Refactor of kolla_container_facts

Refactor that prepares kolla_container_facts
module for introducing more actions that will be moved
from kolla_container module and kolla_container_volume_facts.

This change is based on a discussion about adding a new action
to kolla_container module that retrieves all names of the running
containers. It was agreed that kolla-ansible should follow Ansible's
direction of splitting modules between action modules and facts
modules. Because of this, kolla_container_facts needs to be able
to handle different requests for data about containers or volumes.

Change-Id: Ieaec8f64922e4e5a2199db2d6983518b124cb4aa
Signed-off-by: Ivan Halomi <ivan.halomi@tietoevry.com>

ansible/library/kolla_container_facts.py

@@ -12,8 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
+from abc import ABC
+from abc import abstractmethod
 from ansible.module_utils.basic import AnsibleModule
+from traceback import format_exc
 
 
 DOCUMENTATION = '''
@@ -40,9 +42,9 @@ options:
       - Name or names of the containers
     required: False
     type: str or list
-  container_engine:
+  action:
     description:
-      - Name of container engine to use
+      - The action to perform
     required: True
     type: str
 author: Jeffrey Zhang
@@ -54,6 +56,7 @@ EXAMPLES = '''
     - name: Gather docker facts
       kolla_container_facts:
         container_engine: docker
+      action: get_containers
 
     - name: Gather glance container facts
       kolla_container_facts:
@@ -62,70 +65,103 @@ EXAMPLES = '''
           - glance_api
           - glance_registry
         container_engine: podman
+        action: get_containers
 '''
 
 
-def get_docker_client():
-    import docker
-    return docker.APIClient
+class ContainerFactsWorker(ABC):
+    def __init__(self, module):
+        self.module = module
+        self.results = dict(changed=False, _containers=[])
+        self.params = module.params
+
+    @abstractmethod
+    def get_containers(self):
+        pass
 
 
-def use_docker(module, results):
-    client = get_docker_client()(version=module.params.get('api_version'))
+class DockerFactsWorker(ContainerFactsWorker):
+    def __init__(self, module):
+        super().__init__(module)
+        try:
+            import docker
+        except ImportError:
+            self.module.fail_json(
+                msg="The docker library could not be imported")
+        self.client = docker.APIClient(version=module.params.get(
+                                       'api_version'))
 
-    containers = client.containers()
-    names = module.params.get('name')
-    if names and not isinstance(names, list):
-        names = [names]
-    for container in containers:
-        for container_name in container['Names']:
-            # remove '/' prefix character
-            container_name = container_name[1:]
-            if names and container_name not in names:
+    def get_containers(self):
+        containers = self.client.containers()
+        names = self.params.get('name')
+        if names and not isinstance(names, list):
+            names = [names]
+        for container in containers:
+            for container_name in container['Names']:
+                # remove '/' prefix character
+                container_name = container_name[1:]
+                if names and container_name not in names:
+                    continue
+                self.results['_containers'].append(container)
+                self.results[container_name] = container
+
+
+class PodmanFactsWorker(ContainerFactsWorker):
+    def __init__(self, module):
+        try:
+            import podman.errors as podmanError
+            from podman import PodmanClient
+        except ImportError:
+            self.module.fail_json(
+                msg="The podman library could not be imported")
+        self.podmanError = podmanError
+        super().__init__(module)
+        self.client = PodmanClient(
+            base_url="http+unix:/run/podman/podman.sock")
+
+    def get_containers(self):
+        try:
+            containers = self.client.containers.list(
+                all=True, ignore_removed=True)
+        except self.podmanError.APIError as e:
+            self.module.fail_json(failed=True,
+                                  msg=f"Internal error: {e.explanation}")
+        names = self.params.get('name')
+        if names and not isinstance(names, list):
+            names = [names]
+
+        for container in containers:
+            container.reload()
+            container_name = container.attrs['Name']
+            if container_name not in names:
                 continue
-            results['_containers'].append(container)
-            results[container_name] = container
-
-
-def use_podman(module, results):
-    import podman.errors as pe
-    from podman import PodmanClient
-
-    client = PodmanClient(base_url="http+unix:/run/podman/podman.sock")
-
-    try:
-        containers = client.containers.list(all=True, ignore_removed=True)
-    except pe.APIError as e:
-        module.fail_json(failed=True, msg=f"Internal error: {e.explanation}")
-    names = module.params.get('name')
-    if names and not isinstance(names, list):
-        names = [names]
-
-    for container in containers:
-        container.reload()
-        container_name = container.attrs['Name']
-        if names and container_name not in names:
-            continue
-        results['_containers'].append(container.attrs)
-        results[container_name] = container.attrs
+            self.results['_containers'].append(container.attrs)
+            self.results[container_name] = container.attrs
 
 
 def main():
     argument_spec = dict(
         name=dict(required=False, type='list', default=[]),
         api_version=dict(required=False, type='str', default='auto'),
-        container_engine=dict(required=True, type='str')
+        container_engine=dict(required=True, type='str'),
+        action=dict(required=True, type='str',
+                    choices=['get_containers']),
     )
 
     module = AnsibleModule(argument_spec=argument_spec)
 
