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

add Troubleshooting help #140

Merged
merged 1 commit into from
Oct 5, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,26 @@ This shows that the `--lsr-enable` flag is available.
- `shellcheck` test requires `shellcheck` package.
On Fedora, you can install it with `dnf install shellcheck`, then you can test shell scripts with `tox -e shellcheck`.

### Molecule and Ansible Version Support
Several tests use `podman` - so `dnf install podman`

QEMU tests have more requirements - see below `QEMU Testing`

As of August 30, 2021, system roles do not support the latest versions of
molecule 3.x or later, which only support Ansible 3.x or later. While it's
possible that system roles will work with Ansible 3.x and later, there is some
work that needs to be done to ensure that they are supportable and supported.
Therefore, for now, molecule testing is disabled by default, and we will revisit
this issue in the near future.
### Molecule and Ansible Version Support

tox-lsr 2.0 and later use molecule v3, which support Ansible 2.8 and later. If
for some reason you need to support Ansible 2.7 or earlier, use tox-lsr 1.x.

## Troubleshooting

* Remove the `.tox` directory: `rm -rf .tox`
* Remove all versions of `tox-lsr`: `pip uninstall tox-lsr` - repeat until all
versions are removed
* Remove anything left over -
`rm -rf ~/.local/lib/python*/site-packages/tox_lsr*` and
`rm -rf ~/.local/lib/python*/site-packages/tox-lsr*`
Copy link
Contributor

Choose a reason for hiding this comment

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

@richm these two lines are the same

Copy link
Contributor Author

Choose a reason for hiding this comment

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

almost - one has a dash - and one has an underscore _

* Remove any cached files `rm -rf ~/.local/bin/__pycache__/*`
* Reinstall `tox-lsr` - see above

## Example tox.ini

The following is an example of a `tox.ini` from the kernel_settings role:
Expand Down