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.

Sign up for GitHub

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

Jump to bottom

Update path to sanity test requirements.txt #63725

Closed
wants to merge 1 commit into from
Closed

Update path to sanity test requirements.txt #63725

wants to merge 1 commit into from

Conversation

prasadkatti
Copy link
Contributor

SUMMARY

The path test/runner/requirements/sanity.txt does not exist.
Opening this PR based on the discussion from IRC #ansible-aws.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

sanity testing guide

ADDITIONAL INFORMATION
<PrasadK_> Prasad Katti I am trying to run sanity tests but it seems my environment is missing some packages. I found a page that says `pip install --user -r test/runner/requirements/sanity.txt` should give me the required packages. But that looks like an old doc. I can't the file sanity.txt at that path. 3:12:00 PM 
<felixfontein> Felix Fontein PrasadK_: if you have docker, it's best to run the tests in a docker container by adding `--docker default` to the `ansible-test sanity` arguments 3:12:11 PM 
that container contains everything that is needed to run the sanity tests 3:13:15 PM 
also, I think the file is now test/sanity/requirements.txt 3:13:17 PM 
<PrasadK_> Prasad Katti thanks, that exactly what I was just trying out. :) 3:13:46 PM 
<felixfontein> Felix Fontein please create a docs PR to fix the path in the docs :) 3:14:06 PM 
<PrasadK_> Prasad Katti ah, okay. I will do that. 3:14:29 PM 
<felixfontein> Felix Fontein thanks a lot!

@prasadkatti
Update path to sanity test requirements.txt
66fce2a 
The path `test/runner/requirements/sanity.txt` does not exist.
Opening this PR based on the discussion from IRC #ansible-aws.

```<PrasadK_> Prasad Katti I am trying to run sanity tests but it seems my environment is missing some packages. I found a page that says `pip install --user -r test/runner/requirements/sanity.txt` should give me the required packages. But that looks like an old doc. I can't the file sanity.txt at that path.
3:12:00 PM <felixfontein> Felix Fontein PrasadK_: if you have docker, it's best to run the tests in a docker container by adding `--docker default` to the `ansible-test sanity` arguments
3:12:11 PM that container contains everything that is needed to run the sanity tests
3:13:15 PM also, I think the file is now test/sanity/requirements.txt
3:13:17 PM <PrasadK_> Prasad Katti thanks, that exactly what I was just trying out. :)
3:13:46 PM <felixfontein> Felix Fontein please create a docs PR to fix the path in the docs :)
3:14:06 PM <PrasadK_> Prasad Katti ah, okay. I will do that.
3:14:29 PM <felixfontein> Felix Fontein thanks a lot!```
@prasadkatti
Copy link
Contributor Author

@felixfontein - created this PR as discussed on IRC

@ansibot
Copy link
Contributor

ansibot commented Oct 20, 2019

cc @acozine @gundalow
click here for bot help

@ansibot ansibot added affects_2.10 This issue/PR affects Ansible v2.10 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. needs_triage Needs a first human triage before being processed. small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Oct 20, 2019
@felixfontein
Copy link
Contributor

How about also mentioning ansible-test sanity --requirements? (That was mentioned by @mattclay later in the discussion IIRC.)

@ansibot ansibot removed the needs_triage Needs a first human triage before being processed. label Oct 20, 2019
@prasadkatti
Copy link
Contributor Author

I mentioned that on IRC. I found out about that command from the output of ansible-test sanity -h. But I didn't see that mentioned anywhere in the docs and I don't exactly know what it does.

mattclay
mattclay reviewed Oct 21, 2019
View reviewed changes
docs/docsite/rst/dev_guide/testing_documentation.rst
@@ -29,7 +29,7 @@ To ensure that your module documentation matches your ``argument_spec``:

.. code-block:: bash

pip install --user -r test/runner/requirements/sanity.txt
pip install --user -r test/sanity/requirements.txt
Copy link
Member

Choose a reason for hiding this comment

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

I recommend directing users to use either the --docker or --venv options. If running in their own venv, using --requirements also works. If requirements are to be installed manually then things get more complicated, as there are multiple requirements files involved, depending on the tests being executed and whether testing is being done on ansible/ansible or an Ansible Collection.

@ansibot ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Oct 29, 2019
@gundalow
Copy link
Contributor

@prasadkatti Thank you for this PR. Would you be able to take a look at Matt's suggestion above?

@gundalow gundalow added the pr_day Has been reviewed during a PR review Day label Nov 14, 2019
@acozine
Copy link
Contributor

acozine commented Nov 14, 2019

Duplicate of #62314?

@prasadkatti prasadkatti closed this Dec 3, 2019
@prasadkatti prasadkatti deleted the patch-6 branch December 3, 2019 22:03
@ansible ansible locked and limited conversation to collaborators Jan 2, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@mattclay mattclay mattclay left review comments

Assignees
No one assigned
Labels
affects_2.10 This issue/PR affects Ansible v2.10 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. pr_day Has been reviewed during a PR review Day small_patch stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@prasadkatti @ansibot @felixfontein @gundalow @acozine @mattclay