Build crate. Version bump. (#369)

* Added odra-build crate. * Bumped version to 0.8.1. * Bump cargo odra version for tests
odradev · Feb 29, 2024 · 6e9fb7a · 6e9fb7a
1 parent 6f46105
commit 6e9fb7a
Show file tree

Hide file tree

Showing 19 changed files with 94 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,16 +2,17 @@
 
 Changelog for `odra`.
 
-## [0.9.0] - 2024-XX-XX
+## [0.8.1] - 2024-XX-XX
 ### Added
 - `ContractRef` trait with `new` and `address` functions. All contract references now implement it.
 - `disable-allocator` feature for `odra` crate. It allows to disable the allocator used by Odra Framework in
 wasm build.
+- `odra-build` crate for including the code in contract's build.rs file.
 
 ### Changed
 - Traits implemented by modules are now also implemented by their `ContractRefs` and `HostRefs`.
 
-## [0.8.0] - 2024-XX-XX
+## [0.8.0] - 2024-02-06
 
 ### Changed
 - Replaced `contract_env::` with `self.env()` in the contract context (of type `ContractEnv`).

diff --git a/Cargo.toml b/Cargo.toml
@@ -8,24 +8,26 @@ members = [
     "odra-casper/livenet-env",
     "odra-casper/wasm-env",
     "odra-casper/test-vm",
-    "odra-test"]
+    "odra-test",
+    "odra-build"
+]
 exclude = [ "examples", "modules", "benchmark", "odra-casper/proxy-caller", "templates/blank", "templates/full", "templates/workspace", "tests"]
 resolver = "2"
 
 [workspace.package]
-version = "0.8.0"
+version = "0.8.1"
 authors = ["Jakub Płaskonka <kuba@odra.dev>", "Krzysztof Pobiarżyn <krzysztof@odra.dev>", "Maciej Zieliński <maciej@odra.dev>"]
 license = "MIT"
 homepage = "https://odra.dev/docs"
 repository = "https://github.com/odradev/odra"
 
 [workspace.dependencies]
-odra-core = { path = "core", version = "0.8.0" }
-odra-macros = { path = "odra-macros", version = "0.8.0" }
-odra-casper-test-vm = { path = "odra-casper/test-vm", version = "0.8.0" }
-odra-casper-rpc-client = { path = "odra-casper/rpc-client", version = "0.8.0" }
-odra-vm = { path = "odra-vm", version = "0.8.0" }
-odra-casper-wasm-env = { path = "odra-casper/wasm-env", version = "0.8.0"}
+odra-core = { path = "core", version = "0.8.1" }
+odra-macros = { path = "odra-macros", version = "0.8.1" }
+odra-casper-test-vm = { path = "odra-casper/test-vm", version = "0.8.1" }
+odra-casper-rpc-client = { path = "odra-casper/rpc-client", version = "0.8.1" }
+odra-vm = { path = "odra-vm", version = "0.8.1" }
+odra-casper-wasm-env = { path = "odra-casper/wasm-env", version = "0.8.1"}
 casper-contract = { version = "3.0.0", default-features = false }
 casper-types = { version = "3.0.0", default-features = false }
 casper-execution-engine = "5.0.0"

diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "odra-examples"
-version = "0.8.0"
+version = "0.8.1"
 edition = "2021"
 
 [dependencies]
