Compare commits

..
1 Commits
30 changed files with 14595 additions and 68450 deletions

No files matched your search

+14 -2
View File
@@ -1,4 +1,16 @@
module.exports = {
ignorePatterns: ['build/**', 'node_modules/**'],
extends: ['universe/node'],
ignorePatterns: ['/build/**', 'node_modules/**'],
parser: '@typescript-eslint/parser',
plugins: ['@typescript-eslint', 'jest', 'prettier'],
env: {
es6: true,
'jest/globals': true,
node: true,
},
extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
rules: {
'@typescript-eslint/explicit-member-accessibility': ['error', { accessibility: 'no-public' }],
'@typescript-eslint/no-var-requires': 'off',
'prettier/prettier': 'error',
},
};
+2 -5
View File
@@ -17,9 +17,6 @@ jobs:
- macos-latest
- ubuntu-latest
- windows-latest
cache:
- true
- false
runs-on: ${{ matrix.os }}
steps:
- name: 🏗 Setup repo
@@ -29,9 +26,9 @@ jobs:
uses: ./
with:
eas-version: latest
eas-cache: ${{ matrix.cache }}
eas-cache: true
expo-version: latest
expo-cache: ${{ matrix.cache }}
expo-cache: true
token: ${{ secrets.EXPO_TOKEN }}
- name: 🧪 EAS installed
+11
View File
@@ -0,0 +1,11 @@
{
"jsc": {
"target": "es2020",
"parser": {
"syntax": "typescript"
}
},
"module": {
"type": "commonjs"
}
}
-60
View File
@@ -1,63 +1,3 @@
## [7.0.0](https://github.com/expo/expo-github-action/compare/6.0.0...7.0.0) (2022-01-13)
### ⚠ BREAKING CHANGES
* some input options are deprecated
- Username and password authentication is dropped in favor of tokens
- Custom cache keys are dropped
- Custom install error handler is dropped
### Bug fixes
* use which instead of npx to authenticate ([#147](https://github.com/expo/expo-github-action/issues/147)) ([c5d2c0f](https://github.com/expo/expo-github-action/commit/c5d2c0f8c034b625147bc4b2ccd6d14a29412a1d))
### Code changes
* allow multiple entrypoints for different sub-actions ([#121](https://github.com/expo/expo-github-action/issues/121)) ([8a7306a](https://github.com/expo/expo-github-action/commit/8a7306a97854f9b2853a614d3302061922471a8f))
* clean up setup action ([#146](https://github.com/expo/expo-github-action/issues/146)) ([439ff4c](https://github.com/expo/expo-github-action/commit/439ff4c9aa508ea6f38364859109267d8f26fcf1))
* enable caches by default ([#148](https://github.com/expo/expo-github-action/issues/148)) ([72d4067](https://github.com/expo/expo-github-action/commit/72d406754f3b10aeff9b54a2b3e3e833d4cd3c9f))
* replace libnpm with npm cli ([#139](https://github.com/expo/expo-github-action/issues/139)) ([4f28493](https://github.com/expo/expo-github-action/commit/4f28493708de28b8eebd418702ec8eb93660927d))
* roll back to ncc because of swc bundling issues ([#144](https://github.com/expo/expo-github-action/issues/144)) ([3007741](https://github.com/expo/expo-github-action/commit/3007741466570f1bf8f3cf7417e56c7aab50b60a))
* update the outdated workflows and use node 16 ([#138](https://github.com/expo/expo-github-action/issues/138)) ([3134e26](https://github.com/expo/expo-github-action/commit/3134e26b3a41fcc058c60c0f34f87c8d44189d3c))
* upgrade to node 16 github actions runtime ([#137](https://github.com/expo/expo-github-action/issues/137)) ([3bf9181](https://github.com/expo/expo-github-action/commit/3bf9181edb0df2dcaf9112b50c9d2a9996db8a32))
* use boolean input instead of manual conversion ([#127](https://github.com/expo/expo-github-action/issues/127)) ([f1fe877](https://github.com/expo/expo-github-action/commit/f1fe8775927c95727008dfe31f580c122913a745))
* use spaces for indentation ([#126](https://github.com/expo/expo-github-action/issues/126)) ([ff2ff0f](https://github.com/expo/expo-github-action/commit/ff2ff0f980f70d0047d10637dd5ef915128199ec))
* use swc pack instead of ncc ([#140](https://github.com/expo/expo-github-action/issues/140)) ([3f9e947](https://github.com/expo/expo-github-action/commit/3f9e9479631f03a941ecfebdcd0351ef57f59a2e))
### Other chores
* add basic e2e test workflow for main action ([#141](https://github.com/expo/expo-github-action/issues/141)) ([414c169](https://github.com/expo/expo-github-action/commit/414c1693e6183ad92723fca4517181b21f93eaf0))
* add manual trigger to the tests ([4908a48](https://github.com/expo/expo-github-action/commit/4908a48f1b5e1ccff9589c0fcaafe4223d53bee1))
* always use lf for build files ([#122](https://github.com/expo/expo-github-action/issues/122)) ([a9b9cfe](https://github.com/expo/expo-github-action/commit/a9b9cfef50ba2c1d38fff1a679c554eb52edc25e))
* bump semver-regex from 3.1.2 to 3.1.3 ([#114](https://github.com/expo/expo-github-action/issues/114)) ([50c0ef9](https://github.com/expo/expo-github-action/commit/50c0ef9028d51bd25197c54102438f494c265438))
* bump tar from 4.4.13 to 4.4.19 ([#112](https://github.com/expo/expo-github-action/issues/112)) ([5f5673b](https://github.com/expo/expo-github-action/commit/5f5673ba7744a05d9c499fbca7b4e503aabef5a1))
* bump tmpl from 1.0.4 to 1.0.5 ([#115](https://github.com/expo/expo-github-action/issues/115)) ([92ec93f](https://github.com/expo/expo-github-action/commit/92ec93fa37744783ec10149e7d755d7181649f8a))
* clean up dependencies and eslint rules ([#145](https://github.com/expo/expo-github-action/issues/145)) ([3ae7999](https://github.com/expo/expo-github-action/commit/3ae799926e78cfecd54e965c77d1c1fb49cac45b))
* clean up master references in release and workflows ([#104](https://github.com/expo/expo-github-action/issues/104)) ([a2d9b1c](https://github.com/expo/expo-github-action/commit/a2d9b1cadf463af1e6b4025af3edc99cf7f4b5a0))
* clean up tsconfig and eslint rules ([#123](https://github.com/expo/expo-github-action/issues/123)) ([c20146f](https://github.com/expo/expo-github-action/commit/c20146f3b7513ae3a3df3dead651d2a2dea988af))
* lint root files with prettier and eslint ([#125](https://github.com/expo/expo-github-action/issues/125)) ([1cfa7bb](https://github.com/expo/expo-github-action/commit/1cfa7bbd9ed623e2e40406addab4bff2c9a7b2fd))
* rebuild project ([45b79a0](https://github.com/expo/expo-github-action/commit/45b79a05ef7496339d33d03fdd7755ef76c7038b))
* rebuild project after dependency bumps ([b099f17](https://github.com/expo/expo-github-action/commit/b099f17d588e23df069b60d39ca1e21327066a4f))
* remove husky and improve ci build message ([#128](https://github.com/expo/expo-github-action/issues/128)) ([39b0d36](https://github.com/expo/expo-github-action/commit/39b0d361f7d97ef1a71a02495463d1e93a72093a))
* simplify review and update build detection ([#142](https://github.com/expo/expo-github-action/issues/142)) ([ee415b0](https://github.com/expo/expo-github-action/commit/ee415b027afce4c15cabcc6fa2f8368530a36c08))
* update `setup-node` action to `v2` release ([#119](https://github.com/expo/expo-github-action/issues/119)) ([3b3e6b8](https://github.com/expo/expo-github-action/commit/3b3e6b8031b898cdf0bc59488d541d90748954b9))
* update the action manifest ([633cdf0](https://github.com/expo/expo-github-action/commit/633cdf0ac9f283f5a7010fef11bfda9174278054))
* upgrade dev dependencies and rebuild action ([#120](https://github.com/expo/expo-github-action/issues/120)) ([186ef00](https://github.com/expo/expo-github-action/commit/186ef0011a259a7b2c745f8cf2743358ca112530))
### Documentation changes
* fix broken sup element in readme ([0b1822a](https://github.com/expo/expo-github-action/commit/0b1822a93580171a0582013a0cf7848cf3503ed7))
* fix github capitalization ([#116](https://github.com/expo/expo-github-action/issues/116)) ([b602469](https://github.com/expo/expo-github-action/commit/b60246939fba50e600b11596b4b1029091017b7c))
* fix unsplash comment on pr branch reference ([#110](https://github.com/expo/expo-github-action/issues/110)) ([f14253e](https://github.com/expo/expo-github-action/commit/f14253ea9c17296e843610c7b8fad4e13c7abda0))
* update expo.io links to expo.dev ([#111](https://github.com/expo/expo-github-action/issues/111)) ([1c8e5a2](https://github.com/expo/expo-github-action/commit/1c8e5a21e9689cedd8fbcf61e50a3f4700b6bc41))
* update node version reference in readme ([#107](https://github.com/expo/expo-github-action/issues/107)) ([3ba667b](https://github.com/expo/expo-github-action/commit/3ba667b43f1e103a1c64e92a60d7c36bd0ad10b2))
* update readme and contributing guides ([521de72](https://github.com/expo/expo-github-action/commit/521de724fcb79235773c077e870d7c2293ab51cb))
* use `main` branch to update `v{major}` tag ([#103](https://github.com/expo/expo-github-action/issues/103)) ([def44e2](https://github.com/expo/expo-github-action/commit/def44e2c77a39f5bd48dbb07adec509137afcf67))
## [6.0.0](https://github.com/expo/expo-github-action/compare/5.5.1...6.0.0) (2021-06-22)
+3 -3
View File
@@ -10,16 +10,16 @@
## 🏎️ Running a custom version
To try out your changes with GitHub Action, you have [to reference your fork and/or branch or commit reference](https://docs.github.com/en/actions/learn-github-actions/finding-and-customizing-actions#using-release-management-for-your-custom-actions) in the workflow you want to try. After that, you have two options:
To try out your changed with GitHub Action, you have [to reference your fork and/or branch or commit reference](https://docs.github.com/en/actions/learn-github-actions/finding-and-customizing-actions#using-release-management-for-your-custom-actions) in the workflow you want to try. After that, you have two options:
1. Run the workflow in GitHub Actions itself by triggering your workflow.
2. Run the workflow locally with [nektos/act](https://github.com/nektos/act).
## 🧪 Testing
## ✅ Testing
Testing is done using [Jest](https://jestjs.io/https://jestjs.io/). Run `yarn test` to run Jest.
If your PR is ready, run the **test** workflow to test the workflows on all supported OS system.
In CI we are running tests on multiple Node versions using Windows, Linux, and MacOS. Make sure they are passing for your PR.
## 📝 Writing a Commit Message
+139 -38
View File
@@ -25,8 +25,8 @@
## What's inside?
With this Expo action, you have full access to [Expo CLI][link-expo-cli] and [EAS CLI][link-eas-cli].
It allows you to fully automate the `expo publish` or `eas build` process, leaving you with more time available for your project.
With this Expo action, you have full access to [Expo CLI][link-expo-cli] and [EAS CLI][link-eas-cli] itself.
It allows you to fully automate the `expo publish` or `expo build` process, leaving you with more time available for your project.
There are some additional features included to make the usage of this action as simple as possible, like caching and authentication.
## Configuration options
@@ -34,17 +34,21 @@ There are some additional features included to make the usage of this action as
This action is customizable through variables; they are defined in the [`action.yml`](action.yml).
Here is a summary of all the variables that you can use and their purpose.
| variable | default | description |
| ---------------- | ------- | ------------------------------------------------------------------------------------ |
| `expo-version` | `''` | [Expo CLI](https://github.com/expo/expo-cli) version to install, skips when omitted. |
| `expo-cache` | `true` | If it should use the [GitHub actions cache](#using-the-built-in-cache). |
| `eas-version` | `''` | [EAS CLI](https://github.com/expo/eas-cli) version to install, skips when omitted. |
| `eas-cache` | `true` | If it should use the [GitHub actions cache](#using-the-built-in-cache). |
| `packager` | `yarn` | The package manager to use. _(e.g. `yarn` or `npm`)_ |
| `token` | `''` | The token of your Expo account |
| `patch-watchers` | `true` | If it should [patch the `fs.inotify.` limits](#enospc-errors-on-linux). |
| variable | default | description |
| ---------------- | ------- | ------------------------------------------------------------------------------------------------------------ |
| `expo-version` | - | [Expo CLI](https://github.com/expo/expo-cli) version to install, skips when omitted. |
| `expo-cache` | `false` | If it should use the [GitHub actions (remote) cache](#using-the-built-in-cache). |
| `expo-cache-key` | - | An optional custom (remote) cache key. _(**use with caution**)_ |
| `eas-version` | - | [EAS CLI](https://github.com/expo/eas-cli) version to install, skips when omitted. (`latest` is recommended) |
| `eas-cache` | `false` | If it should use the [GitHub actions (remote) cache](#using-the-built-in-cache). |
| `eas-cache-key` | - | An optional custom (remote) cache key. _(**use with caution**)_ |
| `packager` | `yarn` | The package manager to use. _(e.g. `npm`)_ |
| `token` | - | The token of your Expo account _(e.g. [`${{ secrets.EXPO_TOKEN }}`][link-actions-secrets])_ |
| `username` | - | The username of your Expo account _(e.g. `bycedric`)_ |
| `password` | - | The password of your Expo account _(e.g. [`${{ secrets.EXPO_CLI_PASSWORD }}`][link-actions-secrets])_ |
| `patch-watchers` | `true` | If it should [patch the `fs.inotify.` limits](#enospc-errors-on-linux). |
> Never hardcode `expo-token` in your workflow, use [secrets][link-actions-secrets] to store them.
> Never hardcode `expo-token` or `expo-password` in your workflow, use [secrets][link-actions-secrets] to store them.
> Using `latest` for `eas-version` is recommened, you should always have the latest version of this CLI installed.
@@ -54,9 +58,12 @@ Before you dive into the workflow examples, you should know the basics of GitHub
You can read more about this in the [GitHub Actions documentation][link-actions].
1. [Publish on any push to main](#publish-on-any-push-to-main)
2. [Creating a new EAS build](#creating-a-new-eas-build)
3. [Test PRs and publish a review version](#test-prs-and-publish-a-review-version)
4. [Test PRs on multiple nodes and systems](#test-prs-on-multiple-node-versions-and-systems)
2. [Cache Expo CLI for other jobs](#cache-expo-cli-for-other-jobs)
3. [Creating a new EAS build](#creating-a-new-eas-build)
4. [Test PRs and publish a review version](#test-prs-and-publish-a-review-version)
5. [Test PRs on multiple nodes and systems](#test-prs-on-multiple-nodes-and-systems)
6. [Test and build web every day at 08:00](#test-and-build-web-every-day-at-0800)
7. [Authenticate using credentials](#authenticate-using-credentials)
### Publish on any push to main
@@ -65,22 +72,55 @@ The workflow listens to the `push` event and sets up Node 14 using the [Setup No
It also auto-authenticates when the `token` is provided.
```yml
name: Expo Publish
on:
push:
branches:
- main
jobs:
publish:
name: Install and publish
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
node-version: 14.x
- uses: expo/expo-github-action@v6
with:
expo-version: 5.x
expo-version: 4.x
token: ${{ secrets.EXPO_TOKEN }}
- run: yarn install
- run: expo publish
```
### Cache Expo CLI for other jobs
Below you can see a slightly modified version of the example above.
In this one, we enabled the built-in cache that will reuse a previously installed Expo CLI.
It skips the installation part and extracts the files directly, boosting the performance of your workflow.
> You can [read more about the cache here](#using-the-built-in-cache)
```yml
name: Expo Publish
on:
push:
branches:
- main
jobs:
publish:
name: Install and publish
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 14.x
- uses: expo/expo-github-action@v6
with:
expo-version: 4.x
expo-cache: true
token: ${{ secrets.EXPO_TOKEN }}
- run: yarn install
- run: expo publish
@@ -95,19 +135,20 @@ Both the `token` and `username`/`password` is shared between both Expo and EAS C
> We recommend using `latest` for `eas-version` to always have the most up-to-date version.
```yml
name: EAS build
on:
push:
branches:
- main
jobs:
build:
name: Create new build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
node-version: 14.x
- uses: expo/expo-github-action@v6
with:
eas-version: latest
@@ -123,33 +164,31 @@ To make this easier, you can publish the edited version of the PR using a [relea
Below you can see an example of a workflow that publishes and comments on te PR when the app is published.
```yml
name: Expo Review
on: [pull_request]
env:
projectOwner: bycedric
projectSlug: use-expo
jobs:
publish:
name: Install and publish
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 16.x
cache: yarn
node-version: 14.x
- uses: expo/expo-github-action@v6
with:
expo-version: 5.x
expo-version: 4.x
token: ${{ secrets.EXPO_TOKEN }}
- run: yarn install
- run: expo publish --release-channel=pr-${{ github.event.number }}
- uses: unsplash/comment-on-pr@v1.1.1
- uses: unsplash/comment-on-pr@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
msg: App is ready for review, you can [see it here](https://expo.dev/@${{ env.projectOwner }}/${{ env.projectSlug }}?release-channel=pr-${{ github.event.number }}).\n\n<img src="https://qr.expo.dev/expo-go?owner=${{ env.projectOwner }}&slug=${{ env.projectSlug }}&releaseChannel=pr-${{ github.event.number }}" height="200px" width="200px"></a>
msg: App is ready for review, you can [see it here](https://expo.dev/@bycedric/use-expo?release-channel=pr-${{ github.event.number }}).
```
### Test PRs on multiple node versions and systems
### Test PRs on multiple nodes and systems
With GitHub Actions, it's reasonably easy to set up a matrix build and test the app on multiple environments.
These matrixes can help to make sure your app runs smoothly on a broad set of different development machines.
@@ -157,42 +196,102 @@ These matrixes can help to make sure your app runs smoothly on a broad set of di
> If you don't need automatic authentication, you can omit the `token` variables.
```yml
name: Expo CI
on: [pull_request]
jobs:
ci:
name: Continuous Integration
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [ubuntu-latest, macOS-latest, windows-latest]
node: [14.x, 16.x]
node: [10, 12, 13]
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node }}
cache: yarn
- uses: expo/expo-github-action@v6
with:
expo-version: 5.x
expo-version: 4.x
- run: yarn install
- run: yarn test
- run: expo doctor
```
### Test and build web every day at 08:00
You can also schedule jobs by using the cron syntax.
It can help to minimize the number of updates your users have to install.
```yml
name: Expo Daily CI
on:
schedule:
- cron: 0 8 * * *
jobs:
ci:
name: Daily Continuous Integration
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 14.x
- uses: expo/expo-github-action@v6
with:
expo-version: 4.x
- run: yarn install
- run: yarn test
- run: expo build:web
```
### Authenticate using credentials
Instead of using an access token, you can also authenticate using credentials.
This is only possible when Expo CLI is installed.
```yml
name: Expo Publish
on:
push:
branches:
- main
jobs:
publish:
name: Install and publish
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v2
with:
node-version: 14.x
- uses: expo/expo-github-action@v6
with:
expo-version: 4.x
username: ${{ secrets.EXPO_CLI_USERNAME }}
password: ${{ secrets.EXPO_CLI_PASSWORD }}
- run: yarn install
- run: expo publish
```
## Things to know
### Automatic Expo login
You need to authenticate for some Expo commands like `expo publish` and `expo build`.
This action can export the `EXPO_TOKEN` variable to access it in every step.
This action gives you configuration options to keep your workflow simple.
You can choose if you want to authenticate using an `EXPO_TOKEN` or account credentials.
Under the hood, it uses the [`EXPO_CLI_PASSWORD`][link-expo-cli-password] environment variable to make credentials authentication as secure as possible.
> Note, this action does not store the token anywhere. For every seperate job, you need to setup the token.
> Note, this action only uses your token or credentials to authenticate with Expo. It doesn't store these anywhere.
### Using the built-in cache
Caching is enabled by default to speed up consecutive CLI installs, but you can still opt-out to this.
Under the hood, it uses the [`@actions/cache`][link-actions-cache-package] package to restore the CLI installation.
This action generates a unique cache key for the OS, used packager, and exact version of the CLI.
You can opt-in to caching the installation, making it a lot faster.
Under the hood, it uses the [`@action/cache`][link-actions-cache-package] package to restore the Expo CLI installation.
This action generates a unique cache key for the OS, used packager, and exact version of the Expo CLI.
If you need more control over this cache, you can define a custom cache key with `expo-cache-key`.
> Note, this cache will count towards your [repo cache limit][link-actions-cache-limit]. The Expo and EAS CLI are stored in different caches.
@@ -213,9 +312,11 @@ You can disable this patch by setting the `patch-watchers` to `false`.
[link-actions]: https://help.github.com/en/categories/automating-your-workflow-with-github-actions
[link-actions-cache-limit]: https://github.com/actions/cache#cache-limits
[link-actions-cache-package]: https://github.com/actions/toolkit/tree/main/packages/cache
[link-actions-cache-package]: https://www.npmjs.com/package/@actions/cache
[link-actions-node]: https://github.com/actions/setup-node
[link-actions-secrets]: https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets
[link-expo-cli]: https://docs.expo.dev/workflow/expo-cli/
[link-expo-cli-password]: https://github.com/expo/expo-cli/blob/master/packages/expo-cli/src/accounts.ts#L88-L90
[link-expo-release-channels]: https://docs.expo.dev/distribution/release-channels/
[link-eas-cli]: https://github.com/expo/eas-cli#readme
[link-semver-playground]: https://semver.npmjs.com/
+20 -25
View File
@@ -1,42 +1,37 @@
---
name: Expo GitHub Action
author: Cedric van Putten <[email protected]>
description: Publish, build or manage your Expo app with GitHub Actions
description: Expo CLI in your GitHub Actions workflow.
branding:
icon: terminal
color: gray-dark
runs:
using: node16
main: build/setup/index.js
main: build/setup.js
inputs:
expo-version:
description: Expo CLI version to install
description: The Expo CLI version to install (use any semver/dist-tag available).
expo-cache:
description: If Expo CLI should be cached to speed up installation
default: true
eas-version:
description: EAS CLI version to install
eas-cache:
description: If EAS CLI should be cached to speed up installation
default: true
packager:
description: The package manager used to install the CLIs
default: yarn
patch-watchers:
description: If the action should patch the ENOSPC errors
default: true
token:
description: Your Expo token, for authentication. (use with secrets)
# Below are deprecated and won't be supported anymore
eas-cache-key:
description: A custom remote cache key to use for EAS CLI.
deprecationMessage: Custom cache keys are deprecated and not used anymore.
description: If Expo CLI should be stored in the GitHub Actions cache.
default: false
expo-cache-key:
description: A custom remote cache key to use for Expo CLI.
deprecationMessage: Custom cache keys are deprecated and not used anymore.
eas-version:
description: The EAS CLI version to install (use any semver/dist-tag available).
eas-cache:
description: If EAS CLI should be stored in the GitHub Actions cache.
default: false
eas-cache-key:
description: A custom remote cache key to use for EAS CLI.
username:
description: Your Expo username, for authentication.
deprecationMessage: Username/password authentication is deprecated, use a token instead.
token:
description: Your Expo token, for authentication. (use with secrets)
password:
description: Your Expo password, for authentication. (use with secrets)
deprecationMessage: Username/password authentication is deprecated, use a token instead.
packager:
description: The package manager used to install the Expo CLI. (can be yarn or npm)
default: yarn
patch-watchers:
description: If Expo should fix the default watchers limit, helps with ENOSPC errors. (can be true or false)
default: true
+12574
View File
File diff suppressed because it is too large. Load diff
-65201
View File
File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
+1
View File
@@ -5,6 +5,7 @@ module.exports = {
moduleFileExtensions: ['js', 'ts'],
testEnvironment: 'node',
testMatch: ['**/*.test.ts'],
testRunner: 'jest-circus/runner',
transform: {
'^.+\\.ts$': 'ts-jest',
},
-52
View File
@@ -1,52 +0,0 @@
const ncc = require('@vercel/ncc');
const fs = require('fs');
const path = require('path');
build();
async function build() {
const actionsDir = path.resolve(__dirname, 'src/actions');
const buildDir = path.resolve(__dirname, 'build');
const actions = fs
.readdirSync(actionsDir, { withFileTypes: true })
.filter(entity => entity.isFile())
.map(entity => ({
name: path.basename(entity.name, path.extname(entity.name)),
file: path.resolve(actionsDir, entity.name),
}));
for (const action of actions) {
const files = await compile(action.file);
write(files, path.resolve(buildDir, action.name));
console.log(`✓ ${path.relative(__dirname, action.file)}`);
}
}
async function compile(entry) {
const { code, map, assets } = await ncc(entry, {
cache: false,
license: 'license.txt',
quiet: true,
});
return {
...assets,
'index.js': { source: code },
'index.js.map': { source: map },
};
}
function write(files, dir) {
for (const fileName in files) {
if (!files[fileName].source) {
continue;
}
const filePath = path.resolve(dir, fileName);
fs.mkdirSync(path.dirname(filePath), { recursive: true });
fs.writeFileSync(filePath, files[fileName].source, { encoding: 'utf-8' });
}
}
+26 -20
View File
@@ -1,7 +1,7 @@
{
"private": true,
"name": "expo-github-action",
"version": "7.0.0",
"version": "6.0.0",
"description": "Expo CLI in your GitHub Actions workflow",
"main": "build/index.js",
"repository": {
@@ -16,34 +16,40 @@
"homepage": "https://github.com/expo/expo-github-action#readme",
"scripts": {
"test": "jest",
"lint": "eslint .",
"build": "node ncc.js",
"clean": "rimraf build"
"lint": "tsc --noEmit && eslint .",
"build": "spack && rimraf build/*.map",
"clean": "rimraf build .swc"
},
"dependencies": {
"@actions/cache": "^1.0.8",
"@actions/cache": "^1.0.7",
"@actions/core": "^1.6.0",
"@actions/exec": "^1.1.0",
"@actions/io": "^1.1.1",
"@actions/tool-cache": "^1.7.1"
"@actions/tool-cache": "^1.7.1",
"semver": "^7.3.5"
},
"devDependencies": {
"@semantic-release/changelog": "^6.0.1",
"@semantic-release/git": "^10.0.1",
"@semantic-release/changelog": "^5.0.1",
"@semantic-release/git": "^9.0.0",
"@swc/cli": "^0.1.55",
"@swc/core": "^1.2.128",
"@tsconfig/node16": "^1.0.2",
"@types/jest": "^27.4.0",
"@types/jest": "^27.0.2",
"@types/node": "^16.11.19",
"@typescript-eslint/eslint-plugin": "^5.9.1",
"@typescript-eslint/parser": "^5.9.1",
"@vercel/ncc": "^0.33.1",
"conventional-changelog-conventionalcommits": "^4.6.3",
"eslint": "^8.6.0",
"eslint-config-universe": "^10.0.0",
"jest": "^27.4.7",
"prettier": "^2.5.1",
"@types/semver": "^7.3.6",
"@typescript-eslint/eslint-plugin": "^5.4.0",
"@typescript-eslint/parser": "^5.4.0",
"conventional-changelog-conventionalcommits": "^4.6.0",
"eslint": "^8.2.0",
"eslint-plugin-jest": "^25.2.4",
"eslint-plugin-prettier": "^4.0.0",
"jest": "^27.3.1",
"jest-circus": "^27.3.1",
"prettier": "^2.4.1",
"regenerator-runtime": "^0.13.9",
"rimraf": "^3.0.2",
"semantic-release": "^18.0.1",
"ts-jest": "^27.1.2",
"typescript": "^4.5.4"
"semantic-release": "^17.4.4",
"ts-jest": "^27.0.7",
"typescript": "^4.4.4"
}
}
+40
View File
@@ -0,0 +1,40 @@
const { config } = require('@swc/core/spack');
const { readdirSync } = require('fs');
const { resolve, basename, extname } = require('path');
module.exports = config({
target: 'node',
entry: actions(resolve(__dirname, 'src/actions')),
output: {
path: resolve(__dirname, 'build'),
},
externalModules: externals(),
});
/**
* Get all action entry points, in src/actions.
* This returns them as `{ [name]: absolutePath }`.
*/
function actions(dir) {
return Object.fromEntries(
readdirSync(dir, { withFileTypes: true })
.filter(entity => entity.isFile())
.map(entity => {
const actionName = basename(entity.name, extname(entity.name));
const actionFile = resolve(dir, entity.name);
return [actionName, actionFile];
})
);
}
/**
* Get all external modules that should not be bundled.
*
* Note, currently `@actions/cache` can't be bundled by SWC due to modules issues in `@azure/*`:
* > internal error: entered unreachable code: module item found but is_es6 is false
*
* @see https://github.com/expo/expo-github-action/pull/62
*/
function externals() {
return ['@azure/storage-blob', '@azure/ms-rest-js'];
}
+46 -64
View File
@@ -1,79 +1,61 @@
import { getBooleanInput, getInput, group, info } from '@actions/core';
import { addPath, getBooleanInput, getInput, group, info } from '@actions/core';
import { restoreFromCache, saveToCache } from '../cacher';
import { installPackage, resolvePackage } from '../packager';
import { executeAction, expoAuthenticate, findTool, installToolFromPackage, patchWatchers } from '../worker';
import { install } from '../install';
import { resolveVersion } from '../packager';
import * as tools from '../tools';
// Auto-execute in GitHub actions
executeAction(setupAction);
tools.performAction(setupAction);
export type SetupInput = ReturnType<typeof setupInput>;
export async function setupAction(): Promise<void> {
const expoVersion = await installCli('expo-cli');
const easVersion = await installCli('eas-cli');
export function setupInput() {
return {
easCache: !getInput('eas-cache') || getBooleanInput('eas-cache'),
easVersion: getInput('eas-version'),
expoCache: !getInput('expo-cache') || getBooleanInput('expo-cache'),
expoVersion: getInput('expo-version'),
packager: getInput('packager') || 'yarn',
patchWatchers: !getInput('patch-watchers') || getBooleanInput('patch-watchers'),
token: getInput('token'),
};
await group('Checking current authenticated account', () =>
tools.maybeAuthenticate({
cli: expoVersion ? 'expo-cli' : easVersion ? 'eas-cli' : undefined,
token: getInput('token') || undefined,
username: getInput('username') || undefined,
password: getInput('password') || undefined,
})
);
if (!getInput('patch-watchers') || getBooleanInput('patch-watchers') !== false) {
await group('Patching system watchers for the `ENOSPC` error', () => tools.maybePatchWatchers());
}
}
export async function setupAction(input: SetupInput = setupInput()): Promise<void> {
if (!input.expoVersion) {
info(`Skipped installing expo-cli: 'expo-version' not provided.`);
} else {
const version = await resolvePackage('expo-cli', input.expoVersion);
const message = input.expoCache
? `Installing expo-cli (${version}) from cache or with ${input.packager}`
: `Installing expo-cli (${version}) with ${input.packager}`;
async function installCli(name: tools.PackageName): Promise<string | void> {
const shortName = tools.getBinaryName(name);
const inputVersion = getInput(`${shortName}-version`);
const packager = getInput('packager') || 'yarn';
await group(message, () => installCli('expo-cli', version, input.packager, input.expoCache));
if (!inputVersion) {
return info(`Skipping installation of ${name}, \`${shortName}-version\` not provided.`);
}
if (!input.easVersion) {
info(`Skipped installing eas-cli: 'eas-version' not provided.`);
} else {
const version = await resolvePackage('eas-cli', input.easVersion);
const message = input.easCache
? `Installing eas-cli (${version}) from cache or with ${input.packager}`
: `Installing eas-cli (${version}) with ${input.packager}`;
const version = await resolveVersion(name, inputVersion);
const cache = getBooleanInput(`${shortName}-cache`);
await group(message, () => installCli('eas-cli', input.easVersion, input.packager, input.easCache));
}
if (!input.token) {
info(`Skipped authentication: 'token' not provided.`);
} else {
await group('Validating authenticated account', () =>
expoAuthenticate(input.token, input.easVersion ? 'eas' : input.expoVersion ? 'expo' : undefined)
try {
const path = await group(
cache
? `Installing ${name} (${version}) from cache or with ${packager}`
: `Installing ${name} (${version}) with ${packager}`,
() =>
install({
packager,
version,
cache,
package: name,
cacheKey: getInput(`${shortName}-cache-key`) || undefined,
})
);
addPath(path);
} catch (error) {
tools.handleError(name, error);
}
if (!input.patchWatchers) {
info(`Skipped patching watchers: 'patch-watchers' disabled.`);
} else {
await group(`Patching system watchers for the 'ENOSPC' error`, patchWatchers);
}
}
async function installCli(name: string, version: string, packager: string, cache: boolean = true) {
const cliVersion = await resolvePackage(name, version);
let cliPath = findTool(name, cliVersion) || undefined;
if (!cliPath && cache) {
cliPath = await restoreFromCache(name, cliVersion, packager);
}
if (!cliPath) {
cliPath = await installPackage(name, cliVersion, packager);
if (cache) {
await saveToCache(name, cliVersion, packager);
}
}
installToolFromPackage(cliPath);
return version;
}
+94
View File
@@ -0,0 +1,94 @@
import { ReserveCacheError, restoreCache, saveCache } from '@actions/cache';
import * as core from '@actions/core';
import * as toolCache from '@actions/tool-cache';
import path from 'path';
import os from 'os';
import type { InstallConfig } from './install';
export type CacheConfig = Omit<InstallConfig, 'cache'>;
/**
* Get the path to the `expo-cli` from cache, if any.
* Note, this cache is **NOT** shared between jobs.
*
* @see https://github.com/actions/toolkit/issues/47
*/
export async function fromLocalCache(config: CacheConfig): Promise<string | undefined> {
return toolCache.find(config.package, config.version);
}
/**
* Store the root of `expo-cli` in the cache, for future reuse.
* Note, this cache is **NOT** shared between jobs.
*
* @see https://github.com/actions/toolkit/issues/47
*/
export async function toLocalCache(root: string, config: CacheConfig): Promise<string> {
return toolCache.cacheDir(root, config.package, config.version);
}
/**
* Download the remotely stored `expo-cli` from cache, if any.
* Note, this cache is shared between jobs.
*/
export async function fromRemoteCache(config: CacheConfig): Promise<string | undefined> {
// see: https://github.com/actions/toolkit/blob/8a4134761f09d0d97fb15f297705fd8644fef920/packages/tool-cache/src/tool-cache.ts#L401
const target = path.join(process.env['RUNNER_TOOL_CACHE'] || '', config.package, config.version, os.arch());
const cacheKey = config.cacheKey || getRemoteKey(config);
try {
// When running with nektos/act, or other custom environments, the cache might not be set up.
const hit = await restoreCache([target], cacheKey);
if (hit) {
return target;
}
} catch (error) {
if (!handleRemoteCacheError(error)) {
throw error;
}
}
}
/**
* Store the root of `expo-cli` in the remote cache, for future reuse.
* Note, this cache is shared between jobs.
*/
export async function toRemoteCache(source: string, config: CacheConfig): Promise<void> {
const cacheKey = config.cacheKey || getRemoteKey(config);
try {
await saveCache([source], cacheKey);
} catch (error) {
if (!handleRemoteCacheError(error)) {
throw error;
}
}
}
/**
* Get the cache key to use when (re)storing the Expo CLI from remote cache.
*/
function getRemoteKey(config: Omit<CacheConfig, 'cacheKey'>): string {
return `${config.package}-${process.platform}-${os.arch()}-${config.packager}-${config.version}`;
}
/**
* Handle any incoming errors from cache methods.
* This can include actual errors like `ReserveCacheErrors` or unavailability errors.
* When the error is handled, it MUST provide feedback for the developer.
*
* @returns If the error was handled properly.
*/
function handleRemoteCacheError(error: Error): boolean {
const isReserveCacheError = error instanceof ReserveCacheError;
const isCacheUnavailable = error.message.toLowerCase().includes('cache service url not found');
if (isReserveCacheError || isCacheUnavailable) {
core.warning('Skipping remote cache storage, encountered error:');
core.warning(error.message);
return true;
}
return false;
}
-61
View File
@@ -1,61 +0,0 @@
import { saveCache, restoreCache, ReserveCacheError } from '@actions/cache';
import { warning } from '@actions/core';
import os from 'os';
import { toolPath } from './worker';
/**
* Get the exact cache key for the package.
* We can prefix this when there are breaking changes in this action.
*/
export function cacheKey(name: string, version: string, manager: string): string {
return `${name}-${process.platform}-${os.arch()}-${manager}-${version}`;
}
/**
* Restore a tool from the remote cache.
* This will install the tool back into the local tool cache.
*/
export async function restoreFromCache(name: string, version: string, manager: string) {
const dir = toolPath(name, version)!;
try {
if (await restoreCache([dir], cacheKey(name, version, manager))) {
return dir;
}
} catch (error) {
handleCacheError(error);
}
}
/**
* Save a tool to the remote cache.
* This will fetch the tool from the local tool cache.
*/
export async function saveToCache(name: string, version: string, manager: string) {
try {
await saveCache([toolPath(name, version)], cacheKey(name, version, manager));
} catch (error) {
handleCacheError(error);
}
}
/**
* Try to handle incoming cache errors.
* Because workers can operate in environments without cache configured,
* we need to make sure to only skip the cache instead of fail.
*
* Currently we handle these types of errors:
* - ReserveCacheError
* - "cache service url not found"
*/
export function handleCacheError(error: Error): void {
const isReserveCacheError = error instanceof ReserveCacheError;
const isCacheUnavailable = error.message.toLowerCase().includes('cache service url not found');
if (isReserveCacheError || isCacheUnavailable) {
warning('Skipped remote cache, encountered error:');
warning(error.message);
} else {
throw error;
}
}
+60
View File
@@ -0,0 +1,60 @@
import * as core from '@actions/core';
import * as cli from '@actions/exec';
import * as io from '@actions/io';
import * as path from 'path';
import { fromLocalCache, fromRemoteCache, toLocalCache, toRemoteCache } from './cache';
import { PackageName } from './tools';
export type InstallConfig = {
/** The exact version to install */
version: string;
/** The name of the package to install */
package: PackageName;
/** The packager to install with, likely to be `yarn` or `npm` */
packager: string;
/** If remote caching is enabled or not */
cache?: boolean;
/** The custom remote cache key */
cacheKey?: string;
};
/**
* Install `expo-cli`, by version, using the packager.
* Here you can provide any semver range or dist tag used in the registry.
* It returns the path where Expo is installed.
*/
export async function install(config: InstallConfig): Promise<string> {
let root: string | undefined = await fromLocalCache(config);
if (!root && config.cache) {
root = await fromRemoteCache(config);
} else {
core.info('Skipping remote cache, not enabled...');
}
if (!root) {
root = await fromPackager(config);
root = await toLocalCache(root, config);
if (config.cache) {
await toRemoteCache(root, config);
}
}
return path.join(root, 'node_modules', '.bin');
}
/**
* Install `expo-cli`, by version, using npm or yarn.
* It creates a temporary directory to store all required files.
*/
export async function fromPackager(config: InstallConfig): Promise<string> {
const root = process.env['RUNNER_TEMP'] || '';
const tool = await io.which(config.packager);
await io.mkdirP(root);
await cli.exec(tool, ['add', `${config.package}@${config.version}`], { cwd: root });
return root;
}
+2 -20
View File
@@ -1,14 +1,11 @@
import { exec } from '@actions/exec';
import { which, mkdirP } from '@actions/io';
import { cacheTool, tempPath } from './worker';
/**
* Resolve a package with version range to an exact version.
* This is useful to invalidate the cache _and_ using dist-tags or version ranges.
* It executes `npm info` and parses the latest manifest.
*/
export async function resolvePackage(name: string, range: string): Promise<string> {
export async function resolveVersion(name: string, range: string): Promise<string> {
let stdout = '';
try {
@@ -21,7 +18,7 @@ export async function resolvePackage(name: string, range: string): Promise<strin
},
});
} catch (error) {
throw new Error(`Could not resolve ${name}@${range}, reason:\n${error.message || error}`);
throw new Error(`Could not resolve version "${range}" of "${name}", reason:\n${error.message || error}`);
}
// thanks npm, for returning a "x.x.x" json value...
@@ -31,18 +28,3 @@ export async function resolvePackage(name: string, range: string): Promise<strin
return JSON.parse(stdout).at(-1);
}
/**
* Install a module using a node package manager.
* The installation is executed in a temporary folder.
* After this is complete, it's "installed" into the worker's tool cache.
*/
export async function installPackage(name: string, version: string, manager: string) {
const temp = tempPath(name, version);
const tool = await which(manager);
await mkdirP(temp);
await exec(tool, ['add', `${name}@${version}`], { cwd: temp });
return cacheTool(temp, name, version);
}
+132
View File
@@ -0,0 +1,132 @@
import * as core from '@actions/core';
import * as cli from '@actions/exec';
import semver from 'semver';
import { resolveVersion } from './packager';
export type PackageName = 'expo-cli' | 'eas-cli';
export type AuthenticateOptions = {
cli?: PackageName;
token?: string;
username?: string;
password?: string;
};
/**
* Convert `expo-cli` or `eas-cli` to just their binary name.
* For windows we have to use `<bin>.cmd`, toolkit will handle the Windows binary with that.
*/
export function getBinaryName(name: PackageName, forWindows = false): string {
const bin = name.toLowerCase().replace('-cli', '');
return forWindows ? `${bin}.cmd` : bin;
}
/**
* Authenticate with Expo using either the token or username/password method.
* If both of them are set, token has priority.
*/
export async function maybeAuthenticate(options: AuthenticateOptions = {}): Promise<void> {
if (options.token) {
if (options.cli) {
const bin = getBinaryName(options.cli, process.platform === 'win32');
await cli.exec(bin, ['whoami'], {
env: { ...process.env, EXPO_TOKEN: options.token },
});
} else {
core.info("Skipping token validation: no CLI installed, can't run `whoami`.");
}
return core.exportVariable('EXPO_TOKEN', options.token);
}
if (options.username || options.password) {
if (options.cli !== 'expo-cli') {
return core.warning(
'Skipping authentication: only Expo CLI supports programmatic credentials, use `token` instead.'
);
}
if (!options.username || !options.password) {
return core.info('Skipping authentication: `username` and/or `password` not set...');
}
const bin = getBinaryName(options.cli, process.platform === 'win32');
await cli.exec(bin, ['login', `--username=${options.username}`], {
env: { ...process.env, EXPO_CLI_PASSWORD: options.password },
});
}
core.info('Skipping authentication: `token`, `username`, and/or `password` not set...');
}
/**
* Try to patch the default watcher/inotify limit.
* This is a limitation from GitHub Actions and might be an issue in some Expo projects.
* It sets the system's `fs.inotify` limits to a more sensible setting.
*
* @see https://github.com/expo/expo-github-action/issues/20
*/
export async function maybePatchWatchers(): Promise<void> {
if (process.platform !== 'linux') {
return core.info('Skipping patch for watchers, not running on Linux...');
}
core.info('Patching system watchers for the `ENOSPC` error...');
try {
// see https://github.com/expo/expo-cli/issues/277#issuecomment-452685177
await cli.exec('sudo sysctl fs.inotify.max_user_instances=524288');
await cli.exec('sudo sysctl fs.inotify.max_user_watches=524288');
await cli.exec('sudo sysctl fs.inotify.max_queued_events=524288');
await cli.exec('sudo sysctl -p');
} catch {
core.warning("Looks like we can't patch watchers/inotify limits, you might encouter the `ENOSPC` error.");
core.warning('For more info, https://github.com/expo/expo-github-action/issues/20');
}
}
/**
* Check if there is a new major version available.
* If there is, create a warning for people to upgrade their workflow.
* Because this introduces additional requests, it should only be executed when necessary.
*/
export async function maybeWarnForUpdate(name: PackageName): Promise<void> {
const binaryName = getBinaryName(name);
const latest = await resolveVersion(name, 'latest');
const current = await resolveVersion(name, core.getInput(`${getBinaryName(name)}-version`) || 'latest');
if (semver.diff(latest, current) === 'major') {
core.warning(`There is a new major version available of the Expo CLI (${latest})`);
core.warning(
`If you run into issues, try upgrading your workflow to "${binaryName}-version: ${semver.major(latest)}.x"`
);
}
}
/**
* Handle errors when this action fails, providing useful next-steps for developers.
* This mostly checks if the installed version is the latest version.
*/
export async function handleError(name: PackageName, error: Error) {
try {
await maybeWarnForUpdate(name);
} catch {
// If this fails, ignore it
}
core.setFailed(error);
}
/**
* Auto-execute the action if it's not running in a test environment.
* This is useful to test the action, without running it in tests.
* The method can also be mocked.
*/
export function performAction(action: () => Promise<void>) {
if (process.env.JEST_WORKER_ID) {
return Promise.resolve(null);
}
return action();
}
-93
View File
@@ -1,93 +0,0 @@
import { addPath, exportVariable, info, setFailed, warning } from '@actions/core';
import { exec } from '@actions/exec';
import { which } from '@actions/io';
import os from 'os';
import path from 'path';
export { find as findTool, cacheDir as cacheTool } from '@actions/tool-cache';
export function tempPath(name: string, version: string): string {
const temp = process.env['RUNNER_TEMP'] || '';
if (!temp) {
throw new Error(`Could not resolve temporary path, 'RUNNER_TEMP' not defined.`);
}
return path.join(temp, name, version, os.arch());
}
export function toolPath(name: string, version: string): string {
const toolCache = process.env['RUNNER_TOOL_CACHE'] || '';
if (!toolCache) {
throw new Error(`Could not resolve the local tool cache, 'RUNNER_TOOL_CACHE' not defined.`);
}
// https://github.com/actions/toolkit/blob/daf8bb00606d37ee2431d9b1596b88513dcf9c59/packages/tool-cache/src/tool-cache.ts#L747-L749
return path.join(toolCache, name, version, os.arch());
}
/**
* Install a "tool" from a node package.
* This will add the folder, containing the `node_modules`, to the global path.
*/
export function installToolFromPackage(dir: string) {
return addPath(path.join(dir, 'node_modules', '.bin'));
}
/**
* Try to patch Linux's inotify limits to a more sensible setting on Linux.
* This limitation could cause `ENOSPC` errors when bundling Expo or React Native projects.
*
* It will try to change these `fs.inotify.` limits:
* - .max_user_instances = 524288
* - .max_user_watches = 524288
* - .max_queued_events = 524288
*
* @see https://github.com/expo/expo-github-action/issues/20
*/
export async function patchWatchers(): Promise<void> {
if (process.platform !== 'linux') {
return info('Skipped patching watchers: not running on Linux.');
}
try {
// see https://github.com/expo/expo-cli/issues/277#issuecomment-452685177
await exec('sudo sysctl fs.inotify.max_user_instances=524288');
await exec('sudo sysctl fs.inotify.max_user_watches=524288');
await exec('sudo sysctl fs.inotify.max_queued_events=524288');
await exec('sudo sysctl -p');
info('Patched system watchers for the `ENOSPC` error.');
} catch (error) {
warning(`Looks like we can't patch watchers/inotify limits, you might encouter the 'ENOSPC' error.`);
warning('For more info: https://github.com/expo/expo-github-action/issues/20, encountered error:');
warning(error.message);
}
}
/**
* Try to authenticate the user using either Expo or EAS CLI.
* This method tries to invoke 'whoami' to validate if the token is valid.
* If that passes, the token is exported as EXPO_TOKEN for all steps within the job.
*/
export async function expoAuthenticate(token: string, cli?: 'expo' | 'eas'): Promise<void> {
if (!cli) {
info(`Skipped token validation: no CLI installed, can't run 'whoami'.`);
} else {
await exec(await which(cli), ['whoami'], {
env: { ...process.env, EXPO_TOKEN: token },
});
}
exportVariable('EXPO_TOKEN', token);
}
/**
* Auto-execute the action if it's not running in a test environment.
* This also propagate possible errors to GitHub actions, with setFailed.
*/
export async function executeAction(action: () => Promise<void>) {
if (process.env.JEST_WORKER_ID) {
return Promise.resolve(null);
}
return action().catch(setFailed);
}
+117 -93
View File
@@ -1,108 +1,132 @@
import { getToolsMock, mockInput } from '../utils';
jest.mock('../../src/tools', () => getToolsMock());
jest.mock('../../src/packager', () => ({
async resolveVersion(_: string, version: string) {
return version;
},
}));
import * as core from '@actions/core';
import { SetupInput, setupInput, setupAction } from '../../src/actions/setup';
import * as cacher from '../../src/cacher';
import * as packager from '../../src/packager';
import * as worker from '../../src/worker';
import { mockInput } from '../utils';
jest.mock('@actions/core');
jest.mock('../../src/cacher');
jest.mock('../../src/packager');
jest.mock('../../src/worker');
describe(setupInput, () => {
it('returns object with correct defaults', () => {
expect(setupInput()).toMatchObject({
easCache: true,
easVersion: undefined,
expoCache: true,
expoVersion: undefined,
packager: 'yarn',
patchWatchers: true,
token: undefined,
});
});
it('returns expo version and cache', () => {
mockInput({ 'expo-version': '5.x', 'expo-cache': 'true' });
expect(setupInput()).toMatchObject({ expoVersion: '5.x', expoCache: true });
});
it('returns eas version and cache', () => {
mockInput({ 'eas-version': 'latest', 'eas-cache': 'true' });
expect(setupInput()).toMatchObject({ easVersion: 'latest', easCache: true });
});
it('returns different packager', () => {
mockInput({ packager: 'npm' });
expect(setupInput()).toMatchObject({ packager: 'npm' });
});
it('returns disabled patch watchers', () => {
mockInput({ 'patch-watchers': 'false' });
expect(setupInput()).toMatchObject({ patchWatchers: false });
});
it('returns token', () => {
mockInput({ token: 'faketoken' });
expect(setupInput()).toMatchObject({ token: 'faketoken' });
});
});
import * as install from '../../src/install';
import * as tools from '../../src/tools';
import { setupAction } from '../../src/actions/setup';
describe(setupAction, () => {
const input: SetupInput = {
easCache: false,
easVersion: '',
expoCache: false,
expoVersion: '',
packager: 'yarn',
patchWatchers: true,
token: '',
};
beforeAll(() => {
jest.mocked(core.group).mockImplementation((_, action) => action());
});
['expo', 'eas'].forEach(cli => {
const cliName = `${cli}-cli`;
const cliVersion = `${cli}Version`;
const cliCache = `${cli}Cache`;
it(`installs ${cliName} using npm`, async () => {
jest.mocked(packager.resolvePackage).mockResolvedValue('5.0.3');
await setupAction({ ...input, [cliVersion]: '5.x', [cliCache]: false, packager: 'npm' });
expect(packager.installPackage).toBeCalledWith(cliName, '5.0.3', 'npm');
expect(worker.installToolFromPackage).toBeCalled();
describe('patch watchers', () => {
it('patches the system when set to true', async () => {
mockInput({ 'patch-watchers': 'true' });
await setupAction();
expect(tools.maybePatchWatchers).toHaveBeenCalled();
});
it(`installs ${cliName} from cache`, async () => {
jest.mocked(packager.resolvePackage).mockResolvedValue('5.0.3');
jest.mocked(cacher.restoreFromCache).mockResolvedValue('fake/path');
await setupAction({ ...input, [cliVersion]: 'latest', [cliCache]: true });
expect(packager.installPackage).not.toBeCalled();
expect(worker.installToolFromPackage).toBeCalledWith('fake/path');
it('patches the system when not set', async () => {
mockInput({ 'patch-watchers': '' });
await setupAction();
expect(tools.maybePatchWatchers).toHaveBeenCalled();
});
it('skips the system patch when set to false', async () => {
mockInput({ 'patch-watchers': 'false' });
await setupAction();
expect(tools.maybePatchWatchers).not.toHaveBeenCalled();
});
});
it('authenticates token with eas-cli by default', async () => {
await setupAction({ ...input, expoVersion: 'latest', easVersion: 'latest', token: 'faketoken' });
expect(worker.expoAuthenticate).toBeCalledWith('faketoken', 'eas');
describe('authentication', () => {
it('authenticates with provided credentials', async () => {
mockInput({ username: 'bycedric', password: 'mypassword' });
await setupAction();
expect(tools.maybeAuthenticate).toBeCalledWith({ username: 'bycedric', password: 'mypassword' });
});
it('authenticates with provided token', async () => {
mockInput({ token: 'ABC123' });
await setupAction();
expect(tools.maybeAuthenticate).toBeCalledWith({ token: 'ABC123' });
});
});
it('authenticates token with expo-cli without eas-cli', async () => {
await setupAction({ ...input, expoVersion: 'latest', token: 'faketoken' });
expect(worker.expoAuthenticate).toBeCalledWith('faketoken', 'expo');
});
['expo', 'eas'].forEach(cliName => {
const packageName = `${cliName}-cli`;
let installMock: jest.SpyInstance;
it('authenticates token without any cli', async () => {
await setupAction({ ...input, token: 'faketoken' });
expect(worker.expoAuthenticate).toBeCalledWith('faketoken', undefined);
});
beforeEach(() => {
installMock = jest.spyOn(install, 'install').mockImplementation();
});
it('patches watchers', async () => {
await setupAction({ ...input, patchWatchers: true });
expect(worker.patchWatchers).toBeCalled();
afterEach(() => {
installMock.mockRestore();
});
describe(packageName, () => {
it(`skips installation without \`${cliName}-version\``, async () => {
mockInput();
await setupAction();
expect(installMock).not.toBeCalledWith({ package: packageName });
});
it('installs with yarn by default', async () => {
mockInput({ [`${cliName}-version`]: 'latest' });
await setupAction();
expect(installMock).toBeCalledWith({
package: packageName,
version: 'latest',
packager: 'yarn',
cache: false,
});
});
it('installs provided version with npm', async () => {
mockInput({ [`${cliName}-version`]: '3.0.10', packager: 'npm' });
await setupAction();
expect(installMock).toBeCalledWith({
package: packageName,
version: '3.0.10',
packager: 'npm',
cache: false,
});
});
it('installs with yarn and cache enabled', async () => {
mockInput({
packager: 'yarn',
[`${cliName}-version`]: '4.2.0',
[`${cliName}-cache`]: 'true',
});
await setupAction();
expect(installMock).toBeCalledWith({
package: packageName,
version: '4.2.0',
packager: 'yarn',
cache: true,
});
});
it('installs with yarn and custom cache key', async () => {
mockInput({
packager: 'yarn',
[`${cliName}-version`]: '4.2.0',
[`${cliName}-cache`]: 'true',
[`${cliName}-cache-key`]: 'custom-key',
});
await setupAction();
expect(installMock).toBeCalledWith({
package: packageName,
version: '4.2.0',
packager: 'yarn',
cache: true,
cacheKey: 'custom-key',
});
});
it('installs path to global path', async () => {
installMock.mockResolvedValue(`/${cliName}/install/path`);
const addPathSpy = jest.spyOn(core, 'addPath').mockImplementation();
await setupAction();
expect(addPathSpy).toBeCalledWith(`/${cliName}/install/path`);
});
});
});
});
+153
View File
@@ -0,0 +1,153 @@
import os from 'os';
import { join } from 'path';
import * as remoteCache from '@actions/cache';
import * as core from '@actions/core';
import * as toolCache from '@actions/tool-cache';
import * as cache from '../src/cache';
import * as utils from './utils';
describe(cache.fromLocalCache, () => {
it('fetches the version specific cache', async () => {
const path = join('path', 'to', 'local', 'cache');
// todo: check why jest wants `never` instead of `string`
const find = jest.spyOn(toolCache, 'find').mockResolvedValue(path as never);
const result = await cache.fromLocalCache({ package: 'eas-cli', version: '4.2.0', packager: 'npm' });
expect(result).toBe(path);
expect(find).toBeCalledWith('eas-cli', '4.2.0');
});
});
describe(cache.toLocalCache, () => {
it('stores the version specific cache', async () => {
const path = join('path', 'to', 'local', 'cache');
const root = join('path', 'from', 'source');
const cacheDir = jest.spyOn(toolCache, 'cacheDir').mockResolvedValue(path);
const result = await cache.toLocalCache(root, { package: 'expo-cli', version: '4.2.0', packager: 'yarn' });
expect(result).toBe(path);
expect(cacheDir).toBeCalledWith(root, 'expo-cli', '4.2.0');
});
});
describe(cache.fromRemoteCache, () => {
let spy: { [key: string]: jest.SpyInstance } = {};
beforeEach(() => {
spy = {
restore: jest.spyOn(remoteCache, 'restoreCache').mockImplementation(),
warning: jest.spyOn(core, 'warning').mockImplementation(),
};
});
beforeAll(() => {
utils.setEnv('RUNNER_TOOL_CACHE', join('cache', 'path'));
});
afterAll(() => {
utils.restoreEnv();
spy.restore.mockRestore();
spy.warning.mockRestore();
});
it('restores remote cache with default key', async () => {
expect(await cache.fromRemoteCache({ package: 'expo-cli', version: '3.20.1', packager: 'yarn' })).toBeUndefined();
expect(remoteCache.restoreCache).toBeCalledWith(
[join('cache', 'path', 'expo-cli', '3.20.1', os.arch())],
`expo-cli-${process.platform}-${os.arch()}-yarn-3.20.1`
);
});
it('restores remote cache with custom key', async () => {
expect(
await cache.fromRemoteCache({
package: 'eas-cli',
version: '4.2.0',
packager: 'yarn',
cacheKey: 'custom-cache-key',
})
).toBeUndefined();
expect(remoteCache.restoreCache).toBeCalledWith(
[join('cache', 'path', 'eas-cli', '4.2.0', os.arch())],
'custom-cache-key'
);
});
it('returns path when remote cache exists', async () => {
spy.restore.mockResolvedValueOnce(true);
expect(await cache.fromRemoteCache({ package: 'expo-cli', version: '3.20.1', packager: 'npm' })).toBe(
join('cache', 'path', 'expo-cli', '3.20.1', os.arch())
);
});
it('fails when remote cache throws', async () => {
const error = new Error('Remote cache restore failed');
spy.restore.mockRejectedValueOnce(error);
await expect(cache.fromRemoteCache({ package: 'eas-cli', version: '3.20.1', packager: 'yarn' })).rejects.toBe(
error
);
});
it('skips remote cache when unavailable', async () => {
// see: https://github.com/actions/toolkit/blob/9167ce1f3a32ad495fc1dbcb574c03c0e013ae53/packages/cache/src/internal/cacheHttpClient.ts#L41
const error = new Error('Cache Service Url not found, unable to restore cache.');
spy.restore.mockRejectedValueOnce(error);
expect(await cache.fromRemoteCache({ package: 'expo-cli', version: '3.20.1', packager: 'yarn' })).toBeUndefined();
expect(spy.warning).toHaveBeenCalledWith(expect.stringContaining('Skipping remote cache'));
});
});
describe(cache.toRemoteCache, () => {
let spy: { [key: string]: jest.SpyInstance } = {};
beforeEach(() => {
spy = {
save: jest.spyOn(remoteCache, 'saveCache').mockImplementation(),
warning: jest.spyOn(core, 'warning').mockImplementation(),
};
});
afterAll(() => {
spy.save.mockRestore();
spy.warning.mockRestore();
});
it('saves remote cache with default key', async () => {
expect(
await cache.toRemoteCache(join('local', 'path'), { package: 'eas-cli', version: '3.20.1', packager: 'npm' })
).toBeUndefined();
expect(remoteCache.saveCache).toBeCalledWith(
[join('local', 'path')],
`eas-cli-${process.platform}-${os.arch()}-npm-3.20.1`
);
});
it('saves remote cache with custom key', async () => {
expect(
await cache.toRemoteCache(join('local', 'path'), {
package: 'eas-cli',
version: '3.20.1',
packager: 'yarn',
cacheKey: 'custom-cache-key',
})
).toBeUndefined();
expect(remoteCache.saveCache).toBeCalledWith([join('local', 'path')], 'custom-cache-key');
});
it('fails when remote cache throws', async () => {
const error = new Error('Remote cache save failed');
spy.save.mockRejectedValueOnce(error);
await expect(
cache.toRemoteCache(join('local', 'path'), { package: 'expo-cli', version: '3.20.1', packager: 'yarn' })
).rejects.toBe(error);
});
it('skips remote cache when unavailable', async () => {
// see: https://github.com/actions/toolkit/blob/9167ce1f3a32ad495fc1dbcb574c03c0e013ae53/packages/cache/src/internal/cacheHttpClient.ts#L41
const error = new Error('Cache Service Url not found, unable to restore cache.');
spy.save.mockRejectedValueOnce(error);
await expect(
cache.toRemoteCache(join('local', 'path'), { package: 'expo-cli', version: '3.20.1', packager: 'yarn' })
).resolves.toBeUndefined();
expect(spy.warning).toHaveBeenCalledWith(expect.stringContaining('Skipping remote cache'));
});
});
-70
View File
@@ -1,70 +0,0 @@
import * as cache from '@actions/cache';
import os from 'os';
import { cacheKey, restoreFromCache, saveToCache } from '../src/cacher';
import { toolPath } from '../src/worker';
import { resetEnv, setEnv } from './utils';
jest.mock('@actions/cache');
jest.mock('@actions/core');
beforeAll(() => {
setEnv('RUNNER_TOOL_CACHE', os.tmpdir());
});
afterAll(resetEnv);
describe(cacheKey, () => {
it('returns contains package name, version, and manager', () => {
expect(cacheKey('expo-cli', '5.0.3', 'yarn')).toMatch('expo-cli');
expect(cacheKey('expo-cli', '5.0.3', 'yarn')).toMatch('5.0.3');
expect(cacheKey('eas-cli', '5.0.3', 'npm')).toMatch('npm');
});
it('contains the os arch type', () => {
expect(cacheKey('eas-cli', '5.0.3', 'yarn')).toMatch(os.arch());
});
it('contains the platform type', () => {
expect(cacheKey('eas-cli', '5.0.3', 'yarn')).toMatch(process.platform);
});
});
describe(restoreFromCache, () => {
it('skips when cache is unavailable', async () => {
jest.mocked(cache.restoreCache).mockRejectedValue(new Error('Cache service url not found'));
await expect(restoreFromCache('expo-cli', '5.0.3', 'yarn')).resolves.toBeUndefined();
});
it('throws when cache has unexpected error', async () => {
jest.mocked(cache.restoreCache).mockRejectedValue(new Error('Node registry is down'));
await expect(restoreFromCache('expo-cli', '5.0.3', 'yarn')).rejects.toThrow('Node registry is down');
});
it('returns expo-cli path from cache when available', async () => {
jest.mocked(cache.restoreCache).mockResolvedValue('fake/path');
await expect(restoreFromCache('expo-cli', '5.0.3', 'yarn')).resolves.toBe(toolPath('expo-cli', '5.0.3'));
});
it('returns nothing when cache is empty', async () => {
jest.mocked(cache.restoreCache).mockResolvedValue(undefined);
await expect(restoreFromCache('eas-cli', '0.46.2', 'npm')).resolves.toBeUndefined();
});
});
describe(saveToCache, () => {
it('skips when cache is unavailable', async () => {
jest.mocked(cache.saveCache).mockRejectedValue(new Error('Cache service url not found'));
await expect(saveToCache('expo-cli', '5.0.3', 'yarn')).resolves.toBeUndefined();
});
it('throws when cache has unexpected error', async () => {
jest.mocked(cache.saveCache).mockRejectedValue(new Error('Node registry is down'));
await expect(saveToCache('expo-cli', '5.0.3', 'yarn')).rejects.toThrow('Node registry is down');
});
it('saves expo-cli to cache when available', async () => {
jest.mocked(cache.saveCache).mockResolvedValue(1337);
await expect(saveToCache('expo-cli', '5.0.3', 'yarn')).resolves.toBeUndefined();
});
});
+94
View File
@@ -0,0 +1,94 @@
const cli = { exec: jest.fn() };
const io = { mkdirP: jest.fn(), which: jest.fn() };
const cache = {
fromLocalCache: jest.fn(),
fromRemoteCache: jest.fn(),
toLocalCache: jest.fn(),
toRemoteCache: jest.fn(),
};
jest.mock('@actions/exec', () => cli);
jest.mock('@actions/io', () => io);
jest.mock('../src/cache', () => cache);
import { join } from 'path';
import * as install from '../src/install';
import * as utils from './utils';
describe('install', () => {
it('installs path from local cache', async () => {
cache.fromLocalCache.mockResolvedValue(join('cache', 'path'));
const expoPath = await install.install({ package: 'expo-cli', version: '3.0.10', packager: 'npm' });
expect(expoPath).toBe(join('cache', 'path', 'node_modules', '.bin'));
});
it('installs path from packager and cache it locally', async () => {
utils.setEnv('RUNNER_TEMP', join('temp', 'path'));
cache.fromLocalCache.mockResolvedValue(undefined);
cache.toLocalCache.mockResolvedValue(join('cache', 'path'));
const expoPath = await install.install({ package: 'expo-cli', version: '3.0.10', packager: 'npm' });
expect(expoPath).toBe(join('cache', 'path', 'node_modules', '.bin'));
expect(cache.toLocalCache).toBeCalledWith(join('temp', 'path'), {
package: 'expo-cli',
version: '3.0.10',
packager: 'npm',
});
utils.restoreEnv();
});
it('installs path from remote cache', async () => {
cache.fromLocalCache.mockResolvedValue(undefined);
cache.fromRemoteCache.mockResolvedValue(join('cache', 'path'));
const expoPath = await install.install({ package: 'eas-cli', version: '4.2.0', packager: 'yarn', cache: true });
expect(expoPath).toBe(join('cache', 'path', 'node_modules', '.bin'));
expect(cache.fromRemoteCache).toBeCalledWith({
package: 'eas-cli',
version: '4.2.0',
packager: 'yarn',
cache: true,
});
});
it('installs path from packager and cache it remotely', async () => {
utils.setEnv('RUNNER_TEMP', join('temp', 'path'));
cache.fromLocalCache.mockResolvedValue(undefined);
cache.fromRemoteCache.mockResolvedValue(undefined);
cache.toLocalCache.mockResolvedValue(join('cache', 'path'));
const expoPath = await install.install({ package: 'expo-cli', version: '3.20.1', packager: 'npm', cache: true });
expect(expoPath).toBe(join('cache', 'path', 'node_modules', '.bin'));
expect(cache.toRemoteCache).toBeCalledWith(join('cache', 'path'), {
package: 'expo-cli',
version: '3.20.1',
packager: 'npm',
cache: true,
});
utils.restoreEnv();
});
});
describe('fromPackager', () => {
it('resolves tool path', async () => {
await install.fromPackager({ package: 'expo-cli', version: '3.0.10', packager: 'npm' });
expect(io.which).toBeCalledWith('npm');
});
it('creates temporary folder', async () => {
utils.setEnv('RUNNER_TEMP', join('temp', 'path'));
await install.fromPackager({ package: 'eas-cli', version: 'latest', packager: 'yarn' });
expect(io.mkdirP).toBeCalledWith(join('temp', 'path'));
utils.restoreEnv();
});
it('installs expo with tool', async () => {
utils.setEnv('RUNNER_TEMP', join('temp', 'path'));
io.which.mockResolvedValue('npm');
const expoPath = await install.fromPackager({ package: 'eas-cli', version: 'beta', packager: 'npm' });
expect(expoPath).toBe(join('temp', 'path'));
expect(cli.exec).toBeCalled();
expect(cli.exec.mock.calls[0][0]).toBe('npm');
expect(cli.exec.mock.calls[0][1]).toStrictEqual(['add', 'eas-cli@beta']);
expect(cli.exec.mock.calls[0][2]).toMatchObject({ cwd: join('temp', 'path') });
utils.restoreEnv();
});
});
+11 -9
View File
@@ -1,25 +1,27 @@
import { resolvePackage } from '../src/packager';
import { valid as validVersion } from 'semver';
import { resolveVersion } from '../src/packager';
describe(resolvePackage, () => {
describe(resolveVersion, () => {
it('resolves expo-cli@^2.0.0 to 2.21.2', async () => {
await expect(resolvePackage('expo-cli', '^2.0.0')).resolves.toBe('2.21.2');
await expect(resolveVersion('expo-cli', '^2.0.0')).resolves.toBe('2.21.2');
});
it('resolves expo-cli@~3.15.0 to 3.15.5', async () => {
await expect(resolvePackage('expo-cli', '~3.15.0')).resolves.toBe('3.15.5');
await expect(resolveVersion('expo-cli', '~3.15.0')).resolves.toBe('3.15.5');
});
it('resolves eas-cli@~0.33.0 to 0.33.1', async () => {
await expect(resolvePackage('eas-cli', '~0.33.0')).resolves.toBe('0.33.1');
await expect(resolveVersion('eas-cli', '~0.33.0')).resolves.toBe('0.33.1');
});
it('resolves expo-cli@latest to a version', async () => {
await expect(resolvePackage('expo-cli', 'latest')).resolves.not.toMatch('latest');
it('resolves expo-cli@latest to a valid version', async () => {
const version = await resolveVersion('expo-cli', 'latest');
expect(validVersion(version)).not.toBeNull();
});
it('rejects donotpublishthispackageoryouwillbefired with proper error', async () => {
await expect(resolvePackage('donotpublishthispackageoryouwillbefired', 'latest')).rejects.toThrow(
'Could not resolve'
await expect(resolveVersion('donotpublishthispackageoryouwillbefired', 'latest')).rejects.toThrow(
'Could not resolve version "latest" of "donotpublishthispackageoryouwillbefired"'
);
});
});
+328
View File
@@ -0,0 +1,328 @@
import * as core from '@actions/core';
import * as cli from '@actions/exec';
import * as tools from '../src/tools';
import * as packager from '../src/packager';
import * as utils from './utils';
describe(tools.getBinaryName, () => {
it('returns expo for `expo-cli`', () => {
expect(tools.getBinaryName('expo-cli')).toBe('expo');
});
it('returns eas for `eas-cli`', () => {
expect(tools.getBinaryName('eas-cli')).toBe('eas');
});
it('returns eas.cmd for `eas-cli` for windows', () => {
expect(tools.getBinaryName('eas-cli', true)).toBe('eas.cmd');
});
});
describe(tools.maybeAuthenticate, () => {
const token = 'ABC123';
const username = 'bycedric';
const password = 'mypassword';
describe('with token', () => {
let spy: { [key: string]: jest.SpyInstance } = {};
beforeEach(() => {
spy = {
exportVariable: jest.spyOn(core, 'exportVariable').mockImplementation(),
exec: jest.spyOn(cli, 'exec').mockImplementation(),
info: jest.spyOn(core, 'info').mockImplementation(),
};
});
afterAll(() => {
spy.exportVariable.mockRestore();
spy.exec.mockRestore();
spy.info.mockRestore();
});
it('skips authentication without token', async () => {
await tools.maybeAuthenticate();
expect(spy.exec).not.toBeCalled();
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping authentication'));
});
it('executes whoami command with token through environment', async () => {
utils.setEnv('TEST_INCLUDED', 'hellyeah');
await tools.maybeAuthenticate({ token, cli: 'expo-cli' });
expect(spy.exec).toBeCalled();
expect(spy.exec.mock.calls[0][1]).toStrictEqual(['whoami']);
expect(spy.exec.mock.calls[0][2]).toMatchObject({
env: {
TEST_INCLUDED: 'hellyeah',
EXPO_TOKEN: token,
},
});
utils.restoreEnv();
});
it('fails when token is incorrect', async () => {
const error = new Error('Not logged in');
spy.exec.mockRejectedValue(error);
await expect(tools.maybeAuthenticate({ token, cli: 'expo-cli' })).rejects.toBe(error);
});
it('skips validation without cli', async () => {
await tools.maybeAuthenticate({ token });
expect(spy.exec).not.toBeCalled();
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping token validation'));
});
it('executes whoami command with `expo` on macos', async () => {
utils.setPlatform('darwin');
await tools.maybeAuthenticate({ token, cli: 'expo-cli' });
expect(spy.exec).toBeCalled();
expect(spy.exec.mock.calls[0][0]).toBe('expo');
utils.restorePlatform();
});
it('executes whoami command with `eas` on ubuntu', async () => {
utils.setPlatform('linux');
await tools.maybeAuthenticate({ token, cli: 'eas-cli' });
expect(spy.exec).toBeCalled();
expect(spy.exec.mock.calls[0][0]).toBe('eas');
utils.restorePlatform();
});
it('executes whoami command with `expo.cmd` on windows', async () => {
utils.setPlatform('win32');
await tools.maybeAuthenticate({ token, cli: 'expo-cli' });
expect(spy.exec).toBeCalled();
expect(spy.exec.mock.calls[0][0]).toBe('expo.cmd');
utils.restorePlatform();
});
});
describe('credentials', () => {
let spy: { [key: string]: jest.SpyInstance } = {};
beforeEach(() => {
spy = {
exec: jest.spyOn(cli, 'exec').mockImplementation(),
info: jest.spyOn(core, 'info').mockImplementation(),
warning: jest.spyOn(core, 'warning').mockImplementation(),
};
});
afterAll(() => {
spy.exec.mockRestore();
spy.info.mockRestore();
spy.warning.mockRestore();
});
it('skips authentication without cli', async () => {
await tools.maybeAuthenticate({});
expect(spy.exec).not.toBeCalled();
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping authentication'));
});
it('skips authentication without credentials', async () => {
await tools.maybeAuthenticate({ cli: 'expo-cli' });
expect(spy.exec).not.toBeCalled();
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping authentication'));
});
it('skips authentication without password', async () => {
await tools.maybeAuthenticate({ username, cli: 'expo-cli' });
expect(spy.exec).not.toBeCalled();
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping authentication'));
});
it('skips authentication with credentials for eas-cli', async () => {
await tools.maybeAuthenticate({ username, password, cli: 'eas-cli' });
expect(spy.exec).not.toBeCalled();
expect(spy.warning).toBeCalledWith(expect.stringContaining('Skipping authentication'));
});
it('executes login command with password through environment', async () => {
utils.setEnv('TEST_INCLUDED', 'hellyeah');
await tools.maybeAuthenticate({ username, password, cli: 'expo-cli' });
expect(spy.exec).toBeCalled();
expect(spy.exec.mock.calls[0][1]).toStrictEqual(['login', `--username=${username}`]);
expect(spy.exec.mock.calls[0][2]).toMatchObject({
env: {
TEST_INCLUDED: 'hellyeah',
EXPO_CLI_PASSWORD: password,
},
});
utils.restoreEnv();
});
it('fails when credentials are incorrect', async () => {
const error = new Error('Invalid username/password. Please try again.');
spy.exec.mockRejectedValue(error);
await expect(tools.maybeAuthenticate({ username, password, cli: 'expo-cli' })).rejects.toBe(error);
});
it('executes login command with `expo` on macos', async () => {
utils.setPlatform('darwin');
await tools.maybeAuthenticate({ username, password, cli: 'expo-cli' });
expect(spy.exec).toBeCalled();
expect(spy.exec.mock.calls[0][0]).toBe('expo');
utils.restorePlatform();
});
it('executes login command with `expo` on ubuntu', async () => {
utils.setPlatform('linux');
await tools.maybeAuthenticate({ username, password, cli: 'expo-cli' });
expect(spy.exec).toBeCalled();
expect(spy.exec.mock.calls[0][0]).toBe('expo');
utils.restorePlatform();
});
it('executes login command with `expo.cmd` on windows', async () => {
utils.setPlatform('win32');
await tools.maybeAuthenticate({ username, password, cli: 'expo-cli' });
expect(spy.exec).toBeCalled();
expect(spy.exec.mock.calls[0][0]).toBe('expo.cmd');
utils.restorePlatform();
});
});
});
describe(tools.maybePatchWatchers, () => {
let spy: { [key: string]: jest.SpyInstance } = {};
beforeEach(() => {
spy = {
info: jest.spyOn(core, 'info').mockImplementation(),
warning: jest.spyOn(core, 'warning').mockImplementation(),
exec: jest.spyOn(cli, 'exec').mockImplementation(),
};
});
afterEach(() => {
utils.restorePlatform();
});
afterAll(() => {
spy.info.mockRestore();
spy.warning.mockRestore();
spy.exec.mockRestore();
});
it('increses fs inotify settings with sysctl', async () => {
utils.setPlatform('linux');
await tools.maybePatchWatchers();
expect(spy.exec).toBeCalledWith('sudo sysctl fs.inotify.max_user_instances=524288');
expect(spy.exec).toBeCalledWith('sudo sysctl fs.inotify.max_user_watches=524288');
expect(spy.exec).toBeCalledWith('sudo sysctl fs.inotify.max_queued_events=524288');
expect(spy.exec).toBeCalledWith('sudo sysctl -p');
});
it('warns for unsuccessful patches', async () => {
const error = new Error('Something went wrong');
spy.exec.mockRejectedValueOnce(error);
utils.setPlatform('linux');
await tools.maybePatchWatchers();
expect(core.warning).toBeCalledWith(expect.stringContaining("can't patch watchers"));
expect(core.warning).toBeCalledWith(
expect.stringContaining('https://github.com/expo/expo-github-action/issues/20')
);
});
it('skips on windows platform', async () => {
utils.setPlatform('win32');
await tools.maybePatchWatchers();
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping'));
expect(spy.exec).not.toHaveBeenCalled();
});
it('skips on macos platform', async () => {
utils.setPlatform('darwin');
await tools.maybePatchWatchers();
expect(spy.info).toBeCalledWith(expect.stringContaining('Skipping'));
expect(spy.exec).not.toHaveBeenCalled();
});
it('runs on linux platform', async () => {
utils.setPlatform('linux');
await tools.maybePatchWatchers();
expect(spy.info).toBeCalledWith(expect.stringContaining('Patching'));
expect(spy.exec).toHaveBeenCalled();
});
});
describe(tools.maybeWarnForUpdate, () => {
let spy: { [key: string]: jest.SpyInstance } = {};
beforeEach(() => {
spy = {
warning: jest.spyOn(core, 'warning').mockImplementation(),
resolveVersion: jest.spyOn(packager, 'resolveVersion').mockImplementation(),
};
});
afterAll(() => {
spy.warning.mockRestore();
spy.resolveVersion.mockRestore();
});
it('is silent when major version is up to date', async () => {
spy.resolveVersion.mockResolvedValueOnce('4.1.0').mockResolvedValueOnce('4.0.1');
await tools.maybeWarnForUpdate('eas-cli');
expect(spy.warning).not.toBeCalled();
});
it('warns when major version is outdated', async () => {
spy.resolveVersion.mockResolvedValueOnce('4.1.0').mockResolvedValueOnce('3.0.1');
await tools.maybeWarnForUpdate('expo-cli');
expect(spy.warning).toBeCalledWith('There is a new major version available of the Expo CLI (4.1.0)');
expect(spy.warning).toBeCalledWith('If you run into issues, try upgrading your workflow to "expo-version: 4.x"');
});
});
describe(tools.handleError, () => {
let spy: { [key: string]: jest.SpyInstance } = {};
beforeEach(() => {
spy = {
setFailed: jest.spyOn(core, 'setFailed').mockImplementation(),
resolveVersion: jest.spyOn(packager, 'resolveVersion').mockImplementation(),
};
});
afterAll(() => {
spy.setFailed.mockRestore();
spy.resolveVersion.mockRestore();
});
it('marks the job as failed with expo-cli', async () => {
const error = new Error('test');
spy.resolveVersion.mockResolvedValue('4.0.0');
await tools.handleError('expo-cli', error);
expect(core.setFailed).toBeCalledWith(error);
});
it('fails with original error when update warning failed', async () => {
const error = new Error('test');
spy.resolveVersion.mockRejectedValue(new Error('npm issue'));
await tools.handleError('eas-cli', error);
expect(core.setFailed).toBeCalledWith(error);
});
});
describe(tools.performAction, () => {
it('skips the test in a jest environment', async () => {
utils.setEnv('JEST_WORKER_ID', '69');
const action = jest.fn();
const result = await tools.performAction(action);
expect(result).toBeNull();
expect(action).not.toBeCalled();
utils.restoreEnv();
});
it('runs the test outside a jest environment', async () => {
utils.setEnv('JEST_WORKER_ID', '');
const action = jest.fn();
const result = await tools.performAction(action);
expect(result).toBeUndefined();
expect(action).toBeCalled();
utils.restoreEnv();
});
});
+18 -4
View File
@@ -14,7 +14,7 @@ export function setPlatform(platform: NodeJS.Platform): void {
/**
* Revert the platform to the original one.
*/
export function resetPlatform(): void {
export function restorePlatform(): void {
setPlatform(originalPlatform);
}
@@ -31,14 +31,28 @@ export function setEnv(name: string, value: string): void {
/**
* Revert the environment variable changes.
*/
export function resetEnv(): void {
export function restoreEnv(): void {
process.env = originalEnv;
}
/**
* Get a mocked version of the tools.
*/
export function getToolsMock() {
return {
getBinaryName: jest.fn(v => v.replace('-cli', '')),
maybeAuthenticate: jest.fn(),
maybePatchWatchers: jest.fn(),
maybeWarnForUpdate: jest.fn(),
handleError: jest.fn(),
performAction: jest.fn(),
};
}
/**
* Mock both the input and boolean input methods from `@actions/core`.
*/
export function mockInput(inputs: Record<string, string> = {}) {
jest.mocked(core.getInput).mockImplementation(name => inputs[name]);
jest.mocked(core.getBooleanInput).mockImplementation(name => inputs[name] === 'true');
jest.spyOn(core, 'getInput').mockImplementation(name => inputs[name]);
jest.spyOn(core, 'getBooleanInput').mockImplementation(name => inputs[name] === 'true');
}
-139
View File
@@ -1,139 +0,0 @@
import * as core from '@actions/core';
import * as exec from '@actions/exec';
import * as io from '@actions/io';
import os from 'os';
import path from 'path';
import {
tempPath,
toolPath,
installToolFromPackage,
patchWatchers,
expoAuthenticate,
executeAction,
} from '../src/worker';
import { resetEnv, setEnv, setPlatform, resetPlatform } from './utils';
jest.mock('@actions/core');
jest.mock('@actions/exec');
jest.mock('@actions/io');
describe(tempPath, () => {
afterEach(resetEnv);
it('throws when RUNNER_TEMP is undefined', () => {
setEnv('RUNNER_TEMP', '');
expect(tempPath).toThrow(`'RUNNER_TEMP' not defined`);
});
it('returns path with name, version, and arch type', () => {
setEnv('RUNNER_TEMP', 'fake/temp');
expect(tempPath('expo-cli', '5.0.3')).toBe(path.join('fake', 'temp', 'expo-cli', '5.0.3', os.arch()));
});
});
describe(toolPath, () => {
afterEach(resetEnv);
it('throws when RUNNER_TOOL_CACHE is undefined', () => {
setEnv('RUNNER_TOOL_CACHE', '');
expect(toolPath).toThrow(`'RUNNER_TOOL_CACHE' not defined`);
});
it('returns path with name, version, and arch type', () => {
setEnv('RUNNER_TOOL_CACHE', 'fake/tool');
expect(toolPath('eas-cli', '0.34.3')).toBe(path.join('fake', 'tool', 'eas-cli', '0.34.3', os.arch()));
});
});
describe(installToolFromPackage, () => {
it('registers path to <dir>/node_modules/.bin', () => {
installToolFromPackage('fake/install');
expect(core.addPath).toBeCalledWith(path.join('fake', 'install', 'node_modules', '.bin'));
});
});
describe(patchWatchers, () => {
afterEach(resetPlatform);
it('skips patches on windows', async () => {
setPlatform('win32');
await patchWatchers();
expect(exec.exec).not.toBeCalled();
});
it('skips patches on macos', async () => {
setPlatform('darwin');
await patchWatchers();
expect(exec.exec).not.toBeCalled();
});
it('patches on ubuntu', async () => {
setPlatform('linux');
await patchWatchers();
expect(exec.exec).toBeCalledWith('sudo sysctl fs.inotify.max_user_instances=524288');
expect(exec.exec).toBeCalledWith('sudo sysctl fs.inotify.max_user_watches=524288');
expect(exec.exec).toBeCalledWith('sudo sysctl fs.inotify.max_queued_events=524288');
expect(exec.exec).toBeCalledWith('sudo sysctl -p');
});
it('handles exception from commands', async () => {
setPlatform('linux');
jest
.mocked(exec.exec)
.mockResolvedValueOnce(0)
.mockResolvedValueOnce(0)
.mockRejectedValueOnce(new Error('fake error'));
await expect(patchWatchers()).resolves.not.toThrow();
});
});
describe(expoAuthenticate, () => {
it('exports EXPO_TOKEN variable', async () => {
await expoAuthenticate('faketoken', undefined);
expect(core.exportVariable).toBeCalledWith('EXPO_TOKEN', 'faketoken');
});
it('validates EXPO_TOKEN with expo-cli', async () => {
jest.mocked(io.which).mockResolvedValue('expo');
await expoAuthenticate('faketoken', 'expo');
expect(io.which).toBeCalledWith('expo');
expect(exec.exec).toBeCalledWith('expo', ['whoami'], {
env: expect.objectContaining({ EXPO_TOKEN: 'faketoken' }),
});
});
it('validates EXPO_TOKEN with eas-cli', async () => {
jest.mocked(io.which).mockResolvedValue('eas');
await expoAuthenticate('faketoken', 'eas');
expect(io.which).toBeCalledWith('eas');
expect(exec.exec).toBeCalledWith('eas', ['whoami'], {
env: expect.objectContaining({ EXPO_TOKEN: 'faketoken' }),
});
});
});
describe(executeAction, () => {
afterEach(resetEnv);
it('skips executing action in jest', async () => {
const action = jest.fn(() => Promise.resolve());
await executeAction(action);
expect(action).not.toBeCalled();
});
it('executes action outside jest', async () => {
setEnv('JEST_WORKER_ID', '');
const action = jest.fn(() => Promise.resolve());
await executeAction(action);
expect(action).toBeCalled();
});
it('handles action errors', async () => {
setEnv('JEST_WORKER_ID', '');
const error = new Error('fake error');
const action = jest.fn(() => Promise.reject(error));
await expect(executeAction(action)).resolves.not.toThrow();
expect(core.setFailed).toBeCalledWith(error);
});
});
+710 -1402
View File
File diff suppressed because it is too large. Load diff