ci: ansible-lint requires dependencies to be installed [citest_skip]

[richm]

ansible-lint requires the dependencies in meta/collection-requirements.yml
and tests/collection-requirements.yml to be installed. tox-lsr 3.18.1
will ensure they are installed.

Refactor the tests somewhat so that the collection and test steps are separate.

Signed-off-by: Rich Megginson rmeggins@redhat.com

Summary by Sourcery

Update CI workflows to use the latest tox-lsr release and separate collection conversion from ansible linting and testing steps.

CI:

• Bump tox-lsr version to 3.18.1 across linting, testing, managed-var comment, and integration-test GitHub workflows.
• Split ansible-lint and ansible-test workflows into distinct collection-conversion and test execution steps.

[sourcery-ai]

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates CI workflows to use tox-lsr 3.18.1 and refactors ansible-lint and ansible-test jobs so that the collection build step is separated from the lint/test execution, relying on tox-lsr to install collection requirements correctly.

Sequence diagram for updated ansible-lint CI workflow

sequenceDiagram
  actor Developer
  participant GitHubActions
  participant Runner
  participant tox_lsr_3_18_1 as tox_lsr_3_18_1
  participant tox
  participant AnsibleCollection as ansible_collection
  participant AnsibleLint as ansible_lint

  Developer->>GitHubActions: push branch / open PR
  GitHubActions->>Runner: start ansible-lint workflow

  Runner->>Runner: checkout repository

  Runner->>Runner: setup Python matrix version

  Runner->>tox_lsr_3_18_1: pip install tox-lsr 3.18.1
  tox_lsr_3_18_1-->>Runner: provides tox environments

  Note over Runner,AnsibleCollection: Step 1 - build collection separately
  Runner->>tox: tox -e collection
  tox->>AnsibleCollection: convert role to collection layout
  AnsibleCollection-->>tox: built collection with dependencies from collection-requirements
  tox-->>Runner: collection environment ready

  Note over Runner,AnsibleLint: Step 2 - run ansible-lint only
  Runner->>tox: tox -e ansible-lint-collection
  tox->>AnsibleLint: run with LSR_ANSIBLE_LINT_DEP and LSR_ANSIBLE_LINT_ANSIBLE_DEP
  AnsibleLint-->>tox: lint results
  tox-->>Runner: job status
  Runner-->>GitHubActions: report ansible-lint job result
  GitHubActions-->>Developer: CI status on PR

Loading

Flow diagram for refactored ansible-lint job steps

flowchart TD
  A[Start ansible-lint job] --> B[Checkout repository]
  B --> C[Set up Python using matrix version]
  C --> D[Install tox-lsr 3.18.1 with pip]
  D --> E[Run tox -e collection]
  E --> F[Role converted to collection format
and dependencies from collection requirements installed]
  F --> G[Set LSR_ANSIBLE_LINT_DEP and
LSR_ANSIBLE_LINT_ANSIBLE_DEP environment variables]
  G --> H[Run tox -e ansible-lint-collection
with matrix basepython]
  H --> I[ansible-lint runs against built collection]
  I --> J[Report job status]
  J --> K[End ansible-lint job]

Loading

File-Level Changes

Change	Details	Files
Upgrade tox-lsr used in CI workflows to version 3.18.1.	Update pip installation command to reference tox-lsr 3.18.1 instead of 3.18.0 in GitHub Actions workflows that rely on tox-lsr.	.github/workflows/ansible-lint.yml .github/workflows/ansible-test.yml .github/workflows/ansible-managed-var-comment.yml .github/workflows/qemu-kvm-integration-tests.yml
Refactor ansible-lint workflow to run collection build and linting as separate tox invocations.	Split the combined 'convert role to collection format and run ansible-lint' step into two steps: one running 'tox -e collection' and another running ansible-lint. Adjust ansible-lint tox invocation to only run the 'ansible-lint-collection' environment, removing 'collection' from the -e list while preserving environment variable configuration and basepython override.	.github/workflows/ansible-lint.yml
Refactor ansible-test workflow to run collection build and testing as separate tox invocations.	Split the combined 'convert role to collection format and run ansible-test' step into two steps: one running 'tox -e collection' and another running ansible-test. Adjust ansible-test tox invocation to only run the 'ansible-test-${{ matrix.versions.ansible }}' environment, removing 'collection' from the -e list while keeping the basepython override.	.github/workflows/ansible-test.yml

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

• The tox-lsr version string is duplicated across multiple workflows; consider defining it in a single reusable place (e.g., a workflow env var or a shared action) to make future version bumps less error-prone.
• Now that tox -e collection is run in separate steps for ansible-lint and ansible-test, verify whether the collection build artifacts can be reused between jobs (e.g., via actions/cache or artifacts) to avoid rebuilding the collection for each job/matrix entry.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- The tox-lsr version string is duplicated across multiple workflows; consider defining it in a single reusable place (e.g., a workflow env var or a shared action) to make future version bumps less error-prone.
- Now that `tox -e collection` is run in separate steps for ansible-lint and ansible-test, verify whether the collection build artifacts can be reused between jobs (e.g., via `actions/cache` or artifacts) to avoid rebuilding the collection for each job/matrix entry.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}