feat: Run integration tests on full Apple CI matrix #1476
Conversation
jbelkins
changed the title
| # Insert the credentials into the .xctestplan file, write the modified JSON | ||
| # to a temp file, then move the temp over the original. | ||
| jq ".defaultOptions.environmentVariableEntries += [{\"key\": \"AWS_ACCESS_KEY_ID\", \"value\": $AKID_ESCAPED}, {\"key\": \"AWS_SECRET_ACCESS_KEY\", \"value\": $SECRET_ESCAPED}, {\"key\": \"AWS_DEFAULT_REGION\", \"value\": $REGION_ESCAPED}, {\"key\": \"AWS_SESSION_TOKEN\", \"value\": $TOKEN_ESCAPED}]" XCTestPlans/AWSIntegrationTestsOnCI.xctestplan > testplan.tmp | ||
| mv testplan.tmp XCTestPlans/AWSIntegrationTestsOnCI.xctestplan |
There was a problem hiding this comment.
Above is the "secret sauce": to get AWS credentials into the Xcode simulators: use the jq command-line utility to insert the credentials into the scheme's .xctestplan file.
(.xctestplan is a JSON file used by Xcode to conbfigure tests, and jq is a CLI utility for reading, writing & updating JSON.)
There was a problem hiding this comment.
I don't believe jq comes pre-installed on Macs unless github actions makes it available, does this work when run on a github actions environment?
For a script I wrote to run on Amazon Linux I built-in a bash script method that checks if jq is installed and installs it if not, you may need to do something similar here
There was a problem hiding this comment.
NVM I see it comes with github actions
| @@ -0,0 +1,47 @@ | |||
| <?xml version="1.0" encoding="UTF-8"?> | |||
There was a problem hiding this comment.
This is basically a scheme with default settings, that delegates all test configuration to the test plan at XCTestPlans/AWSIntegrationTestsOnCI.xctestplan.
| @@ -0,0 +1,95 @@ | |||
| { | |||
There was a problem hiding this comment.
This file defines the test targets and the configuration to be used when running integration tests.
There was a problem hiding this comment.
This file is actually ignored by Git, and you have to "force" Git to commit changes to it with git add -f.
It must remain ignored, so that Git credentials aren't accidentally committed.
| "defaultOptions" : { | ||
| "environmentVariableEntries" : [ | ||
|
|
||
| ] |
There was a problem hiding this comment.
The step defined in the Github workflow above will fill this empty JSON array with environment variable settings for the test run's AWS credentials.
|
|
||
| ] | ||
| }, | ||
| "testTargets" : [ |
There was a problem hiding this comment.
This section of the file contains all the test targets to be run as part of integration tests.
Note that when we add a new integration test target to the repo, we will have to add it here to make it run on CI.
| @@ -18,20 +18,36 @@ jobs: | |||
| strategy: | |||
| fail-fast: false | |||
| matrix: | |||
There was a problem hiding this comment.
The matrix used here for Apple platforms is copied verbatim out of https://github.com/awslabs/aws-sdk-swift/blob/main/.github/workflows/continuous-integration.yml .
|
Merging this despite the failing integration tests; those are legitimate integration test failures exposed by the config changes in this PR. Will address the root cause of those failures separately. |
Issue #
#1477
Description of changes
Runs our integration test suite on all of the
xcodebuilddestinations that CI does: Mac plus iOS, tvOS sims..xctestplanfile. Since xctestplan is a JSON file, thejqcommand line utility is used to write the credentials into the file before testing. They are then set as environment variables for the test suite before running.New/existing dependencies impact assessment, if applicable
No new dependencies were added to this change.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.