-    results = dict(changed=False, _containers=[])
-    if module.params['container_engine'] == 'podman':
-        use_podman(module, results)
-    else:
-        use_docker(module, results)
+    cw: ContainerFactsWorker = None
+    try:
+        if module.params.get('container_engine') == 'docker':
+            cw = DockerFactsWorker(module)
+        else:
+            cw = PodmanFactsWorker(module)
 
-    module.exit_json(**results)
+        result = bool(getattr(cw, module.params.get('action'))())
+        module.exit_json(result=result, **cw.results)
+    except Exception:
+        module.fail_json(changed=True, msg=repr(format_exc()),
+                         **getattr(cw, 'result', {}))
 
 
 if __name__ == "__main__":

ansible/roles/aodh/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - aodh_api

ansible/roles/barbican/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - barbican_api

ansible/roles/bifrost/tasks/stop.yml

@@ -3,6 +3,7 @@
     - name: Check if bifrost_deploy container is running
       become: true
       kolla_container_facts:
+        action: get_containers
         container_engine: "{{ kolla_container_engine }}"
         name:
           - bifrost_deploy

ansible/roles/blazar/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - blazar_api

ansible/roles/cinder/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - cinder_api

ansible/roles/cloudkitty/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - cloudkitty_api

ansible/roles/cyborg/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - cyborg_api

ansible/roles/designate/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - designate_api

ansible/roles/etcd/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - etcd

ansible/roles/glance/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name: "{{ glance_services.values() | map(attribute='container_name') | list }}"
   check_mode: false

ansible/roles/gnocchi/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - gnocchi_api

ansible/roles/grafana/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - grafana

ansible/roles/hacluster/tasks/precheck.yml

@@ -2,6 +2,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - hacluster_pacemaker_remote

ansible/roles/heat/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - heat_api

ansible/roles/horizon/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - horizon

ansible/roles/influxdb/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - influxdb

ansible/roles/ironic/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - ironic_api

ansible/roles/iscsi/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - iscsid

ansible/roles/keystone/tasks/bootstrap_service.yml

@@ -2,6 +2,7 @@
 - name: Checking for any running keystone_fernet containers
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - keystone_fernet

ansible/roles/keystone/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - keystone

ansible/roles/kuryr/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - kuryr

ansible/roles/letsencrypt/tasks/precheck.yml

@@ -2,6 +2,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - letsencrypt_webserver

ansible/roles/loadbalancer/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - haproxy

ansible/roles/magnum/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - magnum_api

ansible/roles/manila/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - manila_api

ansible/roles/mariadb/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - mariadb

ansible/roles/masakari/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - masakari_api

ansible/roles/memcached/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - memcached

ansible/roles/mistral/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - mistral_api

ansible/roles/neutron/handlers/main.yml

@@ -90,6 +90,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - neutron_l3_agent

ansible/roles/neutron/tasks/neutron_plugin_agent_check.yml

@@ -2,6 +2,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - neutron_openvswitch_agent

ansible/roles/neutron/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - neutron_server

ansible/roles/nova-cell/tasks/libvirt-cleanup.yml

@@ -9,6 +9,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - nova_libvirt

ansible/roles/nova-cell/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - nova_libvirt

ansible/roles/nova/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - nova_api

ansible/roles/octavia/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - octavia_api

ansible/roles/opensearch/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - opensearch

ansible/roles/openvswitch/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - openvswitch_db

ansible/roles/ovn-db/tasks/precheck.yml

@@ -2,6 +2,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - ovn_nb_db

ansible/roles/placement/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - placement_api

ansible/roles/prometheus/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - prometheus_server

ansible/roles/rabbitmq/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - rabbitmq

ansible/roles/rabbitmq/tasks/remove-ha-all-policy.yml

@@ -3,6 +3,7 @@
     - name: Get container facts
       become: true
       kolla_container_facts:
+        action: get_containers
         container_engine: "{{ kolla_container_engine }}"
         name:
           - "{{ service.container_name }}"

ansible/roles/rabbitmq/tasks/restart_services.yml

@@ -2,6 +2,7 @@
 - name: Get info on RabbitMQ container
   become: True
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name: "rabbitmq"
   register: container_info

ansible/roles/redis/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - redis

ansible/roles/service-config-validate/tasks/validate.yml

@@ -2,6 +2,7 @@
 - name: "{{ project_name }} : {{ service.container_name }} | Get info on container"
   become: True
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - "{{ service.container_name }}"

ansible/roles/skyline/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - skyline_apiserver

ansible/roles/swift/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - swift_account_server

ansible/roles/tacker/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - tacker_server

ansible/roles/trove/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - trove_api

ansible/roles/venus/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - venus_api

ansible/roles/watcher/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - watcher_api

ansible/roles/zun/tasks/precheck.yml

@@ -8,6 +8,7 @@
 - name: Get container facts
   become: true
   kolla_container_facts:
+    action: get_containers
     container_engine: "{{ kolla_container_engine }}"
     name:
       - zun_api