fix(verifyConditions): skip google service account key verification w…

…hen `publishPub` is false (#56)
zeshuaro · Oct 11, 2023 · 21196e3 · 21196e3
1 parent bb9f001
commit 21196e3
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 11 deletions.
diff --git a/src/verifyConditions.ts b/src/verifyConditions.ts
@@ -1,20 +1,31 @@
 import SemanticReleaseError from '@semantic-release/error';
 import { execa } from 'execa';
+import { VerifyConditionsContext } from 'semantic-release';
 import { PluginConfig } from './types.js';
 import { getConfig, getGoogleIdentityToken } from './utils.js';
 
-export const verifyConditions = async (pluginConfig: PluginConfig) => {
-  const { cli } = getConfig(pluginConfig);
+export const verifyConditions = async (
+  pluginConfig: PluginConfig,
+  { logger }: VerifyConditionsContext
+) => {
+  const { cli, publishPub } = getConfig(pluginConfig);
   const { GOOGLE_SERVICE_ACCOUNT_KEY } = process.env;
 
-  if (!GOOGLE_SERVICE_ACCOUNT_KEY) {
-    throw new SemanticReleaseError(
-      'Environment variable not found: GOOGLE_SERVICE_ACCOUNT_KEY'
+  if (publishPub) {
+    if (!GOOGLE_SERVICE_ACCOUNT_KEY) {
+      throw new SemanticReleaseError(
+        'Environment variable not found: GOOGLE_SERVICE_ACCOUNT_KEY'
+      );
+    }
+
+    await getGoogleIdentityToken(GOOGLE_SERVICE_ACCOUNT_KEY);
+  } else {
+    logger.log(
+      `Skipping Google service account key verification as publishPub is ${publishPub}`
     );
   }
 
   await verifyCommand(cli);
-  await getGoogleIdentityToken(GOOGLE_SERVICE_ACCOUNT_KEY);
 };
 
 const verifyCommand = async (command: string) => {

diff --git a/tests/verifyConditions.test.ts b/tests/verifyConditions.test.ts
@@ -1,6 +1,9 @@
 import SemanticReleaseError from '@semantic-release/error';
 import { execa } from 'execa';
+import { VerifyConditionsContext } from 'semantic-release';
+import { Signale } from 'signale';
 import { afterEach, beforeEach, describe, expect, test, vi } from 'vitest';
+import { mock } from 'vitest-mock-extended';
 import { PluginConfig, verifyConditions } from '../src/index.js';
 import { getConfig, getGoogleIdentityToken } from '../src/utils.js';
 
@@ -13,9 +16,14 @@ describe('verifyConditions', () => {
   const serviceAccount = 'serviceAccount';
   const idToken = 'idToken';
 
-  const config: PluginConfig = { cli };
+  const config: PluginConfig = { cli, publishPub: true };
+
+  const logger = mock<Signale>();
+  const context = mock<VerifyConditionsContext>();
 
   beforeEach(() => {
+    context.logger = logger;
+
     vi.mocked(getConfig).mockReturnValue(config);
     vi.mocked(getGoogleIdentityToken).mockResolvedValue(idToken);
   });
@@ -28,10 +36,20 @@ describe('verifyConditions', () => {
   test('success', async () => {
     stubEnv();
 
-    await verifyConditions(config);
+    await verifyConditions(config, context);
 
     expect(execa).toBeCalledWith(cli);
-    expect(getGoogleIdentityToken).toHaveBeenNthCalledWith(1, serviceAccount);
+    expectGetGoogleIdentityTokenCalled();
+  });
+
+  test('success with publishPub=false', async () => {
+    const config: PluginConfig = { cli, publishPub: false };
+    vi.mocked(getConfig).mockReturnValue(config);
+
+    await verifyConditions(config, context);
+
+    expect(execa).toBeCalledWith(cli);
+    expect(getGoogleIdentityToken).toBeCalledTimes(0);
   });
 
   test('error due to missing environment variable', async () => {
@@ -50,14 +68,17 @@ describe('verifyConditions', () => {
     await expectSemanticReleaseError();
 
     expect(execa).toBeCalledWith(cli);
-    expect(getGoogleIdentityToken).toBeCalledTimes(0);
+    expectGetGoogleIdentityTokenCalled();
   });
 
   const stubEnv = () =>
     vi.stubEnv('GOOGLE_SERVICE_ACCOUNT_KEY', serviceAccount);
 
+  const expectGetGoogleIdentityTokenCalled = () =>
+    expect(getGoogleIdentityToken).toHaveBeenNthCalledWith(1, serviceAccount);
+
   const expectSemanticReleaseError = async () => {
-    await expect(() => verifyConditions(config)).rejects.toThrowError(
+    await expect(() => verifyConditions(config, context)).rejects.toThrowError(
       SemanticReleaseError
     );
   };