Merge pull request #117 from actions/ljones140/clean-detector-categories-pr

Add DetectorCategories input So we can run by ecosystem

README.md

@@ -1,6 +1,6 @@
 # Component detection dependency submission action
 
-This GitHub Action runs the [microsoft/component-detection](https://github.com/microsoft/component-detection) library to automate dependency extraction at build time. It uses a combination of static and dynamic scanning to build a dependency tree and then uploads that to GitHub's dependency graph via the dependency submission API. This gives you more accurate Dependabot alerts, and support for a bunch of additional ecosystems. 
+This GitHub Action runs the [microsoft/component-detection](https://github.com/microsoft/component-detection) library to automate dependency extraction at build time. It uses a combination of static and dynamic scanning to build a dependency tree and then uploads that to GitHub's dependency graph via the dependency submission API. This gives you more accurate Dependabot alerts, and support for a bunch of additional ecosystems.
 
 ### Example workflow
 
@@ -12,7 +12,7 @@ on:
   workflow_dispatch:
   push:
 
-permissions: 
+permissions:
   id-token: write
   contents: write
 
@@ -21,19 +21,20 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Component detection 
+      - name: Component detection
         uses: advanced-security/component-detection-dependency-submission-action@v0.0.3
-```        
+```
 
 ### Configuration options
 
-| Parameter | Description | Example | 
+| Parameter | Description | Example |
-| --- | --- | --- | 
+| --- | --- | --- |
 filePath | The path to the directory containing the environment files to upload. Defaults to Actions working directory. | `'.'`
 directoryExclusionList | Filters out specific directories following a minimatch pattern. | `test`
 detectorArgs | Comma separated list of properties that can affect the detectors execution, like EnableIfDefaultOff that allows a specific detector that is in beta to run, the format for this property is DetectorId=EnableIfDefaultOff, for example Pip=EnableIfDefaultOff. | `Pip=EnableIfDefaultOff`
-dockerImagesToScan |Comma separated list of docker image names or hashes to execute container scanning on |  ubuntu:16.04,56bab49eef2ef07505f6a1b0d5bd3a601dfc3c76ad4460f24c91d6fa298369ab | 
+dockerImagesToScan |Comma separated list of docker image names or hashes to execute container scanning on |  ubuntu:16.04,56bab49eef2ef07505f6a1b0d5bd3a601dfc3c76ad4460f24c91d6fa298369ab |
 detectorsFilter | A comma separated list with the identifiers of the specific detectors to be used. | `Pip, RustCrateDetector`
+detectorsCategories | A comma separated list with the categories of components that are going to be scanned. The detectors that are going to run are the ones that belongs to the categories. | `NuGet,Npm`
 correlator | An optional identifier to distinguish between multiple dependency snapshots of the same type. Defaults to the [job_id](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_id) of the current job | `csharp-backend`
 
 For more information: https://github.com/microsoft/component-detection

action.yml

@@ -5,7 +5,7 @@ inputs:
     description: "GitHub Personal Access Token (PAT). Defaults to PAT provided by Actions runner."
     required: false
     default: ${{ github.token }}
-  filePath:  
+  filePath:
     description: 'The path to the directory containing the environment files to upload. Defaults to Actions working directory.'
     required: false
     default: '.'
@@ -18,12 +18,14 @@ inputs:
   dockerImagesToScan:
     description: 'Comma separated list of docker image names or hashes to execute container scanning on, ex: ubuntu:16.04,56bab49eef2ef07505f6a1b0d5bd3a601dfc3c76ad4460f24c91d6fa298369ab'
     required: false
-  detectorsFilter: 
+  detectorsFilter:
     description: 'A comma separated list with the identifiers of the specific detectors to be used. This is meant to be used for testing purposes only.'
     required: false
+  detectorsCategories:
+    description: 'A comma separated list with the categories of components that are going to be scanned. The detectors that are going to run are the ones that belongs to the categories. The possible values are: Npm, NuGet, Maven, RubyGems, Cargo, Pip, GoMod, CocoaPods, Linux.'
+    required: false
   correlator:
     description: 'An optional identifier to distinguish between multiple dependency snapshots of the same type.'
-    type: string
     required: false
 runs:
   using: 'node20'

componentDetection.ts

@@ -22,7 +22,7 @@ export default class ComponentDetection {
   public static componentDetectionPath = process.platform === "win32" ? './component-detection.exe' : './component-detection';
   public static outputPath = './output.json';
 
-  // This is the default entry point for this class. 
+  // This is the default entry point for this class.
   static async scanAndGetManifests(path: string): Promise<Manifest[] | undefined> {
     await this.downloadLatestRelease();
     await this.runComponentDetection(path);
@@ -61,6 +61,7 @@ export default class ComponentDetection {
     parameters += (core.getInput('directoryExclusionList')) ? ` --DirectoryExclusionList ${core.getInput('directoryExclusionList')}` : "";
     parameters += (core.getInput('detectorArgs')) ? ` --DetectorArgs ${core.getInput('detectorArgs')}` : "";
     parameters += (core.getInput('detectorsFilter')) ? ` --DetectorsFilter ${core.getInput('detectorsFilter')}` : "";
+    parameters += (core.getInput('detectorsCategories')) ? ` --DetectorCategories ${core.getInput('detectorsCategories')}` : "";
     parameters += (core.getInput('dockerImagesToScan')) ? ` --DockerImagesToScan ${core.getInput('dockerImagesToScan')}` : "";
     return parameters;
   }
@@ -86,7 +87,7 @@ export default class ComponentDetection {
       }
 
       const packageUrl = ComponentDetection.makePackageUrl(component.component.packageUrl);
-      
+
       // Skip if the packageUrl is empty (indicates an invalid or missing packageUrl)
       if (!packageUrl) {
         core.debug(`Skipping component with invalid packageUrl: ${component.component.id}`);
@@ -110,15 +111,15 @@ export default class ComponentDetection {
           core.debug(`Skipping referrer without packageUrl for component: ${pkg.id}`);
           return;
         }
-        
+
         const referrerUrl = ComponentDetection.makePackageUrl(referrer.packageUrl);
-        
+
         // Skip if the generated packageUrl is empty
         if (!referrerUrl) {
           core.debug(`Skipping referrer with invalid packageUrl for component: ${pkg.id}`);
           return;
         }
-        
+
         try {
           const referrerPackage = packageCache.lookupPackage(referrerUrl);
           if (referrerPackage) {
@@ -195,10 +196,10 @@ export default class ComponentDetection {
   private static async getLatestReleaseURL(): Promise<string> {
     let githubToken = core.getInput('token') || process.env.GITHUB_TOKEN || "";
 
-    const githubAPIURL = 'https://api.github.com' 
+    const githubAPIURL = 'https://api.github.com'
 
     let ghesMode = github.context.apiUrl != githubAPIURL;
-    // If the we're running in GHES, then use an empty string as the token  
+    // If the we're running in GHES, then use an empty string as the token
     if (ghesMode) {
       githubToken = "";
     }
@@ -213,7 +214,7 @@ export default class ComponentDetection {
     const repo = "component-detection";
     core.debug("Attempting to download latest release from " + githubAPIURL);
 
-    try { 
+    try {
       const latestRelease = await octokit.request("GET /repos/{owner}/{repo}/releases/latest", {owner, repo});
 
     var downloadURL: string = "";
@@ -229,7 +230,7 @@ export default class ComponentDetection {
       core.error(error);
       core.debug(error.message);
       core.debug(error.stack);
-      throw new Error("Failed to download latest release"); 
+      throw new Error("Failed to download latest release");
     }
   }
 }

dist/index.js

@@ -36004,7 +36004,7 @@ const exec = __importStar(__nccwpck_require__(5236));
 const dotenv_1 = __importDefault(__nccwpck_require__(8889));
 dotenv_1.default.config();
 class ComponentDetection {
-    // This is the default entry point for this class. 
+    // This is the default entry point for this class.
     static scanAndGetManifests(path) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.downloadLatestRelease();
@@ -36047,6 +36047,7 @@ class ComponentDetection {
         parameters += (core.getInput('directoryExclusionList')) ? ` --DirectoryExclusionList ${core.getInput('directoryExclusionList')}` : "";
         parameters += (core.getInput('detectorArgs')) ? ` --DetectorArgs ${core.getInput('detectorArgs')}` : "";
         parameters += (core.getInput('detectorsFilter')) ? ` --DetectorsFilter ${core.getInput('detectorsFilter')}` : "";
+        parameters += (core.getInput('detectorsCategories')) ? ` --DetectorCategories ${core.getInput('detectorsCategories')}` : "";
         parameters += (core.getInput('dockerImagesToScan')) ? ` --DockerImagesToScan ${core.getInput('dockerImagesToScan')}` : "";
         return parameters;
     }
@@ -36170,7 +36171,7 @@ class ComponentDetection {
             let githubToken = core.getInput('token') || process.env.GITHUB_TOKEN || "";
             const githubAPIURL = 'https://api.github.com';
             let ghesMode = github.context.apiUrl != githubAPIURL;
-            // If the we're running in GHES, then use an empty string as the token  
+            // If the we're running in GHES, then use an empty string as the token
             if (ghesMode) {
                 githubToken = "";
             }