Cleanup GitHub workflows (#655)

* Cleanup gha

* test by removing matrix excludes

* Rename sanity tests

* trigger integration tests

* Fix ansible-lint workflow

* Fix concurrency

* Add ansible-lint config

* Add ansible-lint config

* Fix integration and lint issues

* integration wf

* fix yamllint issues

* fix yamllint issues

* update readme and add ignore-2.16.txt

* fix ansible-doc

* Add version

* Use /dev/random to generate random data

The GHA environment has difficultly generating entropy. Trying to read
from /dev/urandom just blocks forever. We don't care if the random data
is cryptographically secure; it's just garbage data for the test. Read
from /dev/random, instead. This is only used during the k8s_copy test
target.

This also removes the custom test module that was being used to generate
the files. It's not worth maintaining this for two task that can be
replaced with some simple command/shell tasks.

* Fix saniry errors

* test github_action fix

* Address review comments

* Remove default types

* review comments

* isort fixes

* remove tags

* Add setuptools to venv

* Test gh changes

* update changelog

* update ignore-2.16

* Fix indentation in inventory plugin example

* Update .github/workflows/integration-tests.yaml

* Update integration-tests.yaml

---------

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

plugins/module_utils/ansiblemodule.py

@@ -14,9 +14,9 @@ except TypeError:
 
 if enable_turbo_mode:
     try:
-        from ansible_collections.cloud.common.plugins.module_utils.turbo.module import (
+        from ansible_collections.cloud.common.plugins.module_utils.turbo.module import (  # noqa: F401
             AnsibleTurboModule as AnsibleModule,
-        )  # noqa: F401
+        )
 
         AnsibleModule.collection_name = "kubernetes.core"
     except ImportError:

plugins/module_utils/apply.py

@@ -17,8 +17,8 @@ from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
 
-from collections import OrderedDict
 import json
+from collections import OrderedDict
 
 from ansible.module_utils.common.dict_transformations import dict_merge
 from ansible_collections.kubernetes.core.plugins.module_utils.exceptions import (
@@ -31,7 +31,6 @@ from ansible_collections.kubernetes.core.plugins.module_utils.version import (
     LooseVersion,
 )
 
-
 try:
     from kubernetes.dynamic.exceptions import NotFoundError
 except ImportError:

plugins/module_utils/client/discovery.py

@@ -13,15 +13,18 @@
 # limitations under the License.
 
 
+import hashlib
 import json
 import os
-from collections import defaultdict
-import hashlib
 import tempfile
+from collections import defaultdict
 from functools import partial
 
 import kubernetes.dynamic
 import kubernetes.dynamic.discovery
+from ansible_collections.kubernetes.core.plugins.module_utils.client.resource import (
+    ResourceList,
+)
 from kubernetes import __version__
 from kubernetes.dynamic.exceptions import (
     ResourceNotFoundError,
@@ -29,10 +32,6 @@ from kubernetes.dynamic.exceptions import (
     ServiceUnavailableError,
 )
 
-from ansible_collections.kubernetes.core.plugins.module_utils.client.resource import (
-    ResourceList,
-)
-
 
 class Discoverer(kubernetes.dynamic.discovery.Discoverer):
     def __init__(self, client, cache_file):

plugins/module_utils/common.py

@@ -20,17 +20,20 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 import base64
-import time
-import os
-import traceback
-import sys
 import hashlib
+import os
+import sys
+import time
+import traceback
 from datetime import datetime
 from tempfile import NamedTemporaryFile
 
-from ansible_collections.kubernetes.core.plugins.module_utils.version import (
-    LooseVersion,
-)
+from ansible.module_utils._text import to_bytes, to_native, to_text
+from ansible.module_utils.basic import missing_required_lib
+from ansible.module_utils.common.dict_transformations import dict_merge
+from ansible.module_utils.parsing.convert_bool import boolean
+from ansible.module_utils.six import iteritems, string_types
+from ansible.module_utils.urls import Request
 from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
     AUTH_ARG_MAP,
     AUTH_ARG_SPEC,
@@ -42,27 +45,23 @@ from ansible_collections.kubernetes.core.plugins.module_utils.hashes import (
 from ansible_collections.kubernetes.core.plugins.module_utils.selector import (
     LabelSelectorFilter,
 )
-
-from ansible.module_utils.basic import missing_required_lib
-from ansible.module_utils.six import iteritems, string_types
-from ansible.module_utils._text import to_native, to_bytes, to_text
-from ansible.module_utils.common.dict_transformations import dict_merge
-from ansible.module_utils.parsing.convert_bool import boolean
-from ansible.module_utils.urls import Request
+from ansible_collections.kubernetes.core.plugins.module_utils.version import (
+    LooseVersion,
+)
 
 K8S_IMP_ERR = None
 try:
     import kubernetes
     from kubernetes.dynamic.exceptions import (
+        BadRequestError,
+        ConflictError,
+        DynamicApiError,
+        ForbiddenError,
+        KubernetesValidateMissing,
+        MethodNotAllowedError,
         NotFoundError,
         ResourceNotFoundError,
         ResourceNotUniqueError,
-        DynamicApiError,
-        ConflictError,
-        ForbiddenError,
-        MethodNotAllowedError,
-        BadRequestError,
-        KubernetesValidateMissing,
     )
 
     HAS_K8S_MODULE_HELPER = True
@@ -819,7 +818,7 @@ class K8sAnsibleMixin(object):
         try:
             self.client = get_api_client(self.module)
         # Hopefully the kubernetes client will provide its own exception class one day
-        except (urllib3.exceptions.RequestError) as e:
+        except urllib3.exceptions.RequestError as e:
             self.fail_json(msg="Couldn't connect to Kubernetes: %s" % str(e))
 
         flattened_definitions = []
@@ -837,7 +836,7 @@ class K8sAnsibleMixin(object):
                 resource = self.find_resource(kind, api_version, fail=True)
                 flattened_definitions.append((resource, definition))
 
-        for (resource, definition) in flattened_definitions:
+        for resource, definition in flattened_definitions:
             kind = definition.get("kind", self.kind)
             api_version = definition.get("apiVersion", self.api_version)
             definition = self.set_defaults(resource, definition)

plugins/module_utils/copy.py

@@ -18,25 +18,26 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 import os
-from tempfile import TemporaryFile, NamedTemporaryFile
-from select import select
-from abc import ABCMeta, abstractmethod
 import tarfile
+from abc import ABCMeta, abstractmethod
+from select import select
+from tempfile import NamedTemporaryFile, TemporaryFile
+
+from ansible.module_utils._text import to_native
 
 # from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule import AnsibleModule
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
     CoreException,
 )
-from ansible.module_utils._text import to_native
 
 try:
     from kubernetes.client.api import core_v1_api
     from kubernetes.stream import stream
     from kubernetes.stream.ws_client import (
-        STDOUT_CHANNEL,
-        STDERR_CHANNEL,
-        ERROR_CHANNEL,
         ABNF,
+        ERROR_CHANNEL,
+        STDERR_CHANNEL,
+        STDOUT_CHANNEL,
     )
 except ImportError:
     pass

plugins/module_utils/hashes.py

@@ -19,8 +19,8 @@ from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
 
-import json
 import hashlib
+import json
 
 try:
     import string
@@ -37,7 +37,7 @@ except ImportError:
 
 def sorted_dict(unsorted_dict):
     result = OrderedDict()
-    for (k, v) in sorted(unsorted_dict.items()):
+    for k, v in sorted(unsorted_dict.items()):
         if isinstance(v, dict):
             v = sorted_dict(v)
         result[k] = v

plugins/module_utils/helm.py

@@ -7,19 +7,18 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 
+import copy
+import json
 import os
+import re
 import tempfile
 import traceback
-import re
-import json
-import copy
 
-from ansible.module_utils.basic import missing_required_lib
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
 from ansible.module_utils.six import string_types
 from ansible_collections.kubernetes.core.plugins.module_utils.version import (
     LooseVersion,
 )
-from ansible.module_utils.basic import AnsibleModule
 
 try:
     import yaml
@@ -84,7 +83,6 @@ class AnsibleHelmModule(object):
     """
 
     def __init__(self, **kwargs):
-
         self._module = None
         if "module" in kwargs:
             self._module = kwargs.get("module")
@@ -184,7 +182,6 @@ class AnsibleHelmModule(object):
         )
 
     def get_helm_version(self):
-
         command = self.get_helm_binary() + " version"
         rc, out, err = self.run_command(command)
         m = re.match(r'version.BuildInfo{Version:"v([0-9\.]*)",', out)
@@ -216,7 +213,6 @@ class AnsibleHelmModule(object):
         return yaml.safe_load(out)
 
     def parse_yaml_content(self, content):
-
         if not HAS_YAML:
             self.fail_json(msg=missing_required_lib("yaml"), exception=HAS_YAML)
 
@@ -228,7 +224,6 @@ class AnsibleHelmModule(object):
             )
 
     def get_manifest(self, release_name):
-
         command = [
             self.get_helm_binary(),
             "get",
@@ -241,7 +236,6 @@ class AnsibleHelmModule(object):
         return self.parse_yaml_content(out)
 
     def get_notes(self, release_name):
-
         command = [
             self.get_helm_binary(),
             "get",

plugins/module_utils/k8s/client.py

@@ -1,12 +1,11 @@
 # Copyright: (c) 2021, Red Hat | Ansible
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
-import os
 import hashlib
+import os
 from typing import Any, Dict, List, Optional
 
 from ansible.module_utils.six import iteritems, string_types
-
 from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
     AUTH_ARG_MAP,
     AUTH_ARG_SPEC,

plugins/module_utils/k8s/core.py

@@ -1,15 +1,12 @@
 import traceback
-
 from typing import Optional
 
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
+from ansible.module_utils.common.text.converters import to_text
 from ansible_collections.kubernetes.core.plugins.module_utils.version import (
     LooseVersion,
 )
 
-from ansible.module_utils.basic import AnsibleModule
-from ansible.module_utils.basic import missing_required_lib
-from ansible.module_utils.common.text.converters import to_text
-
 
 class AnsibleK8SModule:
     """A base module class for K8S modules.

plugins/module_utils/k8s/resource.py

@@ -2,7 +2,7 @@
 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
 
 import os
-from typing import cast, Dict, Iterable, List, Optional, Union
+from typing import Dict, Iterable, List, Optional, Union, cast
 
 from ansible.module_utils.six import string_types
 from ansible.module_utils.urls import Request

plugins/module_utils/k8s/runner.py

@@ -4,12 +4,12 @@
 from typing import Dict
 
 from ansible.module_utils._text import to_native
-
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
     get_api_client,
 )
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
     CoreException,
+    ResourceTimeout,
 )
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.resource import (
     create_definitions,
@@ -19,9 +19,6 @@ from ansible_collections.kubernetes.core.plugins.module_utils.k8s.service import
     diff_objects,
     hide_fields,
 )
-from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
-    ResourceTimeout,
-)
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.waiter import exists
 from ansible_collections.kubernetes.core.plugins.module_utils.selector import (
     LabelSelectorFilter,

plugins/module_utils/k8s/service.py

@@ -4,36 +4,30 @@
 import copy
 from typing import Any, Dict, List, Optional, Tuple
 
+from ansible.module_utils.common.dict_transformations import dict_merge
 from ansible_collections.kubernetes.core.plugins.module_utils.hashes import (
     generate_hash,
 )
-
-from ansible_collections.kubernetes.core.plugins.module_utils.k8s.waiter import (
-    Waiter,
-    exists,
-    resource_absent,
-    get_waiter,
-)
-
-from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
-    requires,
-)
-
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import requires
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
     CoreException,
 )
