kubevirt.core collection cross testing (#731) (#736)

* Initial

* update python version

* update python version

* checkout local version of collection

* add integration job

* indent

* Set workflow as non blocking

(cherry picked from commit c0666a5137)

Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>

.github/workflows/integration-tests-kubevirt.yaml

@@ -0,0 +1,127 @@
+name: Integration tests Kubevirt
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+    branches:
+      - main
+      - stable-*
+
+jobs:
+  splitter:
+    continue-on-error: true
+    env:
+      kubernetes: "./kubernetes"
+      kubevirt: "./kubevirt"
+      py_version: 3.9
+    runs-on: ubuntu-latest
+    outputs:
+      test_targets: ${{ steps.splitter.outputs.kubevirt_targets }}
+    steps:
+      - name: Checkout kubernetes.core repository
+        uses: actions/checkout@v3
+        with:
+          path: ${{ env.kubernetes }}
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Checkout the kubevirt.core collection
+        uses: actions/checkout@v3
+        with:
+          repository: kubevirt/kubevirt.core
+          path: ${{ env.kubevirt }}
+
+      - name: "Set up Python ${{ env.py_version }}"
+        uses: actions/setup-python@v4
+        with:
+          python-version: "${{ env.py_version }}"
+
+      - name: List targets from kubevirt.core collection
+        id: splitter
+        run: python ${{ env.kubernetes }}/tools/kubevirt_list_targets.py ${{ env.kubevirt }}
+        shell: bash
+
+  integration:
+    if: ${{ needs.splitter.outputs.test_targets != '' }}
+    name: "integration-kubevirt-${{ matrix.test-target }}"
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    needs:
+      - splitter
+    env:
+      kubernetes: "./kubernetes"
+      kubevirt: "./kubevirt"
+      ansible_version: milestone
+      python_version: 3.12
+    strategy:
+      fail-fast: false
+      matrix:
+        test-target: ${{ fromJson(needs.splitter.outputs.test_targets) }}
+    steps:
+      - name: Checkout kubernetes.core repository
+        uses: actions/checkout@v4
+        with:
+          path: ${{ env.kubernetes }}
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Checkout kubevirt.core repository
+        uses: actions/checkout@v4
+        with:
+          repository: kubevirt/kubevirt.core
+          path: ${{ env.kubevirt }}
+          ref: main
+
+      # Install ansible
+      - name: Install ansible-core (${{ env.ansible_version }})
+        run: >-
+          python3 -m pip install
+          https://github.com/ansible/ansible/archive/${{ env.ansible_version }}.tar.gz
+          --disable-pip-version-check
+        shell: bash
+
+      - name: Build and install kubevirt.core collection
+        id: install-kubevirt
+        uses: ansible-network/github_actions/.github/actions/build_install_collection@main
+        with:
+          install_python_dependencies: true
+          source_path: ${{ env.kubevirt }}
+
+      - name: Build and install kubernetes.core collection
+        id: install-kubernetes
+        uses: ansible-network/github_actions/.github/actions/build_install_collection@main
+        with:
+          install_python_dependencies: true
+          source_path: ${{ env.kubernetes }}
+
+      - name: Install kind / kubectl
+        uses: helm/kind-action@v1.9.0
+        with:
+          version: v0.22.0
+          install_only: true
+
+      - name: Deploy kubevirt
+        run: >-
+          ${{ env.kubevirt }}/hack/e2e-setup.sh \
+            -v \
+            --configure-inotify-limits \
+            --configure-secondary-network \
+            --deploy-kubevirt \
+            --deploy-kubevirt-cdi \
+            --deploy-kubevirt-common-instancetypes \
+            --deploy-cnao \
+            --create-cluster \
+            --create-nad
+        env:
+          KIND: kind
+          KUBECTL: kubectl
+
+      - name: Run integration tests
+        uses: ansible-network/github_actions/.github/actions/ansible_test_integration@main
+        with:
+          collection_path: ${{ steps.install-kubevirt.outputs.collection_path }}
+          python_version: ${{ env.python_version }}
+          ansible_version: ${{ env.ansible_version }}
+          ansible_test_targets: ${{ matrix.test-target }}
+        env:
+          ANSIBLE_COLLECTIONS_PATHS: /home/runner/collections

CHANGELOG.rst

@@ -4,6 +4,39 @@ Kubernetes Collection Release Notes
 
 .. contents:: Topics
 
+v4.0.0
+======
+
+Release Summary
+---------------
+
+This major release brings several bug fixes. We have also removed support for ``ansible-core<2.15`` and deprecated functions and class from ``module_utils/common.py``.
+
+Minor Changes
+-------------
+
+- inventory/k8s.py - Defer removal of k8s inventory plugin to version 5.0 (https://github.com/ansible-collections/kubernetes.core/pull/723).
+- k8s - The module and K8sService were changed so warnings returned by the K8S API are now displayed to the user.
+
+Removed Features (previously deprecated)
+----------------------------------------
+
+- k8s - Support for ``merge_type=json`` has been removed in version 4.0.0. Please use ``kubernetes.core.k8s_json_patch`` instead (https://github.com/ansible-collections/kubernetes.core/pull/722).
+- k8s_exec - the previously deprecated ``result.return_code`` return value has been removed, consider using ``result.rc`` instead (https://github.com/ansible-collections/kubernetes.core/pull/726).
+- module_utils/common.py - the previously deprecated ``K8sAnsibleMixin`` class has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
+- module_utils/common.py - the previously deprecated ``configuration_digest()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
+- module_utils/common.py - the previously deprecated ``get_api_client()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
+- module_utils/common.py - the previously deprecated ``unique_string()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
+
+Bugfixes
+--------
+
+- Resolve Collections util resource discovery fails when complex subresources present (https://github.com/ansible-collections/kubernetes.core/pull/676).
+- align `helmdiff_check()` function commandline rendering with the `deploy()` function (https://github.com/ansible-collections/kubernetes.core/pull/670).
+- avoid unsafe conditions in integration tests (https://github.com/ansible-collections/kubernetes.core/pull/665).
+- helm - use ``reuse-values`` when running ``helm diff`` command (https://github.com/ansible-collections/kubernetes.core/issues/680).
+- integrations test helm_kubeconfig - set helm version to v3.10.3 to avoid incompatability with new bitnami charts (https://github.com/ansible-collections/kubernetes.core/pull/670).
+
 v3.1.0
 ======
 

Makefile

@@ -1,5 +1,5 @@
 # Also needs to be updated in galaxy.yml
-VERSION = 3.0.0
+VERSION = 4.0.0
 
 TEST_ARGS ?= ""
 PYTHON_VERSION ?= `python -c 'import platform; print(".".join(platform.python_version_tuple()[0:2]))'`

README.md

@@ -93,7 +93,7 @@ You can also include it in a `requirements.yml` file and install it via `ansible
 ---
 collections:
   - name: kubernetes.core
-    version: 3.0.0
+    version: 4.0.0
 ```
 
 ### Installing the Kubernetes Python Library

changelogs/changelog.yaml

@@ -854,3 +854,45 @@ releases:
     - 652-fix-json-patch-action.yml
     - 654-helm-expand-user.yml
     release_date: '2024-05-16'
+  4.0.0:
+    changes:
+      bugfixes:
+      - Resolve Collections util resource discovery fails when complex subresources
+        present (https://github.com/ansible-collections/kubernetes.core/pull/676).
+      - align `helmdiff_check()` function commandline rendering with the `deploy()`
+        function (https://github.com/ansible-collections/kubernetes.core/pull/670).
+      - avoid unsafe conditions in integration tests (https://github.com/ansible-collections/kubernetes.core/pull/665).
+      - helm - use ``reuse-values`` when running ``helm diff`` command (https://github.com/ansible-collections/kubernetes.core/issues/680).
+      - integrations test helm_kubeconfig - set helm version to v3.10.3 to avoid incompatability
+        with new bitnami charts (https://github.com/ansible-collections/kubernetes.core/pull/670).
+      minor_changes:
+      - inventory/k8s.py - Defer removal of k8s inventory plugin to version 5.0 (https://github.com/ansible-collections/kubernetes.core/pull/723).
+      - k8s - The module and K8sService were changed so warnings returned by the K8S
+        API are now displayed to the user.
+      release_summary: This major release brings several bug fixes. We have also removed
+        support for ``ansible-core<2.15`` and deprecated functions and class from
+        ``module_utils/common.py``.
+      removed_features:
+      - k8s - Support for ``merge_type=json`` has been removed in version 4.0.0. Please
+        use ``kubernetes.core.k8s_json_patch`` instead (https://github.com/ansible-collections/kubernetes.core/pull/722).
+      - k8s_exec - the previously deprecated ``result.return_code`` return value has
+        been removed, consider using ``result.rc`` instead (https://github.com/ansible-collections/kubernetes.core/pull/726).
+      - module_utils/common.py - the previously deprecated ``K8sAnsibleMixin`` class
+        has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
+      - module_utils/common.py - the previously deprecated ``configuration_digest()``
+        function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
+      - module_utils/common.py - the previously deprecated ``get_api_client()`` function
+        has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
+      - module_utils/common.py - the previously deprecated ``unique_string()`` function
+        has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
+    fragments:
+    - 20231206-fix-unsafe-condition-in-integration.yml
+    - 20240117-fix-helm-diff-cmd-line-rendering.yml
+    - 20240222-Collections-util-resource-discovery-fails-when-complex-subresources-present.yml
+    - 20240228-fix-helm-diff-with-reuse-values.yml
+    - 20240423-k8s-display-warnings-to-users.yml
+    - 4.0.0.yaml
+    - inventory-update_removal_date.yml
+    - k8s-merge_type-removed.yml
+    - module_utils-common-remove-deprecated-functions-and-class.yaml
+    release_date: '2024-05-24'

changelogs/fragments/20231206-fix-unsafe-condition-in-integration.yml

@@ -1,3 +0,0 @@
----
-bugfixes:
-  - avoid unsafe conditions in integration tests (https://github.com/ansible-collections/kubernetes.core/pull/665).

changelogs/fragments/20240117-fix-helm-diff-cmd-line-rendering.yml

@@ -1,4 +0,0 @@
----
-bugfixes:
-  - align `helmdiff_check()` function commandline rendering with the `deploy()` function (https://github.com/ansible-collections/kubernetes.core/pull/670).
-  - integrations test helm_kubeconfig - set helm version to v3.10.3 to avoid incompatability with new bitnami charts (https://github.com/ansible-collections/kubernetes.core/pull/670).

changelogs/fragments/20240222-Collections-util-resource-discovery-fails-when-complex-subresources-present.yml

@@ -1,3 +0,0 @@
----
-bugfixes:
-  - Resolve Collections util resource discovery fails when complex subresources present (https://github.com/ansible-collections/kubernetes.core/pull/676).

changelogs/fragments/20240228-fix-helm-diff-with-reuse-values.yml

@@ -1,3 +0,0 @@
----
-bugfixes:
-  - helm - use ``reuse-values`` when running ``helm diff`` command (https://github.com/ansible-collections/kubernetes.core/issues/680).

changelogs/fragments/20240423-k8s-display-warnings-to-users.yml

@@ -1,3 +0,0 @@
----
-minor_changes:
-  - k8s - The module and K8sService were changed so warnings returned by the K8S API are now displayed to the user.

changelogs/fragments/inventory-update_removal_date.yml

@@ -1,2 +0,0 @@
-minor_changes:
-  - inventory/k8s.py - Defer removal of k8s inventory plugin to version 5.0 (https://github.com/ansible-collections/kubernetes.core/pull/723).

changelogs/fragments/k8s-merge_type-removed.yml

@@ -1,2 +0,0 @@
-removed_features:
-  - k8s - Support for ``merge_type=json`` has been removed in version 4.0.0. Please use ``kubernetes.core.k8s_json_patch`` instead (https://github.com/ansible-collections/kubernetes.core/pull/722).

changelogs/fragments/module_utils-common-remove-deprecated-functions-and-class.yaml

@@ -1,6 +0,0 @@
-removed_features:
-  - k8s_exec - the previously deprecated ``result.return_code`` return value has been removed, consider using ``result.rc`` instead (https://github.com/ansible-collections/kubernetes.core/pull/726).
-  - module_utils/common.py - the previously deprecated ``K8sAnsibleMixin`` class has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
-  - module_utils/common.py - the previously deprecated ``configuration_digest()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
-  - module_utils/common.py - the previously deprecated ``get_api_client()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).
-  - module_utils/common.py - the previously deprecated ``unique_string()`` function has been removed (https://github.com/ansible-collections/kubernetes.core/pull/726).

docs/kubernetes.core.k8s_inventory.rst

@@ -17,7 +17,7 @@ DEPRECATED
 ----------
 :Removed in collection release after 
 :Why: As discussed in https://github.com/ansible-collections/kubernetes.core/issues/31, we decided to
-remove the k8s inventory plugin in release 4.0.0.
+remove the k8s inventory plugin in release 5.0.0.
 
 :Alternative: Use :ref:`kubernetes.core.k8s_info <kubernetes.core.k8s_info_module>` and :ref:`ansible.builtin.add_host <ansible.builtin.add_host_module>` instead.
 
@@ -357,7 +357,7 @@ Status
 ------
 
 
-- This inventory will be removed in version 4.0.0. *[deprecated]*
+- This inventory will be removed in version 5.0.0. *[deprecated]*
 - For more information see `DEPRECATED`_.
 
 

docs/kubernetes.core.k8s_module.rst

@@ -121,7 +121,7 @@ Parameters
                 <td>
                         <div><code>apply</code> compares the desired resource definition with the previously supplied resource definition, ignoring properties that are automatically generated</div>
                         <div><code>apply</code> works better with Services than &#x27;force=yes&#x27;</div>
-                        <div>mutually exclusive with <code>merge_type</code></div>
+                        <div>Mutually exclusive with <code>merge_type</code>.</div>
                 </td>
             </tr>
             <tr>
@@ -513,18 +513,17 @@ Parameters
                 </td>
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
-                                    <li>json</li>
                                     <li>merge</li>
                                     <li>strategic-merge</li>
                         </ul>
                 </td>
                 <td>
                         <div>Whether to override the default patch merge approach with a specific type. By default, the strategic merge will typically be used.</div>
-                        <div>For example, Custom Resource Definitions typically aren&#x27;t updatable by the usual strategic merge. You may want to use <code>merge</code> if you see &quot;strategic merge patch format is not supported&quot;</div>
+                        <div>For example, Custom Resource Definitions typically aren&#x27;t updatable by the usual strategic merge. You may want to use <code>merge</code> if you see &quot;strategic merge patch format is not supported&quot;.</div>
                         <div>See <a href='https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment'>https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment</a></div>
                         <div>If more than one <code>merge_type</code> is given, the merge_types will be tried in order. This defaults to <code>[&#x27;strategic-merge&#x27;, &#x27;merge&#x27;]</code>, which is ideal for using the same parameters on resource kinds that combine Custom Resources and built-in resources.</div>
-                        <div>mutually exclusive with <code>apply</code></div>
-                        <div><em>merge_type=json</em> is deprecated and will be removed in version 4.0.0. Please use <span class='module'>kubernetes.core.k8s_json_patch</span> instead.</div>
+                        <div>Mutually exclusive with <code>apply</code>.</div>
+                        <div><em>merge_type=json</em> has been removed in version 4.0.0. Please use <span class='module'>kubernetes.core.k8s_json_patch</span> instead.</div>
                 </td>
             </tr>
             <tr>

galaxy.yml

@@ -25,7 +25,7 @@ tags:
   - openshift
   - okd
   - cluster
-version: 3.1.0
+version: 4.0.0
 build_ignore:
   - .DS_Store
   - "*.tar.gz"

tools/kubevirt_list_targets.py

@@ -0,0 +1,22 @@
+import os
+import sys
+from pathlib import PosixPath
+
+
+def main():
+
+    src = sys.argv[1]
+    path = PosixPath(src) / PosixPath("tests/integration/targets/")
+
+    def _is_disable(path):
+        flags = ("unsupported", "disabled", "unstable", "hidden")
+        aliases_path = path / PosixPath("aliases")
+        return (aliases_path.exists() and any((d.startswith(flags) for d in aliases_path.read_text().split("\n"))))
+
+    targets = [i.stem for i in path.glob("*") if i.is_dir() and not _is_disable(i)]
+    with open(os.environ.get("GITHUB_OUTPUT"), "a", encoding="utf-8") as fw:
+        fw.write(f"kubevirt_targets={targets}\n")
+
+
+if __name__ == "__main__":
+    main()