feat(source-scan): docker checks (#166)

fast-forward extension of #164 1. [Cargo.toml](https://github.com/dj8yfo/sample_no_workspace/blob/1fd39bcbe4d523ac26c3d07c1f49ecc0fc65d9e7/Cargo.toml) => `sample-crate-12.testnet` <details> <summary>contract_source_metadata</summary><p> ```json { "build_info": { "build_command": [ "cargo", "near", "build", "--no-default-features", "--features", "near-sdk/expensive-debug" ], "build_environment": "dj8yfo/sourcescan:0.x.x-dev-cargo-near-finalization@sha256:f86a095cb3daed21d0b5f86a4b5d9da0c0e26835f85c42678e1d460c9caa2c12", "contract_path": "", "source_code_snapshot": "git+https://github.com/dj8yfo/sample_no_workspace.git?rev=1fd39bcbe4d523ac26c3d07c1f49ecc0fc65d9e7" }, "link": "https://github.com/dj8yfo/sample_no_workspace/tree/1fd39bcbe4d523ac26c3d07c1f49ecc0fc65d9e7", "standards": [ { "standard": "nep330", "version": "1.2.0" } ], "version": "0.7.7" } ``` </p> </details> 2. [Cargo.toml](https://github.com/dj8yfo/sample_workspace/blob/86aa6ccf4610f072cd207db86869e6324779780f/self-updates/update/Cargo.toml) => `sample-subpath-in-repo-6.testnet` <details> <summary>contract_source_metadata</summary><p> ```json { "build_info": { "build_command": [ "cargo", "near", "build", "--no-release", "--no-doc" ], "build_environment": "dj8yfo/sourcescan:0.x.x-dev-cargo-near-finalization@sha256:f86a095cb3daed21d0b5f86a4b5d9da0c0e26835f85c42678e1d460c9caa2c12", "contract_path": "self-updates/update", "source_code_snapshot": "git+https://github.com/dj8yfo/sample_workspace.git?rev=86aa6ccf4610f072cd207db86869e6324779780f" }, "link": "https://github.com/dj8yfo/sample_workspace/tree/86aa6ccf4610f072cd207db86869e6324779780f", "standards": [ { "standard": "nep330", "version": "1.2.0" } ], "version": "1.7.7" } ``` </p> </details> 3. [dir containing submodule](https://github.com/dj8yfo/sample_workspace_with_submodules/tree/4b466921b89df67d6e8d1f9956b55a677edb2497/self-updates) => `sample-crate-in-submodule-5.testnet` <details> <summary>contract_source_metadata</summary><p> ```json { "build_info": { "build_command": [ "cargo", "near", "build", "--no-release", "--no-doc" ], "build_environment": "dj8yfo/sourcescan:0.x.x-dev-cargo-near-finalization@sha256:f86a095cb3daed21d0b5f86a4b5d9da0c0e26835f85c42678e1d460c9caa2c12", "contract_path": "self-updates/update", "source_code_snapshot": "git+https://github.com/dj8yfo/sample_workspace_with_submodules.git?rev=4b466921b89df67d6e8d1f9956b55a677edb2497" }, "link": "https://github.com/dj8yfo/sample_workspace_with_submodules/tree/4b466921b89df67d6e8d1f9956b55a677edb2497", "standards": [ { "standard": "nep330", "version": "1.2.0" } ], "version": "1.0.0" } ``` </p> </details> 4. [Cargo.toml](https://bitbucket.org/dj8yfomule/scratch_check_git/src/finalization/Cargo.toml) => `bitbucket-scratch-4.testnet` <details> <summary>contract_source_metadata</summary><p> ```json { "build_info": { "build_command": [ "cargo", "near", "build", "--no-release", "--no-doc" ], "build_environment": "dj8yfo/sourcescan:0.x.x-dev-cargo-near-finalization@sha256:f86a095cb3daed21d0b5f86a4b5d9da0c0e26835f85c42678e1d460c9caa2c12", "contract_path": "", "source_code_snapshot": "git+https://feepdake27@bitbucket.org/dj8yfomule/scratch_check_git.git?rev=af9e835380053205f7fcc9b232a7ebb1c2c20694" }, "link": "https://bitbucket.org/dj8yfomule/scratch_check_git/src/finalization/", "standards": [ { "standard": "nep330", "version": "1.2.0" } ], "version": "0.1.0" } ``` </p> </details> 5. factory [Cargo.toml](https://github.com/dj8yfo/factory-rust/blob/62a34ac86e6323ee6351b20fded7fc668b1e0277/factory/Cargo.toml) => `repro-fct-19.testnet` <details> <summary>contract_source_metadata</summary><p> ```json { "build_info": { "build_command": [ "cargo", "near", "build", "--no-default-features", "--features", "near-sdk/expensive-debug" ], "build_environment": "dj8yfo/sourcescan:0.x.x-dev-cargo-near-finalization@sha256:f86a095cb3daed21d0b5f86a4b5d9da0c0e26835f85c42678e1d460c9caa2c12", "contract_path": "factory", "source_code_snapshot": "git+https://github.com/dj8yfo/factory-rust.git?rev=62a34ac86e6323ee6351b20fded7fc668b1e0277" }, "link": "https://github.com/dj8yfo/factory-rust/tree/62a34ac86e6323ee6351b20fded7fc668b1e0277", "standards": [ { "standard": "nep330", "version": "1.2.0" } ], "version": "0.1.13" } ``` </p> </details> 6. `repro-fct-19.testnet` => product `donation-product.repro-fct-19.testnet` <details> <summary>contract_source_metadata</summary><p> ```json { "build_info": { "build_command": [ "cargo", "near", "build" ], "build_environment": "dj8yfo/sourcescan:0.x.x-dev-cargo-near-finalization@sha256:f86a095cb3daed21d0b5f86a4b5d9da0c0e26835f85c42678e1d460c9caa2c12", "contract_path": "product-donation", "source_code_snapshot": "git+https://github.com/dj8yfo/factory-rust.git?rev=62a34ac86e6323ee6351b20fded7fc668b1e0277" }, "link": "https://github.com/dj8yfo/factory-rust/tree/62a34ac86e6323ee6351b20fded7fc668b1e0277", "standards": [ { "standard": "nep330", "version": "1.2.0" } ], "version": "0.2.9" } ``` </p> </details> 7. product [Cargo.toml](https://github.com/dj8yfo/factory-rust/blob/62a34ac86e6323ee6351b20fded7fc668b1e0277/product-donation/Cargo.toml) => `repro-fct-product-19.testnet` <details> <summary>contract_source_metadata</summary><p> ```json { "build_info": { "build_command": [ "cargo", "near", "build" ], "build_environment": "dj8yfo/sourcescan:0.x.x-dev-cargo-near-finalization@sha256:f86a095cb3daed21d0b5f86a4b5d9da0c0e26835f85c42678e1d460c9caa2c12", "contract_path": "product-donation", "source_code_snapshot": "git+https://github.com/dj8yfo/factory-rust.git?rev=62a34ac86e6323ee6351b20fded7fc668b1e0277" }, "link": "https://github.com/dj8yfo/factory-rust/tree/62a34ac86e6323ee6351b20fded7fc668b1e0277", "standards": [ { "standard": "nep330", "version": "1.2.0" } ], "version": "0.2.9" } ``` </p> </details>
near · Jun 19, 2024 · 21bd5bc · 21bd5bc
1 parent 48cef28
commit 21bd5bc
Show file tree

Hide file tree

Showing 21 changed files with 832 additions and 167 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -50,14 +50,14 @@ npm install cargo-near
   <summary>Compile and install from source code (Cargo)</summary>
 
 ```sh
-cargo install cargo-near
+cargo install --locked cargo-near
 ```
 
 or, install the most recent version from git repository:
 
 ```sh
 $ git clone https://github.com/near/cargo-near
-$ cargo install --path cargo-near
+$ cargo install --locked --path cargo-near
 ```
 </details>
 
@@ -71,32 +71,65 @@ cargo near
 
 Starts interactive mode that will allow to explore all the available commands.
 
+---
+
+```console
+cargo near new
+```
+
+Initializes a new project skeleton to create a contract from a template.
+
+---
+
 ```console
 cargo near build
 ```
 
 Builds a NEAR smart contract along with its [ABI](https://github.com/near/abi) (while in the directory containing contract's Cargo.toml).
 
-You can also make this command embed ABI into your WASM artifact by adding `--embed-abi` parameter. Once deployed, this will allow you to call a view function `__contract_abi` to retrieve a [ZST](https://facebook.github.io/zstd/)-compressed ABI.
+By default, this runs a reproducible build in a [Docker](https://docs.docker.com/) container, which:
+
+- runs against source code version, committed to git, ignoring any uncommitted changes
+- requires that `Cargo.lock` of project is created (e.g. via `cargo update`) and added to git 
+- will use configuration in `[package.metadata.near.reproducible_build]` section of contract's `Cargo.toml`
+
+`--no-docker` flag can be used to perform a regular build with rust toolchain installed onto host, running the `cargo-near` cli. *NO*-Docker builds run against actual state of code in filesystem and not against a version, committed to source control.   
+
+`--no-locked` flag is allowed in *NO*-Docker builds, e.g. to generate a `Cargo.lock` *and* simultaneously build the contract.
+
+---
 
 ```console
 cargo near abi
 ```
 
 Generates NEAR smart contract's [ABI](https://github.com/near/abi) (while in the directory containing contract's Cargo.toml).
 
+Once contract is deployed, this will allow you to call a view function `__contract_abi` to retrieve a [ZST](https://facebook.github.io/zstd/)-compressed ABI.
+
+---
+
 ```console
 cargo near create-dev-account
 ```
 
 Guides you through creation of a new NEAR account on [testnet](https://explorer.testnet.near.org).
 
+---
+
 ```console
 cargo near deploy
 ```
 
 Builds the smart contract (equivalent to `cargo near build`) and guides you to deploy it to the blockchain.
 
+By default, this runs a reproducible build in a Docker container.
+
+`deploy` command from Docker build requires that contract's source code has been pushed to remote repository,
+doesn't have any modified tracked files, any staged changes or any untracked content. 
+
+`--no-docker` flag can be used to perform a regular *NO*-Docker build *and* deploy. Similar to `build` command, 
+in this case none of the git-related concerns and restrictions apply.
 
 ## Contribution
 

diff --git a/cargo-near/Cargo.toml b/cargo-near/Cargo.toml
@@ -19,6 +19,7 @@ eula = false
 
 [dependencies]
 bs58 = "0.4"
+hex = "0.4.3"
 camino = "1.1.1"
 cargo_metadata = "0.18.1"
 clap = { version = "4.0.18", features = ["derive", "env"] }
@@ -54,8 +55,9 @@ home = "0.5.9"
 pathdiff = { version = "0.2.1", features = ["camino"]}
 unix_path = "1.0.1"
 url = { version = "2.5.0", features = ["serde"]}
+tmp_env = "0.1.1"
 
-[target.'cfg(unix)'.dependencies]
+[target.'cfg(target_os = "linux")'.dependencies]
 nix = { version = "0.28.0", features = ["user", "process"] }
 
 [features]

diff --git a/cargo-near/src/build_extended.rs b/cargo-near/src/build_extended.rs
@@ -0,0 +1,61 @@
+use crate::{BuildArtifact, BuildOpts};
+
+mod build_script;
+pub use build_script::BuildScriptOpts;
+use rustc_version::Version;
+
+#[derive(Debug, Clone)]
+pub struct OptsExtended<'a> {
+    pub workdir: &'a str,
+    /// vector of key-value pairs of temporary env overrides during build process
+    pub env: Vec<(&'a str, &'a str)>,
+    pub build_opts: BuildOpts,
+    pub build_script_opts: BuildScriptOpts<'a>,
+}
+
+pub fn build(args: OptsExtended) -> Result<BuildArtifact, Box<dyn std::error::Error>> {
+    let actual_version = rustc_version::version()?;
+    let (artifact, skipped) = args.skip_or_compile(&actual_version)?;
+
+    args.build_script_opts
+        .post_build(skipped, &artifact, args.workdir, &actual_version)?;
+    Ok(artifact)
+}
+
+impl<'a> OptsExtended<'a> {
+    pub fn skip_or_compile(
+        &self,
+        version: &Version,
+    ) -> Result<(BuildArtifact, bool), Box<dyn std::error::Error>> {
+        let _tmp_workdir = tmp_env::set_current_dir(self.workdir)?;
+        let result = if self.build_script_opts.should_skip(version) {
+            let artifact = self.build_script_opts.create_empty_stub()?;
+            (artifact, true)
+        } else {
+            let artifact = self.compile_near_artifact()?;
+            (artifact, false)
+        };
+        Ok(result)
+    }
+
+    /// `CARGO_TARGET_DIR` export is needed to avoid attempt to acquire same `target/<profile-path>/.cargo-lock`
+    /// as the `cargo` process, which is running the build-script
+    pub fn compile_near_artifact(&self) -> Result<BuildArtifact, Box<dyn std::error::Error>> {
+        let mut tmp_envs = vec![];
+        for (env_key, value) in self.env.iter() {
+            let tmp_env = tmp_env::set_var(env_key, value);
+            tmp_envs.push(tmp_env);
+        }
+
+        let artifact = if let Some(distinct_target_dir) = self.build_script_opts.distinct_target_dir
+        {
+            let _tmp_cargo_target_env = tmp_env::set_var("CARGO_TARGET_DIR", distinct_target_dir);
+
+            crate::build(self.build_opts.clone())?
+        } else {
+            crate::build(self.build_opts.clone())?
+        };
+
+        Ok(artifact)
+    }
+}
diff --git a/cargo-near/src/build_extended/build_script.rs b/cargo-near/src/build_extended/build_script.rs
@@ -0,0 +1,169 @@
+use crate::BuildArtifact;
+use rustc_version::Version;
+
+/// `cargo::` prefix for build script outputs, that `cargo` recognizes
+/// was implemented <https://github.com/rust-lang/cargo/pull/12201> since this version
+const DEPRECATE_SINGLE_COLON_SINCE: Version = Version::new(1, 77, 0);
+
+macro_rules! print_warn {
+    ($version: ident, $($tokens: tt)*) => {
+        let separator = if $version >= &DEPRECATE_SINGLE_COLON_SINCE {
+            "::"
+        } else {
+            ":"
+        };
+        println!("cargo{}warning={}", separator, format!($($tokens)*))
+    }
+}
+
+#[derive(Debug, Clone)]
+pub struct BuildScriptOpts<'a> {
+    /// environment variable name to export result `*.wasm` path to with [`cargo::rustc-env=`](https://doc.rust-lang.org/cargo/reference/build-scripts.html#rustc-env)
+    /// instruction
+    pub result_env_key: Option<&'a str>,
+    /// list of paths for [`cargo::rerun-if-changed=`](https://doc.rust-lang.org/cargo/reference/build-scripts.html#rerun-if-changed)
+    /// instruction
+    ///
+    /// if relative, it's relative to path of crate, where build.rs is compiled
+    pub rerun_if_changed_list: Vec<&'a str>,
+    /// vector of key-value pairs of environment variable name and its value,
+    /// when compilation should be skipped on a variable's value match;
+    /// e.g.
+    /// skipping emitting output `*.wasm` may be helpful when `PROFILE` is equal to `debug`
+    /// for using  `rust-analyzer/flycheck`, `cargo check`, `bacon` and other dev-tools
+    pub build_skipped_when_env_is: Vec<(&'a str, &'a str)>,
+    /// path of stub file, where a placeholder empty `wasm` output is emitted to, when
+    /// build is skipped due to match in [`Self::build_skipped_when_env_is`]
+    ///
+    /// if this path is relative, then the base is [`crate::BuildOptsExtended::workdir`]
+    pub stub_path: Option<&'a str>,
+    /// substitution export of [`CARGO_TARGET_DIR`](https://doc.rust-lang.org/cargo/reference/environment-variables.html),
+    /// which is required to avoid deadlock <https://github.com/rust-lang/cargo/issues/8938>;
+    /// should best be a subfolder of [`CARGO_TARGET_DIR`](https://doc.rust-lang.org/cargo/reference/environment-variables.html)
+    /// of crate being built to work normally in docker builds
+    ///
+    /// if this path is relative, then the base is [`crate::BuildOptsExtended::workdir`]
+    pub distinct_target_dir: Option<&'a str>,
+}
+
+impl<'a> BuildScriptOpts<'a> {
+    pub fn should_skip(&self, version: &Version) -> bool {
+        let mut return_bool = false;
+        for (env_key, value_to_skip) in self.build_skipped_when_env_is.iter() {
+            if let Ok(actual_value) = std::env::var(env_key) {
+                if actual_value == *value_to_skip {
+                    return_bool = true;
+                    print_warn!(
+                        version,
+                        "`{}` env set to `{}`, build was configured to skip on this value",
+                        env_key,
+                        actual_value
+                    );
+                }
+            }
+        }
+
+        return_bool
+    }
+    pub fn create_empty_stub(&self) -> Result<BuildArtifact, Box<dyn std::error::Error>> {
+        if self.stub_path.is_none() {
+            return Err(
+                "build must be skipped, but `BuildScriptOpts.stub_path` wasn't configured"
+                    .to_string(),
+            )?;
+        }
+        let stub_path = std::path::Path::new(self.stub_path.as_ref().unwrap());
+        create_stub_file(stub_path)?;
+        let stub_path = stub_path.canonicalize()?;
+
+        let artifact = {
+            let stub_path = camino::Utf8PathBuf::from_path_buf(stub_path)
+                .map_err(|err| format!("`{}` isn't a valid UTF-8 path", err.to_string_lossy()))?;
+            BuildArtifact {
+                path: stub_path,
+                fresh: true,
+                from_docker: false,
+            }
+        };
+        Ok(artifact)
+    }
+
+    pub fn post_build(
+        &self,
+        skipped: bool,
+        artifact: &BuildArtifact,
+        workdir: &str,
+        version: &Version,
+    ) -> Result<(), Box<dyn std::error::Error>> {
+        let colon_separator = if version >= &DEPRECATE_SINGLE_COLON_SINCE {
+            "::"
+        } else {
+            ":"
+        };
+        if let Some(ref result_env_key) = self.result_env_key {
+            pretty_print(skipped, artifact, version)?;
+            println!(
+                "cargo{}rustc-env={}={}",
+                colon_separator,
+                result_env_key,
+                artifact.path.clone().into_string()
+            );
+            print_warn!(
+                version,
+                "Path to result artifact of build in `{}` is exported to `{}`",
+                workdir,
+                result_env_key,
+            );
+        }
+        for path in self.rerun_if_changed_list.iter() {
+            println!("cargo{}rerun-if-changed={}", colon_separator, path);
+        }
+        Ok(())
+    }
+}
+
+fn create_stub_file(out_path: &std::path::Path) -> Result<(), Box<dyn std::error::Error>> {
+    std::fs::OpenOptions::new()
+        .write(true)
+        .truncate(true)
+        .create(true)
+        .open(out_path)?;
+    Ok(())
+}
+
+fn pretty_print(
+    skipped: bool,
+    artifact: &BuildArtifact,
+    version: &Version,
+) -> Result<(), Box<dyn std::error::Error>> {
+    if skipped {
+        print_warn!(
+            version,
+            "Build empty artifact stub-file written to: `{}`",
+            artifact.path.clone().into_string()
+        );
+        return Ok(());
+    }
+    let hash = artifact.compute_hash()?;
+
+    print_warn!(version, "");
+    print_warn!(version, "");
+    print_warn!(
+        version,
+        "Build artifact path: {}",
+        artifact.path.clone().into_string()
+    );
+    print_warn!(
+        version,
+        "Sub-build artifact SHA-256 checksum hex: {}",
+        hash.to_hex_string()
+    );
+    print_warn!(
+        version,
+        "Sub-build artifact SHA-256 checksum bs58: {}",
+        hash.to_base58_string()
+    );
+    print_warn!(version, "");
+    print_warn!(version, "");
+    Ok(())
+}
diff --git a/cargo-near/src/commands/abi_command/abi.rs b/cargo-near/src/commands/abi_command/abi.rs
@@ -6,6 +6,7 @@ use color_eyre::eyre::ContextCompat;
 use colored::Colorize;
 use near_abi::AbiRoot;
 
+use crate::commands::build_command::BUILD_RS_ABI_STEP_HINT_ENV_KEY;
 use crate::common::ColorPreference;
 use crate::types::{manifest::CargoManifestPath, metadata::CrateMetadata};
 use crate::util;
@@ -93,6 +94,7 @@ pub(crate) fn generate_abi(
             ("CARGO_PROFILE_DEV_OPT_LEVEL", "0"),
             ("CARGO_PROFILE_DEV_DEBUG", "0"),
             ("CARGO_PROFILE_DEV_LTO", "off"),
+            (BUILD_RS_ABI_STEP_HINT_ENV_KEY, "true"),
         ],
         util::dylib_extension(),
         hide_warnings,