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.

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

Merged
merged 1 commit into from
May 13, 2024
Merged

update integration testing doc #3073

merged 1 commit into from
May 13, 2024

Conversation

dheyay
Copy link
Contributor

@dheyay dheyay commented Apr 22, 2024

Why is this needed?

This PR updates the integration testing document to current commands for testing the pro client.

Test Steps

Checklist

  • I have updated or added any unit tests accordingly
  • I have updated or added any integration tests accordingly
  • Changes here need to be documented, and this was done in:

Does this PR require extra reviews?

  • Yes
  • No

@github-actions github-actions bot added the docs label Apr 22, 2024
@dheyay
Copy link
Contributor Author

dheyay commented Apr 22, 2024

@orndorffgrant @lucasmoura
This might need to be updated for the following sections:

  • Iterating locally
  • Optimizing total run time of integration tests with snapshots

Please feel free to leave comments for specific changes if these sections have to be updated. Thanks!

Copy link
Contributor

@lucasmoura lucasmoura left a 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

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)
Copy link
Contributor

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

Copy link
Member

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

Copy link
Contributor Author

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

@dheyay dheyay force-pushed the update-testing-doc branch 4 times, most recently from ad88972 to 43cfb03 Compare April 26, 2024 20:59
Copy link
Collaborator

@orndorffgrant orndorffgrant left a 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

dev-docs/howtoguides/testing.md Show resolved Hide resolved
dev-docs/howtoguides/testing.md Show resolved Hide resolved
@dheyay dheyay changed the base branch from docs-devel to docs May 3, 2024 20:25
Copy link
Collaborator

@orndorffgrant orndorffgrant left a 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

@@ -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.
Copy link
Collaborator

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..." :)

Suggested change
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated

@orndorffgrant orndorffgrant merged commit 7e2fd27 into docs May 13, 2024
7 checks passed
@orndorffgrant orndorffgrant deleted the update-testing-doc branch May 13, 2024 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants