Remove defaults from the recently added fields.

Updating action.yml to include `*-check` config options

.devcontainer/devcontainer.json

@@ -0,0 +1,9 @@
+{
+  "name": "Dependency Review Action",
+  "image": "mcr.microsoft.com/devcontainers/typescript-node:18",
+  "postCreateCommand": "npm install",
+  "remoteUser": "node",
+  "features": {
+    "ghcr.io/devcontainers/features/ruby:1": {}
+  }
+}

.github/dependabot.yml

@@ -9,3 +9,6 @@ updates:
     directory: /
     schedule:
       interval: daily
+    ignore:
+      - dependency-name: '@types/node'
+        update-types: ['version-update:semver-major']

.github/workflows/check-dist.yml

@@ -23,10 +23,10 @@ jobs:
     steps:
       - uses: actions/checkout@v3
 
-      - name: Set Node.js 16.x
+      - name: Set Node.js 18.x
         uses: actions/setup-node@v3
         with:
-          node-version: 16.x
+          node-version: 18.x
 
       - name: Install dependencies
         run: npm ci

.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+      - name: Test
+        run: |
+          npm test
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: npm
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+      - name: Check format
+        run: |
+          npm run format-check
+      - name: Lint
+        run: |
+          npm run lint

.gitignore

@@ -1,4 +1,5 @@
 event.json
+.ruby-version
 
 # Dependency directory
 node_modules

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
+}

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}

CONTRIBUTING.md

@@ -1,4 +1,5 @@
 # Contributing
+
 [fork]: https://github.com/actions/dependency-review-action/fork
 [pr]: https://github.com/actions/dependency-review-action/compare
 [code-of-conduct]: CODE_OF_CONDUCT.md
