Merge branch 'main' into macos

Author: ssbarnea

.config/requirements-docs.txt

@@ -1,3 +1,3 @@
-mkdocs-ansible[lock]>=0.2.0
+mkdocs-ansible>=24.2.1
 pipdeptree>=2.4.0
-linkchecker==10.2.1
+linkchecker>=10.4.0

.github/CODEOWNERS

@@ -1 +1 @@
-*       @ansible-community/molecule @ansible-community/devtools
+*       @ansible/devtools

.github/release-drafter.yml

@@ -1,2 +1,2 @@
-# see https://github.com/ansible/devtools
-_extends: ansible/devtools
+# see https://github.com/ansible/team-devtools
+_extends: ansible/team-devtools

.github/workflows/ack.yml

@@ -1,10 +1,15 @@
----
-# See https://github.com/ansible/devtools/blob/main/.github/workflows/ack.yml
+# See https://github.com/ansible/team-devtools/blob/main/.github/workflows/ack.yml
 name: ack
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 on:
   pull_request_target:
     types: [opened, labeled, unlabeled, synchronize]
 
 jobs:
   ack:
-    uses: ansible/devtools/.github/workflows/ack.yml@main
+    uses: ansible/team-devtools/.github/workflows/ack.yml@main
+    secrets: inherit

.github/workflows/push.yml

@@ -1,5 +1,4 @@
----
-# See https://github.com/ansible/devtools/blob/main/.github/workflows/push.yml
+# See https://github.com/ansible/team-devtools/blob/main/.github/workflows/push.yml
 name: push
 on:
   push:
@@ -10,4 +9,4 @@ on:
 
 jobs:
   ack:
-    uses: ansible/devtools/.github/workflows/push.yml@main
+    uses: ansible/team-devtools/.github/workflows/push.yml@main

.github/workflows/release.yml

@@ -1,5 +1,3 @@
----
-# cspell:ignore mislav
 name: release
 
 on:
@@ -8,36 +6,29 @@ on:
 
 jobs:
   pypi:
-    name: Publish to PyPI registry
+    name: release ${{ github.event.ref }}
     environment: release
     runs-on: ubuntu-22.04
+    permissions:
+      id-token: write
 
     env:
       FORCE_COLOR: 1
       PY_COLORS: 1
-      TOXENV: pkg
+      TOX_PARALLEL_NO_SPINNER: 1
 
     steps:
-      - name: Switch to using Python 3.10 by default
+      - name: Switch to using Python 3.12 by default
         uses: actions/setup-python@v5
         with:
-          python-version: 3.10
-
+          python-version: "3.12"
       - name: Install tox
         run: python3 -m pip install --user "tox>=4.0.0"
-
       - name: Check out src from Git
         uses: actions/checkout@v4
         with:
           fetch-depth: 0 # needed by setuptools-scm
-          submodules: true
-
       - name: Build dists
-        run: python -m tox
-
+        run: python -m tox -e pkg
       - name: Publish to pypi.org
-        if: >- # "create" workflows run separately from "push" & "pull_request"
-          github.event_name == 'release'
         uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          password: ${{ secrets.pypi_password }}

.github/workflows/tox.yml

@@ -1,21 +1,16 @@
 ---
 name: tox
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 on:
   push: # only publishes pushes to the main branch to TestPyPI
     branches: # any integration branch but not tag
       - "main"
   pull_request:
-    branches:
-      - "main"
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.sha }}
-  cancel-in-progress: true
-
-env:
-  FORCE_COLOR: 1 # tox, pytest, ansible-lint
-  PY_COLORS: 1
+  workflow_call:
 
 jobs:
   pre:
@@ -54,6 +49,7 @@ jobs:
 
     env:
       PYTEST_REQPASS: 450
+    environment: test
     steps:
       - uses: actions/checkout@v4
         with:
@@ -119,14 +115,20 @@ jobs:
         # produce a single .coverage file at repo root
         run: tox -e coverage
 
+      - name: Archive logs
+        uses: actions/upload-artifact@v4
+        with:
+          name: logs-${{ matrix.name }}.zip
+          path: .tox/**/log/
+
       - name: Upload coverage data
         if: ${{ startsWith(matrix.passed_name, 'py') }}
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
-          name: ${{ matrix.passed_name }}
-          fail_ci_if_error: false # see https://github.com/codecov/codecov-action/issues/598
+          name: ${{ matrix.name }}
           token: ${{ secrets.CODECOV_TOKEN }}
-          verbose: true # optional (default = false)
+          verbose: true
+          fail_ci_if_error: true
 
       - name: Report failure if git reports dirty status
         run: |
@@ -142,10 +144,14 @@ jobs:
 
     needs:
       - build
-
     runs-on: ubuntu-latest
-
     steps:
+      - name: Merge logs into a single archive
+        uses: actions/upload-artifact/merge@v4
+        with:
+          name: logs.zip
+          pattern: logs-*.zip
+          delete-merged: true
       - name: Decide whether the needed jobs succeeded or failed
         uses: re-actors/alls-green@release/v1
         with:

.pre-commit-config.yaml

@@ -23,7 +23,7 @@ repos:
     hooks:
       - id: codespell
   - repo: https://github.com/psf/black
-    rev: 23.12.1
+    rev: 24.2.0
     hooks:
       - id: black
         language_version: python3
@@ -40,14 +40,14 @@ repos:
         language_version: python3
 
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.33.0
+    rev: v1.35.1
     hooks:
       - id: yamllint
         files: \.(yaml|yml)$
         types: [file, yaml]
         entry: yamllint --strict
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: "v0.1.13"
+    rev: "v0.2.2"
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
@@ -94,6 +94,6 @@ repos:
           - pytest-testinfra
           - wcmatch
   - repo: https://github.com/ansible/ansible-lint
-    rev: v6.22.1
+    rev: v24.2.0
     hooks:
       - id: ansible-lint

codecov.yml

@@ -1,9 +1,4 @@
-codecov:
-  require_ci_to_pass: true
 comment: false
 coverage:
   status:
-    patch: false
-    project:
-      default:
-        threshold: 0.5%
+    patch: true # we want github annotations

conftest.py

@@ -1,6 +1,5 @@
 """PyTest Config File."""
 
-
 import os
 
 import pytest

mkdocs.yml

@@ -3,7 +3,7 @@ site_name: Ansible Molecule
 site_url: https://ansible.readthedocs.io/projects/molecule/
 repo_url: https://github.com/ansible/molecule
 edit_uri: blob/main/docs/
-copyright: Copyright © 2023 Red Hat, Inc.
+copyright: Copyright © 2024 Red Hat, Inc.
 docs_dir: docs
 strict: true
 
@@ -32,6 +32,7 @@ theme:
     - search.highlight
     - search.share
     - search.suggest
+    - toc.follow
     - toc.integrate
 extra:
   generator: false
@@ -80,9 +81,10 @@ nav:
 
 plugins:
   - autorefs
-  - search
+  - material/search:
+      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
   - material/social
-
+  - material/tags
   - mkdocstrings:
       enable_inventory: true
       default_handler: python

src/molecule/app.py

@@ -1,4 +1,5 @@
 """Molecule Application Module."""
+
 from ansible_compat.runtime import Runtime
 
 

src/molecule/console.py

@@ -1,4 +1,5 @@
 """Console and terminal utilities."""
+
 import os
 import sys
 from typing import Any
@@ -71,6 +72,12 @@ def should_do_markup() -> bool:
     return sys.stdout.isatty()
 
 
+# Define ANSIBLE_FORCE_COLOR if markup is enabled and another value is not
+# already given. This assures that Ansible subprocesses are still colored,
+# even if they do not run with a real TTY.
+if should_do_markup():
+    os.environ["ANSIBLE_FORCE_COLOR"] = os.environ.get("ANSIBLE_FORCE_COLOR", "1")
+
 console_options: dict[str, Any] = {"emoji": False, "theme": theme, "soft_wrap": True}
 
 console = Console(
@@ -82,9 +89,3 @@ def should_do_markup() -> bool:
 console_options_stderr = console_options.copy()
 console_options_stderr["stderr"] = True
 console_stderr: Console = Console(**console_options_stderr)
-
-# Define ANSIBLE_FORCE_COLOR if markup is enabled and another value is not
-# already given. This assures that Ansible subprocesses are still colored,
-# even if they do not run with a real TTY.
-if should_do_markup():
-    os.environ["ANSIBLE_FORCE_COLOR"] = os.environ.get("ANSIBLE_FORCE_COLOR", "1")

src/molecule/constants.py

@@ -1,6 +1,5 @@
 """Constants used by molecule."""
 
-
 RC_SUCCESS = 0
 RC_TIMEOUT = 3
 RC_SETUP_ERROR = 4  # Broken setup, like missing Ansible

src/molecule/data/init-scenario.yml

@@ -31,3 +31,7 @@
         - templates/scenario/*.j2
       loop_control:
         label: "{{ dest_file | relpath }}"
+      when:
+        - ((driver_name in ['containers', 'docker', 'podman']) and
+          (item | regex_search('create|destroy') is none) or
+          (driver_name not in ['containers', 'docker', 'podman']))

src/molecule/data/templates/scenario/molecule.yml.j2

@@ -1,6 +1,13 @@
 ---
+driver:
+  name: {{ driver_name }}
 platforms:
   - name: instance
+{% if driver_name in ['containers', 'docker', 'podman'] %}
+    image: quay.io/centos/centos:stream8
+    pre_build_image: true
+{% else %}
     # you might want to add your own variables here based on what provisioning
     # you are doing like:
     # image: quay.io/centos/centos:stream8
+{% endif %}

src/molecule/dependency/ansible_galaxy/__init__.py

@@ -1,4 +1,5 @@
 """Base definition for Ansible Galaxy dependencies."""
+
 from molecule import util
 from molecule.dependency.ansible_galaxy.collections import Collections
 from molecule.dependency.ansible_galaxy.roles import Roles

src/molecule/dependency/ansible_galaxy/collections.py

@@ -1,4 +1,5 @@
 """Ansible Galaxy dependencies for lists of collections."""
+
 import logging
 import os
 

src/molecule/dependency/ansible_galaxy/roles.py

@@ -1,4 +1,5 @@
 """Ansible Galaxy dependencies for lists of roles."""
+
 import logging
 import os
 

src/molecule/driver/delegated.py

@@ -137,6 +137,7 @@ class Delegated(Driver):
               ansible_connection: local
     ```
     """
+
     title = "Default driver, user is expected to manage provisioning of test resources."
 
     def __init__(self, config=None) -> None:

src/molecule/provisioner/ansible.py

@@ -904,6 +904,14 @@ def _link_or_update_vars(self):
             if not os.path.exists(source):
                 msg = f"The source path '{source}' does not exist."
                 util.sysexit_with_message(msg)
+            if os.path.exists(target):
+                if os.path.realpath(target) == os.path.realpath(source):
+                    msg = f"Required symlink {target} to {source} exist, skip creation"
+                    LOG.debug(msg)
+                    continue
+                msg = f"Required symlink {target} exist with another source"
+                LOG.debug(msg)
+                os.remove(target)
             msg = f"Inventory {source} linked to {target}"
             LOG.debug(msg)
             os.symlink(source, target)

src/molecule/text.py

@@ -1,4 +1,5 @@
 """Text utils."""
+
 import re
 
 

src/molecule/util.py

@@ -391,5 +391,6 @@ def bool2args(data: bool) -> list[str]:
 
 def print_as_yaml(data: Any) -> None:
     """Render python object as yaml on console."""
-    result = Syntax(safe_dump(data), "yaml")
+    # https://github.com/Textualize/rich/discussions/990#discussioncomment-342217
+    result = Syntax(code=safe_dump(data), lexer="yaml", background_color="default")
     console.print(result)

tox.ini

@@ -87,7 +87,7 @@ passenv = *
 usedevelop = true
 commands =
     linkchecker -f linkcheckerrc docs
-    mkdocs build --strict
+    mkdocs build -c --strict {posargs:}
 extras =
     docs