Issue #1: Initial effort to lift some content out of the Kubernetes collection. (#3)

* Issue #1: Initial effort to lift some content out of the Kubernetes collection.

* Issue #1: Disable integration tests for now, as they're not relevant.

tests/integration/targets/okd/README.md

@@ -0,0 +1,19 @@
+Wait tests
+----------
+
+wait tests require at least one node, and don't work on the normal k8s
+openshift-origin container as provided by ansible-test --docker -v k8s
+
+minikube, Kubernetes from Docker or any other Kubernetes service will
+suffice.
+
+If kubectl is already using the right config file and context, you can
+just do
+
+```
+cd tests/integration/targets/okd
+./runme.sh -vv
+```
+
+otherwise set one or both of `K8S_AUTH_KUBECONFIG` and `K8S_AUTH_CONTEXT`
+and use the same command

tests/integration/targets/okd/defaults/main.yml

@@ -0,0 +1,2 @@
+---
+k8s_openshift: true

tests/integration/targets/okd/files/crd-resource.yml

@@ -0,0 +1,21 @@
+---
+apiVersion: certmanager.k8s.io/v1alpha1
+kind: Certificate
+metadata:
+  name: acme-crt
+spec:
+  secretName: acme-crt-secret
+  dnsNames:
+    - foo.example.com
+    - bar.example.com
+  acme:
+    config:
+      - ingressClass: nginx
+        domains:
+          - foo.example.com
+          - bar.example.com
+  issuerRef:
+    name: letsencrypt-prod
+    # We can reference ClusterIssuers by changing the kind here.
+    # The default value is Issuer (i.e. a locally namespaced Issuer)
+    kind: Issuer

tests/integration/targets/okd/files/kuard-extra-property.yml

@@ -0,0 +1,22 @@
+---
+apiVersion: extensions/v1beta1
+kind: Deployment
+metadata:
+  labels:
+    app: kuard
+  name: kuard
+  namespace: default
+spec:
+  replicas: 3
+  selector:
+    matchLabels:
+      app: kuard
+    unwanted: value
+  template:
+    metadata:
+      labels:
+        app: kuard
+    spec:
+      containers:
+        - image: gcr.io/kuar-demo/kuard-amd64:1
+          name: kuard

tests/integration/targets/okd/files/kuard-invalid-type.yml

@@ -0,0 +1,21 @@
+---
+apiVersion: extensions/v1beta1
+kind: Deployment
+metadata:
+  labels:
+    app: kuard
+  name: kuard
+  namespace: default
+spec:
+  replicas: hello
+  selector:
+    matchLabels:
+      app: kuard
+  template:
+    metadata:
+      labels:
+        app: kuard
+    spec:
+      containers:
+        - image: gcr.io/kuar-demo/kuard-amd64:1
+          name: kuard

tests/integration/targets/okd/files/setup-crd.yml

@@ -0,0 +1,15 @@
+---
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  name: certificates.certmanager.k8s.io
+spec:
+  group: certmanager.k8s.io
+  version: v1alpha1
+  scope: Namespaced
+  names:
+    kind: Certificate
+    plural: certificates
+    shortNames:
+      - cert
+      - certs

tests/integration/targets/okd/handlers/main.yml

@@ -0,0 +1,6 @@
+---
+- name: delete temporary directory
+  file:
+    path: "{{ remote_tmp_dir }}"
+    state: absent
+  no_log: yes

tests/integration/targets/okd/library/README.md

@@ -0,0 +1,3 @@
+# README
+
+The `test_tempfile.py` module added here is only used for the `setup_remote_tmp_dir.yml` temporary directory setup task. It is a clone of the `tempfile.py` community-supported Ansible module, and has to be included with the tests here because it is not available in the `ansible-base` distribution against which this collection is tested.

tests/integration/targets/okd/library/test_tempfile.py

