LUAFDN-784 Try to download all tools before erroring

scripts/end-to-end-tests.sh

@@ -39,8 +39,23 @@ verify_gitlab_tool () {
     rm foreman.toml
 }
 
+verify_install_all_before_fail () {
+    write_foreman_toml github NotARealTool "roblox/not-a-real-tool" "0.1.0"
+    echo "$1 = { github = \"$2\", version = \"=$3\" }" >> foreman.toml
+    {
+        # try
+        foreman install
+    } || {
+        # finally
+        verify_tool_version $1 $3
+        rm foreman.toml
+    }
+}
+
 verify_github_tool Rojo "rojo-rbx/rojo" "6.0.0"
 verify_github_tool remodel "rojo-rbx/remodel" "0.9.1"
 verify_github_tool stylua "JohnnyMorganz/stylua" "0.11.3"
 
 verify_gitlab_tool darklua "seaofvoices/darklua" "0.7.0"
+
+verify_install_all_before_fail selene "Kampfkarren/selene" "0.22.0"

src/config.rs

@@ -1,4 +1,4 @@
-use std::{collections::HashMap, env, fmt};
+use std::{collections::BTreeMap, env, fmt};
 
 use semver::VersionReq;
 use serde::{Deserialize, Serialize};
@@ -69,13 +69,13 @@ impl fmt::Display for ToolSpec {
 
 #[derive(Debug, Serialize, Deserialize)]
 pub struct ConfigFile {
-    pub tools: HashMap<String, ToolSpec>,
+    pub tools: BTreeMap<String, ToolSpec>,
 }
 
 impl ConfigFile {
     pub fn new() -> Self {
         Self {
-            tools: HashMap::new(),
+            tools: BTreeMap::new(),
         }
     }
 

src/error.rs

@@ -68,6 +68,9 @@ pub enum ForemanError {
         current_path: PathBuf,
         config_file: ConfigFile,
     },
+    ToolsNotDownloaded {
+        tools: Vec<String>,
+    },
 }
 
 impl ForemanError {
@@ -302,6 +305,9 @@ impl fmt::Display for ForemanError {
                 current_path.display(),
                 config_file,
             ),
+            Self::ToolsNotDownloaded { tools } => {
+                write!(f, "The following tools were not installed:\n{:#?}", tools)
+            }
         }
     }
 }

src/main.rs