@@ -13,6 +13,9 @@ odra-casper-livenet-env = { path = "../odra-casper/livenet-env", optional = true
 odra-test = { path = "../odra-test" }
 hex = "0.4.3"
 
+[build-dependencies]
+odra-build = { path = "../odra-build" }
+
 [features]
 default = []
 livenet = ["odra-casper-livenet-env"]

diff --git a/examples/build.rs b/examples/build.rs
@@ -1,10 +1,6 @@
 //! Odra's contracts build script.
-use std::env;
 
 /// Uses the ENV variable `ODRA_MODULE` to set the `odra_module` cfg flag.
 pub fn main() {
-    println!("cargo:rerun-if-env-changed=ODRA_MODULE");
-    let module = env::var("ODRA_MODULE").unwrap_or_else(|_| "".to_string());
-    let msg = format!("cargo:rustc-cfg=odra_module=\"{}\"", module);
-    println!("{}", msg);
+    odra_build::build();
 }
diff --git a/justfile b/justfile
@@ -1,5 +1,5 @@
 CARGO_ODRA_GIT_REPO := "https://github.com/odradev/cargo-odra"
-CARGO_ODRA_BRANCH := "release/0.1.0"
+CARGO_ODRA_BRANCH := "release/0.1.1"
 BINARYEN_VERSION := "version_116"
 BINARYEN_CHECKSUM := "c55b74f3109cdae97490faf089b0286d3bba926bb6ea5ed00c8c784fc53718fd"
 

diff --git a/modules/Cargo.toml b/modules/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "odra-modules"
-version = "0.8.0"
+version = "0.8.1"
 edition = "2021"
 authors = ["Jakub Płaskonka <kuba@odra.dev>", "Krzysztof Pobiarżyn <krzysztof@odra.dev>", "Maciej Zieliński <maciej@odra.dev>"]
 license = "MIT"
@@ -10,11 +10,14 @@ keywords = ["wasm", "webassembly", "blockchain"]
 categories = ["wasm"]
 
 [dependencies]
-odra = { path = "../odra", version = "0.8.0", default-features = false }
+odra = { path = "../odra", version = "0.8.1", default-features = false }
 hex = { version = "0.4.3", default-features = false }
 
 [dev-dependencies]
-odra-test = { path = "../odra-test", version = "0.8.0" }
+odra-test = { path = "../odra-test", version = "0.8.1" }
+
+[build-dependencies]
+odra-build = { path = "../odra-build", version = "0.8.1" }
 
 [features]
 default = []

diff --git a/modules/build.rs b/modules/build.rs
@@ -1,10 +1,6 @@
 //! Odra's contracts build script.
-use std::env;
 
 /// Uses the ENV variable `ODRA_MODULE` to set the `odra_module` cfg flag.
 pub fn main() {
-    println!("cargo:rerun-if-env-changed=ODRA_MODULE");
-    let module = env::var("ODRA_MODULE").unwrap_or_else(|_| "".to_string());
-    let msg = format!("cargo:rustc-cfg=odra_module=\"{}\"", module);
-    println!("{}", msg);
+    odra_build::build();
 }
diff --git a/odra-build/Cargo.toml b/odra-build/Cargo.toml
@@ -0,0 +1,9 @@
+[package]
+name = "odra-build"
+description = "Function used in build.rs files of Odra projects"
+edition = "2021"
+version.workspace = true
+authors.workspace = true
+license.workspace = true
+homepage.workspace = true
+repository.workspace = true
diff --git a/odra-build/src/lib.rs b/odra-build/src/lib.rs
@@ -0,0 +1,33 @@
+pub fn build() {
+    flags().iter().for_each(|flag| println!("{}", flag));
+}
+
+fn flags() -> Vec<String> {
+    let mut flags = vec![];
+    flags.push("cargo:rerun-if-env-changed=ODRA_MODULE".to_string());
+    let module = std::env::var("ODRA_MODULE").unwrap_or_else(|_| "".to_string());
+    let msg = format!("cargo:rustc-cfg=odra_module=\"{}\"", module);
+    flags.push(msg);
+    flags
+}
+
+#[cfg(test)]
+mod test {
+    #[test]
+    fn test_flags() {
+        std::env::remove_var("ODRA_MODULE");
+        let flags = super::flags();
+        assert_eq!(flags.len(), 2);
+        assert_eq!(flags[0], "cargo:rerun-if-env-changed=ODRA_MODULE");
+        assert_eq!(flags[1], "cargo:rustc-cfg=odra_module=\"\"");
+    }
+
+    #[test]
+    fn test_flags_with_env() {
+        std::env::set_var("ODRA_MODULE", "test");
+        let flags = super::flags();
+        assert_eq!(flags.len(), 2);
+        assert_eq!(flags[0], "cargo:rerun-if-env-changed=ODRA_MODULE");
+        assert_eq!(flags[1], "cargo:rustc-cfg=odra_module=\"test\"");
+    }
+}
diff --git a/odra-casper/proxy-caller/Cargo.toml b/odra-casper/proxy-caller/Cargo.toml
@@ -1,7 +1,7 @@
 [package]
 name = "odra-casper-proxy-caller"
 edition = "2021"
-version = "0.8.0"
+version = "0.8.1"
 authors = ["Jakub Płaskonka <kuba@odra.dev>", "Krzysztof Pobiarżyn <krzysztof@odra.dev>", "Maciej Zieliński <maciej@odra.dev>"]
 license = "MIT"
 homepage = "https://odra.dev/docs"

diff --git a/templates/blank/_Cargo.toml b/templates/blank/_Cargo.toml
@@ -9,6 +9,9 @@ edition = "2021"
 [dev-dependencies]
 #odra_test_dependency
 
+[build-dependencies]
+#odra_build_dependency
+
 [[bin]]
 name = "{{project-name}}_build_contract"
 path = "bin/build_contract.rs"

diff --git a/templates/blank/build.rs b/templates/blank/build.rs
@@ -1,8 +1,6 @@
-use std::env;
+//! Odra's contracts build script.
 
+/// Uses the ENV variable `ODRA_MODULE` to set the `odra_module` cfg flag.
 pub fn main() {
-    println!("cargo:rerun-if-env-changed=ODRA_MODULE");
-    let module = env::var("ODRA_MODULE").unwrap_or_else(|_| "".to_string());
-    let msg = format!("cargo:rustc-cfg=odra_module=\"{}\"", module);
-    println!("{}", msg);
+    odra_build::build();
 }
diff --git a/templates/full/_Cargo.toml b/templates/full/_Cargo.toml
@@ -9,6 +9,9 @@ edition = "2021"
 [dev-dependencies]
 #odra_test_dependency
 
+[build-dependencies]
+#odra_build_dependency
+
 [[bin]]
 name = "{{project-name}}_build_contract"
 path = "bin/build_contract.rs"

diff --git a/templates/full/build.rs b/templates/full/build.rs
@@ -1,8 +1,6 @@
-use std::env;
+//! Odra's contracts build script.
 
+/// Uses the ENV variable `ODRA_MODULE` to set the `odra_module` cfg flag.
 pub fn main() {
-    println!("cargo:rerun-if-env-changed=ODRA_MODULE");
-    let module = env::var("ODRA_MODULE").unwrap_or_else(|_| "".to_string());
-    let msg = format!("cargo:rustc-cfg=odra_module=\"{}\"", module);
-    println!("{}", msg);
+    odra_build::build();
 }
diff --git a/templates/workspace/_Cargo.toml b/templates/workspace/_Cargo.toml
@@ -8,6 +8,7 @@ resolver = "2"
 [workspace.dependencies]
 #odra_dependency
 #odra_test_dependency
+#odra_build_dependency
 
 [profile.release]
 codegen-units = 1

diff --git a/templates/workspace/flapper/Cargo.toml b/templates/workspace/flapper/Cargo.toml
@@ -9,6 +9,9 @@ odra = { workspace = true }
 [dev-dependencies]
 odra-test = { workspace = true }
 
+[build-dependencies]
+odra-build = { workspace = true }
+
 [[bin]]
 name = "flapper_build_contract"
 path = "bin/build_contract.rs"

diff --git a/templates/workspace/flapper/build.rs b/templates/workspace/flapper/build.rs
@@ -1,8 +1,6 @@
-use std::env;
+//! Odra's contracts build script.
 
+/// Uses the ENV variable `ODRA_MODULE` to set the `odra_module` cfg flag.
 pub fn main() {
-    println!("cargo:rerun-if-env-changed=ODRA_MODULE");
-    let module = env::var("ODRA_MODULE").unwrap_or_else(|_| "".to_string());
-    let msg = format!("cargo:rustc-cfg=odra_module=\"{}\"", module);
-    println!("{}", msg);
+    odra_build::build();
 }
diff --git a/templates/workspace/flipper/Cargo.toml b/templates/workspace/flipper/Cargo.toml
@@ -9,6 +9,9 @@ odra = { workspace = true }
 [dev-dependencies]
 odra-test = { workspace = true }
 
+[build-dependencies]
+odra-build = { workspace = true }
+
 [[bin]]
 name = "flipper_build_contract"
 path = "bin/build_contract.rs"

diff --git a/templates/workspace/flipper/build.rs b/templates/workspace/flipper/build.rs
@@ -1,8 +1,6 @@
-use std::env;
+//! Odra's contracts build script.
 
+/// Uses the ENV variable `ODRA_MODULE` to set the `odra_module` cfg flag.
 pub fn main() {
-    println!("cargo:rerun-if-env-changed=ODRA_MODULE");
-    let module = env::var("ODRA_MODULE").unwrap_or_else(|_| "".to_string());
-    let msg = format!("cargo:rustc-cfg=odra_module=\"{}\"", module);
-    println!("{}", msg);
+    odra_build::build();
 }