Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: update integration test commands to allow selection #910

Merged
merged 3 commits into from
Sep 27, 2021
Merged

chore: update integration test commands to allow selection #910

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fdb21c9
chore: update integ test commands with selection
Jordan-Nelson Sep 23, 2021
0229514
chore: update description
Jordan-Nelson Sep 23, 2021
f06c3a5
Merge branch 'main' into chore/integration-test-select
Jordan-Nelson Sep 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 29 additions & 17 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,45 +154,57 @@ toolkit for interacting with AWS backend resources.

## Integration Tests

In addition to unit tests which mock Amplify API interaction, this repository has integration tests which
test functionality with real Amplify backends. The integration test script will execute tests in example
In addition to unit tests which mock Amplify API interaction, this repository has integration tests which
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The formatting changes in this file are auto formatting from prettier. The changes generally seem to be an improvement, and the majority of the file was already following that formatting, so I decided to leave them.

Pro tip: use https://github.com/aws-amplify/amplify-flutter/pull/910/files?diff=split&w=1 to ignore the whitespace changes

I also updated a few typos in the file.

test functionality with real Amplify back-ends. The integration test script will execute tests in example
apps which have integration tests written (skipping those that don't). It runs on Android and iOS simulators.

**Note:** To run integration tests, you will need prerequisite Amplify resources in the example
**Note:** To run integration tests, you will need prerequisite Amplify resources in the example
apps where the tests run. The process for creating those is noted below. You will also need to install dependencies with `melos bootstrap`.

To run all integration tests on available platforms:

```bash
$ melos run test:integration
```

To run all tests just on Android (also works for `ios` instead of `android`):
To run tests for all packages on a single platform (replace `android` with `ios` to run on iOS):

```bash
$ melos run test:integration:android --no-select
```

To run tests for a single package on a single platform (replace `android` with `ios` to run on iOS):

> Note: you will be prompted with which package to run the tests for

```bash
$ melos run test:integration:android
```

To run a single test file on device matching "sdk":

```bash
$ cd packages/amplify_auth_cognito/example
$ flutter drive --driver=test_driver/integration_test.dart --target=integration_test/sign_in_sign_out_test.dart -d sdk
```

## Provision Resources For Integration Tests

Any app with integration tests will have a script `tool/provision_integration_test_resources.sh` which will call `amplify init` and `amplify push` with preconfigured amplify environments for that app.
Executing it will create real AWS resources. It requires [the Amplify CLI](https://docs.amplify.aws/cli). It does not need to run every time you run the tests. Run it once to set up or update your environments.
If you already have an amplify environment configured for an app, this command will create a "test"
Any app with integration tests will have a script `tool/provision_integration_test_resources.sh` which will call `amplify init` and `amplify push` with preconfigured amplify environments for that app.
Executing it will create real AWS resources. It requires [the Amplify CLI](https://docs.amplify.aws/cli). It does not need to run every time you run the tests. Run it once to set up or update your environments.
If you already have an amplify environment configured for an app, this command will create a "test"
environment and check it out.

Create all the amplify environments in the example apps which have provisioning scripts (takes several minutes). Note that you may need to give yourself permission to execute the scripts.:

```bash
$ melos run provision_integration_test_resources
```

Note: you will need to have [`jq`](https://github.com/stedolan/jq) installed, which you can install by running `brew install jq`.
Note: you will need to have [`jq`](https://github.com/stedolan/jq) installed, which you can install by running `brew install jq`.
The provisioning script uses the [Amplify CLI headless mode](https://docs.amplify.aws/cli/usage/headless).

The auth tests require some additional configuration to support lambda triggers for automatically
The auth tests require some additional configuration to support lambda triggers for automatically
verifying temporary test users. Note that this should only be done for the test environment, never a production one. This can be done manually by [following this process](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html#aws-lambda-triggers-pre-registration-example-2) or by following these instructions for the amplify CLI:

```
Expand All @@ -201,7 +213,7 @@ $ amplify update auth
Please note that certain attributes may not be overwritten if you choose to use defaults settings.
Using service: Cognito, provided by: awscloudformation
What do you want to do?
Walkthrough all the auth configurations
Walk-through all the auth configurations
Select the authentication/authorization services that you want to use:
User Sign-Up, Sign-In, connected with AWS IAM controls ( Enables per-user Storage features for images or other content, Analytics, and more)
Please enter a name for your identity pool.
Expand All @@ -214,7 +226,7 @@ $ amplify update auth
No
Do you want to add an admin queries API?
No
Multifactor authentication (MFA) user login options:
Multi-factor authentication (MFA) user login options:
OFF
Email based user registration/forgot password:
Enabled (Requires per-user email entry at registration)
Expand All @@ -228,7 +240,7 @@ $ amplify update auth
30
Do you want to specify the user attributes this app can read and write?
No
Do you want to enable any of the following capabilities?
Do you want to enable any of the following capabilities?
Do you want to use an OAuth flow?
No
? Do you want to configure Lambda Triggers for Cognito?
Expand All @@ -240,23 +252,22 @@ $ amplify update auth
Successfully added resource authintegrationtestPreSignup locally.
```

When prompted to edit the function now, choose "yes" and add the following code to the `custom.js` file
When prompted to edit the function now, choose "yes" and add the following code to the `custom.js` file
created by the amplify CLI, from [documentation](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html#aws-lambda-triggers-pre-registration-example-2).

```js
exports.handler = (event, context, callback) => {

// Confirm the user
event.response.autoConfirmUser = true;

// Set the email as verified if it is in the request
if (event.request.userAttributes.hasOwnProperty("email")) {
event.response.autoVerifyEmail = true;
event.response.autoVerifyEmail = true;
}

// Set the phone number as verified if it is in the request
if (event.request.userAttributes.hasOwnProperty("phone_number")) {
event.response.autoVerifyPhone = true;
event.response.autoVerifyPhone = true;
}

// Return to Amazon Cognito
Expand All @@ -265,11 +276,12 @@ exports.handler = (event, context, callback) => {
```

Finally, run a push to update the resources with the new function resource (lambda trigger):

```bash
$ amplify push
```

Additionally, the storage category requires some manual configuration as the [headless CLI does not yet support storage](https://github.com/aws-amplify/amplify-cli/issues/7378). Those instructions
Additionally, the storage category requires some manual configuration as the [headless CLI does not yet support storage](https://github.com/aws-amplify/amplify-cli/issues/7378). Those instructions
are notes in the [storage example app](packages/amplify_storage_s3/example/README.md).

## Code of Conduct
Expand Down
21 changes: 18 additions & 3 deletions melos.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,31 @@ scripts:
./.circleci/test_all_plugins.sh ios-test && exit 0

test:integration:
run: melos run test:integration:android && melos run test:integration:ios
run: melos run test:integration:android --no-select && melos run test:integration:ios --no-select
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! Did not know about no-select option.

description:
Run all integration tests for all package example apps on Android and iOS simulators. Skips if no tests available.
- Requires running Android and iOS simulators.

test:integration:android:
run: melos exec -c 1 --scope="*example*" --file-exists="integration_test/main_test.dart" "flutter drive --no-pub --driver=test_driver/integration_test.dart --target=integration_test/main_test.dart -d sdk"
run: melos exec -c 1 "flutter drive --no-pub --driver=test_driver/integration_test.dart --target=integration_test/main_test.dart -d sdk"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for restoring this syntax!

description:
Run integration tests for a single package on an Android emulator.
- Run with `--no-select` to run for all applicable packages.
- Requires launching an Android emulator prior to execution.
select-package:
file-exists:
- integration_test/main_test.dart
scope: "*example*"

test:integration:ios:
run: melos exec -c 1 --scope="*example*" --file-exists="integration_test/main_test.dart" "flutter drive --no-pub --driver=test_driver/integration_test.dart --target=integration_test/main_test.dart -d iPhone"
run: melos exec -c 1 "flutter drive --no-pub --driver=test_driver/integration_test.dart --target=integration_test/main_test.dart -d iPhone"
description: Run integration tests for a single package on an iOS simulator.
- Run with `--no-select` to run for all applicable packages.
- Requires launching an iOS simulator prior to execution.
select-package:
file-exists:
- integration_test/main_test.dart
scope: "*example*"

provision_integration_test_resources:
run: melos exec "./tool/provision_integration_test_resources.sh"
Expand Down