test: Add README.md in tmt folder for integration test local running #1357
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
The pull request adds a README file to the tmt folder, providing instructions on how to run integration tests locally. The instructions are clear and concise, which is helpful for developers. However, there are a few minor suggestions to improve clarity and completeness.
Summary of Findings
- Clarity on
tmt: Adding a brief explanation of whattmtis would be helpful for those unfamiliar with the tool. - Link to
integration.fmf: Linking to the file on the main branch instead of a specific commit hash would make the link more robust. - Missing dependency: Mentioning the need for podman or docker would ensure users have the necessary tools installed.
Merge Readiness
The pull request is a valuable addition to the repository, providing clear instructions for running integration tests locally. Addressing the suggestions above would further enhance the README's clarity and completeness. I am unable to approve this pull request, and recommend that others review and approve this code before merging. I would recommend addressing the medium severity issues before merging.
|
|
||
| To run integration tests locally, you need to [install tmt](https://tmt.readthedocs.io/en/stable/guide.html#the-first-steps) first. Then, use `tmt run -vvvvv plans -n integration` command to run the all integration tests. | ||
|
|
||
| To run integration tests on different distros, just change `image: fedora-rawhide` in https://github.com/bootc-dev/bootc/blob/9d15eedea0d54a4dbc15d267dbdb055817336254/tmt/plans/integration.fmf#L6. |
There was a problem hiding this comment.
The link to the integration.fmf file is a direct link to the GitHub blob. It would be better to link to the file on the bootc-dev/bootc repository's main branch, so that the link remains valid even if the commit hash changes. Also, consider adding a brief explanation of what this file is and why it needs to be changed.
tmt/README.md
Outdated
|
|
||
| In the bootc CI, integration tests are executed via Packit on the Testing Farm. In addition, the integration tests can also be run locally on a developer's machine, which is especially valuable for debugging purposes. | ||
|
|
||
| To run integration tests locally, you need to [install tmt](https://tmt.readthedocs.io/en/stable/guide.html#the-first-steps) first. Then, use `tmt run -vvvvv plans -n integration` command to run the all integration tests. |
There was a problem hiding this comment.
Consider adding a note that the user needs to have podman or docker installed to run the integration tests locally, as tmt uses these tools to manage containers.
There was a problem hiding this comment.
or rather, the tests need tmt+provision-virtual, correct? Could be good to mention that.
Signed-off-by: Xiaofeng Wang <[email protected]>
4 participants
This PR adds a README file to explain how to run the integration tests on a local machine.