add tests to cover 100%

add case for not found

Author: rexebin

.github/linters/.eslintrc.yml

@@ -50,10 +50,10 @@ rules:
     '@typescript-eslint/ban-ts-comment': 'error',
     '@typescript-eslint/consistent-type-assertions': 'error',
     '@typescript-eslint/explicit-member-accessibility':
-      ['error', { 'accessibility': 'no-public' }],
-#    '@typescript-eslint/explicit-function-return-type':
-#      ['error', { 'allowExpressions': true, 'allowTypedFunctionExpressions': true }],
-    '@typescript-eslint/func-call-spacing': ['error', 'never'],
+      [ 'error', { 'accessibility': 'no-public' } ],
+    #    '@typescript-eslint/explicit-function-return-type':
+    #      ['error', { 'allowExpressions': true, 'allowTypedFunctionExpressions': true }],
+    '@typescript-eslint/func-call-spacing': [ 'error', 'never' ],
     '@typescript-eslint/no-array-constructor': 'error',
     '@typescript-eslint/no-empty-interface': 'error',
     '@typescript-eslint/no-explicit-any': 'off',
@@ -76,7 +76,6 @@ rules:
     '@typescript-eslint/promise-function-async': 'error',
     '@typescript-eslint/require-array-sort-compare': 'error',
     '@typescript-eslint/restrict-plus-operands': 'error',
-    '@typescript-eslint/semi': ['error', 'never'],
     '@typescript-eslint/space-before-function-paren': 'off',
     '@typescript-eslint/type-annotation-spacing': 'error',
     '@typescript-eslint/unbound-method': 'error'

.github/linters/tsconfig.json

@@ -4,6 +4,14 @@
   "compilerOptions": {
     "noEmit": true
   },
-  "include": ["../../__tests__/**/*", "../../src/**/*"],
-  "exclude": ["../../dist", "../../node_modules", "../../coverage", "*.json"]
+  "include": [
+    "../../__tests__/**/*",
+    "../../src/**/*"
+  ],
+  "exclude": [
+    "../../dist",
+    "../../node_modules",
+    "../../coverage",
+    "*.json"
+  ]
 }

.prettierrc.json

@@ -2,7 +2,7 @@
   "printWidth": 80,
   "tabWidth": 2,
   "useTabs": false,
-  "semi": false,
+  "semi": true,
   "singleQuote": true,
   "quoteProps": "as-needed",
   "jsxSingleQuote": false,

README.md

@@ -1,27 +1,29 @@
 # GitHub Action for calculate next nuget version from Github Packages
 
