feat(ubi): add support for self-hosted GitHub/GitLab (jdx#4765)

Fixes #4749

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: roele

Cargo.lock

@@ -151,6 +151,7 @@ zip = { version = "=2.5.0", default-features = false, features = ["deflate"] }
 zstd = "0.13"
 gix = { version = "<1", features = ["worktree-mutation"] }
 jiff = "0.2"
+urlencoding = "2.1.3"
 
 [target.'cfg(unix)'.dependencies]
 exec = "0.3"

Cargo.toml

@@ -11,10 +11,12 @@ By default, this will use a `mise.toml` file in the current directory.
 
 In the following order:
 
+- If `--global` is set, it will use the global config file.
+- If `--path` is set, it will use the config file at the given path.
+- If `--env` is set, it will use `mise.<env>.toml`.
 - If `MISE_DEFAULT_CONFIG_FILENAME` is set, it will use that instead.
 - If `MISE_OVERRIDE_CONFIG_FILENAMES` is set, it will the first from that list.
-- If `MISE_ENV` is set, it will use a `mise.<env>.toml` instead.
-- Otherwise just "mise.toml"
+- Otherwise just "mise.toml" or global config if cwd is home directory.
 
 Use the `--global` flag to use the global config file instead.
 

docs/cli/use.md

@@ -69,6 +69,26 @@ then this will be ignored.
 "ubi:BurntSushi/ripgrep" = { version = "latest", matching = "musl" }
 ```
 
+### `provider`
+
+Set the provider type to use for fetching assets and release information. Either `github` or `gitlab` (default is `github`).
+Ensure the `provider` is set to the correct type if you use `api_url` as the type probably cannot be derived correctly
+from the URL.
+
+```toml
+[tools]
+"ubi:gitlab-org/cli" = { version = "latest", exe = "glab", provider = "gitlab" }
+```
+
+### `api_url`
+
+Set the URL for the provider's API. This is useful when using a self-hosted instance.
+
+```toml
+[tools]
+"ubi:acme/my-tool" = { version = "latest", provider= "gitlab", api_url = "https://gitlab.acme.com/api/v4" }
+```
+
 ### `extract_all`
 
 Set to `true` to extract all files in the tarball instead of just the "bin". Not compatible with `exe` nor `rename_exe`.
@@ -100,6 +120,12 @@ releases.
 "ubi:cargo-bins/cargo-binstall" = { version = "latest", tag_regex = "^\d+\." }
 ```
 
+## Self-hosted GitHub/GitLab
+
+If you are using a self-hosted GitHub/GitLab instance, you can set the `provider` and `api_url` tool options.
+Additionally, you can set the `MISE_GITHUB_ENTERPRISE_TOKEN` or `MISE_GITLAB_ENTERPRISE_TOKEN` environment variable to
+authenticate with the API.
+
 ## Supported Ubi Syntax
 
 - **GitHub shorthand for latest release version:** `ubi:goreleaser/goreleaser`

docs/dev-tools/backends/ubi.md

@@ -14,6 +14,15 @@ mise use ubi:cilium/cilium-cli
 assert "cat mise.toml" '[tools]
 "ubi:cilium/cilium-cli" = { version = "latest", exe = "cilium" }'
 
+assert "mise x ubi:gitlab-org/cli[exe=glab,provider=gitlab]@1.54.0 -- glab --version | grep -o 1.54.0" "1.54.0"
+
+cat <<EOF >mise.toml
+[tools]
+"ubi:gitlab-org/cli" = { version = "1.55.0", exe = "glab", provider = "gitlab" }
+EOF
+mise use ubi:gitlab-org/[email protected]
+assert "mise x ubi:gitlab-org/[email protected] -- glab --version | grep -o 1.55.0" "1.55.0"
+
 MISE_USE_VERSIONS_HOST=0 assert_not_contains "mise ls-remote cargo-binstall" "binstalk"
 
 # the following tests that tool options from ubi are still retained even if the default backend changes to aqua

e2e/backend/test_ubi

@@ -941,7 +941,7 @@ cmd usage hide=#true help="Generate a usage CLI spec" {
 }
 cmd use help="Installs a tool and adds the version to mise.toml." {
     alias u
-    long_help "Installs a tool and adds the version to mise.toml.\n\nThis will install the tool version if it is not already installed.\nBy default, this will use a `mise.toml` file in the current directory.\n\nIn the following order:\n  - If `MISE_DEFAULT_CONFIG_FILENAME` is set, it will use that instead.\n  - If `MISE_OVERRIDE_CONFIG_FILENAMES` is set, it will the first from that list.\n  - If `MISE_ENV` is set, it will use a `mise.<env>.toml` instead.\n  - Otherwise just \"mise.toml\"\n\nUse the `--global` flag to use the global config file instead."
+    long_help "Installs a tool and adds the version to mise.toml.\n\nThis will install the tool version if it is not already installed.\nBy default, this will use a `mise.toml` file in the current directory.\n\nIn the following order:\n  - If `--global` is set, it will use the global config file.\n  - If `--path` is set, it will use the config file at the given path.\n  - If `--env` is set, it will use `mise.<env>.toml`.\n  - If `MISE_DEFAULT_CONFIG_FILENAME` is set, it will use that instead.\n  - If `MISE_OVERRIDE_CONFIG_FILENAMES` is set, it will the first from that list.\n  - Otherwise just \"mise.toml\" or global config if cwd is home directory.\n\nUse the `--global` flag to use the global config file instead."
     after_long_help "Examples:\n    \n    # run with no arguments to use the interactive selector\n    $ mise use\n\n    # set the current version of node to 20.x in mise.toml of current directory\n    # will write the fuzzy version (e.g.: 20)\n    $ mise use node@20\n\n    # set the current version of node to 20.x in ~/.config/mise/config.toml\n    # will write the precise version (e.g.: 20.0.0)\n    $ mise use -g --pin node@20\n\n    # sets .mise.local.toml (which is intended not to be committed to a project)\n    $ mise use --env local node@20\n\n    # sets .mise.staging.toml (which is used if MISE_ENV=staging)\n    $ mise use --env staging node@20\n"
     flag "-f --force" help="Force reinstall even if already installed"
     flag --fuzzy help="Save fuzzy version to config file" {

mise.usage.kdl

@@ -2,12 +2,14 @@ use crate::backend::Backend;
 use crate::backend::backend_type::BackendType;
 use crate::cli::args::BackendArg;
 use crate::config::SETTINGS;
-use crate::env::GITHUB_TOKEN;
+use crate::env::{
+    GITHUB_TOKEN, GITLAB_TOKEN, MISE_GITHUB_ENTERPRISE_TOKEN, MISE_GITLAB_ENTERPRISE_TOKEN,
+};
 use crate::install_context::InstallContext;
 use crate::plugins::VERSION_REGEX;
 use crate::tokio::RUNTIME;
 use crate::toolset::ToolVersion;
-use crate::{file, github, hash};
+use crate::{file, github, gitlab, hash};
 use eyre::bail;
 use itertools::Itertools;
 use regex::Regex;
@@ -39,14 +41,43 @@ impl Backend for UbiBackend {
             Ok(vec!["latest".to_string()])
         } else {
             let opts = self.ba.opts();
+            let forge = match opts.get("provider") {
+                Some(forge) => ForgeType::from_str(forge)?,
+                None => ForgeType::default(),
+            };
+            let api_url = match opts.get("api_url") {
+                Some(api_url) => api_url,
+                None => match forge {
+                    ForgeType::GitHub => github::API_URL,
+                    ForgeType::GitLab => gitlab::API_URL,
+                },
+            };
             let tag_regex = OnceLock::new();
-            let mut versions = github::list_releases(&self.tool_name())?
-                .into_iter()
-                .map(|r| r.tag_name)
-                .collect::<Vec<String>>();
+            let mut versions = match forge {
+                ForgeType::GitHub => github::list_releases_from_url(api_url, &self.tool_name())?
+                    .into_iter()
+                    .map(|r| r.tag_name)
+                    .collect::<Vec<String>>(),
+                ForgeType::GitLab => gitlab::list_releases_from_url(api_url, &self.tool_name())?
+                    .into_iter()
+                    .map(|r| r.tag_name)
+                    .collect::<Vec<String>>(),
+            };
             if versions.is_empty() {
-                versions = github::list_tags(&self.tool_name())?.into_iter().collect();
+                match forge {
+                    ForgeType::GitHub => {
+                        versions = github::list_tags_from_url(api_url, &self.tool_name())?
+                            .into_iter()
+                            .collect();
+                    }
+                    ForgeType::GitLab => {
+                        versions = gitlab::list_tags_from_url(api_url, &self.tool_name())?
+                            .into_iter()
+                            .collect();
+                    }
+                }
             }
+
             Ok(versions
                 .into_iter()
                 // trim 'v' prefixes if they exist
@@ -75,10 +106,29 @@ impl Backend for UbiBackend {
     ) -> eyre::Result<ToolVersion> {
         let mut v = tv.version.to_string();
         let opts = tv.request.options();
+        let forge = match opts.get("provider") {
+            Some(forge) => ForgeType::from_str(forge)?,
+            None => ForgeType::default(),
+        };
+        let api_url = match opts.get("api_url") {
+            Some(api_url) => api_url,
+            None => match forge {
+                ForgeType::GitHub => github::API_URL,
+                ForgeType::GitLab => gitlab::API_URL,
+            },
+        };
         let extract_all = opts.get("extract_all").is_some_and(|v| v == "true");
         let bin_dir = tv.install_path();
 
-        if let Err(err) = github::get_release(&self.tool_name(), &tv.version) {
+        let release: Result<_, eyre::Report> = match forge {
+            ForgeType::GitHub => {
+                github::get_release_for_url(api_url, &self.tool_name(), &v).map(|_| "github")
+            }
+            ForgeType::GitLab => {
+                gitlab::get_release_for_url(api_url, &self.tool_name(), &v).map(|_| "gitlab")
+            }
+        };
+        if let Err(err) = release {
             // this can fail with a rate limit error or 404, either way, try prefixing and if it fails, try without the prefix
             // if http::error_code(&err) == Some(404) {
             debug!(
@@ -95,10 +145,6 @@ impl Backend for UbiBackend {
 
             let mut builder = UbiBuilder::new().project(&name).install_dir(&bin_dir);
 
-            if let Some(token) = &*GITHUB_TOKEN {
-                builder = builder.token(token);
-            }
-
             if v != "latest" {
                 builder = builder.tag(v);
             }
@@ -116,8 +162,19 @@ impl Backend for UbiBackend {
             if let Some(matching) = opts.get("matching") {
                 builder = builder.matching(matching);
             }
-            if let Some(forge) = opts.get("forge") {
-                builder = builder.forge(ForgeType::from_str(forge)?);
+
+            let forge = match opts.get("provider") {
+                Some(forge) => ForgeType::from_str(forge)?,
+                None => ForgeType::default(),
+            };
+            builder = builder.forge(forge.clone());
+            builder = set_token(builder, &forge);
+
+            if let Some(api_url) = opts.get("api_url") {
+                if !api_url.contains("github.com") && !api_url.contains("gitlab.com") {
+                    builder = builder.api_base_url(api_url);
+                    builder = set_enterprise_token(builder, &forge);
+                }
             }
 
             let mut ubi = builder.build().map_err(|e| eyre::eyre!(e))?;
@@ -247,3 +304,37 @@ impl UbiBackend {
 fn name_is_url(n: &str) -> bool {
     n.starts_with("http")
 }
+
+fn set_token<'a>(mut builder: UbiBuilder<'a>, forge: &ForgeType) -> UbiBuilder<'a> {
+    match forge {
+        ForgeType::GitHub => {
+            if let Some(token) = &*GITHUB_TOKEN {
+                builder = builder.token(token)
+            }
+            builder
+        }
+        ForgeType::GitLab => {
+            if let Some(token) = &*GITLAB_TOKEN {
+                builder = builder.token(token)
+            }
+            builder
+        }
+    }
+}
+
+fn set_enterprise_token<'a>(mut builder: UbiBuilder<'a>, forge: &ForgeType) -> UbiBuilder<'a> {
+    match forge {
+        ForgeType::GitHub => {
+            if let Some(token) = &*MISE_GITHUB_ENTERPRISE_TOKEN {
+                builder = builder.token(token);
+            }
+            builder
+        }
+        ForgeType::GitLab => {
+            if let Some(token) = &*MISE_GITLAB_ENTERPRISE_TOKEN {
+                builder = builder.token(token);
+            }
+            builder
+        }
+    }
+}

src/backend/ubi.rs

@@ -177,6 +177,10 @@ impl BackendArg {
         })
     }
 
+    pub fn set_opts(&mut self, opts: Option<ToolVersionOptions>) {
+        self.opts = opts;
+    }
+
     pub fn tool_name(&self) -> String {
         let full = self.full();
         let (_backend, tool_name) = full.split_once(':').unwrap_or(("", &full));

src/cli/args/backend_arg.rs

@@ -439,7 +439,11 @@ impl ConfigFile for MiseToml {
                     for v in options.opts.values_mut() {
                         *v = self.parse_template(v)?;
                     }
-                    ToolRequest::new_opts(ba.clone(), &version, options, source.clone())?
+                    let mut ba = ba.clone();
+                    let mut ba_opts = ba.opts().clone();
+                    ba_opts.merge(&options.opts);
+                    ba.set_opts(Some(ba_opts.clone()));
+                    ToolRequest::new_opts(ba, &version, options, source.clone())?
                 } else {
                     ToolRequest::new(ba.clone(), &version, source.clone())?
                 };

src/config/config_file/mise_toml.rs

@@ -223,6 +223,43 @@ pub static GITHUB_TOKEN: Lazy<Option<String>> = Lazy::new(|| {
 
     token
 });
+pub static MISE_GITHUB_ENTERPRISE_TOKEN: Lazy<Option<String>> =
+    Lazy::new(|| match var("MISE_GITHUB_ENTERPRISE_TOKEN") {
+        Ok(v) if v.trim() != "" => {
+            set_var("MISE_GITHUB_ENTERPRISE_TOKEN", &v);
+            Some(v)
+        }
+        _ => {
+            remove_var("MISE_GITHUB_ENTERPRISE_TOKEN");
+            None
+        }
+    });
+pub static GITLAB_TOKEN: Lazy<Option<String>> =
+    Lazy::new(
+        || match var("MISE_GITLAB_TOKEN").or_else(|_| var("GITLAB_TOKEN")) {
+            Ok(v) if v.trim() != "" => {
+                set_var("MISE_GITLAB_TOKEN", &v);
+                set_var("GITLAB_TOKEN", &v);
+                Some(v)
+            }
+            _ => {
+                remove_var("MISE_GITLAB_TOKEN");
+                remove_var("GITLAB_TOKEN");
+                None
+            }
+        },
+    );
+pub static MISE_GITLAB_ENTERPRISE_TOKEN: Lazy<Option<String>> =
+    Lazy::new(|| match var("MISE_GITLAB_ENTERPRISE_TOKEN") {
+        Ok(v) if v.trim() != "" => {
+            set_var("MISE_GITLAB_ENTERPRISE_TOKEN", &v);
+            Some(v)
+        }
+        _ => {
+            remove_var("MISE_GITLAB_ENTERPRISE_TOKEN");
+            None
+        }
+    });
 
 pub static TEST_TRANCHE: Lazy<usize> = Lazy::new(|| var_u8("TEST_TRANCHE") as usize);
 pub static TEST_TRANCHE_COUNT: Lazy<usize> = Lazy::new(|| var_u8("TEST_TRANCHE_COUNT") as usize);