Compare commits

...

26 Commits

Author SHA1 Message Date
mickael e 3027ac711e update jsonata to 2.0.4
addresses CVE-2024-27307
2024-03-21 20:23:44 -04:00
John-Michael Faircloth 77efb36ae3 update got dependency and convert to esm module (#533)
* update require got to import got

* convert remaining to esm

* wip: replace jest with vitest

* fix test imports and vitest config

* remove dist package.json

* fix import in ent test

* add dist

* move actions/core to prod dependency

* remove unused import that was breaking esm compilation

* simplify imports

* use module.createRequire to import jsonata

* add doc link comment

* add comments on import insanity

* add more comments

* update PR tempalte

* bump got and remove jest deps

* revert debug npm run command

* fix fs import

* simplify vitest config for each test suite
2024-03-19 10:42:34 -05:00
John-Michael Faircloth a727ce205a approle: do not require secret_id (#522)
* approle: support bind_secret_id

* add changelog
2024-02-28 11:15:56 -06:00
John-Michael Faircloth d1720f055e fix changelog link (#530) 2024-02-15 11:55:33 -06:00
John-Michael Faircloth 92626383ce Prepare for v3.0.0 release (#529) 2024-02-15 11:53:53 -06:00
John-Michael Faircloth 9c2d817b85 Fix changelog link (#528) 2024-02-15 11:42:04 -06:00
John-Michael Faircloth b477844b5f Prepare for v2.8.1 release (#527) 2024-02-15 11:38:07 -06:00
John-Michael Faircloth 9f522b8598 Update to v2.8.0 (#519) 2024-02-01 08:48:51 -06:00
John-Michael Faircloth efab57ede0 feature: add ignoreNotFound option (#518)
* add ignoreNotFound option

* update README
2024-02-01 08:42:56 -06:00
dependabot[bot] d523bb05b2 chore(deps-dev): bump @vercel/ncc from 0.36.1 to 0.38.1 (#503)
Bumps [@vercel/ncc](https://github.com/vercel/ncc) from 0.36.1 to 0.38.1.
- [Release notes](https://github.com/vercel/ncc/releases)
- [Commits](https://github.com/vercel/ncc/compare/0.36.1...0.38.1)

---
updated-dependencies:
- dependency-name: "@vercel/ncc"
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-31 15:52:19 -06:00
dependabot[bot] 11845b19f6 chore(deps-dev): bump jest from 29.5.0 to 29.7.0 (#490)
Bumps [jest](https://github.com/jestjs/jest/tree/HEAD/packages/jest) from 29.5.0 to 29.7.0.
- [Release notes](https://github.com/jestjs/jest/releases)
- [Changelog](https://github.com/jestjs/jest/blob/main/CHANGELOG.md)
- [Commits](https://github.com/jestjs/jest/commits/v29.7.0/packages/jest)

---
updated-dependencies:
- dependency-name: jest
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-31 15:33:32 -06:00
dependabot[bot] 7a6258bb0b chore(deps-dev): bump jest-when from 3.5.2 to 3.6.0 (#484)
Bumps [jest-when](https://github.com/timkindberg/jest-when) from 3.5.2 to 3.6.0.
- [Release notes](https://github.com/timkindberg/jest-when/releases)
- [Commits](https://github.com/timkindberg/jest-when/compare/v3.5.2...v3.6.0)

---
updated-dependencies:
- dependency-name: jest-when
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-31 15:28:35 -06:00
dependabot[bot] a0b66b1cc3 chore(deps-dev): bump @actions/core from 1.10.0 to 1.10.1 (#489)
Bumps [@actions/core](https://github.com/actions/toolkit/tree/HEAD/packages/core) from 1.10.0 to 1.10.1.
- [Changelog](https://github.com/actions/toolkit/blob/main/packages/core/RELEASES.md)
- [Commits](https://github.com/actions/toolkit/commits/HEAD/packages/core)

---
updated-dependencies:
- dependency-name: "@actions/core"
  dependency-type: direct:development
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-31 15:26:53 -06:00
dependabot[bot] c616aba63e chore(deps): bump jsrsasign from 10.8.6 to 11.0.0 (#513)
Bumps [jsrsasign](https://github.com/kjur/jsrsasign) from 10.8.6 to 11.0.0.
- [Release notes](https://github.com/kjur/jsrsasign/releases)
- [Changelog](https://github.com/kjur/jsrsasign/blob/master/ChangeLog.txt)
- [Commits](https://github.com/kjur/jsrsasign/compare/10.8.6...11.0.0)

---
updated-dependencies:
- dependency-name: jsrsasign
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-01-31 15:26:26 -06:00
John-Michael Faircloth e3d5714d59 Update to v2.7.5 (#517) 2024-01-30 16:42:42 -06:00
Max Winslow 00bce0da9c Add path parameter example (#511)
* x

* Update README.md

Co-authored-by: John-Michael Faircloth <fairclothjm@users.noreply.github.com>

---------

Co-authored-by: John-Michael Faircloth <fairclothjm@users.noreply.github.com>
2024-01-03 14:11:01 -06:00
Jean-François Roche 6853090cd9 Use nodejs 20 (#509)
Node 16 has reached its end of life

More details here: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/
2023-12-22 09:34:55 -05:00
John-Michael Faircloth 45dc5344f1 Update README.md (#510) 2023-12-21 11:14:42 -06:00
Calvin Leung Huang 2fb925f14c action: update marketplace name (#500) 2023-11-03 10:17:35 -07:00
Nicholas Farley caba6efd0e Bump got from 11.8.5 to 11.8.6 (#492)
* Bump got from 11.8.5 to 11.8.6
* Revert changes to dist/index.js
2023-11-01 10:27:02 -04:00
John-Michael Faircloth affa6f04da Update to v2.7.4 (#499) 2023-10-26 09:47:04 -05:00
John-Michael Faircloth 4727f0b168 chore: update readme reference for readability (#497) 2023-10-23 13:46:51 -05:00
Calvin Leung Huang 86c7f837eb Revert "Update action.yml (#495)" (#496)
This reverts commit 375956aa33.
2023-09-26 14:35:18 -07:00
Calvin Leung Huang 375956aa33 Update action.yml (#495)
Updates the Vault Secrets name to Vault in the GH Marketplace
2023-09-26 14:15:43 -07:00
Calvin Leung Huang 1328cd9fa9 Revert "Update Vault Action name in package.json (#493)" (#494)
This reverts commit d4437ee96c.
2023-09-26 14:14:07 -07:00
Calvin Leung Huang d4437ee96c Update Vault Action name in package.json (#493) 2023-09-26 14:12:24 -07:00
45 changed files with 14455 additions and 15996 deletions
+15 -7
View File
@@ -3,21 +3,29 @@ name: Bug report
about: Create a report to help us improve about: Create a report to help us improve
title: "[BUG] " title: "[BUG] "
labels: bug labels: bug
assignees: RichiCoder1
--- ---
**Describe the bug** ## Vault server version
v0.0.0
## vault-action version
v0.0.0
## Describe the bug
A clear and concise description of what the bug is. A clear and concise description of what the bug is.
**To Reproduce** ## To Reproduce
The yaml of the `vault-action` step, with any sensitive information masked or removed. The yaml of the `vault-action` step, with any sensitive information masked or removed.
**Expected behavior** ## Expected behavior
A clear and concise description of what you expected to happen. A clear and concise description of what you expected to happen.
**Log Output** ## Log Output
For the most verbose logs, [add a secret called `ACTIONS_STEP_DEBUG` with the value `true`](https://github.com/actions/toolkit/blob/main/docs/action-debugging.md). Then, re-run the workflow if possible and post the *raw logs* for the step here with any sensitive information masked or removed. For the most verbose logs, add a secret called
[`ACTIONS_STEP_DEBUG`](https://github.com/actions/toolkit/blob/main/docs/action-debugging.md)
with the value `true`. Then, re-run the workflow if possible and post the *raw
logs* for the step here with any sensitive information masked or removed.
**Additional context** ## Additional context
Add any other context about the problem here. Add any other context about the problem here.
+4 -5
View File
@@ -3,18 +3,17 @@ name: Feature request
about: Suggest an idea for this project about: Suggest an idea for this project
title: "[FEAT] " title: "[FEAT] "
labels: enhancement labels: enhancement
assignees: RichiCoder1
--- ---
**Is your feature request related to a problem? Please describe.** ## Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like** ## Describe the solution you'd like
A clear and concise description of what you want to happen. A clear and concise description of what you want to happen.
**Describe alternatives you've considered** ## Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered. A clear and concise description of any alternative solutions or features you've considered.
**Additional context** ## Additional context
Add any other context or screenshots about the feature request here. Add any other context or screenshots about the feature request here.
+20
View File
@@ -0,0 +1,20 @@
### Description
<!--- Description of the change. For example: This PR updates ABC resource so that we can XYZ --->
<!--- If your PR fully resolves and should automatically close the linked issue, use Closes. Otherwise, use Relates --->
Relates OR Closes #0000
### Checklist
- [ ] Added [CHANGELOG](https://github.com/hashicorp/vault-action/blob/master/CHANGELOG.md) entry (only for user-facing changes)
### Community Note
* Please vote on this pull request by adding a 👍
[reaction](https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/)
to the original pull request comment to help the community and maintainers
prioritize this request
* Please do not leave "+1" comments, they generate extra noise for pull request
followers and do not help prioritize the request
+5 -5
View File
@@ -10,7 +10,7 @@ jobs:
- uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
with: with:
node-version: '16.14.0' node-version: '20.9.0'
- name: Setup NPM Cache - name: Setup NPM Cache
uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1 uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1
@@ -40,7 +40,7 @@ jobs:
- uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
with: with:
node-version: '16.14.0' node-version: '20.9.0'
- name: Setup NPM Cache - name: Setup NPM Cache
uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1 uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1
@@ -76,7 +76,7 @@ jobs:
- uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
with: with:
node-version: '16.14.0' node-version: '20.9.0'
- name: Setup NPM Cache - name: Setup NPM Cache
uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1 uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1
@@ -110,7 +110,7 @@ jobs:
- uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
with: with:
node-version: '16.14.0' node-version: '20.9.0'
- name: Setup NPM Cache - name: Setup NPM Cache
uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1 uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1
@@ -207,7 +207,7 @@ jobs:
- uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
with: with:
node-version: '16.14.0' node-version: '20.9.0'
- name: Setup NPM Cache - name: Setup NPM Cache
uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1 uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # v3.3.1
+22 -10
View File
@@ -22,7 +22,7 @@ jobs:
- uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0 - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
with: with:
node-version: '16.14.0' node-version: '20.9.0'
- name: NPM Install - name: NPM Install
run: npm ci run: npm ci
@@ -48,14 +48,26 @@ jobs:
token: testtoken token: testtoken
secrets: | secrets: |
secret/data/test-json-string jsonString; secret/data/test-json-string jsonString;
secret/data/test-json-data jsonData;
- name: Check Secrets - uses: actions/github-script@v7
run: | with:
touch secrets.json github-token: "foobar"
echo "${{ steps.import-secrets.outputs.jsonString }}" >> secrets.json script: |
const { JSONSTRING, JSONDATA } = process.env
- name: Check json file format console.log(`string ${JSONSTRING}`)
run: | console.log(`data ${JSONDATA}`)
echo const str = JSONDATA
cat secrets.json
jq -c . < secrets.json let valid = true
try {
JSON.parse(str)
} catch (e) {
valid = false
}
if (valid) {
console.log("valid json")
} else {
console.log("not valid json")
}
+42 -1
View File
@@ -1,6 +1,47 @@
## Unreleased ## Unreleased
* Add changes here Features:
* `secretId` is no longer required for approle to support advanced use cases like machine login when `bind_secret_id` is false. [GH-522](https://github.com/hashicorp/vault-action/pull/522)
## 3.0.0 (February 15, 2024)
Improvements:
* Bump node runtime from node16 to node20 [GH-529](https://github.com/hashicorp/vault-action/pull/529)
## 2.8.1 (February 15, 2024)
Bugs:
* Revert [GH-509](https://github.com/hashicorp/vault-action/pull/509) which made a backwards incompatible bump of the node runtime from node16 to node20 [GH-527](https://github.com/hashicorp/vault-action/pull/527)
## 2.8.0 (February 1, 2024)
Features:
* Add `ignoreNotFound` input (default: false) to prevent the action from failing when a secret does not exist [GH-518](https://github.com/hashicorp/vault-action/pull/518)
Improvements:
* bump jsrsasign from 10.8.6 to 11.0.0 [GH-513](https://github.com/hashicorp/vault-action/pull/513)
* bump @actions/core from 1.10.0 to 1.10.1 [GH-489](https://github.com/hashicorp/vault-action/pull/489)
* bump jest-when from 3.5.2 to 3.6.0 [GH-484](https://github.com/hashicorp/vault-action/pull/484)
* bump jest from 29.5.0 to 29.7.0 [GH-490](https://github.com/hashicorp/vault-action/pull/490)
* bump @vercel/ncc from 0.36.1 to 0.38.1 [GH-503](https://github.com/hashicorp/vault-action/pull/503)
## 2.7.5 (January 30, 2024)
Improvements:
* Bump node runtime from node16 to node20 [GH-509](https://github.com/hashicorp/vault-action/pull/509)
* Bump got from 11.8.5 to 11.8.6 [GH-492](https://github.com/hashicorp/vault-action/pull/492)
## 2.7.4 (October 26, 2023)
Features:
* Add ability to specify a wildcard for the key name to get all keys in the path [GH-488](https://github.com/hashicorp/vault-action/pull/488)
## 2.7.3 (July 13, 2023) ## 2.7.3 (July 13, 2023)
+191 -28
View File
@@ -8,6 +8,9 @@
A helper action for easily pulling secrets from HashiCorp Vault™. A helper action for easily pulling secrets from HashiCorp Vault™.
Note: The Vault Github Action is a read-only action, and in general
is not meant to modify Vaults state.
<!-- TOC --> <!-- TOC -->
- [Vault GitHub Action](#vault-github-action) - [Vault GitHub Action](#vault-github-action)
@@ -22,6 +25,7 @@ A helper action for easily pulling secrets from HashiCorp Vault™.
- [Userpass](#userpass) - [Userpass](#userpass)
- [Ldap](#ldap) - [Ldap](#ldap)
- [Other Auth Methods](#other-auth-methods) - [Other Auth Methods](#other-auth-methods)
- [Custom Path](#custom-path-name)
- [Key Syntax](#key-syntax) - [Key Syntax](#key-syntax)
- [Simple Key](#simple-key) - [Simple Key](#simple-key)
- [Set Output Variable Name](#set-output-variable-name) - [Set Output Variable Name](#set-output-variable-name)
@@ -297,6 +301,20 @@ with:
If any other method is specified and you provide an `authPayload`, the action will If any other method is specified and you provide an `authPayload`, the action will
attempt to `POST` to `auth/${method}/login` with the provided payload and parse out the client token. attempt to `POST` to `auth/${method}/login` with the provided payload and parse out the client token.
### Custom Path Name
Auth methods at custom path names can be configured using the [`path`](#path) parameter
```yaml
with:
url: https://vault.mycompany.com:8200
caCertificate: ${{ secrets.VAULT_CA_CERT }}
path: my-custom-path
method: userpass
username: ${{ secrets.VAULT_USERNAME }}
password: ${{ secrets.VAULT_PASSWORD }}
```
## Key Syntax ## Key Syntax
The `secrets` parameter is a set of multiple secret requests separated by the `;` character. The `secrets` parameter is a set of multiple secret requests separated by the `;` character.
@@ -464,34 +482,179 @@ steps:
Here are all the inputs available through `with`: Here are all the inputs available through `with`:
| Input | Description | Default | Required | ### `url`
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
| `url` | The URL for the vault endpoint | | ✔ | **Type: `string`**\
| `secrets` | A semicolon-separated list of secrets to retrieve. These will automatically be converted to environmental variable keys. See README for more details | | | **Required**
| `namespace` | The Vault namespace from which to query secrets. Vault Enterprise only, unset by default | | |
| `method` | The method to use to authenticate with Vault. | `token` | | The URL for the Vault endpoint.
| `role` | Vault role for specified auth method | | |
| `path` | Custom vault path, if the auth method was enabled at a different path | | | ### `secrets`
| `token` | The Vault Token to be used to authenticate with Vault | | |
| `roleId` | The Role Id for App Role authentication | | | **Type: `string`**
| `secretId` | The Secret Id for App Role authentication | | |
| `githubToken` | The Github Token to be used to authenticate with Vault | | | A semicolon-separated list of secrets to retrieve. These will automatically be
| `jwtPrivateKey` | Base64 encoded Private key to sign JWT | | | converted to environmental variable keys. See [Key Syntax](#key-syntax) for
| `jwtKeyPassword` | Password for key stored in jwtPrivateKey (if needed) | | | more details.
| `jwtGithubAudience` | Identifies the recipient ("aud" claim) that the JWT is intended for |`sigstore`| |
| `jwtTtl` | Time in seconds, after which token expires | | 3600 | ### `namespace`
| `kubernetesTokenPath` | The path to the service-account secret with the jwt token for kubernetes based authentication |`/var/run/secrets/kubernetes.io/serviceaccount/token` | |
| `username` | The username of the user to log in to Vault as. Available to both Userpass and LDAP auth methods | | | **Type: `string`**
| `password` | The password of the user to log in to Vault as. Available to both Userpass and LDAP auth methods | | |
| `authPayload` | The JSON payload to be sent to Vault when using a custom authentication method. | | | The Vault namespace from which to query secrets. Vault Enterprise only, unset by default.
| `extraHeaders` | A string of newline separated extra headers to include on every request. | | |
| `exportEnv` | Whether or not export secrets as environment variables. | `true` | | ### `method`
| `exportToken` | Whether or not export Vault token as environment variables (i.e VAULT_TOKEN). | `false` | |
| `outputToken` | Whether or not to set the `vault_token` output to contain the Vault token after authentication. | `false` | | **Type: `string`**\
| `caCertificate` | Base64 encoded CA certificate the server certificate was signed with. | | | **Default: `token`**
| `clientCertificate` | Base64 encoded client certificate the action uses to authenticate with Vault when mTLS is enabled. | | |
| `clientKey` | Base64 encoded client key the action uses to authenticate with Vault when mTLS is enabled. | | | The method to use to authenticate with Vault.
| `tlsSkipVerify` | When set to true, disables verification of server certificates when testing the action. | `false` | |
### `role`
**Type: `string`**
Vault role for the specified auth method.
### `path`
**Type: `string`**
The Vault path for the auth method.
### `token`
**Type: `string`**
The Vault token to be used to authenticate with Vault.
### `roleId`
**Type: `string`**
The role ID for App Role authentication.
### `secretId`
**Type: `string`**
The secret ID for App Role authentication.
### `githubToken`
**Type: `string`**
The Github Token to be used to authenticate with Vault.
### `jwtPrivateKey`
**Type: `string`**
Base64 encoded private key to sign the JWT.
### `jwtKeyPassword`
**Type: `string`**
Password for key stored in `jwtPrivateKey` (if needed).
### `jwtGithubAudience`
**Type: `string`**\
**Default: `sigstore`**
Identifies the recipient ("aud" claim) that the JWT is intended for.
### `jwtTtl`
**Type: `string`**\
**Default: `3600`**
Time in seconds, after which token expires.
### `kubernetesTokenPath`
**Type: `string`**\
**Default: `/var/run/secrets/kubernetes.io/serviceaccount/token`**
The path to the service-account secret with the jwt token for kubernetes based authentication.
### `username`
**Type: `string`**
The username of the user to log in to Vault as. Available to both Userpass and LDAP auth methods.
### `password`
**Type: `string`**
The password of the user to log in to Vault as. Available to both Userpass and LDAP auth methods.
### `authPayload`
**Type: `string`**
The JSON payload to be sent to Vault when using a custom authentication method.
### `extraHeaders`
**Type: `string`**
A string of newline separated extra headers to include on every request.
### `exportEnv`
**Type: `string`**\
**Default: `true`**
Whether or not to export secrets as environment variables.
### `exportToken`
**Type: `string`**\
**Default: `false`**
Whether or not export Vault token as environment variables (i.e VAULT_TOKEN).
### `outputToken`
**Type: `string`**\
**Default: `false`**
Whether or not to set the `vault_token` output to contain the Vault token after authentication.
### `caCertificate`
**Type: `string`**
Base64 encoded CA certificate the server certificate was signed with. Defaults to CAs provided by Mozilla.
### `clientCertificate`
**Type: `string`**
Base64 encoded client certificate the action uses to authenticate with Vault when mTLS is enabled.
### `clientKey`
**Type: `string`**
Base64 encoded client key the action uses to authenticate with Vault when mTLS is enabled.
### `tlsSkipVerify`
**Type: `string`**\
**Default: `false`**
When set to true, disables verification of server certificates when testing the action.
### `ignoreNotFound`
**Type: `string`**\
**Default: `false`**
When set to true, prevents the action from failing when a secret does not exist.
## Masking - Hiding Secrets from Logs ## Masking - Hiding Secrets from Logs
+11 -7
View File
@@ -1,4 +1,4 @@
name: 'Vault Secrets' name: 'HashiCorp Vault'
description: 'A Github Action that allows you to consume HashiCorp Vault™ secrets as secure environment variables' description: 'A Github Action that allows you to consume HashiCorp Vault™ secrets as secure environment variables'
inputs: inputs:
url: url:
@@ -18,16 +18,16 @@ inputs:
description: 'Vault role for specified auth method' description: 'Vault role for specified auth method'
required: false required: false
path: path:
description: 'Custom Vault path, if the auth method was mounted at a different path' description: 'The Vault path for the auth method.'
required: false required: false
token: token:
description: 'The Vault Token to be used to authenticate with Vault' description: 'The Vault token to be used to authenticate with Vault'
required: false required: false
roleId: roleId:
description: 'The Role Id for App Role authentication' description: 'The role ID for App Role authentication'
required: false required: false
secretId: secretId:
description: 'The Secret Id for App Role authentication' description: 'The secret ID for App Role authentication'
required: false required: false
githubToken: githubToken:
description: 'The Github Token to be used to authenticate with Vault' description: 'The Github Token to be used to authenticate with Vault'
@@ -61,7 +61,7 @@ inputs:
default: 'false' default: 'false'
required: false required: false
caCertificate: caCertificate:
description: 'Base64 encoded CA certificate to verify the Vault server certificate.' description: 'Base64 encoded CA certificate the server certificate was signed with. Defaults to CAs provided by Mozilla.'
required: false required: false
clientCertificate: clientCertificate:
description: 'Base64 encoded client certificate for mTLS communication with the Vault server.' description: 'Base64 encoded client certificate for mTLS communication with the Vault server.'
@@ -89,8 +89,12 @@ inputs:
secretEncodingType: secretEncodingType:
description: 'The encoding type of the secret to decode. If not specified, the secret will not be decoded. Supported values: base64, hex, utf8' description: 'The encoding type of the secret to decode. If not specified, the secret will not be decoded. Supported values: base64, hex, utf8'
required: false required: false
ignoreNotFound:
description: 'Whether or not the action should exit successfully if some requested secrets were not found.'
required: false
default: 'false'
runs: runs:
using: 'node16' using: 'node20'
main: 'dist/index.js' main: 'dist/index.js'
branding: branding:
icon: 'unlock' icon: 'unlock'
+8933 -13579
View File
File diff suppressed because one or more lines are too long
+3
View File
@@ -0,0 +1,3 @@
{
"type": "module"
}
+8 -7
View File
@@ -1,11 +1,12 @@
jest.mock('@actions/core'); import { vi, describe, test, expect } from 'vitest';
jest.mock('@actions/core/lib/command');
const core = require('@actions/core');
const got = require('got'); vi.mock('@actions/core');
const { when } = require('jest-when'); import core from '@actions/core';
const { exportSecrets } = require('../../src/action'); import got from 'got';
import { when } from 'jest-when'
import { exportSecrets } from '../../src/action.js';
const vaultUrl = `http://${process.env.VAULT_HOST || 'localhost'}:${process.env.VAULT_PORT || '8200'}`; const vaultUrl = `http://${process.env.VAULT_HOST || 'localhost'}:${process.env.VAULT_PORT || '8200'}`;
const vaultToken = `${process.env.VAULT_TOKEN || 'testtoken'}` const vaultToken = `${process.env.VAULT_TOKEN || 'testtoken'}`
@@ -102,7 +103,7 @@ describe('authenticate with approle', () => {
}); });
beforeEach(() => { beforeEach(() => {
jest.resetAllMocks(); vi.resetAllMocks();
when(core.getInput) when(core.getInput)
.calledWith('method', expect.anything()) .calledWith('method', expect.anything())
+31 -8
View File
@@ -1,11 +1,12 @@
jest.mock('@actions/core'); import { vi, describe, test, expect } from 'vitest';
jest.mock('@actions/core/lib/command');
const core = require('@actions/core');
const got = require('got'); vi.mock('@actions/core');
const { when } = require('jest-when'); import core from '@actions/core';
const { exportSecrets } = require('../../src/action'); import got from 'got';
import { when } from 'jest-when'
import { exportSecrets } from '../../src/action.js';
const vaultUrl = `http://${process.env.VAULT_HOST || 'localhost'}:${process.env.VAULT_PORT || '8200'}`; const vaultUrl = `http://${process.env.VAULT_HOST || 'localhost'}:${process.env.VAULT_PORT || '8200'}`;
const vaultToken = `${process.env.VAULT_TOKEN || 'testtoken'}` const vaultToken = `${process.env.VAULT_TOKEN || 'testtoken'}`
@@ -107,7 +108,7 @@ describe('integration', () => {
}); });
beforeEach(() => { beforeEach(() => {
jest.resetAllMocks(); vi.resetAllMocks();
when(core.getInput) when(core.getInput)
.calledWith('url', expect.anything()) .calledWith('url', expect.anything())
@@ -124,12 +125,34 @@ describe('integration', () => {
.mockReturnValueOnce(secrets); .mockReturnValueOnce(secrets);
} }
function mockIgnoreNotFound(shouldIgnore) {
when(core.getInput)
.calledWith('ignoreNotFound', expect.anything())
.mockReturnValueOnce(shouldIgnore);
}
it('prints a nice error message when secret not found', async () => { it('prints a nice error message when secret not found', async () => {
mockInput(`secret/data/test secret ; mockInput(`secret/data/test secret ;
secret/data/test secret | NAMED_SECRET ; secret/data/test secret | NAMED_SECRET ;
secret/data/notFound kehe | NO_SIR ;`); secret/data/notFound kehe | NO_SIR ;`);
expect(exportSecrets()).rejects.toEqual(Error(`Unable to retrieve result for "secret/data/notFound" because it was not found: {"errors":[]}`)); await expect(exportSecrets()).rejects.toEqual(Error(`Unable to retrieve result for "secret/data/notFound" because it was not found: {"errors":[]}`));
})
it('does not error when secret not found and ignoreNotFound is true', async () => {
mockInput(`secret/data/test secret ;
secret/data/test secret | NAMED_SECRET ;
secret/data/notFound kehe | NO_SIR ;`);
mockIgnoreNotFound("true");
await exportSecrets();
expect(core.exportVariable).toBeCalledTimes(2);
expect(core.exportVariable).toBeCalledWith('SECRET', 'SUPERSECRET');
expect(core.exportVariable).toBeCalledWith('NAMED_SECRET', 'SUPERSECRET');
}) })
it('get simple secret', async () => { it('get simple secret', async () => {
-3
View File
@@ -1,3 +0,0 @@
module.exports = {
verbose: true
};
+12 -11
View File
@@ -1,17 +1,18 @@
jest.mock('@actions/core'); import { vi, describe, test, expect } from 'vitest';
jest.mock('@actions/core/lib/command');
const core = require('@actions/core'); vi.mock('@actions/core');
const rsasign = require('jsrsasign'); import core from '@actions/core';
const { import rsasign from 'jsrsasign';
import {
privateRsaKey, privateRsaKey,
privateRsaKeyBase64, privateRsaKeyBase64,
publicRsaKey publicRsaKey
} = require('./rsa_keys'); } from './rsa_keys.js';
const got = require('got'); import got from 'got';
const { when } = require('jest-when'); import { when } from 'jest-when'
const { exportSecrets } = require('../../src/action'); import { exportSecrets } from '../../src/action.js';
const vaultUrl = `http://${process.env.VAULT_HOST || 'localhost'}:${process.env.VAULT_PORT || '8200'}`; const vaultUrl = `http://${process.env.VAULT_HOST || 'localhost'}:${process.env.VAULT_PORT || '8200'}`;
const vaultToken = `${process.env.VAULT_TOKEN || 'testtoken'}` const vaultToken = `${process.env.VAULT_TOKEN || 'testtoken'}`
@@ -139,7 +140,7 @@ describe('jwt auth', () => {
describe('authenticate with private key', () => { describe('authenticate with private key', () => {
beforeEach(() => { beforeEach(() => {
jest.resetAllMocks(); vi.resetAllMocks();
when(core.getInput) when(core.getInput)
.calledWith('url', expect.anything()) .calledWith('url', expect.anything())
@@ -189,7 +190,7 @@ describe('jwt auth', () => {
}) })
beforeEach(() => { beforeEach(() => {
jest.resetAllMocks(); vi.resetAllMocks();
when(core.getInput) when(core.getInput)
.calledWith('url', expect.anything()) .calledWith('url', expect.anything())
+1 -1
View File
@@ -42,7 +42,7 @@ LrJEY9tZaRF8xraMZiOcBcyAt6S/TS29HttJ6+zlhcWx34fItEZ8jA5gzhTmspOY
-----END PUBLIC KEY----- -----END PUBLIC KEY-----
`; `;
module.exports = { export {
privateRsaKey, privateRsaKey,
privateRsaKeyBase64, privateRsaKeyBase64,
publicRsaKey publicRsaKey
+8 -7
View File
@@ -1,11 +1,12 @@
jest.mock('@actions/core'); import { vi, describe, test, expect } from 'vitest';
jest.mock('@actions/core/lib/command');
const core = require('@actions/core');
const got = require('got'); vi.mock('@actions/core');
const { when } = require('jest-when'); import core from '@actions/core';
const { exportSecrets } = require('../../src/action'); import got from 'got';
import { when } from 'jest-when'
import { exportSecrets } from '../../src/action.js';
const vaultUrl = `http://${process.env.VAULT_HOST || 'localhost'}:${process.env.VAULT_PORT || '8200'}`; const vaultUrl = `http://${process.env.VAULT_HOST || 'localhost'}:${process.env.VAULT_PORT || '8200'}`;
const vaultToken = `${process.env.VAULT_TOKEN || 'testtoken'}` const vaultToken = `${process.env.VAULT_TOKEN || 'testtoken'}`
@@ -84,7 +85,7 @@ describe('authenticate with userpass', () => {
}); });
beforeEach(() => { beforeEach(() => {
jest.resetAllMocks(); vi.resetAllMocks();
when(core.getInput) when(core.getInput)
.calledWith('method', expect.anything()) .calledWith('method', expect.anything())
+11
View File
@@ -0,0 +1,11 @@
import { defineConfig, configDefaults } from 'vitest/config'
export default defineConfig({
test: {
// required to make jest-when work with vitest
globals: true,
include: [
'**/integrationTests/basic/**.{test,spec}.?(c|m)[jt]s?(x)',
],
},
})
+2
View File
@@ -1,3 +1,5 @@
import { describe, test, expect } from 'vitest';
describe('e2e-tls', () => { describe('e2e-tls', () => {
it('verify', () => { it('verify', () => {
expect(process.env.SECRET).toBe("SUPERSECRET"); expect(process.env.SECRET).toBe("SUPERSECRET");
-3
View File
@@ -1,3 +0,0 @@
module.exports = {
verbose: true
};
+2 -2
View File
@@ -1,5 +1,5 @@
const got = require('got'); import got from 'got';
const core = require('@actions/core'); import core from '@actions/core';
const vaultUrl = `${process.env.VAULT_HOST}:${process.env.VAULT_PORT}`; const vaultUrl = `${process.env.VAULT_HOST}:${process.env.VAULT_PORT}`;
const caCertificateRaw = `${process.env.VAULTCA}`; const caCertificateRaw = `${process.env.VAULTCA}`;
+11
View File
@@ -0,0 +1,11 @@
import { defineConfig, configDefaults } from 'vitest/config'
export default defineConfig({
test: {
// required to make jest-when work with vitest
globals: true,
include: [
'**/integrationTests/e2e-tls/**.{test,spec}.?(c|m)[jt]s?(x)',
],
},
})
+2
View File
@@ -1,3 +1,5 @@
import { describe, test, expect } from 'vitest';
describe('e2e', () => { describe('e2e', () => {
it('verify', () => { it('verify', () => {
expect(process.env.SECRET).toBe("SUPERSECRET"); expect(process.env.SECRET).toBe("SUPERSECRET");
-3
View File
@@ -1,3 +0,0 @@
module.exports = {
verbose: true
};
+1 -1
View File
@@ -1,4 +1,4 @@
const got = require('got'); import got from 'got';
const vaultUrl = `${process.env.VAULT_HOST}:${process.env.VAULT_PORT}`; const vaultUrl = `${process.env.VAULT_HOST}:${process.env.VAULT_PORT}`;
const vaultToken = `${process.env.VAULT_TOKEN}` === undefined ? `${process.env.VAULT_TOKEN}` : "testtoken"; const vaultToken = `${process.env.VAULT_TOKEN}` === undefined ? `${process.env.VAULT_TOKEN}` : "testtoken";
+11
View File
@@ -0,0 +1,11 @@
import { defineConfig, configDefaults } from 'vitest/config'
export default defineConfig({
test: {
// required to make jest-when work with vitest
globals: true,
include: [
'**/integrationTests/e2e/**.{test,spec}.?(c|m)[jt]s?(x)',
],
},
})
@@ -1,11 +1,12 @@
jest.mock('@actions/core'); import { vi, describe, test, expect } from 'vitest';
jest.mock('@actions/core/lib/command');
const core = require('@actions/core');
const got = require('got'); vi.mock('@actions/core');
const { when } = require('jest-when'); import core from '@actions/core';
const { exportSecrets } = require('../../src/action'); import got from 'got';
import { when } from 'jest-when'
import { exportSecrets } from '../../src/action.js';
const vaultUrl = `http://${process.env.VAULT_HOST || 'localhost'}:${process.env.VAULT_PORT || '8201'}`; const vaultUrl = `http://${process.env.VAULT_HOST || 'localhost'}:${process.env.VAULT_PORT || '8201'}`;
const vaultToken = `${process.env.VAULT_TOKEN || 'testtoken'}` const vaultToken = `${process.env.VAULT_TOKEN || 'testtoken'}`
@@ -41,7 +42,7 @@ describe('integration', () => {
}); });
beforeEach(() => { beforeEach(() => {
jest.resetAllMocks(); vi.resetAllMocks();
when(core.getInput) when(core.getInput)
.calledWith('url', expect.anything()) .calledWith('url', expect.anything())
@@ -238,7 +239,7 @@ describe('authenticate with approle', () => {
}); });
beforeEach(() => { beforeEach(() => {
jest.resetAllMocks(); vi.resetAllMocks();
when(core.getInput) when(core.getInput)
.calledWith('method', expect.anything()) .calledWith('method', expect.anything())
@@ -1,3 +0,0 @@
module.exports = {
verbose: true
};
@@ -0,0 +1,11 @@
import { defineConfig, configDefaults } from 'vitest/config'
export default defineConfig({
test: {
// required to make jest-when work with vitest
globals: true,
include: [
'**/integrationTests/enterprise/**.{test,spec}.?(c|m)[jt]s?(x)',
],
},
})
-3
View File
@@ -1,3 +0,0 @@
module.exports = {
testPathIgnorePatterns: ['/node_modules/', '<rootDir>/integrationTests/'],
};
+4848 -2084
View File
File diff suppressed because it is too large Load Diff
+14 -16
View File
@@ -2,14 +2,15 @@
"name": "vault-action", "name": "vault-action",
"version": "0.1.0", "version": "0.1.0",
"description": "A Github Action that allows you to consume vault secrets as secure environment variables.", "description": "A Github Action that allows you to consume vault secrets as secure environment variables.",
"type": "module",
"main": "dist/index.js", "main": "dist/index.js",
"scripts": { "scripts": {
"build": "ncc build src/entry.js -o dist", "build": "ncc build src/entry.js -o dist",
"test": "jest", "test": "vitest run",
"test:integration:basic": "jest -c integrationTests/basic/jest.config.js", "test:integration:basic": "vitest run -c integrationTests/basic/vitest.config.js",
"test:integration:enterprise": "jest -c integrationTests/enterprise/jest.config.js", "test:integration:enterprise": "vitest run -c integrationTests/enterprise/vitest.config.js",
"test:integration:e2e": "jest -c integrationTests/e2e/jest.config.js", "test:integration:e2e": "vitest run -c integrationTests/e2e/vitest.config.js",
"test:integration:e2e-tls": "jest -c integrationTests/e2e-tls/jest.config.js" "test:integration:e2e-tls": "vitest run -c integrationTests/e2e-tls/vitest.config.js"
}, },
"files": [ "files": [
"src/**/*", "src/**/*",
@@ -34,18 +35,15 @@
}, },
"homepage": "https://github.com/hashicorp/vault-action#readme", "homepage": "https://github.com/hashicorp/vault-action#readme",
"dependencies": { "dependencies": {
"got": "^11.8.5", "@actions/core": "^1.10.1",
"jsonata": "^2.0.3", "got": "^14.2.1",
"jsrsasign": "^10.8.6" "jsonata": "^2.0.4",
}, "jsrsasign": "^11.0.0"
"peerDependencies": {
"@actions/core": ">=1 <2"
}, },
"devDependencies": { "devDependencies": {
"@actions/core": "^1.10.0", "@vercel/ncc": "^0.38.1",
"@vercel/ncc": "^0.36.1", "jest-when": "^3.6.0",
"jest": "^29.5.0", "mock-http-server": "^1.4.5",
"jest-when": "^3.5.2", "vitest": "^1.3.1"
"mock-http-server": "^1.4.5"
} }
} }
+12 -11
View File
@@ -1,12 +1,14 @@
// @ts-check import core from '@actions/core';
const core = require('@actions/core'); import got from 'got';
const command = require('@actions/core/lib/command');
const got = require('got').default;
const jsonata = require('jsonata');
const { normalizeOutputKey } = require('./utils');
const { WILDCARD } = require('./constants');
const { auth: { retrieveToken }, secrets: { getSecrets } } = require('./index'); import { normalizeOutputKey } from './utils.js';
import { WILDCARD } from './constants.js';
import { retrieveToken } from './auth.js';
import { getSecrets } from './secrets.js';
// ncc doesn't compile jsonata imports properly, so we must use our own custom require
import require from "./cjs-require.js";
const jsonata = require('jsonata');
const AUTH_METHODS = ['approle', 'token', 'github', 'jwt', 'kubernetes', 'ldap', 'userpass']; const AUTH_METHODS = ['approle', 'token', 'github', 'jwt', 'kubernetes', 'ldap', 'userpass'];
const ENCODING_TYPES = ['base64', 'hex', 'utf8']; const ENCODING_TYPES = ['base64', 'hex', 'utf8'];
@@ -219,9 +221,8 @@ function parseHeadersInput(inputKey, inputOptions) {
}, new Map()); }, new Map());
} }
module.exports = { export {
exportSecrets, exportSecrets,
parseSecretsInput, parseSecretsInput,
parseHeadersInput, parseHeadersInput,
}; }
+10 -10
View File
@@ -1,17 +1,17 @@
jest.mock('got'); import { vi, describe, test, expect } from 'vitest';
jest.mock('@actions/core');
jest.mock('@actions/core/lib/command');
const command = require('@actions/core/lib/command'); vi.mock('got');
const core = require('@actions/core'); vi.mock('@actions/core');
const got = require('got');
const { import core from '@actions/core';
import got from 'got';
import {
exportSecrets, exportSecrets,
parseSecretsInput, parseSecretsInput,
parseHeadersInput parseHeadersInput
} = require('./action'); } from './action.js';
const { when } = require('jest-when'); import { when } from 'jest-when'
describe('parseSecretsInput', () => { describe('parseSecretsInput', () => {
it('parses simple secret', () => { it('parses simple secret', () => {
@@ -132,7 +132,7 @@ describe('parseHeaders', () => {
describe('exportSecrets', () => { describe('exportSecrets', () => {
beforeEach(() => { beforeEach(() => {
jest.resetAllMocks(); vi.resetAllMocks();
when(core.getInput) when(core.getInput)
.calledWith('url', expect.anything()) .calledWith('url', expect.anything())
+6 -6
View File
@@ -1,8 +1,8 @@
// @ts-check // @ts-check
const core = require('@actions/core'); import core from '@actions/core';
const rsasign = require('jsrsasign'); import * as fs from 'fs';
const fs = require('fs'); import got from 'got';
const { default: got } = require('got'); import rsasign from 'jsrsasign';
const defaultKubernetesTokenPath = '/var/run/secrets/kubernetes.io/serviceaccount/token' const defaultKubernetesTokenPath = '/var/run/secrets/kubernetes.io/serviceaccount/token'
/*** /***
@@ -17,7 +17,7 @@ async function retrieveToken(method, client) {
switch (method) { switch (method) {
case 'approle': { case 'approle': {
const vaultRoleId = core.getInput('roleId', { required: true }); const vaultRoleId = core.getInput('roleId', { required: true });
const vaultSecretId = core.getInput('secretId', { required: true }); const vaultSecretId = core.getInput('secretId', { required: false });
return await getClientToken(client, method, path, { role_id: vaultRoleId, secret_id: vaultSecretId }); return await getClientToken(client, method, path, { role_id: vaultRoleId, secret_id: vaultSecretId });
} }
case 'github': { case 'github': {
@@ -154,6 +154,6 @@ async function getClientToken(client, method, path, payload) {
* }} auth * }} auth
*/ */
module.exports = { export {
retrieveToken, retrieveToken,
}; };
+15 -17
View File
@@ -1,22 +1,20 @@
jest.mock('got'); import { vi, describe, test, expect } from 'vitest';
jest.mock('@actions/core');
jest.mock('@actions/core/lib/command'); vi.mock('got');
jest.mock('fs', () => ({ vi.mock('@actions/core');
stat: jest.fn().mockResolvedValue(null), vi.mock('fs', () => ({
stat: vi.fn().mockResolvedValue(null),
promises: { promises: {
access: jest.fn().mockResolvedValue(null), access: vi.fn().mockResolvedValue(null),
} }
})); }));
const core = require('@actions/core'); import core from '@actions/core';
const got = require('got'); import got from 'got'
const fs = require("fs") import * as fs from 'fs';
const { when } = require('jest-when'); import { when } from 'jest-when'
import { retrieveToken } from './auth.js';
const {
retrieveToken
} = require('./auth');
function mockInput(name, key) { function mockInput(name, key) {
@@ -27,7 +25,7 @@ function mockInput(name, key) {
function mockApiResponse() { function mockApiResponse() {
const response = { body: { auth: { client_token: testToken, renewable: true, policies: [], accessor: "accessor" } } } const response = { body: { auth: { client_token: testToken, renewable: true, policies: [], accessor: "accessor" } } }
got.post = jest.fn() got.post = vi.fn()
got.post.mockReturnValue(response) got.post.mockReturnValue(response)
} }
const testToken = "testoken"; const testToken = "testoken";
@@ -35,7 +33,7 @@ const testToken = "testoken";
describe("test retrival for token", () => { describe("test retrival for token", () => {
beforeEach(() => { beforeEach(() => {
jest.resetAllMocks(); vi.resetAllMocks();
}); });
it("test retrival with approle", async () => { it("test retrival with approle", async () => {
@@ -76,7 +74,7 @@ describe("test retrival for token", () => {
mockInput("kubernetesTokenPath", testTokenPath) mockInput("kubernetesTokenPath", testTokenPath)
mockInput("role", testRole) mockInput("role", testRole)
mockInput("path", testPath) mockInput("path", testPath)
fs.readFileSync = jest.fn() fs.readFileSync = vi.fn()
fs.readFileSync.mockReturnValueOnce(jwtToken) fs.readFileSync.mockReturnValueOnce(jwtToken)
const token = await retrieveToken(method, got) const token = await retrieveToken(method, got)
expect(token).toEqual(testToken) expect(token).toEqual(testToken)
+7
View File
@@ -0,0 +1,7 @@
// This allows us to use `require` in our ECMAScript module
// See: https://github.com/vercel/ncc/issues/791
// https://nodejs.org/api/module.html#modulecreaterequirefilename
import { createRequire } from "module";
const require = createRequire(import.meta.url);
export default require;
+1 -1
View File
@@ -1,5 +1,5 @@
const WILDCARD = '*'; const WILDCARD = '*';
module.exports = { export {
WILDCARD WILDCARD
}; };
+2 -2
View File
@@ -1,5 +1,5 @@
const core = require('@actions/core'); import core from '@actions/core';
const { exportSecrets } = require('./action'); import { exportSecrets } from './action.js';
(async () => { (async () => {
try { try {
+3 -3
View File
@@ -1,7 +1,7 @@
const auth = require('./auth'); import auth from './auth.js';
const secrets = require('./secrets'); import secrets from './secrets.js';
module.exports = { export default {
auth, auth,
secrets secrets
}; };
+16 -14
View File
@@ -1,17 +1,19 @@
jest.mock('@actions/core'); import { vi, describe, test, expect } from 'vitest';
const core = require('@actions/core'); vi.mock('@actions/core');
const ServerMock = require("mock-http-server");
const { exportSecrets } = require("./action"); import core from '@actions/core';
const { when } = require('jest-when'); import ServerMock from 'mock-http-server';
import { exportSecrets } from './action.js';
import { when } from 'jest-when';
describe('exportSecrets retries', () => { describe('exportSecrets retries', () => {
var server = new ServerMock({ host: "127.0.0.1", port: 0 }); var server = new ServerMock({ host: "127.0.0.1", port: 0 });
var calls = 0; var calls = 0;
beforeEach((done) => { beforeEach(() => new Promise(done => {
calls = 0; calls = 0;
jest.resetAllMocks(); vi.resetAllMocks();
when(core.getInput) when(core.getInput)
.calledWith('token', expect.anything()) .calledWith('token', expect.anything())
@@ -28,11 +30,11 @@ describe('exportSecrets retries', () => {
.mockReturnValueOnce('http://127.0.0.1:' + server.getHttpPort()); .mockReturnValueOnce('http://127.0.0.1:' + server.getHttpPort());
done(); done();
}); });
}); }));
afterEach((done) => { afterEach(() => new Promise(done => {
server.stop(done); server.stop(done);
}); }));
function mockStatusCodes(statusCodes) { function mockStatusCodes(statusCodes) {
server.on({ server.on({
@@ -51,19 +53,19 @@ describe('exportSecrets retries', () => {
}); });
} }
it('retries on 412 status code', (done) => { it('retries on 412 status code', () => new Promise(done => {
mockStatusCodes([412, 200]) mockStatusCodes([412, 200])
exportSecrets().then(() => { exportSecrets().then(() => {
expect(calls).toEqual(2); expect(calls).toEqual(2);
done(); done();
}); });
}); }));
it('retries on 500 status code', (done) => { it('retries on 500 status code', () => new Promise(done => {
mockStatusCodes([500, 200]) mockStatusCodes([500, 200])
exportSecrets().then(() => { exportSecrets().then(() => {
expect(calls).toEqual(2); expect(calls).toEqual(2);
done(); done();
}); });
}); }));
}); });
+19 -6
View File
@@ -1,6 +1,12 @@
const jsonata = require("jsonata"); import core from '@actions/core';
const { WILDCARD } = require("./constants"); import { WILDCARD } from './constants.js';
const { normalizeOutputKey } = require("./utils"); import { normalizeOutputKey } from './utils.js';
// ncc doesn't compile jsonata imports properly, so we must use our own custom require
import require from "./cjs-require.js";
const jsonata = require('jsonata');
/** /**
* @typedef {Object} SecretRequest * @typedef {Object} SecretRequest
* @property {string} path * @property {string} path
@@ -21,7 +27,7 @@ const { normalizeOutputKey } = require("./utils");
* @param {import('got').Got} client * @param {import('got').Got} client
* @return {Promise<SecretResponse<TRequest>[]>} * @return {Promise<SecretResponse<TRequest>[]>}
*/ */
async function getSecrets(secretRequests, client) { async function getSecrets(secretRequests, client, ignoreNotFound) {
const responseCache = new Map(); const responseCache = new Map();
let results = []; let results = [];
@@ -42,7 +48,14 @@ async function getSecrets(secretRequests, client) {
} catch (error) { } catch (error) {
const {response} = error; const {response} = error;
if (response?.statusCode === 404) { if (response?.statusCode === 404) {
throw Error(`Unable to retrieve result for "${path}" because it was not found: ${response.body.trim()}`) let notFoundMsg = `Unable to retrieve result for "${path}" because it was not found: ${response.body.trim()}`;
const ignoreNotFound = (core.getInput('ignoreNotFound', { required: false }) || 'false').toLowerCase() != 'false';
if (ignoreNotFound) {
core.error(`${notFoundMsg}`);
continue;
} else {
throw Error(notFoundMsg)
}
} }
throw error throw error
} }
@@ -156,7 +169,7 @@ const selectAndAppendResults = async (
]; ];
}; };
module.exports = { export {
getSecrets, getSecrets,
selectData selectData
} }
+1 -1
View File
@@ -14,6 +14,6 @@ function normalizeOutputKey(dataKey, isEnvVar = false) {
return outputKey; return outputKey;
} }
module.exports = { export {
normalizeOutputKey normalizeOutputKey
}; };
+12
View File
@@ -0,0 +1,12 @@
import { defineConfig, configDefaults } from 'vitest/config'
export default defineConfig({
test: {
// required to make jest-when work with vitest
globals: true,
exclude:[
...configDefaults.exclude,
'**/integrationTests/**'
]
},
})