Compare commits

..
Author SHA1 Message Date
Federico Builes 20f8e76960 Merge branch 'main' into add-summary
# Conflicts:
#	README.md
#	dist/index.js
#	dist/index.js.map
#	src/main.ts
2022-08-18 15:48:03 +02:00
27 changed files with 3381 additions and 28150 deletions
-9
View File
@@ -1,9 +0,0 @@
{
"name": "Dependency Review Action",
"image": "mcr.microsoft.com/devcontainers/typescript-node:18",
"postCreateCommand": "npm install",
"remoteUser": "node",
"features": {
"ghcr.io/devcontainers/features/ruby:1": {}
}
}
+2 -2
View File
@@ -23,10 +23,10 @@ jobs:
steps: steps:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- name: Set Node.js 18.x - name: Set Node.js 16.x
uses: actions/setup-node@v3 uses: actions/setup-node@v3
with: with:
node-version: 18.x node-version: 16.x
- name: Install dependencies - name: Install dependencies
run: npm ci run: npm ci
+2 -2
View File
@@ -17,7 +17,7 @@ jobs:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
node-version: 18 node-version: 16
cache: npm cache: npm
- name: Install dependencies - name: Install dependencies
run: npm ci --ignore-scripts run: npm ci --ignore-scripts
@@ -30,7 +30,7 @@ jobs:
- uses: actions/checkout@v3 - uses: actions/checkout@v3
- uses: actions/setup-node@v3 - uses: actions/setup-node@v3
with: with:
node-version: 18 node-version: 16
cache: npm cache: npm
- name: Install dependencies - name: Install dependencies
run: npm ci --ignore-scripts run: npm ci --ignore-scripts
-1
View File
@@ -1,5 +1,4 @@
event.json event.json
.ruby-version
# Dependency directory # Dependency directory
node_modules node_modules
+17 -27
View File
@@ -1,5 +1,4 @@
# Contributing # Contributing
[fork]: https://github.com/actions/dependency-review-action/fork [fork]: https://github.com/actions/dependency-review-action/fork
[pr]: https://github.com/actions/dependency-review-action/compare [pr]: https://github.com/actions/dependency-review-action/compare
[code-of-conduct]: CODE_OF_CONDUCT.md [code-of-conduct]: CODE_OF_CONDUCT.md
@@ -10,6 +9,7 @@ Contributions to this project are
[released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) [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). to the public under the [project's open source license](LICENSE).
Please note that this project is released with a [Contributor Code of Please note that this project is released with a [Contributor Code of
Conduct][code-of-conduct]. By participating in this project you agree Conduct][code-of-conduct]. By participating in this project you agree
to abide by its terms. to abide by its terms.
@@ -20,6 +20,7 @@ This Action makes an authenticated query to the Dependency Graph Diff
API endpoint (`GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}`) API endpoint (`GET /repos/{owner}/{repo}/dependency-graph/compare/{basehead}`)
to find out the set of added and removed dependencies for each manifest. to find out the set of added and removed dependencies for each manifest.
### Bootstrapping the project ### Bootstrapping the project
``` ```
@@ -34,11 +35,10 @@ npm install
npm run test 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 ## 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 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): 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,24 +56,16 @@ Like this:
$ GITHUB_TOKEN=my-secret-token ./scripts/scan_pr https://github.com/actions/dependency-review-action/pull/3 $ 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 ## Submitting a pull request
0. [Fork][fork] and clone the repository 0. [Fork][fork] and clone the repository
1. Configure and install the dependencies: `npm install` 0. Configure and install the dependencies: `npm install`
2. Make sure the tests pass on your machine: `npm run test` 0. Make sure the tests pass on your machine: `npm run test`
3. Create a new branch: `git checkout -b my-branch-name` 0. Create a new branch: `git checkout -b my-branch-name`
4. Make your change, add tests, and make sure the tests still pass 0. 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` 0. 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] 0. 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. 0. 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: Here are a few things you can do that will increase the likelihood of your pull request being accepted:
@@ -83,23 +75,22 @@ Here are a few things you can do that will increase the likelihood of your pull
## Cutting a new release ## 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 1. Go to [Draft a new
release](https://github.com/actions/dependency-review-action/releases/new) release](https://github.com/actions/dependency-review-action/releases/new)
in the Releases page. in the Releases page.
1. Make sure that the `Publish this Action to the GitHub Marketplace` 2. Make sure that the `Publish this Action to the GitHub Marketplace`
checkbox is enabled 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"> <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 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`). 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"). 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"> <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 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. include a small description of the biggest changes in the new version.
6. Click "Publish Release". 6. Click "Publish Release".
You now have a tag and release using the semver version you used You now have a tag and release using the semver version you used
@@ -109,8 +100,7 @@ major version number (e.g. `v1`) in their workflows while
automatically getting all the automatically getting all the
minor/patch updates. minor/patch updates.
To do this just checkout `main`, force-create a new annotated tag, and push it: To do this just force-create a new annotated tag and push it:
``` ```
git tag -fa v2 -m "Updating v2 to 2.3.4" git tag -fa v2 -m "Updating v2 to 2.3.4"
git push origin v2 --force git push origin v2 --force
+73 -56
View File
@@ -5,11 +5,11 @@ raise an error if any vulnerabilities or invalid licenses are being introduced.
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: 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"> <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: or on the job summary
<img src="https://user-images.githubusercontent.com/7847935/182871416-50332bbb-b279-4621-a136-ca72a4314301.png"> <img src="https://user-images.githubusercontent.com/7847935/182871416-50332bbb-b279-4621-a136-ca72a4314301.png">
@@ -33,12 +33,12 @@ jobs:
- name: 'Checkout Repository' - name: 'Checkout Repository'
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: 'Dependency Review' - name: 'Dependency Review'
uses: actions/dependency-review-action@v3 uses: actions/dependency-review-action@v2
``` ```
### GitHub Enterprise Server ### GitHub Enterprise Server
This action is available in Enterprise Server starting with version 3.6. Make sure This action is available in GHES starting with version 3.6. Make sure
[GitHub Advanced [GitHub Advanced
Security](https://docs.github.com/en/[email protected]/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise) Security](https://docs.github.com/en/[email protected]/admin/code-security/managing-github-advanced-security-for-your-enterprise/enabling-github-advanced-security-for-your-enterprise)
and [GitHub and [GitHub
@@ -50,6 +50,7 @@ with the label of any of your runners (the default label
is `self-hosted`): is `self-hosted`):
```yaml ```yaml
# ... # ...
jobs: jobs:
@@ -59,34 +60,14 @@ jobs:
- name: 'Checkout Repository' - name: 'Checkout Repository'
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: 'Dependency Review' - name: 'Dependency Review'
uses: actions/dependency-review-action@v3 uses: actions/dependency-review-action@v2
``` ```
## Configuration options ## Configuration
Configure this action by either inlining these options in your workflow file, or by using an external configuration file. All configuration options are optional. You can pass additional options to the Dependency Review
Action using your workflow file. Here's an example workflow with
| Option | Usage | Possible values | Default value | all the possible configurations:
|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------|---------------|
| `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 ```yaml
name: 'Dependency Review' name: 'Dependency Review'
@@ -100,49 +81,82 @@ jobs:
- name: 'Checkout Repository' - name: 'Checkout Repository'
uses: actions/checkout@v3 uses: actions/checkout@v3
- name: Dependency Review - name: Dependency Review
uses: actions/dependency-review-action@v3 uses: actions/dependency-review-action@v2
with: with:
fail-on-severity: moderate # Possible values: "critical", "high", "moderate", "low"
# fail-on-severity: critical
# Use comma-separated names to pass list arguments: #
deny-licenses: LGPL-2.0, BSD-2-Clause # Possible values: Any available git ref
# base-ref: ${{ github.event.pull_request.base.ref }}
# head-ref: ${{ github.event.pull_request.head.ref }}
#
# You can only include one of these two options: `allow-licenses` and `deny-licenses`. These options are not supported on GHES.
#
# 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
``` ```
### Configuration File When the workflow with this action is caused by a `pull_request` or `pull_request_target` event,
the `base-ref` and `head-ref` values have the defaults as shown above. If the workflow is caused by
any other event, the `base-ref` and `head-ref` options must be
explicitly set in the configuration file.
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. ### Vulnerability Severity
| Option | Usage | Possible values | 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
| `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` | 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
| `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. | action defaults to `low`.
#### Example This example will only fail on pull requests with `critical` and `high` vulnerabilities:
Start by specifying that you will be using an external configuration file:
```yaml ```yaml
- name: Dependency Review - name: Dependency Review
uses: actions/dependency-review-action@v2 uses: actions/dependency-review-action@v2
with: with:
config-file: './.github/dependency-review-config.yml' fail-on-severity: high
``` ```
And then create the file in the path you just specified: ### 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. These options are not supported on GHES.
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:
```yaml ```yaml
fail-on-severity: 'critical' # only allow MIT-licensed dependents
allow-licenses: - name: Dependency Review
- 'GPL-3.0' uses: actions/dependency-review-action@v2
- 'BSD-3-Clause' with:
- 'MIT' allow-licenses: MIT
``` ```
### Considerations ```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
```
- Checking for licenses is not supported on Enterprise Server. **Important**
- 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**. - 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**.
## Blocking pull requests ## Blocking pull requests
@@ -150,11 +164,14 @@ The Dependency Review GitHub Action check will only block a pull request from be
## Getting help ## 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 ## 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 ## License
+13 -182
View File
@@ -1,7 +1,6 @@
import {expect, test, beforeEach} from '@jest/globals' import {expect, test, beforeEach} from '@jest/globals'
import {readConfig} from '../src/config' import {readConfig} from '../src/config'
import {getRefs} from '../src/git-refs' import {getRefs} from '../src/git-refs'
import * as Utils from '../src/utils'
// GitHub Action inputs come in the form of environment variables // GitHub Action inputs come in the form of environment variables
// with an INPUT prefix (e.g. INPUT_FAIL-ON-SEVERITY) // with an INPUT prefix (e.g. INPUT_FAIL-ON-SEVERITY)
@@ -14,13 +13,8 @@ function setInput(input: string, value: string) {
function clearInputs() { function clearInputs() {
const allowedOptions = [ const allowedOptions = [
'FAIL-ON-SEVERITY', 'FAIL-ON-SEVERITY',
'FAIL-ON-SCOPES',
'ALLOW-LICENSES', 'ALLOW-LICENSES',
'DENY-LICENSES', 'DENY-LICENSES',
'ALLOW-GHSAS',
'LICENSE-CHECK',
'VULNERABILITY-CHECK',
'CONFIG-FILE',
'BASE-REF', 'BASE-REF',
'HEAD-REF' 'HEAD-REF'
] ]
@@ -30,62 +24,48 @@ function clearInputs() {
}) })
} }
beforeAll(() => {
jest.spyOn(Utils, 'isSPDXValid').mockReturnValue(true)
})
beforeEach(() => { beforeEach(() => {
clearInputs() clearInputs()
}) })
test('it defaults to low severity', async () => { test('it defaults to low severity', async () => {
const config = await readConfig() const options = readConfig()
expect(config.fail_on_severity).toEqual('low') expect(options.fail_on_severity).toEqual('low')
}) })
test('it reads custom configs', async () => { test('it reads custom configs', async () => {
setInput('fail-on-severity', 'critical') setInput('fail-on-severity', 'critical')
setInput('allow-licenses', ' BSD, GPL 2') setInput('allow-licenses', ' BSD, GPL 2')
const config = await readConfig() const options = readConfig()
expect(config.fail_on_severity).toEqual('critical') expect(options.fail_on_severity).toEqual('critical')
expect(config.allow_licenses).toEqual(['BSD', 'GPL 2']) expect(options.allow_licenses).toEqual(['BSD', 'GPL 2'])
}) })
test('it defaults to empty allow/deny lists ', async () => { test('it defaults to empty allow/deny lists ', async () => {
const config = await readConfig() const options = readConfig()
expect(config.allow_licenses).toEqual(undefined) expect(options.allow_licenses).toEqual(undefined)
expect(config.deny_licenses).toEqual(undefined) expect(options.deny_licenses).toEqual(undefined)
}) })
test('it raises an error if both an allow and denylist are specified', async () => { test('it raises an error if both an allow and denylist are specified', async () => {
setInput('allow-licenses', 'MIT') setInput('allow-licenses', 'MIT')
setInput('deny-licenses', 'BSD') setInput('deny-licenses', 'BSD')
await expect(readConfig()).rejects.toThrow( expect(() => readConfig()).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 () => { test('it raises an error when given an unknown severity', async () => {
setInput('fail-on-severity', 'zombies') 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 () => { test('it uses the given refs when the event is not a pull request', async () => {
setInput('base-ref', 'a-custom-base-ref') setInput('base-ref', 'a-custom-base-ref')
setInput('head-ref', 'a-custom-head-ref') setInput('head-ref', 'a-custom-head-ref')
const refs = getRefs(await readConfig(), { const refs = getRefs(readConfig(), {
payload: {}, payload: {},
eventName: 'workflow_dispatch' eventName: 'workflow_dispatch'
}) })
@@ -94,160 +74,11 @@ test('it uses the given refs when the event is not a pull request', async () =>
}) })
test('it raises an error when no refs are provided and the event is not a pull request', async () => { test('it raises an error when no refs are provided and the event is not a pull request', async () => {
const config = await readConfig() const options = readConfig()
expect(() => expect(() =>
getRefs(config, { getRefs(options, {
payload: {}, payload: {},
eventName: 'workflow_dispatch' eventName: 'workflow_dispatch'
}) })
).toThrow() ).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'
)
})
})
+1 -65
View File
@@ -1,10 +1,6 @@
import {expect, test} from '@jest/globals' import {expect, test} from '@jest/globals'
import {Change, Changes} from '../src/schemas' import {Change, Changes} from '../src/schemas'
import { import {filterChangesBySeverity} from '../src/filter'
filterChangesBySeverity,
filterChangesByScopes,
filterAllowedAdvisories
} from '../src/filter'
let npmChange: Change = { let npmChange: Change = {
manifest: 'package.json', manifest: 'package.json',
@@ -15,7 +11,6 @@ let npmChange: Change = {
package_url: 'pkg:npm/[email protected]', package_url: 'pkg:npm/[email protected]',
license: 'MIT', license: 'MIT',
source_repository_url: 'github.com/some-repo', source_repository_url: 'github.com/some-repo',
scope: 'runtime',
vulnerabilities: [ vulnerabilities: [
{ {
severity: 'critical', severity: 'critical',
@@ -35,7 +30,6 @@ let rubyChange: Change = {
package_url: 'pkg:gem/[email protected]', package_url: 'pkg:gem/[email protected]',
license: 'BSD', license: 'BSD',
source_repository_url: 'github.com/some-repo', source_repository_url: 'github.com/some-repo',
scope: 'development',
vulnerabilities: [ vulnerabilities: [
{ {
severity: 'moderate', severity: 'moderate',
@@ -52,19 +46,6 @@ let rubyChange: Change = {
] ]
} }
let noVulnNpmChange: Change = {
manifest: 'package.json',
change_type: 'added',
ecosystem: 'npm',
name: 'helpful',
version: '1.0.0',
package_url: 'pkg:npm/[email protected]',
license: 'MIT',
source_repository_url: 'github.com/some-repo',
scope: 'runtime',
vulnerabilities: []
}
test('it properly filters changes by severity', async () => { test('it properly filters changes by severity', async () => {
const changes = [npmChange, rubyChange] const changes = [npmChange, rubyChange]
let result = filterChangesBySeverity('high', changes) let result = filterChangesBySeverity('high', changes)
@@ -76,48 +57,3 @@ test('it properly filters changes by severity', async () => {
result = filterChangesBySeverity('critical', changes) result = filterChangesBySeverity('critical', changes)
expect(changes).toEqual([npmChange, rubyChange]) 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])
})
@@ -1,2 +0,0 @@
fail_on_severity: critical
allow_licenses: []
@@ -1,3 +0,0 @@
fail-on-severity: 'so many zombies'
deny-licenses:
- MIT
@@ -1 +0,0 @@
allow_licenses: ['MIT', 'GPL 2']
+26 -118
View File
@@ -1,7 +1,6 @@
import {expect, jest, test} from '@jest/globals' import {expect, test} from '@jest/globals'
import {Change, Changes} from '../src/schemas' import {Change, Changes} from '../src/schemas'
import {getDeniedLicenseChanges} from '../src/licenses'
let getInvalidLicenseChanges: Function
let npmChange: Change = { let npmChange: Change = {
manifest: 'package.json', manifest: 'package.json',
@@ -12,7 +11,6 @@ let npmChange: Change = {
package_url: 'pkg:npm/[email protected]', package_url: 'pkg:npm/[email protected]',
license: 'MIT', license: 'MIT',
source_repository_url: 'github.com/some-repo', source_repository_url: 'github.com/some-repo',
scope: 'runtime',
vulnerabilities: [ vulnerabilities: [
{ {
severity: 'critical', severity: 'critical',
@@ -32,7 +30,6 @@ let rubyChange: Change = {
package_url: 'pkg:gem/[email protected]', package_url: 'pkg:gem/[email protected]',
license: 'BSD', license: 'BSD',
source_repository_url: 'github.com/some-repo', source_repository_url: 'github.com/some-repo',
scope: 'runtime',
vulnerabilities: [ vulnerabilities: [
{ {
severity: 'moderate', severity: 'moderate',
@@ -49,142 +46,53 @@ let rubyChange: Change = {
] ]
} }
jest.mock('@actions/core') test('it fails if a license outside the allow list is found', async () => {
const mockOctokit = {
rest: {
licenses: {
getForRepo: jest
.fn()
.mockReturnValue({data: {license: {spdx_id: 'AGPL'}}})
}
}
}
jest.mock('octokit', () => {
return {
Octokit: class {
constructor() {
return mockOctokit
}
}
}
})
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'))
})
test('it adds license outside the allow list to forbidden changes', async () => {
const changes: Changes = [npmChange, rubyChange] const changes: Changes = [npmChange, rubyChange]
const {forbidden} = await getInvalidLicenseChanges(changes, { const [invalidChanges, _] = getDeniedLicenseChanges(changes, {allow: ['BSD']})
allow: ['BSD'] expect(invalidChanges[0]).toBe(npmChange)
})
expect(forbidden[0]).toBe(npmChange)
expect(forbidden.length).toEqual(1)
}) })
test('it adds license inside the deny list to forbidden changes', async () => { test('it fails if a license inside the deny list is found', async () => {
const changes: Changes = [npmChange, rubyChange] const changes: Changes = [npmChange, rubyChange]
const {forbidden} = await getInvalidLicenseChanges(changes, { const [invalidChanges] = getDeniedLicenseChanges(changes, {deny: ['BSD']})
expect(invalidChanges[0]).toBe(rubyChange)
})
// 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 () => {
const changes: Changes = [npmChange, rubyChange]
let [invalidChanges, _] = getDeniedLicenseChanges(changes, {
allow: [],
deny: ['BSD'] deny: ['BSD']
}) })
expect(forbidden[0]).toBe(rubyChange) expect(invalidChanges.length).toBe(2)
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 () => { test('it does not fail if a license outside the allow list is found in removed changes', async () => {
const changes: Changes = [ const changes: Changes = [
{...npmChange, change_type: 'removed'}, {...npmChange, change_type: 'removed'},
{...rubyChange, change_type: 'removed'} {...rubyChange, change_type: 'removed'}
] ]
const {forbidden} = await getInvalidLicenseChanges(changes, { const [invalidChanges, _] = getDeniedLicenseChanges(changes, {allow: ['BSD']})
allow: ['BSD'] expect(invalidChanges).toStrictEqual([])
})
expect(forbidden).toStrictEqual([])
}) })
test('it does not add license inside the deny list to forbidden changes if it is in removed changes', async () => { test('it does not fail if a license inside the deny list is found in removed changes', async () => {
const changes: Changes = [ const changes: Changes = [
{...npmChange, change_type: 'removed'}, {...npmChange, change_type: 'removed'},
{...rubyChange, change_type: 'removed'} {...rubyChange, change_type: 'removed'}
] ]
const {forbidden} = await getInvalidLicenseChanges(changes, { const [invalidChanges, _] = getDeniedLicenseChanges(changes, {deny: ['BSD']})
deny: ['BSD'] expect(invalidChanges).toStrictEqual([])
})
expect(forbidden).toStrictEqual([])
}) })
test('it adds license outside the allow list to forbidden changes if it is in both added and removed changes', async () => { test('it fails if a license outside the allow list is found in both of added and removed changes', async () => {
const changes: Changes = [ const changes: Changes = [
{...npmChange, change_type: 'removed'}, {...npmChange, change_type: 'removed'},
npmChange, npmChange,
{...rubyChange, change_type: 'removed'} {...rubyChange, change_type: 'removed'}
] ]
const {forbidden} = await getInvalidLicenseChanges(changes, { const [invalidChanges, _] = getDeniedLicenseChanges(changes, {allow: ['BSD']})
allow: ['BSD'] expect(invalidChanges).toStrictEqual([npmChange])
})
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)
})
}) })
-19
View File
@@ -10,37 +10,18 @@ inputs:
description: Don't block PRs below this severity. Possible values are `low`, `moderate`, `high`, `critical`. description: Don't block PRs below this severity. Possible values are `low`, `moderate`, `high`, `critical`.
required: false required: false
default: 'low' 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: 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. 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 required: false
head-ref: 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. 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 required: false
config-file:
description: A path to the configuration file for the action.
required: false
allow-licenses: allow-licenses:
description: Comma-separated list of allowed licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause") description: Comma-separated list of allowed licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause")
required: false required: false
deny-licenses: deny-licenses:
description: Comma-separated list of forbidden licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause") description: Comma-separated list of forbidden licenses (e.g. "MIT, GPL 3.0, BSD 2 Clause")
required: false 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: runs:
using: 'node16' using: 'node16'
main: 'dist/index.js' main: 'dist/index.js'
Generated Vendored
+605 -21786
View File
File diff suppressed because one or more lines are too long
Generated Vendored
+1 -1
View File
File diff suppressed because one or more lines are too long
Generated Vendored
-1174
View File
File diff suppressed because it is too large Load Diff
+2 -2
View File
@@ -1,9 +1,9 @@
module.exports = { module.exports = {
clearMocks: true, clearMocks: true,
moduleFileExtensions: ['js', 'json', 'ts'], moduleFileExtensions: ['js', 'ts'],
testMatch: ['**/*.test.ts'], testMatch: ['**/*.test.ts'],
transform: { transform: {
'^.+\\.ts$': 'ts-jest' '^.+\\.ts$': 'ts-jest'
}, },
verbose: true verbose: true
} }
+2450 -3980
View File
File diff suppressed because it is too large Load Diff
+19 -25
View File
@@ -1,6 +1,6 @@
{ {
"name": "dependency-review-action", "name": "dependency-review-action",
"version": "2.5.1", "version": "2.0.4",
"private": true, "private": true,
"description": "A GitHub Action for Dependency Review", "description": "A GitHub Action for Dependency Review",
"main": "lib/main.js", "main": "lib/main.js",
@@ -25,36 +25,30 @@
"author": "GitHub", "author": "GitHub",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@actions/core": "^1.10.0", "@actions/core": "^1.9.1",
"@actions/github": "^5.1.1", "@actions/github": "^5.0.3",
"@octokit/plugin-retry": "^4.0.3", "@octokit/plugin-retry": "^3.0.9",
"@octokit/request-error": "^3.0.2", "@octokit/request-error": "^3.0.1",
"ansi-styles": "^6.2.1", "ansi-styles": "^6.1.0",
"got": "^12.5.2", "got": "^12.3.1",
"nodemon": "^2.0.20", "nodemon": "^2.0.19",
"octokit": "^2.0.10", "yaml": "^2.1.1",
"spdx-expression-parse": "^3.0.1", "zod": "^3.18.0"
"spdx-satisfies": "^5.0.1",
"yaml": "^2.1.3",
"zod": "^3.19.1"
}, },
"devDependencies": { "devDependencies": {
"@types/jest": "^27.5.2", "@types/node": "^16.11.49",
"@types/node": "^16.18.3", "@typescript-eslint/eslint-plugin": "^5.33.1",
"@typescript-eslint/eslint-plugin": "^5.42.1", "@typescript-eslint/parser": "^5.33.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", "@vercel/ncc": "^0.34.0",
"esbuild-register": "^3.4.1", "esbuild-register": "^3.3.3",
"eslint": "^8.27.0", "eslint": "^8.22.0",
"eslint-plugin-github": "^4.4.1", "eslint-plugin-github": "^4.3.7",
"eslint-plugin-jest": "^27.1.5", "eslint-plugin-jest": "^26.8.3",
"jest": "^27.5.1", "jest": "^27.5.1",
"js-yaml": "^4.1.0", "js-yaml": "^4.1.0",
"nodemon": "^2.0.20", "nodemon": "^2.0.19",
"prettier": "2.7.1", "prettier": "2.7.1",
"ts-jest": "^27.1.4", "ts-jest": "^27.1.4",
"typescript": "^4.8.4" "typescript": "^4.7.4"
} }
} }
+6 -45
View File
@@ -3,52 +3,22 @@ require 'json'
require 'tempfile' require 'tempfile'
require 'open3' require 'open3'
require 'bundler/inline' require 'bundler/inline'
require 'optparse'
gemfile do gemfile do
source 'https://rubygems.org' source 'https://rubygems.org'
gem 'octokit' gem 'octokit'
end end
config_file = nil
github_token = ENV["GITHUB_TOKEN"] github_token = ENV["GITHUB_TOKEN"]
if !github_token || github_token.empty? if !github_token || github_token.empty?
puts "Please set the GITHUB_TOKEN environment variable" puts "Please set the GITHUB_TOKEN environment variable"
exit -1 exit -1
end end
op = OptionParser.new do |opts| arg = /(?<repo_nwo>[\w\-]+\/[\w\-]+)\/pull\/(?<pr_number>\d+)/.match(ARGV[0])
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? if arg.nil?
puts op puts "Usage: script/scan_pr <pr_url>"
exit -1 exit -1
end end
@@ -62,26 +32,17 @@ event_file = Tempfile.new
event_file.write("{ \"pull_request\": #{pr.to_h.to_json}}") event_file.write("{ \"pull_request\": #{pr.to_h.to_json}}")
event_file.close event_file.close
action_inputs = {
"repo-token": github_token,
"config-file": config_file
}
dev_cmd_env = { dev_cmd_env = {
"INPUT_REPO-TOKEN" => github_token,
"GITHUB_REPOSITORY" => repo_nwo, "GITHUB_REPOSITORY" => repo_nwo,
"GITHUB_EVENT_NAME" => "pull_request", "GITHUB_EVENT_NAME" => "pull_request",
"GITHUB_EVENT_PATH" => event_file.path, "GITHUB_EVENT_PATH" => event_file.path
"GITHUB_STEP_SUMMARY" => "/dev/null"
} }
# bash does not like variable names with dashes like the ones Actions dev_cmd = "./node_modules/.bin/nodemon --exec \"node -r esbuild-register\" src/main.ts"
# 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| Open3.popen2e(dev_cmd_env, dev_cmd) do |stdin, out|
while line = out.gets while line = out.gets
puts line.gsub(github_token, "<REDACTED>") puts line
end end
end end
+19 -152
View File
@@ -1,165 +1,32 @@
import * as fs from 'fs'
import path from 'path'
import YAML from 'yaml'
import * as core from '@actions/core' import * as core from '@actions/core'
import * as z from 'zod' import * as z from 'zod'
import {ConfigurationOptions, ConfigurationOptionsSchema} from './schemas' import {ConfigurationOptions, SEVERITIES} 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 { function getOptionalInput(name: string): string | undefined {
const value = core.getInput(name) const value = core.getInput(name)
return value.length > 0 ? value : undefined return value.length > 0 ? value : undefined
} }
function parseList(list: string | undefined): string[] | undefined { export function readConfig(): ConfigurationOptions {
if (list === undefined) { const fail_on_severity = z
return list .enum(SEVERITIES)
} else { .default('low')
return list.split(',').map(x => x.trim()) .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")
} }
}
function validateLicenses( const base_ref = getOptionalInput('base-ref')
key: 'allow-licenses' | 'deny-licenses', const head_ref = getOptionalInput('head-ref')
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 return {
// but this is not reflected in the return type of getContent, so we're fail_on_severity,
// casting the return value to a string. allow_licenses: allow_licenses?.split(',').map(x => x.trim()),
return z.string().parse(data as unknown) deny_licenses: deny_licenses?.split(',').map(x => x.trim()),
} catch (error) { base_ref,
core.debug(error as string) head_ref
throw new Error('Error fetching remote config file')
} }
} }
+1 -58
View File
@@ -1,4 +1,4 @@
import {Changes, Severity, SEVERITIES, Scope} from './schemas' import {Changes, Severity, SEVERITIES} from './schemas'
export function filterChangesBySeverity( export function filterChangesBySeverity(
severity: Severity, severity: Severity,
@@ -33,60 +33,3 @@ export function filterChangesBySeverity(
) )
return filteredChanges 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
}
+18 -143
View File
@@ -1,6 +1,4 @@
import spdxSatisfies from 'spdx-satisfies' import {Change} from './schemas'
import {Change, Changes} from './schemas'
import {isSPDXValid, octokitClient} from './utils'
/** /**
* Loops through a list of changes, filtering and returning the * Loops through a list of changes, filtering and returning the
@@ -12,163 +10,40 @@ import {isSPDXValid, octokitClient} from './utils'
* we will ignore the deny list. * we will ignore the deny list.
* @param {Change[]} changes The list of changes to filter. * @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. * @param { { allow?: string[], deny?: string[]}} licenses An object with `allow`/`deny` keys, each containing a list of 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 * @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
*/ */
export async function getInvalidLicenseChanges( export function getDeniedLicenseChanges(
changes: Change[], changes: Change[],
licenses: { licenses: {
allow?: string[] allow?: string[]
deny?: string[] deny?: string[]
} }
): Promise<Record<string, Changes>> { ): [Change[], Change[]] {
const {allow, deny} = licenses const {allow, deny} = licenses
const groupedChanges = await groupChanges(changes) const disallowed: Change[] = []
const licensedChanges: Changes = groupedChanges.licensed const unknown: Change[] = []
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) {
continue
}
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)
}
}
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) { for (const change of changes) {
if (change.change_type === 'removed') { if (change.change_type === 'removed') {
continue continue
} }
if (change.license === null) { const license = change.license
if (change.source_repository_url !== null) { if (license === null) {
ghChanges.push(change) unknown.push(change)
} else { continue
result.unlicensed.push(change) }
if (allow !== undefined) {
if (!allow.includes(license)) {
disallowed.push(change)
} }
} else { } else if (deny !== undefined) {
if ( if (deny.includes(license)) {
truncatedDGLicense(change.license) && disallowed.push(change)
change.source_repository_url !== null
) {
ghChanges.push(change)
} else {
result.licensed.push(change)
} }
} }
} }
if (ghChanges.length > 0) { return [disallowed, unknown]
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
} }
+60 -135
View File
@@ -3,22 +3,16 @@ import * as dependencyGraph from './dependency-graph'
import * as github from '@actions/github' import * as github from '@actions/github'
import styles from 'ansi-styles' import styles from 'ansi-styles'
import {RequestError} from '@octokit/request-error' import {RequestError} from '@octokit/request-error'
import {Change, Severity, Changes} from './schemas' import {Change, Severity} from './schemas'
import {readConfig} from '../src/config' import {readConfig} from '../src/config'
import { import {filterChangesBySeverity} from '../src/filter'
filterChangesBySeverity, import {getDeniedLicenseChanges} from './licenses'
filterChangesByScopes,
filterAllowedAdvisories
} from '../src/filter'
import {getInvalidLicenseChanges} from './licenses'
import * as summary from './summary' import * as summary from './summary'
import {getRefs} from './git-refs' import {getRefs} from './git-refs'
import {groupDependenciesByManifest} from './utils'
async function run(): Promise<void> { async function run(): Promise<void> {
try { try {
const config = await readConfig() const config = readConfig()
const refs = getRefs(config, github.context) const refs = getRefs(config, github.context)
const changes = await dependencyGraph.compare({ const changes = await dependencyGraph.compare({
@@ -29,15 +23,16 @@ async function run(): Promise<void> {
}) })
const minSeverity = config.fail_on_severity const minSeverity = config.fail_on_severity
const scopedChanges = filterChangesByScopes(config.fail_on_scopes, changes) let failed = false
const filteredChanges = filterAllowedAdvisories(
config.allow_ghsas, const licenses = {
scopedChanges allow: config.allow_licenses,
) deny: config.deny_licenses
}
const addedChanges = filterChangesBySeverity( const addedChanges = filterChangesBySeverity(
minSeverity, minSeverity as Severity,
filteredChanges changes
).filter( ).filter(
change => change =>
change.change_type === 'added' && change.change_type === 'added' &&
@@ -45,30 +40,38 @@ async function run(): Promise<void> {
change.vulnerabilities.length > 0 change.vulnerabilities.length > 0
) )
const invalidLicenseChanges = await getInvalidLicenseChanges( const [licenseErrors, unknownLicenses] = getDeniedLicenseChanges(
filteredChanges, changes,
{ licenses
allow: config.allow_licenses, )
deny: config.deny_licenses
summary.addSummaryToSummary(addedChanges, licenseErrors, unknownLicenses)
if (addedChanges.length > 0) {
for (const change of addedChanges) {
printChangeVulnerabilities(change)
} }
) failed = true
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)
} }
summary.addScannedDependencies(changes) summary.addChangeVulnerabilitiesToSummary(addedChanges, minSeverity || '')
printScannedDependencies(changes)
if (licenseErrors.length > 0) {
printLicensesError(licenseErrors)
core.setFailed('Dependency review detected incompatible licenses.')
}
printNullLicenses(unknownLicenses)
summary.addLicensesToSummary(licenseErrors, unknownLicenses, config)
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.`
)
}
} catch (error) { } catch (error) {
if (error instanceof RequestError && error.status === 404) { if (error instanceof RequestError && error.status === 404) {
core.setFailed( core.setFailed(
@@ -90,29 +93,6 @@ async function run(): Promise<void> {
} }
} }
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 { function printChangeVulnerabilities(change: Change): void {
for (const vuln of change.vulnerabilities) { for (const vuln of change.vulnerabilities) {
core.info( core.info(
@@ -126,49 +106,6 @@ function printChangeVulnerabilities(change: Change): void {
} }
} }
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( function renderSeverity(
severity: 'critical' | 'high' | 'moderate' | 'low' severity: 'critical' | 'high' | 'moderate' | 'low'
): string { ): string {
@@ -183,42 +120,30 @@ function renderSeverity(
return `${styles.color[color].open}(${severity} severity)${styles.color[color].close}` return `${styles.color[color].open}(${severity} severity)${styles.color[color].close}`
} }
function renderScannedDependency(change: Change): string { function printLicensesError(changes: Change[]): void {
const changeType: string = change.change_type if (changes.length === 0) {
return
if (changeType !== 'added' && changeType !== 'removed') {
throw new Error(`Unexpected change type: ${changeType}`)
} }
const color = ( core.info('\nThe following dependencies have incompatible licenses:\n')
{ for (const change of changes) {
added: 'green', core.info(
removed: 'red' `${styles.bold.open}${change.manifest} » ${change.name}@${change.version}${styles.bold.close} License: ${styles.color.red.open}${change.license}${styles.color.red.close}`
} as const )
)[changeType] }
const icon = (
{
added: '+',
removed: '-'
} as const
)[changeType]
return `${styles.color[color].open}${icon} ${change.name}@${change.version}${styles.color[color].close}`
} }
function printScannedDependencies(changes: Changes): void { function printNullLicenses(changes: Change[]): void {
core.group('Dependency Changes', async () => { if (changes.length === 0) {
const dependencies = groupDependenciesByManifest(changes) return
}
for (const manifestName of dependencies.keys()) { core.info('\nWe could not detect a license for the following dependencies:\n')
const manifestChanges = dependencies.get(manifestName) || [] for (const change of changes) {
core.info(`File: ${styles.bold.open}${manifestName}${styles.bold.close}`) core.info(
for (const change of manifestChanges) { `${styles.bold.open}${change.manifest} » ${change.name}@${change.version}${styles.bold.close}`
core.info(`${renderScannedDependency(change)}`) )
} }
}
})
} }
run() run()
+12 -40
View File
@@ -1,9 +1,6 @@
import * as z from 'zod' import * as z from 'zod'
export const SEVERITIES = ['critical', 'high', 'moderate', 'low'] as const 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({ export const ChangeSchema = z.object({
change_type: z.enum(['added', 'removed']), change_type: z.enum(['added', 'removed']),
@@ -14,11 +11,10 @@ export const ChangeSchema = z.object({
package_url: z.string(), package_url: z.string(),
license: z.string().nullable(), license: z.string().nullable(),
source_repository_url: z.string().nullable(), source_repository_url: z.string().nullable(),
scope: z.enum(SCOPES).optional(),
vulnerabilities: z vulnerabilities: z
.array( .array(
z.object({ z.object({
severity: SeveritySchema, severity: z.enum(['critical', 'high', 'moderate', 'low']),
advisory_ghsa_id: z.string(), advisory_ghsa_id: z.string(),
advisory_summary: z.string(), advisory_summary: z.string(),
advisory_url: z.string() advisory_url: z.string()
@@ -36,45 +32,21 @@ export const PullRequestSchema = z.object({
export const ConfigurationOptionsSchema = z export const ConfigurationOptionsSchema = z
.object({ .object({
fail_on_severity: SeveritySchema, fail_on_severity: z.enum(SEVERITIES).default('low'),
fail_on_scopes: z.array(z.enum(SCOPES)).default(['runtime']), allow_licenses: z.array(z.string()).default([]),
allow_licenses: z.array(z.string()).optional(), deny_licenses: z.array(z.string()).default([]),
deny_licenses: z.array(z.string()).optional(), base_ref: z.string(),
allow_ghsas: z.array(z.string()).default([]), head_ref: z.string()
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 const ChangesSchema = z.array(ChangeSchema)
export type Change = z.infer<typeof ChangeSchema> export type Change = z.infer<typeof ChangeSchema>
export type Changes = z.infer<typeof ChangesSchema> export type Changes = z.infer<typeof ChangesSchema>
export type ConfigurationOptions = z.infer<typeof ConfigurationOptionsSchema> export type ConfigurationOptions = z.infer<typeof ConfigurationOptionsSchema>
export type Severity = z.infer<typeof SeveritySchema> export type Severity = typeof SEVERITIES[number]
export type Scope = typeof SCOPES[number]
+54 -67
View File
@@ -1,27 +1,17 @@
import * as core from '@actions/core' import * as core from '@actions/core'
import {ConfigurationOptions, Changes} from './schemas' import {ConfigurationOptions, Change, Changes} from './schemas'
import {SummaryTableRow} from '@actions/core/lib/summary' import {SummaryTableRow} from '@actions/core/lib/summary'
import {groupDependenciesByManifest, getManifestsSet, renderUrl} from './utils'
export function addSummaryToSummary( export function addSummaryToSummary(
addedPackages: Changes | null, addedPackages: Changes,
invalidLicenseChanges: Record<string, Changes> | null licenseErrors: Change[],
unknownLicenses: Change[]
): void { ): void {
core.summary core.summary
.addHeading('Dependency Review') .addHeading('Dependency Review')
.addRaw('We found:') .addRaw(
.addList([ `We found ${addedPackages.length} vulnerable package(s), ${licenseErrors.length} package(s) with incompatible licenses, and ${unknownLicenses.length} package(s) with unknown licenses.`
...(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( export function addChangeVulnerabilitiesToSummary(
@@ -30,7 +20,7 @@ export function addChangeVulnerabilitiesToSummary(
): void { ): void {
const rows: SummaryTableRow[] = [] const rows: SummaryTableRow[] = []
const manifests = getManifestsSet(addedPackages) const manifests = getManifests(addedPackages)
core.summary core.summary
.addHeading('Vulnerabilities') .addHeading('Vulnerabilities')
@@ -85,7 +75,8 @@ export function addChangeVulnerabilitiesToSummary(
} }
export function addLicensesToSummary( export function addLicensesToSummary(
invalidLicenseChanges: Record<string, Changes>, licenseErrors: Change[],
unknownLicenses: Change[],
config: ConfigurationOptions config: ConfigurationOptions
): void { ): void {
core.summary.addHeading('Licenses') core.summary.addHeading('Licenses')
@@ -101,76 +92,72 @@ export function addLicensesToSummary(
) )
} }
if (Object.values(invalidLicenseChanges).every(item => item.length === 0)) { if (licenseErrors.length === 0 && unknownLicenses.length === 0) {
core.summary.addQuote('No license violations detected.') core.summary.addQuote('No license violations detected.')
return return
} }
core.debug( if (licenseErrors.length > 0) {
`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 rows: SummaryTableRow[] = []
const manifests = getManifestsSet(changes) const manifests = getManifests(licenseErrors)
core.summary.addHeading('Incompatible Licenses', 3).addSeparator()
for (const manifest of manifests) { for (const manifest of manifests) {
core.summary.addHeading(`<em>${manifest}</em>`, 4) core.summary.addHeading(`<em>${manifest}</em>`, 4)
for (const change of changes.filter(pkg => pkg.manifest === manifest)) { for (const change of licenseErrors.filter(
pkg => pkg.manifest === manifest
)) {
rows.push([ rows.push([
renderUrl(change.source_repository_url, change.name), renderUrl(change.source_repository_url, change.name),
change.version, change.version,
formatLicense(change.license) change.license || ''
]) ])
} }
core.summary.addTable([['Package', 'Version', 'License'], ...rows]) core.summary.addTable([['Package', 'Version', 'License'], ...rows])
} }
} else { } else {
core.summary.addQuote(`No ${heading.toLowerCase()} detected.`) core.summary.addQuote('No license violations detected.')
} }
}
function formatLicense(license: string | null): string { core.debug(`found ${unknownLicenses.length} unknown licenses`)
if (license === null || license === 'NOASSERTION') {
return 'Null'
}
return license
}
export function addScannedDependencies(changes: Changes): void { if (unknownLicenses.length > 0) {
const dependencies = groupDependenciesByManifest(changes) const rows: SummaryTableRow[] = []
const manifests = dependencies.keys() const manifests = getManifests(unknownLicenses)
const summary = core.summary core.debug(
.addHeading('Scanned Dependencies') `found ${manifests.entries.length} manifests for unknown licenses`
.addHeading(`We scanned ${dependencies.size} manifest files:`, 5) )
for (const manifest of manifests) { core.summary.addHeading('Unknown Licenses', 3).addSeparator()
const deps = dependencies.get(manifest)
if (deps) { for (const manifest of manifests) {
const dependencyNames = deps.map( core.summary.addHeading(`<em>${manifest}</em>`, 4)
dependency => `<li>${dependency.name}@${dependency.version}</li>`
) for (const change of unknownLicenses.filter(
summary.addDetails(manifest, `<ul>${dependencyNames.join('')}</ul>`) pkg => pkg.manifest === manifest
)) {
rows.push([
renderUrl(change.source_repository_url, change.name),
change.version
])
}
core.summary.addTable([['Package', 'Version'], ...rows])
} }
} }
} }
function getManifests(changes: Changes): Set<string> {
return new Set(changes.flatMap(c => c.manifest))
}
function renderUrl(url: string | null, text: string): string {
if (url) {
return `<a href="${url}">${text}</a>`
} else {
return text
}
}
-55
View File
@@ -1,55 +0,0 @@
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)
}