@@ -0,0 +1,121 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2016, Krzysztof Magosa <krzysztof@magosa.pl>
+# Copyright: (c) 2017, Ansible Project
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+__metaclass__ = type
+
+
+DOCUMENTATION = '''
+---
+module: test_tempfile
+
+short_description: Creates temporary files and directories
+
+description:
+  - The C(test_tempfile) module creates temporary files and directories. C(mktemp) command takes different parameters on various systems, this module helps
+    to avoid troubles related to that. Files/directories created by module are accessible only by creator. In case you need to make them world-accessible
+    you need to use M(ansible.builtin.file) module.
+  - For Windows targets, use the M(ansible.builtin.win_tempfile) module instead.
+
+options:
+  state:
+    description:
+      - Whether to create file or directory.
+    type: str
+    choices: [ directory, file ]
+    default: file
+  path:
+    description:
+      - Location where temporary file or directory should be created.
+      - If path is not specified, the default system temporary directory will be used.
+    type: path
+  prefix:
+    description:
+      - Prefix of file/directory name created by module.
+    type: str
+    default: ansible.
+  suffix:
+    description:
+      - Suffix of file/directory name created by module.
+    type: str
+    default: ""
+
+seealso:
+- module: file
+- module: win_tempfile
+
+author:
+  - Krzysztof Magosa (@krzysztof-magosa)
+'''
+
+EXAMPLES = """
+- name: create temporary build directory
+  test_tempfile:
+    state: directory
+    suffix: build
+
+- name: create temporary file
+  test_tempfile:
+    state: file
+    suffix: temp
+  register: tempfile_1
+
+- name: use the registered var and the file module to remove the temporary file
+  file:
+    path: "{{ tempfile_1.path }}"
+    state: absent
+  when: tempfile_1.path is defined
+"""
+
+RETURN = '''
+path:
+  description: Path to created file or directory
+  returned: success
+  type: str
+  sample: "/tmp/ansible.bMlvdk"
+'''
+
+from os import close
+from tempfile import mkstemp, mkdtemp
+from traceback import format_exc
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils._text import to_native
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=dict(
+            state=dict(type='str', default='file', choices=['file', 'directory']),
+            path=dict(type='path'),
+            prefix=dict(type='str', default='ansible.'),
+            suffix=dict(type='str', default=''),
+        ),
+    )
+
+    try:
+        if module.params['state'] == 'file':
+            handle, path = mkstemp(
+                prefix=module.params['prefix'],
+                suffix=module.params['suffix'],
+                dir=module.params['path'],
+            )
+            close(handle)
+        elif module.params['state'] == 'directory':
+            path = mkdtemp(
+                prefix=module.params['prefix'],
+                suffix=module.params['suffix'],
+                dir=module.params['path'],
+            )
+
+        module.exit_json(changed=True, path=path)
+    except Exception as e:
+        module.fail_json(msg=to_native(e), exception=format_exc())
+
+
+if __name__ == '__main__':
+    main()

tests/integration/targets/okd/meta/main.yml

@@ -0,0 +1,2 @@
+---
+dependencies: []

tests/integration/targets/okd/tasks/main.yml

@@ -0,0 +1,50 @@
+---
+- include_tasks: setup_remote_tmp_dir.yml
+
+- set_fact:
+    virtualenv: "{{ remote_tmp_dir }}/virtualenv"
+    virtualenv_command: "{{ ansible_python_interpreter }} -m virtualenv"
+
+- set_fact:
+    virtualenv_interpreter: "{{ virtualenv }}/bin/python"
+
+- pip:
+    name: virtualenv
+
+# Test graceful failure for older versions of openshift
+
+- pip:
+    name:
+      - openshift==0.6.0
+      - kubernetes==6.0.0
+      - coverage
+    virtualenv: "{{ virtualenv }}"
+    virtualenv_command: "{{ virtualenv_command }}"
+    virtualenv_site_packages: no
+
+- include_tasks: older_openshift_fail.yml
+  vars:
+    ansible_python_interpreter: "{{ virtualenv_interpreter }}"
+    playbook_namespace: ansible-test-k8s-older-openshift
+
+- file:
+    path: "{{ virtualenv }}"
+    state: absent
+  no_log: yes
+
+# Test openshift
+
+- debug:
+    var: k8s_openshift
+
+- pip:
+    name:
+      - kubernetes-validate==1.12.0
+      - openshift>=0.9.2
+      - coverage
+    virtualenv: "{{ virtualenv }}"
+    virtualenv_command: "{{ virtualenv_command }}"
+    virtualenv_site_packages: no
+
+- include: openshift.yml
+  when: k8s_openshift | bool

tests/integration/targets/okd/tasks/older_openshift_fail.yml

@@ -0,0 +1,71 @@
+---
+# TODO: Not available in ansible-base
+# - python_requirements_info:
+#     dependencies:
+#       - openshift==0.6.0
+#       - kubernetes==6.0.0
+
+# append_hash
+- name: use append_hash with ConfigMap
+  community.kubernetes.k8s:
+    definition:
+      metadata:
+        name: config-map-test
+        namespace: "{{ playbook_namespace }}"
+      apiVersion: v1
+      kind: ConfigMap
+      data:
+        hello: world
+    append_hash: yes
+  ignore_errors: yes
+  register: k8s_append_hash
+
+- name: assert that append_hash fails gracefully
+  assert:
+    that:
+      - k8s_append_hash is failed
+      - "'Failed to import the required Python library (openshift >= 0.7.2)' in k8s_append_hash.msg"
+      - "'. This is required for append_hash.' in k8s_append_hash.msg"
+
+# validate
+- name: attempt to use validate with older openshift
+  community.kubernetes.k8s:
+    definition:
+      metadata:
+        name: config-map-test
+        namespace: "{{ playbook_namespace }}"
+      apiVersion: v1
+      kind: ConfigMap
+      data:
+        hello: world
+    validate:
+      fail_on_error: yes
+  ignore_errors: yes
+  register: k8s_validate
+
+- name: assert that validate fails gracefully
+  assert:
+    that:
+      - k8s_validate is failed
+      - "k8s_validate.msg == 'openshift >= 0.8.0 is required for validate'"
+
+# apply
+- name: attempt to use apply with older openshift
+  community.kubernetes.k8s:
+    definition:
+      metadata:
+        name: config-map-test
+        namespace: "{{ playbook_namespace }}"
+      apiVersion: v1
+      kind: ConfigMap
+      data:
+        hello: world
+    apply: yes
+  ignore_errors: yes
+  register: k8s_apply
+
+- name: assert that apply fails gracefully
+  assert:
+    that:
+      - k8s_apply is failed
+      - "k8s_apply.msg.startswith('Failed to import the required Python library (openshift >= 0.9.2)')"

tests/integration/targets/okd/tasks/openshift.yml

@@ -0,0 +1,62 @@
+---
+# OpenShift Resources
+- name: Create a project
+  community.kubernetes.k8s:
+    name: testing
+    kind: Project
+    api_version: v1
+    apply: no
+  register: output
+
+- name: show output
+  debug:
+    var: output
+
+- name: Create deployment config
+  community.kubernetes.k8s:
+    state: present
+    inline: &dc
+      apiVersion: v1
+      kind: DeploymentConfig
+      metadata:
+        name: elastic
+        labels:
+          app: galaxy
+          service: elastic
+        namespace: testing
+      spec:
+        template:
+          metadata:
+            labels:
+              app: galaxy
+              service: elastic
+          spec:
+            containers:
+              - name: elastic
+                volumeMounts:
+                  - mountPath: /usr/share/elasticsearch/data
+                    name: elastic-volume
+                command: ['elasticsearch']
+                image: 'ansible/galaxy-elasticsearch:2.4.6'
+            volumes:
+              - name: elastic-volume
+                persistentVolumeClaim:
+                  claimName: elastic-volume
+        replicas: 1
+        strategy:
+          type: Rolling
+  register: output
+
+- name: Show output
+  debug:
+    var: output
+
+- name: Create deployment config again
+  community.kubernetes.k8s:
+    state: present
+    inline: *dc
+  register: output
+
+- name: DC creation should be idempotent
+  assert:
+    that: not output.changed

tests/integration/targets/okd/tasks/setup_remote_tmp_dir.yml

@@ -0,0 +1,12 @@
+---
+- name: create temporary directory
+  test_tempfile:
+    state: directory
+    suffix: .test
+  register: remote_tmp_dir
+  notify:
+    - delete temporary directory
+
+- name: record temporary directory
+  set_fact:
+    remote_tmp_dir: "{{ remote_tmp_dir.path }}"

tests/integration/targets/okd/tasks/validate_installed.yml