+[![GitHub Super-Linter](https://github.com/rexebin/next-nuget-package-version/actions/workflows/linter.yml/badge.svg)](https://github.com/super-linter/super-linter)
 ![CI](https://github.com/rexebin/next-nuget-package-version/actions/workflows/ci.yml/badge.svg)
 
-This github action calls GitHub API `https://api.github.com/orgs/${org}/packages/nuget/${packageName}/versions` with `${{ secrets.GITHUB_TOKEN }}`, to get the latest version and calculate the next version number from inputs such as:
+This github action calls GitHub API `https://api.github.com/orgs/${org}/packages/nuget/${packageName}/versions`
+with `${{ secrets.GITHUB_TOKEN }}`, to get the latest version and calculate the next version number from inputs such as:
 
 1. main version
 2. minor version
 3. publish beta or not
 
 ## Version Calculations
 
-|Main Version|Minor Version|Last Version|Publish Beta|Next Version| Note
-|---------|------|----|----|-|-
-|1|0|''|true|1.0.0-beta.1| first version
-|1|0|''|false|1.0.0|first version
-|1|0|'1.0.1'|true|1.0.2.beta.1| create beta 1 for next patch version
-|1|0|'1.0.1'|false|1.0.2| increment patch version
-|1|0|'1.0.1.beta.1'|true|1.0.1.beta.2| increment beta version
-|1|0|'1.0.1.beta.1'|false|1.0.1| create next version from beta
-|1|1|'1.0.20'|false|1.1.0|last version doesn't match input minor version, bump minor version
-|1|1|'1.0.20'|true|1.1.0.beta.1|last version doesn't match input minor version, bump minor version
-|2|0|'1.0.20.beta.1'|false|2.0.0|last version doesn't match input main version, bump main version
-|2|0|'1.0.20.beta.1'|false|2.0.0.beta.1|last version doesn't match input main version, bump main version
+| Main Version | Minor Version | Last Version    | Publish Beta | Next Version | Note                                                               
+|--------------|---------------|-----------------|--------------|--------------|--------------------------------------------------------------------
+| 1            | 0             | ''              | true         | 1.0.0-beta.1 | first version                                                      
+| 1            | 0             | ''              | false        | 1.0.0        | first version                                                      
+| 1            | 0             | '1.0.1'         | true         | 1.0.2.beta.1 | create beta 1 for next patch version                               
+| 1            | 0             | '1.0.1'         | false        | 1.0.2        | increment patch version                                            
+| 1            | 0             | '1.0.1.beta.1'  | true         | 1.0.1.beta.2 | increment beta version                                             
+| 1            | 0             | '1.0.1.beta.1'  | false        | 1.0.1        | create next version from beta                                      
+| 1            | 1             | '1.0.20'        | false        | 1.1.0        | last version doesn't match input minor version, bump minor version 
+| 1            | 1             | '1.0.20'        | true         | 1.1.0.beta.1 | last version doesn't match input minor version, bump minor version 
+| 2            | 0             | '1.0.20.beta.1' | false        | 2.0.0        | last version doesn't match input main version, bump main version   
+| 2            | 0             | '1.0.20.beta.1' | false        | 2.0.0.beta.1 | last version doesn't match input main version, bump main version   
 
 ## Usage
 

__tests__/get-current-version.test.ts

@@ -2,31 +2,55 @@
  * Unit tests for src/wait.ts
  */
 
-import { getCurrentVersion } from '../src/get-current-version'
+import { getCurrentVersion } from '../src/get-current-version';
 
 function mockVersion(version: string) {
   jest.spyOn(global, 'fetch').mockResolvedValue({
     json: jest
       .fn()
       .mockResolvedValue(version === '' ? [] : [{ name: version }]),
     ok: true
-  } as any as Promise<Response>)
+  } as any as Promise<Response>);
 }
 
 afterEach(() => {
-  jest.restoreAllMocks()
-})
+  jest.restoreAllMocks();
+});
 
 describe('get current version', () => {
   it('should return current version', async () => {
-    mockVersion('1.0.0')
-    const result = await getCurrentVersion('token')
-    expect(result).toBe('1.0.0')
-  })
+    mockVersion('1.0.0');
+    const result = await getCurrentVersion('token');
+    expect(result).toBe('1.0.0');
+  });
 
   it('should return empty string if no version', async () => {
-    mockVersion('')
-    const result = await getCurrentVersion('token')
-    expect(result).toBe('')
-  })
-})
+    mockVersion('');
+    const result = await getCurrentVersion('token');
+    expect(result).toBe('');
+  });
+
+  it('should return empty string if Github api returns 404 not found', async () => {
+    jest.spyOn(global, 'fetch').mockResolvedValue({
+      json: jest.fn(),
+      ok: false,
+      status: 404,
+      statusText: 'Not Found'
+    } as any as Promise<Response>);
+    const result = await getCurrentVersion('token');
+    expect(result).toBe('');
+  });
+
+  it('should throw if Github API return not Ok and not 404 not found', async () => {
+    jest.spyOn(global, 'fetch').mockResolvedValue({
+      json: jest.fn(),
+      ok: false,
+      status: 500,
+      statusText: 'Internal Server Error'
+    } as any as Promise<Response>);
+    const result = getCurrentVersion('token');
+    await expect(result).rejects.toThrow(
+      'Failed to get current version: Internal Server Error'
+    );
+  });
+});

__tests__/get-next-version.test.ts

@@ -2,27 +2,27 @@
  * Unit tests for src/wait.ts
  */
 
-import { expect } from '@jest/globals'
-import { getNextVersion } from '../src/get-next-version'
+import { expect } from '@jest/globals';
+import { getNextVersion } from '../src/get-next-version';
 
 describe('get next version', () => {
   it('should increment beta version from last beta version', () => {
-    const result = getNextVersion('1.0.0-beta.1', true)
-    expect(result).toBe('1.0.0-beta.2')
-  })
+    const result = getNextVersion('1.0.0-beta.1', true);
+    expect(result).toBe('1.0.0-beta.2');
+  });
 
   it('should publish main version from last beta', () => {
-    const result = getNextVersion('1.0.0-beta.1', false)
-    expect(result).toBe('1.0.0')
-  })
+    const result = getNextVersion('1.0.0-beta.1', false);
+    expect(result).toBe('1.0.0');
+  });
 
   it('should increment main version and create beta 1 for next patch version', () => {
-    const result = getNextVersion('1.0.0', true)
-    expect(result).toBe('1.0.1-beta.1')
-  })
+    const result = getNextVersion('1.0.0', true);
+    expect(result).toBe('1.0.1-beta.1');
+  });
 
   it('should increment main version from last main version', () => {
-    const result = getNextVersion('1.0.0', false)
-    expect(result).toBe('1.0.1')
-  })
-})
+    const result = getNextVersion('1.0.0', false);
+    expect(result).toBe('1.0.1');
+  });
+});

__tests__/index.test.ts

@@ -2,16 +2,16 @@
  * Unit tests for the action's entrypoint, src/index.ts
  */
 
-import * as main from '../src/main'
+import * as main from '../src/main';
 
 // Mock the action's entrypoint
