Add an integration test with ansible-lint

[oraNod]

Resolves #170 by adding an integration test that checks compatibility with ansible-lint.

[oraNod]

@shatakshiiii Hi, I've been wrangling with the assert in this test a bit more. I think we want to check that stdout for lint does not contain failures such as this one:

Failed: 2 failure(s), 0 warning(s) on 59 files. Last profile that met the validation criteria was 'min'.

Basically it needs to be something like assert ( "Failed: (\d) failure\(s\), (\d) warning\(s\) on (\d) files(.*)" in result.stdout is None) to ensure there are no lint failures.

I'm struggling to see what is in stdout when I run the test with tox. Is there an easy way to debug these tests? I feel like I'm doing a lot of guesswork and taking shots in the dark.

Thanks a mill for the help.

[oraNod]

Also, why does it seem like vscode settings from this repo automatically format things in a way that is inconsistent with what I see in the auto fix commits? 6878fea

That's honestly driving me nuts. Every time I save in vscode formatting gets applied that conflicts with the formatting that gets applied with the pre-commit hooks. I don't think it's my local settings because it doesn't seem to happen with other repos.

[oraNod]

OK, I made a bunch more changes and figured out how to see what's going on with stdout and stderr. I know we'll probably want to remove some of the bits from the test before we merge but I thought I'd leave everything in so people can see what I'm doing.

Looks like this issue is coming from lint:

Standard Error: CRITICAL:root:Unable to create local directories(/home/ansible/.ansible/tmp): [Errno 13] Permission denied: b'/home/ansible'

I've been banging my head against this for the past while. Looking at this:

E       AssertionError: assert 3 == 0
E        +  where 3 = CalledProcessError(3, '/home/dnaro/git/ansible-creator/.tox/py/bin/ansible-lint /tmp/pytest-of-dnaro/pytest-22/popen-gw2/test_lint_collection0/collections/ansible_collections/testorg/testcol').returncod

That looks like I would expect it to. In fact if I try to reproduce this with my user installs of ansible-creator and ansible-lint I can't reproduce the error. I can scaffold a collection under /tmp/pytest-of-dnaro/pytest-22/popen-gw2/test_lint_collection0/collections/ansible_collections/ and then run ansible-lint against that directory and everything is fine.

Why is the cli run function trying to create a directory under /home/ansible?

[NilashishC]

Why is the cli run function trying to create a directory under /home/ansible?

So, the os.environ is set to /home/ansible in conftest (https://github.com/ansible/ansible-creator/blob/main/tests/conftest.py#L22). IIRC, this was done for some basic scaffolding tests.

Playing around a bit with test_lint.py, I think it's ansible-lint that's doing something with the home dir? One solution can be to change the hardcoded /home/ansible/ in conftest to use something like from pathlib import Path; str(Path.home()) and update all the affected fixtures.

[oraNod]

Why is the cli run function trying to create a directory under /home/ansible?

So, the os.environ is set to /home/ansible in conftest (https://github.com/ansible/ansible-creator/blob/main/tests/conftest.py#L22). IIRC, this was done for some basic scaffolding tests.

Playing around a bit with test_lint.py, I think it's ansible-lint that's doing something with the home dir? One solution can be to change the hardcoded /home/ansible/ in conftest to use something like from pathlib import Path; str(Path.home()) and update all the affected fixtures.

Thanks for taking a look @NilashishC I can send a separate PR to adjust things in conftest.py.

[cidrblock]

Can you uses this for the ANSI function? It might get rid of the sonarcloud thing too. https://github.com/ansible/ansible-navigator/blob/88a240be6eeada2f579059210059fc3ecafc3037/src/ansible_navigator/utils/functions.py#L368

[oraNod]

Can you uses this for the ANSI function? It might get rid of the sonarcloud thing too. https://github.com/ansible/ansible-navigator/blob/88a240be6eeada2f579059210059fc3ecafc3037/src/ansible_navigator/utils/functions.py#L368

@cidrblock Thanks, man. That's super helpful. I wasn't feeling great about that ANSI function in my commit. Hopefully I'll be able to take another look at this soon and keep hacking. Cheers.

[oraNod]

I decided to add the noqa comments for ruff S603 after reading astral-sh/ruff#4054 I think the commands are constructed well enough and don't pose a risk from some kind of malicious injection. I kept banging my head against it and the only way to satisfy things might be to sanitize the commands by adding more complexity. That just seems over the top to me though but I'm open to advice from the experts here. Cheers.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud