scanoss 0.7.9 → 0.7.11

package/src/sdk/Dependencies/DependencyScanner.ts

@@ -1,108 +0,0 @@
-import { ILocalDependencies } from "./LocalDependency/DependencyTypes";
-import { GrpcDependencyService } from "../grpc/GrpcDependencyService";
-import { DependencyRequest, DependencyResponse } from "../grpc/scanoss/api/dependencies/v2/scanoss-dependencies_pb";
-import { LocalDependencies } from "./LocalDependency/LocalDependency";
-import { DependencyScannerCfg } from "./DependencyScannerCfg";
-import { IDependencyResponse } from "./DependencyTypes";
-import { PackageURL } from "packageurl-js";
-
-export class DependencyScanner {
-
-  private localDependency: LocalDependencies;
-
-  private grpcDependencyService: GrpcDependencyService;
-
-  constructor(cfg = new DependencyScannerCfg()) {
-    this.grpcDependencyService = new GrpcDependencyService(cfg.DEFAULT_GRPC_HOST, cfg.DEFAULT_GRPC_PORT);
-    this.localDependency = new LocalDependencies();
-  }
-
-
-  public async scan(files: Array<string>): Promise<IDependencyResponse> {
-    let localDependencies = await this.localDependency.search(files);
-    if (localDependencies.files.length === 0) return {filesList: []};
-    localDependencies = this.purlAdapter(localDependencies);
-    const request = this.buildRequest(localDependencies);
-    const grpcResponse = await this.grpcDependencyService.get(request);
-    const response = grpcResponse.toObject();
-
-    // Extract scope from localDependencies and add it to response
-    // Also adds the requirements field from localDependency to the response if the server didn't
-    // replay back a version
-    this.repairOutput(localDependencies, response);
-    return response;
-  }
-
-  private purlAdapter(localDependencies: ILocalDependencies): ILocalDependencies {
-    for (const file of localDependencies.files) {
-      for (const purl of file.purls) {
-
-        //If purl has a specific version, remove it and place the "version" value into requirement field.
-        const version = PackageURL.fromString(purl.purl).version;
-        if (version) {
-          purl.requirement = version;
-          purl.purl = purl.purl.replace('@' + version, '');
-        }
-
-        if (purl.purl.includes('%2F'))
-          purl.purl = purl.purl.replace(/%2F/g, '/');
-
-      }
-    }
-    return localDependencies;
-  }
-
-
-  private buildRequest(localDependencies: ILocalDependencies): DependencyRequest {
-    try {
-      const depRequest = new DependencyRequest();
-      depRequest.setDepth(1);
-      for (const file of localDependencies.files) {
-        const fileMsg = new DependencyRequest.Files();
-        fileMsg.setFile(file.file);
-        for (const purl of file.purls) {
-          const purlMsg = new DependencyRequest.Purls();
-          purlMsg.setPurl(purl.purl);
-          if(purl?.requirement) purlMsg.setRequirement(purl.requirement);
-          fileMsg.addPurls(purlMsg);
-        }
-        depRequest.addFiles(fileMsg);
-      }
-      return depRequest;
-    } catch (e) {
-      console.error(e);
-      return null;
-    }
-  }
-
-  private repairOutput(localdependency: ILocalDependencies, serverResponse: DependencyResponse.AsObject) {
-
-    // Create a map with key = [filename + purl] and the value is an object containing:
-    // * The scope of the local dependency
-    // * The requirement of the local dependency
-    // Later this map is used to add information in the server response
-    const localDependencyInfo = {};
-    for (const file of localdependency.files) {
-      const filename = file.file
-      for (const localDependency of file.purls) {
-        const localInfo = {}
-        if (localDependency?.scope) localInfo['scope'] = localDependency.scope
-        if(localDependency?.requirement) localInfo['requirement'] = localDependency.requirement
-        localDependencyInfo[filename + localDependency.purl] = localInfo;
-      }
-    }
-
-    for (const file of serverResponse.filesList) {
-      const filename = file.file
-      for (const dependency of file.dependenciesList) {
-        const localDependencyData = localDependencyInfo[filename + dependency.purl];
-        if (localDependencyData?.scope) dependency['scope'] = localDependencyData.scope;
-        if (localDependencyData?.requirement && dependency.version == "") {
-          dependency.version = localDependencyData.requirement;
-        }
-      }
-    }
-  }
-
-
-}

package/src/sdk/Dependencies/DependencyScannerCfg.ts

@@ -1,7 +0,0 @@
-export class DependencyScannerCfg {
-
-  DEFAULT_GRPC_PORT = '443';
-
-  DEFAULT_GRPC_HOST = 'scanoss.com';
-
-}

package/src/sdk/Dependencies/DependencyTypes.ts

@@ -1,24 +0,0 @@
-export interface LicensesList {
-    name: string;
-    spdxId: string;
-    isSpdxApproved: boolean;
-}
-
-export interface DependenciesList {
-    component: string;
-    purl: string;
-    version?: string;
-    scope?: string;
-    licensesList: LicensesList[];
-}
-
-export interface FilesList {
-    file: string;
-    id: string;
-    status: string;
-    dependenciesList: DependenciesList[];
-}
-
-export interface IDependencyResponse {
-    filesList: FilesList[];
-}

package/src/sdk/Dependencies/LocalDependency/DependencyTypes.ts

@@ -1,21 +0,0 @@
-export interface ILocalPurl {
-  purl: string;
-  requirement?: string;
-  scope?: string;
-}
-
-export interface ILocalDependency {
-  file: string;
-  purls: Array<ILocalPurl>;
-}
-
-export interface ILocalDependencies{
-  files: Array<ILocalDependency>;
-}
-
-/* Parser funcion definition */
-export type ParserFuncType = (fileContent: string, filePath: string) => Promise<ILocalDependency>;
-
-export interface ParserDefinitions {
-  [key: string]: ParserFuncType;
-}

package/src/sdk/Dependencies/LocalDependency/LocalDependency.ts

@@ -1,111 +0,0 @@
-import path from 'path';
-import fs from 'fs';
-import { ParserFuncType, ILocalDependencies } from "./DependencyTypes";
-import { requirementsParser } from "./parsers/pyParser";
-import { pomParser } from "./parsers/mavenParser";
-import {
-  packagelockParser,
-  packageParser,
-  yarnLockParser
-} from './parsers/npmParser';
-import { gemfilelockParser, gemfileParser } from "./parsers/rubyParser";
-import { goModParser, goSumParser } from './parsers/golangParser';
-import { csprojParser, packagesConfigParser } from './parsers/nugetParser';
-import { buildGradleParser } from './parsers/buildGradleParser';
-
-export class LocalDependencies {
-
-  private parserMap: Record<string, ParserFuncType>;
-  constructor() {
-      /*
-      This is a hash map that connect a filename with it's own parser function
-      Any parser function must return a ILocalDependencies object (See DependencyTypes.ts)
-      */
-      this.parserMap = {
-        'requirements.txt': requirementsParser,
-        'pom.xml': pomParser,
-        'package.json': packageParser,
-        'package-lock.json': packagelockParser,
-        'Gemfile': gemfileParser,
-        'Gemfile.lock': gemfilelockParser,
-        'go.mod': goModParser,
-        'go.sum': goSumParser,
-        'yarn.lock': yarnLockParser,
-        '*.csproj': csprojParser,
-        'packages.config': packagesConfigParser,
-        'build.gradle': buildGradleParser,
-      };
-  }
-
-  public async search(files: Array<string>): Promise<ILocalDependencies> {
-    let results: ILocalDependencies = {files: []};
-    for (const filePath of files) {
-        const fileName = path.basename(filePath);
-        const parser: ParserFuncType = this.getParserFunc(fileName);
-        if(parser != null) {
-          try {
-            const fileContent = await fs.promises.readFile(filePath, 'utf8');
-            const dependency = await parser(fileContent, filePath);
-            if(dependency.purls.length != 0)
-                results.files.push(dependency);
-          } catch(e) {
-            console.error(e);
-            continue;
-          }
-        }
-    }
-    return results;
-  }
-
-  private getParserFunc(filename: string): ParserFuncType {
-
-    //Check for an exact match
-    const func = this.parserMap[filename];
-    if(func) return func
-
-
-    //Check for a wildcard string match
-    const filesPatterns = Object.keys(this.parserMap).filter((item) => item.includes("*"));
-    for (const pattern of filesPatterns) {
-
-      if (this.stringMatchWithWildcard(filename, pattern)) return this.parserMap[pattern];
-    }
-
-    return null;
-  }
-
-
-  // The logic for the string wildcard match algorithm was an imitation from here:
-  // https://www.codeproject.com/Articles/5163931/Fast-String-Matching-with-Wildcards-Globs-and-Giti
-  public stringMatchWithWildcard(text: string, pattern: string): boolean {
-
-    let iText = 0;
-    let iPattern = 0;
-
-    let iTextBackup = null;
-    let iPatternBackup = null;
-
-    while (text[iText]) {
-      if (pattern[iPattern] == '*') {
-        // new star-loop: backup positions in pattern and text
-        iTextBackup = iText;
-        iPatternBackup = ++iPattern;
-      } else if (text[iText] == pattern[iPattern]) {
-        iText++;
-        iPattern++;
-      } else {
-        //If there are no star, we fail to match
-        if (iPatternBackup == null) return false;
-        iText = ++iTextBackup;
-        iPattern = iPatternBackup;
-      }
-    }
-
-    //Ignore trailling stars
-    while (pattern[iPattern] == '*') iPatternBackup++
-
-    //There is a match when the pattern was walked all the way throught
-    return iPattern >= pattern.length ? true : false
-  }
-
-}

