Install rust globally

.github/workflows/build-windows.yml

@@ -5,13 +5,13 @@ name: build
 
 on:
   pull_request:
-    branches: [ main, feat/* ]
+    branches: [main, feat/*]
   workflow_dispatch:
 
 jobs:
   build:
     name: Build and Test mxpy for ${{ matrix.os }}, python ${{ matrix.python-version }}
-    
+
     runs-on: ${{ matrix.os }}
 
     strategy:
@@ -20,39 +20,39 @@ jobs:
         python-version: [3.8]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      shell: bash
-      run: |
-        python3 -m pip install --upgrade pip
-        pip3 install -r requirements.txt
-        pip3 install pytest
-    - name: Set github_api_token
-      shell: bash
-      run: |
-        mkdir ~/multiversx-sdk
-        export PYTHONPATH=.
-        python3 -m multiversx_sdk_cli.cli config new test
-        python3 -m multiversx_sdk_cli.cli config set github_api_token ${{ secrets.GITHUB_TOKEN }}
-    - name: Setup test dependencies
-      shell: bash
-      run: |
-        python3 -m multiversx_sdk_cli.cli deps install testwallets
-    - name: Run unit tests
-      shell: bash
-      run: |
-        export PYTHONPATH=.
-        pytest -m "not skip_on_windows" .
-    - name: Run CLI tests
-      shell: bash
-      run: |
-        export PROXY=https://testnet-gateway.multiversx.com
-        export CHAIN_ID=T
-        cd ./multiversx_sdk_cli/tests
-        source ./test_cli_tx.sh && testAll || return 1
-        source ./test_cli_dns.sh && testOffline || return 1
-        source ./test_cli_validators.sh && testAll || return 1
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        shell: bash
+        run: |
+          python3 -m pip install --upgrade pip
+          pip3 install -r requirements.txt
+          pip3 install pytest
+      - name: Set github_api_token
+        shell: bash
+        run: |
+          mkdir ~/multiversx-sdk
+          export PYTHONPATH=.
+          python3 -m multiversx_sdk_cli.cli config new test
+          python3 -m multiversx_sdk_cli.cli config set github_api_token ${{ secrets.GITHUB_TOKEN }}
+      - name: Setup test dependencies
+        shell: bash
+        run: |
+          python3 -m multiversx_sdk_cli.cli deps install testwallets
+      - name: Run unit tests
+        shell: bash
+        run: |
+          export PYTHONPATH=.
+          pytest -m "not skip_on_windows" .
+      - name: Run CLI tests
+        shell: bash
+        run: |
+          export PROXY=https://testnet-gateway.multiversx.com
+          export CHAIN_ID=T
+          cd ./multiversx_sdk_cli/tests
+          source ./test_cli_tx.sh && testAll || return 1
+          source ./test_cli_dns.sh && testOffline || return 1
+          source ./test_cli_validators.sh && testAll || return 1

.github/workflows/build.yml

@@ -5,53 +5,54 @@ name: build
 
 on:
   pull_request:
-    branches: [ main, feat/* ]
+    branches: [main, feat/*]
   workflow_dispatch:
 
 jobs:
   build:
     name: Build and Test mxpy for ${{ matrix.os }}, python ${{ matrix.python-version }}
-    
+
     runs-on: ${{ matrix.os }}
 
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: [3.8, 3.11]
+        python-version: [3.11]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python3 -m pip install --upgrade pip
-        pip3 install -r requirements.txt
-        pip3 install pytest
-    - name: Install libtinfo5
-      if: ${{ matrix.os != 'macos-latest' }}
-      run: |
-        sudo apt update
-        sudo apt install -y libtinfo5
-    - name: Set github_api_token
-      run: |
-        mkdir ~/multiversx-sdk
-        export PYTHONPATH=.
-        python3 -m multiversx_sdk_cli.cli config new test
-        python3 -m multiversx_sdk_cli.cli config set github_api_token ${{ secrets.GITHUB_TOKEN }}
-    - name: Setup test dependencies
-      run: |
-        python3 -m multiversx_sdk_cli.cli deps install testwallets
-        python3 -m multiversx_sdk_cli.cli deps install wasm-opt
-    - name: Run unit tests
-      run: |
-        export PYTHONPATH=.
-        pytest .
-    - name: Run CLI tests
-      run: |
-        python3 -m multiversx_sdk_cli.cli config set dependencies.vmtools.tag v1.4.60
-        cd ./multiversx_sdk_cli/tests
-        source ./test_cli_contracts.sh && testAll || return 1
-        source ./test_cli_dns.sh && testOffline || return 1
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          pip3 install -r requirements.txt
+          pip3 install pytest
+      - name: Install libtinfo5
+        if: ${{ matrix.os != 'macos-latest' }}
+        run: |
+          sudo apt update
+          sudo apt install -y libtinfo5
+      - name: Set github_api_token
+        run: |
+          mkdir ~/multiversx-sdk
+          export PYTHONPATH=.
+          python3 -m multiversx_sdk_cli.cli config new test
+          python3 -m multiversx_sdk_cli.cli config set github_api_token ${{ secrets.GITHUB_TOKEN }}
+      - name: Setup test dependencies
+        run: |
+          python3 -m multiversx_sdk_cli.cli deps install testwallets
+          python3 -m multiversx_sdk_cli.cli deps install wasm-opt
+          python3 -m multiversx_sdk_cli.cli deps install rust --overwrite
+      - name: Run unit tests
+        run: |
+          export PYTHONPATH=.
+          pytest .
+      - name: Run CLI tests
+        run: |
+          python3 -m multiversx_sdk_cli.cli config set dependencies.vmtools.tag v1.4.60
+          cd ./multiversx_sdk_cli/tests
+          source ./test_cli_contracts.sh && testAll || return 1
+          source ./test_cli_dns.sh && testOffline || return 1

multiversx_sdk_cli/config.py

@@ -154,7 +154,6 @@ def get_defaults() -> Dict[str, Any]:
         # ide.elrond.com will be removed, TBD if clang will still be downloaded
         "dependencies.llvm.urlTemplate.linux": "https://ide.elrond.com/vendor-llvm/{TAG}/linux-amd64.tar.gz?t=19feb",
         "dependencies.llvm.urlTemplate.osx": "https://ide.elrond.com/vendor-llvm/{TAG}/darwin-amd64.tar.gz?t=19feb",
-        "dependencies.rust.resolution": "SDK",
         "dependencies.rust.tag": "nightly-2023-05-26",
         "dependencies.golang.resolution": "SDK",
         "dependencies.golang.tag": "go1.20.7",

multiversx_sdk_cli/dependencies/modules.py

@@ -9,6 +9,7 @@
                                 myprocess, utils, workstation)
 from multiversx_sdk_cli.dependencies.resolution import (
     DependencyResolution, get_dependency_resolution)
+from multiversx_sdk_cli.ux import show_warning
 
 logger = logging.getLogger("modules")
 
@@ -34,7 +35,6 @@
             logger.info("Already exists. Skip install.")
             return
 
-        self._guard_cannot_install_on_host()
         self.uninstall(tag)
         self._do_install(tag)
 
@@ -66,10 +66,6 @@
     def get_resolution(self) -> DependencyResolution:
         return get_dependency_resolution(self.key)
 
-    def _guard_cannot_install_on_host(self):
-        if self.get_resolution() == DependencyResolution.Host:
-            raise errors.KnownError(f"Installation of {self.key} on the host machine is not supported. Perhaps set 'dependencies.{self.key}.resolution' to 'SDK' in config?")
-
 
 class StandaloneModule(DependencyModule):
     def __init__(self,
@@ -256,6 +252,29 @@
 
 
 class Rust(DependencyModule):
+    def is_installed(self, tag: str) -> bool:
+        which_rustc = shutil.which("rustc")
+        which_cargo = shutil.which("cargo")
+        logger.info(f"which rustc: {which_rustc}")
+        logger.info(f"which cargo: {which_cargo}")
+
+        return which_rustc is not None and which_cargo is not None
+
+    def install(self, tag: str, overwrite: bool) -> None:
+        # Fallback to default tag if not provided
+        tag = tag or config.get_dependency_tag(self.key)
+
+        logger.info(f"install: key={self.key}, tag={tag}, overwrite={overwrite}")
+
+        if overwrite:
+            logger.info("Overwriting the current rust version...")
+        elif self._is_installed_and_set_to_nightly():
+            return
+
+        self._do_install(tag)
+        self._install_sc_meta()
+        self._post_install(tag)
+
     def _do_install(self, tag: str) -> None:
         installer_url = self._get_installer_url()
         installer_path = self._get_installer_path()
@@ -269,12 +288,14 @@
             toolchain = "nightly"
 
         args = [str(installer_path), "--verbose", "--default-toolchain", toolchain, "--profile",
-                "minimal", "--target", "wasm32-unknown-unknown", "--no-modify-path", "-y"]
-        output = myprocess.run_process(args, env=self.get_env_for_install())
+                "minimal", "--target", "wasm32-unknown-unknown", "-y"]
+
+        myprocess.run_process(args)
 
-        if output:
-            sc_meta_args = ["cargo", "install", "multiversx-sc-meta"]
-            myprocess.run_process(sc_meta_args, env=self.get_env_for_install())
+    def _install_sc_meta(self):
+        logger.info("Installing multiversx-sc-meta")
+        args = ["cargo", "install", "multiversx-sc-meta"]
+        myprocess.run_process(args)
 
     def _get_installer_url(self) -> str:
         if workstation.is_windows():
@@ -293,73 +314,27 @@
         if os.path.isdir(directory):
             shutil.rmtree(directory)
 
-    def is_installed(self, tag: str) -> bool:
-        resolution = self.get_resolution()
+    def _is_installed_and_set_to_nightly(self) -> bool:
+        # the method parameter is not used in this specific module
+        is_rust_installed = self.is_installed("")
 
-        if resolution == DependencyResolution.Host:
-            which_rustc = shutil.which("rustc")
-            which_cargo = shutil.which("cargo")
-            logger.info(f"which rustc: {which_rustc}")
-            logger.info(f"which cargo: {which_cargo}")
-
-            return which_rustc is not None and which_cargo is not None
-        if resolution == DependencyResolution.SDK:
-            try:
-                env = self._get_env_for_is_installed_in_sdk()
-                myprocess.run_process(["rustc", "--version"], env=env)
-                return True
-            except Exception:
-                return False
+        if not is_rust_installed:
+            return is_rust_installed
+        else:
+            self._recommend_default_rust_version()
+            return True
 
-        raise errors.BadDependencyResolution(self.key, resolution)
+    def _recommend_default_rust_version(self):
+        module = dependencies.get_module_by_key("rust")
+        default_tag: str = config.get_dependency_tag(module.key)
+        show_warning(f"We recommend using rust {default_tag}. If you'd like to overwrite your current version please run `mxpy deps install rust --overwrite`.")
 
     def get_directory(self, tag: str) -> Path:
         tools_folder = workstation.get_tools_folder()
         return tools_folder / "vendor-rust"
 
-    def get_env(self):
-        directory = self.get_directory("")
-        resolution = self.get_resolution()
-
-        if resolution == DependencyResolution.Host:
-            return {
-                "PATH": os.environ.get("PATH", ""),
-                "RUSTUP_HOME": os.environ.get("RUSTUP_HOME", ""),
-                "CARGO_HOME": os.environ.get("CARGO_HOME", "")
-            }
-        if resolution == DependencyResolution.SDK:
-            return {
-                # At this moment, cc (build-essential) is sometimes required by the meta crate (e.g. for reports)
-                "PATH": f"{path.join(directory, 'bin')}:{os.environ['PATH']}",
-                "RUSTUP_HOME": str(directory),
-                "CARGO_HOME": str(directory)
-            }
-
-        raise errors.BadDependencyResolution(self.key, resolution)
-
-    def _get_env_for_is_installed_in_sdk(self) -> Dict[str, str]:
-        directory = self.get_directory("")
-
-        return {
-            "PATH": str(directory / "bin"),
-            "RUSTUP_HOME": str(directory),
-            "CARGO_HOME": str(directory)
-        }
-
-    def get_env_for_install(self):
-        directory = self.get_directory("")
-
-        env = {
-            # For installation, wget (or curl) and cc (build-essential) are also required.
-            "PATH": f"{path.join(directory, 'bin')}:{os.environ['PATH']}",
-            "RUSTUP_HOME": str(directory),
-            "CARGO_HOME": str(directory)
-        }
-
-        if workstation.is_windows():
-            env["RUSTUP_USE_HYPER"] = "1"
-
-        return env
+    def get_env(self) -> Dict[str, str]:
+        return dict(os.environ)
 
     def get_latest_release(self) -> str:
         raise errors.UnsupportedConfigurationValue("Rust tag must either be explicit, empty or 'nightly'")

multiversx_sdk_cli/projects/project_rust.py

@@ -1,4 +1,5 @@
 import logging
+import shutil
 import subprocess
 from pathlib import Path
 from typing import Any, Dict, List, Set, cast
@@ -53,7 +54,14 @@ def prepare_build_wasm_args(self, args: List[str]):
             self.get_output_folder()
         ])
 
+    def check_if_sc_meta_is_installed(self):
+        which_sc_meta = shutil.which("sc-meta")
+
+        if which_sc_meta is None:
+            raise errors.KnownError("'sc-meta' is not installed. Run 'cargo install multiversx-sc-meta' then try again.")
+
     def run_meta(self):
+        self.check_if_sc_meta_is_installed()
         env = self.get_env()
 
         with_wasm_opt = not self.options.get("no-wasm-opt")
@@ -123,6 +131,8 @@ def get_env(self):
         return dependencies.get_module_by_key("rust").get_env()
 
     def build_wasm_with_debug_symbols(self, build_options: Dict[str, Any]):
+        self.check_if_sc_meta_is_installed()
+
         cwd = self.path
         env = self.get_env()
         target_dir: str = build_options.get("target-dir", "")

multiversx_sdk_cli/tests/shared.sh

@@ -16,7 +16,7 @@ PROXY="${PROXY:-http://localhost:7950}"
 CHAIN_ID="${CHAIN_ID:-localnet}"
 TestUser=./testdata/testUser.pem
 TestUser2=./testdata/testUser2.pem
-RUST_VERSION="nightly-2023-04-24"
+RUST_VERSION="nightly-2023-05-26"
 
 cleanSandbox() {
     rm -rf ${SANDBOX}