Merge pull request #852 from semantic-release/feat/error-when-glab-is-missing

feat: raise error when GitLab CLI is required but not installed

Author: fgreinacher

lib/definitions/errors.js

@@ -87,4 +87,8 @@ Please make sure the GitLab user associated with the token has the [permission t
 
 Please make sure to create a [GitLab personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html) and to set it in the \`GL_TOKEN\` or \`GITLAB_TOKEN\` environment variable on your CI environment. The token must allow to push to the repository ${repositoryUrl}.`,
   }),
+  EGLABNOTINSTALLED: () => ({
+    message: 'GitLab CLI not installed.',
+    details: 'The [GitLab CLI needs to be installed](https://gitlab.com/gitlab-org/cli#installation) so that the project\'s CI components can be published.',
+  }),
 };

lib/glab.js

@@ -0,0 +1,5 @@
+import { execa } from "execa";
+
+export default async (args, options) => {
+  return execa("glab", args, options);
+};

lib/publish.js

@@ -12,7 +12,7 @@ import resolveConfig from "./resolve-config.js";
 import getAssets from "./glob-assets.js";
 import { RELEASE_NAME } from "./definitions/constants.js";
 import getProjectContext from "./get-project-context.js";
-import { execa } from "execa";
+import glab from "./glab.js";
 const isUrlScheme = (value) => /^(https|http|ftp):\/\//.test(value);
 
 export default async (pluginConfig, context) => {
@@ -195,7 +195,7 @@ export default async (pluginConfig, context) => {
 
   if (publishToCatalog) {
     try {
-      await execa("glab", ["repo", "publish", "catalog", gitTag], {
+      await glab(["repo", "publish", "catalog", gitTag], {
         cwd,
         timeout: 30 * 1000,
         env: { GITLAB_TOKEN: gitlabToken },

lib/verify.js

@@ -30,7 +30,10 @@ export default async (pluginConfig, context) => {
     options: { repositoryUrl },
     logger,
   } = context;
-  const { gitlabToken, gitlabUrl, gitlabApiUrl, proxy, ...options } = resolveConfig(pluginConfig, context);
+  const { gitlabToken, gitlabUrl, gitlabApiUrl, proxy, publishToCatalog, ...options } = resolveConfig(
+    pluginConfig,
+    context
+  );
   const { projectPath, projectApiUrl } = getProjectContext(context, gitlabUrl, gitlabApiUrl, repositoryUrl);
 
   debug("apiUrl: %o", gitlabApiUrl);
@@ -89,6 +92,18 @@ export default async (pluginConfig, context) => {
     }
   }
 
+  if (publishToCatalog === true) {
+    try {
+      logger.log("Verifying that the GitLab CLI is installed");
+      await glab(["version"], {
+        timeout: 5 * 1000,
+      });
+    } catch (error) {
+      logger.error("The GitLab CLI is required but failed to run:\n%O", error);
+      errors.push(getError("EGLABNOTINSTALLED"));
+    }
+  }
+
   if (errors.length > 0) {
     throw new AggregateError(errors);
   }

test/verify.test.js

@@ -3,6 +3,7 @@ import nock from "nock";
 import { stub } from "sinon";
 import verify from "../lib/verify.js";
 import authenticate from "./helpers/mock-gitlab.js";
+import * as td from "testdouble";
 
 /* eslint camelcase: ["error", {properties: "never"}] */
 
@@ -988,3 +989,34 @@ test.serial(
     t.true(gitlab.isDone());
   }
 );
+
+test.serial(
+  'Throw SemanticReleaseError if "publishToCatalog" option is set and the GitLab CLI is not installed.',
+  async (t) => {
+    const owner = "test_user";
+    const repo = "test_repo";
+    const env = { GITLAB_TOKEN: "gitlab_token" };
+    const gitlab = authenticate(env)
+      .get(`/projects/${owner}%2F${repo}`)
+      .reply(200, { permissions: { project_access: { access_level: 40 } } });
+
+    const execa = (await td.replaceEsm("execa")).execa;
+    td.when(
+      execa("glab", ["version"], {
+        timeout: 5000,
+      })
+    ).thenReject();
+    const verifyWithMockExeca = (await import("../lib/verify.js")).default;
+    const {
+      errors: [error],
+    } = await t.throwsAsync(
+      verifyWithMockExeca(
+        { publishToCatalog: true },
+        { env, options: { repositoryUrl: `https://gitlab.com/${owner}/${repo}.git` }, logger: t.context.logger }
+      )
+    );
+    t.is(error.name, "SemanticReleaseError");
+    t.is(error.code, "EGLABNOTINSTALLED");
+    t.true(gitlab.isDone());
+  }
+);