DT-1094 Converts table LicenseObligation to new data layer

Author: isasmendiagus

Diff for: assets/ReportHTMLTemplate/index.html

@@ -1,6 +1,6 @@
 {
   "name": "scanoss",
-  "version": "0.9.3",
+  "version": "0.10.0",
   "description": "The SCANOSS JS package provides a simple, easy to consume module for interacting with SCANOSS APIs/Engine.",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",

Diff for: package.json

@@ -28,6 +28,7 @@ import { SummaryDataProvider } from '../../sdk/Report/DataLayer/DataProviders/Su
 import { DecompressionFilter } from '../../sdk/tree/Filters/DecompressionFilter';
 import { DecompressionManager } from '../../sdk/Decompress/DecompressionManager';
 import path from 'path';
+import { LicenseObligationDataProvider } from '../../sdk/Report/DataLayer/DataProviders/LicenseObligationDataProvider';
 
 export async function scanHandler(
   rootPath: string,
@@ -184,6 +185,13 @@ export async function scanHandler(
     dataProviderManager.addDataProvider(
       new SummaryDataProvider(projectName, new Date(), scannersResults.scanner)
     );
+
+    dataProviderManager.addDataProvider(
+      new LicenseObligationDataProvider(
+        scannersResults.scanner,
+        scannersResults.dependencies
+      )
+    );
     const report = new Report(dataProviderManager);
     scannerResultsString = await report.getHTML();
   }

Diff for: src/cli/commands/scan.ts

@@ -87,9 +87,6 @@ export interface LicenseDataLayer {
   label: string;
   value: number; //Number of licenses found
   components: Array<LicenseComponent>;
-  incompatibleWith: Array<string>;
-  hasIncompatibles: Array<string>;
-  copyleft: boolean;
 }
 
 export interface LicenseComponent {
@@ -101,7 +98,17 @@ export interface LicenseComponent {
 }
 /*************  License interface definition  *************/
 
+/*************  License Obligation interface definition  *************/
+export interface LicenseObligation {
+  label: string; //spdxid
+  incompatibleWith: Array<string>;
+  hasIncompatibles: Array<string>;
+  copyleft: boolean;
+}
+/*************  License Obligation interface definition  *************/
+
 export interface SummaryDataLayer {
+  reportTitle: string;
   projectName: string;
   timestamp: Date;
   matchedFiles: number;
@@ -112,6 +119,7 @@ export interface SummaryDataLayer {
 // Each layer is created to group by differents criteria.
 export interface IDataLayers {
   licenses: LicenseDataLayer[];
+  licensesObligations: LicenseObligation[];
   component: ComponentDataLayer[];
   dependencies: DependencyDataLayer[];
   vulnerabilities: VulnerabilityDataLayer[];

Diff for: src/sdk/Report/DataLayer/DataLayerTypes.ts

@@ -18,6 +18,7 @@ export class DataProviderManager {
       vulnerabilities: null,
       summary: null,
       licenses: null,
+      licensesObligations: null,
     };
 
     for (const layer of this.dataLayersProviders)

Diff for: src/sdk/Report/DataLayer/DataProviderManager.ts

@@ -47,7 +47,6 @@ export class LicenseDataProvider implements DataProvider {
       this.updateLicenseStorageFromDependencies();
 
     this.licenseLayer = Object.values(this.licenseStorage);
-    if (this.licenseLayer.length > 0) this.updateIncompatibilities();
 
     this.licenseLayer.sort((itemA, itemB) => {
       if (itemA.value > itemB.value) return -1;
@@ -74,12 +73,6 @@ export class LicenseDataProvider implements DataProvider {
           const newLicense: LicenseDataLayer = <LicenseDataLayer>{};
           newLicense.value = 1;
           newLicense.label = license.name;
-          newLicense.copyleft = license.copyleft === 'yes' ? true : false;
-          newLicense.hasIncompatibles = [];
-          newLicense.incompatibleWith =
-            license.incompatible_with !== undefined
-              ? license.incompatible_with.split(',').map((il) => il.trim())
-              : [];
           newLicense.components = [newLicenseComponent];
           this.licenseStorage[license.name] = newLicense;
         } else {
@@ -111,9 +104,6 @@ export class LicenseDataProvider implements DataProvider {
                 const newLicense: LicenseDataLayer = <LicenseDataLayer>{};
                 newLicense.value = 1;
                 newLicense.label = license_name;
-                newLicense.copyleft = false;
-                newLicense.hasIncompatibles = [];
-                newLicense.incompatibleWith = [];
                 newLicense.components = [newLicenseComponent];
                 this.licenseStorage[license_name] = newLicense;
               } else {
@@ -131,9 +121,6 @@ export class LicenseDataProvider implements DataProvider {
               const newLicense: LicenseDataLayer = <LicenseDataLayer>{};
               newLicense.value = 1;
               newLicense.label = 'unknown';
-              newLicense.copyleft = false;
-              newLicense.hasIncompatibles = [];
-              newLicense.incompatibleWith = [];
               newLicense.components = [newLicenseComponent];
               this.licenseStorage['unknown'] = newLicense;
             } else {
@@ -148,21 +135,6 @@ export class LicenseDataProvider implements DataProvider {
     });
   }
 
-  private updateIncompatibilities() {
-    for (let l = 0; l < this.licenseLayer.length; l += 1) {
-      const license = this.licenseLayer[l];
-      if (license.incompatibleWith !== undefined)
-        for (let i = 0; i < license.incompatibleWith.length; i += 1) {
-          if (
-            this.licenseLayer.some(
-              (lic) => lic.label === license.incompatibleWith[i]
-            )
-          )
-            license.hasIncompatibles.push(license.incompatibleWith[i]);
-        }
-    }
-  }
-
   private insertComponentIntoLicense(
     license: LicenseDataLayer,
     newComponent: LicenseComponent
@@ -187,17 +159,4 @@ export class LicenseDataProvider implements DataProvider {
     }
     return license;
   }
-
-  private unknownLicensesToEnd() {
-    // let unknownLicenses = null;
-    // if(this.licenseMapper['unknown']){
-    //   unknownLicenses =  this.licenseMapper['unknown'];
-    //   delete this.licenseMapper['unknown'];
-    // }
-    //
-    // this.licenses =  Object.values((this.licenseMapper));
-    // if(unknownLicenses){
-    //   this.licenses.push(unknownLicenses);
-    // }
-  }
 }

Diff for: src/sdk/Report/DataLayer/DataProviders/LicenseDataProvider.ts

@@ -0,0 +1,92 @@
+import {
+  DataProvider,
+  IDataLayers,
+  LicenseComponent,
+  LicenseDataLayer,
+  LicenseObligation,
+} from '../DataLayerTypes';
+import {
+  ScannerComponent,
+  ScannerResults,
+} from '../../../scanner/ScannerTypes';
+import { IDependencyResponse } from '../../../Dependencies/DependencyTypes';
+
+export class LicenseObligationDataProvider implements DataProvider {
+  private scanResults: ScannerResults;
+
+  private dependencies: IDependencyResponse;
+  private licenseLayer: LicenseObligation[];
+  private componentList: ScannerComponent[];
+
+  private licenseSet: Record<string, LicenseObligation>;
+  constructor(scanResults: ScannerResults, dependencies?: IDependencyResponse) {
+    this.scanResults = scanResults;
+    this.dependencies = dependencies;
+
+    //Maps a license name to its own data
+    this.licenseSet = {};
+    this.licenseLayer = [];
+  }
+
+  public getLayerName(): string {
+    return 'License Obligation Layer';
+  }
+
+  public async getData(): Promise<IDataLayers> {
+    /* Get licenses from Scan Results */
+    this.componentList = Object.values(this.scanResults).flat();
+    this.componentList = this.componentList.filter(
+      (component) => component.id !== 'none'
+    );
+
+    if (this.componentList.length > 0) {
+      this.componentList.forEach((component) => {
+        component.licenses.forEach((license) => {
+          if (!this.licenseSet[license.name]) {
+            this.licenseSet[license.name] = {
+              copyleft:
+                license.copyleft?.toLowerCase() === 'yes' ? true : false,
+              label: license.name,
+              hasIncompatibles: [],
+              incompatibleWith: license.incompatible_with
+                ? license.incompatible_with.split('')
+                : [],
+            };
+          }
+        });
+      });
+    }
+
+    /* Get licenses from Dependencies Results */
+    if (this.dependencies && this.dependencies.filesList.length > 0) {
+      this.dependencies.filesList.forEach((file) => {
+        file.dependenciesList.forEach((dependency) => {
+          dependency.licensesList.forEach((license) => {
+            license.spdxId?.split(/;|\//g).forEach((spdxid) => {
+              if (spdxid !== '' && !this.licenseSet[spdxid]) {
+                this.licenseSet[spdxid] = {
+                  copyleft: false,
+                  label: spdxid,
+                  hasIncompatibles: [],
+                  incompatibleWith: [],
+                };
+              }
+            });
+          });
+        });
+      });
+    }
+
+    const allSpdxid = Object.keys(this.licenseSet);
+    const allLicenses = Object.values(this.licenseSet);
+
+    const licensesObligations = allLicenses.map((l) => {
+      l.incompatibleWith = l.incompatibleWith.filter((spdxid) =>
+        allSpdxid.includes(spdxid)
+      );
+      return l;
+    });
+
+    return { licensesObligations } as IDataLayers;
+  }
+}

Diff for: src/sdk/Report/DataLayer/DataProviders/LicenseObligationDataProvider.ts

@@ -14,6 +14,7 @@ export class SummaryDataProvider implements DataProvider {
 
   private projectCreateAt: Date;
 
+  private reportTitle: string = 'Detected Report';
   constructor(
     projectName: string,
     projectCreatedAt: Date,
@@ -35,6 +36,7 @@ export class SummaryDataProvider implements DataProvider {
     this.summary.totalFiles = 0;
     this.summary.noMatchFiles = 0;
     this.summary.matchedFiles = 0;
+    this.summary.reportTitle = this.getReportTitle();
 
     for (const [file, components] of Object.entries(this.scannerResults)) {
       components.forEach((component) => {
@@ -47,4 +49,8 @@ export class SummaryDataProvider implements DataProvider {
 
     return <IDataLayers>{ summary: this.summary };
   }
+
+  public getReportTitle(): string {
+    return this.reportTitle;
+  }
 }

Diff for: src/sdk/Report/DataLayer/DataProviders/SummaryDataProvider.ts

@@ -10,7 +10,7 @@ chai.use(deepEqualInAnyOrder);
 const { expect } = chai;
 
 describe('Suit test for DataProvider', () => {
-  it('Test ComponentDataLayer', function () {
+  it('Test ComponentDataLayer', async function () {
     const result = JSON.parse(
       fs.readFileSync(
         path.join(__dirname, '/samples/results-with-dep.json'),
@@ -21,7 +21,7 @@ describe('Suit test for DataProvider', () => {
       result.scanner,
       result.dependencies
     );
-    const componentData = componentDataProvider.getData();
+    const componentData = await componentDataProvider.getData();
 
     const expectedOutput: ComponentDataLayer[] = [
       //First component

Diff for: tests/sdk/DataLayer/DataProviders/ComponentDataProvider.spec.ts

@@ -6,7 +6,7 @@ import { DependencyDataProvider } from '../../../../src/sdk/Report/DataLayer/Dat
 import { DependencyDataLayer } from '../../../../src/sdk/Report/DataLayer/DataLayerTypes';
 
 describe('Suit test for Dependency Data Provider', () => {
-  it('Test Simple case Dependency Data provider', function () {
+  it('Test Simple case Dependency Data provider', async function () {
     const result = JSON.parse(
       fs.readFileSync(
         path.join(__dirname, '/samples/results-with-dep.json'),
@@ -16,7 +16,7 @@ describe('Suit test for Dependency Data Provider', () => {
     const dependencyDataProvider = new DependencyDataProvider(
       result.dependencies
     );
-    const dependencyData = dependencyDataProvider.getData();
+    const dependencyData = await dependencyDataProvider.getData();
 
     const expectedOutput: DependencyDataLayer[] = [
       {

Diff for: tests/sdk/DataLayer/DataProviders/DependencyDataProvider.spec.ts

@@ -6,7 +6,7 @@ import { SummaryDataLayer } from '../../../../src/sdk/Report/DataLayer/DataLayer
 import { SummaryDataProvider } from '../../../../src/sdk/Report/DataLayer/DataProviders/SummaryDataProvider';
 
 describe('Suit test for SummaryDataProvider', () => {
-  it('Simple test SummaryDataProvider', function () {
+  it('Simple test SummaryDataProvider', async function () {
     const result = JSON.parse(
       fs.readFileSync(
         path.join(__dirname, '/samples/results-with-dep.json'),
@@ -21,14 +21,15 @@ describe('Suit test for SummaryDataProvider', () => {
       date,
       result.scanner
     );
-    const summaryData = summaryDataProvider.getData();
+    const summaryData = await summaryDataProvider.getData();
 
     const expectedOutput: SummaryDataLayer = {
       projectName: 'Test project',
       timestamp: date,
       totalFiles: 4,
       noMatchFiles: 0,
       matchedFiles: 4,
+      reportTitle: summaryDataProvider.getReportTitle(),
     };
 
     expect(summaryData.summary).to.deep.equal(expectedOutput);