@@ -197,10 +197,31 @@ fn actual_main(paths: ForemanPaths) -> ForemanResult<()> {
 
             let mut cache = ToolCache::load(&paths)?;
 
-            for (tool_alias, tool_spec) in &config.tools {
-                let providers = ToolProvider::new(&paths);
-                cache.download_if_necessary(tool_spec, &providers)?;
-                add_self_alias(tool_alias, &paths.bin_dir())?;
+            let providers = ToolProvider::new(&paths);
+
+            let tools_not_downloaded: Vec<String> = config
+                .tools
+                .iter()
+                .filter_map(|(tool_alias, tool_spec)| {
+                    cache
+                        .download_if_necessary(tool_spec, &providers)
+                        .and_then(|_| add_self_alias(tool_alias, &paths.bin_dir()))
+                        .err()
+                        .map(|err| {
+                            log::error!(
+                                "The following error occurred while trying to download tool \"{}\":\n{}",
+                                tool_alias,
+                                err
+                            );
+                            tool_alias.to_string()
+                        })
+                })
+                .collect();
+
+            if !tools_not_downloaded.is_empty() {
+                return Err(ForemanError::ToolsNotDownloaded {
+                    tools: tools_not_downloaded,
+                });
             }
 
             if config.tools.is_empty() {

tests/cli.rs

@@ -181,3 +181,20 @@ stylua = { github = "JohnnyMorganz/StyLua", version = "0.11.3" }
     );
     context.snapshot_command("install_invalid_auth_configuration");
 }
+
+#[test]
+fn snapshot_install_all_tools_before_failing() {
+    let mut context = TestContext::foreman().arg("install");
+    let config_path = context.path_from_working_directory("foreman.toml");
+    write_file(
+        &config_path,
+        r#"
+[tools]
+not-a-real-tool = { github = "Roblox/VeryFakeRepository", version = "0.1.0" }
+badly-formatted-tool = { github = "Roblox/", version = "0.2.0" }
+also-not-a-real-tool = { github = "Roblox/NotARepository", version = "0.1.0" }
+    "#,
+    );
+
+    context.snapshot_command("install_all_tools_before_failing");
+}

tests/snapshots/install_all_tools_before_failing.snap

@@ -0,0 +1,33 @@
+---
+source: tests/cli.rs
+assertion_line: 101
+expression: content
+---
+[INFO ] Downloading github.com/Roblox/NotARepository@^0.1.0
+[ERROR] The following error occurred while trying to download tool "also-not-a-real-tool":
+        unexpected response body: invalid type: map, expected a sequence at line 1 column 0
+        Request from `https://api.github.com/repos/Roblox/NotARepository/releases`
+
+        Received body:
+        {"message":"Not Found","documentation_url":"https://docs.github.com/rest/reference/repos#list-releases"}
+[INFO ] Downloading github.com/Roblox/@^0.2.0
+[ERROR] The following error occurred while trying to download tool "badly-formatted-tool":
+        unexpected response body: invalid type: map, expected a sequence at line 1 column 0
+        Request from `https://api.github.com/repos/Roblox//releases`
+
+        Received body:
+        {"message":"Not Found","documentation_url":"https://docs.github.com/rest"}
+[INFO ] Downloading github.com/Roblox/VeryFakeRepository@^0.1.0
+[ERROR] The following error occurred while trying to download tool "not-a-real-tool":
+        unexpected response body: invalid type: map, expected a sequence at line 1 column 0
+        Request from `https://api.github.com/repos/Roblox/VeryFakeRepository/releases`
+
+        Received body:
+        {"message":"Not Found","documentation_url":"https://docs.github.com/rest/reference/repos#list-releases"}
+The following tools were not installed:
+[
+    "also-not-a-real-tool",
+    "badly-formatted-tool",
+    "not-a-real-tool",
+]
+

tests/snapshots/install_invalid_auth_configuration.snap

@@ -2,22 +2,26 @@
 source: tests/cli.rs
 assertion_line: 101
 expression: content
-
 ---
 [INFO ] Downloading github.com/JohnnyMorganz/StyLua@^0.11.3
-unable to parse Foreman authentication file (at {{FOREMAN_HOME}}auth.toml): expected an equals, found eof at line 1 column 8
-
-A Foreman authentication file looks like this:
-
-# For authenticating with GitHub.com, put a personal access token here under the
-# `github` key. This is useful if you hit GitHub API rate limits or if you need
-# to access private tools.
-
-github = "YOUR_TOKEN_HERE"
-
-# For authenticating with GitLab.com, put a personal access token here under the
-# `gitlab` key. This is useful if you hit GitLab API rate limits or if you need
-# to access private tools.
-
-gitlab = "YOUR_TOKEN_HERE"
+[ERROR] The following error occurred while trying to download tool "stylua":
+        unable to parse Foreman authentication file (at {{FOREMAN_HOME}}auth.toml): expected an equals, found eof at line 1 column 8
+
+        A Foreman authentication file looks like this:
+
+        # For authenticating with GitHub.com, put a personal access token here under the
+        # `github` key. This is useful if you hit GitHub API rate limits or if you need
+        # to access private tools.
+
+        github = "YOUR_TOKEN_HERE"
+
+        # For authenticating with GitLab.com, put a personal access token here under the
+        # `gitlab` key. This is useful if you hit GitLab API rate limits or if you need
+        # to access private tools.
+
+        gitlab = "YOUR_TOKEN_HERE"
+The following tools were not installed:
+[
+    "stylua",
+]