-
-from ansible.module_utils.common.dict_transformations import dict_merge
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.waiter import (
+    Waiter,
+    exists,
+    get_waiter,
+    resource_absent,
+)
 
 try:
     from kubernetes.dynamic.exceptions import (
-        NotFoundError,
-        ResourceNotFoundError,
-        ResourceNotUniqueError,
+        BadRequestError,
         ConflictError,
         ForbiddenError,
         MethodNotAllowedError,
-        BadRequestError,
+        NotFoundError,
+        ResourceNotFoundError,
+        ResourceNotUniqueError,
     )
 except ImportError:
     # Handled in module setup

plugins/module_utils/k8s/waiter.py

@@ -3,7 +3,6 @@ from functools import partial
 from typing import Any, Callable, Dict, Iterator, List, Optional, Tuple, Union
 
 from ansible.module_utils.parsing.convert_bool import boolean
-
 from ansible_collections.kubernetes.core.plugins.module_utils.k8s.exceptions import (
     CoreException,
 )

plugins/module_utils/k8sdynamicclient.py

@@ -18,12 +18,11 @@ from __future__ import absolute_import, division, print_function
 __metaclass__ = type
 
 
-from kubernetes.dynamic import DynamicClient
-
 from ansible_collections.kubernetes.core.plugins.module_utils.apply import k8s_apply
 from ansible_collections.kubernetes.core.plugins.module_utils.exceptions import (
     ApplyException,
 )
+from kubernetes.dynamic import DynamicClient
 
 
 class K8SDynamicClient(DynamicClient):

plugins/module_utils/selector.py

@@ -16,7 +16,6 @@ import re
 
 
 class Selector(object):
-
     equality_based_operators = ("==", "!=", "=")
 
     def __init__(self, data):