Add documentaiton on how to test

[PabloHiro]

No description provided.

[coderabbitai]

Warning

Rate limit exceeded

@PabloHiro has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 23 minutes and 28 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[webknjaz]

This should be wired into the Sphinx docs, similar to contributing so it'll need a little infra change. But additionally, the content will need to be rewritten. Look into making it similar to https://github.com/ansible/pylibssh/blob/devel/docs/contributing/testing_guide.rst. I'll give more comprehensive advice tomorrow.

[PabloHiro]

Moved it to the Sphinx docs, but I have not updated the contents. I am not familiar with sphinx syntax and I don't want to retest what works for a testing environment. I think it is better to have a simple working guide to non at all.

[webknjaz]

sphinx syntax

Sphinx can use either RST or MD. For MD, you'll need to follow MyST syntax. Since I've originally integrated both parsers, your change has been picked up and renders w/o errors: https://awx-plugins-core--153.org.readthedocs.build/en/153/contributing/testing/.

I'll take a look to see what we need to improve syntax-wise and also in terms of the content.

[webknjaz]

It's rather unclear what "full" implies here. This runs the default toxenv under whatever python resolves to at the moment. It's probably more accurate to say pytest. I also like adding -qq to standard invocations lately — this hides output from tox and what's left is the pytest output (or other configured commands).

[PabloHiro]

Done