SCP-66 Adds test suite for report service

__tests__/main.test.ts

@@ -37,30 +37,8 @@ describe('action', () => {
     // Set the action's inputs as return values from core.getInput()
     getInputMock.mockImplementation((name: string): string => {
       switch (name) {
-        case 'milliseconds':
-          return '500';
-        default:
+        case 'scanner-parameters':
           return '';
-      }
-    });
-
-    await main.run();
-    expect(runMock).toHaveReturned();
-
-    // Verify that all of the core library functions were called correctly
-    expect(debugMock).toHaveBeenNthCalledWith(1, 'Waiting 500 milliseconds ...');
-    expect(debugMock).toHaveBeenNthCalledWith(2, expect.stringMatching(timeRegex));
-    expect(debugMock).toHaveBeenNthCalledWith(3, expect.stringMatching(timeRegex));
-    expect(setOutputMock).toHaveBeenNthCalledWith(1, 'time', expect.stringMatching(timeRegex));
-    expect(errorMock).not.toHaveBeenCalled();
-  });
-
-  it('sets a failed status', async () => {
-    // Set the action's inputs as return values from core.getInput()
-    getInputMock.mockImplementation((name: string): string => {
-      switch (name) {
-        case 'milliseconds':
-          return 'this is not a number';
         default:
           return '';
       }
@@ -70,7 +48,7 @@ describe('action', () => {
     expect(runMock).toHaveReturned();
 
     // Verify that all of the core library functions were called correctly
-    expect(setFailedMock).toHaveBeenNthCalledWith(1, 'milliseconds not a number');
+    expect(debugMock).toHaveBeenNthCalledWith(1, 'SCANOSS Scan Action started...');
     expect(errorMock).not.toHaveBeenCalled();
   });
 });

__tests__/report-service.test.ts

@@ -0,0 +1,41 @@
+import { getLicensesReport } from '../src/services/report.service';
+import { ScannerResults } from '../src/services/result.interfaces';
+import { getLicenses, Licenses } from '../src/services/result.service';
+
+const licenseTableTest = [
+  {
+    name: '1) report test',
+    licenses: [{ spdxid: 'MIT', url: null, copyleft: null }],
+    output: '| License | Copyleft | URL |\n| ------- | -------- | --- |\n| MIT | :x: |  |\n'
+  },
+  {
+    name: '2) report test',
+    licenses: [
+      { spdxid: 'MIT', url: null, copyleft: null },
+      { spdxid: 'Apache-2.0', url: null, copyleft: null },
+      { spdxid: '0BSD', url: null, copyleft: null }
+    ],
+    output:
+      '| License | Copyleft | URL |\n| ------- | -------- | --- |\n| MIT | :x: |  |\n| Apache-2.0 | :x: |  |\n| 0BSD | :x: |  |\n'
+  },
+  {
+    name: '3) report test',
+    licenses: [
+      { spdxid: 'GPL-2.0-only', url: 'https://spdx.org/licenses/GPL-2.0-only.html', copyleft: true },
+      { spdxid: 'GPL-2.0-or-later', url: 'https://spdx.org/licenses/GPL-2.0-or-later.html', copyleft: true },
+      { spdxid: 'JSON', url: 'https://spdx.org/licenses/JSON.html', copyleft: null },
+      { spdxid: 'LicenseRef-scancode-unknown-license-reference', url: null, copyleft: null }
+    ],
+    output:
+      '| License | Copyleft | URL |\n| ------- | -------- | --- |\n| GPL-2.0-only | :heavy_check_mark: | https://spdx.org/licenses/GPL-2.0-only.html |\n| GPL-2.0-or-later | :heavy_check_mark: | https://spdx.org/licenses/GPL-2.0-or-later.html |\n| JSON | :x: | https://spdx.org/licenses/JSON.html |\n| LicenseRef-scancode-unknown-license-reference | :x: |  |\n'
+  }
+];
+
+describe('Test report service', () => {
+  for (const t of licenseTableTest) {
+    it(`${t.name}`, () => {
+      const report = getLicensesReport(t.licenses);
+      expect(report).toEqual(t.output);
+    });
+  }
+});

src/main.ts

@@ -11,10 +11,13 @@ import { getLicensesReport } from './services/report.service';
  */
 export async function run(): Promise<void> {
   try {
+    core.debug(`SCANOSS Scan Action started...`);
+
     const repoDir = process.env.GITHUB_WORKSPACE as string;
     const outputPath = 'results.json';
 
     // create policies
+    core.debug(`Creating policies`);
     const policies = [new LicensePolicyCheck()];
     policies.forEach(async policy => policy.start());