cloud test setup documentation #495
Merged
Conversation
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
Codecov Report
@@ Coverage Diff @@
## master #495 +/- ##
==========================================
- Coverage 79.89% 79.86% -0.03%
==========================================
Files 21 21
Lines 3621 3621
==========================================
- Hits 2893 2892 -1
- Misses 728 729 +1
Continue to review full report at Codecov.
|
|
For now, I would just review this for basic english, but save a vetting walkthrough as part of the cleanup/test documentation pass. |
henry54809
reviewed
Jun 23, 2020
docs/cloud_tests.md
Outdated
|
|
||
| ## Manual Test Pipeline | ||
|
|
||
| The overal device-to-cloud pipeline looks something like the following: |
docs/cloud_tests.md
Outdated
|
|
||
| Take note the URL in your browser's address bar when running Travis. You might be on either | ||
| <code>travis-ci<b>.com</b></code> or <code>travis-ci<b>.org</b></code>. Any particular setup | ||
| may end up across both sites for undertermined reasons. Please consult with your browser's |
|
Typos have been addressed, PTAL. |
henry54809
approved these changes
Jun 24, 2020
pbatta
requested changes
Jun 24, 2020
docs/cloud_tests.md
Outdated
| ## Base Local Test Setup | ||
|
|
||
| * The `udmi` module needs to be enabled in build. When running `cmd/build` there should be a line | ||
| like `subset/cloud/Dockerfile.test_udmi`. This is enabled through the `host_tests` config parameter, |
There was a problem hiding this comment.
a line like subset/cloud/Dockerfile.test_udmi in the startup logs? (not clear whether that line should be in config or will show up in some log)
docs/cloud_tests.md
Outdated
| ## Integration Testing | ||
|
|
||
| If developing cloud-tests, then the CI build system also needs to have a service account configured | ||
| pointing at a suitable GCP proejct. To run cloud-based tests, setup the Travis `GCP_BASE64_CRED` |
docs/cloud_tests.md
Outdated
| use a dedicated key with a nice name like `daq-travis`, but not required. Encode the key value | ||
| as per below, and cut/paste the resulting string into a | ||
| [Travis environment variable](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings) | ||
| for a `GCP_BASE64_CRED` varaible. Note the `-w 0` option is required for proper parsing/formatting, |
docs/cloud_tests.md
Outdated
| * `gcp_topic` config to `local/system.conf` as described in this doc. | ||
| * Configure test subsystem with proper cloud endpoint in `{test_site}/cloud_iot_config.json`. | ||
| * Configure the DUT with the proper cloud device credentials (device specific). For _faux_ devices, this means copying | ||
| the assocatied `rsa_private.pkcs8` file to someting like `inst/faux/daq-faux-2/local/` (exact path depends on which faux). |
There was a problem hiding this comment.
s/assocatied/associated & s/someting/something
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.