add tests for validating blank inputs

Author: rexebin

.github/linters/.eslintrc.yml

@@ -47,7 +47,7 @@ rules:
     'semi': 'off',
     '@typescript-eslint/array-type': 'error',
     '@typescript-eslint/await-thenable': 'error',
-    '@typescript-eslint/ban-ts-comment': 'error',
+    '@typescript-eslint/ban-ts-comment': 'off',
     '@typescript-eslint/consistent-type-assertions': 'error',
     '@typescript-eslint/explicit-member-accessibility':
       [ 'error', { 'accessibility': 'no-public' } ],

__tests__/get-current-version.test.ts

@@ -3,6 +3,8 @@
  */
 
 import { getCurrentVersion } from '../src/get-current-version';
+// @ts-ignore
+import { mockInputs } from './mock-inputs';
 
 function mockVersion(version: string) {
   jest.spyOn(global, 'fetch').mockResolvedValue({
@@ -18,6 +20,10 @@ afterEach(() => {
 });
 
 describe('get current version', () => {
+  beforeEach(() => {
+    mockInputs('1', '0', 'false');
+  });
+
   it('should return current version', async () => {
     mockVersion('1.0.0');
     const result = await getCurrentVersion('token');

__tests__/main.test.ts

@@ -1,5 +1,7 @@
 import { run } from '../src/main';
 import * as core from '@actions/core';
+// @ts-ignore
+import { mockInputs } from './mock-inputs';
 
 function mockCurrentVersion(version: string) {
   jest.spyOn(global, 'fetch').mockResolvedValue({
@@ -9,32 +11,6 @@ function mockCurrentVersion(version: string) {
     ok: true
   } as any as Promise<Response>);
 }
-
-function mockInputs(
-  majorVersion: string,
-  minorVersion: string,
-  publishBeta: string
-) {
-  jest.spyOn(core, 'getInput').mockImplementation((name: string) => {
-    if (name === 'org') {
-      return 'org';
-    }
-    if (name === 'packageName') {
-      return 'packageName';
-    }
-    if (name === 'minorVersion') {
-      return minorVersion;
-    }
-    if (name === 'majorVersion') {
-      return majorVersion;
-    }
-    if (name === 'publishBeta') {
-      return publishBeta;
-    }
-    throw new Error(`Unexpected input ${name}`);
-  });
-}
-
 afterEach(() => {
   jest.restoreAllMocks();
 });
@@ -50,13 +26,49 @@ describe('get current version', () => {
     process.env = OLD_ENV; // Restore old environment
   });
 
-  it('should throw if no token is given', async () => {
-    process.env = { ...OLD_ENV, ...{ GITHUB_TOKEN: undefined } };
-    jest.spyOn(core, 'setFailed');
-    await run();
-    expect(core.setFailed).toHaveBeenCalledWith(
-      'GITHUB_TOKEN not set, please set the GITHUB_TOKEN environment variable to secrets.GITHUB_TOKEN'
-    );
+  describe('inputs should be validated', () => {
+    it('should throw if no token is given', async () => {
+      process.env = { ...OLD_ENV, ...{ GITHUB_TOKEN: undefined } };
+      jest.spyOn(core, 'setFailed');
+      await run();
+      expect(core.setFailed).toHaveBeenCalledWith(
+        'GITHUB_TOKEN not set, please set the GITHUB_TOKEN environment variable to secrets.GITHUB_TOKEN'
+      );
+    });
+
+    it('should throw if no org is given', async () => {
+      mockInputs('1', '0', 'false', '');
+      jest.spyOn(core, 'setFailed');
+      await run();
+      expect(core.setFailed).toHaveBeenCalledWith('Input org is not set');
+    });
+
+    it('should throw if no package name is given', async () => {
+      mockInputs('1', '0', 'false', 'org', '');
+      jest.spyOn(core, 'setFailed');
+      await run();
+      expect(core.setFailed).toHaveBeenCalledWith(
+        'Input packageName is not set'
+      );
+    });
+
+    it('should throw if no major version is given', async () => {
+      mockInputs('', '0', 'false');
+      jest.spyOn(core, 'setFailed');
+      await run();
+      expect(core.setFailed).toHaveBeenCalledWith(
+        'Input majorVersion is not set'
+      );
+    });
+
+    it('should throw if no minor version is given', async () => {
+      mockInputs('1', '', 'false');
+      jest.spyOn(core, 'setFailed');
+      await run();
+      expect(core.setFailed).toHaveBeenCalledWith(
+        'Input minorVersion is not set'
+      );
+    });
   });
 
   describe('when current version is empty', () => {

__tests__/mock-inputs.ts

@@ -0,0 +1,28 @@
+import * as core from '@actions/core';
+
+export function mockInputs(
+  majorVersion: string,
+  minorVersion: string,
+  publishBeta: string,
+  org = 'org',
+  packageName = 'packageName'
+) {
+  jest.spyOn(core, 'getInput').mockImplementation((name: string) => {
+    if (name === 'org') {
+      return org;
+    }
+    if (name === 'packageName') {
+      return packageName;
+    }
+    if (name === 'minorVersion') {
+      return minorVersion;
+    }
+    if (name === 'majorVersion') {
+      return majorVersion;
+    }
+    if (name === 'publishBeta') {
+      return publishBeta;
+    }
+    throw new Error(`Unexpected input ${name}`);
+  });
+}

dist/index.js

@@ -69,13 +69,13 @@
   },
   "devDependencies": {
     "@types/jest": "^29.5.6",
-    "@types/node": "^20.8.7",
-    "@typescript-eslint/eslint-plugin": "^6.8.0",
-    "@typescript-eslint/parser": "^6.8.0",
+    "@types/node": "^20.8.8",
+    "@typescript-eslint/eslint-plugin": "^6.9.0",
+    "@typescript-eslint/parser": "^6.9.0",
     "@vercel/ncc": "^0.38.1",
-    "eslint": "^8.51.0",
+    "eslint": "^8.52.0",
     "eslint-plugin-github": "^4.10.1",
-    "eslint-plugin-jest": "^27.4.2",
+    "eslint-plugin-jest": "^27.4.3",
     "eslint-plugin-jsonc": "^2.10.0",
     "eslint-plugin-prettier": "^5.0.1",
     "jest": "^29.7.0",

package.json

@@ -7,7 +7,14 @@ interface GithubPackageVersion {
 
 export async function getCurrentVersion(token: string): Promise<string> {
   const org: string = core.getInput('org');
+  if (org === '') {
+    throw new Error(`Input org is not set`);
+  }
+
   const packageName: string = core.getInput('packageName');
+  if (packageName === '') {
+    throw new Error(`Input packageName is not set`);
+  }
 
   const response: Response = await fetch(
     `https://api.github.com/orgs/${org}/packages/nuget/${packageName}/versions`,

src/get-current-version.ts

@@ -24,7 +24,15 @@ export async function run(): Promise<void> {
       );
     }
     const minorVersion = core.getInput('minorVersion');
+    if (minorVersion === '') {
+      throw new Error(`Input minorVersion is not set`);
+    }
+
     const majorVersion = core.getInput('majorVersion');
+    if (majorVersion === '') {
+      throw new Error(`Input majorVersion is not set`);
+    }
+
     const publishBeta = core.getInput('publishBeta').toLowerCase() === 'true';
 
     const currentVersion = await getCurrentVersion(token);