-
Notifications
You must be signed in to change notification settings - Fork 75
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.
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
update integration testing doc #3073
Conversation
@orndorffgrant @lucasmoura
Please feel free to leave comments for specific changes if these sections have to be updated. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a tiny nit, but LGTM
dev-docs/howtoguides/testing.md
Outdated
As can be seen, this will run behave tests only for release 22.04 (Jammy Jellyfish). We are currently | ||
supporting 7 distinct releases: | ||
|
||
* 23.10 (Mantic Minotaur) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We no longer run tests for Lunar and Kinetic, we can remove those entries
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please avoid specifying the releases, unless if giving an example. Specify the rule:
- all supported releases
- LTS releases, including those under ESM
- devel release, at some point in the development cycle
Otherwise this is going to go stale often and we need to update it every 3 months or so during the interim cycles
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated to mention the rule instead of specific releases
ad88972
to
43cfb03
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the much needed updates!
Please rebase this to target docs
since this does not need to wait for a future version of pro-client
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One last nit then we can merge
dev-docs/howtoguides/testing.md
Outdated
@@ -57,36 +57,33 @@ The testing can be overridden to install ubuntu-advantage-tools from other sourc | |||
> **Note** | |||
> Note that we cache the source when running with `UACLIENT_BEHAVE_INSTALL_FROM=local` based on a hash, calculated from the repository state. If you change the python code locally and run the behave tests against your new version, there will be new debs in the cache source with the new repo state hash. | |||
|
|||
To run the tests, you can use `tox`: | |||
To run the integration tests, use the `tox` command as shown below. | |||
Please note that this command will execute all the integration tests sequentially and may take a significant amount of time to complete, depending on the number and complexity of the tests. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This command as written will always take a long time - no "depending..." :)
Please note that this command will execute all the integration tests sequentially and may take a significant amount of time to complete, depending on the number and complexity of the tests. | |
Please note that, as shown here without arguments, this command would execute all the integration tests sequentially and would take an inordinate amount of time to complete. Always pass arguments to this command to specify a subset of tests to run, as demonstrated next. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated
8014ec1
to
6c0fd5f
Compare
Why is this needed?
This PR updates the integration testing document to current commands for testing the pro client.
Test Steps
Checklist
Does this PR require extra reviews?