Merge pull request #3 from abikouo/test-release-2.4.1

Test release 2.4.1

.github/workflows/black.yml

@@ -0,0 +1,17 @@
+---
+name: black
+
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.sha }}'
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - main
+      - 'stable-*'
+  pull_request_target:
+
+jobs:
+  format:
+    uses: abikouo/github_actions/.github/workflows/black.yml@automate_changes_a

.github/workflows/ci.yml

@@ -0,0 +1,167 @@
+name: CI
+concurrency:
+  group: ${{ github.head_ref }}
+  cancel-in-progress: true
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - labeled
+      - unlabeled
+      - synchronize
+    branches:
+      - main
+      - stable-*
+    tags:
+      - '*'
+
+jobs:
+  changelog:
+    uses: ansible-network/github_actions/.github/workflows/changelog.yml@main
+  linters:
+    uses: abikouo/github_actions/.github/workflows/tox-linters.yml@tox_linters
+  splitter:
+    env:
+      source_dir: "./source"
+    runs-on: ubuntu-latest
+    outputs:
+      test_targets: ${{ steps.display.outputs.test_targets }}
+    steps:
+      - name: Checkout the collection repository
+        uses: actions/checkout@v3
+        with:
+          path: ${{ env.source_dir }}
+          fetch-depth: "0"
+
+      - name: list changes for pull request
+        id: splitter
+        uses: ansible-network/github_actions/.github/actions/ansible_test_splitter@main
+        with:
+          collections_to_test: ${{ env.source_dir }}
+          total_jobs: 8
+
+      - name: display targets
+        id: display
+        run: echo "test_targets=${{ steps.splitter.outputs.test_targets }}" >> $GITHUB_OUTPUT
+        shell: bash
+
+  integration:
+    needs:
+      - splitter
+    env:
+      source: "./source"
+      cloud_common: "./cloudcommon"
+      ansible_posix: "./ansible_posix"
+      test_targets: ${{ needs.splitter.outputs.test_targets }}
+    runs-on: ubuntu-latest
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        ansible-version:
+          - stable-2.12
+          - milestone
+          - devel
+        python-version:
+          - "3.8"
+          - "3.9"
+        exclude:
+          - ansible-version: stable-2.9
+            python-version: 3.9
+          - ansible-version: stable-2.9
+            python-version: 3.10
+          - ansible-version: stable-2.9
+            python-version: 3.11
+          - ansible-version: stable-2.12
+            python-version: 3.11
+          - ansible-version: stable-2.13
+            python-version: 3.11
+          - ansible-version: stable-2.14
+            python-version: 3.8
+          - ansible-version: stable-2.15
+            python-version: 3.8
+          - ansible-version: milestone
+            python-version: 3.8
+          - ansible-version: devel
+            python-version: 3.8
+        enable-turbo-mode:
+          - true
+          - false
+        job-index: [1, 2, 3, 4, 5, 6, 7, 8]
+    name: "integration-py${{ matrix.python-version }}-${{ matrix.ansible-version }}-turbo-mode=${{ matrix.enable-turbo-mode }}-${{ matrix.job-index }}"
+    steps:
+      - name: Read ansible-test targets
+        id: read-targets
+        run: >-
+          echo "ansible_test_targets=$(echo "${{ env.test_targets }}" | sed s/';'/'\n'/g |
+          grep "kubernetes.core-${{ matrix.job-index }}" | cut -d ':' -f2 | sed s/','/' '/g)" >> $GITHUB_OUTPUT
+        shell: bash
+
+      - name: Display targets
+        run: >-
+          echo "targets to test: $ANSIBLE_TARGETS"
+        shell: bash
+        env:
+          ANSIBLE_TARGETS: ${{ steps.read-targets.outputs.ansible_test_targets }}
+
+      - name: Checkout kubernetes.core repository
+        uses: actions/checkout@v3
+        with:
+          path: ${{ env.source }}
+          fetch-depth: "0"
+        if: steps.read-targets.outputs.ansible_test_targets != ''
+
+      - name: checkout ansible-collections/cloud.common
+        uses: ansible-network/github_actions/.github/actions/checkout_dependency@main
+        with:
+          repository: ansible-collections/cloud.common
+          path: ${{ env.cloud_common }}
+          ref: main
+        if: steps.read-targets.outputs.ansible_test_targets != ''
+
+      - name: checkout ansible-collections/ansible.posix
+        uses: ansible-network/github_actions/.github/actions/checkout_dependency@main
+        with:
+          repository: ansible-collections/ansible.posix
+          path: ${{ env.ansible_posix }}
+          ref: main
+        if: steps.read-targets.outputs.ansible_test_targets != ''
+
+      - name: install kubernetes.core collection
+        id: install-collection
+        uses: abikouo/github_actions/.github/actions/build_install_collection@build_install_collection
+        with:
+          install_python_dependencies: true
+          source_path: ${{ env.source }}
+        if: steps.read-targets.outputs.ansible_test_targets != ''
+
+      - name: install cloud.common collection
+        uses: abikouo/github_actions/.github/actions/build_install_collection@build_install_collection
+        with:
+          install_python_dependencies: true
+          source_path: ${{ env.cloud_common }}
+        if: steps.read-targets.outputs.ansible_test_targets != ''
+
+      - name: install ansible.posix collection
+        uses: abikouo/github_actions/.github/actions/build_install_collection@build_install_collection
+        with:
+          install_python_dependencies: true
+          source_path: ${{ env.ansible_posix }}
+        if: steps.read-targets.outputs.ansible_test_targets != ''
+
+      - name: create kubernetes cluster
+        uses: helm/kind-action@v1.4.0
+        if: steps.read-targets.outputs.ansible_test_targets != ''
+
+      - name: Run integration tests
+        uses: abikouo/github_actions/.github/actions/ansible_test_integration@ansible_test_integration_a
+        with:
+          collection_path: ${{ steps.install-collection.outputs.collection_path }}
+          python_version: ${{ matrix.python-version }}
+          ansible_version: ${{ matrix.ansible-version }}
+          ansible_test_targets: ${{ steps.read-targets.outputs.ansible_test_targets }}
+          ansible_test_environment: |
+            ENABLE_TURBO_MODE=${{ matrix.enable-turbo-mode }}
+        if: steps.read-targets.outputs.ansible_test_targets != ''

changelogs/fragments/20230206-deprecate-k8s-inventory.yml

@@ -0,0 +1,2 @@
+deprecated_features:
+- k8s - the ``k8s`` inventory plugin has been deprecated and will be removed in release 4.0.0 (https://github.com/ansible-collections/kubernetes.core/issues/31).

changelogs/fragments/517-k8s-make-name-optional.yaml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - k8s - add new option delete_all to support deletion of all resources when state is set to absent. (https://github.com/ansible-collections/kubernetes.core/issues/504)

changelogs/fragments/575-helm-add-support-for-reuse_values-and-reset_values.yml

@@ -0,0 +1,3 @@
+---
+minor_changes:
+  - helm - add reuse_values and reset_values support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/394).

changelogs/fragments/579-k8s_scale-fix-issue-with-scaling-statefulsets.yml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - k8s_scale - fix issue when scaling StatefulSets with updateStrategy=OnDelete (https://github.com/ansible-collections/kubernetes.core/issues/579).

changelogs/fragments/583-k8s_scale-clean-handling-of-ResourceTimeout-exception.yaml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - k8s_scale - clean handling of ResourceTimeout exception (https://github.com/ansible-collections/kubernetes.core/issues/583).

changelogs/fragments/586-helm-fix-post-renderer-arg.yml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - helm - fix post_renderer argument breaking the helm deploy_command (https://github.com/ansible-collections/kubernetes.core/pull/586).

changelogs/fragments/588-helm-use-post-renderer-for-helmdiff.yml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - helm - use post_renderer when checking 'changed' status for a helm release (https://github.com/ansible-collections/kubernetes.core/pull/588).

changelogs/fragments/589-helm-uninstall-chart-releases-with-statuses-different-than-deployed.yaml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - helm - fix issue occurring when uninstalling chart with statues others than 'deployed' (https://github.com/ansible-collections/kubernetes.core/issues/319).

changelogs/fragments/612-fix-helm-tests.yaml

@@ -0,0 +1,3 @@
+---
+trivial:
+  - add dependency with `install_helm` for `helm_set_values` and `helm_kubeconfig` integration tests (https://github.com/ansible-collections/kubernetes.core/pull/612).

changelogs/fragments/helm-delete-temporary-file-created-when-using-option-release_values.yaml

@@ -0,0 +1,3 @@
+---
+bugfixes:
+  - helm - delete temporary file created when deploying chart with option release_values set (https://github.com/ansible-collections/kubernetes.core/issues/530).

docs/kubernetes.core.k8s_drain_module.rst

@@ -554,14 +554,15 @@ Examples
       kubernetes.core.k8s_drain:
         state: drain
         name: foo
-        force: yes
+        delete_options:
+          force: yes
 
     - name: Drain node "foo", but abort if there are pods not managed by a ReplicationController, Job, or DaemonSet, and use a grace period of 15 minutes.
       kubernetes.core.k8s_drain:
         state: drain
         name: foo
         delete_options:
-            terminate_grace_period: 900
+          terminate_grace_period: 900
 
     - name: Mark node "foo" as schedulable.
       kubernetes.core.k8s_drain:

meta/runtime.yml

@@ -20,6 +20,12 @@ plugin_routing:
   inventory:
     openshift:
       redirect: community.okd.openshift
+    k8s:
+      deprecation:
+        removal_version: 4.0.0
+        warning_text: >-
+          The k8s inventory plugin has been deprecated and
+          will be removed in release 4.0.0.
   modules:
     k8s_auth:
       redirect: community.okd.k8s_auth

plugins/inventory/k8s.py

@@ -19,6 +19,13 @@
       - Uses the kubectl connection plugin to access the Kubernetes cluster.
       - Uses k8s.(yml|yaml) YAML configuration file to set parameter values.
 
+    deprecated:
+      removed_in: 4.0.0
+      why: |
+        As discussed in U(https://github.com/ansible-collections/kubernetes.core/issues/31), we decided to
+        remove the k8s inventory plugin in release 4.0.0.
+      alternative: "Use M(kubernetes.core.k8s_info) and M(ansible.builtin.add_host) instead."
+
     options:
       plugin:
          description: token that ensures this is a source file for the 'k8s' plugin.
@@ -155,6 +162,12 @@ class InventoryModule(BaseInventoryPlugin, Constructable, Cacheable):
 
     def parse(self, inventory, loader, path, cache=True):
         super(InventoryModule, self).parse(inventory, loader, path)
+
+        self.display.deprecated(
+            "The 'k8s' inventory plugin has been deprecated and will be removed in release 4.0.0",
+            version="4.0.0",
+            collection_name="kubernetes.core",
+        )
         cache_key = self._get_cache_prefix(path)
         config_data = self._read_config_data(path)
         self.setup(config_data, cache, cache_key)

plugins/module_utils/k8s/runner.py

@@ -46,16 +46,51 @@ def _prepend_resource_info(resource, msg):
     return [_prepend_resource_info(resource, msg) for msg in warnings + errors]
 
 
+def get_definitions(svc, params):
+    try:
+        definitions = create_definitions(params)
+    except Exception as e:
+        msg = "Failed to load resource definition: {0}".format(e)
+        raise CoreException(msg) from e
+
+    delete_all = params.get("delete_all")
+    src = params.get("src")
+    resource_definition = params.get("resource_definition")
+    name = params.get("name")
+    state = params.get("state")
+
+    if (
+        delete_all
+        and state == "absent"
+        and name is None
+        and resource_definition is None
+        and src is None
+    ):
+        # Delete all resources in the namespace for the specified resource type
+        if params.get("kind") is None:
+            raise CoreException(
+                "'kind' option is required to specify the resource type."
+            )
+
+        resource = svc.find_resource(
+            params.get("kind"), params.get("api_version"), fail=True
+        )
+        definitions = svc.retrieve_all(
+            resource,
+            params.get("namespace"),
+            params.get("label_selectors"),
+        )
+
+    return definitions
+
+
 def run_module(module) -> None:
     results = []
     changed = False
     client = get_api_client(module)
     svc = K8sService(client, module)
-    try:
-        definitions = create_definitions(module.params)
-    except Exception as e:
-        msg = "Failed to load resource definition: {0}".format(e)
-        raise CoreException(msg) from e
+
+    definitions = get_definitions(svc, module.params)
 
     for definition in definitions:
         result = {"changed": False, "result": {}}

plugins/module_utils/k8s/service.py

@@ -211,6 +211,30 @@ def retrieve(self, resource: Resource, definition: Dict) -> ResourceInstance:
 
         return existing
 
+    def retrieve_all(
+        self, resource: Resource, namespace: str, label_selectors: List[str] = None
+    ) -> List[Dict]:
+        definitions: List[ResourceInstance] = []
+
+        try:
+            params = dict(namespace=namespace)
+            if label_selectors:
+                params["label_selector"] = ",".join(label_selectors)
+            resource_list = self.client.get(resource, **params)
+            for item in resource_list.items:
+                existing = self.client.get(
+                    resource, name=item.metadata.name, namespace=namespace
+                )
+                definitions.append(existing.to_dict())
+        except (NotFoundError, MethodNotAllowedError):
+            pass
+        except Exception as e:
+            reason = e.body if hasattr(e, "body") else e
+            msg = "Failed to retrieve requested object: {0}".format(reason)
+            raise CoreException(msg) from e
+
+        return definitions
+
     def find(
         self,
         kind: str,

plugins/module_utils/k8s/waiter.py

@@ -61,6 +61,13 @@ def daemonset_ready(daemonset: ResourceInstance) -> bool:
 
 
 def statefulset_ready(statefulset: ResourceInstance) -> bool:
+    if statefulset.spec.updateStrategy.type == "OnDelete":
+        return bool(
+            statefulset.status
+            and statefulset.status.observedGeneration
+            == (statefulset.metadata.generation or 0)
+            and statefulset.status.replicas == statefulset.spec.replicas
+        )
     # These may be None
     updated_replicas = statefulset.status.updatedReplicas or 0
     ready_replicas = statefulset.status.readyReplicas or 0