Add new AnsibleK8SModule class (#269)

* Add new AnsibleK8SModule class

This class is intended to replace part of the K8SAnsibleMixin class and
is part of a larger refactoring effort.

* Fix sanity errors

* Fix unit tests

* Add mock to test requirements

tests/sanity/refresh_ignore_files

@@ -9,28 +9,36 @@ module_dir = target_dir / "plugins" / "modules"
 module_utils_dir = target_dir / "plugins" / "module_utils"
 ignore_dir.mkdir(parents=True, exist_ok=True)
 
-skip_list = [
+skip_list_2_6 = [
     "compile-2.6!skip",  # Py3.8+
+    "import-2.6!skip",  # Py3.8+
+]
+
+skip_list_3 = [
     "compile-2.7!skip",  # Py3.8+
     "compile-3.5!skip",  # Py3.8+
-    "import-2.6!skip",  # Py3.8+
     "import-2.7!skip",  # Py3.8+
     "import-3.5!skip",  # Py3.8+
     "future-import-boilerplate!skip",  # Py2 only
     "metaclass-boilerplate!skip",  # Py2 only
 ]
 
-for version in ["2.9", "2.10", "2.11", "2.12"]:
+for version in ["2.9", "2.10", "2.11", "2.12", "2.13"]:
     ignore_file = ignore_dir / f"ignore-{version}.txt"
     ignore_content = ignore_file.read_text().split("\n")
     ignore_content.append(f"tests/sanity/refresh_ignore_files shebang!skip")
 
-    for f in module_dir.glob("*.py"):
+    if version == "2.13":
+        skip_list = skip_list_3
+    else:
+        skip_list = skip_list_2_6 + skip_list_3
+
+    for f in module_dir.glob("**/*.py"):
         if f.is_symlink():
             continue
         for test in skip_list:
             ignore_content.append(f"{f} {test}")
-    for f in module_utils_dir.glob("*.py"):
+    for f in module_utils_dir.glob("**/*.py"):
         if f.is_symlink():
             continue
         for test in skip_list:

tests/unit/conftest.py

@@ -0,0 +1,44 @@
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+import json
+import sys
+from io import BytesIO
+
+import pytest
+
+import ansible.module_utils.basic
+from ansible.module_utils.six import string_types
+from ansible.module_utils._text import to_bytes
+from ansible.module_utils.common._collections_compat import MutableMapping
+
+
+@pytest.fixture
+def stdin(mocker, request):
+    old_args = ansible.module_utils.basic._ANSIBLE_ARGS
+    ansible.module_utils.basic._ANSIBLE_ARGS = None
+    old_argv = sys.argv
+    sys.argv = ["ansible_unittest"]
+
+    if isinstance(request.param, string_types):
+        args = request.param
+    elif isinstance(request.param, MutableMapping):
+        if "ANSIBLE_MODULE_ARGS" not in request.param:
+            request.param = {"ANSIBLE_MODULE_ARGS": request.param}
+        if "_ansible_remote_tmp" not in request.param["ANSIBLE_MODULE_ARGS"]:
+            request.param["ANSIBLE_MODULE_ARGS"]["_ansible_remote_tmp"] = "/tmp"
+        if "_ansible_keep_remote_files" not in request.param["ANSIBLE_MODULE_ARGS"]:
+            request.param["ANSIBLE_MODULE_ARGS"]["_ansible_keep_remote_files"] = False
+        args = json.dumps(request.param)
+    else:
+        raise Exception("Malformed data to the stdin pytest fixture")
+
+    fake_stdin = BytesIO(to_bytes(args, errors="surrogate_or_strict"))
+    mocker.patch("ansible.module_utils.basic.sys.stdin", mocker.MagicMock())
+    mocker.patch("ansible.module_utils.basic.sys.stdin.buffer", fake_stdin)
+
+    yield fake_stdin
+
+    ansible.module_utils.basic._ANSIBLE_ARGS = old_args
+    sys.argv = old_argv

tests/unit/module_utils/test_core.py

@@ -0,0 +1,91 @@
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+import json
+
+import kubernetes
+import pytest
+
+from ansible_collections.kubernetes.core.plugins.module_utils.k8s.core import (
+    AnsibleK8SModule,
+)
+
+MINIMAL_K8S_VERSION = "12.0.0"
+UNSUPPORTED_K8S_VERSION = "11.0.0"
+
+
+@pytest.mark.parametrize("stdin", [{}], indirect=["stdin"])
+def test_no_warn(monkeypatch, stdin, capfd):
+    monkeypatch.setattr(kubernetes, "__version__", MINIMAL_K8S_VERSION)
+
+    module = AnsibleK8SModule(argument_spec={})
+    with pytest.raises(SystemExit):
+        module.exit_json()
+    out, err = capfd.readouterr()
+
+    return_value = json.loads(out)
+
+    assert return_value.get("exception") is None
+    assert return_value.get("warnings") is None
+    assert return_value.get("failed") is None
+
+
+@pytest.mark.parametrize("stdin", [{}], indirect=["stdin"])
+def test_warn_on_k8s_version(monkeypatch, stdin, capfd):
+    monkeypatch.setattr(kubernetes, "__version__", UNSUPPORTED_K8S_VERSION)
+
+    module = AnsibleK8SModule(argument_spec={})
+    with pytest.raises(SystemExit):
+        module.exit_json()
+    out, err = capfd.readouterr()
+
+    return_value = json.loads(out)
+
+    assert return_value.get("warnings") is not None
+    warnings = return_value["warnings"]
+    assert len(warnings) == 1
+    assert "kubernetes" in warnings[0]
+    assert MINIMAL_K8S_VERSION in warnings[0]
+
+
+dependencies = [
+    ["18.20.0", "12.0.1", False],
+    ["18.20.0", "18.20.0", True],
+    ["12.0.1", "18.20.0", True],
+]
+
+
+@pytest.mark.parametrize(
+    "stdin,desired,actual,result", [({}, *d) for d in dependencies], indirect=["stdin"]
+)
+def test_has_at_least(monkeypatch, stdin, desired, actual, result, capfd):
+    monkeypatch.setattr(kubernetes, "__version__", actual)
+
+    module = AnsibleK8SModule(argument_spec={})
+
+    assert module.has_at_least("kubernetes", desired) is result
+
+
+dependencies = [
+    ["kubernetes", "18.20.0", "(kubernetes>=18.20.0)"],
+    ["foobar", "1.0.0", "(foobar>=1.0.0)"],
+    ["foobar", None, "(foobar)"],
+]
+
+
+@pytest.mark.parametrize(
+    "stdin,dependency,version,msg", [({}, *d) for d in dependencies], indirect=["stdin"]
+)
+def test_requires_fails_with_message(
+    monkeypatch, stdin, dependency, version, msg, capfd
+):
+    monkeypatch.setattr(kubernetes, "__version__", "12.0.0")
+    module = AnsibleK8SModule(argument_spec={})
+    with pytest.raises(SystemExit):
+        module.requires(dependency, version)
+    out, err = capfd.readouterr()
+    return_value = json.loads(out)
+
+    assert return_value.get("failed")
+    assert msg in return_value.get("msg")