Skip to content

cloud test setup documentation - #495

Merged
grafnu merged 13 commits into
faucetsdn:masterfrom
grafnu:mqttsetup
Jun 24, 2020
Merged

grafnu merged 13 commits into
faucetsdn:masterfrom
grafnu:mqttsetup

Conversation

@grafnu

@grafnu grafnu commented Jun 22, 2020

Copy link
Copy Markdown
Collaborator

No description provided.

@codecov

codecov Bot commented Jun 22, 2020 •

Copy link
Copy Markdown

Codecov Report

Merging #495 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            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     
Flag Coverage Δ
#aux 74.97% <ø> (ø)
#base 76.34% <ø> (ø)
#dhcp 71.30% <ø> (ø)
#many 71.47% <ø> (-0.09%) ⬇️
#modules 23.44% <ø> (ø)
#topo 73.32% <ø> (-0.03%) ⬇️
Impacted Files Coverage Δ
daq/host.py 91.16% <0.00%> (-0.18%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bf7840a...226646a. Read the comment docs.

@grafnu grafnu changed the title WIP cloud testing documentation cloud test setup documentation Jun 23, 2020
@grafnu
grafnu requested a review from pbatta June 23, 2020 06:03
@grafnu

grafnu commented Jun 23, 2020

Copy link
Copy Markdown
Collaborator Author

For now, I would just review this for basic english, but save a vetting walkthrough as part of the cleanup/test documentation pass.

Comment thread docs/cloud_tests.md Outdated

## Manual Test Pipeline

The overal device-to-cloud pipeline looks something like the following:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

typo

Comment thread 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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

typo

@grafnu

grafnu commented Jun 24, 2020

Copy link
Copy Markdown
Collaborator Author

Typos have been addressed, PTAL.

Comment thread 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,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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)

Comment thread 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`

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

s/proeject/project

Comment thread 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,

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

s/varaible/variable

Comment thread 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).

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

s/assocatied/associated & s/someting/something

@grafnu
grafnu merged commit 33ea77a into faucetsdn:master Jun 24, 2020
@grafnu
grafnu deleted the mqttsetup branch July 21, 2020 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants