1
0
mirror of https://github.com/actions/setup-node.git synced 2026-07-14 11:51:40 +00:00

Compare commits

...

12 Commits

Author SHA1 Message Date
gowridurgad 8207627860 Migrate to ESM and upgrade dependencies (#1574)
* Migrate to ESM

* updated package.json version

* Update README for v6 and clean up dev dependencies

* Remove unused ts-node

* fix audit issue

---------

Co-authored-by: gowridurgad <gowridurgad@gmail.com>
2026-07-13 21:38:27 -05:00
gowridurgad 04be95cf35 Add cache-primary-key and cache-matched-key as outputs (#1577)
* Add cache-primary-key and cache-matched-key as outputs

* Refine cache output descriptions

---------

Co-authored-by: gowridurgad <gowridurgad@gmail.com>
2026-07-07 13:57:48 -05:00
Chiranjib Swain 7c2c68d20d docs: Update caching recommendations to mitigate cache poisoning risks (#1567)
* docs: Update caching recommendations to mitigate cache poisoning risks

* docs: Disable automatic npm caching to mitigate cache poisoning risks
2026-07-02 13:14:10 -05:00
Bassem Dghaidi 6a61c0375d Merge pull request #1569 from jasongin/update-actions-cache-5.1.0
Bump @actions/cache to 5.1.0, log cache write denied
2026-06-23 11:19:27 +02:00
Jason Ginchereau 30eb73b41d Resolve high-severity audit issues 2026-06-18 17:59:56 -07:00
Jason Ginchereau 4e1a87a501 Update dist 2026-06-18 15:55:36 -07:00
Jason Ginchereau 360237f0c0 Strict equality 2026-06-18 15:46:26 -07:00
Jason Ginchereau 4f8aac5beb Bump @actions/cache to 5.1.0, log cache write denied 2026-06-18 15:18:53 -07:00
Timo Sand f4a67bbeca Only use mirrorToken in getManifest if it's provided (#1548)
* Only use `mirrorToken` in `getManifest` if it's provided

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

* `npm run build`

Signed-off-by: Timo Sand <timo.sand@f-secure.com>

---------

Signed-off-by: Timo Sand <timo.sand@f-secure.com>
2026-06-09 11:03:18 -05:00
gowridurgad 0355742c94 Remove dummy NODE_AUTH_TOKEN export (#1558)
Co-authored-by: gowridurgad <gowridurgad@gmail.com>
2026-05-27 21:56:31 -05:00
priya-kinthali ad1b57eb81 docs: Update restore-only cache documentation (#1550)
* update restore-only cache example in advanced-usage.md

* fix copilot suggestion

* update naming
2026-05-26 17:51:36 -05:00
Chiranjib Swain 670825a89d Add documentation for publishing to npm with Trusted Publisher (OIDC) (#1536) 2026-04-22 21:58:57 -05:00
92 changed files with 109645 additions and 126952 deletions
-6
View File
@@ -1,6 +0,0 @@
# Ignore list
/*
# Do not ignore these folders:
!__tests__/
!src/
-51
View File
@@ -1,51 +0,0 @@
// This is a reusable configuration file copied from https://github.com/actions/reusable-workflows/tree/main/reusable-configurations. Please don't make changes to this file as it's the subject of an automatic update.
module.exports = {
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:eslint-plugin-jest/recommended',
'eslint-config-prettier'
],
parser: '@typescript-eslint/parser',
plugins: ['@typescript-eslint', 'eslint-plugin-node', 'eslint-plugin-jest'],
rules: {
'@typescript-eslint/no-require-imports': 'error',
'@typescript-eslint/no-non-null-assertion': 'off',
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-empty-function': 'off',
'@typescript-eslint/ban-ts-comment': [
'error',
{
'ts-ignore': 'allow-with-description'
}
],
'no-console': 'error',
'yoda': 'error',
'prefer-const': [
'error',
{
destructuring: 'all'
}
],
'no-control-regex': 'off',
'no-constant-condition': ['error', {checkLoops: false}],
'node/no-extraneous-import': 'error'
},
overrides: [
{
files: ['**/*{test,spec}.ts'],
rules: {
'@typescript-eslint/no-unused-vars': 'off',
'jest/no-standalone-expect': 'off',
'jest/no-conditional-expect': 'off',
'no-console': 'off',
}
}
],
env: {
node: true,
es6: true,
'jest/globals': true
}
};
+5 -1
View File
@@ -10,7 +10,11 @@ allowed:
- mit - mit
- cc0-1.0 - cc0-1.0
- unlicense - unlicense
- blueoak-1.0.0
reviewed: reviewed:
npm: npm:
- "@actions/http-client" - "@actions/http-client"
- balanced-match
- brace-expansion
- fast-content-type-parse
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@actions/cache" name: "@actions/cache"
version: 5.0.5 version: 6.1.0
type: npm type: npm
summary: Actions cache lib summary: Actions cache lib
homepage: https://github.com/actions/toolkit/tree/main/packages/cache homepage: https://github.com/actions/toolkit/tree/main/packages/cache
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@actions/core" name: "@actions/core"
version: 2.0.3 version: 3.0.1
type: npm type: npm
summary: Actions core lib summary: Actions core lib
homepage: https://github.com/actions/toolkit/tree/main/packages/core homepage: https://github.com/actions/toolkit/tree/main/packages/core
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@actions/exec" name: "@actions/exec"
version: 2.0.0 version: 3.0.0
type: npm type: npm
summary: Actions exec lib summary: Actions exec lib
homepage: https://github.com/actions/toolkit/tree/main/packages/exec homepage: https://github.com/actions/toolkit/tree/main/packages/exec
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@actions/github" name: "@actions/github"
version: 6.0.1 version: 9.1.1
type: npm type: npm
summary: Actions github lib summary: Actions github lib
homepage: https://github.com/actions/toolkit/tree/main/packages/github homepage: https://github.com/actions/toolkit/tree/main/packages/github
@@ -1,6 +1,6 @@
--- ---
name: "@actions/glob" name: "@actions/glob"
version: 0.5.1 version: 0.6.1
type: npm type: npm
summary: Actions glob lib summary: Actions glob lib
homepage: https://github.com/actions/toolkit/tree/main/packages/glob homepage: https://github.com/actions/toolkit/tree/main/packages/glob
@@ -1,20 +1,20 @@
--- ---
name: "@octokit/openapi-types" name: "@actions/glob"
version: 24.2.0 version: 0.7.0
type: npm type: npm
summary: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com summary: Actions glob lib
homepage: homepage: https://github.com/actions/toolkit/tree/main/packages/glob
license: mit license: mit
licenses: licenses:
- sources: LICENSE - sources: LICENSE.md
text: |- text: |-
Copyright 2020 Gregor Martynus The MIT License (MIT)
Copyright 2019 GitHub
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- sources: README.md
text: "[MIT](LICENSE)"
notices: [] notices: []
@@ -1,10 +1,10 @@
--- ---
name: "@actions/http-client" name: "@actions/http-client"
version: 2.2.3 version: 4.0.1
type: npm type: npm
summary: Actions Http Client summary: Actions Http Client
homepage: https://github.com/actions/toolkit/tree/main/packages/http-client homepage: https://github.com/actions/toolkit/tree/main/packages/http-client
license: mit license: other
licenses: licenses:
- sources: LICENSE - sources: LICENSE
text: | text: |
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@actions/io" name: "@actions/io"
version: 2.0.0 version: 3.0.2
type: npm type: npm
summary: Actions io lib summary: Actions io lib
homepage: https://github.com/actions/toolkit/tree/main/packages/io homepage: https://github.com/actions/toolkit/tree/main/packages/io
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@actions/tool-cache" name: "@actions/tool-cache"
version: 3.0.1 version: 4.0.0
type: npm type: npm
summary: Actions tool-cache lib summary: Actions tool-cache lib
homepage: https://github.com/actions/toolkit/tree/main/packages/tool-cache homepage: https://github.com/actions/toolkit/tree/main/packages/tool-cache
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@azure/core-http-compat" name: "@azure/core-http-compat"
version: 2.3.1 version: 2.4.0
type: npm type: npm
summary: Core HTTP Compatibility Library to bridge the gap between Core V1 & V2 packages. summary: Core HTTP Compatibility Library to bridge the gap between Core V1 & V2 packages.
homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-compat/ homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-compat/
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@azure/core-rest-pipeline" name: "@azure/core-rest-pipeline"
version: 1.22.2 version: 1.23.0
type: npm type: npm
summary: Isomorphic client library for making HTTP requests in node.js and browser. summary: Isomorphic client library for making HTTP requests in node.js and browser.
homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-rest-pipeline/ homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-rest-pipeline/
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@azure/core-xml" name: "@azure/core-xml"
version: 1.5.0 version: 1.5.1
type: npm type: npm
summary: Core library for interacting with XML payloads summary: Core library for interacting with XML payloads
homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-xml/ homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/core-xml/
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@azure/storage-blob" name: "@azure/storage-blob"
version: 12.29.1 version: 12.31.0
type: npm type: npm
summary: Microsoft Azure Storage SDK for JavaScript - Blob summary: Microsoft Azure Storage SDK for JavaScript - Blob
homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-blob/ homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-blob/
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@azure/storage-common" name: "@azure/storage-common"
version: 12.1.1 version: 12.3.0
type: npm type: npm
summary: Azure Storage Common Client Library for JavaScript summary: Azure Storage Common Client Library for JavaScript
homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-internal-avro/ homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/storage/storage-internal-avro/
-30
View File
@@ -1,30 +0,0 @@
---
name: "@fastify/busboy"
version: 2.1.1
type: npm
summary: A streaming parser for HTML form data for node.js
homepage:
license: mit
licenses:
- sources: LICENSE
text: |-
Copyright Brian White. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
IN THE SOFTWARE.
notices: []
+11
View File
@@ -0,0 +1,11 @@
---
name: "@nodable/entities"
version: 2.1.0
type: npm
summary: Entity parser for XML, HTML, External entites with security and NCR control
homepage:
license: mit
licenses:
- sources: README.md
text: MIT
notices: []
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@octokit/auth-token" name: "@octokit/auth-token"
version: 4.0.0 version: 6.0.0
type: npm type: npm
summary: GitHub API token authentication for browsers and Node.js summary: GitHub API token authentication for browsers and Node.js
homepage: homepage:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@octokit/core" name: "@octokit/core"
version: 5.2.2 version: 7.0.6
type: npm type: npm
summary: Extendable client for GitHub's REST & GraphQL APIs summary: Extendable client for GitHub's REST & GraphQL APIs
homepage: homepage:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@octokit/endpoint" name: "@octokit/endpoint"
version: 9.0.6 version: 11.0.3
type: npm type: npm
summary: Turns REST API endpoints into generic request options summary: Turns REST API endpoints into generic request options
homepage: homepage:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@octokit/graphql" name: "@octokit/graphql"
version: 7.1.1 version: 9.0.3
type: npm type: npm
summary: GitHub GraphQL API client for browsers and Node summary: GitHub GraphQL API client for browsers and Node
homepage: homepage:
@@ -1,14 +1,14 @@
--- ---
name: "@octokit/openapi-types" name: "@octokit/openapi-types"
version: 20.0.0 version: 27.0.0
type: npm type: npm
summary: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com summary: Generated TypeScript definitions based on GitHub's OpenAPI spec for api.github.com
homepage: homepage:
license: mit license: mit
licenses: licenses:
- sources: LICENSE - sources: LICENSE
text: |- text: |
Copyright 2020 Gregor Martynus Copyright (c) GitHub 2025 - Licensed as MIT.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@octokit/plugin-paginate-rest" name: "@octokit/plugin-paginate-rest"
version: 9.2.2 version: 14.0.0
type: npm type: npm
summary: Octokit plugin to paginate REST API endpoint responses summary: Octokit plugin to paginate REST API endpoint responses
homepage: homepage:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@octokit/plugin-rest-endpoint-methods" name: "@octokit/plugin-rest-endpoint-methods"
version: 10.4.1 version: 17.0.0
type: npm type: npm
summary: Octokit plugin adding one method for all of api.github.com REST API endpoints summary: Octokit plugin adding one method for all of api.github.com REST API endpoints
homepage: homepage:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@octokit/request-error" name: "@octokit/request-error"
version: 5.1.1 version: 7.1.0
type: npm type: npm
summary: Error class for Octokit request errors summary: Error class for Octokit request errors
homepage: homepage:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@octokit/request" name: "@octokit/request"
version: 8.4.1 version: 10.0.8
type: npm type: npm
summary: Send parameterized requests to GitHub's APIs with sensible defaults in browsers summary: Send parameterized requests to GitHub's APIs with sensible defaults in browsers
and Node and Node
-20
View File
@@ -1,20 +0,0 @@
---
name: "@octokit/types"
version: 13.10.0
type: npm
summary: Shared TypeScript definitions for Octokit projects
homepage:
license: mit
licenses:
- sources: LICENSE
text: |
MIT License Copyright (c) 2019 Octokit contributors
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
- sources: README.md
text: "[MIT](LICENSE)"
notices: []
@@ -1,6 +1,6 @@
--- ---
name: "@octokit/types" name: "@octokit/types"
version: 12.6.0 version: 16.0.0
type: npm type: npm
summary: Shared TypeScript definitions for Octokit projects summary: Shared TypeScript definitions for Octokit projects
homepage: homepage:
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: "@typespec/ts-http-runtime" name: "@typespec/ts-http-runtime"
version: 0.3.2 version: 0.3.5
type: npm type: npm
summary: Isomorphic client library for making HTTP requests in node.js and browser. summary: Isomorphic client library for making HTTP requests in node.js and browser.
homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/ts-http-runtime/ homepage: https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/core/ts-http-runtime/
+34
View File
@@ -0,0 +1,34 @@
---
name: balanced-match
version: 4.0.4
type: npm
summary: Match balanced character pairs, like "{" and "}"
homepage:
license: other
licenses:
- sources: LICENSE.md
text: |
(MIT)
Original code Copyright Julian Gruber <julian@juliangruber.com>
Port to TypeScript Copyright Isaac Z. Schlueter <i@izs.me>
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
notices: []
+2 -2
View File
@@ -1,9 +1,9 @@
--- ---
name: before-after-hook name: before-after-hook
version: 2.2.3 version: 4.0.0
type: npm type: npm
summary: asynchronous before/error/after hooks for internal functionality summary: asynchronous before/error/after hooks for internal functionality
homepage: homepage:
license: apache-2.0 license: apache-2.0
licenses: licenses:
- sources: LICENSE - sources: LICENSE
@@ -1,16 +1,18 @@
--- ---
name: "@azure/abort-controller" name: brace-expansion
version: 1.1.0 version: 5.0.6
type: npm type: npm
summary: Microsoft Azure SDK for JavaScript - Aborter summary: Brace expansion as known from sh/bash
homepage: https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/core/abort-controller/README.md homepage:
license: mit license: other
licenses: licenses:
- sources: LICENSE - sources: LICENSE
text: | text: |
The MIT License (MIT) MIT License
Copyright (c) 2020 Microsoft Copyright Julian Gruber <julian@juliangruber.com>
TypeScript port Copyright Isaac Z. Schlueter <i@izs.me>
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal
-28
View File
@@ -1,28 +0,0 @@
---
name: deprecation
version: 2.3.1
type: npm
summary: Log a deprecation message with stack
homepage: https://github.com/gr2m/deprecation#readme
license: isc
licenses:
- sources: LICENSE
text: |
The ISC License
Copyright (c) Gregor Martynus and contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- sources: README.md
text: "[ISC](LICENSE)"
notices: []
+37
View File
@@ -0,0 +1,37 @@
---
name: fast-content-type-parse
version: 3.0.0
type: npm
summary: Parse HTTP Content-Type header according to RFC 7231
homepage: https://github.com/fastify/fast-content-type-parse#readme
license: other
licenses:
- sources: LICENSE
text: |-
MIT License
Copyright (c) 2023 The Fastify Team
The Fastify team members are listed at https://github.com/fastify/fastify#team
and in the README file.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
- sources: README.md
text: Licensed under [MIT](./LICENSE).
notices: []
+2 -2
View File
@@ -1,9 +1,9 @@
--- ---
name: fast-xml-builder name: fast-xml-builder
version: 1.1.4 version: 1.2.0
type: npm type: npm
summary: Build XML from JSON without C/C++ based libraries summary: Build XML from JSON without C/C++ based libraries
homepage: homepage:
license: mit license: mit
licenses: licenses:
- sources: LICENSE - sources: LICENSE
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: fast-xml-parser name: fast-xml-parser
version: 5.5.11 version: 5.7.2
type: npm type: npm
summary: Validate XML, Parse XML, Build XML without C/C++ based libraries summary: Validate XML, Parse XML, Build XML without C/C++ based libraries
homepage: homepage:
@@ -1,16 +1,17 @@
--- ---
name: undici name: json-with-bigint
version: 6.24.1 version: 3.5.8
type: npm type: npm
summary: An HTTP/1.1 client, written from scratch for Node.js summary: JS library that allows you to easily serialize and deserialize data with
homepage: https://undici.nodejs.org BigInt values
homepage:
license: mit license: mit
licenses: licenses:
- sources: LICENSE - sources: LICENSE
text: | text: |
MIT License MIT License
Copyright (c) Matteo Collina and Undici contributors Copyright (c) 2023 Ivan Korolenko
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal
@@ -29,6 +30,4 @@ licenses:
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE. SOFTWARE.
- sources: README.md
text: MIT
notices: [] notices: []
+66
View File
@@ -0,0 +1,66 @@
---
name: minimatch
version: 10.2.5
type: npm
summary: a glob matcher in javascript
homepage:
license: blueoak-1.0.0
licenses:
- sources: LICENSE.md
text: |
# Blue Oak Model License
Version 1.0.0
## Purpose
This license gives everyone as much permission to work with
this software as possible, while protecting contributors
from liability.
## Acceptance
In order to receive this license, you must agree to its
rules. The rules of this license are both obligations
under that agreement and conditions to your license.
You must not do anything with this software that triggers
a rule that you cannot or will not follow.
## Copyright
Each contributor licenses you to do everything with this
software that would otherwise infringe that contributor's
copyright in it.
## Notices
You must ensure that everyone who gets a copy of
any part of this software from you, with or without
changes, also gets the text of this license or a link to
<https://blueoakcouncil.org/license/1.0.0>.
## Excuse
If anyone notifies you in writing that you have not
complied with [Notices](#notices), you can keep your
license by taking all practical steps to comply within 30
days after the notice. If you do not do so, your license
ends immediately.
## Patent
Each contributor licenses you to do everything with this
software that would otherwise infringe any patent claims
they can license or become able to license.
## Reliability
No contributor can revoke this license.
## No Liability
**_As far as the law allows, this software comes as is,
without any warranty or condition, and no contributor
will be liable to anyone for any damages related to this
software or this license, under any kind of legal claim._**
notices: []
-26
View File
@@ -1,26 +0,0 @@
---
name: once
version: 1.4.0
type: npm
summary: Run a function exactly one time
homepage: https://github.com/isaacs/once#readme
license: isc
licenses:
- sources: LICENSE
text: |
The ISC License
Copyright (c) Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
notices: []
+1 -1
View File
@@ -1,6 +1,6 @@
--- ---
name: path-expression-matcher name: path-expression-matcher
version: 1.4.0 version: 1.5.0
type: npm type: npm
summary: Efficient path tracking and pattern matching for XML/JSON parsers summary: Efficient path tracking and pattern matching for XML/JSON parsers
homepage: https://github.com/NaturalIntelligence/path-expression-matcher#readme homepage: https://github.com/NaturalIntelligence/path-expression-matcher#readme
-26
View File
@@ -1,26 +0,0 @@
---
name: semver
version: 6.3.1
type: npm
summary: The semantic version parser used by npm.
homepage:
license: isc
licenses:
- sources: LICENSE
text: |
The ISC License
Copyright (c) Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
notices: []
@@ -1,6 +1,6 @@
--- ---
name: semver name: semver
version: 7.7.3 version: 7.8.5
type: npm type: npm
summary: The semantic version parser used by npm. summary: The semantic version parser used by npm.
homepage: homepage:
@@ -1,6 +1,6 @@
--- ---
name: undici name: undici
version: 5.29.0 version: 6.27.0
type: npm type: npm
summary: An HTTP/1.1 client, written from scratch for Node.js summary: An HTTP/1.1 client, written from scratch for Node.js
homepage: https://undici.nodejs.org homepage: https://undici.nodejs.org
+3 -3
View File
@@ -1,8 +1,8 @@
--- ---
name: universal-user-agent name: universal-user-agent
version: 6.0.1 version: 7.0.3
type: npm type: npm
summary: Get a user agent string in both browser and node summary: Get a user agent string across all JavaScript Runtime Environments
homepage: homepage:
license: isc license: isc
licenses: licenses:
@@ -10,7 +10,7 @@ licenses:
text: | text: |
# [ISC License](https://spdx.org/licenses/ISC) # [ISC License](https://spdx.org/licenses/ISC)
Copyright (c) 2018, Gregor Martynus (https://github.com/gr2m) Copyright (c) 2018-2021, Gregor Martynus (https://github.com/gr2m)
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
-26
View File
@@ -1,26 +0,0 @@
---
name: wrappy
version: 1.0.2
type: npm
summary: Callback wrapping utility
homepage: https://github.com/npm/wrappy
license: isc
licenses:
- sources: LICENSE
text: |
The ISC License
Copyright (c) Isaac Z. Schlueter and Contributors
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
notices: []
+12
View File
@@ -0,0 +1,12 @@
---
name: xml-naming
version: 0.1.0
type: npm
summary: Validates XML name productions — Name, NCName, QName, NMToken, NMTokens —
for XML 1.0 and 1.1
homepage:
license: mit
licenses:
- sources: README.md
text: MIT
notices: []
-11
View File
@@ -1,11 +0,0 @@
// This is a reusable configuration file copied from https://github.com/actions/reusable-workflows/tree/main/reusable-configurations. Please don't make changes to this file as it's the subject of an automatic update.
module.exports = {
printWidth: 80,
tabWidth: 2,
useTabs: false,
semi: true,
singleQuote: true,
trailingComma: 'none',
bracketSpacing: false,
arrowParens: 'avoid'
};
+10
View File
@@ -0,0 +1,10 @@
{
"printWidth": 80,
"tabWidth": 2,
"useTabs": false,
"semi": true,
"singleQuote": true,
"trailingComma": "none",
"bracketSpacing": false,
"arrowParens": "avoid"
}
+8
View File
@@ -12,6 +12,10 @@ This action provides the following functionality for GitHub Actions users:
- Registering problem matchers for error output - Registering problem matchers for error output
- Configuring authentication for GPR or npm - Configuring authentication for GPR or npm
## Breaking changes in V7
- **Migrated to ESM** to enable support for the latest `@actions/*` package versions.
## Breaking changes in V6 ## Breaking changes in V6
- Caching is now automatically enabled for npm projects when either the `devEngines.packageManager` field or the top-level `packageManager` field in `package.json` is set to `npm`. For other package managers, such as Yarn and pnpm, caching is disabled by default and must be configured manually using the `cache` input. - Caching is now automatically enabled for npm projects when either the `devEngines.packageManager` field or the top-level `packageManager` field in `package.json` is set to `npm`. For other package managers, such as Yarn and pnpm, caching is disabled by default and must be configured manually using the `cache` input.
@@ -119,6 +123,7 @@ steps:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
node-version: 24 node-version: 24
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -217,6 +222,7 @@ jobs:
uses: actions/setup-node@v6 uses: actions/setup-node@v6
with: with:
node-version: ${{ matrix.node }} node-version: ${{ matrix.node }}
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -232,6 +238,7 @@ uses: actions/setup-node@v6
with: with:
token: ${{ secrets.GH_DOTCOM_TOKEN }} token: ${{ secrets.GH_DOTCOM_TOKEN }}
node-version: 24 node-version: 24
package-manager-cache: false # Disable automatic npm caching if not required
``` ```
If the runner is not able to access github.com, any Nodejs versions requested during a workflow run must come from the runner's tool cache. See "[Setting up the tool cache on self-hosted runners without internet access](https://docs.github.com/en/enterprise-server@3.2/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)" for more information. If the runner is not able to access github.com, any Nodejs versions requested during a workflow run must come from the runner's tool cache. See "[Setting up the tool cache on self-hosted runners without internet access](https://docs.github.com/en/enterprise-server@3.2/admin/github-actions/managing-access-to-actions-from-githubcom/setting-up-the-tool-cache-on-self-hosted-runners-without-internet-access)" for more information.
@@ -249,6 +256,7 @@ If the runner is not able to access github.com, any Nodejs versions requested du
- [Publishing to npmjs and GPR with npm](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-npm) - [Publishing to npmjs and GPR with npm](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-npm)
- [Publishing to npmjs and GPR with yarn](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-yarn) - [Publishing to npmjs and GPR with yarn](docs/advanced-usage.md#publish-to-npmjs-and-gpr-with-yarn)
- [Using private packages](docs/advanced-usage.md#use-private-packages) - [Using private packages](docs/advanced-usage.md#use-private-packages)
- [Publishing to npm with Trusted Publisher (OIDC)](docs/advanced-usage.md#publishing-to-npm-with-trusted-publisher-oidc)
- [Using private mirror](docs/advanced-usage.md#use-private-mirror) - [Using private mirror](docs/advanced-usage.md#use-private-mirror)
## Recommended permissions ## Recommended permissions
+69 -19
View File
@@ -1,19 +1,57 @@
import {
jest,
describe,
it,
expect,
beforeAll,
beforeEach,
afterAll
} from '@jest/globals';
import {fileURLToPath} from 'url';
import os from 'os'; import os from 'os';
import fs from 'fs'; import fs from 'fs';
import * as path from 'path'; import * as path from 'path';
import * as core from '@actions/core';
import * as io from '@actions/io'; import * as io from '@actions/io';
import * as auth from '../src/authutil';
import * as cacheUtils from '../src/cache-utils'; const __dirname = path.dirname(fileURLToPath(import.meta.url));
jest.unstable_mockModule('@actions/core', () => ({
info: jest.fn(),
warning: jest.fn(),
debug: jest.fn(),
error: jest.fn(),
notice: jest.fn(),
setFailed: jest.fn(),
setOutput: jest.fn(),
getInput: jest.fn((name: string) => {
const val =
process.env[`INPUT_${name.replace(/ /g, '_').toUpperCase()}`] || '';
return val.trim();
}),
getBooleanInput: jest.fn(),
getMultilineInput: jest.fn(),
addPath: jest.fn(),
exportVariable: jest.fn(),
saveState: jest.fn(),
getState: jest.fn(),
setSecret: jest.fn(),
isDebug: jest.fn(() => false),
startGroup: jest.fn(),
endGroup: jest.fn(),
group: jest.fn((_name: string, fn: () => Promise<unknown>) => fn())
}));
// Dynamic imports AFTER mocking so authutil sees the mocked core.
const core = await import('@actions/core');
const auth = await import('../src/authutil.js');
let rcFile: string; let rcFile: string;
describe('authutil tests', () => { describe('authutil tests', () => {
const _runnerDir = path.join(__dirname, 'runner'); const _runnerDir = path.join(__dirname, 'runner');
let cnSpy: jest.SpyInstance; let cnSpy: jest.SpiedFunction<typeof process.stdout.write>;
let logSpy: jest.SpyInstance; let logSpy: jest.SpiedFunction<typeof console.log>;
let dbgSpy: jest.SpyInstance;
beforeAll(async () => { beforeAll(async () => {
const randPath = path.join(Math.random().toString(36).substring(7)); const randPath = path.join(Math.random().toString(36).substring(7));
@@ -37,19 +75,8 @@ describe('authutil tests', () => {
// writes // writes
cnSpy = jest.spyOn(process.stdout, 'write'); cnSpy = jest.spyOn(process.stdout, 'write');
logSpy = jest.spyOn(console, 'log'); logSpy = jest.spyOn(console, 'log');
dbgSpy = jest.spyOn(core, 'debug'); cnSpy.mockImplementation(() => true);
cnSpy.mockImplementation(line => { logSpy.mockImplementation(() => {});
// uncomment to debug
// process.stderr.write('write:' + line + '\n');
});
logSpy.mockImplementation(line => {
// uncomment to debug
// process.stderr.write('log:' + line + '\n');
});
dbgSpy.mockImplementation(msg => {
// uncomment to see debug output
// process.stderr.write(msg + '\n');
});
}, 100000); }, 100000);
function dbg(message: string) { function dbg(message: string) {
@@ -118,6 +145,29 @@ describe('authutil tests', () => {
expect(process.env.NODE_AUTH_TOKEN).toEqual('foobar'); expect(process.env.NODE_AUTH_TOKEN).toEqual('foobar');
}); });
it('should not export NODE_AUTH_TOKEN if not set in environment', async () => {
const exportSpy = core.exportVariable as jest.Mock;
exportSpy.mockClear();
delete process.env.NODE_AUTH_TOKEN;
await auth.configAuthentication('https://registry.npmjs.org/');
expect(fs.statSync(rcFile)).toBeDefined();
const rc = readRcFile(rcFile);
expect(rc['registry']).toBe('https://registry.npmjs.org/');
expect(exportSpy).not.toHaveBeenCalledWith(
'NODE_AUTH_TOKEN',
expect.anything()
);
});
it('should export NODE_AUTH_TOKEN if set to empty string', async () => {
const exportSpy = core.exportVariable as jest.Mock;
exportSpy.mockClear();
process.env.NODE_AUTH_TOKEN = '';
await auth.configAuthentication('https://registry.npmjs.org/');
expect(fs.statSync(rcFile)).toBeDefined();
expect(exportSpy).toHaveBeenCalledWith('NODE_AUTH_TOKEN', '');
});
it('configAuthentication should overwrite non-scoped with non-scoped', async () => { it('configAuthentication should overwrite non-scoped with non-scoped', async () => {
fs.writeFileSync(rcFile, 'registry=NNN'); fs.writeFileSync(rcFile, 'registry=NNN');
await auth.configAuthentication('https://registry.npmjs.org/'); await auth.configAuthentication('https://registry.npmjs.org/');
+142 -68
View File
@@ -1,11 +1,67 @@
import * as core from '@actions/core'; import {jest, describe, it, expect, beforeEach, afterEach} from '@jest/globals';
import * as cache from '@actions/cache'; import {fileURLToPath} from 'url';
import * as path from 'path'; import * as path from 'path';
import * as glob from '@actions/glob';
import osm from 'os'; import osm from 'os';
import * as utils from '../src/cache-utils'; const __dirname = path.dirname(fileURLToPath(import.meta.url));
import {restoreCache} from '../src/cache-restore';
// Mock @actions modules before importing anything that depends on them
jest.unstable_mockModule('@actions/core', () => ({
info: jest.fn(),
warning: jest.fn(),
debug: jest.fn(),
error: jest.fn(),
notice: jest.fn(),
setFailed: jest.fn(),
setOutput: jest.fn(),
getInput: jest.fn(),
getBooleanInput: jest.fn(),
getMultilineInput: jest.fn(),
addPath: jest.fn(),
exportVariable: jest.fn(),
saveState: jest.fn(),
getState: jest.fn(),
setSecret: jest.fn(),
isDebug: jest.fn(() => false),
startGroup: jest.fn(),
endGroup: jest.fn(),
group: jest.fn((_name: string, fn: () => Promise<unknown>) => fn()),
toPlatformPath: jest.fn((p: string) => p),
toWin32Path: jest.fn((p: string) => p),
toPosixPath: jest.fn((p: string) => p)
}));
jest.unstable_mockModule('@actions/cache', () => ({
saveCache: jest.fn(),
restoreCache: jest.fn(),
isFeatureAvailable: jest.fn()
}));
jest.unstable_mockModule('@actions/glob', () => ({
hashFiles: jest.fn(),
create: jest.fn()
}));
jest.unstable_mockModule('@actions/exec', () => ({
exec: jest.fn(),
getExecOutput: jest.fn()
}));
jest.unstable_mockModule('@actions/io', () => ({
which: jest.fn(),
mkdirP: jest.fn(),
rmRF: jest.fn(),
mv: jest.fn(),
cp: jest.fn()
}));
// Dynamic imports after mocking
const core = await import('@actions/core');
const cache = await import('@actions/cache');
const glob = await import('@actions/glob');
const exec = await import('@actions/exec');
const utils = await import('../src/cache-utils.js');
const {restoreCache} = await import('../src/cache-restore.js');
describe('cache-restore', () => { describe('cache-restore', () => {
const packageManagers = ['yarn', 'npm', 'pnpm'] as const; const packageManagers = ['yarn', 'npm', 'pnpm'] as const;
@@ -53,64 +109,66 @@ describe('cache-restore', () => {
} }
} }
let saveStateSpy: jest.SpyInstance; let saveStateSpy: jest.Mock;
let infoSpy: jest.SpyInstance; let infoSpy: jest.Mock;
let debugSpy: jest.SpyInstance; let debugSpy: jest.Mock;
let setOutputSpy: jest.SpyInstance; let setOutputSpy: jest.Mock;
let getCommandOutputSpy: jest.SpyInstance; let getExecOutputSpy: jest.Mock;
let restoreCacheSpy: jest.SpyInstance; let restoreCacheSpy: jest.Mock;
let hashFilesSpy: jest.SpyInstance; let hashFilesSpy: jest.Mock;
let archSpy: jest.SpyInstance; let archSpy: jest.SpiedFunction<typeof osm.arch>;
beforeEach(() => { beforeEach(() => {
// core // core
infoSpy = jest.spyOn(core, 'info'); infoSpy = core.info as jest.Mock;
infoSpy.mockImplementation(() => undefined); infoSpy.mockImplementation(() => undefined);
debugSpy = jest.spyOn(core, 'debug'); debugSpy = core.debug as jest.Mock;
debugSpy.mockImplementation(() => undefined); debugSpy.mockImplementation(() => undefined);
setOutputSpy = jest.spyOn(core, 'setOutput'); setOutputSpy = core.setOutput as jest.Mock;
setOutputSpy.mockImplementation(() => undefined); setOutputSpy.mockImplementation(() => undefined);
saveStateSpy = jest.spyOn(core, 'saveState'); saveStateSpy = core.saveState as jest.Mock;
saveStateSpy.mockImplementation(() => undefined); saveStateSpy.mockImplementation(() => undefined);
// glob // glob
hashFilesSpy = jest.spyOn(glob, 'hashFiles'); hashFilesSpy = glob.hashFiles as jest.Mock;
hashFilesSpy.mockImplementation((pattern: string) => { (hashFilesSpy as jest.Mock<typeof glob.hashFiles>).mockImplementation(
if (pattern.includes('package-lock.json')) { async (pattern: string) => {
return npmFileHash; if (pattern.includes('package-lock.json')) {
} else if (pattern.includes('pnpm-lock.yaml')) { return npmFileHash;
return pnpmFileHash; } else if (pattern.includes('pnpm-lock.yaml')) {
} else if (pattern.includes('yarn.lock')) { return pnpmFileHash;
return yarnFileHash; } else if (pattern.includes('yarn.lock')) {
} else { return yarnFileHash;
return ''; } else {
} return '';
});
// cache
restoreCacheSpy = jest.spyOn(cache, 'restoreCache');
restoreCacheSpy.mockImplementation(
(cachePaths: Array<string>, key: string) => {
if (!cachePaths || cachePaths.length === 0) {
return undefined;
} }
const cachPath = cachePaths[0];
const fileHash = cachesObject[cachPath];
if (key.includes(fileHash)) {
return key;
}
return undefined;
} }
); );
// cache-utils // cache
getCommandOutputSpy = jest.spyOn(utils, 'getCommandOutput'); restoreCacheSpy = cache.restoreCache as jest.Mock;
(
restoreCacheSpy as jest.Mock<typeof cache.restoreCache>
).mockImplementation(async (cachePaths: string[], key: string) => {
if (!cachePaths || cachePaths.length === 0) {
return undefined;
}
const cachPath = cachePaths[0];
const fileHash = cachesObject[cachPath];
if (key.includes(fileHash)) {
return key;
}
return undefined;
});
// exec
getExecOutputSpy = exec.getExecOutput as jest.Mock;
// os // os
archSpy = jest.spyOn(osm, 'arch'); archSpy = jest.spyOn(osm, 'arch');
@@ -134,28 +192,36 @@ describe('cache-restore', () => {
['yarn', '1.2.3', yarnFileHash], ['yarn', '1.2.3', yarnFileHash],
['npm', '', npmFileHash], ['npm', '', npmFileHash],
['pnpm', '', pnpmFileHash] ['pnpm', '', pnpmFileHash]
] as const)( ])(
'restored dependencies for %s', 'restored dependencies for %s',
async (packageManager, toolVersion, fileHash) => { async (packageManager, toolVersion, fileHash) => {
// Set workspace to the appropriate fixture folder const expectedCacheKey = `node-cache-${platform}-${arch}-${packageManager}-${fileHash}`;
setWorkspaceFor(packageManager); setWorkspaceFor(packageManager as PackageManager);
getCommandOutputSpy.mockImplementation((command: string) => { getExecOutputSpy.mockImplementation(async (command: any) => ({
if (command.includes('version')) { stdout: command.includes('version')
return toolVersion; ? toolVersion
} else { : findCacheFolder(command),
return findCacheFolder(command); stderr: '',
} exitCode: 0
}); }));
await restoreCache(packageManager, ''); await restoreCache(packageManager, '');
expect(hashFilesSpy).toHaveBeenCalled(); expect(hashFilesSpy).toHaveBeenCalled();
expect(infoSpy).toHaveBeenCalledWith( expect(infoSpy).toHaveBeenCalledWith(
`Cache restored from key: node-cache-${platform}-${arch}-${packageManager}-${fileHash}` `Cache restored from key: ${expectedCacheKey}`
); );
expect(infoSpy).not.toHaveBeenCalledWith( expect(infoSpy).not.toHaveBeenCalledWith(
`${packageManager} cache is not found` `${packageManager} cache is not found`
); );
expect(setOutputSpy).toHaveBeenCalledWith('cache-hit', true); expect(setOutputSpy).toHaveBeenCalledWith('cache-hit', true);
expect(setOutputSpy).toHaveBeenCalledWith(
'cache-primary-key',
expectedCacheKey
);
expect(setOutputSpy).toHaveBeenCalledWith(
'cache-matched-key',
expectedCacheKey
);
} }
); );
}); });
@@ -166,18 +232,18 @@ describe('cache-restore', () => {
['yarn', '1.2.3', yarnFileHash], ['yarn', '1.2.3', yarnFileHash],
['npm', '', npmFileHash], ['npm', '', npmFileHash],
['pnpm', '', pnpmFileHash] ['pnpm', '', pnpmFileHash]
] as const)( ])(
'dependencies are changed %s', 'dependencies are changed %s',
async (packageManager, toolVersion, fileHash) => { async (packageManager, toolVersion, fileHash) => {
// Set workspace to the appropriate fixture folder const expectedCacheKey = `node-cache-${platform}-${arch}-${packageManager}-${fileHash}`;
setWorkspaceFor(packageManager); setWorkspaceFor(packageManager as PackageManager);
getCommandOutputSpy.mockImplementation((command: string) => { getExecOutputSpy.mockImplementation(async (command: any) => ({
if (command.includes('version')) { stdout: command.includes('version')
return toolVersion; ? toolVersion
} else { : findCacheFolder(command),
return findCacheFolder(command); stderr: '',
} exitCode: 0
}); }));
restoreCacheSpy.mockImplementationOnce(() => undefined); restoreCacheSpy.mockImplementationOnce(() => undefined);
await restoreCache(packageManager, ''); await restoreCache(packageManager, '');
@@ -186,6 +252,14 @@ describe('cache-restore', () => {
`${packageManager} cache is not found` `${packageManager} cache is not found`
); );
expect(setOutputSpy).toHaveBeenCalledWith('cache-hit', false); expect(setOutputSpy).toHaveBeenCalledWith('cache-hit', false);
expect(setOutputSpy).toHaveBeenCalledWith(
'cache-primary-key',
expectedCacheKey
);
expect(setOutputSpy).toHaveBeenCalledWith(
'cache-matched-key',
undefined
);
} }
); );
}); });
+118 -52
View File
@@ -1,12 +1,74 @@
import * as core from '@actions/core'; import {jest, describe, it, expect, beforeEach, afterEach} from '@jest/globals';
import * as cache from '@actions/cache'; import {fileURLToPath} from 'url';
import * as glob from '@actions/glob';
import fs from 'fs';
import path from 'path'; import path from 'path';
import fs from 'fs';
import * as utils from '../src/cache-utils'; const __dirname = path.dirname(fileURLToPath(import.meta.url));
import {run} from '../src/cache-save';
import {State} from '../src/constants'; // Mock @actions modules before importing anything that depends on them
jest.unstable_mockModule('@actions/core', () => ({
info: jest.fn(),
warning: jest.fn(),
debug: jest.fn(),
error: jest.fn(),
notice: jest.fn(),
setFailed: jest.fn(),
setOutput: jest.fn(),
getInput: jest.fn(),
getBooleanInput: jest.fn(),
getMultilineInput: jest.fn(),
addPath: jest.fn(),
exportVariable: jest.fn(),
saveState: jest.fn(),
getState: jest.fn(),
setSecret: jest.fn(),
isDebug: jest.fn(() => false),
startGroup: jest.fn(),
endGroup: jest.fn(),
group: jest.fn((_name: string, fn: () => Promise<unknown>) => fn()),
toPlatformPath: jest.fn((p: string) => p),
toWin32Path: jest.fn((p: string) => p),
toPosixPath: jest.fn((p: string) => p)
}));
jest.unstable_mockModule('@actions/cache', () => ({
saveCache: jest.fn(),
restoreCache: jest.fn(),
isFeatureAvailable: jest.fn(),
ValidationError: class ValidationError extends Error {
constructor(message: string) {
super(message);
this.name = 'ValidationError';
}
}
}));
jest.unstable_mockModule('@actions/glob', () => ({
hashFiles: jest.fn(),
create: jest.fn()
}));
jest.unstable_mockModule('@actions/exec', () => ({
exec: jest.fn(),
getExecOutput: jest.fn()
}));
jest.unstable_mockModule('@actions/io', () => ({
which: jest.fn(),
mkdirP: jest.fn(),
rmRF: jest.fn(),
mv: jest.fn(),
cp: jest.fn()
}));
// Dynamic imports after mocking
const core = await import('@actions/core');
const cache = await import('@actions/cache');
const glob = await import('@actions/glob');
const exec = await import('@actions/exec');
const utils = await import('../src/cache-utils.js');
const {run} = await import('../src/cache-save.js');
const {State} = await import('../src/constants.js');
describe('run', () => { describe('run', () => {
const yarnFileHash = const yarnFileHash =
@@ -20,42 +82,42 @@ describe('run', () => {
const inputs = {} as any; const inputs = {} as any;
let getInputSpy: jest.SpyInstance; let getInputSpy: jest.Mock;
let infoSpy: jest.SpyInstance; let infoSpy: jest.Mock;
let warningSpy: jest.SpyInstance; let warningSpy: jest.Mock;
let debugSpy: jest.SpyInstance; let debugSpy: jest.Mock;
let setFailedSpy: jest.SpyInstance; let setFailedSpy: jest.Mock;
let getStateSpy: jest.SpyInstance; let getStateSpy: jest.Mock;
let saveCacheSpy: jest.SpyInstance; let saveCacheSpy: jest.Mock;
let getCommandOutputSpy: jest.SpyInstance; let getExecOutputSpy: jest.Mock;
let hashFilesSpy: jest.SpyInstance; let hashFilesSpy: jest.Mock;
let existsSpy: jest.SpyInstance; let existsSpy: jest.SpiedFunction<typeof fs.existsSync>;
beforeEach(() => { beforeEach(() => {
getInputSpy = jest.spyOn(core, 'getInput'); getInputSpy = core.getInput as jest.Mock;
getInputSpy.mockImplementation((name: string) => inputs[name]); getInputSpy.mockImplementation((name: any) => inputs[name]);
infoSpy = jest.spyOn(core, 'info'); infoSpy = core.info as jest.Mock;
infoSpy.mockImplementation(() => undefined); infoSpy.mockImplementation(() => undefined);
warningSpy = jest.spyOn(core, 'warning'); warningSpy = core.warning as jest.Mock;
warningSpy.mockImplementation(() => undefined); warningSpy.mockImplementation(() => undefined);
setFailedSpy = jest.spyOn(core, 'setFailed'); setFailedSpy = core.setFailed as jest.Mock;
setFailedSpy.mockImplementation(() => undefined); setFailedSpy.mockImplementation(() => undefined);
debugSpy = jest.spyOn(core, 'debug'); debugSpy = core.debug as jest.Mock;
debugSpy.mockImplementation(() => undefined); debugSpy.mockImplementation(() => undefined);
getStateSpy = jest.spyOn(core, 'getState'); getStateSpy = core.getState as jest.Mock;
// cache // cache
saveCacheSpy = jest.spyOn(cache, 'saveCache'); saveCacheSpy = cache.saveCache as jest.Mock;
saveCacheSpy.mockImplementation(() => undefined); saveCacheSpy.mockImplementation(() => undefined);
// glob // glob
hashFilesSpy = jest.spyOn(glob, 'hashFiles'); hashFilesSpy = glob.hashFiles as jest.Mock;
hashFilesSpy.mockImplementation((pattern: string) => { hashFilesSpy.mockImplementation((pattern: any) => {
if (pattern.includes('package-lock.json')) { if (pattern.includes('package-lock.json')) {
return npmFileHash; return npmFileHash;
} else if (pattern.includes('yarn.lock')) { } else if (pattern.includes('yarn.lock')) {
@@ -68,17 +130,20 @@ describe('run', () => {
existsSpy = jest.spyOn(fs, 'existsSync'); existsSpy = jest.spyOn(fs, 'existsSync');
existsSpy.mockImplementation(() => true); existsSpy.mockImplementation(() => true);
// utils // exec
getCommandOutputSpy = jest.spyOn(utils, 'getCommandOutput'); getExecOutputSpy = exec.getExecOutput as jest.Mock;
}); });
afterEach(() => { afterEach(() => {
existsSpy.mockRestore(); existsSpy.mockRestore();
jest.resetAllMocks();
jest.clearAllMocks();
}); });
describe('Package manager validation', () => { describe('Package manager validation', () => {
it('Package manager is not provided, skip caching', async () => { it('Package manager is not provided, skip caching', async () => {
inputs['cache'] = ''; inputs['cache'] = '';
getStateSpy.mockImplementation(() => '');
await run(); await run();
@@ -124,7 +189,7 @@ describe('run', () => {
expect(getInputSpy).not.toHaveBeenCalled(); expect(getInputSpy).not.toHaveBeenCalled();
expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getStateSpy).toHaveBeenCalledTimes(4);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(getExecOutputSpy).toHaveBeenCalledTimes(0);
expect(debugSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0);
expect(infoSpy).toHaveBeenCalledWith( expect(infoSpy).toHaveBeenCalledWith(
`Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.` `Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
@@ -148,7 +213,7 @@ describe('run', () => {
expect(getInputSpy).not.toHaveBeenCalled(); expect(getInputSpy).not.toHaveBeenCalled();
expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getStateSpy).toHaveBeenCalledTimes(4);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(getExecOutputSpy).toHaveBeenCalledTimes(0);
expect(debugSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0);
expect(infoSpy).toHaveBeenCalledWith( expect(infoSpy).toHaveBeenCalledWith(
`Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.` `Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
@@ -167,13 +232,17 @@ describe('run', () => {
? '["/foo/bar"]' ? '["/foo/bar"]'
: 'not expected' : 'not expected'
); );
getCommandOutputSpy.mockImplementationOnce(() => `${commonPath}/npm`); getExecOutputSpy.mockImplementationOnce(() => ({
stdout: `${commonPath}/npm`,
stderr: '',
exitCode: 0
}));
await run(); await run();
expect(getInputSpy).not.toHaveBeenCalled(); expect(getInputSpy).not.toHaveBeenCalled();
expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getStateSpy).toHaveBeenCalledTimes(4);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(getExecOutputSpy).toHaveBeenCalledTimes(0);
expect(debugSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0);
expect(setFailedSpy).not.toHaveBeenCalled(); expect(setFailedSpy).not.toHaveBeenCalled();
}); });
@@ -194,7 +263,7 @@ describe('run', () => {
expect(getInputSpy).not.toHaveBeenCalled(); expect(getInputSpy).not.toHaveBeenCalled();
expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getStateSpy).toHaveBeenCalledTimes(4);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(getExecOutputSpy).toHaveBeenCalledTimes(0);
expect(debugSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0);
expect(setFailedSpy).not.toHaveBeenCalled(); expect(setFailedSpy).not.toHaveBeenCalled();
}); });
@@ -203,7 +272,7 @@ describe('run', () => {
describe('action saves the cache', () => { describe('action saves the cache', () => {
it('saves cache from yarn 1', async () => { it('saves cache from yarn 1', async () => {
inputs['cache'] = 'yarn'; inputs['cache'] = 'yarn';
getStateSpy.mockImplementation((key: string) => getStateSpy.mockImplementation((key: any) =>
key === State.CachePackageManager key === State.CachePackageManager
? inputs['cache'] ? inputs['cache']
: key === State.CacheMatchedKey : key === State.CacheMatchedKey
@@ -219,7 +288,7 @@ describe('run', () => {
expect(getInputSpy).not.toHaveBeenCalled(); expect(getInputSpy).not.toHaveBeenCalled();
expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getStateSpy).toHaveBeenCalledTimes(4);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(getExecOutputSpy).toHaveBeenCalledTimes(0);
expect(debugSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0);
expect(infoSpy).not.toHaveBeenCalledWith( expect(infoSpy).not.toHaveBeenCalledWith(
`Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.` `Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
@@ -233,7 +302,7 @@ describe('run', () => {
it('saves cache from yarn 2', async () => { it('saves cache from yarn 2', async () => {
inputs['cache'] = 'yarn'; inputs['cache'] = 'yarn';
getStateSpy.mockImplementation((key: string) => getStateSpy.mockImplementation((key: any) =>
key === State.CachePackageManager key === State.CachePackageManager
? inputs['cache'] ? inputs['cache']
: key === State.CacheMatchedKey : key === State.CacheMatchedKey
@@ -249,7 +318,7 @@ describe('run', () => {
expect(getInputSpy).not.toHaveBeenCalled(); expect(getInputSpy).not.toHaveBeenCalled();
expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getStateSpy).toHaveBeenCalledTimes(4);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(getExecOutputSpy).toHaveBeenCalledTimes(0);
expect(debugSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0);
expect(infoSpy).not.toHaveBeenCalledWith( expect(infoSpy).not.toHaveBeenCalledWith(
`Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.` `Cache hit occurred on the primary key ${yarnFileHash}, not saving cache.`
@@ -263,7 +332,7 @@ describe('run', () => {
it('saves cache from npm', async () => { it('saves cache from npm', async () => {
inputs['cache'] = 'npm'; inputs['cache'] = 'npm';
getStateSpy.mockImplementation((key: string) => getStateSpy.mockImplementation((key: any) =>
key === State.CachePackageManager key === State.CachePackageManager
? inputs['cache'] ? inputs['cache']
: key === State.CacheMatchedKey : key === State.CacheMatchedKey
@@ -279,7 +348,7 @@ describe('run', () => {
expect(getInputSpy).not.toHaveBeenCalled(); expect(getInputSpy).not.toHaveBeenCalled();
expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getStateSpy).toHaveBeenCalledTimes(4);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(getExecOutputSpy).toHaveBeenCalledTimes(0);
expect(debugSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0);
expect(infoSpy).not.toHaveBeenCalledWith( expect(infoSpy).not.toHaveBeenCalledWith(
`Cache hit occurred on the primary key ${npmFileHash}, not saving cache.` `Cache hit occurred on the primary key ${npmFileHash}, not saving cache.`
@@ -293,7 +362,7 @@ describe('run', () => {
it('saves cache from pnpm', async () => { it('saves cache from pnpm', async () => {
inputs['cache'] = 'pnpm'; inputs['cache'] = 'pnpm';
getStateSpy.mockImplementation((key: string) => getStateSpy.mockImplementation((key: any) =>
key === State.CachePackageManager key === State.CachePackageManager
? inputs['cache'] ? inputs['cache']
: key === State.CacheMatchedKey : key === State.CacheMatchedKey
@@ -309,7 +378,7 @@ describe('run', () => {
expect(getInputSpy).not.toHaveBeenCalled(); expect(getInputSpy).not.toHaveBeenCalled();
expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getStateSpy).toHaveBeenCalledTimes(4);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(getExecOutputSpy).toHaveBeenCalledTimes(0);
expect(debugSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0);
expect(infoSpy).not.toHaveBeenCalledWith( expect(infoSpy).not.toHaveBeenCalledWith(
`Cache hit occurred on the primary key ${pnpmFileHash}, not saving cache.` `Cache hit occurred on the primary key ${pnpmFileHash}, not saving cache.`
@@ -323,7 +392,7 @@ describe('run', () => {
it('save with -1 cacheId , should not fail workflow', async () => { it('save with -1 cacheId , should not fail workflow', async () => {
inputs['cache'] = 'npm'; inputs['cache'] = 'npm';
getStateSpy.mockImplementation((key: string) => getStateSpy.mockImplementation((key: any) =>
key === State.CachePackageManager key === State.CachePackageManager
? inputs['cache'] ? inputs['cache']
: key === State.CacheMatchedKey : key === State.CacheMatchedKey
@@ -342,8 +411,10 @@ describe('run', () => {
expect(getInputSpy).not.toHaveBeenCalled(); expect(getInputSpy).not.toHaveBeenCalled();
expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getStateSpy).toHaveBeenCalledTimes(4);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(getExecOutputSpy).toHaveBeenCalledTimes(0);
expect(debugSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledWith(
`Cache was not saved for the key: ${yarnFileHash}`
);
expect(infoSpy).not.toHaveBeenCalledWith( expect(infoSpy).not.toHaveBeenCalledWith(
`Cache hit occurred on the primary key ${npmFileHash}, not saving cache.` `Cache hit occurred on the primary key ${npmFileHash}, not saving cache.`
); );
@@ -356,7 +427,7 @@ describe('run', () => {
it('saves with error from toolkit, should fail workflow', async () => { it('saves with error from toolkit, should fail workflow', async () => {
inputs['cache'] = 'npm'; inputs['cache'] = 'npm';
getStateSpy.mockImplementation((key: string) => getStateSpy.mockImplementation((key: any) =>
key === State.CachePackageManager key === State.CachePackageManager
? inputs['cache'] ? inputs['cache']
: key === State.CacheMatchedKey : key === State.CacheMatchedKey
@@ -375,7 +446,7 @@ describe('run', () => {
expect(getInputSpy).not.toHaveBeenCalled(); expect(getInputSpy).not.toHaveBeenCalled();
expect(getStateSpy).toHaveBeenCalledTimes(4); expect(getStateSpy).toHaveBeenCalledTimes(4);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(0); expect(getExecOutputSpy).toHaveBeenCalledTimes(0);
expect(debugSpy).toHaveBeenCalledTimes(0); expect(debugSpy).toHaveBeenCalledTimes(0);
expect(infoSpy).not.toHaveBeenCalledWith( expect(infoSpy).not.toHaveBeenCalledWith(
`Cache hit occurred on the primary key ${npmFileHash}, not saving cache.` `Cache hit occurred on the primary key ${npmFileHash}, not saving cache.`
@@ -384,9 +455,4 @@ describe('run', () => {
expect(setFailedSpy).toHaveBeenCalled(); expect(setFailedSpy).toHaveBeenCalled();
}); });
}); });
afterEach(() => {
jest.resetAllMocks();
jest.clearAllMocks();
});
}); });
+176 -104
View File
@@ -1,45 +1,133 @@
import * as core from '@actions/core';
import * as cache from '@actions/cache';
import path from 'path';
import * as utils from '../src/cache-utils';
import { import {
PackageManagerInfo, jest,
describe,
it,
expect,
beforeEach,
afterEach,
afterAll
} from '@jest/globals';
import {fileURLToPath} from 'url';
import path from 'path';
import fs from 'fs';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
// Mock @actions modules before importing anything that depends on them
jest.unstable_mockModule('@actions/core', () => ({
info: jest.fn(),
warning: jest.fn(),
debug: jest.fn(),
error: jest.fn(),
notice: jest.fn(),
setFailed: jest.fn(),
setOutput: jest.fn(),
getInput: jest.fn(),
getBooleanInput: jest.fn(),
getMultilineInput: jest.fn(),
addPath: jest.fn(),
exportVariable: jest.fn(),
saveState: jest.fn(),
getState: jest.fn(),
setSecret: jest.fn(),
isDebug: jest.fn(() => false),
startGroup: jest.fn(),
endGroup: jest.fn(),
group: jest.fn((_name: string, fn: () => Promise<unknown>) => fn()),
toPlatformPath: jest.fn((p: string) => p),
toWin32Path: jest.fn((p: string) => p),
toPosixPath: jest.fn((p: string) => p)
}));
jest.unstable_mockModule('@actions/cache', () => ({
saveCache: jest.fn(),
restoreCache: jest.fn(),
isFeatureAvailable: jest.fn()
}));
jest.unstable_mockModule('@actions/glob', () => ({
hashFiles: jest.fn(),
create: jest.fn()
}));
jest.unstable_mockModule('@actions/exec', () => ({
exec: jest.fn(),
getExecOutput: jest.fn()
}));
jest.unstable_mockModule('@actions/io', () => ({
which: jest.fn(),
mkdirP: jest.fn(),
rmRF: jest.fn(),
mv: jest.fn(),
cp: jest.fn()
}));
// Dynamic imports after mocking
const core = await import('@actions/core');
const cache = await import('@actions/cache');
const glob = await import('@actions/glob');
const exec = await import('@actions/exec');
const utils = await import('../src/cache-utils.js');
const cacheUtils = await import('../src/cache-utils.js');
// @ts-ignore - test file outside rootDir
const {MockGlobber} = await import('./mock/glob-mock.js');
import type {PackageManagerInfo} from '../src/cache-utils.js';
const {
isCacheFeatureAvailable, isCacheFeatureAvailable,
supportedPackageManagers, supportedPackageManagers,
isGhes, isGhes,
resetProjectDirectoriesMemoized resetProjectDirectoriesMemoized
} from '../src/cache-utils'; } = utils;
import fs from 'fs';
import * as cacheUtils from '../src/cache-utils'; // Helper: mock exec.getExecOutput to simulate getCommandOutput behavior
import * as glob from '@actions/glob'; function mockGetCommandOutput(
import {Globber} from '@actions/glob'; spy: jest.Mock,
import {MockGlobber} from './mock/glob-mock'; fn: (command: string, cwd?: string) => string
) {
spy.mockImplementation(async (command: any, _args: any, options: any) => ({
stdout: fn(command, options?.cwd),
stderr: '',
exitCode: 0
}));
}
function mockGetCommandOutputOnce(spy: jest.Mock, result: string) {
spy.mockImplementationOnce(async () => ({
stdout: result,
stderr: '',
exitCode: 0
}));
}
describe('cache-utils', () => { describe('cache-utils', () => {
const versionYarn1 = '1.2.3'; const versionYarn1 = '1.2.3';
let debugSpy: jest.SpyInstance; let debugSpy: jest.Mock;
let getCommandOutputSpy: jest.SpyInstance; let getExecOutputSpy: jest.Mock;
let isFeatureAvailable: jest.SpyInstance; let isFeatureAvailable: jest.Mock;
let info: jest.SpyInstance; let info: jest.Mock;
let warningSpy: jest.SpyInstance; let warningSpy: jest.Mock;
let fsRealPathSyncSpy: jest.SpyInstance; let fsRealPathSyncSpy: jest.SpiedFunction<typeof fs.realpathSync>;
beforeEach(() => { beforeEach(() => {
console.log('::stop-commands::stoptoken'); console.log('::stop-commands::stoptoken');
process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data'); process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data');
debugSpy = jest.spyOn(core, 'debug');
debugSpy.mockImplementation(msg => {});
info = jest.spyOn(core, 'info'); debugSpy = core.debug as jest.Mock;
warningSpy = jest.spyOn(core, 'warning'); debugSpy.mockImplementation((_msg: any) => {});
isFeatureAvailable = jest.spyOn(cache, 'isFeatureAvailable'); info = core.info as jest.Mock;
warningSpy = core.warning as jest.Mock;
getCommandOutputSpy = jest.spyOn(utils, 'getCommandOutput'); isFeatureAvailable = cache.isFeatureAvailable as jest.Mock;
getExecOutputSpy = exec.getExecOutput as jest.Mock;
fsRealPathSyncSpy = jest.spyOn(fs, 'realpathSync'); fsRealPathSyncSpy = jest.spyOn(fs, 'realpathSync');
fsRealPathSyncSpy.mockImplementation(dirName => { fsRealPathSyncSpy.mockImplementation((dirName: any) => {
return dirName; return dirName;
}); });
}); });
@@ -47,7 +135,6 @@ describe('cache-utils', () => {
afterEach(() => { afterEach(() => {
jest.resetAllMocks(); jest.resetAllMocks();
jest.clearAllMocks(); jest.clearAllMocks();
//jest.restoreAllMocks();
}); });
afterAll(async () => { afterAll(async () => {
@@ -64,7 +151,7 @@ describe('cache-utils', () => {
['yarn2', null], ['yarn2', null],
['npm7', null] ['npm7', null]
])('getPackageManagerInfo for %s is %o', async (packageManager, result) => { ])('getPackageManagerInfo for %s is %o', async (packageManager, result) => {
getCommandOutputSpy.mockImplementationOnce(() => versionYarn1); mockGetCommandOutputOnce(getExecOutputSpy, versionYarn1);
await expect(utils.getPackageManagerInfo(packageManager)).resolves.toBe( await expect(utils.getPackageManagerInfo(packageManager)).resolves.toBe(
result result
); );
@@ -92,7 +179,6 @@ describe('cache-utils', () => {
it('isCacheFeatureAvailable for GHES is available', () => { it('isCacheFeatureAvailable for GHES is available', () => {
isFeatureAvailable.mockImplementation(() => true); isFeatureAvailable.mockImplementation(() => true);
expect(isCacheFeatureAvailable()).toStrictEqual(true); expect(isCacheFeatureAvailable()).toStrictEqual(true);
}); });
@@ -103,24 +189,22 @@ describe('cache-utils', () => {
}); });
describe('getCacheDirectoriesPaths', () => { describe('getCacheDirectoriesPaths', () => {
let existsSpy: jest.SpyInstance; let existsSpy: jest.SpiedFunction<typeof fs.existsSync>;
let lstatSpy: jest.SpyInstance; let lstatSpy: jest.SpiedFunction<typeof fs.lstatSync>;
let globCreateSpy: jest.SpyInstance; let globCreateSpy: jest.Mock;
beforeEach(() => { beforeEach(() => {
existsSpy = jest.spyOn(fs, 'existsSync'); existsSpy = jest.spyOn(fs, 'existsSync');
existsSpy.mockImplementation(() => true); existsSpy.mockImplementation(() => true);
lstatSpy = jest.spyOn(fs, 'lstatSync'); lstatSpy = jest.spyOn(fs, 'lstatSync');
lstatSpy.mockImplementation(arg => ({ lstatSpy.mockImplementation(
isDirectory: () => true (_arg: any) => ({isDirectory: () => true}) as any
})); );
globCreateSpy = jest.spyOn(glob, 'create'); globCreateSpy = glob.create as jest.Mock;
globCreateSpy.mockImplementation((_pattern: any) =>
globCreateSpy.mockImplementation( MockGlobber.create(['/foo', '/bar'])
(pattern: string): Promise<Globber> =>
MockGlobber.create(['/foo', '/bar'])
); );
resetProjectDirectoriesMemoized(); resetProjectDirectoriesMemoized();
@@ -129,7 +213,6 @@ describe('cache-utils', () => {
afterEach(() => { afterEach(() => {
existsSpy.mockRestore(); existsSpy.mockRestore();
lstatSpy.mockRestore(); lstatSpy.mockRestore();
globCreateSpy.mockRestore();
}); });
it.each([ it.each([
@@ -142,22 +225,18 @@ describe('cache-utils', () => {
])( ])(
'getCacheDirectoriesPaths should return one dir for non yarn', 'getCacheDirectoriesPaths should return one dir for non yarn',
async (packageManagerInfo, cacheDependency) => { async (packageManagerInfo, cacheDependency) => {
getCommandOutputSpy.mockImplementation(() => 'foo'); mockGetCommandOutput(getExecOutputSpy, () => 'foo');
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(
packageManagerInfo, packageManagerInfo,
cacheDependency cacheDependency
); );
expect(dirs).toEqual(['foo']); expect(dirs).toEqual(['foo']);
// to do not call for a version expect(getExecOutputSpy).toHaveBeenCalledTimes(1);
// call once for get cache folder
expect(getCommandOutputSpy).toHaveBeenCalledTimes(1);
} }
); );
it('getCacheDirectoriesPaths should return one dir for yarn without cacheDependency', async () => { it('getCacheDirectoriesPaths should return one dir for yarn without cacheDependency', async () => {
getCommandOutputSpy.mockImplementation(() => 'foo'); mockGetCommandOutput(getExecOutputSpy, () => 'foo');
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(
supportedPackageManagers.yarn, supportedPackageManagers.yarn,
'' ''
@@ -178,15 +257,12 @@ describe('cache-utils', () => {
])( ])(
'getCacheDirectoriesPaths should throw for getCommandOutput returning empty', 'getCacheDirectoriesPaths should throw for getCommandOutput returning empty',
async (packageManagerInfo, cacheDependency) => { async (packageManagerInfo, cacheDependency) => {
getCommandOutputSpy.mockImplementation((command: string) => mockGetCommandOutput(getExecOutputSpy, (command: string) =>
// return empty string to indicate getCacheFolderPath failed
// --version still works
command.includes('version') ? '1.' : '' command.includes('version') ? '1.' : ''
); );
await expect( await expect(
cacheUtils.getCacheDirectories(packageManagerInfo, cacheDependency) cacheUtils.getCacheDirectories(packageManagerInfo, cacheDependency)
).rejects.toThrow(); //'Could not get cache folder path for /dir'); ).rejects.toThrow();
} }
); );
@@ -196,10 +272,9 @@ describe('cache-utils', () => {
])( ])(
'getCacheDirectoriesPaths should nothrow in case of having not directories', 'getCacheDirectoriesPaths should nothrow in case of having not directories',
async (packageManagerInfo, cacheDependency) => { async (packageManagerInfo, cacheDependency) => {
lstatSpy.mockImplementation(arg => ({ lstatSpy.mockImplementation(
isDirectory: () => false (_arg: any) => ({isDirectory: () => false}) as any
})); );
await cacheUtils.getCacheDirectories( await cacheUtils.getCacheDirectories(
packageManagerInfo, packageManagerInfo,
cacheDependency cacheDependency
@@ -214,9 +289,8 @@ describe('cache-utils', () => {
it.each(['1.1.1', '2.2.2'])( it.each(['1.1.1', '2.2.2'])(
'getCacheDirectoriesPaths yarn v%s should return one dir without cacheDependency', 'getCacheDirectoriesPaths yarn v%s should return one dir without cacheDependency',
async version => { async version => {
getCommandOutputSpy.mockImplementationOnce(() => version); mockGetCommandOutputOnce(getExecOutputSpy, version);
getCommandOutputSpy.mockImplementationOnce(() => `foo${version}`); mockGetCommandOutputOnce(getExecOutputSpy, `foo${version}`);
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(
supportedPackageManagers.yarn, supportedPackageManagers.yarn,
'' ''
@@ -229,14 +303,12 @@ describe('cache-utils', () => {
'getCacheDirectoriesPaths yarn v%s should return 2 dirs with globbed cacheDependency', 'getCacheDirectoriesPaths yarn v%s should return 2 dirs with globbed cacheDependency',
async version => { async version => {
let dirNo = 1; let dirNo = 1;
getCommandOutputSpy.mockImplementation((command: string) => mockGetCommandOutput(getExecOutputSpy, (command: string) =>
command.includes('version') ? version : `file_${version}_${dirNo++}` command.includes('version') ? version : `file_${version}_${dirNo++}`
); );
globCreateSpy.mockImplementation( globCreateSpy.mockImplementation((_pattern: any) =>
(pattern: string): Promise<Globber> => MockGlobber.create(['/tmp/dir1/file', '/tmp/dir2/file'])
MockGlobber.create(['/tmp/dir1/file', '/tmp/dir2/file'])
); );
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(
supportedPackageManagers.yarn, supportedPackageManagers.yarn,
'/tmp/**/file' '/tmp/**/file'
@@ -249,18 +321,16 @@ describe('cache-utils', () => {
'getCacheDirectoriesPaths yarn v%s should return 2 dirs with globbed cacheDependency expanding to duplicates', 'getCacheDirectoriesPaths yarn v%s should return 2 dirs with globbed cacheDependency expanding to duplicates',
async version => { async version => {
let dirNo = 1; let dirNo = 1;
getCommandOutputSpy.mockImplementation((command: string) => mockGetCommandOutput(getExecOutputSpy, (command: string) =>
command.includes('version') ? version : `file_${version}_${dirNo++}` command.includes('version') ? version : `file_${version}_${dirNo++}`
); );
globCreateSpy.mockImplementation( globCreateSpy.mockImplementation((_pattern: any) =>
(pattern: string): Promise<Globber> => MockGlobber.create([
MockGlobber.create([ '/tmp/dir1/file',
'/tmp/dir1/file', '/tmp/dir2/file',
'/tmp/dir2/file', '/tmp/dir1/file'
'/tmp/dir1/file' ])
])
); );
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(
supportedPackageManagers.yarn, supportedPackageManagers.yarn,
'/tmp/**/file' '/tmp/**/file'
@@ -273,55 +343,59 @@ describe('cache-utils', () => {
'getCacheDirectoriesPaths yarn v%s should return 2 uniq dirs despite duplicate cache directories', 'getCacheDirectoriesPaths yarn v%s should return 2 uniq dirs despite duplicate cache directories',
async version => { async version => {
let dirNo = 1; let dirNo = 1;
getCommandOutputSpy.mockImplementation((command: string) => mockGetCommandOutput(getExecOutputSpy, (command: string) =>
command.includes('version') command.includes('version')
? version ? version
: `file_${version}_${dirNo++ % 2}` : `file_${version}_${dirNo++ % 2}`
); );
globCreateSpy.mockImplementation( globCreateSpy.mockImplementation((_pattern: any) =>
(pattern: string): Promise<Globber> => MockGlobber.create([
MockGlobber.create([ '/tmp/dir1/file',
'/tmp/dir1/file', '/tmp/dir2/file',
'/tmp/dir2/file', '/tmp/dir3/file'
'/tmp/dir3/file' ])
])
); );
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(
supportedPackageManagers.yarn, supportedPackageManagers.yarn,
'/tmp/**/file' '/tmp/**/file'
); );
expect(dirs).toEqual([`file_${version}_1`, `file_${version}_0`]); expect(dirs).toEqual([`file_${version}_1`, `file_${version}_0`]);
expect(getCommandOutputSpy).toHaveBeenCalledTimes(6); expect(getExecOutputSpy).toHaveBeenCalledTimes(6);
expect(getCommandOutputSpy).toHaveBeenCalledWith( expect(getExecOutputSpy).toHaveBeenCalledWith(
'yarn --version', 'yarn --version',
'/tmp/dir1' undefined,
expect.objectContaining({cwd: '/tmp/dir1'})
); );
expect(getCommandOutputSpy).toHaveBeenCalledWith( expect(getExecOutputSpy).toHaveBeenCalledWith(
'yarn --version', 'yarn --version',
'/tmp/dir2' undefined,
expect.objectContaining({cwd: '/tmp/dir2'})
); );
expect(getCommandOutputSpy).toHaveBeenCalledWith( expect(getExecOutputSpy).toHaveBeenCalledWith(
'yarn --version', 'yarn --version',
'/tmp/dir3' undefined,
expect.objectContaining({cwd: '/tmp/dir3'})
); );
expect(getCommandOutputSpy).toHaveBeenCalledWith( expect(getExecOutputSpy).toHaveBeenCalledWith(
version.startsWith('1.') version.startsWith('1.')
? 'yarn cache dir' ? 'yarn cache dir'
: 'yarn config get cacheFolder', : 'yarn config get cacheFolder',
'/tmp/dir1' undefined,
expect.objectContaining({cwd: '/tmp/dir1'})
); );
expect(getCommandOutputSpy).toHaveBeenCalledWith( expect(getExecOutputSpy).toHaveBeenCalledWith(
version.startsWith('1.') version.startsWith('1.')
? 'yarn cache dir' ? 'yarn cache dir'
: 'yarn config get cacheFolder', : 'yarn config get cacheFolder',
'/tmp/dir2' undefined,
expect.objectContaining({cwd: '/tmp/dir2'})
); );
expect(getCommandOutputSpy).toHaveBeenCalledWith( expect(getExecOutputSpy).toHaveBeenCalledWith(
version.startsWith('1.') version.startsWith('1.')
? 'yarn cache dir' ? 'yarn cache dir'
: 'yarn config get cacheFolder', : 'yarn config get cacheFolder',
'/tmp/dir3' undefined,
expect.objectContaining({cwd: '/tmp/dir3'})
); );
} }
); );
@@ -329,22 +403,20 @@ describe('cache-utils', () => {
it.each(['1.1.1', '2.2.2'])( it.each(['1.1.1', '2.2.2'])(
'getCacheDirectoriesPaths yarn v%s should return 4 dirs with multiple globs', 'getCacheDirectoriesPaths yarn v%s should return 4 dirs with multiple globs',
async version => { async version => {
// simulate wrong indents
const cacheDependencyPath = `/tmp/dir1/file const cacheDependencyPath = `/tmp/dir1/file
/tmp/dir2/file /tmp/dir2/file
/tmp/**/file /tmp/**/file
`; `;
globCreateSpy.mockImplementation( globCreateSpy.mockImplementation((_pattern: any) =>
(pattern: string): Promise<Globber> => MockGlobber.create([
MockGlobber.create([ '/tmp/dir1/file',
'/tmp/dir1/file', '/tmp/dir2/file',
'/tmp/dir2/file', '/tmp/dir3/file',
'/tmp/dir3/file', '/tmp/dir4/file'
'/tmp/dir4/file' ])
])
); );
let dirNo = 1; let dirNo = 1;
getCommandOutputSpy.mockImplementation((command: string) => mockGetCommandOutput(getExecOutputSpy, (command: string) =>
command.includes('version') ? version : `file_${version}_${dirNo++}` command.includes('version') ? version : `file_${version}_${dirNo++}`
); );
const dirs = await cacheUtils.getCacheDirectories( const dirs = await cacheUtils.getCacheDirectories(
+190 -99
View File
@@ -1,51 +1,162 @@
import * as core from '@actions/core'; import {
import * as io from '@actions/io'; jest,
import * as tc from '@actions/tool-cache'; describe,
import * as httpm from '@actions/http-client'; it,
import * as exec from '@actions/exec'; expect,
import * as cache from '@actions/cache'; beforeEach,
afterEach,
afterAll
} from '@jest/globals';
import {fileURLToPath} from 'url';
import fs from 'fs'; import fs from 'fs';
import cp from 'child_process'; import cp from 'child_process';
import osm from 'os'; import osm from 'os';
import path from 'path'; import path from 'path';
import * as main from '../src/main';
import * as auth from '../src/authutil';
import {INodeVersion} from '../src/distributions/base-models';
import nodeTestManifest from './data/versions-manifest.json'; const __dirname = path.dirname(fileURLToPath(import.meta.url));
import nodeTestDist from './data/node-dist-index.json';
import nodeTestDistNightly from './data/node-nightly-index.json'; // Mock @actions modules before importing anything that depends on them
import nodeTestDistRc from './data/node-rc-index.json'; jest.unstable_mockModule('@actions/core', () => ({
import nodeV8CanaryTestDist from './data/v8-canary-dist-index.json'; info: jest.fn(),
warning: jest.fn(),
debug: jest.fn(),
error: jest.fn(),
notice: jest.fn(),
setFailed: jest.fn(),
setOutput: jest.fn(),
getInput: jest.fn(),
getBooleanInput: jest.fn(),
getMultilineInput: jest.fn(),
addPath: jest.fn(),
exportVariable: jest.fn(),
saveState: jest.fn(),
getState: jest.fn(),
setSecret: jest.fn(),
isDebug: jest.fn(() => false),
startGroup: jest.fn(),
endGroup: jest.fn(),
group: jest.fn((_name: string, fn: () => Promise<unknown>) => fn()),
toPlatformPath: jest.fn((p: string) => p),
toWin32Path: jest.fn((p: string) => p),
toPosixPath: jest.fn((p: string) => p)
}));
jest.unstable_mockModule('@actions/io', () => ({
which: jest.fn(),
mkdirP: jest.fn(),
rmRF: jest.fn(),
mv: jest.fn(),
cp: jest.fn()
}));
jest.unstable_mockModule('@actions/tool-cache', () => ({
find: jest.fn(),
findAllVersions: jest.fn(),
downloadTool: jest.fn(),
extractTar: jest.fn(),
extractZip: jest.fn(),
extractXar: jest.fn(),
extract7z: jest.fn(),
cacheDir: jest.fn(),
cacheFile: jest.fn(),
getManifestFromRepo: jest.fn(),
findFromManifest: jest.fn(),
HTTPError: class HTTPError extends Error {
readonly httpStatusCode: number;
constructor(httpStatusCode?: number) {
super(`Unexpected HTTP response: ${httpStatusCode}`);
this.httpStatusCode = httpStatusCode ?? 0;
}
}
}));
const _mockGetJson = jest.fn();
jest.unstable_mockModule('@actions/http-client', () => ({
HttpClient: jest.fn().mockImplementation(() => ({
getJson: _mockGetJson
}))
}));
jest.unstable_mockModule('@actions/exec', () => ({
exec: jest.fn(),
getExecOutput: jest.fn()
}));
jest.unstable_mockModule('@actions/cache', () => ({
saveCache: jest.fn(),
restoreCache: jest.fn(),
isFeatureAvailable: jest.fn()
}));
// Pre-import real authutil before mocking
const realAuth = await import('../src/authutil.js');
jest.unstable_mockModule('../src/authutil.js', () => ({
...realAuth,
configAuthentication: jest.fn()
}));
// Dynamic imports after mocking
const core = await import('@actions/core');
const io = await import('@actions/io');
const tc = await import('@actions/tool-cache');
const httpm = await import('@actions/http-client');
const exec = await import('@actions/exec');
const cache = await import('@actions/cache');
const main = await import('../src/main.js');
const auth = await import('../src/authutil.js');
const {default: nodeTestManifest} = await import(
'./data/versions-manifest.json',
{with: {type: 'json'}}
);
const {default: nodeTestDist} = await import('./data/node-dist-index.json', {
with: {type: 'json'}
});
const {default: nodeTestDistNightly} = await import(
'./data/node-nightly-index.json',
{with: {type: 'json'}}
);
const {default: nodeTestDistRc} = await import('./data/node-rc-index.json', {
with: {type: 'json'}
});
const {default: nodeV8CanaryTestDist} = await import(
'./data/v8-canary-dist-index.json',
{with: {type: 'json'}}
);
import type {INodeVersion} from '../src/distributions/base-models.js';
import type {IToolRelease} from '@actions/tool-cache';
describe('setup-node', () => { describe('setup-node', () => {
let inputs = {} as any; let inputs = {} as any;
let os = {} as any; let os = {} as any;
let inSpy: jest.SpyInstance; let inSpy: jest.Mock;
let findSpy: jest.SpyInstance; let findSpy: jest.Mock;
let findAllVersionsSpy: jest.SpyInstance; let findAllVersionsSpy: jest.Mock;
let cnSpy: jest.SpyInstance; let cnSpy: jest.SpiedFunction<typeof process.stdout.write>;
let logSpy: jest.SpyInstance; let logSpy: jest.Mock;
let warningSpy: jest.SpyInstance; let warningSpy: jest.Mock;
let getManifestSpy: jest.SpyInstance; let addPathSpy: jest.Mock;
let getDistSpy: jest.SpyInstance; let setFailedSpy: jest.Mock;
let platSpy: jest.SpyInstance; let getManifestSpy: jest.Mock;
let archSpy: jest.SpyInstance; let getDistSpy: jest.Mock;
let dlSpy: jest.SpyInstance; let platSpy: jest.SpiedFunction<typeof osm.platform>;
let exSpy: jest.SpyInstance; let archSpy: jest.SpiedFunction<typeof osm.arch>;
let cacheSpy: jest.SpyInstance; let dlSpy: jest.Mock;
let dbgSpy: jest.SpyInstance; let exSpy: jest.Mock;
let whichSpy: jest.SpyInstance; let cacheSpy: jest.Mock;
let existsSpy: jest.SpyInstance; let dbgSpy: jest.Mock;
let readFileSyncSpy: jest.SpyInstance; let whichSpy: jest.Mock;
let mkdirpSpy: jest.SpyInstance; let existsSpy: jest.SpiedFunction<typeof fs.existsSync>;
let execSpy: jest.SpyInstance; let readFileSyncSpy: jest.Mock;
let authSpy: jest.SpyInstance; let mkdirpSpy: jest.Mock;
let parseNodeVersionSpy: jest.SpyInstance; let execSpy: jest.SpiedFunction<typeof cp.execSync>;
let isCacheActionAvailable: jest.SpyInstance; let authSpy: jest.Mock;
let getExecOutputSpy: jest.SpyInstance; let parseNodeVersionSpy: jest.Mock;
let getJsonSpy: jest.SpyInstance; let isCacheActionAvailable: jest.Mock;
let getExecOutputSpy: jest.Mock;
let getJsonSpy: jest.Mock;
beforeEach(() => { beforeEach(() => {
// @actions/core // @actions/core
@@ -53,8 +164,8 @@ describe('setup-node', () => {
process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
inputs = {}; inputs = {};
inSpy = jest.spyOn(core, 'getInput'); inSpy = core.getInput as jest.Mock;
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
// node // node
os = {}; os = {};
@@ -65,34 +176,35 @@ describe('setup-node', () => {
execSpy = jest.spyOn(cp, 'execSync'); execSpy = jest.spyOn(cp, 'execSync');
// @actions/tool-cache // @actions/tool-cache
findSpy = jest.spyOn(tc, 'find'); findSpy = tc.find as jest.Mock;
findAllVersionsSpy = jest.spyOn(tc, 'findAllVersions'); findAllVersionsSpy = tc.findAllVersions as jest.Mock;
dlSpy = jest.spyOn(tc, 'downloadTool'); dlSpy = tc.downloadTool as jest.Mock;
exSpy = jest.spyOn(tc, 'extractTar'); exSpy = tc.extractTar as jest.Mock;
cacheSpy = jest.spyOn(tc, 'cacheDir'); cacheSpy = tc.cacheDir as jest.Mock;
getManifestSpy = jest.spyOn(tc, 'getManifestFromRepo'); getManifestSpy = tc.getManifestFromRepo as jest.Mock;
// http-client // http-client
getJsonSpy = jest.spyOn(httpm.HttpClient.prototype, 'getJson'); getJsonSpy = _mockGetJson;
(httpm.HttpClient as jest.Mock).mockImplementation(() => ({
getJson: _mockGetJson
}));
// io // io
whichSpy = jest.spyOn(io, 'which'); whichSpy = io.which as jest.Mock;
existsSpy = jest.spyOn(fs, 'existsSync'); existsSpy = jest.spyOn(fs, 'existsSync');
mkdirpSpy = jest.spyOn(io, 'mkdirP'); mkdirpSpy = io.mkdirP as jest.Mock;
// @actions/tool-cache // @actions/tool-cache
isCacheActionAvailable = jest.spyOn(cache, 'isFeatureAvailable'); isCacheActionAvailable = cache.isFeatureAvailable as jest.Mock;
// disable authentication portion for installer tests // disable authentication portion for installer tests
authSpy = jest.spyOn(auth, 'configAuthentication'); authSpy = auth.configAuthentication as jest.Mock;
authSpy.mockImplementation(() => {}); authSpy.mockImplementation(() => {});
// gets // gets
getManifestSpy.mockImplementation( getManifestSpy.mockImplementation(() => <IToolRelease[]>nodeTestManifest);
() => <tc.IToolRelease[]>nodeTestManifest
);
getJsonSpy.mockImplementation(url => { getJsonSpy.mockImplementation((url: any) => {
let res: any; let res: any;
if (url.includes('/rc')) { if (url.includes('/rc')) {
res = <INodeVersion[]>nodeTestDistRc; res = <INodeVersion[]>nodeTestDistRc;
@@ -109,28 +221,18 @@ describe('setup-node', () => {
// writes // writes
cnSpy = jest.spyOn(process.stdout, 'write'); cnSpy = jest.spyOn(process.stdout, 'write');
logSpy = jest.spyOn(core, 'info'); logSpy = core.info as jest.Mock;
dbgSpy = jest.spyOn(core, 'debug'); dbgSpy = core.debug as jest.Mock;
warningSpy = jest.spyOn(core, 'warning'); warningSpy = core.warning as jest.Mock;
cnSpy.mockImplementation(line => { addPathSpy = core.addPath as jest.Mock;
// uncomment to debug setFailedSpy = core.setFailed as jest.Mock;
// process.stderr.write('write:' + line + '\n'); cnSpy.mockImplementation(() => true);
}); logSpy.mockImplementation(() => {});
logSpy.mockImplementation(line => { dbgSpy.mockImplementation(() => {});
// uncomment to debug warningSpy.mockImplementation(() => {});
// process.stderr.write('log:' + line + '\n');
});
dbgSpy.mockImplementation(msg => {
// uncomment to see debug output
// process.stderr.write(msg + '\n');
});
warningSpy.mockImplementation(msg => {
// uncomment to debug
// process.stderr.write('log:' + msg + '\n');
});
// @actions/exec // @actions/exec
getExecOutputSpy = jest.spyOn(exec, 'getExecOutput'); getExecOutputSpy = exec.getExecOutput as jest.Mock;
getExecOutputSpy.mockImplementation(() => 'v16.15.0'); getExecOutputSpy.mockImplementation(() => 'v16.15.0');
}); });
@@ -178,7 +280,7 @@ describe('setup-node', () => {
inputs['node-version'] = '20-v8-canary'; inputs['node-version'] = '20-v8-canary';
os['arch'] = 'x64'; os['arch'] = 'x64';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const toolPath = path.normalize( const toolPath = path.normalize(
'/cache/node/20.0.0-v8-canary20221103f7e2421e91/x64' '/cache/node/20.0.0-v8-canary20221103f7e2421e91/x64'
@@ -193,7 +295,7 @@ describe('setup-node', () => {
await main.run(); await main.run();
const expPath = path.join(toolPath, 'bin'); const expPath = path.join(toolPath, 'bin');
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('handles unhandled find error and reports error', async () => { it('handles unhandled find error and reports error', async () => {
@@ -213,7 +315,7 @@ describe('setup-node', () => {
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith('::error::' + errMsg + osm.EOL); expect(setFailedSpy).toHaveBeenCalledWith(errMsg);
}); });
//-------------------------------------------------- //--------------------------------------------------
@@ -249,7 +351,7 @@ describe('setup-node', () => {
expect(logSpy).toHaveBeenCalledWith( expect(logSpy).toHaveBeenCalledWith(
`Attempting to download ${versionSpec}...` `Attempting to download ${versionSpec}...`
); );
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('does not find a version that does not exist', async () => { it('does not find a version that does not exist', async () => {
@@ -268,8 +370,8 @@ describe('setup-node', () => {
]); ]);
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith( expect(setFailedSpy).toHaveBeenCalledWith(
`::error::Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.${osm.EOL}` `Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.`
); );
}); });
@@ -295,7 +397,7 @@ describe('setup-node', () => {
}); });
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith(`::error::${errMsg}${osm.EOL}`); expect(setFailedSpy).toHaveBeenCalledWith(errMsg);
}); });
it('acquires specified architecture of node', async () => { it('acquires specified architecture of node', async () => {
@@ -319,7 +421,6 @@ describe('setup-node', () => {
darwin: 'darwin', darwin: 'darwin',
win32: 'win' win32: 'win'
}[os.platform]; }[os.platform];
inputs['node-version'] = version; inputs['node-version'] = version;
inputs['architecture'] = arch; inputs['architecture'] = arch;
inputs['token'] = 'faketoken'; inputs['token'] = 'faketoken';
@@ -393,9 +494,7 @@ describe('setup-node', () => {
); );
expect(logSpy).toHaveBeenCalledWith('Extracting ...'); expect(logSpy).toHaveBeenCalledWith('Extracting ...');
expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...'); expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...');
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
@@ -428,9 +527,7 @@ describe('setup-node', () => {
// assert // assert
expect(findAllVersionsSpy).toHaveBeenCalled(); expect(findAllVersionsSpy).toHaveBeenCalled();
expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`); expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
@@ -490,9 +587,7 @@ describe('setup-node', () => {
); );
expect(logSpy).toHaveBeenCalledWith('Extracting ...'); expect(logSpy).toHaveBeenCalledWith('Extracting ...');
expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...'); expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...');
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
@@ -554,9 +649,7 @@ describe('setup-node', () => {
); );
expect(logSpy).toHaveBeenCalledWith('Extracting ...'); expect(logSpy).toHaveBeenCalledWith('Extracting ...');
expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...'); expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...');
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
}); });
@@ -575,13 +668,11 @@ describe('setup-node', () => {
findAllVersionsSpy.mockImplementation(() => [versionExpected]); findAllVersionsSpy.mockImplementation(() => [versionExpected]);
const toolPath = path.normalize(`/cache/node/${versionExpected}/x64`); const toolPath = path.normalize(`/cache/node/${versionExpected}/x64`);
findSpy.mockImplementation(version => toolPath); findSpy.mockImplementation((version: any) => toolPath);
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(`${toolPath}${path.sep}bin`);
`::add-path::${toolPath}${path.sep}bin${osm.EOL}`
);
expect(dlSpy).not.toHaveBeenCalled(); expect(dlSpy).not.toHaveBeenCalled();
expect(exSpy).not.toHaveBeenCalled(); expect(exSpy).not.toHaveBeenCalled();
+155 -63
View File
@@ -1,43 +1,125 @@
import * as core from '@actions/core'; import {
import * as exec from '@actions/exec'; jest,
import * as tc from '@actions/tool-cache'; describe,
import * as cache from '@actions/cache'; it,
import * as io from '@actions/io'; expect,
beforeEach,
afterEach,
afterAll
} from '@jest/globals';
import {fileURLToPath} from 'url';
import fs from 'fs'; import fs from 'fs';
import path from 'path'; import path from 'path';
import osm from 'os'; import osm from 'os';
import each from 'jest-each'; const __dirname = path.dirname(fileURLToPath(import.meta.url));
import * as main from '../src/main'; // Mock @actions modules before importing anything that depends on them
import * as util from '../src/util'; jest.unstable_mockModule('@actions/core', () => ({
import OfficialBuilds from '../src/distributions/official_builds/official_builds'; info: jest.fn(),
warning: jest.fn(),
debug: jest.fn(),
error: jest.fn(),
notice: jest.fn(),
setFailed: jest.fn(),
setOutput: jest.fn(),
getInput: jest.fn(),
getBooleanInput: jest.fn(),
getMultilineInput: jest.fn(),
addPath: jest.fn(),
exportVariable: jest.fn(),
saveState: jest.fn(),
getState: jest.fn(),
setSecret: jest.fn(),
isDebug: jest.fn(() => false),
startGroup: jest.fn(),
endGroup: jest.fn(),
group: jest.fn((_name: string, fn: () => Promise<unknown>) => fn()),
toPlatformPath: jest.fn((p: string) => p),
toWin32Path: jest.fn((p: string) => p),
toPosixPath: jest.fn((p: string) => p)
}));
jest.unstable_mockModule('@actions/exec', () => ({
exec: jest.fn(),
getExecOutput: jest.fn()
}));
jest.unstable_mockModule('@actions/tool-cache', () => ({
find: jest.fn(),
findAllVersions: jest.fn(),
downloadTool: jest.fn(),
extractTar: jest.fn(),
extractZip: jest.fn(),
extractXar: jest.fn(),
extract7z: jest.fn(),
cacheDir: jest.fn(),
cacheFile: jest.fn(),
getManifestFromRepo: jest.fn(),
findFromManifest: jest.fn()
}));
jest.unstable_mockModule('@actions/cache', () => ({
saveCache: jest.fn(),
restoreCache: jest.fn(),
isFeatureAvailable: jest.fn()
}));
jest.unstable_mockModule('@actions/io', () => ({
which: jest.fn(),
mkdirP: jest.fn(),
rmRF: jest.fn(),
mv: jest.fn(),
cp: jest.fn()
}));
// Pre-import real util before mocking so we can spread it
const realUtil = await import('../src/util.js');
jest.unstable_mockModule('../src/util.js', () => ({
...realUtil,
getNodeVersionFromFile: jest.fn(realUtil.getNodeVersionFromFile)
}));
// Dynamic imports after mocking
const core = await import('@actions/core');
const exec = await import('@actions/exec');
const tc = await import('@actions/tool-cache');
const cache = await import('@actions/cache');
const io = await import('@actions/io');
const main = await import('../src/main.js');
const util = await import('../src/util.js');
const {default: OfficialBuilds} =
await import('../src/distributions/official_builds/official_builds.js');
import each from 'jest-each';
describe('main tests', () => { describe('main tests', () => {
let inputs = {} as any; let inputs = {} as any;
let os = {} as any; let os = {} as any;
let infoSpy: jest.SpyInstance; let infoSpy: jest.Mock;
let warningSpy: jest.SpyInstance; let warningSpy: jest.Mock;
let saveStateSpy: jest.SpyInstance; let saveStateSpy: jest.Mock;
let inSpy: jest.SpyInstance; let inSpy: jest.Mock;
let setOutputSpy: jest.SpyInstance; let setOutputSpy: jest.Mock;
let startGroupSpy: jest.SpyInstance; let startGroupSpy: jest.Mock;
let endGroupSpy: jest.SpyInstance; let endGroupSpy: jest.Mock;
let whichSpy: jest.SpyInstance; let whichSpy: jest.Mock;
let existsSpy: jest.SpyInstance; let existsSpy: jest.Mock;
let getExecOutputSpy: jest.SpyInstance; let getExecOutputSpy: jest.Mock;
let getNodeVersionFromFileSpy: jest.SpyInstance; let getNodeVersionFromFileSpy: jest.Mock;
let cnSpy: jest.SpyInstance; let cnSpy: jest.SpiedFunction<typeof process.stdout.write>;
let findSpy: jest.SpyInstance; let findSpy: jest.Mock;
let isCacheActionAvailable: jest.SpyInstance; let isCacheActionAvailable: jest.Mock;
let setupNodeJsSpy: jest.SpyInstance; let setupNodeJsSpy: jest.SpiedFunction<
typeof OfficialBuilds.prototype.setupNodeJs
>;
beforeEach(() => { beforeEach(() => {
inputs = {}; inputs = {};
@@ -48,37 +130,34 @@ describe('main tests', () => {
process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data'); process.env['GITHUB_WORKSPACE'] = path.join(__dirname, 'data');
process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
infoSpy = jest.spyOn(core, 'info'); infoSpy = core.info as jest.Mock;
infoSpy.mockImplementation(() => {}); infoSpy.mockImplementation(() => {});
setOutputSpy = jest.spyOn(core, 'setOutput'); setOutputSpy = core.setOutput as jest.Mock;
setOutputSpy.mockImplementation(() => {}); setOutputSpy.mockImplementation(() => {});
warningSpy = jest.spyOn(core, 'warning'); warningSpy = core.warning as jest.Mock;
warningSpy.mockImplementation(() => {}); warningSpy.mockImplementation(() => {});
saveStateSpy = jest.spyOn(core, 'saveState'); saveStateSpy = core.saveState as jest.Mock;
saveStateSpy.mockImplementation(() => {}); saveStateSpy.mockImplementation(() => {});
startGroupSpy = jest.spyOn(core, 'startGroup'); startGroupSpy = core.startGroup as jest.Mock;
startGroupSpy.mockImplementation(() => {}); startGroupSpy.mockImplementation(() => {});
endGroupSpy = jest.spyOn(core, 'endGroup'); endGroupSpy = core.endGroup as jest.Mock;
endGroupSpy.mockImplementation(() => {}); endGroupSpy.mockImplementation(() => {});
inSpy = jest.spyOn(core, 'getInput'); inSpy = core.getInput as jest.Mock;
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
whichSpy = jest.spyOn(io, 'which'); whichSpy = io.which as jest.Mock;
getExecOutputSpy = jest.spyOn(exec, 'getExecOutput'); getExecOutputSpy = exec.getExecOutput as jest.Mock;
findSpy = jest.spyOn(tc, 'find'); findSpy = tc.find as jest.Mock;
isCacheActionAvailable = jest.spyOn(cache, 'isFeatureAvailable'); isCacheActionAvailable = cache.isFeatureAvailable as jest.Mock;
cnSpy = jest.spyOn(process.stdout, 'write'); cnSpy = jest.spyOn(process.stdout, 'write');
cnSpy.mockImplementation(line => { cnSpy.mockImplementation(() => true);
// uncomment to debug
process.stderr.write('write:' + line + '\n');
});
setupNodeJsSpy = jest.spyOn(OfficialBuilds.prototype, 'setupNodeJs'); setupNodeJsSpy = jest.spyOn(OfficialBuilds.prototype, 'setupNodeJs');
setupNodeJsSpy.mockImplementation(() => {}); setupNodeJsSpy.mockImplementation(async () => {});
}); });
afterEach(() => { afterEach(() => {
@@ -93,6 +172,12 @@ describe('main tests', () => {
}, 100000); }, 100000);
describe('getNodeVersionFromFile', () => { describe('getNodeVersionFromFile', () => {
beforeEach(() => {
(util.getNodeVersionFromFile as jest.Mock).mockImplementation(
realUtil.getNodeVersionFromFile as any
);
});
each` each`
contents | expected contents | expected
${'12'} | ${'12'} ${'12'} | ${'12'}
@@ -112,12 +197,12 @@ describe('main tests', () => {
${'{"engines": {"node": "17.0.0"}}'} | ${'17.0.0'} ${'{"engines": {"node": "17.0.0"}}'} | ${'17.0.0'}
${'{"devEngines": {"runtime": {"name": "node", "version": "22.0.0"}}}'} | ${'22.0.0'} ${'{"devEngines": {"runtime": {"name": "node", "version": "22.0.0"}}}'} | ${'22.0.0'}
${'{"devEngines": {"runtime": [{"name": "bun"}, {"name": "node", "version": "22.0.0"}]}}'} | ${'22.0.0'} ${'{"devEngines": {"runtime": [{"name": "bun"}, {"name": "node", "version": "22.0.0"}]}}'} | ${'22.0.0'}
`.it('parses "$contents"', ({contents, expected}) => { `.it('parses "$contents"', ({contents, expected}: any) => {
const existsSpy = jest.spyOn(fs, 'existsSync'); const existsSpy = jest.spyOn(fs, 'existsSync');
existsSpy.mockImplementation(() => true); existsSpy.mockImplementation(() => true);
const readFileSpy = jest.spyOn(fs, 'readFileSync'); const readFileSpy = jest.spyOn(fs, 'readFileSync');
readFileSpy.mockImplementation(filePath => { readFileSpy.mockImplementation((filePath: any) => {
if ( if (
typeof filePath === 'string' && typeof filePath === 'string' &&
path.basename(filePath) === 'package.json' path.basename(filePath) === 'package.json'
@@ -139,8 +224,10 @@ describe('main tests', () => {
[{node: '16.0.2', npm: '7.3.3', yarn: '2.22.11'}], [{node: '16.0.2', npm: '7.3.3', yarn: '2.22.11'}],
[{node: '14.0.1', npm: '8.1.0', yarn: '3.2.1'}], [{node: '14.0.1', npm: '8.1.0', yarn: '3.2.1'}],
[{node: '17.0.2', npm: '6.3.3', yarn: ''}] [{node: '17.0.2', npm: '6.3.3', yarn: ''}]
])('Tools versions %p', async obj => { ])('Tools versions %p', async (obj: any) => {
getExecOutputSpy.mockImplementation(async command => { (
getExecOutputSpy as jest.Mock<typeof exec.getExecOutput>
).mockImplementation(async (command: string) => {
if (Reflect.has(obj, command) && !obj[command]) { if (Reflect.has(obj, command) && !obj[command]) {
return { return {
stdout: '', stdout: '',
@@ -152,14 +239,14 @@ describe('main tests', () => {
return {stdout: obj[command], stderr: '', exitCode: 0}; return {stdout: obj[command], stderr: '', exitCode: 0};
}); });
whichSpy.mockImplementation(cmd => { whichSpy.mockImplementation((cmd: any) => {
return `some/${cmd}/path`; return `some/${cmd}/path`;
}); });
await util.printEnvDetailsAndSetOutput(); await util.printEnvDetailsAndSetOutput();
expect(setOutputSpy).toHaveBeenCalledWith('node-version', obj['node']); expect(setOutputSpy).toHaveBeenCalledWith('node-version', obj['node']);
Object.getOwnPropertyNames(obj).forEach(name => { Object.getOwnPropertyNames(obj).forEach((name: any) => {
if (!obj[name]) { if (!obj[name]) {
expect(infoSpy).toHaveBeenCalledWith( expect(infoSpy).toHaveBeenCalledWith(
`[warning]${name} does not exist` `[warning]${name} does not exist`
@@ -175,11 +262,16 @@ describe('main tests', () => {
delete inputs['node-version']; delete inputs['node-version'];
inputs['node-version-file'] = '.nvmrc'; inputs['node-version-file'] = '.nvmrc';
getNodeVersionFromFileSpy = jest.spyOn(util, 'getNodeVersionFromFile'); getNodeVersionFromFileSpy = util.getNodeVersionFromFile as jest.Mock;
getNodeVersionFromFileSpy.mockImplementation(
realUtil.getNodeVersionFromFile as any
);
}); });
afterEach(() => { afterEach(() => {
getNodeVersionFromFileSpy.mockRestore(); getNodeVersionFromFileSpy.mockImplementation(
realUtil.getNodeVersionFromFile as any
);
}); });
it('does not read node-version-file if node-version is provided', async () => { it('does not read node-version-file if node-version is provided', async () => {
@@ -238,8 +330,8 @@ describe('main tests', () => {
// Assert // Assert
expect(getNodeVersionFromFileSpy).toHaveBeenCalled(); expect(getNodeVersionFromFileSpy).toHaveBeenCalled();
expect(cnSpy).toHaveBeenCalledWith( expect(core.setFailed as jest.Mock).toHaveBeenCalledWith(
`::error::The specified node version file at: ${versionFilePath} does not exist${osm.EOL}` `The specified node version file at: ${versionFilePath} does not exist`
); );
}); });
}); });
@@ -249,7 +341,7 @@ describe('main tests', () => {
inputs['node-version'] = '12'; inputs['node-version'] = '12';
inputs['cache'] = 'npm'; inputs['cache'] = 'npm';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const toolPath = path.normalize('/cache/node/12.16.1/x64'); const toolPath = path.normalize('/cache/node/12.16.1/x64');
findSpy.mockImplementation(() => toolPath); findSpy.mockImplementation(() => toolPath);
@@ -269,7 +361,7 @@ describe('main tests', () => {
inputs['node-version'] = '12'; inputs['node-version'] = '12';
inputs['cache'] = 'npm'; inputs['cache'] = 'npm';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const toolPath = path.normalize('/cache/node/12.16.1/x64'); const toolPath = path.normalize('/cache/node/12.16.1/x64');
findSpy.mockImplementation(() => toolPath); findSpy.mockImplementation(() => toolPath);
@@ -292,7 +384,7 @@ describe('main tests', () => {
inputs['cache'] = ''; inputs['cache'] = '';
isCacheActionAvailable.mockImplementation(() => true); isCacheActionAvailable.mockImplementation(() => true);
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const readFileSpy = jest.spyOn(fs, 'readFileSync'); const readFileSpy = jest.spyOn(fs, 'readFileSync');
readFileSpy.mockImplementation(() => readFileSpy.mockImplementation(() =>
JSON.stringify({ JSON.stringify({
@@ -310,7 +402,7 @@ describe('main tests', () => {
inputs['cache'] = ''; inputs['cache'] = '';
isCacheActionAvailable.mockImplementation(() => true); isCacheActionAvailable.mockImplementation(() => true);
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const readFileSpy = jest.spyOn(fs, 'readFileSync'); const readFileSpy = jest.spyOn(fs, 'readFileSync');
readFileSpy.mockImplementation(() => readFileSpy.mockImplementation(() =>
JSON.stringify({ JSON.stringify({
@@ -330,7 +422,7 @@ describe('main tests', () => {
inputs['cache'] = ''; inputs['cache'] = '';
isCacheActionAvailable.mockImplementation(() => true); isCacheActionAvailable.mockImplementation(() => true);
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const readFileSpy = jest.spyOn(fs, 'readFileSync'); const readFileSpy = jest.spyOn(fs, 'readFileSync');
readFileSpy.mockImplementation(() => readFileSpy.mockImplementation(() =>
JSON.stringify({ JSON.stringify({
@@ -348,7 +440,7 @@ describe('main tests', () => {
it('Should not enable caching if packageManager is "pnpm@8.0.0" and cache input is not provided', async () => { it('Should not enable caching if packageManager is "pnpm@8.0.0" and cache input is not provided', async () => {
inputs['package-manager-cache'] = 'true'; inputs['package-manager-cache'] = 'true';
inputs['cache'] = ''; inputs['cache'] = '';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const readFileSpy = jest.spyOn(fs, 'readFileSync'); const readFileSpy = jest.spyOn(fs, 'readFileSync');
readFileSpy.mockImplementation(() => readFileSpy.mockImplementation(() =>
JSON.stringify({ JSON.stringify({
@@ -364,7 +456,7 @@ describe('main tests', () => {
it('Should not enable caching if devEngines.packageManager.name is "pnpm"', async () => { it('Should not enable caching if devEngines.packageManager.name is "pnpm"', async () => {
inputs['package-manager-cache'] = 'true'; inputs['package-manager-cache'] = 'true';
inputs['cache'] = ''; inputs['cache'] = '';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const readFileSpy = jest.spyOn(fs, 'readFileSync'); const readFileSpy = jest.spyOn(fs, 'readFileSync');
readFileSpy.mockImplementation(() => readFileSpy.mockImplementation(() =>
JSON.stringify({ JSON.stringify({
@@ -382,7 +474,7 @@ describe('main tests', () => {
it('Should not enable caching if devEngines.packageManager is array without "npm"', async () => { it('Should not enable caching if devEngines.packageManager is array without "npm"', async () => {
inputs['package-manager-cache'] = 'true'; inputs['package-manager-cache'] = 'true';
inputs['cache'] = ''; inputs['cache'] = '';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const readFileSpy = jest.spyOn(fs, 'readFileSync'); const readFileSpy = jest.spyOn(fs, 'readFileSync');
readFileSpy.mockImplementation(() => readFileSpy.mockImplementation(() =>
JSON.stringify({ JSON.stringify({
@@ -400,7 +492,7 @@ describe('main tests', () => {
it('Should not enable caching if packageManager field is missing in package.json and cache input is not provided', async () => { it('Should not enable caching if packageManager field is missing in package.json and cache input is not provided', async () => {
inputs['package-manager-cache'] = 'true'; inputs['package-manager-cache'] = 'true';
inputs['cache'] = ''; inputs['cache'] = '';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const readFileSpy = jest.spyOn(fs, 'readFileSync'); const readFileSpy = jest.spyOn(fs, 'readFileSync');
readFileSpy.mockImplementation(() => readFileSpy.mockImplementation(() =>
JSON.stringify({ JSON.stringify({
@@ -416,7 +508,7 @@ describe('main tests', () => {
it('Should skip caching when package-manager-cache is false', async () => { it('Should skip caching when package-manager-cache is false', async () => {
inputs['package-manager-cache'] = 'false'; inputs['package-manager-cache'] = 'false';
inputs['cache'] = ''; inputs['cache'] = '';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
await main.run(); await main.run();
expect(saveStateSpy).not.toHaveBeenCalled(); expect(saveStateSpy).not.toHaveBeenCalled();
}); });
@@ -424,7 +516,7 @@ describe('main tests', () => {
it('Should enable caching with cache input explicitly provided', async () => { it('Should enable caching with cache input explicitly provided', async () => {
inputs['package-manager-cache'] = 'true'; inputs['package-manager-cache'] = 'true';
inputs['cache'] = 'npm'; inputs['cache'] = 'npm';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
isCacheActionAvailable.mockImplementation(() => true); isCacheActionAvailable.mockImplementation(() => true);
await main.run(); await main.run();
expect(saveStateSpy).toHaveBeenCalledWith(expect.anything(), 'npm'); expect(saveStateSpy).toHaveBeenCalledWith(expect.anything(), 'npm');
+2 -1
View File
@@ -1,4 +1,5 @@
import {MockGlobber} from './glob-mock'; import {describe, it, expect} from '@jest/globals';
import {MockGlobber} from './glob-mock.js';
describe('mocked globber tests', () => { describe('mocked globber tests', () => {
it('globber should return generator', async () => { it('globber should return generator', async () => {
+193 -101
View File
@@ -1,51 +1,160 @@
import * as core from '@actions/core'; import {
import * as io from '@actions/io'; jest,
import * as tc from '@actions/tool-cache'; describe,
import * as httpm from '@actions/http-client'; it,
import * as exec from '@actions/exec'; expect,
import * as cache from '@actions/cache'; beforeEach,
afterEach,
afterAll
} from '@jest/globals';
import {fileURLToPath} from 'url';
import fs from 'fs'; import fs from 'fs';
import cp from 'child_process'; import cp from 'child_process';
import osm from 'os'; import osm from 'os';
import path from 'path'; import path from 'path';
import * as main from '../src/main';
import * as auth from '../src/authutil';
import {INodeVersion} from '../src/distributions/base-models';
import nodeTestManifest from './data/versions-manifest.json'; const __dirname = path.dirname(fileURLToPath(import.meta.url));
import nodeTestDist from './data/node-dist-index.json';
import nodeTestDistNightly from './data/node-nightly-index.json'; // Mock @actions modules before importing anything that depends on them
import nodeTestDistRc from './data/node-rc-index.json'; jest.unstable_mockModule('@actions/core', () => ({
import nodeV8CanaryTestDist from './data/v8-canary-dist-index.json'; info: jest.fn(),
warning: jest.fn(),
debug: jest.fn(),
error: jest.fn(),
notice: jest.fn(),
setFailed: jest.fn(),
setOutput: jest.fn(),
getInput: jest.fn(),
getBooleanInput: jest.fn(),
getMultilineInput: jest.fn(),
addPath: jest.fn(),
exportVariable: jest.fn(),
saveState: jest.fn(),
getState: jest.fn(),
setSecret: jest.fn(),
isDebug: jest.fn(() => false),
startGroup: jest.fn(),
endGroup: jest.fn(),
group: jest.fn((_name: string, fn: () => Promise<unknown>) => fn()),
toPlatformPath: jest.fn((p: string) => p),
toWin32Path: jest.fn((p: string) => p),
toPosixPath: jest.fn((p: string) => p)
}));
jest.unstable_mockModule('@actions/io', () => ({
which: jest.fn(),
mkdirP: jest.fn(),
rmRF: jest.fn(),
mv: jest.fn(),
cp: jest.fn()
}));
jest.unstable_mockModule('@actions/tool-cache', () => ({
find: jest.fn(),
findAllVersions: jest.fn(),
downloadTool: jest.fn(),
extractTar: jest.fn(),
extractZip: jest.fn(),
extractXar: jest.fn(),
extract7z: jest.fn(),
cacheDir: jest.fn(),
cacheFile: jest.fn(),
getManifestFromRepo: jest.fn(),
findFromManifest: jest.fn(),
HTTPError: class HTTPError extends Error {
readonly httpStatusCode: number;
constructor(httpStatusCode?: number) {
super(`Unexpected HTTP response: ${httpStatusCode}`);
this.httpStatusCode = httpStatusCode ?? 0;
}
}
}));
const _mockGetJson = jest.fn();
jest.unstable_mockModule('@actions/http-client', () => ({
HttpClient: jest.fn().mockImplementation(() => ({
getJson: _mockGetJson
}))
}));
jest.unstable_mockModule('@actions/exec', () => ({
exec: jest.fn(),
getExecOutput: jest.fn()
}));
jest.unstable_mockModule('@actions/cache', () => ({
saveCache: jest.fn(),
restoreCache: jest.fn(),
isFeatureAvailable: jest.fn()
}));
const realAuth = await import('../src/authutil.js');
jest.unstable_mockModule('../src/authutil.js', () => ({
...realAuth,
configAuthentication: jest.fn()
}));
// Dynamic imports after mocking
const core = await import('@actions/core');
const io = await import('@actions/io');
const tc = await import('@actions/tool-cache');
const httpm = await import('@actions/http-client');
const exec = await import('@actions/exec');
const cache = await import('@actions/cache');
const main = await import('../src/main.js');
const auth = await import('../src/authutil.js');
const {default: nodeTestManifest} = await import(
'./data/versions-manifest.json',
{with: {type: 'json'}}
);
const {default: nodeTestDist} = await import('./data/node-dist-index.json', {
with: {type: 'json'}
});
const {default: nodeTestDistNightly} = await import(
'./data/node-nightly-index.json',
{with: {type: 'json'}}
);
const {default: nodeTestDistRc} = await import('./data/node-rc-index.json', {
with: {type: 'json'}
});
const {default: nodeV8CanaryTestDist} = await import(
'./data/v8-canary-dist-index.json',
{with: {type: 'json'}}
);
import type {INodeVersion} from '../src/distributions/base-models.js';
describe('setup-node', () => { describe('setup-node', () => {
let inputs = {} as any; let inputs = {} as any;
let os = {} as any; let os = {} as any;
let inSpy: jest.SpyInstance; let inSpy: jest.Mock;
let findSpy: jest.SpyInstance; let findSpy: jest.Mock;
let findAllVersionsSpy: jest.SpyInstance; let findAllVersionsSpy: jest.Mock;
let cnSpy: jest.SpyInstance; let cnSpy: jest.SpiedFunction<typeof process.stdout.write>;
let logSpy: jest.SpyInstance; let logSpy: jest.Mock;
let warningSpy: jest.SpyInstance; let warningSpy: jest.Mock;
let getManifestSpy: jest.SpyInstance; let addPathSpy: jest.Mock;
let getDistSpy: jest.SpyInstance; let setFailedSpy: jest.Mock;
let platSpy: jest.SpyInstance; let getManifestSpy: jest.Mock;
let archSpy: jest.SpyInstance; let getDistSpy: jest.Mock;
let dlSpy: jest.SpyInstance; let platSpy: jest.SpiedFunction<typeof osm.platform>;
let exSpy: jest.SpyInstance; let archSpy: jest.SpiedFunction<typeof osm.arch>;
let cacheSpy: jest.SpyInstance; let dlSpy: jest.Mock;
let dbgSpy: jest.SpyInstance; let exSpy: jest.Mock;
let whichSpy: jest.SpyInstance; let cacheSpy: jest.Mock;
let existsSpy: jest.SpyInstance; let dbgSpy: jest.Mock;
let mkdirpSpy: jest.SpyInstance; let whichSpy: jest.Mock;
let cpSpy: jest.SpyInstance; let existsSpy: jest.SpiedFunction<typeof fs.existsSync>;
let execSpy: jest.SpyInstance; let mkdirpSpy: jest.Mock;
let authSpy: jest.SpyInstance; let cpSpy: jest.Mock;
let parseNodeVersionSpy: jest.SpyInstance; let execSpy: jest.SpiedFunction<typeof cp.execSync>;
let isCacheActionAvailable: jest.SpyInstance; let authSpy: jest.Mock;
let getExecOutputSpy: jest.SpyInstance; let parseNodeVersionSpy: jest.Mock;
let getJsonSpy: jest.SpyInstance; let isCacheActionAvailable: jest.Mock;
let getExecOutputSpy: jest.Mock;
let getJsonSpy: jest.Mock;
beforeEach(() => { beforeEach(() => {
// @actions/core // @actions/core
@@ -54,8 +163,8 @@ describe('setup-node', () => {
process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
process.env['RUNNER_TEMP'] = '/runner_temp'; process.env['RUNNER_TEMP'] = '/runner_temp';
inputs = {}; inputs = {};
inSpy = jest.spyOn(core, 'getInput'); inSpy = core.getInput as jest.Mock;
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
// node // node
os = {}; os = {};
@@ -66,30 +175,33 @@ describe('setup-node', () => {
execSpy = jest.spyOn(cp, 'execSync'); execSpy = jest.spyOn(cp, 'execSync');
// @actions/tool-cache // @actions/tool-cache
findSpy = jest.spyOn(tc, 'find'); findSpy = tc.find as jest.Mock;
findAllVersionsSpy = jest.spyOn(tc, 'findAllVersions'); findAllVersionsSpy = tc.findAllVersions as jest.Mock;
dlSpy = jest.spyOn(tc, 'downloadTool'); dlSpy = tc.downloadTool as jest.Mock;
exSpy = jest.spyOn(tc, 'extractTar'); exSpy = tc.extractTar as jest.Mock;
cacheSpy = jest.spyOn(tc, 'cacheDir'); cacheSpy = tc.cacheDir as jest.Mock;
getManifestSpy = jest.spyOn(tc, 'getManifestFromRepo'); getManifestSpy = tc.getManifestFromRepo as jest.Mock;
// http-client // http-client
getJsonSpy = jest.spyOn(httpm.HttpClient.prototype, 'getJson'); getJsonSpy = _mockGetJson;
(httpm.HttpClient as jest.Mock).mockImplementation(() => ({
getJson: _mockGetJson
}));
// io // io
whichSpy = jest.spyOn(io, 'which'); whichSpy = io.which as jest.Mock;
existsSpy = jest.spyOn(fs, 'existsSync'); existsSpy = jest.spyOn(fs, 'existsSync');
mkdirpSpy = jest.spyOn(io, 'mkdirP'); mkdirpSpy = io.mkdirP as jest.Mock;
cpSpy = jest.spyOn(io, 'cp'); cpSpy = io.cp as jest.Mock;
// @actions/tool-cache // @actions/tool-cache
isCacheActionAvailable = jest.spyOn(cache, 'isFeatureAvailable'); isCacheActionAvailable = cache.isFeatureAvailable as jest.Mock;
// disable authentication portion for installer tests // disable authentication portion for installer tests
authSpy = jest.spyOn(auth, 'configAuthentication'); authSpy = auth.configAuthentication as jest.Mock;
authSpy.mockImplementation(() => {}); authSpy.mockImplementation(() => {});
getJsonSpy.mockImplementation(url => { getJsonSpy.mockImplementation((url: any) => {
let res: any; let res: any;
if (url.includes('/rc')) { if (url.includes('/rc')) {
res = <INodeVersion[]>nodeTestDistRc; res = <INodeVersion[]>nodeTestDistRc;
@@ -106,28 +218,18 @@ describe('setup-node', () => {
// writes // writes
cnSpy = jest.spyOn(process.stdout, 'write'); cnSpy = jest.spyOn(process.stdout, 'write');
logSpy = jest.spyOn(core, 'info'); logSpy = core.info as jest.Mock;
dbgSpy = jest.spyOn(core, 'debug'); dbgSpy = core.debug as jest.Mock;
warningSpy = jest.spyOn(core, 'warning'); warningSpy = core.warning as jest.Mock;
cnSpy.mockImplementation(line => { addPathSpy = core.addPath as jest.Mock;
// uncomment to debug setFailedSpy = core.setFailed as jest.Mock;
// process.stderr.write('write:' + line + '\n'); cnSpy.mockImplementation(() => true);
}); logSpy.mockImplementation(() => {});
logSpy.mockImplementation(line => { dbgSpy.mockImplementation(() => {});
// uncomment to debug warningSpy.mockImplementation(() => {});
// process.stderr.write('log:' + line + '\n');
});
dbgSpy.mockImplementation(msg => {
// uncomment to see debug output
// process.stderr.write(msg + '\n');
});
warningSpy.mockImplementation(msg => {
// uncomment to debug
// process.stderr.write('log:' + msg + '\n');
});
// @actions/exec // @actions/exec
getExecOutputSpy = jest.spyOn(exec, 'getExecOutput'); getExecOutputSpy = exec.getExecOutput as jest.Mock;
getExecOutputSpy.mockImplementation(() => 'v16.15.0'); getExecOutputSpy.mockImplementation(() => 'v16.15.0');
}); });
@@ -202,7 +304,7 @@ describe('setup-node', () => {
inputs['node-version'] = '16-nightly'; inputs['node-version'] = '16-nightly';
os['arch'] = 'x64'; os['arch'] = 'x64';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const toolPath = path.normalize( const toolPath = path.normalize(
'/cache/node/16.0.0-nightly20210417bc31dc0e0f/x64' '/cache/node/16.0.0-nightly20210417bc31dc0e0f/x64'
@@ -224,7 +326,7 @@ describe('setup-node', () => {
); );
const expPath = path.join(toolPath, 'bin'); const expPath = path.join(toolPath, 'bin');
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('handles unhandled find error and reports error', async () => { it('handles unhandled find error and reports error', async () => {
@@ -244,7 +346,7 @@ describe('setup-node', () => {
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith('::error::' + errMsg + osm.EOL); expect(setFailedSpy).toHaveBeenCalledWith(errMsg);
}); });
it('falls back to a version from node dist', async () => { it('falls back to a version from node dist', async () => {
@@ -274,7 +376,7 @@ describe('setup-node', () => {
expect(dlSpy).toHaveBeenCalled(); expect(dlSpy).toHaveBeenCalled();
expect(exSpy).toHaveBeenCalled(); expect(exSpy).toHaveBeenCalled();
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('windows: falls back to exe version if not in manifest and not in node dist', async () => { it('windows: falls back to exe version if not in manifest and not in node dist', async () => {
@@ -296,8 +398,8 @@ describe('setup-node', () => {
findSpy.mockImplementation(() => ''); findSpy.mockImplementation(() => '');
findAllVersionsSpy.mockImplementation(() => []); findAllVersionsSpy.mockImplementation(() => []);
dlSpy.mockImplementation(async url => { dlSpy.mockImplementation(async (url: any) => {
if (workingUrls.includes(url)) { if (workingUrls.includes(url as string)) {
return '/some/temp/path'; return '/some/temp/path';
} }
@@ -312,10 +414,10 @@ describe('setup-node', () => {
await main.run(); await main.run();
workingUrls.forEach(url => { workingUrls.forEach((url: any) => {
expect(dlSpy).toHaveBeenCalledWith(url, undefined, undefined); expect(dlSpy).toHaveBeenCalledWith(url, undefined, undefined);
}); });
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${toolPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(toolPath);
}); });
it('linux: does not fall back to exe version if not in manifest and not in node dist', async () => { it('linux: does not fall back to exe version if not in manifest and not in node dist', async () => {
@@ -337,8 +439,8 @@ describe('setup-node', () => {
findSpy.mockImplementation(() => ''); findSpy.mockImplementation(() => '');
findAllVersionsSpy.mockImplementation(() => []); findAllVersionsSpy.mockImplementation(() => []);
dlSpy.mockImplementation(async url => { dlSpy.mockImplementation(async (url: any) => {
if (workingUrls.includes(url)) { if (workingUrls.includes(url as string)) {
return '/some/temp/path'; return '/some/temp/path';
} }
@@ -353,12 +455,10 @@ describe('setup-node', () => {
await main.run(); await main.run();
workingUrls.forEach(url => { workingUrls.forEach((url: any) => {
expect(dlSpy).not.toHaveBeenCalledWith(url); expect(dlSpy).not.toHaveBeenCalledWith(url);
}); });
expect(cnSpy).toHaveBeenCalledWith( expect(setFailedSpy).toHaveBeenCalledWith('Unexpected HTTP response: 404');
`::error::Unexpected HTTP response: 404${osm.EOL}`
);
}); });
it('does not find a version that does not exist', async () => { it('does not find a version that does not exist', async () => {
@@ -372,8 +472,8 @@ describe('setup-node', () => {
findAllVersionsSpy.mockImplementation(() => []); findAllVersionsSpy.mockImplementation(() => []);
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith( expect(setFailedSpy).toHaveBeenCalledWith(
`::error::Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.${osm.EOL}` `Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.`
); );
}); });
@@ -396,7 +496,7 @@ describe('setup-node', () => {
}); });
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith(`::error::${errMsg}${osm.EOL}`); expect(setFailedSpy).toHaveBeenCalledWith(errMsg);
}); });
it('acquires specified architecture of node', async () => { it('acquires specified architecture of node', async () => {
@@ -420,7 +520,6 @@ describe('setup-node', () => {
darwin: 'darwin', darwin: 'darwin',
win32: 'win' win32: 'win'
}[os.platform]; }[os.platform];
inputs['node-version'] = version; inputs['node-version'] = version;
inputs['architecture'] = arch; inputs['architecture'] = arch;
inputs['token'] = 'faketoken'; inputs['token'] = 'faketoken';
@@ -465,7 +564,6 @@ describe('setup-node', () => {
darwin: 'darwin', darwin: 'darwin',
win32: 'win' win32: 'win'
}[os.platform]; }[os.platform];
inputs['node-version'] = version; inputs['node-version'] = version;
inputs['architecture'] = arch; inputs['architecture'] = arch;
inputs['token'] = 'faketoken'; inputs['token'] = 'faketoken';
@@ -541,9 +639,7 @@ describe('setup-node', () => {
); );
expect(logSpy).toHaveBeenCalledWith('Extracting ...'); expect(logSpy).toHaveBeenCalledWith('Extracting ...');
expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...'); expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...');
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
@@ -573,9 +669,7 @@ describe('setup-node', () => {
// assert // assert
expect(findAllVersionsSpy).toHaveBeenCalled(); expect(findAllVersionsSpy).toHaveBeenCalled();
expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`); expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
@@ -641,9 +735,7 @@ describe('setup-node', () => {
); );
expect(logSpy).toHaveBeenCalledWith('Extracting ...'); expect(logSpy).toHaveBeenCalledWith('Extracting ...');
expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...'); expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...');
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
}); });
+225 -103
View File
@@ -1,51 +1,163 @@
import * as core from '@actions/core'; import {
import * as io from '@actions/io'; jest,
import * as tc from '@actions/tool-cache'; describe,
import * as httpm from '@actions/http-client'; it,
import * as exec from '@actions/exec'; expect,
import * as cache from '@actions/cache'; beforeEach,
afterEach,
afterAll
} from '@jest/globals';
import {fileURLToPath} from 'url';
import fs from 'fs'; import fs from 'fs';
import cp from 'child_process'; import cp from 'child_process';
import osm from 'os'; import osm from 'os';
import path from 'path'; import path from 'path';
import * as main from '../src/main';
import * as auth from '../src/authutil';
import OfficialBuilds from '../src/distributions/official_builds/official_builds';
import {INodeVersion} from '../src/distributions/base-models';
import nodeTestManifest from './data/versions-manifest.json'; const __dirname = path.dirname(fileURLToPath(import.meta.url));
import nodeTestDist from './data/node-dist-index.json';
import nodeTestDistNightly from './data/node-nightly-index.json'; // Mock @actions modules before importing anything that depends on them
import nodeTestDistRc from './data/node-rc-index.json'; jest.unstable_mockModule('@actions/core', () => ({
import nodeV8CanaryTestDist from './data/v8-canary-dist-index.json'; info: jest.fn(),
warning: jest.fn(),
debug: jest.fn(),
error: jest.fn(),
notice: jest.fn(),
setFailed: jest.fn(),
setOutput: jest.fn(),
getInput: jest.fn(),
getBooleanInput: jest.fn(),
getMultilineInput: jest.fn(),
addPath: jest.fn(),
exportVariable: jest.fn(),
saveState: jest.fn(),
getState: jest.fn(),
setSecret: jest.fn(),
isDebug: jest.fn(() => false),
startGroup: jest.fn(),
endGroup: jest.fn(),
group: jest.fn((_name: string, fn: () => Promise<unknown>) => fn()),
toPlatformPath: jest.fn((p: string) => p),
toWin32Path: jest.fn((p: string) => p),
toPosixPath: jest.fn((p: string) => p)
}));
jest.unstable_mockModule('@actions/io', () => ({
which: jest.fn(),
mkdirP: jest.fn(),
rmRF: jest.fn(),
mv: jest.fn(),
cp: jest.fn()
}));
jest.unstable_mockModule('@actions/tool-cache', () => ({
find: jest.fn(),
findAllVersions: jest.fn(),
downloadTool: jest.fn(),
extractTar: jest.fn(),
extractZip: jest.fn(),
extractXar: jest.fn(),
extract7z: jest.fn(),
cacheDir: jest.fn(),
cacheFile: jest.fn(),
getManifestFromRepo: jest.fn(),
findFromManifest: jest.fn(),
HTTPError: class HTTPError extends Error {
readonly httpStatusCode: number;
constructor(httpStatusCode?: number) {
super(`Unexpected HTTP response: ${httpStatusCode}`);
this.httpStatusCode = httpStatusCode ?? 0;
}
}
}));
const _mockGetJson = jest.fn();
jest.unstable_mockModule('@actions/http-client', () => ({
HttpClient: jest.fn().mockImplementation(() => ({
getJson: _mockGetJson
}))
}));
jest.unstable_mockModule('@actions/exec', () => ({
exec: jest.fn(),
getExecOutput: jest.fn()
}));
jest.unstable_mockModule('@actions/cache', () => ({
saveCache: jest.fn(),
restoreCache: jest.fn(),
isFeatureAvailable: jest.fn()
}));
// Pre-import real authutil before mocking
const realAuth = await import('../src/authutil.js');
jest.unstable_mockModule('../src/authutil.js', () => ({
...realAuth,
configAuthentication: jest.fn()
}));
// Dynamic imports after mocking
const core = await import('@actions/core');
const io = await import('@actions/io');
const tc = await import('@actions/tool-cache');
const httpm = await import('@actions/http-client');
const exec = await import('@actions/exec');
const cache = await import('@actions/cache');
const main = await import('../src/main.js');
const auth = await import('../src/authutil.js');
const {default: OfficialBuilds} =
await import('../src/distributions/official_builds/official_builds.js');
const {default: nodeTestManifest} = await import(
'./data/versions-manifest.json',
{with: {type: 'json'}}
);
const {default: nodeTestDist} = await import('./data/node-dist-index.json', {
with: {type: 'json'}
});
const {default: nodeTestDistNightly} = await import(
'./data/node-nightly-index.json',
{with: {type: 'json'}}
);
const {default: nodeTestDistRc} = await import('./data/node-rc-index.json', {
with: {type: 'json'}
});
const {default: nodeV8CanaryTestDist} = await import(
'./data/v8-canary-dist-index.json',
{with: {type: 'json'}}
);
import type {INodeVersion} from '../src/distributions/base-models.js';
import type {IToolRelease} from '@actions/tool-cache';
describe('setup-node', () => { describe('setup-node', () => {
let build: OfficialBuilds; let build: InstanceType<typeof OfficialBuilds>;
let inputs = {} as any; let inputs = {} as any;
let os = {} as any; let os = {} as any;
let inSpy: jest.SpyInstance; let inSpy: jest.Mock;
let findSpy: jest.SpyInstance; let findSpy: jest.Mock;
let findAllVersionsSpy: jest.SpyInstance; let findAllVersionsSpy: jest.Mock;
let cnSpy: jest.SpyInstance; let cnSpy: jest.SpiedFunction<typeof process.stdout.write>;
let logSpy: jest.SpyInstance; let logSpy: jest.Mock;
let warningSpy: jest.SpyInstance; let warningSpy: jest.Mock;
let getManifestSpy: jest.SpyInstance; let addPathSpy: jest.Mock;
let platSpy: jest.SpyInstance; let setFailedSpy: jest.Mock;
let archSpy: jest.SpyInstance; let getManifestSpy: jest.Mock;
let dlSpy: jest.SpyInstance; let platSpy: jest.SpiedFunction<typeof osm.platform>;
let exSpy: jest.SpyInstance; let archSpy: jest.SpiedFunction<typeof osm.arch>;
let cacheSpy: jest.SpyInstance; let dlSpy: jest.Mock;
let dbgSpy: jest.SpyInstance; let exSpy: jest.Mock;
let whichSpy: jest.SpyInstance; let cacheSpy: jest.Mock;
let existsSpy: jest.SpyInstance; let dbgSpy: jest.Mock;
let readFileSyncSpy: jest.SpyInstance; let whichSpy: jest.Mock;
let mkdirpSpy: jest.SpyInstance; let existsSpy: jest.SpiedFunction<typeof fs.existsSync>;
let execSpy: jest.SpyInstance; let readFileSyncSpy: jest.Mock;
let authSpy: jest.SpyInstance; let mkdirpSpy: jest.Mock;
let isCacheActionAvailable: jest.SpyInstance; let execSpy: jest.SpiedFunction<typeof cp.execSync>;
let getExecOutputSpy: jest.SpyInstance; let authSpy: jest.Mock;
let getJsonSpy: jest.SpyInstance; let isCacheActionAvailable: jest.Mock;
let getExecOutputSpy: jest.Mock;
let getJsonSpy: jest.Mock;
beforeEach(() => { beforeEach(() => {
// @actions/core // @actions/core
@@ -53,8 +165,8 @@ describe('setup-node', () => {
process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
inputs = {}; inputs = {};
inSpy = jest.spyOn(core, 'getInput'); inSpy = core.getInput as jest.Mock;
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
// node // node
os = {}; os = {};
@@ -65,34 +177,61 @@ describe('setup-node', () => {
execSpy = jest.spyOn(cp, 'execSync'); execSpy = jest.spyOn(cp, 'execSync');
// @actions/tool-cache // @actions/tool-cache
findSpy = jest.spyOn(tc, 'find'); findSpy = tc.find as jest.Mock;
findAllVersionsSpy = jest.spyOn(tc, 'findAllVersions'); findAllVersionsSpy = tc.findAllVersions as jest.Mock;
dlSpy = jest.spyOn(tc, 'downloadTool'); dlSpy = tc.downloadTool as jest.Mock;
exSpy = jest.spyOn(tc, 'extractTar'); exSpy = tc.extractTar as jest.Mock;
cacheSpy = jest.spyOn(tc, 'cacheDir'); cacheSpy = tc.cacheDir as jest.Mock;
getManifestSpy = jest.spyOn(tc, 'getManifestFromRepo'); getManifestSpy = tc.getManifestFromRepo as jest.Mock;
// Restore findFromManifest after clearMocks.
// In ESM, the real tc.findFromManifest uses os.platform() from its own
// module namespace, which jest.spyOn on our os import cannot override.
// So we provide a minimal reimplementation that uses the test's os var.
(tc.findFromManifest as jest.Mock).mockImplementation(
async (versionSpec: any, stable: any, manifest: any, archFilter: any) => {
const arch = archFilter || os['arch'] || 'x64';
const plat = os['platform'] || process.platform;
const semverModule = await import('semver');
for (const rel of manifest || []) {
if (
semverModule.default.satisfies(rel.version, versionSpec, {
includePrerelease: true
}) &&
rel.stable === stable
) {
const file = rel.files.find(
(f: any) => f.arch === arch && f.platform === plat
);
if (file) return {...rel, files: [file]};
}
}
return undefined;
}
);
// http-client // http-client
getJsonSpy = jest.spyOn(httpm.HttpClient.prototype, 'getJson'); getJsonSpy = _mockGetJson;
(httpm.HttpClient as jest.Mock).mockImplementation(() => ({
getJson: _mockGetJson
}));
// io // io
whichSpy = jest.spyOn(io, 'which'); whichSpy = io.which as jest.Mock;
existsSpy = jest.spyOn(fs, 'existsSync'); existsSpy = jest.spyOn(fs, 'existsSync');
mkdirpSpy = jest.spyOn(io, 'mkdirP'); mkdirpSpy = io.mkdirP as jest.Mock;
// @actions/tool-cache // @actions/tool-cache
isCacheActionAvailable = jest.spyOn(cache, 'isFeatureAvailable'); isCacheActionAvailable = cache.isFeatureAvailable as jest.Mock;
// disable authentication portion for installer tests // disable authentication portion for installer tests
authSpy = jest.spyOn(auth, 'configAuthentication'); authSpy = auth.configAuthentication as jest.Mock;
authSpy.mockImplementation(() => {}); authSpy.mockImplementation(() => {});
// gets // gets
getManifestSpy.mockImplementation( getManifestSpy.mockImplementation(() => <IToolRelease[]>nodeTestManifest);
() => <tc.IToolRelease[]>nodeTestManifest
);
getJsonSpy.mockImplementation(url => { getJsonSpy.mockImplementation((url: any) => {
let res: any; let res: any;
if (url.includes('/rc')) { if (url.includes('/rc')) {
res = <INodeVersion[]>nodeTestDistRc; res = <INodeVersion[]>nodeTestDistRc;
@@ -107,28 +246,18 @@ describe('setup-node', () => {
// writes // writes
cnSpy = jest.spyOn(process.stdout, 'write'); cnSpy = jest.spyOn(process.stdout, 'write');
logSpy = jest.spyOn(core, 'info'); logSpy = core.info as jest.Mock;
dbgSpy = jest.spyOn(core, 'debug'); dbgSpy = core.debug as jest.Mock;
warningSpy = jest.spyOn(core, 'warning'); warningSpy = core.warning as jest.Mock;
cnSpy.mockImplementation(line => { addPathSpy = core.addPath as jest.Mock;
// uncomment to debug setFailedSpy = core.setFailed as jest.Mock;
process.stderr.write('write:' + line + '\n'); cnSpy.mockImplementation(() => true);
}); logSpy.mockImplementation(() => {});
logSpy.mockImplementation(line => { dbgSpy.mockImplementation(() => {});
// uncomment to debug warningSpy.mockImplementation(() => {});
process.stderr.write('log:' + line + '\n');
});
dbgSpy.mockImplementation(msg => {
// uncomment to see debug output
// process.stderr.write(msg + '\n');
});
warningSpy.mockImplementation(msg => {
// uncomment to debug
// process.stderr.write('log:' + msg + '\n');
});
// @actions/exec // @actions/exec
getExecOutputSpy = jest.spyOn(exec, 'getExecOutput'); getExecOutputSpy = exec.getExecOutput as jest.Mock;
getExecOutputSpy.mockImplementation(() => 'v16.15.0'); getExecOutputSpy.mockImplementation(() => 'v16.15.0');
}); });
@@ -156,7 +285,7 @@ describe('setup-node', () => {
async (versionSpec, platform, expectedVersion, expectedLts) => { async (versionSpec, platform, expectedVersion, expectedLts) => {
os.platform = platform; os.platform = platform;
os.arch = 'x64'; os.arch = 'x64';
const versions: tc.IToolRelease[] | null = await tc.getManifestFromRepo( const versions: IToolRelease[] | null = await tc.getManifestFromRepo(
'actions', 'actions',
'node-versions', 'node-versions',
'mocktoken' 'mocktoken'
@@ -187,7 +316,7 @@ describe('setup-node', () => {
it('finds version in cache with stable not supplied', async () => { it('finds version in cache with stable not supplied', async () => {
inputs['node-version'] = '12'; inputs['node-version'] = '12';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const toolPath = path.normalize('/cache/node/12.16.1/x64'); const toolPath = path.normalize('/cache/node/12.16.1/x64');
findSpy.mockImplementation(() => toolPath); findSpy.mockImplementation(() => toolPath);
@@ -199,14 +328,14 @@ describe('setup-node', () => {
it('finds version in cache and adds it to the path', async () => { it('finds version in cache and adds it to the path', async () => {
inputs['node-version'] = '12'; inputs['node-version'] = '12';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const toolPath = path.normalize('/cache/node/12.16.1/x64'); const toolPath = path.normalize('/cache/node/12.16.1/x64');
findSpy.mockImplementation(() => toolPath); findSpy.mockImplementation(() => toolPath);
await main.run(); await main.run();
const expPath = path.join(toolPath, 'bin'); const expPath = path.join(toolPath, 'bin');
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('handles unhandled find error and reports error', async () => { it('handles unhandled find error and reports error', async () => {
@@ -219,7 +348,7 @@ describe('setup-node', () => {
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith('::error::' + errMsg + osm.EOL); expect(setFailedSpy).toHaveBeenCalledWith(errMsg);
}); });
//-------------------------------------------------- //--------------------------------------------------
@@ -247,7 +376,7 @@ describe('setup-node', () => {
const toolPath = path.normalize('/cache/node/12.16.2/x64'); const toolPath = path.normalize('/cache/node/12.16.2/x64');
exSpy.mockImplementation(async () => '/some/other/temp/path'); exSpy.mockImplementation(async () => '/some/other/temp/path');
cacheSpy.mockImplementation(async () => toolPath); cacheSpy.mockImplementation(async () => toolPath);
whichSpy.mockImplementation(cmd => { whichSpy.mockImplementation((cmd: any) => {
return `some/${cmd}/path`; return `some/${cmd}/path`;
}); });
@@ -278,7 +407,7 @@ describe('setup-node', () => {
expect(logSpy).toHaveBeenCalledWith( expect(logSpy).toHaveBeenCalledWith(
`Attempting to download ${versionSpec}...` `Attempting to download ${versionSpec}...`
); );
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('falls back to a version from node dist from mirror', async () => { it('falls back to a version from node dist from mirror', async () => {
@@ -314,7 +443,7 @@ describe('setup-node', () => {
); );
expect(dlSpy).toHaveBeenCalled(); expect(dlSpy).toHaveBeenCalled();
expect(exSpy).toHaveBeenCalled(); expect(exSpy).toHaveBeenCalled();
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('falls back to a version from node dist', async () => { it('falls back to a version from node dist', async () => {
@@ -348,7 +477,7 @@ describe('setup-node', () => {
); );
expect(dlSpy).toHaveBeenCalled(); expect(dlSpy).toHaveBeenCalled();
expect(exSpy).toHaveBeenCalled(); expect(exSpy).toHaveBeenCalled();
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('does not find a version that does not exist', async () => { it('does not find a version that does not exist', async () => {
@@ -367,8 +496,8 @@ describe('setup-node', () => {
expect(logSpy).toHaveBeenCalledWith( expect(logSpy).toHaveBeenCalledWith(
`Attempting to download ${versionSpec}...` `Attempting to download ${versionSpec}...`
); );
expect(cnSpy).toHaveBeenCalledWith( expect(setFailedSpy).toHaveBeenCalledWith(
`::error::Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.${osm.EOL}` `Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.`
); );
}); });
@@ -390,7 +519,7 @@ describe('setup-node', () => {
}); });
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith(`::error::${errMsg}${osm.EOL}`); expect(setFailedSpy).toHaveBeenCalledWith(errMsg);
}); });
it('reports when download failed but version exists', async () => { it('reports when download failed but version exists', async () => {
@@ -583,7 +712,7 @@ describe('setup-node', () => {
expect(logSpy).toHaveBeenCalledWith( expect(logSpy).toHaveBeenCalledWith(
`Attempting to download ${versionSpec}...` `Attempting to download ${versionSpec}...`
); );
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('fallback to dist if manifest is not available', async () => { it('fallback to dist if manifest is not available', async () => {
@@ -626,7 +755,7 @@ describe('setup-node', () => {
expect(logSpy).toHaveBeenCalledWith( expect(logSpy).toHaveBeenCalledWith(
`Attempting to download ${versionSpec}...` `Attempting to download ${versionSpec}...`
); );
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
}); });
@@ -668,9 +797,7 @@ describe('setup-node', () => {
`Found LTS release '${expectedVersion}' for Node version 'lts/${lts}'` `Found LTS release '${expectedVersion}' for Node version 'lts/${lts}'`
); );
expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`); expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
@@ -728,9 +855,7 @@ describe('setup-node', () => {
); );
expect(logSpy).toHaveBeenCalledWith('Extracting ...'); expect(logSpy).toHaveBeenCalledWith('Extracting ...');
expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...'); expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...');
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
@@ -750,8 +875,8 @@ describe('setup-node', () => {
expect(dbgSpy).toHaveBeenCalledWith( expect(dbgSpy).toHaveBeenCalledWith(
'Getting manifest from actions/node-versions@main' 'Getting manifest from actions/node-versions@main'
); );
expect(cnSpy).toHaveBeenCalledWith( expect(setFailedSpy).toHaveBeenCalledWith(
`::error::Unable to parse LTS alias for Node version 'lts/'${osm.EOL}` `Unable to parse LTS alias for Node version 'lts/'`
); );
}); });
@@ -774,8 +899,8 @@ describe('setup-node', () => {
expect(dbgSpy).toHaveBeenCalledWith( expect(dbgSpy).toHaveBeenCalledWith(
`LTS alias 'unknown' for Node version 'lts/unknown'` `LTS alias 'unknown' for Node version 'lts/unknown'`
); );
expect(cnSpy).toHaveBeenCalledWith( expect(setFailedSpy).toHaveBeenCalledWith(
`::error::Unable to find LTS release 'unknown' for Node version 'lts/unknown'.${osm.EOL}` `Unable to find LTS release 'unknown' for Node version 'lts/unknown'.`
); );
}); });
@@ -799,9 +924,7 @@ describe('setup-node', () => {
expect(dbgSpy).toHaveBeenCalledWith( expect(dbgSpy).toHaveBeenCalledWith(
'Getting manifest from actions/node-versions@main' 'Getting manifest from actions/node-versions@main'
); );
expect(cnSpy).toHaveBeenCalledWith( expect(setFailedSpy).toHaveBeenCalledWith('Unable to download manifest');
`::error::Unable to download manifest${osm.EOL}`
);
}); });
}); });
@@ -871,7 +994,6 @@ describe('setup-node', () => {
darwin: 'darwin', darwin: 'darwin',
win32: 'win' win32: 'win'
}[os.platform]; }[os.platform];
inputs['node-version'] = version; inputs['node-version'] = version;
inputs['architecture'] = arch; inputs['architecture'] = arch;
inputs['token'] = 'faketoken'; inputs['token'] = 'faketoken';
+2 -1
View File
@@ -1,4 +1,5 @@
import tscMatcher from '../.github/tsc.json'; import {describe, it, expect} from '@jest/globals';
import tscMatcher from '../.github/tsc.json' with {type: 'json'};
describe('problem matcher tests', () => { describe('problem matcher tests', () => {
it('tsc: matches TypeScript "pretty" error message', () => { it('tsc: matches TypeScript "pretty" error message', () => {
+178 -84
View File
@@ -1,46 +1,152 @@
import * as core from '@actions/core'; import {
import * as io from '@actions/io'; jest,
import * as tc from '@actions/tool-cache'; describe,
import * as httpm from '@actions/http-client'; it,
import * as exec from '@actions/exec'; expect,
import * as cache from '@actions/cache'; beforeEach,
afterEach,
afterAll
} from '@jest/globals';
import {fileURLToPath} from 'url';
import fs from 'fs'; import fs from 'fs';
import cp from 'child_process'; import cp from 'child_process';
import osm from 'os'; import osm from 'os';
import path from 'path'; import path from 'path';
import * as main from '../src/main';
import * as auth from '../src/authutil';
import {INodeVersion} from '../src/distributions/base-models';
import nodeTestDist from './data/node-dist-index.json'; const __dirname = path.dirname(fileURLToPath(import.meta.url));
import nodeTestDistNightly from './data/node-nightly-index.json';
import nodeTestDistRc from './data/node-rc-index.json'; // Mock @actions modules before importing anything that depends on them
import nodeV8CanaryTestDist from './data/v8-canary-dist-index.json'; jest.unstable_mockModule('@actions/core', () => ({
info: jest.fn(),
warning: jest.fn(),
debug: jest.fn(),
error: jest.fn(),
notice: jest.fn(),
setFailed: jest.fn(),
setOutput: jest.fn(),
getInput: jest.fn(),
getBooleanInput: jest.fn(),
getMultilineInput: jest.fn(),
addPath: jest.fn(),
exportVariable: jest.fn(),
saveState: jest.fn(),
getState: jest.fn(),
setSecret: jest.fn(),
isDebug: jest.fn(() => false),
startGroup: jest.fn(),
endGroup: jest.fn(),
group: jest.fn((_name: string, fn: () => Promise<unknown>) => fn()),
toPlatformPath: jest.fn((p: string) => p),
toWin32Path: jest.fn((p: string) => p),
toPosixPath: jest.fn((p: string) => p)
}));
jest.unstable_mockModule('@actions/io', () => ({
which: jest.fn(),
mkdirP: jest.fn(),
rmRF: jest.fn(),
mv: jest.fn(),
cp: jest.fn()
}));
jest.unstable_mockModule('@actions/tool-cache', () => ({
find: jest.fn(),
findAllVersions: jest.fn(),
downloadTool: jest.fn(),
extractTar: jest.fn(),
extractZip: jest.fn(),
extractXar: jest.fn(),
extract7z: jest.fn(),
cacheDir: jest.fn(),
cacheFile: jest.fn(),
getManifestFromRepo: jest.fn(),
findFromManifest: jest.fn(),
HTTPError: class HTTPError extends Error {
readonly httpStatusCode: number;
constructor(httpStatusCode?: number) {
super(`Unexpected HTTP response: ${httpStatusCode}`);
this.httpStatusCode = httpStatusCode ?? 0;
}
}
}));
const _mockGetJson = jest.fn();
jest.unstable_mockModule('@actions/http-client', () => ({
HttpClient: jest.fn().mockImplementation(() => ({
getJson: _mockGetJson
}))
}));
jest.unstable_mockModule('@actions/exec', () => ({
exec: jest.fn(),
getExecOutput: jest.fn()
}));
jest.unstable_mockModule('@actions/cache', () => ({
saveCache: jest.fn(),
restoreCache: jest.fn(),
isFeatureAvailable: jest.fn()
}));
const realAuth = await import('../src/authutil.js');
jest.unstable_mockModule('../src/authutil.js', () => ({
...realAuth,
configAuthentication: jest.fn()
}));
// Dynamic imports after mocking
const core = await import('@actions/core');
const io = await import('@actions/io');
const tc = await import('@actions/tool-cache');
const httpm = await import('@actions/http-client');
const exec = await import('@actions/exec');
const cache = await import('@actions/cache');
const main = await import('../src/main.js');
const auth = await import('../src/authutil.js');
const {default: nodeTestDist} = await import('./data/node-dist-index.json', {
with: {type: 'json'}
});
const {default: nodeTestDistNightly} = await import(
'./data/node-nightly-index.json',
{with: {type: 'json'}}
);
const {default: nodeTestDistRc} = await import('./data/node-rc-index.json', {
with: {type: 'json'}
});
const {default: nodeV8CanaryTestDist} = await import(
'./data/v8-canary-dist-index.json',
{with: {type: 'json'}}
);
import type {INodeVersion} from '../src/distributions/base-models.js';
describe('setup-node', () => { describe('setup-node', () => {
let inputs = {} as any; let inputs = {} as any;
let os = {} as any; let os = {} as any;
let inSpy: jest.SpyInstance; let inSpy: jest.Mock;
let findSpy: jest.SpyInstance; let findSpy: jest.Mock;
let findAllVersionsSpy: jest.SpyInstance; let findAllVersionsSpy: jest.Mock;
let cnSpy: jest.SpyInstance; let cnSpy: jest.SpiedFunction<typeof process.stdout.write>;
let logSpy: jest.SpyInstance; let logSpy: jest.Mock;
let warningSpy: jest.SpyInstance; let warningSpy: jest.Mock;
let platSpy: jest.SpyInstance; let addPathSpy: jest.Mock;
let archSpy: jest.SpyInstance; let setFailedSpy: jest.Mock;
let dlSpy: jest.SpyInstance; let platSpy: jest.SpiedFunction<typeof osm.platform>;
let exSpy: jest.SpyInstance; let archSpy: jest.SpiedFunction<typeof osm.arch>;
let cacheSpy: jest.SpyInstance; let dlSpy: jest.Mock;
let dbgSpy: jest.SpyInstance; let exSpy: jest.Mock;
let whichSpy: jest.SpyInstance; let cacheSpy: jest.Mock;
let existsSpy: jest.SpyInstance; let dbgSpy: jest.Mock;
let mkdirpSpy: jest.SpyInstance; let whichSpy: jest.Mock;
let execSpy: jest.SpyInstance; let existsSpy: jest.SpiedFunction<typeof fs.existsSync>;
let authSpy: jest.SpyInstance; let mkdirpSpy: jest.Mock;
let isCacheActionAvailable: jest.SpyInstance; let execSpy: jest.SpiedFunction<typeof cp.execSync>;
let getExecOutputSpy: jest.SpyInstance; let authSpy: jest.Mock;
let getJsonSpy: jest.SpyInstance; let isCacheActionAvailable: jest.Mock;
let getExecOutputSpy: jest.Mock;
let getJsonSpy: jest.Mock;
beforeEach(() => { beforeEach(() => {
// @actions/core // @actions/core
@@ -48,8 +154,8 @@ describe('setup-node', () => {
process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out process.env['GITHUB_PATH'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out process.env['GITHUB_OUTPUT'] = ''; // Stub out ENV file functionality so we can verify it writes to standard out
inputs = {}; inputs = {};
inSpy = jest.spyOn(core, 'getInput'); inSpy = core.getInput as jest.Mock;
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
// node // node
os = {}; os = {};
@@ -60,30 +166,33 @@ describe('setup-node', () => {
execSpy = jest.spyOn(cp, 'execSync'); execSpy = jest.spyOn(cp, 'execSync');
// @actions/tool-cache // @actions/tool-cache
findSpy = jest.spyOn(tc, 'find'); findSpy = tc.find as jest.Mock;
findAllVersionsSpy = jest.spyOn(tc, 'findAllVersions'); findAllVersionsSpy = tc.findAllVersions as jest.Mock;
dlSpy = jest.spyOn(tc, 'downloadTool'); dlSpy = tc.downloadTool as jest.Mock;
exSpy = jest.spyOn(tc, 'extractTar'); exSpy = tc.extractTar as jest.Mock;
cacheSpy = jest.spyOn(tc, 'cacheDir'); cacheSpy = tc.cacheDir as jest.Mock;
// getDistSpy = jest.spyOn(im, 'getVersionsFromDist'); // getDistSpy = jest.spyOn(im, 'getVersionsFromDist') as jest.Mock;
// http-client // http-client
getJsonSpy = jest.spyOn(httpm.HttpClient.prototype, 'getJson'); getJsonSpy = _mockGetJson;
(httpm.HttpClient as jest.Mock).mockImplementation(() => ({
getJson: _mockGetJson
}));
// io // io
whichSpy = jest.spyOn(io, 'which'); whichSpy = io.which as jest.Mock;
existsSpy = jest.spyOn(fs, 'existsSync'); existsSpy = jest.spyOn(fs, 'existsSync');
mkdirpSpy = jest.spyOn(io, 'mkdirP'); mkdirpSpy = io.mkdirP as jest.Mock;
// @actions/tool-cache // @actions/tool-cache
isCacheActionAvailable = jest.spyOn(cache, 'isFeatureAvailable'); isCacheActionAvailable = cache.isFeatureAvailable as jest.Mock;
isCacheActionAvailable.mockImplementation(() => false); isCacheActionAvailable.mockImplementation(() => false);
// disable authentication portion for installer tests // disable authentication portion for installer tests
authSpy = jest.spyOn(auth, 'configAuthentication'); authSpy = auth.configAuthentication as jest.Mock;
authSpy.mockImplementation(() => {}); authSpy.mockImplementation(() => {});
getJsonSpy.mockImplementation(url => { getJsonSpy.mockImplementation((url: any) => {
let res: any; let res: any;
if (url.includes('/rc')) { if (url.includes('/rc')) {
res = <INodeVersion[]>nodeTestDistRc; res = <INodeVersion[]>nodeTestDistRc;
@@ -98,28 +207,18 @@ describe('setup-node', () => {
// writes // writes
cnSpy = jest.spyOn(process.stdout, 'write'); cnSpy = jest.spyOn(process.stdout, 'write');
logSpy = jest.spyOn(core, 'info'); logSpy = core.info as jest.Mock;
dbgSpy = jest.spyOn(core, 'debug'); dbgSpy = core.debug as jest.Mock;
warningSpy = jest.spyOn(core, 'warning'); warningSpy = core.warning as jest.Mock;
cnSpy.mockImplementation(line => { addPathSpy = core.addPath as jest.Mock;
// uncomment to debug setFailedSpy = core.setFailed as jest.Mock;
// process.stderr.write('write:' + line + '\n'); cnSpy.mockImplementation(() => true);
}); logSpy.mockImplementation(() => {});
logSpy.mockImplementation(line => { dbgSpy.mockImplementation(() => {});
// uncomment to debug warningSpy.mockImplementation(() => {});
// process.stderr.write('log:' + line + '\n');
});
dbgSpy.mockImplementation(msg => {
// uncomment to see debug output
// process.stderr.write(msg + '\n');
});
warningSpy.mockImplementation(msg => {
// uncomment to debug
// process.stderr.write('log:' + msg + '\n');
});
// @actions/exec // @actions/exec
getExecOutputSpy = jest.spyOn(exec, 'getExecOutput'); getExecOutputSpy = exec.getExecOutput as jest.Mock;
getExecOutputSpy.mockImplementation(() => 'v16.15.0-rc.1'); getExecOutputSpy.mockImplementation(() => 'v16.15.0-rc.1');
}); });
@@ -152,7 +251,7 @@ describe('setup-node', () => {
it('finds version in cache with stable not supplied', async () => { it('finds version in cache with stable not supplied', async () => {
inputs['node-version'] = '12.0.0-rc.1'; inputs['node-version'] = '12.0.0-rc.1';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const toolPath = path.normalize('/cache/node/12.0.0-rc.1/x64'); const toolPath = path.normalize('/cache/node/12.0.0-rc.1/x64');
findSpy.mockImplementation(() => toolPath); findSpy.mockImplementation(() => toolPath);
@@ -164,14 +263,14 @@ describe('setup-node', () => {
it('finds version in cache and adds it to the path', async () => { it('finds version in cache and adds it to the path', async () => {
inputs['node-version'] = '12.0.0-rc.1'; inputs['node-version'] = '12.0.0-rc.1';
inSpy.mockImplementation(name => inputs[name]); inSpy.mockImplementation((name: any) => inputs[name]);
const toolPath = path.normalize('/cache/node/12.0.0-rc.1/x64'); const toolPath = path.normalize('/cache/node/12.0.0-rc.1/x64');
findSpy.mockImplementation(() => toolPath); findSpy.mockImplementation(() => toolPath);
await main.run(); await main.run();
const expPath = path.join(toolPath, 'bin'); const expPath = path.join(toolPath, 'bin');
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('handles unhandled find error and reports error', async () => { it('handles unhandled find error and reports error', async () => {
@@ -184,7 +283,7 @@ describe('setup-node', () => {
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith('::error::' + errMsg + osm.EOL); expect(setFailedSpy).toHaveBeenCalledWith(errMsg);
}); });
it('falls back to a version from node dist', async () => { it('falls back to a version from node dist', async () => {
@@ -212,7 +311,7 @@ describe('setup-node', () => {
expect(exSpy).toHaveBeenCalled(); expect(exSpy).toHaveBeenCalled();
expect(logSpy).toHaveBeenCalledWith('Extracting ...'); expect(logSpy).toHaveBeenCalledWith('Extracting ...');
expect(logSpy).toHaveBeenCalledWith('Done'); expect(logSpy).toHaveBeenCalledWith('Done');
expect(cnSpy).toHaveBeenCalledWith(`::add-path::${expPath}${osm.EOL}`); expect(addPathSpy).toHaveBeenCalledWith(expPath);
}); });
it('does not find a version that does not exist', async () => { it('does not find a version that does not exist', async () => {
@@ -225,8 +324,8 @@ describe('setup-node', () => {
findSpy.mockImplementation(() => ''); findSpy.mockImplementation(() => '');
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith( expect(setFailedSpy).toHaveBeenCalledWith(
`::error::Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.${osm.EOL}` `Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.`
); );
}); });
@@ -247,7 +346,7 @@ describe('setup-node', () => {
}); });
await main.run(); await main.run();
expect(cnSpy).toHaveBeenCalledWith(`::error::${errMsg}${osm.EOL}`); expect(setFailedSpy).toHaveBeenCalledWith(errMsg);
}); });
it('acquires specified architecture of node', async () => { it('acquires specified architecture of node', async () => {
@@ -263,7 +362,6 @@ describe('setup-node', () => {
darwin: 'darwin', darwin: 'darwin',
win32: 'win' win32: 'win'
}[os.platform]; }[os.platform];
inputs['node-version'] = version; inputs['node-version'] = version;
inputs['architecture'] = arch; inputs['architecture'] = arch;
inputs['token'] = 'faketoken'; inputs['token'] = 'faketoken';
@@ -334,9 +432,7 @@ describe('setup-node', () => {
// assert // assert
expect(logSpy).toHaveBeenCalledWith('Extracting ...'); expect(logSpy).toHaveBeenCalledWith('Extracting ...');
expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...'); expect(logSpy).toHaveBeenCalledWith('Adding to the cache ...');
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
@@ -370,9 +466,7 @@ describe('setup-node', () => {
// assert // assert
expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`); expect(logSpy).toHaveBeenCalledWith(`Found in cache @ ${toolPath}`);
expect(cnSpy).toHaveBeenCalledWith( expect(addPathSpy).toHaveBeenCalledWith(path.join(toolPath, 'bin'));
`::add-path::${path.join(toolPath, 'bin')}${osm.EOL}`
);
} }
); );
@@ -391,8 +485,8 @@ describe('setup-node', () => {
await main.run(); await main.run();
// assert // assert
expect(cnSpy).toHaveBeenCalledWith( expect(setFailedSpy).toHaveBeenCalledWith(
`::error::Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.${osm.EOL}` `Unable to find Node version '${versionSpec}' for platform ${os.platform} and architecture ${os.arch}.`
); );
}); });
}); });
+4
View File
@@ -34,6 +34,10 @@ inputs:
outputs: outputs:
cache-hit: cache-hit:
description: 'A boolean value to indicate if a cache was hit.' description: 'A boolean value to indicate if a cache was hit.'
cache-primary-key:
description: 'The key used to restore and save the cache.'
cache-matched-key:
description: 'The key of the cache that was restored. Empty when no cache is found.'
node-version: node-version:
description: 'The installed node version.' description: 'The installed node version.'
runs: runs:
+50635 -45998
View File
File diff suppressed because one or more lines are too long
+3
View File
@@ -0,0 +1,3 @@
{
"type": "module"
}
+54140 -77848
View File
File diff suppressed because one or more lines are too long
+3
View File
@@ -0,0 +1,3 @@
{
"type": "module"
}
+102 -26
View File
@@ -69,6 +69,7 @@ steps:
with: with:
node-version: '24' node-version: '24'
check-latest: true check-latest: true
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -86,6 +87,7 @@ steps:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
node-version-file: '.nvmrc' node-version-file: '.nvmrc'
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -131,6 +133,7 @@ jobs:
with: with:
node-version: '24' node-version: '24'
architecture: 'x64' # optional, x64 or x86. If not specified, x64 will be used by default architecture: 'x64' # optional, x64 or x86. If not specified, x64 will be used by default
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -151,6 +154,7 @@ jobs:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
node-version: '24.0.0-v8-canary' # it will install the latest v8 canary release for node 24.0.0 node-version: '24.0.0-v8-canary' # it will install the latest v8 canary release for node 24.0.0
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -166,6 +170,7 @@ jobs:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
node-version: '24-v8-canary' # it will install the latest v8 canary release for node 24 node-version: '24-v8-canary' # it will install the latest v8 canary release for node 24
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -182,6 +187,7 @@ jobs:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
node-version: 'v24.0.0-v8-canary2025030537242e55ac' node-version: 'v24.0.0-v8-canary2025030537242e55ac'
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -202,6 +208,7 @@ jobs:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
node-version: '24-nightly' # it will install the latest nightly release for node 24 node-version: '24-nightly' # it will install the latest nightly release for node 24
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -218,6 +225,7 @@ jobs:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
node-version: '24.0.0-nightly' # it will install the latest nightly release for node 24.0.0 node-version: '24.0.0-nightly' # it will install the latest nightly release for node 24.0.0
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -234,6 +242,7 @@ jobs:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
node-version: '24.0.0-nightly202505066102159fa1' node-version: '24.0.0-nightly202505066102159fa1'
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -252,11 +261,12 @@ jobs:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
node-version: '24.0.0-rc.4' node-version: '24.0.0-rc.4'
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
**Note:** Unlike nightly versions, which support version range specifiers, you must specify the exact version for a release candidate: `24.0.0-rc.4`. **Note**: Unlike nightly versions, which support version range specifiers, you must specify the exact version for a release candidate: `24.0.0-rc.4`.
## Caching packages data ## Caching packages data
The action follows [actions/cache](https://github.com/actions/cache/blob/main/examples.md#node---npm) guidelines, and caches global cache on the machine instead of `node_modules`, so cache can be reused between different Node.js versions. The action follows [actions/cache](https://github.com/actions/cache/blob/main/examples.md#node---npm) guidelines, and caches global cache on the machine instead of `node_modules`, so cache can be reused between different Node.js versions.
@@ -329,36 +339,52 @@ steps:
- run: npm test - run: npm test
``` ```
**Restore-Only Cache** **Restore-only cache**
You can restore caches without saving new entries, which helps reduce cache writes and storage usage in read-only cache workflows.
```yaml ```yaml
## In some workflows, you may want to restore a cache without saving it. This can help reduce cache writes and storage usage in workflows that only need to read from cache steps:
jobs: - uses: actions/checkout@v6
build: # - uses: pnpm/action-setup@v6
runs-on: ubuntu-latest # with:
steps: # version: 10
- uses: actions/checkout@v6
# Restore Node.js modules cache (restore-only) - name: Setup Node.js
- name: Restore Node modules cache uses: actions/setup-node@v6
uses: actions/cache@v5 with:
id: cache-node-modules node-version: '24'
with: package-manager-cache: false # Disable automatic npm caching if not required
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }} - name: Normalize runner architecture
restore-keys: | shell: bash
${{ runner.os }}-node- run: echo "ARCH=$(echo '${{ runner.arch }}' | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
# Setup Node.js
- name: Setup Node.js - name: Output of cache path
uses: actions/setup-node@v6 id: cachepath
with: shell: bash
node-version: '24' run: echo "path=$(npm config get cache)" >> $GITHUB_OUTPUT
# Install dependencies # run: echo "path=$(pnpm store path --silent)" >> $GITHUB_OUTPUT
- run: npm install # For yarn workflow, output of yarn cache dir (v1) or yarn config get cacheFolder (v2+)
# run: echo "path=$(yarn cache dir)" >> $GITHUB_OUTPUT
- name: Restore Node cache
uses: actions/cache/restore@v5
with:
path: ${{ steps.cachepath.outputs.path }}
key: node-cache-${{ runner.os }}-${{ env.ARCH }}-npm-${{ hashFiles('**/package-lock.json') }}
# key: node-cache-${{ runner.os }}-${{ env.ARCH }}-yarn-${{ hashFiles('**/yarn.lock') }}
# key: node-cache-${{ runner.os }}-${{ env.ARCH }}-pnpm-${{ hashFiles('**/pnpm-lock.yaml') }}
- run: npm ci
# - run: yarn install --frozen-lockfile # optional, --immutable
# - run: pnpm install
``` ```
> **Note**: Uncomment the commands relevant to your project's package manager.
> For more details related to cache scenarios, please refer [Node npm](https://github.com/actions/cache/blob/main/examples.md#node---npm). > For more details related to cache scenarios, please refer [actions/cache/restore](https://github.com/actions/cache/tree/main/restore#only-restore-cache).
## Multiple Operating Systems and Architectures ## Multiple operating systems and architectures
```yaml ```yaml
jobs: jobs:
@@ -389,6 +415,7 @@ jobs:
with: with:
node-version: ${{ matrix.node_version }} node-version: ${{ matrix.node_version }}
architecture: ${{ matrix.architecture }} architecture: ${{ matrix.architecture }}
package-manager-cache: false # Disable automatic npm caching if not required
- run: npm ci - run: npm ci
- run: npm test - run: npm test
``` ```
@@ -401,6 +428,7 @@ steps:
with: with:
node-version: '24.x' node-version: '24.x'
registry-url: 'https://registry.npmjs.org' registry-url: 'https://registry.npmjs.org'
package-manager-cache: false # Disable automatic npm dependency caching to reduce cache poisoning risk
- run: npm ci - run: npm ci
- run: npm publish - run: npm publish
env: env:
@@ -408,6 +436,7 @@ steps:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
registry-url: 'https://npm.pkg.github.com' registry-url: 'https://npm.pkg.github.com'
package-manager-cache: false # Disable automatic npm dependency caching to reduce cache poisoning risk
- run: npm publish - run: npm publish
env: env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -421,6 +450,7 @@ steps:
with: with:
node-version: '24.x' node-version: '24.x'
registry-url: <registry url> registry-url: <registry url>
package-manager-cache: false # Disable automatic npm dependency caching to reduce cache poisoning risk
- run: yarn install --frozen-lockfile - run: yarn install --frozen-lockfile
- run: yarn publish - run: yarn publish
env: env:
@@ -428,6 +458,7 @@ steps:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
registry-url: 'https://npm.pkg.github.com' registry-url: 'https://npm.pkg.github.com'
package-manager-cache: false # Disable automatic npm dependency caching to reduce cache poisoning risk
- run: yarn publish - run: yarn publish
env: env:
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -441,6 +472,7 @@ steps:
with: with:
node-version: '24.x' node-version: '24.x'
registry-url: 'https://registry.npmjs.org' registry-url: 'https://registry.npmjs.org'
package-manager-cache: false # Disable automatic npm dependency caching to reduce cache poisoning risk
# Skip post-install scripts here, as a malicious # Skip post-install scripts here, as a malicious
# script could steal NODE_AUTH_TOKEN. # script could steal NODE_AUTH_TOKEN.
- run: npm ci --ignore-scripts - run: npm ci --ignore-scripts
@@ -460,6 +492,7 @@ steps:
- uses: actions/setup-node@v6 - uses: actions/setup-node@v6
with: with:
node-version: '24.x' node-version: '24.x'
package-manager-cache: false # Disable automatic npm dependency caching to reduce cache poisoning risk
- name: Setup .yarnrc.yml - name: Setup .yarnrc.yml
run: | run: |
yarn config set npmScopes.my-org.npmRegistryServer "https://npm.pkg.github.com" yarn config set npmScopes.my-org.npmRegistryServer "https://npm.pkg.github.com"
@@ -475,6 +508,48 @@ To access private GitHub Packages within the same organization, go to "Manage Ac
Please refer to the [Ensuring workflow access to your package - Configuring a package's access control and visibility](https://docs.github.com/en/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package) for more details. Please refer to the [Ensuring workflow access to your package - Configuring a package's access control and visibility](https://docs.github.com/en/packages/learn-github-packages/configuring-a-packages-access-control-and-visibility#ensuring-workflow-access-to-your-package) for more details.
## Publishing to npm with Trusted Publisher (OIDC)
npm supports Trusted Publishers, enabling packages to be published from GitHub Actions using OpenID Connect (OIDC) instead of long-lived npm tokens. This improves security by replacing static credentials with short-lived tokens, reducing the risk of credential leakage and simplifying authentication in CI/CD workflows.
### Requirements
Trusted publishing requires a compatible npm version:
* **npm ≥ 11.5.1 (required)**
* **Node.js 24 or newer (recommended)** — includes a compatible npm version by default
> If npm is below 11.5.1, publishing will fail even if OIDC permissions are correctly configured.
You must also configure a **Trusted Publisher** in npm for your package/scope that matches your GitHub repository and workflow (and optional environment, if used).
> **Note**: In publishing workflows, set `package-manager-cache: false` because setup-node enables npm caching automatically when `package.json` specifies npm via `packageManager` or `devEngines.packageManager` (see [Running without a lockfile](#running-without-a-lockfile)), and a poisoned cache may expose credentials (including OIDC tokens) to attacker-controlled code.
### Example workflow
```yaml
permissions:
contents: read
id-token: write # Required for OIDC
steps:
- uses: actions/checkout@v6
- uses: actions/setup-node@v6
with:
node-version: '24'
registry-url: 'https://registry.npmjs.org'
package-manager-cache: false # Disable automatic npm dependency caching to reduce cache poisoning risk
- run: npm ci
- run: npm run build --if-present
- run: npm publish
```
> **Note**: If the Trusted Publisher configuration (GitHub owner/repo/workflow file, and optional environment) does not match the workflow run identity exactly, publishing may fail with **E404 Not Found** even if the package exists on npm.
For more details, see the [npm Trusted Publishers documentation](https://docs.npmjs.com/trusted-publishers) and the [GitHub Actions OpenID Connect (OIDC) overview](https://docs.github.com/en/actions/concepts/security/openid-connect).
## Use private mirror ## Use private mirror
It is possible to use a private mirror hosting Node.js binaries. This mirror must be a full mirror of the official Node.js distribution. It is possible to use a private mirror hosting Node.js binaries. This mirror must be a full mirror of the official Node.js distribution.
@@ -488,4 +563,5 @@ The token will be passed in the `Authorization` header.
node-version: '24.x' node-version: '24.x'
mirror: 'https://nodejs.org/dist' mirror: 'https://nodejs.org/dist'
mirror-token: 'your-mirror-token' mirror-token: 'your-mirror-token'
cache-package-manager: false # Disable automatic npm caching if not required
``` ```
+74
View File
@@ -0,0 +1,74 @@
// This is a reusable configuration file copied from https://github.com/actions/reusable-workflows/tree/main/reusable-configurations. Please don't make changes to this file as it's the subject of an automatic update.
import js from '@eslint/js';
import tsParser from '@typescript-eslint/parser';
import tsPlugin from '@typescript-eslint/eslint-plugin';
import jest from 'eslint-plugin-jest';
import n from 'eslint-plugin-n';
import prettier from 'eslint-config-prettier';
import globals from 'globals';
export default [
{
ignores: ['**/*', '!src/**', '!__tests__/**']
},
js.configs.recommended,
{
files: ['**/*.ts'],
languageOptions: {
parser: tsParser,
ecmaVersion: 2022,
sourceType: 'module',
globals: {
...globals.node,
...globals.es2015
}
},
plugins: {
'@typescript-eslint': tsPlugin,
n
},
rules: {
...tsPlugin.configs.recommended.rules,
'@typescript-eslint/no-require-imports': 'error',
'@typescript-eslint/no-non-null-assertion': 'off',
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-empty-function': 'off',
'@typescript-eslint/ban-ts-comment': [
'error',
{
'ts-ignore': 'allow-with-description'
}
],
'no-console': 'error',
yoda: 'error',
'prefer-const': [
'error',
{
destructuring: 'all'
}
],
'no-control-regex': 'off',
'no-constant-condition': ['error', {checkLoops: false}],
'no-undef': 'off',
'no-useless-assignment': 'off',
'n/no-extraneous-import': 'error'
}
},
{
files: ['**/*{test,spec}.ts'],
plugins: {jest},
languageOptions: {
globals: {
...globals.jest
}
},
rules: {
...jest.configs['flat/recommended'].rules,
'@typescript-eslint/no-unused-vars': 'off',
'jest/no-standalone-expect': 'off',
'jest/no-conditional-expect': 'off',
'no-console': 'off'
}
},
prettier
];
-11
View File
@@ -1,11 +0,0 @@
module.exports = {
clearMocks: true,
moduleFileExtensions: ['js', 'ts'],
testEnvironment: 'node',
testMatch: ['**/*.test.ts'],
testRunner: 'jest-circus/runner',
transform: {
'^.+\\.ts$': 'ts-jest'
},
verbose: true
}
+24
View File
@@ -0,0 +1,24 @@
export default {
clearMocks: true,
moduleFileExtensions: ['js', 'ts'],
roots: ['<rootDir>'],
testEnvironment: 'node',
testMatch: ['**/*.test.ts'],
transform: {
'^.+\\.ts$': [
'ts-jest',
{
useESM: true,
diagnostics: {
ignoreCodes: [151002]
}
}
]
},
extensionsToTreatAsEsm: ['.ts'],
transformIgnorePatterns: ['node_modules/(?!(@actions)/)'],
moduleNameMapper: {
'^(\\.{1,2}/.*)\\.js$': '$1'
},
verbose: true
}
+2862 -2008
View File
File diff suppressed because it is too large Load Diff
+33 -31
View File
@@ -1,6 +1,7 @@
{ {
"name": "setup-node", "name": "setup-node",
"version": "6.4.0", "version": "7.0.0",
"type": "module",
"private": true, "private": true,
"description": "setup node action", "description": "setup node action",
"main": "lib/setup-node.js", "main": "lib/setup-node.js",
@@ -9,11 +10,11 @@
}, },
"scripts": { "scripts": {
"build": "ncc build -o dist/setup src/setup-node.ts && ncc build -o dist/cache-save src/cache-save.ts", "build": "ncc build -o dist/setup src/setup-node.ts && ncc build -o dist/cache-save src/cache-save.ts",
"format": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --write \"**/*.{ts,yml,yaml}\"", "format": "prettier --no-error-on-unmatched-pattern --write \"**/*.{ts,yml,yaml}\"",
"format-check": "prettier --no-error-on-unmatched-pattern --config ./.prettierrc.js --check \"**/*.{ts,yml,yaml}\"", "format-check": "prettier --no-error-on-unmatched-pattern --check \"**/*.{ts,yml,yaml}\"",
"lint": "eslint --config ./.eslintrc.js \"**/*.ts\"", "lint": "eslint \"**/*.ts\"",
"lint:fix": "eslint --config ./.eslintrc.js \"**/*.ts\" --fix", "lint:fix": "eslint \"**/*.ts\" --fix",
"test": "jest --coverage", "test": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js --runInBand --coverage",
"pre-checkin": "npm run format && npm run lint:fix && npm run build && npm test" "pre-checkin": "npm run format && npm run lint:fix && npm run build && npm test"
}, },
"repository": { "repository": {
@@ -28,32 +29,33 @@
"author": "GitHub", "author": "GitHub",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@actions/cache": "^5.0.5", "@actions/cache": "^6.1.0",
"@actions/core": "^2.0.3", "@actions/core": "^3.0.1",
"@actions/exec": "^2.0.0", "@actions/exec": "^3.0.0",
"@actions/github": "^6.0.1", "@actions/github": "^9.1.1",
"@actions/glob": "^0.5.1", "@actions/glob": "^0.7.0",
"@actions/http-client": "^3.0.2", "@actions/http-client": "^4.0.1",
"@actions/io": "^2.0.0", "@actions/io": "^3.0.2",
"@actions/tool-cache": "^3.0.1", "@actions/tool-cache": "^4.0.0",
"semver": "^7.6.3" "semver": "^7.8.5"
}, },
"devDependencies": { "devDependencies": {
"@types/jest": "^29.5.14", "@eslint/js": "^10.0.1",
"@types/node": "^24.1.0", "@jest/globals": "^30.4.1",
"@types/semver": "^7.5.8", "@types/node": "^26.0.0",
"@typescript-eslint/eslint-plugin": "^5.54.0", "@types/semver": "^7.7.0",
"@typescript-eslint/parser": "^5.54.0", "@typescript-eslint/eslint-plugin": "^8.62.0",
"@vercel/ncc": "^0.38.3", "@typescript-eslint/parser": "^8.62.0",
"eslint": "^8.57.0", "@vercel/ncc": "^0.44.0",
"eslint-config-prettier": "^8.6.0", "eslint": "^10.5.0",
"eslint-plugin-jest": "^27.9.0", "eslint-config-prettier": "^10.1.8",
"eslint-plugin-node": "^11.1.0", "eslint-plugin-jest": "^29.15.2",
"jest": "^29.7.0", "eslint-plugin-n": "^18.1.0",
"jest-circus": "^29.7.0", "globals": "^17.7.0",
"jest-each": "^29.7.0", "jest": "^30.4.2",
"prettier": "^3.6.2", "jest-each": "^30.4.1",
"ts-jest": "^29.4.1", "prettier": "^3.8.4",
"typescript": "^5.4.2" "ts-jest": "^29.4.11",
"typescript": "^6.0.3"
} }
} }
+4 -5
View File
@@ -46,9 +46,8 @@ function writeRegistryToFile(registryUrl: string, fileLocation: string) {
newContents += `${authString}${os.EOL}${registryString}`; newContents += `${authString}${os.EOL}${registryString}`;
fs.writeFileSync(fileLocation, newContents); fs.writeFileSync(fileLocation, newContents);
core.exportVariable('NPM_CONFIG_USERCONFIG', fileLocation); core.exportVariable('NPM_CONFIG_USERCONFIG', fileLocation);
// Export empty node_auth_token if didn't exist so npm doesn't complain about not being able to find it // Only export NODE_AUTH_TOKEN if explicitly provided by user
core.exportVariable( if (Object.prototype.hasOwnProperty.call(process.env, 'NODE_AUTH_TOKEN')) {
'NODE_AUTH_TOKEN', core.exportVariable('NODE_AUTH_TOKEN', process.env.NODE_AUTH_TOKEN);
process.env.NODE_AUTH_TOKEN || 'XXXXX-XXXXX-XXXXX-XXXXX' }
);
} }
+5 -2
View File
@@ -5,13 +5,13 @@ import path from 'path';
import fs from 'fs'; import fs from 'fs';
import os from 'os'; import os from 'os';
import {State} from './constants'; import {State} from './constants.js';
import { import {
getCacheDirectories, getCacheDirectories,
getPackageManagerInfo, getPackageManagerInfo,
repoHasYarnBerryManagedDependencies, repoHasYarnBerryManagedDependencies,
PackageManagerInfo PackageManagerInfo
} from './cache-utils'; } from './cache-utils.js';
export const restoreCache = async ( export const restoreCache = async (
packageManager: string, packageManager: string,
@@ -45,6 +45,7 @@ export const restoreCache = async (
core.debug(`primary key is ${primaryKey}`); core.debug(`primary key is ${primaryKey}`);
core.saveState(State.CachePrimaryKey, primaryKey); core.saveState(State.CachePrimaryKey, primaryKey);
core.setOutput('cache-primary-key', primaryKey);
const isManagedByYarnBerry = await repoHasYarnBerryManagedDependencies( const isManagedByYarnBerry = await repoHasYarnBerryManagedDependencies(
packageManagerInfo, packageManagerInfo,
@@ -61,6 +62,8 @@ export const restoreCache = async (
} }
core.setOutput('cache-hit', Boolean(cacheKey)); core.setOutput('cache-hit', Boolean(cacheKey));
core.setOutput('cache-matched-key', cacheKey);
core.debug(`cache-matched-key is ${cacheKey}`);
if (!cacheKey) { if (!cacheKey) {
core.info(`${packageManager} cache is not found`); core.info(`${packageManager} cache is not found`);
+7 -3
View File
@@ -1,8 +1,8 @@
import * as core from '@actions/core'; import * as core from '@actions/core';
import * as cache from '@actions/cache'; import * as cache from '@actions/cache';
import {State} from './constants'; import {State} from './constants.js';
import {getPackageManagerInfo} from './cache-utils'; import {getPackageManagerInfo} from './cache-utils.js';
// Catch and log any unhandled exceptions. These exceptions can leak out of the uploadChunk method in // Catch and log any unhandled exceptions. These exceptions can leak out of the uploadChunk method in
// @actions/toolkit when a failed upload closes the file descriptor causing any in-process reads to // @actions/toolkit when a failed upload closes the file descriptor causing any in-process reads to
@@ -62,7 +62,11 @@ const cachePackages = async (packageManager: string) => {
} }
const cacheId = await cache.saveCache(cachePaths, primaryKey); const cacheId = await cache.saveCache(cachePaths, primaryKey);
if (cacheId == -1) { if (cacheId === -1) {
// saveCache returns -1 without throwing when the cache was not saved, e.g.
// a reserve collision or a read-only token (fork PR). @actions/cache has
// already logged the reason at the appropriate severity, so just trace it.
core.debug(`Cache was not saved for the key: ${primaryKey}`);
return; return;
} }
+2 -2
View File
@@ -4,7 +4,7 @@ import * as cache from '@actions/cache';
import * as glob from '@actions/glob'; import * as glob from '@actions/glob';
import path from 'path'; import path from 'path';
import fs from 'fs'; import fs from 'fs';
import {unique} from './util'; import {unique} from './util.js';
export interface PackageManagerInfo { export interface PackageManagerInfo {
name: string; name: string;
@@ -91,7 +91,7 @@ export const getCommandOutputNotEmpty = async (
error: string, error: string,
cwd?: string cwd?: string
): Promise<string> => { ): Promise<string> => {
const stdOut = getCommandOutput(toolCommand, cwd); const stdOut = await getCommandOutput(toolCommand, cwd);
if (!stdOut) { if (!stdOut) {
throw new Error(error); throw new Error(error);
} }
@@ -2,8 +2,8 @@ import * as tc from '@actions/tool-cache';
import semver from 'semver'; import semver from 'semver';
import BaseDistribution from './base-distribution'; import BaseDistribution from './base-distribution.js';
import {NodeInputs} from './base-models'; import {NodeInputs} from './base-models.js';
export default abstract class BasePrereleaseNodejs extends BaseDistribution { export default abstract class BasePrereleaseNodejs extends BaseDistribution {
protected abstract distribution: string; protected abstract distribution: string;
+15 -9
View File
@@ -9,8 +9,8 @@ import * as assert from 'assert';
import * as path from 'path'; import * as path from 'path';
import os from 'os'; import os from 'os';
import fs from 'fs'; import fs from 'fs';
import {fileURLToPath} from 'url';
import {NodeInputs, INodeVersion, INodeVersionInfo} from './base-models'; import {NodeInputs, INodeVersion, INodeVersionInfo} from './base-models.js';
export default abstract class BaseDistribution { export default abstract class BaseDistribution {
protected httpClient: hc.HttpClient; protected httpClient: hc.HttpClient;
@@ -26,9 +26,8 @@ export default abstract class BaseDistribution {
protected abstract getDistributionUrl(mirror: string): string; protected abstract getDistributionUrl(mirror: string): string;
public async setupNodeJs() { public async setupNodeJs() {
let nodeJsVersions: INodeVersion[] | undefined;
if (this.nodeInfo.checkLatest) { if (this.nodeInfo.checkLatest) {
const evaluatedVersion = await this.findVersionInDist(nodeJsVersions); const evaluatedVersion = await this.findVersionInDist(undefined);
this.nodeInfo.versionSpec = evaluatedVersion; this.nodeInfo.versionSpec = evaluatedVersion;
} }
@@ -36,7 +35,7 @@ export default abstract class BaseDistribution {
if (toolPath) { if (toolPath) {
core.info(`Found in cache @ ${toolPath}`); core.info(`Found in cache @ ${toolPath}`);
} else { } else {
const evaluatedVersion = await this.findVersionInDist(nodeJsVersions); const evaluatedVersion = await this.findVersionInDist(undefined);
const toolName = this.getNodejsDistInfo(evaluatedVersion); const toolName = this.getNodejsDistInfo(evaluatedVersion);
toolPath = await this.downloadNodejs(toolName); toolPath = await this.downloadNodejs(toolName);
} }
@@ -168,12 +167,14 @@ export default abstract class BaseDistribution {
return toolPath; return toolPath;
} }
protected validRange(versionSpec: string) { protected validRange(versionSpec: string): {
let options: semver.RangeOptions | undefined; range: string;
options: semver.RangeOptions | undefined;
} {
const c = semver.clean(versionSpec) || ''; const c = semver.clean(versionSpec) || '';
const valid = semver.valid(c) ?? versionSpec; const valid = semver.valid(c) ?? versionSpec;
return {range: valid, options}; return {range: valid, options: undefined};
} }
protected async acquireWindowsNodeFromFallbackLocation( protected async acquireWindowsNodeFromFallbackLocation(
@@ -259,7 +260,12 @@ export default abstract class BaseDistribution {
fs.renameSync(downloadPath, renamedArchive); fs.renameSync(downloadPath, renamedArchive);
extPath = await tc.extractZip(renamedArchive); extPath = await tc.extractZip(renamedArchive);
} else { } else {
const _7zPath = path.join(__dirname, '../..', 'externals', '7zr.exe'); const _7zPath = path.join(
path.dirname(fileURLToPath(import.meta.url)),
'../..',
'externals',
'7zr.exe'
);
extPath = await tc.extract7z(downloadPath, undefined, _7zPath); extPath = await tc.extract7z(downloadPath, undefined, _7zPath);
} }
// 7z extracts to folder matching file name // 7z extracts to folder matching file name
+6 -6
View File
@@ -1,9 +1,9 @@
import BaseDistribution from './base-distribution'; import BaseDistribution from './base-distribution.js';
import {NodeInputs} from './base-models'; import {NodeInputs} from './base-models.js';
import NightlyNodejs from './nightly/nightly_builds'; import NightlyNodejs from './nightly/nightly_builds.js';
import OfficialBuilds from './official_builds/official_builds'; import OfficialBuilds from './official_builds/official_builds.js';
import RcBuild from './rc/rc_builds'; import RcBuild from './rc/rc_builds.js';
import CanaryBuild from './v8-canary/canary_builds'; import CanaryBuild from './v8-canary/canary_builds.js';
enum Distributions { enum Distributions {
DEFAULT = '', DEFAULT = '',
+2 -2
View File
@@ -1,5 +1,5 @@
import BasePrereleaseNodejs from '../base-distribution-prerelease'; import BasePrereleaseNodejs from '../base-distribution-prerelease.js';
import {NodeInputs} from '../base-models'; import {NodeInputs} from '../base-models.js';
export default class NightlyNodejs extends BasePrereleaseNodejs { export default class NightlyNodejs extends BasePrereleaseNodejs {
protected distribution = 'nightly'; protected distribution = 'nightly';
@@ -2,8 +2,8 @@ import * as core from '@actions/core';
import * as tc from '@actions/tool-cache'; import * as tc from '@actions/tool-cache';
import path from 'path'; import path from 'path';
import BaseDistribution from '../base-distribution'; import BaseDistribution from '../base-distribution.js';
import {NodeInputs, INodeVersion, INodeVersionInfo} from '../base-models'; import {NodeInputs, INodeVersion, INodeVersionInfo} from '../base-models.js';
interface INodeRelease extends tc.IToolRelease { interface INodeRelease extends tc.IToolRelease {
lts?: string; lts?: string;
@@ -84,7 +84,9 @@ export default class OfficialBuilds extends BaseDistribution {
downloadPath = await tc.downloadTool( downloadPath = await tc.downloadTool(
versionInfo.downloadUrl, versionInfo.downloadUrl,
undefined, undefined,
this.nodeInfo.mirror ? this.nodeInfo.mirrorToken : this.nodeInfo.auth this.nodeInfo.mirror && this.nodeInfo.mirrorToken
? this.nodeInfo.mirrorToken
: this.nodeInfo.auth
); );
if (downloadPath) { if (downloadPath) {
@@ -188,7 +190,9 @@ export default class OfficialBuilds extends BaseDistribution {
return tc.getManifestFromRepo( return tc.getManifestFromRepo(
'actions', 'actions',
'node-versions', 'node-versions',
this.nodeInfo.mirror ? this.nodeInfo.mirrorToken : this.nodeInfo.auth, this.nodeInfo.mirror && this.nodeInfo.mirrorToken
? this.nodeInfo.mirrorToken
: this.nodeInfo.auth,
'main' 'main'
); );
} }
+2 -2
View File
@@ -1,5 +1,5 @@
import BaseDistribution from '../base-distribution'; import BaseDistribution from '../base-distribution.js';
import {NodeInputs} from '../base-models'; import {NodeInputs} from '../base-models.js';
export default class RcBuild extends BaseDistribution { export default class RcBuild extends BaseDistribution {
constructor(nodeInfo: NodeInputs) { constructor(nodeInfo: NodeInputs) {
+2 -2
View File
@@ -1,5 +1,5 @@
import BasePrereleaseNodejs from '../base-distribution-prerelease'; import BasePrereleaseNodejs from '../base-distribution-prerelease.js';
import {NodeInputs} from '../base-models'; import {NodeInputs} from '../base-models.js';
export default class CanaryBuild extends BasePrereleaseNodejs { export default class CanaryBuild extends BasePrereleaseNodejs {
protected distribution = 'v8-canary'; protected distribution = 'v8-canary';
+12 -7
View File
@@ -2,14 +2,15 @@ import * as core from '@actions/core';
import os from 'os'; import os from 'os';
import fs from 'fs'; import fs from 'fs';
import {fileURLToPath} from 'url';
import * as auth from './authutil'; import * as auth from './authutil.js';
import * as path from 'path'; import * as path from 'path';
import {restoreCache} from './cache-restore'; import {restoreCache} from './cache-restore.js';
import {isCacheFeatureAvailable} from './cache-utils'; import {isCacheFeatureAvailable} from './cache-utils.js';
import {getNodejsDistribution} from './distributions/installer-factory'; import {getNodejsDistribution} from './distributions/installer-factory.js';
import {getNodeVersionFromFile, printEnvDetailsAndSetOutput} from './util'; import {getNodeVersionFromFile, printEnvDetailsAndSetOutput} from './util.js';
import {State} from './constants'; import {State} from './constants.js';
export async function run() { export async function run() {
try { try {
@@ -87,7 +88,11 @@ export async function run() {
} }
} }
const matchersPath = path.join(__dirname, '../..', '.github'); const matchersPath = path.join(
path.dirname(fileURLToPath(import.meta.url)),
'../..',
'.github'
);
core.info(`##[add-matcher]${path.join(matchersPath, 'tsc.json')}`); core.info(`##[add-matcher]${path.join(matchersPath, 'tsc.json')}`);
core.info( core.info(
`##[add-matcher]${path.join(matchersPath, 'eslint-stylish.json')}` `##[add-matcher]${path.join(matchersPath, 'eslint-stylish.json')}`
+1 -1
View File
@@ -1,3 +1,3 @@
import {run} from './main'; import {run} from './main.js';
run(); run();
+1 -1
View File
@@ -105,7 +105,7 @@ async function getToolVersion(tool: string, options: string[]) {
} }
return stdout.trim(); return stdout.trim();
} catch (err) { } catch {
return ''; return '';
} }
} }
+2 -2
View File
@@ -1,7 +1,7 @@
{ {
"compilerOptions": { "compilerOptions": {
"target": "ES2022", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */ "target": "ES2022", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */ "module": "NodeNext", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
"outDir": "./lib", /* Redirect output structure to the directory. */ "outDir": "./lib", /* Redirect output structure to the directory. */
"rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ "rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
"sourceMap": true, "sourceMap": true,
@@ -10,5 +10,5 @@
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
"resolveJsonModule": true, /* Allows importing modules with a '.json' extension, which is a common practice in node projects. */ "resolveJsonModule": true, /* Allows importing modules with a '.json' extension, which is a common practice in node projects. */
}, },
"exclude": ["__tests__", "lib", "node_modules"] "exclude": ["__tests__", "lib", "node_modules", "jest.config.ts"]
} }