@@ -0,0 +1,126 @@
+---
+- block:
+    - name: Create a namespace
+      community.kubernetes.k8s:
+        name: "{{ playbook_namespace }}"
+        kind: Namespace
+
+    - copy:
+        src: files
+        dest: "{{ remote_tmp_dir }}"
+
+    - name: incredibly simple ConfigMap
+      community.kubernetes.k8s:
+        definition:
+          apiVersion: v1
+          kind: ConfigMap
+          metadata:
+            name: hello
+            namespace: "{{ playbook_namespace }}"
+        validate:
+          fail_on_error: yes
+      register: k8s_with_validate
+
+    - name: assert that k8s_with_validate succeeds
+      assert:
+        that:
+          - k8s_with_validate is successful
+
+    - name: extra property does not fail without strict
+      community.kubernetes.k8s:
+        src: "{{ remote_tmp_dir }}/files/kuard-extra-property.yml"
+        namespace: "{{ playbook_namespace }}"
+        validate:
+          fail_on_error: yes
+          strict: no
+
+    - name: extra property fails with strict
+      community.kubernetes.k8s:
+        src: "{{ remote_tmp_dir }}/files/kuard-extra-property.yml"
+        namespace: "{{ playbook_namespace }}"
+        validate:
+          fail_on_error: yes
+          strict: yes
+      ignore_errors: yes
+      register: extra_property
+
+    - name: check that extra property fails with strict
+      assert:
+        that:
+          - extra_property is failed
+
+    - name: invalid type fails at validation stage
+      community.kubernetes.k8s:
+        src: "{{ remote_tmp_dir }}/files/kuard-invalid-type.yml"
+        namespace: "{{ playbook_namespace }}"
+        validate:
+          fail_on_error: yes
+          strict: no
+      ignore_errors: yes
+      register: invalid_type
+
+    - name: check that invalid type fails
+      assert:
+        that:
+          - invalid_type is failed
+
+    - name: invalid type fails with warnings when fail_on_error is False
+      community.kubernetes.k8s:
+        src: "{{ remote_tmp_dir }}/files/kuard-invalid-type.yml"
+        namespace: "{{ playbook_namespace }}"
+        validate:
+          fail_on_error: no
+          strict: no
+      ignore_errors: yes
+      register: invalid_type_no_fail
+
+    - name: check that invalid type fails
+      assert:
+        that:
+          - invalid_type_no_fail is failed
+
+    - name: setup custom resource definition
+      community.kubernetes.k8s:
+        src: "{{ remote_tmp_dir }}/files/setup-crd.yml"
+
+    - name: wait a few seconds
+      pause:
+        seconds: 5
+
+    - name: add custom resource definition
+      community.kubernetes.k8s:
+        src: "{{ remote_tmp_dir }}/files/crd-resource.yml"
+        namespace: "{{ playbook_namespace }}"
+        validate:
+          fail_on_error: yes
+          strict: yes
+      register: unknown_kind
+
+    - name: check that unknown kind warns
+      assert:
+        that:
+          - unknown_kind is successful
+          - "'warnings' in unknown_kind"
+
+  always:
+    - name: remove custom resource
+      community.kubernetes.k8s:
+        definition: "{{ lookup('file', role_path + '/files/crd-resource.yml') }}"
+        namespace: "{{ playbook_namespace }}"
+        state: absent
+      ignore_errors: yes
+
+    - name: remove custom resource definitions
+      community.kubernetes.k8s:
+        definition: "{{ lookup('file', role_path + '/files/setup-crd.yml') }}"
+        state: absent
+
+    - name: Delete namespace
+      community.kubernetes.k8s:
+        state: absent
+        definition:
+          - kind: Namespace
+            apiVersion: v1
+            metadata:
+              name: "{{ playbook_namespace }}"
+      ignore_errors: yes

tests/integration/targets/okd/tasks/validate_not_installed.yml

@@ -0,0 +1,25 @@
+---
+# TODO: Not available in ansible-base
+# - python_requirements_info:
+#     dependencies:
+#       - openshift
+#       - kubernetes
+#       - kubernetes-validate
+
+- community.kubernetes.k8s:
+    definition:
+      apiVersion: v1
+      kind: ConfigMap
+      metadata:
+        name: hello
+        namespace: default
+    validate:
+      fail_on_error: yes
+  ignore_errors: yes
+  register: k8s_no_validate
+
+- name: assert that k8s_no_validate fails gracefully
+  assert:
+    that:
+      - k8s_no_validate is failed
+      - "k8s_no_validate.msg == 'kubernetes-validate python library is required to validate resources'"