-const runMock = jest.spyOn(main, 'run').mockImplementation()
+const runMock = jest.spyOn(main, 'run').mockImplementation();
 
 describe('index', () => {
   it('calls run when imported', async () => {
     // eslint-disable-next-line @typescript-eslint/no-require-imports
-    require('../src/index')
+    require('../src/index');
 
-    expect(runMock).toHaveBeenCalled()
-  })
-})
+    expect(runMock).toHaveBeenCalled();
+  });
+});

__tests__/main.test.ts

@@ -1,13 +1,13 @@
-import { run } from '../src/main'
-import * as core from '@actions/core'
+import { run } from '../src/main';
+import * as core from '@actions/core';
 
 function mockCurrentVersion(version: string) {
   jest.spyOn(global, 'fetch').mockResolvedValue({
     json: jest
       .fn()
       .mockResolvedValue(version === '' ? [] : [{ name: version }]),
     ok: true
-  } as any as Promise<Response>)
+  } as any as Promise<Response>);
 }
 
 function mockInputs(
@@ -17,38 +17,47 @@ function mockInputs(
 ) {
   jest.spyOn(core, 'getInput').mockImplementation((name: string) => {
     if (name === 'org') {
-      return 'org'
+      return 'org';
     }
     if (name === 'packageName') {
-      return 'packageName'
+      return 'packageName';
     }
     if (name === 'minorVersion') {
-      return minorVersion
+      return minorVersion;
     }
     if (name === 'mainVersion') {
-      return mainVersion
+      return mainVersion;
     }
     if (name === 'publishBeta') {
-      return publishBeta
+      return publishBeta;
     }
-    throw new Error(`Unexpected input ${name}`)
-  })
+    throw new Error(`Unexpected input ${name}`);
+  });
 }
 
 afterEach(() => {
-  jest.restoreAllMocks()
-})
+  jest.restoreAllMocks();
+});
 
 describe('get current version', () => {
-  const OLD_ENV = process.env
+  const OLD_ENV = process.env;
   beforeEach(() => {
-    jest.resetModules() // Most important - it clears the cache
-    process.env = { ...OLD_ENV, ...{ GITHUB_TOKEN: 'mytoken' } } // Make a copy
-  })
+    jest.resetModules(); // Most important - it clears the cache
+    process.env = { ...OLD_ENV, ...{ GITHUB_TOKEN: 'mytoken' } };
+  });
 
   afterAll(() => {
-    process.env = OLD_ENV // Restore old environment
-  })
+    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('when current version is empty', () => {
     it.each([
@@ -60,14 +69,14 @@ describe('get current version', () => {
     ])(
       'when main version is %s, minor version is %s, beta: %s, should return %s',
       async (mainVersion, minorVersion, publishBeta, expectedVersion) => {
-        mockCurrentVersion('')
-        mockInputs(mainVersion, minorVersion, publishBeta)
-        const spy = jest.spyOn(core, 'setOutput')
-        await run()
-        expect(spy).toHaveBeenCalledWith('version', expectedVersion)
+        mockCurrentVersion('');
+        mockInputs(mainVersion, minorVersion, publishBeta);
+        const spy = jest.spyOn(core, 'setOutput');
+        await run();
+        expect(spy).toHaveBeenCalledWith('version', expectedVersion);
       }
-    )
-  })
+    );
+  });
 
   describe('when current version does not match given main or minor version', () => {
     it.each([
@@ -78,14 +87,14 @@ describe('get current version', () => {
     ])(
       'when current: %s, publish beta: %s, should return: %s',
       async (currentVersion, publishBeta, expectedVersion) => {
-        mockCurrentVersion(currentVersion)
-        mockInputs('1', '0', publishBeta)
-        const spy = jest.spyOn(core, 'setOutput')
-        await run()
-        expect(spy).toHaveBeenCalledWith('version', expectedVersion)
+        mockCurrentVersion(currentVersion);
+        mockInputs('1', '0', publishBeta);
+        const spy = jest.spyOn(core, 'setOutput');
+        await run();
+        expect(spy).toHaveBeenCalledWith('version', expectedVersion);
       }
-    )
-  })
+    );
+  });
 
   describe('when current version match the given main or minor version', () => {
     it.each([
@@ -111,12 +120,12 @@ describe('get current version', () => {
     ])(
       'when current: %s, publish beta: %s, should return: %s',
       async (currentVersion, publishBeta, expectedVersion) => {
-        mockCurrentVersion(currentVersion)
-        mockInputs('1', '0', publishBeta)
-        const spy = jest.spyOn(core, 'setOutput')
-        await run()
-        expect(spy).toHaveBeenCalledWith('version', expectedVersion)
+        mockCurrentVersion(currentVersion);
+        mockInputs('1', '0', publishBeta);
+        const spy = jest.spyOn(core, 'setOutput');
+        await run();
+        expect(spy).toHaveBeenCalledWith('version', expectedVersion);
       }
-    )
-  })
-})
+    );
+  });
+});