package/src/sdk/Dependencies/LocalDependency/parsers/buildGradleParser.ts

@@ -1,115 +0,0 @@
-import { ILocalDependency } from '../DependencyTypes';
-import path from 'path';
-import { PackageURL } from 'packageurl-js';
-
-
-const MANIFEST_FILE = 'build.gradle';
-const depBlockRex = /dependencies\s*{\s*(?<dependencies>(.|\n)*?)}/gm;
-
-enum GRADLE_STATES {
-  WALKING,
-  SINGLELINE_DEPENDENCY,
-  MULTILINE_DEPENDENCY
-}
-export async function buildGradleParser(fileContent: string, filePath: string): Promise<ILocalDependency> {
-
-
-  // If the file is not a manifest file, return an empty results
-  const results: ILocalDependency = {file: filePath, purls: []};
-  if(path.basename(filePath) != MANIFEST_FILE)
-    return results;
-
-  //For each dependency block, generate purls
-  let gradle;
-  while ((gradle = depBlockRex.exec(fileContent)) !== null) {
-    let depBlock = gradle?.groups?.dependencies;
-
-
-    let current_config_name = "";   //Config name is placed in the scope
-    let lines = depBlock.split(/\r?\n/) as string;
-    for (let i = 0; i<lines.length; i++) {
-      let line = lines[i];
-
-      if (line.includes("//")) line = line.replace(/\/\/.*$/gm, "");
-      line = line.trim();
-      if (line == '') continue;
-
-
-      current_config_name = getConfigNameFromLine(line);
-
-      //Multiline dependency
-      if(current_config_name && line.includes("(")) {
-
-        while( i<lines.length && !lines[i].includes(")")) {
-          const componentData = createPurlNameFromLine(lines[i]);
-          if (componentData != null) {
-            results.purls.push({
-              purl: componentData.purlName,
-              requirement: componentData.version,
-              scope: current_config_name
-            });
-          }
-          i++;
-        }
-        current_config_name='';
-      } else {  //Single line dependency
-        const componentData = createPurlNameFromLine(line);
-        if (componentData == null) {
-          current_config_name = '';
-          continue;
-        }
-
-        results.purls.push({purl: componentData.purlName, requirement: componentData.version, scope: current_config_name});
-      }
-
-    }
-
-
-  }
-
-  return Promise.resolve(results);
-
-}
-
-function getConfigNameFromLine(line): string {
-  let configName = ""
-
-  const dep = line.split(/\s/);
-  if (dep.length) configName = dep[0].replace("(", "").trim();
-
-  return configName;
-}
-
-//Takes a line and generate a purl when possible.
-// There are three ways of declaring dependencies
-interface componentData{
-  purlName: string;
-  version: string;
-}
-
-function createPurlNameFromLine(line: string): componentData {
-
-  let namespace = undefined;
-  let name = undefined;
-  let version = undefined;
-
-  //Enters when line = implementation 'org.scala-lang:scala-library:2.11.12'
-  let dep = line.match(/(?<namespace>[\w\.\-]+):(?<name>[\w\.\-]+):(?<version>[\d\.]+)/);
-  if (dep?.length) {
-    namespace = dep.groups.namespace
-    name = dep.groups.name
-    version = dep.groups.version
-  } else if (line.includes("group") && line.includes("name") && line.includes("version")) {
-    version = line.match(/version:\s+['"](?<version>[\w\.\-\d]+)['"]/).groups.version
-    name = line.match(/name:\s+['"](?<name>[\w\.\-\d]+)['"]/).groups?.name
-    namespace = line.match(/group:\s+['"](?<group>[\w\.\-\d]+)['"]/).groups?.group
-  }
-
-  let purlName = "";
-  if(name && namespace) {
-    const purlObj = new PackageURL('maven', namespace, name, undefined, undefined, undefined);
-    return { purlName: purlObj.toString(), version }
-  }
-
-  return null;
-}

package/src/sdk/Dependencies/LocalDependency/parsers/golangParser.ts

@@ -1,130 +0,0 @@
-import { ILocalDependency } from "../DependencyTypes";
-
-import { PackageURL } from "packageurl-js";
-import path from "path";
-
-function parseDepLink (str: string) {
-  const res = /.*?(?<ns_name>[^\s]+)\s+(?<version>(.*))/.exec(str);
-  return {
-    ns_name: res?.groups?.ns_name,
-    version: res?.groups?.version
-  };
-}
-
-function getDepDataGoModFromLine(line: string) {
-  const {ns_name, version} = parseDepLink(line);
-
-  const index = ns_name.lastIndexOf('/');
-  const namespace = ns_name.substring(0, index);
-  const name = ns_name.substring(index + 1);
-
-  return {namespace, name, version}
-}
-
-// Removes comments and spaces
-function preprocessLine(line: string) {
-    if (line.includes("//"))
-      line = line.substring(0,line.indexOf("//"));
-    return line.trim();
-}
-
-
-
-
-const PURL_TYPE = 'golang';
-
-
-// See reference on: https://go.dev/ref/mod#go-mod-file
-const MANIFEST_FILE = 'go.mod';
-export function goModParser(fileContent: string, filePath: string): Promise<ILocalDependency> {
-
-  // If the file is not a go.mod manifest file, return an empty results
-  const results: ILocalDependency = {file: filePath, purls: []};
-  if(path.basename(filePath) != MANIFEST_FILE)
-      return Promise.resolve(results);
-
-  const lines =	fileContent.split('\n');
-
-	const require = [];
-
-  for (let num = 0 ; num < lines.length ; num+=1) {
-
-    let line = preprocessLine(lines[num]);
-
-
-    if(line.includes('require') && line.includes('(')) {
-      num+=1;
-      line = preprocessLine(lines[num]);
-      while (num < lines.length && line!==')') {
-
-        const {namespace, name, version} = getDepDataGoModFromLine(line)
-
-        const purlString = new PackageURL(PURL_TYPE, namespace, name, version, undefined, undefined).toString();
-        results.purls.push({purl: purlString});
-
-        require.push(line);
-
-        num+=1;
-        line = preprocessLine(lines[num]);
-      }
-    }
-  }
-
-  return Promise.resolve(results);
-}
-
-
-
-
-
-function parseGoSumDepLink (str: string) {
-  const res = /.*?(?<ns_name>[^\s]+)\s+(?<version>(.*))\s+h1:(?<checksum>(.*))/.exec(str);
-  return {
-    ns_name: res?.groups?.ns_name,
-    version: res?.groups?.version,
-    checksum: res?.groups?.checksum
-  };
-}
-
-function getDepDataGoSumFromLine(line: string) {
-  const {ns_name, version} = parseGoSumDepLink(line);
-
-  if (!ns_name) return {};
-
-  const index = ns_name.lastIndexOf('/');
-  const namespace = ns_name.substring(0, index);
-  const name = ns_name.substring(index + 1);
-
-  return {namespace, name, version}
-}
-
-// See reference on: https://go.dev/ref/mod#go-mod-file
-export function goSumParser(fileContent: string, filePath: string): Promise<ILocalDependency> {
-
-  // If the file is not a go.mod manifest file, return an empty results
-  const results: ILocalDependency = { file: filePath, purls: [] };
-  if (path.basename(filePath) != 'go.sum')
-    return Promise.resolve(results);
-
-
-  const lines = fileContent.split('\n');
-  for (let num = 0; num < lines.length; num += 1) {
-
-    let line = preprocessLine(lines[num]);  //Deletes coments
-    if(!line) continue
-
-    line = line.replace('/go.mod', '')
-    const {namespace, name, version} = getDepDataGoSumFromLine(line)
-
-    if (!name) continue
-
-    //const purlString = new PackageURL(PURL_TYPE, namespace, name, undefined, undefined, undefined).toString();
-    const purlString = `pkg:${PURL_TYPE}/${namespace}/${name}`
-    results.purls.push({purl: purlString, requirement: version})
-  }
-
-  return Promise.resolve(results);
-
-
-}
-