-
Notifications
You must be signed in to change notification settings - Fork 24.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
infra(e2e): rework local E2E script (#34513)
Summary: This is a long time coming effort to improve the situation around the local e2e script that in the release crew: the current bash-based script is quirky at best, and what you end up generating as a sample project is not really a true sample project. This is where this PR comes in: it migrates the flow from `./scripts/test-manual-e2e.sh` to `yarn test-e2e-local <options>`. Here's the current shape of the options: ```sh Options: --help Show help [boolean] --version Show version number [boolean] -t, --target [choices: "RNTester", "RNTestProject"] [default: "RNTester"] -p, --platform [choices: "iOS", "Android"] [default: "iOS"] -h, --hermes [boolean] [default: true] ``` The idea is to change it so that you can just run the script, and it will do that one specific thing "well", without the tester needing to do anything aside from actually testing the app once it's open. Some of the key changes: * tries to stick to the patterns of the other established *.js based scripts, in terms of tooling and approach (and even refactor parts that can be shared with other scripts) - like the android artifacts generation * no need to start the android emulator on the side * no need to start Metro on the side * RNTester iOS will open up on the simulator (no Xcode open that then you need to press) Things that still need work: * see the #fixme and #todo in comments * because we rely on exec, the output sent back is not formatted/shaped correctly so it's a bit more noisy/chaotic - but can't handle it right now because the package we use doesn't allow it - see shelljs/shelljs#86 ## Changelog <!-- Help reviewers and the release process by writing your own changelog entry. For an example, see: https://reactnative.dev/contributing/changelogs-in-pull-requests --> [Internal] [Changed] - Migrate bash E2E local testing script to new JS based command Pull Request resolved: #34513 Test Plan: To test the script, you can run it passing the options showed above; this is the current situation: * RNTester iOS Hermes ✅ * RNTester Android Hermes ✅ * RNTester iOS JSC ✅ * RNTester Android JSC ✅ * RNTestProject Android Hermes ✅ * RNTestProject iOS Hermes ✅ * RNTestProject Android JSC ✅ * RNTestProject iOS JSC ✅ Reviewed By: cortinico Differential Revision: D39814692 Pulled By: cortinico fbshipit-source-id: d4791798aaad764c6a3757269b7636f847ccf2ca
- Loading branch information
1 parent
540ae39
commit 97f5ef0
Showing
11 changed files
with
489 additions
and
67 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| /** | ||
| * Copyright (c) Meta Platforms, Inc. and affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| * | ||
| * @format | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| const {exec, echo, exit, test, env} = require('shelljs'); | ||
| const {revertFiles, saveFiles} = require('./scm-utils'); | ||
|
|
||
| function saveFilesToRestore(tmpPublishingFolder) { | ||
| const filesToSaveAndRestore = [ | ||
| 'template/Gemfile', | ||
| 'template/_ruby-version', | ||
| 'template/package.json', | ||
| '.ruby-version', | ||
| 'Gemfile.lock', | ||
| 'Gemfile', | ||
| 'package.json', | ||
| 'ReactAndroid/gradle.properties', | ||
| 'Libraries/Core/ReactNativeVersion.js', | ||
| 'React/Base/RCTVersion.m', | ||
| 'ReactAndroid/src/main/java/com/facebook/react/modules/systeminfo/ReactNativeVersion.java', | ||
| 'ReactCommon/cxxreact/ReactNativeVersion.h', | ||
| ]; | ||
|
|
||
| saveFiles(filesToSaveAndRestore, tmpPublishingFolder); | ||
| } | ||
|
|
||
| function generateAndroidArtifacts(releaseVersion, tmpPublishingFolder) { | ||
| // -------- Generating Android Artifacts | ||
| env.REACT_NATIVE_SKIP_PREFAB = true; | ||
| if (exec('./gradlew :ReactAndroid:installArchives').code) { | ||
| echo('Could not generate artifacts'); | ||
| exit(1); | ||
| } | ||
|
|
||
| // -------- Generating the Hermes Engine Artifacts | ||
| env.REACT_NATIVE_HERMES_SKIP_PREFAB = true; | ||
| if (exec('./gradlew :ReactAndroid:hermes-engine:installArchives').code) { | ||
| echo('Could not generate artifacts'); | ||
| exit(1); | ||
| } | ||
|
|
||
| // undo uncommenting javadoc setting | ||
| revertFiles(['ReactAndroid/gradle.properties'], tmpPublishingFolder); | ||
|
|
||
| echo('Generated artifacts for Maven'); | ||
|
|
||
| let artifacts = [ | ||
| '.module', | ||
| '.pom', | ||
| '-debug.aar', | ||
| '-release.aar', | ||
| '-debug-sources.jar', | ||
| '-release-sources.jar', | ||
| ].map(suffix => { | ||
| return `react-native-${releaseVersion}${suffix}`; | ||
| }); | ||
|
|
||
| artifacts.forEach(name => { | ||
| if ( | ||
| !test( | ||
| '-e', | ||
| `./android/com/facebook/react/react-native/${releaseVersion}/${name}`, | ||
| ) | ||
| ) { | ||
| echo( | ||
| `Failing as expected file: \n\ | ||
| android/com/facebook/react/react-native/${releaseVersion}/${name}\n\ | ||
| was not correctly generated.`, | ||
| ); | ||
| exit(1); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| module.exports = { | ||
| generateAndroidArtifacts, | ||
| saveFilesToRestore, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /** | ||
| * Copyright (c) Meta Platforms, Inc. and affiliates. | ||
| * | ||
| * This source code is licensed under the MIT license found in the | ||
| * LICENSE file in the root directory of this source tree. | ||
| * | ||
| * @format | ||
| */ | ||
|
|
||
| 'use strict'; | ||
|
|
||
| /* | ||
| * This script, paired with test-e2e-local.js, is the full suite of | ||
| * tooling needed for a successful local testing experience. | ||
| * This script is an helper to clean up the environment fully | ||
| * before running the test suite. | ||
| * | ||
| * You should use this when switching between branches. | ||
| * | ||
| * It will: | ||
| * - clean up node modules | ||
| * - clean up the build folder (derived data, gradlew cleanAll) | ||
| * - clean up the pods folder for RNTester (pod install) (and Podfile.lock too) | ||
| * - kill all packagers | ||
| * - remove RNTestProject folder | ||
| * | ||
| * an improvements to consider: | ||
| * - an option to uninstall the apps (RNTester, RNTestProject) from emulators | ||
| */ | ||
|
|
||
| const {exec, exit} = require('shelljs'); | ||
|
|
||
| const {isPackagerRunning} = require('./testing-utils'); | ||
|
|
||
| console.info('\n** Starting the clean up process **\n'); | ||
|
|
||
| // let's check if Metro is already running, if it is let's kill it and start fresh | ||
| if (isPackagerRunning() === 'running') { | ||
| exec("lsof -i :8081 | grep LISTEN | /usr/bin/awk '{print $2}' | xargs kill"); | ||
| console.info('\n** Killed Metro **\n'); | ||
| } | ||
|
|
||
| // Android | ||
| console.info('\n** Cleaning Gradle build artifacts **\n'); | ||
| exec('./gradlew cleanAll'); | ||
|
|
||
| // iOS | ||
| console.info('\n** Nuking the derived data folder **\n'); | ||
| exec('rm -rf ~/Library/Developer/Xcode/DerivedData'); | ||
|
|
||
| // RNTester Pods | ||
| console.info('\n** Removing the RNTester Pods **\n'); | ||
| exec('rm -rf packages/rn-tester/Pods'); | ||
|
|
||
| // I'm not sure we want to also remove the lock file | ||
| // exec('rm -rf packages/rn-tester/Podfile.lock'); | ||
|
|
||
| // RNTestProject | ||
| console.info('\n** Removing the RNTestProject folder **\n'); | ||
| exec('rm -rf /tmp/RNTestProject'); | ||
|
|
||
| // final clean up | ||
| console.info('\n** Final git level wipe **\n'); | ||
| // clean unstaged changes from git | ||
| exec('git checkout -- .'); | ||
| // remove all the untracked files | ||
| exec('git clean -fdx'); | ||
|
|
||
| console.info( | ||
| '\n** Clean up process completed\nPlease remember to run yarn install if you are planning to test again\n', | ||
| ); | ||
| exit(0); |
Oops, something went wrong.