feat: Added ability to use SourceScan

.github/workflows/test.yml

@@ -66,7 +66,7 @@ jobs:
         run: sudo apt-get update && sudo apt-get install --assume-yes libudev-dev
 
       - name: Run tests
-        run: cargo test --workspace --verbose
+        run: cargo test --workspace
 
   lint:
     runs-on: ubuntu-latest

.gitignore

@@ -1,6 +1,6 @@
 # Build files
 /target
-
+/integration-tests/docker-build-template/target
 # Code Editor related files
 .idea
 .vscode

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,85 @@ 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:
+
+1. runs against source code version, committed to git, ignoring any uncommitted changes
+2. requires that `Cargo.lock` of project is created (e.g. via `cargo update`) and added to git. 
+    - this enables `--locked` build by downstream `cargo` command. 
+3. will use configuration in [`[package.metadata.near.reproducible_build]`](https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.toml.template#L14-L25) 
+   section of contract's `Cargo.toml` and [`package.repository`](https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.toml.template#L9) field
+    - default values for this section can also be found in `Cargo.toml` of 
+      template project, generated by `cargo near new`
+
+Important flags:
+
+1. `--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.   
+
+2. `--no-locked` 
+    - flag is allowed in *NO*-Docker builds, e.g. to generate a `Cargo.lock` *and* simultaneously build the contract.
+    - flag is allowed in Docker builds, but 
+      - such builds are not reproducible due to potential update of dependencies and compiled `wasm` mismatch as the result.
+
+---
 
 ```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:
+
+1. doesn't have any modified tracked files, any staged changes or any untracked content.  
+2. has been pushed to remote repository, identified by 
+   [`package.repository`](https://github.com/near/cargo-near/blob/main/cargo-near/src/commands/new/new-project-template/Cargo.toml.template#L9).
+
+Important flags:
+
+1. `--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.
+
+2. `--no-locked` 
+    - flag is declined for deploy, due to its effects on `build` result
 
 ## Contribution
 

cargo-near/Cargo.toml

@@ -24,13 +24,15 @@ eula = false
 
 [dependencies]
 bs58 = "0.5"
+hex = "0.4.3"
 camino = "1.1.1"
-cargo_metadata = "0.18"
+cargo_metadata = "0.18.1"
 clap = { version = "4.0.18", features = ["derive", "env"] }
 colored = "2.0"
 env_logger = "0.11"
 log = "0.4"
 rustc_version = "0.4"
+serde = "1.0.197"
 serde_json = "1.0"
 sha2 = "0.10"
 symbolic-debuginfo = "8.8"
@@ -52,6 +54,16 @@ interactive-clap = "0.2.10"
 interactive-clap-derive = "0.2.10"
 near-cli-rs = { version = "0.11.0", default-features = false }
 dunce = "1"
+tempfile = "3.10.1"
+git2 = "0.19"
+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(target_os = "linux")'.dependencies]
+nix = { version = "0.29.0", features = ["user", "process"] }
 
 [features]
 default = ["ledger"]

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)
+    }
+}