SCP-138 Adds policy report: copyleft

__tests__/result-service.test.ts

@@ -1,5 +1,5 @@
 import { ScannerResults } from '../src/services/result.interfaces';
-import { getLicenses, License } from '../src/services/result.service';
+import { getComponents, getLicenses, License } from '../src/services/result.service';
 
 const licenseTableTest: { name: string; description: string; content: string; licenses: License[] }[] = [
   {
@@ -60,3 +60,19 @@ describe('Test Results service', () => {
     });
   }
 });
+
+describe('Test components service', () => {
+  const t = licenseTableTest[3];
+  it(`test c`, () => {
+    const scannerResults = JSON.parse(t.content) as ScannerResults;
+    const components = getComponents(scannerResults);
+    const util = require('util');
+    // console.log(util.inspect(compoments, {showHidden: false, depth: null, colors: true}))
+
+    const componentsWithCopyleft = components.filter(component =>
+      component.licenses.some(license => !!license.copyleft)
+    );
+
+    console.log(util.inspect(componentsWithCopyleft, { showHidden: false, depth: null, colors: true }));
+  });
+});

src/policies/copyleft-policy-check.ts

@@ -1,7 +1,8 @@
 import { ScannerResults } from '../services/result.interfaces';
 import { CHECK_NAME } from '../app.config';
 import { PolicyCheck } from './policy-check';
-import { getLicenses } from '../services/result.service';
+import { Component, getComponents, getLicenses } from '../services/result.service';
+import { generateTable } from 'src/utils/markdown.util';
 
 export class CopyleftPolicyCheck extends PolicyCheck {
   constructor() {
@@ -10,13 +11,42 @@ export class CopyleftPolicyCheck extends PolicyCheck {
 
   async run(scannerResults: ScannerResults): Promise<void> {
     super.run(scannerResults);
-    const licenses = getLicenses(scannerResults);
+    const components = getComponents(scannerResults);
 
-    const hasCopyleft = licenses.some(license => !!license.copyleft);
-    if (!hasCopyleft) {
-      this.success('Completed succesfully', 'Not copyleft licenses were found');
+    // Filter copyleft components
+    const componentsWithCopyleft = components.filter(component =>
+      component.licenses.some(license => !!license.copyleft)
+    );
+
+    const summary = this.getSummary(componentsWithCopyleft);
+    const details = this.getDetails(componentsWithCopyleft);
+
+    if (componentsWithCopyleft.length === 0) {
+      return this.success(summary, details);
     } else {
-      this.reject('Completed failure', 'Copyleft licenses were found:'); // TODO: create a table with copyleft licenses
+      return this.reject(summary, details);
     }
   }
+
+  private getSummary(components: Component[]): string {
+    return components.length === 0
+      ? '### :white_check_mark: Policy Pass \n ' + '#### ' + 'Not copyleft components were found'
+      : '### :x: Policy Fail \n' + '#### ' + components.length + ' component(s) with copyleft licenses were found';
+  }
+
+  private getDetails(components: Component[]): string {
+    if (components.length === 0) return '';
+
+    const headers = ['Component', 'Version', 'License', 'URL', 'Copyleft'];
+    const rows: string[][] = [];
+
+    components.forEach(component => {
+      component.licenses.forEach(license => {
+        const copyleftIcon = license.copyleft ? ':x:' : ' ';
+        rows.push([component.purl, component.version, license.spdxid, `${license.url || ''}`, copyleftIcon]);
+      });
+    });
+
+    return generateTable(headers, rows);
+  }
 }

src/policies/policy-check.ts

@@ -55,11 +55,11 @@ export abstract class PolicyCheck {
   }
 
   protected async success(summary: string, text: string): Promise<void> {
-    await this.finish(CONCLUSION.Success, summary, text);
+    return await this.finish(CONCLUSION.Success, summary, text);
   }
 
   protected async reject(summary: string, text: string): Promise<void> {
-    await this.finish(inputs.POLICIES_HALT_ON_FAILURE ? CONCLUSION.Failure : CONCLUSION.Neutral, summary, text);
+    return await this.finish(inputs.POLICIES_HALT_ON_FAILURE ? CONCLUSION.Failure : CONCLUSION.Neutral, summary, text);
   }
 
   protected async finish(conclusion: CONCLUSION | undefined, summary: string, text: string): Promise<void> {

src/services/result.service.ts

@@ -12,28 +12,44 @@ export interface License {
 
 export interface Component {
   purl: string;
+  version: string;
+  licenses: License[];
 }
+
 export function getComponents(results: ScannerResults): Component[] {
   const components = new Array<Component>();
 
   for (const component of Object.values(results)) {
     for (const c of component) {
       if (c.id === ComponentID.FILE || c.id === ComponentID.SNIPPET) {
         components.push({
-          purl: (c as ScannerComponent).purl[0]
+          purl: (c as ScannerComponent).purl[0],
+          version: (c as ScannerComponent).version,
+          licenses: (c as ScannerComponent).licenses.map(l => ({
+            spdxid: l.name,
+            copyleft: !l.copyleft ? null : l.copyleft === 'yes' ? true : false,
+            url: l?.url ? l.url : null,
+            count: 1
+          }))
         });
       }
 
       if (c.id === ComponentID.DEPENDENCY) {
         const dependencies = (c as DependencyComponent).dependencies;
         for (const d of dependencies) {
-          components.push({ purl: d.purl });
+          components.push({
+            purl: d.purl,
+            version: d.version,
+            licenses: d.licenses.map(l => ({ spdxid: l.spdx_id, copyleft: null, url: null, count: 1 }))
+          });
         }
       }
     }
   }
 
-  return Array.from(new Set(components)); //Remove duplicated
+  //Merge duplicates purls
+
+  return components;
 }
 
 export function getLicenses(results: ScannerResults): License[] {

src/utils/markdown.util.ts

@@ -0,0 +1,13 @@
+export const generateTable = (headers: string[], rows: string[][]): string => {
+  const COL_SEP = ' | ';
+  const LINE_BREAK = ' \n ';
+
+  let md = COL_SEP + headers.join(COL_SEP) + COL_SEP + LINE_BREAK;
+  md += COL_SEP + new Array(headers.length).fill('-').join(COL_SEP) + COL_SEP + LINE_BREAK;
+
+  rows.forEach(row => {
+    md += COL_SEP + row.join(COL_SEP) + COL_SEP + LINE_BREAK;
+  });
+
+  return md;
+};