@@ -9,7 +10,6 @@ Contributions to this project are
 [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license)
 to the public under the [project's open source license](LICENSE).
 
-
 Please note that this project is released with a [Contributor Code of
 Conduct][code-of-conduct]. By participating in this project you agree
 to abide by its terms.
@@ -20,7 +20,6 @@ This Action makes an authenticated query to the Dependency Graph Diff
 API endpoint (`GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}`)
 to find out the set of added and removed dependencies for each manifest.
 
-
 ### Bootstrapping the project
 
 ```
@@ -35,10 +34,11 @@ npm install
 npm run test
 ```
 
-*Note*: We don't have any useful tests yet, contributions are welcome!
+_Note_: We don't have any useful tests yet, contributions are welcome!
 
 ## Local Development
 
+It is recommended to have atleast [Node 18](https://nodejs.org/en/) installed.
 We have a script to scan a given PR for vulnerabilities, this will
 help you test your local changes. Make sure to [grab a Personal Access Token (PAT)](https://github.com/settings/tokens) before proceeding (you'll need `repo` permissions for private repos):
 
@@ -56,16 +56,24 @@ Like this:
 $ GITHUB_TOKEN=my-secret-token ./scripts/scan_pr https://github.com/actions/dependency-review-action/pull/3
 ```
 
+[Configuration options](README.md#configuration-options) can be set by
+passing an external YAML [configuration file](README.md#configuration-file) to the
+`scan_pr` script with the `-c`/`--config-file` option:
+
+```sh
+$ GITHUB_TOKEN=<token> ./scripts/scan_pr --config-file my_custom_config.yml <pr_url>
+```
+
 ## Submitting a pull request
 
 0. [Fork][fork] and clone the repository
-0. Configure and install the dependencies: `npm install`
-0. Make sure the tests pass on your machine: `npm run test`
-0. Create a new branch: `git checkout -b my-branch-name`
-0. Make your change, add tests, and make sure the tests still pass
-0. Make sure to build and package before pushing: `npm run build && npm run package`
-0. Push to your fork and [submit a pull request][pr]
-0. Pat your self on the back and wait for your pull request to be reviewed and merged.
+1. Configure and install the dependencies: `npm install`
+2. Make sure the tests pass on your machine: `npm run test`
+3. Create a new branch: `git checkout -b my-branch-name`
+4. Make your change, add tests, and make sure the tests still pass
+5. Make sure to build and package before pushing: `npm run build && npm run package`
+6. Push to your fork and [submit a pull request][pr]
+7. Pat your self on the back and wait for your pull request to be reviewed and merged.
 
 Here are a few things you can do that will increase the likelihood of your pull request being accepted:
 
@@ -73,6 +81,41 @@ Here are a few things you can do that will increase the likelihood of your pull
 - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
 - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 
+## Cutting a new release
+
+1. Update the version number in [package.json](https://github.com/actions/dependency-review-action/blob/main/package.json).
+1. Go to [Draft a new
+   release](https://github.com/actions/dependency-review-action/releases/new)
+   in the Releases page.
+1. Make sure that the `Publish this Action to the GitHub Marketplace`
+   checkbox is enabled
+
+<img width="481" alt="Screenshot 2022-06-15 at 12 08 19" src="https://user-images.githubusercontent.com/2161/173822484-4b60d8b4-c674-4bff-b5ff-b0c4a3650ab7.png">
+
+3. Click "Choose a tag" and then "Create new tag", where the tag name
+   will be your version prefixed by a `v` (e.g. `v1.2.3`).
+4. Use a version number for the release title (e.g. "1.2.3").
+
+<img width="700" alt="Screenshot 2022-06-15 at 12 08 36" src="https://user-images.githubusercontent.com/2161/173822548-33ab3432-d679-4dc1-adf8-b50fdaf47de3.png">
+
+5. Add your release notes. If this is a major version make sure to
+   include a small description of the biggest changes in the new version.
+6. Click "Publish Release".
+
+You now have a tag and release using the semver version you used
+above. The last remaining thing to do is to move the dynamic version
+identifier to match the current SHA. This allows users to adopt a
+major version number (e.g. `v1`) in their workflows while
+automatically getting all the
+minor/patch updates.
+
+To do this just checkout `main`, force-create a new annotated tag, and push it:
+
+```
+git tag -fa v2 -m "Updating v2 to 2.3.4"
+git push origin v2 --force
+```
+
 ## Resources
 
 - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)

README.md

@@ -1,14 +1,22 @@
 # dependency-review-action
 
-This action scans your pull requests for dependency changes and will raise an error if any new dependencies have existing vulnerabilities. The action is supported by an [API endpoint](https://docs.github.com/en/rest/reference/dependency-graph#dependency-review) that diffs the dependencies between any two revisions.
+This action scans your pull requests for dependency changes, and will
+raise an error if any vulnerabilities or invalid licenses are being introduced. The action is supported by an [API endpoint](https://docs.github.com/en/rest/reference/dependency-graph#dependency-review) that diffs the dependencies between any two revisions.
 
-The action is available for all public repositories, as well as private repositories that have Github Advanced Security licensed.
+The action is available for all public repositories, as well as private repositories that have GitHub Advanced Security licensed.
+
+You can see the results on the job logs:
 
 <img width="854" alt="Screen Shot 2022-03-31 at 1 10 51 PM" src="https://user-images.githubusercontent.com/2161/161042286-b22d7dd3-13cb-458d-8744-ce70ed9bf562.png">
 
+or on the job summary:
+
+<img src="https://user-images.githubusercontent.com/7847935/182871416-50332bbb-b279-4621-a136-ca72a4314301.png">
 
 ## Installation
 
+**Please keep in mind that you need a [GitHub Advanced Security](https://docs.github.com/en/enterprise-cloud@latest/get-started/learning-about-github/about-github-advanced-security) license if you're running this action on private repositories.**
+
 1. Add a new YAML workflow to your `.github/workflows` folder:
 
 ```yaml
@@ -25,15 +33,60 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v2
+        uses: actions/dependency-review-action@v3
 ```
 
-Please keep in mind that you need a GitHub Advanced Security license if you're running this action on private repos.
+### GitHub Enterprise Server
 
-## Configuration
-You can pass additional options to the Dependency Review
-Action using your workflow file. Here's an example workflow with
-all the possible configurations:
+This action is available in Enterprise Server starting with version 3.6. Make sure
+[GitHub Advanced
+Security](https://docs.github.com/en/enterprise-server@3.6/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise)
+and [GitHub
+Connect](https://docs.github.com/en/enterprise-server@3.6/admin/github-actions/managing-access-to-actions-from-githubcom/enabling-automatic-access-to-githubcom-actions-using-github-connect)
+are enabled.
+
+You can use the same workflow as above, replacing the `runs-on` value
+with the label of any of your runners (the default label
+is `self-hosted`):
+
+```yaml
+# ...
+
+jobs:
+  dependency-review:
+    runs-on: self-hosted
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v3
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v3
+```
+
+## Configuration options
+
+Configure this action by either inlining these options in your workflow file, or by using an external configuration file. All configuration options are optional.
+
+| Option                | Usage                                                                                                                                                                             | Possible values                                                                          | Default value |
+|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------|
+| `fail-on-severity`    | Defines the threshold for the level of severity. The action will fail on any pull requests that introduce vulnerabilities of the specified severity level or higher.              | `low`, `moderate`, `high`, `critical`                                                    | `low`         |
+| `allow-licenses`*     | Contains a list of allowed licenses. The action will fail on pull requests that introduce dependencies with licenses that do not match the list.                                  | Any [SPDX-compliant identifier(s)](https://spdx.org/licenses/) | none          |
+| `deny-licenses`*      | Contains a list of prohibited licenses. The action will fail on pull requests that introduce dependencies with licenses that match the list.                                      | Any [SPDX-compliant identifier(s)](https://spdx.org/licenses/) | none          |
+| `fail-on-scopes`†      | Contains a list of strings of the build environments you want to support. The action will fail on pull requests that introduce vulnerabilities in the scopes that match the list. |`runtime`, `development`, `unknown`                                                      | `runtime`     |
+| `allow-ghsas`         | Contains a list of GitHub Advisory Database IDs that can be skipped during detection.                                                                                             | Any GHSAs from the [GitHub Advisory Database](https://github.com/advisories)             | none          |
+| `license-check`       | Enable or disable the license check performed by the action.                                                                                                                                | `true`, `false`                                                                          | `true`       |
+| `vulnerability-check` | Enable or disable the vulnerability check performed by the action.                                                                                                                          | `true`, `false`                                                                          | `true`       |
+| `base-ref`/`head-ref` | Provide custom git references for the git base/head when performing the comparison check. This is only used for event types other than `pull_request` and `pull_request_target`.  | Any valid git ref(s) in your project                                                     | none          |
+
+*not supported for use with GitHub Enterprise Server
+
+†will be supported with GitHub Enterprise Server 3.8 
+
+
+### Inline Configuration
+
+You can pass options to the Dependency Review GitHub Action using your workflow file. 
+
+#### Example
 
 ```yaml
 name: 'Dependency Review'
@@ -47,73 +100,49 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@v3
       - name: Dependency Review
-        uses: actions/dependency-review-action@v2
+        uses: actions/dependency-review-action@v3
         with:
-          # Possible values: "critical", "high", "moderate", "low"
-          # fail-on-severity: critical
-          #
-          # You can only can only include one of these two options: `allow-licenses` and `deny-licences`
-          #
-          # Possible values: Any `spdx_id` value(s) from https://docs.github.com/en/rest/licenses
-          # allow-licenses: GPL-3.0, BSD-3-Clause, MIT
-          #
-          # Possible values: Any `spdx_id` value(s) from https://docs.github.com/en/rest/licenses
-          # deny-licenses: LGPL-2.0, BSD-2-Clause
+          fail-on-severity: moderate
+
+          # Use comma-separated names to pass list arguments:
+          deny-licenses: LGPL-2.0, BSD-2-Clause
 ```
 
-### Vulnerability Severity
+### Configuration File
 
-By default the action will fail on any pull request that contains a
-vulnerable dependency, regardless of the severity level. You can override this behavior by
-using the `fail-on-severity` option, which will cause a failure on any pull requests that introduce vulnerabilities of the specified severity level or higher. The possible values are: `critical`, `high`, `moderate`, or `low`. The
-action defaults to `low`.
+You can use an external configuration file to specify the settings for this action. It can be a local file or a file in an external repository. Refer to the following options for the specification.
 
-This example will only fail on pull requests with `critical` and `high` vulnerabilities:
+| Option                | Usage                                                                                                                                                                                    | Possible values                                                                                                                |
+|-----------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|
+| `config-file`         | A path to a file in the current repository or an external repository. Use this syntax for external files: `OWNER/REPOSITORY/FILENAME@BRANCH`                                             | **Local file**: `./.github/dependency-review-config.yml` <br> **External repo**: `github/octorepo/dependency-review-config.yml@main` |
+| `external-repo-token` | Specifies a token for fetching the configuration file if the file resides in a private external repository. Create a token in [developer settings](https://github.com/settings/tokens). | Any token with `read` permissions to the repository hosting the config file.                                                   |
+
+#### Example
+
+Start by specifying that you will be using an external configuration file:
 
 ```yaml
 - name: Dependency Review
   uses: actions/dependency-review-action@v2
   with:
-    fail-on-severity: high
+    config-file: './.github/dependency-review-config.yml'
 ```
 
-### Licenses
-
-You can set the action to fail on pull requests based on the licenses of the dependencies
-they introduce. With `allow-licenses` you can define the list of licenses
-your repository will accept. Alternatively, you can use `deny-licenses` to only
-forbid a subset of licenses.
-
-You can use the [Licenses
-API](https://docs.github.com/en/rest/licenses) to see the full list of
-supported licenses. Use the `spdx_id` field for every license you want
-to filter. A couple of examples:
+And then create the file in the path you just specified: 
 
 ```yaml
-# only allow MIT-licensed dependents
-- name: Dependency Review
-  uses: actions/dependency-review-action@v2
-  with:
-    allow-licenses: MIT
+fail-on-severity: 'critical'
+allow-licenses:
+  - 'GPL-3.0'
+  - 'BSD-3-Clause'
+  - 'MIT'
 ```
 
-```yaml
-# Block Apache 1.1 and 2.0 licensed dependents
-- name: Dependency Review
-  uses: actions/dependency-review-action@v2
-  with:
-    deny-licenses: Apache-1.1, Apache-2.0
-```
+### Considerations
 
-**Important**
-
-* The action will only accept one of the two parameters; an error will
-be raised if you provide both.
-* By default both parameters are empty (no license checking is
-performed).
-* We don't have license information for all of your dependents. If we
-can't detect the license for a dependency **we will inform you, but the
-action won't fail**.
+- Checking for licenses is not supported on Enterprise Server.
+- The action will only accept one of the two `license` parameters; an error will be raised if you provide both.
+- We don't have license information for all of your dependents. If we can't detect the license for a dependency **we will inform you, but the action won't fail**.
 
 ## Blocking pull requests
 
@@ -121,14 +150,12 @@ The Dependency Review GitHub Action check will only block a pull request from be
 
 ## Getting help
 
-If you have bug reports, questions or suggestions please [create a new
-issue](https://github.com/actions/dependency-review-action/issues/new/choose).
+If you have bug reports, questions or suggestions please [create a new issue](https://github.com/actions/dependency-review-action/issues/new/choose).
 
 ## Contributing
 
-We are grateful for any contributions made to this project.
-
-Please read [CONTRIBUTING.MD](https://github.com/actions/dependency-review-action/blob/main/CONTRIBUTING.md) to get started.
+We are grateful for any contributions made to this project. Please read [CONTRIBUTING.MD](https://github.com/actions/dependency-review-action/blob/main/CONTRIBUTING.md) to get started.
 
 ## License
+
 This project is released under the [MIT License](https://github.com/actions/dependency-review-action/blob/main/LICENSE).

__tests__/config.test.ts

@@ -1,5 +1,7 @@
 import {expect, test, beforeEach} from '@jest/globals'
 import {readConfig} from '../src/config'
+import {getRefs} from '../src/git-refs'
+import * as Utils from '../src/utils'
 
 // GitHub Action inputs come in the form of environment variables
 // with an INPUT prefix (e.g. INPUT_FAIL-ON-SEVERITY)
@@ -10,44 +12,242 @@ function setInput(input: string, value: string) {
 // We want a clean ENV before each test. We use `delete`
 // since we want `undefined` values and not empty strings.
 function clearInputs() {
-  delete process.env['INPUT_FAIL-ON-SEVERITY']
-  delete process.env['INPUT_ALLOW-LICENSES']
-  delete process.env['INPUT_DENY-LICENSES']
+  const allowedOptions = [
+    'FAIL-ON-SEVERITY',
+    'FAIL-ON-SCOPES',
+    'ALLOW-LICENSES',
+    'DENY-LICENSES',
+    'ALLOW-GHSAS',
+    'LICENSE-CHECK',
+    'VULNERABILITY-CHECK',
+    'CONFIG-FILE',
+    'BASE-REF',
+    'HEAD-REF'
+  ]
+
+  allowedOptions.forEach(option => {
+    delete process.env[`INPUT_${option.toUpperCase()}`]
+  })
 }
 
+beforeAll(() => {
+  jest.spyOn(Utils, 'isSPDXValid').mockReturnValue(true)
+})
+
 beforeEach(() => {
   clearInputs()
 })
 
 test('it defaults to low severity', async () => {
-  const options = readConfig()
-  expect(options.fail_on_severity).toEqual('low')
+  const config = await readConfig()
+  expect(config.fail_on_severity).toEqual('low')
 })
 
 test('it reads custom configs', async () => {
   setInput('fail-on-severity', 'critical')
   setInput('allow-licenses', ' BSD, GPL 2')
 
-  const options = readConfig()
-  expect(options.fail_on_severity).toEqual('critical')
-  expect(options.allow_licenses).toEqual(['BSD', 'GPL 2'])
+  const config = await readConfig()
+  expect(config.fail_on_severity).toEqual('critical')
+  expect(config.allow_licenses).toEqual(['BSD', 'GPL 2'])
 })
 
 test('it defaults to empty allow/deny lists ', async () => {
-  const options = readConfig()
+  const config = await readConfig()
 
-  expect(options.allow_licenses).toEqual(undefined)
-  expect(options.deny_licenses).toEqual(undefined)
+  expect(config.allow_licenses).toEqual(undefined)
+  expect(config.deny_licenses).toEqual(undefined)
 })
 
 test('it raises an error if both an allow and denylist are specified', async () => {
   setInput('allow-licenses', 'MIT')
   setInput('deny-licenses', 'BSD')
 
-  expect(() => readConfig()).toThrow()
+  await expect(readConfig()).rejects.toThrow(
+    'You cannot specify both allow-licenses and deny-licenses'
+  )
+})
+test('it raises an error if an empty allow list is specified', async () => {
+  setInput('config-file', './__tests__/fixtures/config-empty-allow-sample.yml')
+
+  await expect(readConfig()).rejects.toThrow(
+    'You should provide at least one license in allow-licenses'
+  )
 })
 
 test('it raises an error when given an unknown severity', async () => {
   setInput('fail-on-severity', 'zombies')
-  expect(() => readConfig()).toThrow()
+
+  await expect(readConfig()).rejects.toThrow(/received 'zombies'/)
+})
+
+test('it uses the given refs when the event is not a pull request', async () => {
+  setInput('base-ref', 'a-custom-base-ref')
+  setInput('head-ref', 'a-custom-head-ref')
+
+  const refs = getRefs(await readConfig(), {
+    payload: {},
+    eventName: 'workflow_dispatch'
+  })
+  expect(refs.base).toEqual('a-custom-base-ref')
+  expect(refs.head).toEqual('a-custom-head-ref')
+})
+
+test('it raises an error when no refs are provided and the event is not a pull request', async () => {
+  const config = await readConfig()
+  expect(() =>
+    getRefs(config, {
+      payload: {},
+      eventName: 'workflow_dispatch'
+    })
+  ).toThrow()
+})
+
+test('it reads an external config file', async () => {
+  setInput('config-file', './__tests__/fixtures/config-allow-sample.yml')
+
+  const config = await readConfig()
+  expect(config.fail_on_severity).toEqual('critical')
+  expect(config.allow_licenses).toEqual(['BSD', 'GPL 2'])
+})
+
+test('raises an error when the the config file was not found', async () => {
+  setInput('config-file', 'fixtures/i-dont-exist')
+  await expect(readConfig()).rejects.toThrow(/Unable to fetch config file/)
+})
+
+test('it parses options from both sources', async () => {
+  setInput('config-file', './__tests__/fixtures/config-allow-sample.yml')
+
+  let config = await readConfig()
+  expect(config.fail_on_severity).toEqual('critical')
+
+  setInput('base-ref', 'a-custom-base-ref')
+  config = await readConfig()
+  expect(config.base_ref).toEqual('a-custom-base-ref')
+})
+
+test('in case of conflicts, the inline config is the source of truth', async () => {
+  setInput('fail-on-severity', 'low')
+  setInput('config-file', './__tests__/fixtures/config-allow-sample.yml') // this will set fail-on-severity to 'critical'
+
+  const config = await readConfig()
+  expect(config.fail_on_severity).toEqual('low')
+})
+
+test('it uses the default values when loading external files', async () => {
+  setInput('config-file', './__tests__/fixtures/no-licenses-config.yml')
+  let config = await readConfig()
+  expect(config.allow_licenses).toEqual(undefined)
+  expect(config.deny_licenses).toEqual(undefined)
+
+  setInput('config-file', './__tests__/fixtures/license-config-sample.yml')
+  config = await readConfig()
+  expect(config.fail_on_severity).toEqual('low')
+})
+
+test('it accepts an external configuration filename', async () => {
+  setInput('config-file', './__tests__/fixtures/no-licenses-config.yml')
+  const config = await readConfig()
+  expect(config.fail_on_severity).toEqual('critical')
+})
+
+test('it raises an error when given an unknown severity in an external config file', async () => {
+  setInput('config-file', './__tests__/fixtures/invalid-severity-config.yml')
+  await expect(readConfig()).rejects.toThrow()
+})
+
+test('it defaults to runtime scope', async () => {
+  const config = await readConfig()
+  expect(config.fail_on_scopes).toEqual(['runtime'])
+})
+
+test('it parses custom scopes preference', async () => {
+  setInput('fail-on-scopes', 'runtime, development')
+  let config = await readConfig()
+  expect(config.fail_on_scopes).toEqual(['runtime', 'development'])
+
+  clearInputs()
+  setInput('fail-on-scopes', 'development')
+  config = await readConfig()
+  expect(config.fail_on_scopes).toEqual(['development'])
+})
+
+test('it raises an error when given invalid scope', async () => {
+  setInput('fail-on-scopes', 'runtime, zombies')
+  await expect(readConfig()).rejects.toThrow(/received 'zombies'/)
+})
+
+test('it defaults to an empty GHSA allowlist', async () => {
+  const config = await readConfig()
+  expect(config.allow_ghsas).toEqual([])
+})
+
+test('it successfully parses GHSA allowlist', async () => {
+  setInput('allow-ghsas', 'GHSA-abcd-1234-5679, GHSA-efgh-1234-5679')
+  const config = await readConfig()
+  expect(config.allow_ghsas).toEqual([
+    'GHSA-abcd-1234-5679',
+    'GHSA-efgh-1234-5679'
+  ])
+})
+
+test('it defaults to checking licenses', async () => {
+  const config = await readConfig()
+  expect(config.license_check).toBe(true)
+})
+
+test('it parses the license-check input', async () => {
+  setInput('license-check', 'false')
+  let config = await readConfig()
+  expect(config.license_check).toEqual(false)
+
+  clearInputs()
+  setInput('license-check', 'true')
+  config = await readConfig()
+  expect(config.license_check).toEqual(true)
+})
+
+test('it defaults to checking vulnerabilities', async () => {
+  const config = await readConfig()
+  expect(config.vulnerability_check).toBe(true)
+})
+
+test('it parses the vulnerability-check input', async () => {
+  setInput('vulnerability-check', 'false')
+  let config = await readConfig()
+  expect(config.vulnerability_check).toEqual(false)
+
+  clearInputs()
+  setInput('vulnerability-check', 'true')
+  config = await readConfig()
+  expect(config.vulnerability_check).toEqual(true)
+})
+
+test('it is not possible to disable both checks', async () => {
+  setInput('license-check', 'false')
+  setInput('vulnerability-check', 'false')
+  await expect(readConfig()).rejects.toThrow(
+    /Can't disable both license-check and vulnerability-check/
+  )
+})
+
+describe('licenses that are not valid SPDX licenses', () => {
+  beforeAll(() => {
+    jest.spyOn(Utils, 'isSPDXValid').mockReturnValue(false)
+  })
+
+  test('it raises an error for invalid licenses in allow-licenses', async () => {
+    setInput('allow-licenses', ' BSD, GPL 2')
+    await expect(readConfig()).rejects.toThrow(
+      'Invalid license(s) in allow-licenses: BSD, GPL 2'
+    )
+  })
+
+  test('it raises an error for invalid licenses in deny-licenses', async () => {
+    setInput('deny-licenses', ' BSD, GPL 2')
+    await expect(readConfig()).rejects.toThrow(
+      'Invalid license(s) in deny-licenses: BSD, GPL 2'
+    )
+  })
 })

__tests__/filter.test.ts

@@ -1,6 +1,10 @@
 import {expect, test} from '@jest/globals'
 import {Change, Changes} from '../src/schemas'
-import {filterChangesBySeverity} from '../src/filter'
+import {
+  filterChangesBySeverity,
+  filterChangesByScopes,
+  filterAllowedAdvisories
+} from '../src/filter'
 
 let npmChange: Change = {
   manifest: 'package.json',
@@ -11,11 +15,12 @@ let npmChange: Change = {
   package_url: 'pkg:npm/reeuhq@1.0.2',
   license: 'MIT',
   source_repository_url: 'github.com/some-repo',
+  scope: 'runtime',
   vulnerabilities: [
     {
       severity: 'critical',
       advisory_ghsa_id: 'first-random_string',
-      advisory_summary: 'very dangerouns',
+      advisory_summary: 'very dangerous',
       advisory_url: 'github.com/future-funk'
     }
   ]
@@ -30,11 +35,12 @@ let rubyChange: Change = {
   package_url: 'pkg:gem/actionsomething@3.2.0',
   license: 'BSD',
   source_repository_url: 'github.com/some-repo',
+  scope: 'development',
   vulnerabilities: [
     {
       severity: 'moderate',
       advisory_ghsa_id: 'second-random_string',
-      advisory_summary: 'not so dangerouns',
+      advisory_summary: 'not so dangerous',
       advisory_url: 'github.com/future-funk'
     },
     {
@@ -46,6 +52,19 @@ let rubyChange: Change = {
   ]
 }
 
+let noVulnNpmChange: Change = {
+  manifest: 'package.json',
+  change_type: 'added',
+  ecosystem: 'npm',
+  name: 'helpful',
+  version: '1.0.0',
+  package_url: 'pkg:npm/helpful@1.0.0',
+  license: 'MIT',
+  source_repository_url: 'github.com/some-repo',
+  scope: 'runtime',
+  vulnerabilities: []
+}
+
 test('it properly filters changes by severity', async () => {
   const changes = [npmChange, rubyChange]
   let result = filterChangesBySeverity('high', changes)
@@ -57,3 +76,48 @@ test('it properly filters changes by severity', async () => {
   result = filterChangesBySeverity('critical', changes)
   expect(changes).toEqual([npmChange, rubyChange])
 })
+
+test('it properly filters changes by scope', async () => {
+  const changes = [npmChange, rubyChange]
+
+  let result = filterChangesByScopes(['runtime'], changes)
+  expect(result).toEqual([npmChange])
+
+  result = filterChangesByScopes(['development'], changes)
+  expect(result).toEqual([rubyChange])
+
+  result = filterChangesByScopes(['runtime', 'development'], changes)
+  expect(result).toEqual([npmChange, rubyChange])
+})
+
+test('it properly handles undefined advisory IDs', async () => {
+  const changes = [npmChange, rubyChange, noVulnNpmChange]
+  let result = filterAllowedAdvisories(undefined, changes)
+  expect(result).toEqual([npmChange, rubyChange, noVulnNpmChange])
+})
+
+test('it properly filters changes with allowed vulnerabilities', async () => {
+  const changes = [npmChange, rubyChange, noVulnNpmChange]
+
+  let result = filterAllowedAdvisories(['notrealGHSAID'], changes)
+  expect(result).toEqual([npmChange, rubyChange, noVulnNpmChange])
+
+  result = filterAllowedAdvisories(['first-random_string'], changes)
+  expect(result).toEqual([rubyChange, noVulnNpmChange])
+
+  result = filterAllowedAdvisories(
+    ['second-random_string', 'third-random_string'],
+    changes
+  )
+  expect(result).toEqual([npmChange, noVulnNpmChange])
+
+  result = filterAllowedAdvisories(
+    ['first-random_string', 'second-random_string', 'third-random_string'],
+    changes
+  )
+  expect(result).toEqual([noVulnNpmChange])
+
+  // if we have a change with multiple vulnerabilities but only one is allowed, we still should not filter out that change
+  result = filterAllowedAdvisories(['second-random_string'], changes)
+  expect(result).toEqual([npmChange, rubyChange, noVulnNpmChange])
+})

__tests__/fixtures/config-empty-allow-sample.yml

@@ -0,0 +1,2 @@
+fail_on_severity: critical
+allow_licenses: []

__tests__/fixtures/invalid-severity-config.yml

@@ -0,0 +1,3 @@
+fail-on-severity: 'so many zombies'
+deny-licenses:
+  - MIT

__tests__/fixtures/license-config-sample.yml

@@ -0,0 +1 @@
+allow_licenses: ['MIT', 'GPL 2']

__tests__/licenses.test.ts

@@ -1,6 +1,7 @@
-import {expect, test} from '@jest/globals'
+import {expect, jest, test} from '@jest/globals'
 import {Change, Changes} from '../src/schemas'
-import {getDeniedLicenseChanges} from '../src/licenses'
+
+let getInvalidLicenseChanges: Function
 
 let npmChange: Change = {
   manifest: 'package.json',
@@ -11,11 +12,12 @@ let npmChange: Change = {
   package_url: 'pkg:npm/reeuhq@1.0.2',
   license: 'MIT',
   source_repository_url: 'github.com/some-repo',
+  scope: 'runtime',
   vulnerabilities: [
     {
       severity: 'critical',
       advisory_ghsa_id: 'first-random_string',
-      advisory_summary: 'very dangerouns',
+      advisory_summary: 'very dangerous',
       advisory_url: 'github.com/future-funk'
     }
   ]
@@ -30,11 +32,12 @@ let rubyChange: Change = {
   package_url: 'pkg:gem/actionsomething@3.2.0',
   license: 'BSD',
   source_repository_url: 'github.com/some-repo',
+  scope: 'runtime',
   vulnerabilities: [
     {
       severity: 'moderate',
       advisory_ghsa_id: 'second-random_string',
-      advisory_summary: 'not so dangerouns',
+      advisory_summary: 'not so dangerous',
       advisory_url: 'github.com/future-funk'
     },
     {
@@ -46,25 +49,142 @@ let rubyChange: Change = {
   ]
 }
 
-test('it fails if a license outside the allow list is found', async () => {
-  const changes: Changes = [npmChange, rubyChange]
-  const [invalidChanges, _] = getDeniedLicenseChanges(changes, {allow: ['BSD']})
-  expect(invalidChanges[0]).toBe(npmChange)
+jest.mock('@actions/core')
+
+const mockOctokit = {
+  rest: {
+    licenses: {
+      getForRepo: jest
+        .fn()
+        .mockReturnValue({data: {license: {spdx_id: 'AGPL'}}})
+    }
+  }
+}
+
+jest.mock('octokit', () => {
+  return {
+    Octokit: class {
+      constructor() {
+        return mockOctokit
+      }
+    }
+  }
 })
 
-test('it fails if a license inside the deny list is found', async () => {
-  const changes: Changes = [npmChange, rubyChange]
-  const [invalidChanges] = getDeniedLicenseChanges(changes, {deny: ['BSD']})
-  expect(invalidChanges[0]).toBe(rubyChange)
+beforeEach(async () => {
+  jest.resetModules()
+  jest.doMock('spdx-satisfies', () => {
+    // mock spdx-satisfies return value
+    // true for BSD, false for all others
+    return jest.fn((license: string, _: string): boolean => license === 'BSD')
+  })
+  ;({getInvalidLicenseChanges} = require('../src/licenses'))
 })
 
-// This is more of a "here's a behavior that might be surprising" than an actual
-// thing we want in the system. Please remove this test after refactoring.
-test('it fails all license checks when allow is provided an empty array', async () => {
+test('it adds license outside the allow list to forbidden changes', async () => {
   const changes: Changes = [npmChange, rubyChange]
-  let [invalidChanges, _] = getDeniedLicenseChanges(changes, {
-    allow: [],
+  const {forbidden} = await getInvalidLicenseChanges(changes, {
+    allow: ['BSD']
+  })
+  expect(forbidden[0]).toBe(npmChange)
+  expect(forbidden.length).toEqual(1)
+})
+
+test('it adds license inside the deny list to forbidden changes', async () => {
+  const changes: Changes = [npmChange, rubyChange]
+  const {forbidden} = await getInvalidLicenseChanges(changes, {
     deny: ['BSD']
   })
-  expect(invalidChanges.length).toBe(2)
+  expect(forbidden[0]).toBe(rubyChange)
+  expect(forbidden.length).toEqual(1)
+})
+
+test('it does not add license outside the allow list to forbidden changes if it is in removed changes', async () => {
+  const changes: Changes = [
+    {...npmChange, change_type: 'removed'},
+    {...rubyChange, change_type: 'removed'}
+  ]
+  const {forbidden} = await getInvalidLicenseChanges(changes, {
+    allow: ['BSD']
+  })
+  expect(forbidden).toStrictEqual([])
+})
+
+test('it does not add license inside the deny list to forbidden changes if it is in removed changes', async () => {
+  const changes: Changes = [
+    {...npmChange, change_type: 'removed'},
+    {...rubyChange, change_type: 'removed'}
+  ]
+  const {forbidden} = await getInvalidLicenseChanges(changes, {
+    deny: ['BSD']
+  })
+  expect(forbidden).toStrictEqual([])
+})
+
+test('it adds license outside the allow list to forbidden changes if it is in both added and removed changes', async () => {
+  const changes: Changes = [
+    {...npmChange, change_type: 'removed'},
+    npmChange,
+    {...rubyChange, change_type: 'removed'}
+  ]
+  const {forbidden} = await getInvalidLicenseChanges(changes, {
+    allow: ['BSD']
+  })
+  expect(forbidden).toStrictEqual([npmChange])
+})
+
+test('it adds all licenses to unresolved if it is unable to determine the validity', async () => {
+  jest.resetModules() // reset module set in before
+  jest.doMock('spdx-satisfies', () => {
+    return jest.fn((_first: string, _second: string) => {
+      throw new Error('Some Error')
+    })
+  })
+  ;({getInvalidLicenseChanges} = require('../src/licenses'))
+  const changes: Changes = [npmChange, rubyChange]
+  const invalidLicenses = await getInvalidLicenseChanges(changes, {
+    allow: ['BSD']
+  })
+  expect(invalidLicenses.forbidden.length).toEqual(0)
+  expect(invalidLicenses.unlicensed.length).toEqual(0)
+  expect(invalidLicenses.unresolved.length).toEqual(2)
+})
+
+describe('GH License API fallback', () => {
+  test('it calls licenses endpoint if atleast one of the changes has null license and valid source_repository_url', async () => {
+    const nullLicenseChange = {
+      ...npmChange,
+      license: null,
+      source_repository_url: 'http://github.com/some-owner/some-repo'
+    }
+    const {unlicensed} = await getInvalidLicenseChanges(
+      [nullLicenseChange, rubyChange],
+      {}
+    )
+
+    expect(mockOctokit.rest.licenses.getForRepo).toHaveBeenNthCalledWith(1, {
+      owner: 'some-owner',
+      repo: 'some-repo'
+    })
+    expect(unlicensed.length).toEqual(0)
+  })
+
+  test('it does not call licenses API endpoint for change with null license and invalid source_repository_url ', async () => {
+    const {unlicensed} = await getInvalidLicenseChanges(
+      [{...npmChange, license: null}],
+      {}
+    )
+    expect(mockOctokit.rest.licenses.getForRepo).not.toHaveBeenCalled()
+    expect(unlicensed.length).toEqual(1)
+  })
+
+  test('it does not call licenses API endpoint if licenses for all changes are present', async () => {
+    const {unlicensed} = await getInvalidLicenseChanges(
+      [npmChange, rubyChange],
+      {}
+    )
+
+    expect(mockOctokit.rest.licenses.getForRepo).not.toHaveBeenCalled()
+    expect(unlicensed.length).toEqual(0)
+  })
 })

action.yml

@@ -10,12 +10,37 @@ inputs:
     description: Don't block PRs below this severity. Possible values are `low`, `moderate`, `high`, `critical`.
     required: false
     default: 'low'
+  fail-on-scopes:
+    description: Dependency scopes to block PRs on. Comma-separated list. Possible values are 'unknown', 'runtime', and 'development' (e.g. "runtime, development")
+    required: false
+    default: 'runtime'
+  base-ref:
+    description: The base git ref to be used for this check. Has a default value when the workflow event is `pull_request` or `pull_request_target`. Must be provided otherwise.
+    required: false
+  head-ref:
+    description: The head git ref to be used for this check. Has a default value when the workflow event is `pull_request` or `pull_request_target`. Must be provided otherwise.
+    required: false
+  config-file:
+    description: A path to the configuration file for the action.
+    required: false
   allow-licenses:
     description: Comma-separated list of allowed licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause")
     required: false
   deny-licenses:
     description: Comma-separated list of forbidden licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause")
     required: false
+  allow-ghsas:
+    description: Comma-separated list of allowed Github Advisory IDs (e.g. "GHSA-abcd-1234-5679, GHSA-efgh-1234-5679")
+    required: false
+  external-repo-token:
+    description: A token for fetching external configuration file if it lives in another repository. It is required if the repository is private
+    required: false
+  license-check:
+    description: A boolean to determine if license checks should be performed
+    required: false
+  vulnerability-check:
+    description: A boolean to determine if vulnerability checks should be performed
+    required: false
 runs:
   using: 'node16'
   main: 'dist/index.js'

jest.config.js

@@ -1,9 +1,9 @@
 module.exports = {
   clearMocks: true,
-  moduleFileExtensions: ['js', 'ts'],
+  moduleFileExtensions: ['js', 'json', 'ts'],
   testMatch: ['**/*.test.ts'],
   transform: {
     '^.+\\.ts$': 'ts-jest'
   },
   verbose: true
-}
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "dependency-review-action",
-  "version": "2.0.0",
+  "version": "2.5.1",
   "private": true,
   "description": "A GitHub Action for Dependency Review",
   "main": "lib/main.js",
@@ -25,30 +25,36 @@
   "author": "GitHub",
   "license": "MIT",
   "dependencies": {
-    "@actions/core": "^1.8.2",
-    "@actions/github": "^5.0.3",
-    "@octokit/plugin-retry": "^3.0.9",
-    "@octokit/request-error": "^2.1.0",
-    "ansi-styles": "^6.1.0",
-    "got": "^12.1.0",
-    "nodemon": "^2.0.16",
-    "yaml": "^2.1.1",
-    "zod": "^3.17.3"
+    "@actions/core": "^1.10.0",
+    "@actions/github": "^5.1.1",
+    "@octokit/plugin-retry": "^4.0.3",
+    "@octokit/request-error": "^3.0.2",
+    "ansi-styles": "^6.2.1",
+    "got": "^12.5.2",
+    "nodemon": "^2.0.20",
+    "octokit": "^2.0.10",
+    "spdx-expression-parse": "^3.0.1",
+    "spdx-satisfies": "^5.0.1",
+    "yaml": "^2.1.3",
+    "zod": "^3.19.1"
   },
   "devDependencies": {
-    "@types/node": "^17.0.43",
-    "@typescript-eslint/eslint-plugin": "^5.28.0",
-    "@typescript-eslint/parser": "^5.28.0",
+    "@types/jest": "^27.5.2",
+    "@types/node": "^16.18.3",
+    "@typescript-eslint/eslint-plugin": "^5.42.1",
+    "@typescript-eslint/parser": "^5.42.1",
+    "@types/spdx-expression-parse": "^3.0.2",
+    "@types/spdx-satisfies": "^0.1.0",
     "@vercel/ncc": "^0.34.0",
-    "esbuild-register": "^3.3.3",
-    "eslint": "^8.17.0",
-    "eslint-plugin-github": "^4.3.6",
-    "eslint-plugin-jest": "^26.5.3",
+    "esbuild-register": "^3.4.1",
+    "eslint": "^8.27.0",
+    "eslint-plugin-github": "^4.4.1",
+    "eslint-plugin-jest": "^27.1.5",
     "jest": "^27.5.1",
     "js-yaml": "^4.1.0",
-    "nodemon": "^2.0.16",
-    "prettier": "2.7.0",
+    "nodemon": "^2.0.20",
+    "prettier": "2.7.1",
     "ts-jest": "^27.1.4",
-    "typescript": "^4.7.3"
+    "typescript": "^4.8.4"
   }
 }

scripts/scan_pr

@@ -3,22 +3,52 @@ require 'json'
 require 'tempfile'
 require 'open3'
 require 'bundler/inline'
+require 'optparse'
 
 gemfile do
   source 'https://rubygems.org'
   gem 'octokit'
 end
 
+config_file = nil
 github_token = ENV["GITHUB_TOKEN"]
+
 if !github_token || github_token.empty?
   puts "Please set the GITHUB_TOKEN environment variable"
   exit -1
 end
 
-arg = /(?<repo_nwo>[\w\-]+\/[\w\-]+)\/pull\/(?<pr_number>\d+)/.match(ARGV[0])
+op = OptionParser.new do |opts|
+  usage = <<EOF
+Run Dependency Review on a repository.
+
+\e[1mUsage:\e[22m
+  scripts/scan_pr [options] <pr_url>
+
+\e[1mExample:\e[22m
+  scripts/scan_pr https://github.com/actions/dependency-review-action/pull/294
+
+EOF
+
+  opts.banner = usage
+
+  opts.on('-c', '--config-file <FILE>', 'Use an external configuration file') do |cf|
+    config_file = cf
+  end
+
+  opts.on("-h", "--help", "Prints this help") do
+    puts opts
+    exit
+  end
+end
+
+op.parse!
+
+# make sure we have a NWO somewhere in the parameters
+arg = /(?<repo_nwo>[\w\-]+\/[\w\-]+)\/pull\/(?<pr_number>\d+)/.match(ARGV.join(" "))
 
 if arg.nil?
-  puts "Usage: script/scan_pr <pr_url>"
+  puts op
   exit -1
 end
 
@@ -32,17 +62,26 @@ event_file = Tempfile.new
 event_file.write("{ \"pull_request\": #{pr.to_h.to_json}}")
 event_file.close
 
-dev_cmd_env = {
-  "INPUT_REPO-TOKEN" => github_token,
-  "GITHUB_REPOSITORY" => repo_nwo,
-  "GITHUB_EVENT_NAME" => "pull_request",
-  "GITHUB_EVENT_PATH" => event_file.path
+action_inputs = {
+  "repo-token": github_token,
+  "config-file": config_file
 }
 
-dev_cmd = "./node_modules/.bin/nodemon --exec \"node -r esbuild-register\" src/main.ts"
+dev_cmd_env = {
+  "GITHUB_REPOSITORY" => repo_nwo,
+  "GITHUB_EVENT_NAME" => "pull_request",
+  "GITHUB_EVENT_PATH" => event_file.path,
+  "GITHUB_STEP_SUMMARY" => "/dev/null"
+}
+
+# bash does not like variable names with dashes like the ones Actions
+# uses (e.g. INPUT_REPO-TOKEN). Passing them through `env` instead of
+# manually setting them does the job.
+action_inputs_env_str = action_inputs.map { |name, value| "\"INPUT_#{name.upcase}=#{value}\"" }.join(" ")
+dev_cmd = "./node_modules/.bin/nodemon --exec \"env #{action_inputs_env_str} node -r esbuild-register\" src/main.ts"
 
 Open3.popen2e(dev_cmd_env, dev_cmd) do |stdin, out|
   while line = out.gets
-    puts line
+    puts line.gsub(github_token, "<REDACTED>")
   end
 end

src/config.ts

@@ -1,27 +1,165 @@
+import * as fs from 'fs'
+import path from 'path'
+import YAML from 'yaml'
 import * as core from '@actions/core'
 import * as z from 'zod'
-import {ConfigurationOptions, SEVERITIES} from './schemas'
+import {ConfigurationOptions, ConfigurationOptionsSchema} from './schemas'
+import {isSPDXValid, octokitClient} from './utils'
+
+type ConfigurationOptionsPartial = Partial<ConfigurationOptions>
+
+export async function readConfig(): Promise<ConfigurationOptions> {
+  const inlineConfig = readInlineConfig()
+
+  const configFile = getOptionalInput('config-file')
+  if (configFile !== undefined) {
+    const externalConfig = await readConfigFile(configFile)
+
+    return ConfigurationOptionsSchema.parse({
+      ...externalConfig,
+      ...inlineConfig
+    })
+  }
+
+  return ConfigurationOptionsSchema.parse(inlineConfig)
+}
+
+function readInlineConfig(): ConfigurationOptionsPartial {
+  const fail_on_severity = getOptionalInput('fail-on-severity')
+  const fail_on_scopes = parseList(getOptionalInput('fail-on-scopes'))
+  const allow_licenses = parseList(getOptionalInput('allow-licenses'))
+  const deny_licenses = parseList(getOptionalInput('deny-licenses'))
+  const allow_ghsas = parseList(getOptionalInput('allow-ghsas'))
+  const license_check = getOptionalBoolean('license-check')
+  const vulnerability_check = getOptionalBoolean('vulnerability-check')
+  const base_ref = getOptionalInput('base-ref')
+  const head_ref = getOptionalInput('head-ref')
+
+  validateLicenses('allow-licenses', allow_licenses)
+  validateLicenses('deny-licenses', deny_licenses)
+
+  const keys = {
+    fail_on_severity,
+    fail_on_scopes,
+    allow_licenses,
+    deny_licenses,
+    allow_ghsas,
+    license_check,
+    vulnerability_check,
+    base_ref,
+    head_ref
+  }
+
+  return Object.fromEntries(
+    Object.entries(keys).filter(([_, value]) => value !== undefined)
+  )
+}
+
+function getOptionalBoolean(name: string): boolean | undefined {
+  const value = core.getInput(name)
+  return value.length > 0 ? core.getBooleanInput(name) : undefined
+}
 
 function getOptionalInput(name: string): string | undefined {
   const value = core.getInput(name)
   return value.length > 0 ? value : undefined
 }
 
-export function readConfig(): ConfigurationOptions {
-  const fail_on_severity = z
-    .enum(SEVERITIES)
-    .default('low')
-    .parse(getOptionalInput('fail-on-severity'))
-  const allow_licenses = getOptionalInput('allow-licenses')
-  const deny_licenses = getOptionalInput('deny-licenses')
-
-  if (allow_licenses !== undefined && deny_licenses !== undefined) {
-    throw new Error("Can't specify both allow_licenses and deny_licenses")
-  }
-
-  return {
-    fail_on_severity,
-    allow_licenses: allow_licenses?.split(',').map(x => x.trim()),
-    deny_licenses: deny_licenses?.split(',').map(x => x.trim())
+function parseList(list: string | undefined): string[] | undefined {
+  if (list === undefined) {
+    return list
+  } else {
+    return list.split(',').map(x => x.trim())
+  }
+}
+
+function validateLicenses(
+  key: 'allow-licenses' | 'deny-licenses',
+  licenses: string[] | undefined
+): void {
+  if (licenses === undefined) {
+    return
+  }
+  const invalid_licenses = licenses.filter(license => !isSPDXValid(license))
+
+  if (invalid_licenses.length > 0) {
+    throw new Error(
+      `Invalid license(s) in ${key}: ${invalid_licenses.join(', ')}`
+    )
+  }
+}
+
+async function readConfigFile(
+  filePath: string
+): Promise<ConfigurationOptionsPartial> {
+  // match a remote config (e.g. 'owner/repo/filepath@someref')
+  const format = new RegExp(
+    '(?<owner>[^/]+)/(?<repo>[^/]+)/(?<path>[^@]+)@(?<ref>.*)'
+  )
+
+  let data: string
+  const pieces = format.exec(filePath)
+
+  try {
+    if (pieces?.groups && pieces.length === 5) {
+      data = await getRemoteConfig({
+        owner: pieces.groups.owner,
+        repo: pieces.groups.repo,
+        path: pieces.groups.path,
+        ref: pieces.groups.ref
+      })
+    } else {
+      data = fs.readFileSync(path.resolve(filePath), 'utf-8')
+    }
+    return parseConfigFile(data)
+  } catch (error) {
+    core.debug(error as string)
+    throw new Error('Unable to fetch config file')
+  }
+}
+
+function parseConfigFile(configData: string): ConfigurationOptionsPartial {
+  try {
+    const data = YAML.parse(configData)
+    for (const key of Object.keys(data)) {
+      if (key === 'allow-licenses' || key === 'deny-licenses') {
+        validateLicenses(key, data[key])
+      }
+      // get rid of the ugly dashes from the actions conventions
+      if (key.includes('-')) {
+        data[key.replace(/-/g, '_')] = data[key]
+        delete data[key]
+      }
+    }
+    return data
+  } catch (error) {
+    throw error
+  }
+}
+
+async function getRemoteConfig(configOpts: {
+  [key: string]: string
+}): Promise<string> {
+  try {
+    const {data} = await octokitClient(
+      'external-repo-token',
+      false
+    ).rest.repos.getContent({
+      mediaType: {
+        format: 'raw'
+      },
+      owner: configOpts.owner,
+      repo: configOpts.repo,
+      path: configOpts.path,
+      ref: configOpts.ref
+    })
+
+    // When using mediaType.format = 'raw', the response.data is a string
+    // but this is not reflected in the return type of getContent, so we're
+    // casting the return value to a string.
+    return z.string().parse(data as unknown)
+  } catch (error) {
+    core.debug(error as string)
+    throw new Error('Error fetching remote config file')
   }
 }

src/filter.ts

@@ -1,5 +1,4 @@
-import {Changes} from './schemas'
-import {Severity, SEVERITIES} from './schemas'
+import {Changes, Severity, SEVERITIES, Scope} from './schemas'
 
 export function filterChangesBySeverity(
   severity: Severity,
@@ -7,7 +6,7 @@ export function filterChangesBySeverity(
 ): Changes {
   const severityIdx = SEVERITIES.indexOf(severity)
   let filteredChanges = []
-  for (let change of changes) {
+  for (const change of changes) {
     if (
       change === undefined ||
       change.vulnerabilities === undefined ||
@@ -16,7 +15,7 @@ export function filterChangesBySeverity(
       continue
     }
 
-    let fChange = {
+    const fChange = {
       ...change,
       vulnerabilities: change.vulnerabilities.filter(vuln => {
         const vulnIdx = SEVERITIES.indexOf(vuln.severity)
@@ -34,3 +33,60 @@ export function filterChangesBySeverity(
   )
   return filteredChanges
 }
+
+export function filterChangesByScopes(
+  scopes: Scope[] | undefined,
+  changes: Changes
+): Changes {
+  if (scopes === undefined) {
+    return []
+  }
+
+  const filteredChanges = changes.filter(change => {
+    // if there is no scope on the change (Enterprise Server API for now), we will assume it is a runtime scope
+    const scope = change.scope || 'runtime'
+    return scopes.includes(scope)
+  })
+
+  return filteredChanges
+}
+
+/**
+ * Filter out changes that are allowed by the allow_ghsas config
+ * option. We want to remove these changes before we do any
+ * processing.
+ * @param ghsas - list of GHSA IDs to allow
+ * @param changes - list of changes to filter
+ * @returns a list of changes with the allowed GHSAs removed
+ */
+export function filterAllowedAdvisories(
+  ghsas: string[] | undefined,
+  changes: Changes
+): Changes {
+  if (ghsas === undefined) {
+    return changes
+  }
+
+  const filteredChanges = changes.filter(change => {
+    const noAdvisories =
+      change.vulnerabilities === undefined ||
+      change.vulnerabilities.length === 0
+
+    if (noAdvisories) {
+      return true
+    }
+
+    let allAllowedAdvisories = true
+    // if there's at least one advisory that is not allowlisted, we will keep the change
+    for (const vulnerability of change.vulnerabilities) {
+      if (!ghsas.includes(vulnerability.advisory_ghsa_id)) {
+        allAllowedAdvisories = false
+      }
+      if (!allAllowedAdvisories) {
+        return true
+      }
+    }
+  })
+
+  return filteredChanges
+}

src/git-refs.ts

@@ -0,0 +1,42 @@
+import {PullRequestSchema, ConfigurationOptions} from './schemas'
+
+export function getRefs(
+  config: ConfigurationOptions,
+  context: {payload: {pull_request?: unknown}; eventName: string}
+): {base: string; head: string} {
+  let base_ref = config.base_ref
+  let head_ref = config.head_ref
+
+  // If possible, source default base & head refs from the GitHub event.
+  // The base/head ref from the config take priority, if provided.
+  if (
+    context.eventName === 'pull_request' ||
+    context.eventName === 'pull_request_target'
+  ) {
+    const pull_request = PullRequestSchema.parse(context.payload.pull_request)
+    base_ref = base_ref || pull_request.base.sha
+    head_ref = head_ref || pull_request.head.sha
+  }
+
+  if (!base_ref && !head_ref) {
+    throw new Error(
+      'Both a base ref and head ref must be provided, either via the `base_ref`/`head_ref` ' +
+        'config options, or by running a `pull_request`/`pull_request_target` workflow.'
+    )
+  } else if (!base_ref) {
+    throw new Error(
+      'A base ref must be provided, either via the `base_ref` config option, ' +
+        'or by running a `pull_request`/`pull_request_target` workflow.'
+    )
+  } else if (!head_ref) {
+    throw new Error(
+      'A head ref must be provided, either via the `head_ref` config option, ' +
+        'or by running a `pull_request`/`pull_request_target` workflow.'
+    )
+  }
+
+  return {
+    base: base_ref,
+    head: head_ref
+  }
+}

src/licenses.ts

@@ -1,4 +1,6 @@
-import {Change, ChangeSchema} from './schemas'
+import spdxSatisfies from 'spdx-satisfies'
+import {Change, Changes} from './schemas'
+import {isSPDXValid, octokitClient} from './utils'
 
 /**
  * Loops through a list of changes, filtering and returning the
@@ -10,37 +12,163 @@ import {Change, ChangeSchema} from './schemas'
  * we will ignore the deny list.
  * @param {Change[]} changes The list of changes to filter.
  * @param { { allow?: string[], deny?: string[]}} licenses An object with `allow`/`deny` keys, each containing a list of licenses.
- * @returns {[Array<Change>, Array<Change]} A tuple where the first element is the list of denied changes and the second one is the list of changes with unknown licenses
+ * @returns {Promise<{Object.<string, Array.<Change>>}} A promise to a Record Object. The keys are strings, unlicensed, unresolved and forbidden. The values are a list of changes
  */
-export function getDeniedLicenseChanges(
-  changes: Array<Change>,
+export async function getInvalidLicenseChanges(
+  changes: Change[],
   licenses: {
-    allow?: Array<string>
-    deny?: Array<string>
+    allow?: string[]
+    deny?: string[]
   }
-): [Array<Change>, Array<Change>] {
-  let {allow, deny} = licenses
+): Promise<Record<string, Changes>> {
+  const {allow, deny} = licenses
 
-  let disallowed: Change[] = []
-  let unknown: Change[] = []
+  const groupedChanges = await groupChanges(changes)
+  const licensedChanges: Changes = groupedChanges.licensed
 
-  for (const change of changes) {
-    let license = change.license
-    // TODO: be loud about unknown licenses
+  const invalidLicenseChanges: Record<string, Changes> = {
+    unlicensed: groupedChanges.unlicensed,
+    unresolved: [],
+    forbidden: []
+  }
+
+  const validityCache = new Map<string, boolean>()
+
+  for (const change of licensedChanges) {
+    const license = change.license
+
+    // should never happen since licensedChanges always have licenses but license is nullable in changes schema
     if (license === null) {
-      unknown.push(change)
       continue
     }
-    if (allow !== undefined) {
-      if (!allow.includes(license)) {
-        disallowed.push(change)
+
+    if (license === 'NOASSERTION') {
+      invalidLicenseChanges.unlicensed.push(change)
+    } else if (validityCache.get(license) === undefined) {
+      try {
+        if (allow !== undefined) {
+          const found = allow.find(spdxExpression =>
+            spdxSatisfies(license, spdxExpression)
+          )
+          validityCache.set(license, found !== undefined)
+        } else if (deny !== undefined) {
+          const found = deny.find(spdxExpression =>
+            spdxSatisfies(license, spdxExpression)
+          )
+          validityCache.set(license, found === undefined)
+        }
+      } catch (err) {
+        invalidLicenseChanges.unresolved.push(change)
       }
-    } else if (deny !== undefined) {
-      if (deny.includes(license)) {
-        disallowed.push(change)
+    }
+
+    if (validityCache.get(license) === false) {
+      invalidLicenseChanges.forbidden.push(change)
+    }
+  }
+
+  return invalidLicenseChanges
+}
+
+const fetchGHLicense = async (
+  owner: string,
+  repo: string
+): Promise<string | null> => {
+  try {
+    const response = await octokitClient().rest.licenses.getForRepo({
+      owner,
+      repo
+    })
+    return response.data.license?.spdx_id ?? null
+  } catch (_) {
+    return null
+  }
+}
+
+const parseGitHubURL = (url: string): {owner: string; repo: string} | null => {
+  try {
+    const parsed = new URL(url)
+    if (parsed.host !== 'github.com') {
+      return null
+    }
+    const components = parsed.pathname.split('/')
+    if (components.length < 3) {
+      return null
+    }
+    return {owner: components[1], repo: components[2]}
+  } catch (_) {
+    return null
+  }
+}
+
+const setGHLicenses = async (changes: Change[]): Promise<Change[]> => {
+  const updatedChanges = changes.map(async change => {
+    if (change.license !== null || change.source_repository_url === null) {
+      return change
+    }
+
+    const githubUrl = parseGitHubURL(change.source_repository_url)
+
+    if (githubUrl === null) {
+      return change
+    }
+
+    return {
+      ...change,
+      license: await fetchGHLicense(githubUrl.owner, githubUrl.repo)
+    }
+  })
+
+  return Promise.all(updatedChanges)
+}
+// Currently Dependency Graph licenses are truncated to 255 characters
+// This possibly makes them invalid spdx ids
+const truncatedDGLicense = (license: string): boolean =>
+  license.length === 255 && !isSPDXValid(license)
+
+async function groupChanges(
+  changes: Changes
+): Promise<Record<string, Changes>> {
+  const result: Record<string, Changes> = {
+    licensed: [],
+    unlicensed: []
+  }
+
+  const ghChanges = []
+
+  for (const change of changes) {
+    if (change.change_type === 'removed') {
+      continue
+    }
+
+    if (change.license === null) {
+      if (change.source_repository_url !== null) {
+        ghChanges.push(change)
+      } else {
+        result.unlicensed.push(change)
+      }
+    } else {
+      if (
+        truncatedDGLicense(change.license) &&
+        change.source_repository_url !== null
+      ) {
+        ghChanges.push(change)
+      } else {
+        result.licensed.push(change)
       }
     }
   }
 
-  return [disallowed, unknown]
+  if (ghChanges.length > 0) {
+    const ghLicenses = await setGHLicenses(ghChanges)
+    for (const change of ghLicenses) {
+      if (change.license === null) {
+        result.unlicensed.push(change)
+      } else {
+        result.licensed.push(change)
+      }
+    }
+  }
+
+  return result
 }

src/main.ts

@@ -3,73 +3,72 @@ import * as dependencyGraph from './dependency-graph'
 import * as github from '@actions/github'
 import styles from 'ansi-styles'
 import {RequestError} from '@octokit/request-error'
-import {Change, PullRequestSchema, Severity} from './schemas'
+import {Change, Severity, Changes} from './schemas'
 import {readConfig} from '../src/config'
-import {filterChangesBySeverity} from '../src/filter'
-import {getDeniedLicenseChanges} from './licenses'
+import {
+  filterChangesBySeverity,
+  filterChangesByScopes,
+  filterAllowedAdvisories
+} from '../src/filter'
+import {getInvalidLicenseChanges} from './licenses'
+import * as summary from './summary'
+import {getRefs} from './git-refs'
+
+import {groupDependenciesByManifest} from './utils'
 
 async function run(): Promise<void> {
   try {
-    if (github.context.eventName !== 'pull_request') {
-      throw new Error(
-        `This run was triggered by the "${github.context.eventName}" event, which is unsupported. Please ensure you are using the "pull_request" event for this workflow.`
-      )
-    }
-
-    const pull_request = PullRequestSchema.parse(
-      github.context.payload.pull_request
-    )
+    const config = await readConfig()
+    const refs = getRefs(config, github.context)
 
     const changes = await dependencyGraph.compare({
       owner: github.context.repo.owner,
       repo: github.context.repo.repo,
-      baseRef: pull_request.base.sha,
-      headRef: pull_request.head.sha
+      baseRef: refs.base,
+      headRef: refs.head
     })
 
-    let config = readConfig()
-    let minSeverity = config.fail_on_severity
-    let failed = false
-
-    let licenses = {
-      allow: config.allow_licenses,
-      deny: config.deny_licenses
-    }
-
-    let filteredChanges = filterChangesBySeverity(
-      minSeverity as Severity,
-      changes
+    const minSeverity = config.fail_on_severity
+    const scopedChanges = filterChangesByScopes(config.fail_on_scopes, changes)
+    const filteredChanges = filterAllowedAdvisories(
+      config.allow_ghsas,
+      scopedChanges
     )
 
-    for (const change of filteredChanges) {
-      if (
+    const addedChanges = filterChangesBySeverity(
+      minSeverity,
+      filteredChanges
+    ).filter(
+      change =>
         change.change_type === 'added' &&
         change.vulnerabilities !== undefined &&
         change.vulnerabilities.length > 0
-      ) {
-        printChangeVulnerabilities(change)
-        failed = true
-      }
-    }
-
-    let [licenseErrors, unknownLicenses] = getDeniedLicenseChanges(
-      changes,
-      licenses
     )
 
-    if (licenseErrors.length > 0) {
-      printLicensesError(licenseErrors, licenses)
-      printNullLicenses(unknownLicenses)
-      core.setFailed('Dependency review detected incompatible licenses.')
+    const invalidLicenseChanges = await getInvalidLicenseChanges(
+      filteredChanges,
+      {
+        allow: config.allow_licenses,
+        deny: config.deny_licenses
+      }
+    )
+
+    summary.addSummaryToSummary(
+      config.vulnerability_check ? addedChanges : null,
+      config.license_check ? invalidLicenseChanges : null
+    )
+
+    if (config.vulnerability_check) {
+      summary.addChangeVulnerabilitiesToSummary(addedChanges, minSeverity)
+      printVulnerabilitiesBlock(addedChanges, minSeverity)
+    }
+    if (config.license_check) {
+      summary.addLicensesToSummary(invalidLicenseChanges, config)
+      printLicensesBlock(invalidLicenseChanges)
     }
 
-    if (failed) {
-      core.setFailed('Dependency review detected vulnerable packages.')
-    } else {
-      core.info(
-        `Dependency review did not detect any vulnerable packages with severity level "${minSeverity}" or higher.`
-      )
-    }
+    summary.addScannedDependencies(changes)
+    printScannedDependencies(changes)
   } catch (error) {
     if (error instanceof RequestError && error.status === 404) {
       core.setFailed(
@@ -86,10 +85,35 @@ async function run(): Promise<void> {
         core.setFailed('Unexpected fatal error')
       }
     }
+  } finally {
+    await core.summary.write()
   }
 }
 
-function printChangeVulnerabilities(change: Change) {
+function printVulnerabilitiesBlock(
+  addedChanges: Changes,
+  minSeverity: Severity
+): void {
+  let failed = false
+  core.group('Vulnerabilities', async () => {
+    if (addedChanges.length > 0) {
+      for (const change of addedChanges) {
+        printChangeVulnerabilities(change)
+      }
+      failed = true
+    }
+
+    if (failed) {
+      core.setFailed('Dependency review detected vulnerable packages.')
+    } else {
+      core.info(
+        `Dependency review did not detect any vulnerable packages with severity level "${minSeverity}" or higher.`
+      )
+    }
+  })
+}
+
+function printChangeVulnerabilities(change: Change): void {
   for (const vuln of change.vulnerabilities) {
     core.info(
       `${styles.bold.open}${change.manifest} » ${change.name}@${
@@ -102,6 +126,49 @@ function printChangeVulnerabilities(change: Change) {
   }
 }
 
+function printLicensesBlock(
+  invalidLicenseChanges: Record<string, Changes>
+): void {
+  core.group('Licenses', async () => {
+    if (invalidLicenseChanges.forbidden.length > 0) {
+      core.info('\nThe following dependencies have incompatible licenses:')
+      printLicensesError(invalidLicenseChanges.forbidden)
+      core.setFailed('Dependency review detected incompatible licenses.')
+    }
+    if (invalidLicenseChanges.unresolved.length > 0) {
+      core.warning(
+        '\nThe validity of the licenses of the dependencies below could not be determined. Ensure that they are valid SPDX licenses:'
+      )
+      printLicensesError(invalidLicenseChanges.unresolved)
+      core.setFailed(
+        'Dependency review could not detect the validity of all licenses.'
+      )
+    }
+    printNullLicenses(invalidLicenseChanges.unlicensed)
+  })
+}
+
+function printLicensesError(changes: Changes): void {
+  for (const change of changes) {
+    core.info(
+      `${styles.bold.open}${change.manifest} » ${change.name}@${change.version}${styles.bold.close} – License: ${styles.color.red.open}${change.license}${styles.color.red.close}`
+    )
+  }
+}
+
+function printNullLicenses(changes: Changes): void {
+  if (changes.length === 0) {
+    return
+  }
+
+  core.info('\nWe could not detect a license for the following dependencies:')
+  for (const change of changes) {
+    core.info(
+      `${styles.bold.open}${change.manifest} » ${change.name}@${change.version}${styles.bold.close}`
+    )
+  }
+}
+
 function renderSeverity(
   severity: 'critical' | 'high' | 'moderate' | 'low'
 ): string {
@@ -116,34 +183,42 @@ function renderSeverity(
   return `${styles.color[color].open}(${severity} severity)${styles.color[color].close}`
 }
 
-function printLicensesError(
-  changes: Array<Change>,
-  licenses: {
-    allow?: Array<string>
-    deny?: Array<string>
-  }
-): void {
-  if (changes.length == 0) {
-    return
+function renderScannedDependency(change: Change): string {
+  const changeType: string = change.change_type
+
+  if (changeType !== 'added' && changeType !== 'removed') {
+    throw new Error(`Unexpected change type: ${changeType}`)
   }
 
-  let {allow = [], deny = []} = licenses
+  const color = (
+    {
+      added: 'green',
+      removed: 'red'
+    } as const
+  )[changeType]
 
-  core.info('\nThe following dependencies have incompatible licenses:\n')
-  for (const change of changes) {
-    core.info(
-      `${styles.bold.open}${change.manifest} » ${change.name}@${change.version}${styles.bold.close} – License: ${styles.color.red.open}${change.license}${styles.color.red.close}`
-    )
-  }
+  const icon = (
+    {
+      added: '+',
+      removed: '-'
+    } as const
+  )[changeType]
+
+  return `${styles.color[color].open}${icon} ${change.name}@${change.version}${styles.color[color].close}`
 }
 
-function printNullLicenses(changes: Array<Change>): void {
-  core.info('\nWe could not detect a license for the following dependencies:\n')
-  for (const change of changes) {
-    core.info(
-      `${styles.bold.open}${change.manifest} » ${change.name}@${change.version}${styles.bold.close}`
-    )
-  }
+function printScannedDependencies(changes: Changes): void {
+  core.group('Dependency Changes', async () => {
+    const dependencies = groupDependenciesByManifest(changes)
+
+    for (const manifestName of dependencies.keys()) {
+      const manifestChanges = dependencies.get(manifestName) || []
+      core.info(`File: ${styles.bold.open}${manifestName}${styles.bold.close}`)
+      for (const change of manifestChanges) {
+        core.info(`${renderScannedDependency(change)}`)
+      }
+    }
+  })
 }
 
 run()

src/schemas.ts

@@ -1,6 +1,9 @@
 import * as z from 'zod'
 
 export const SEVERITIES = ['critical', 'high', 'moderate', 'low'] as const
+export const SCOPES = ['unknown', 'runtime', 'development'] as const
+
+export const SeveritySchema = z.enum(SEVERITIES).default('low')
 
 export const ChangeSchema = z.object({
   change_type: z.enum(['added', 'removed']),
@@ -11,10 +14,11 @@ export const ChangeSchema = z.object({
   package_url: z.string(),
   license: z.string().nullable(),
   source_repository_url: z.string().nullable(),
+  scope: z.enum(SCOPES).optional(),
   vulnerabilities: z
     .array(
       z.object({
-        severity: z.enum(['critical', 'high', 'moderate', 'low']),
+        severity: SeveritySchema,
         advisory_ghsa_id: z.string(),
         advisory_summary: z.string(),
         advisory_url: z.string()
@@ -32,19 +36,45 @@ export const PullRequestSchema = z.object({
 
 export const ConfigurationOptionsSchema = z
   .object({
-    fail_on_severity: z.enum(SEVERITIES).default('low'),
-    allow_licenses: z.array(z.string()).default([]),
-    deny_licenses: z.array(z.string()).default([])
+    fail_on_severity: SeveritySchema,
+    fail_on_scopes: z.array(z.enum(SCOPES)).default(['runtime']),
+    allow_licenses: z.array(z.string()).optional(),
+    deny_licenses: z.array(z.string()).optional(),
+    allow_ghsas: z.array(z.string()).default([]),
+    license_check: z.boolean().default(true),
+    vulnerability_check: z.boolean().default(true),
+    config_file: z.string().optional(),
+    base_ref: z.string().optional(),
+    head_ref: z.string().optional()
+  })
+  .superRefine((config, context) => {
+    if (config.allow_licenses && config.deny_licenses) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: 'You cannot specify both allow-licenses and deny-licenses'
+      })
+    }
+    if (config.allow_licenses && config.allow_licenses.length < 1) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: 'You should provide at least one license in allow-licenses'
+      })
+    }
+    if (
+      config.license_check === false &&
+      config.vulnerability_check === false
+    ) {
+      context.addIssue({
+        code: z.ZodIssueCode.custom,
+        message: "Can't disable both license-check and vulnerability-check"
+      })
+    }
   })
-  .partial()
-  .refine(
-    obj => !(obj.allow_licenses && obj.deny_licenses),
-    "Your workflow file has both an allow_licenses list and deny_licenses list, but you can only set one or the other."
-  )
 
 export const ChangesSchema = z.array(ChangeSchema)
 
 export type Change = z.infer<typeof ChangeSchema>
 export type Changes = z.infer<typeof ChangesSchema>
 export type ConfigurationOptions = z.infer<typeof ConfigurationOptionsSchema>
-export type Severity = typeof SEVERITIES[number]
+export type Severity = z.infer<typeof SeveritySchema>
+export type Scope = typeof SCOPES[number]

src/summary.ts

@@ -0,0 +1,176 @@
+import * as core from '@actions/core'
+import {ConfigurationOptions, Changes} from './schemas'
+import {SummaryTableRow} from '@actions/core/lib/summary'
+import {groupDependenciesByManifest, getManifestsSet, renderUrl} from './utils'
+
+export function addSummaryToSummary(
+  addedPackages: Changes | null,
+  invalidLicenseChanges: Record<string, Changes> | null
+): void {
+  core.summary
+    .addHeading('Dependency Review')
+    .addRaw('We found:')
+    .addList([
+      ...(addedPackages
+        ? [`${addedPackages.length} vulnerable package(s)`]
+        : []),
+      ...(invalidLicenseChanges
+        ? [
+            `${invalidLicenseChanges.unresolved.length} package(s) with invalid SPDX license definitions`,
+            `${invalidLicenseChanges.forbidden.length} package(s) with incompatible licenses`,
+            `${invalidLicenseChanges.unlicensed.length} package(s) with unknown licenses.`
+          ]
+        : [])
+    ])
+}
+
+export function addChangeVulnerabilitiesToSummary(
+  addedPackages: Changes,
+  severity: string
+): void {
+  const rows: SummaryTableRow[] = []
+
+  const manifests = getManifestsSet(addedPackages)
+
+  core.summary
+    .addHeading('Vulnerabilities')
+    .addQuote(
+      `Vulnerabilites were filtered by mininum severity <strong>${severity}</strong>.`
+    )
+
+  if (addedPackages.length === 0) {
+    core.summary.addQuote('No vulnerabilities found in added packages.')
+    return
+  }
+
+  for (const manifest of manifests) {
+    for (const change of addedPackages.filter(
+      pkg => pkg.manifest === manifest
+    )) {
+      let previous_package = ''
+      let previous_version = ''
+      for (const vuln of change.vulnerabilities) {
+        const sameAsPrevious =
+          previous_package === change.name &&
+          previous_version === change.version
+
+        if (!sameAsPrevious) {
+          rows.push([
+            renderUrl(change.source_repository_url, change.name),
+            change.version,
+            renderUrl(vuln.advisory_url, vuln.advisory_summary),
+            vuln.severity
+          ])
+        } else {
+          rows.push([
+            {data: '', colspan: '2'},
+            renderUrl(vuln.advisory_url, vuln.advisory_summary),
+            vuln.severity
+          ])
+        }
+        previous_package = change.name
+        previous_version = change.version
+      }
+    }
+    core.summary.addHeading(`<em>${manifest}</em>`, 3).addTable([
+      [
+        {data: 'Name', header: true},
+        {data: 'Version', header: true},
+        {data: 'Vulnerability', header: true},
+        {data: 'Severity', header: true}
+      ],
+      ...rows
+    ])
+  }
+}
+
+export function addLicensesToSummary(
+  invalidLicenseChanges: Record<string, Changes>,
+  config: ConfigurationOptions
+): void {
+  core.summary.addHeading('Licenses')
+
+  if (config.allow_licenses && config.allow_licenses.length > 0) {
+    core.summary.addQuote(
+      `<strong>Allowed Licenses</strong>: ${config.allow_licenses.join(', ')}`
+    )
+  }
+  if (config.deny_licenses && config.deny_licenses.length > 0) {
+    core.summary.addQuote(
+      `<strong>Denied Licenses</strong>: ${config.deny_licenses.join(', ')}`
+    )
+  }
+
+  if (Object.values(invalidLicenseChanges).every(item => item.length === 0)) {
+    core.summary.addQuote('No license violations detected.')
+    return
+  }
+
+  core.debug(
+    `found ${invalidLicenseChanges.unlicensed.length} unknown licenses`
+  )
+
+  core.debug(
+    `${invalidLicenseChanges.unresolved.length} licenses could not be validated`
+  )
+
+  printLicenseViolation(
+    'Incompatible Licenses',
+    invalidLicenseChanges.forbidden
+  )
+  printLicenseViolation('Unknown Licenses', invalidLicenseChanges.unlicensed)
+  printLicenseViolation(
+    'Invalid SPDX License Definitions',
+    invalidLicenseChanges.unresolved
+  )
+}
+function printLicenseViolation(heading: string, changes: Changes): void {
+  core.summary.addHeading(heading, 5).addSeparator()
+
+  if (changes.length > 0) {
+    const rows: SummaryTableRow[] = []
+    const manifests = getManifestsSet(changes)
+
+    for (const manifest of manifests) {
+      core.summary.addHeading(`<em>${manifest}</em>`, 4)
+
+      for (const change of changes.filter(pkg => pkg.manifest === manifest)) {
+        rows.push([
+          renderUrl(change.source_repository_url, change.name),
+          change.version,
+          formatLicense(change.license)
+        ])
+      }
+
+      core.summary.addTable([['Package', 'Version', 'License'], ...rows])
+    }
+  } else {
+    core.summary.addQuote(`No ${heading.toLowerCase()} detected.`)
+  }
+}
+
+function formatLicense(license: string | null): string {
+  if (license === null || license === 'NOASSERTION') {
+    return 'Null'
+  }
+  return license
+}
+
+export function addScannedDependencies(changes: Changes): void {
+  const dependencies = groupDependenciesByManifest(changes)
+  const manifests = dependencies.keys()
+
+  const summary = core.summary
+    .addHeading('Scanned Dependencies')
+    .addHeading(`We scanned ${dependencies.size} manifest files:`, 5)
+
+  for (const manifest of manifests) {
+    const deps = dependencies.get(manifest)
+    if (deps) {
+      const dependencyNames = deps.map(
+        dependency => `<li>${dependency.name}@${dependency.version}</li>`
+      )
+      summary.addDetails(manifest, `<ul>${dependencyNames.join('')}</ul>`)
+    }
+  }
+}

src/utils.ts

@@ -0,0 +1,55 @@
+import * as core from '@actions/core'
+import {Octokit} from 'octokit'
+import spdxParse from 'spdx-expression-parse'
+import {Changes} from './schemas'
+
+export function groupDependenciesByManifest(
+  changes: Changes
+): Map<string, Changes> {
+  const dependencies: Map<string, Changes> = new Map()
+  for (const change of changes) {
+    const manifestName = change.manifest
+
+    if (dependencies.get(manifestName) === undefined) {
+      dependencies.set(manifestName, [])
+    }
+
+    dependencies.get(manifestName)?.push(change)
+  }
+
+  return dependencies
+}
+
+export function getManifestsSet(changes: Changes): Set<string> {
+  return new Set(changes.flatMap(c => c.manifest))
+}
+
+export function renderUrl(url: string | null, text: string): string {
+  if (url) {
+    return `<a href="${url}">${text}</a>`
+  } else {
+    return text
+  }
+}
+
+export function isSPDXValid(license: string): boolean {
+  try {
+    spdxParse(license)
+    return true
+  } catch (_) {
+    return false
+  }
+}
+
+export function octokitClient(token = 'repo-token', required = true): Octokit {
+  const opts: Record<string, unknown> = {}
+
+  // auth is only added if token is present. For remote config files in public
+  // repos the token is optional, so it could be undefined.
+  const auth = core.getInput(token, {required})
+  if (auth !== undefined) {
+    opts['auth'] = auth
+  }
+
+  return new Octokit(opts)
+}