Add http service tests

Signed-off-by: Sagi Shnaidman <[email protected]>

Author: sshnaidm

.github/workflows/podman_container_api.yml

@@ -41,17 +41,17 @@ jobs:
       matrix:
         ansible-version:
           - ansible<2.10
-          - git+https://github.com/ansible/ansible.git@stable-2.15
+          # - git+https://github.com/ansible/ansible.git@stable-2.17
           - git+https://github.com/ansible/ansible.git@devel
         os:
           - ubuntu-22.04
         python-version:
-          - "3.10"
+          - "3.11"
         podman-version:
           - unstable
         include:
           - os: ubuntu-22.04
-            ansible-version: git+https://github.com/ansible/ansible.git@stable-2.15
+            ansible-version: git+https://github.com/ansible/ansible.git@stable-2.17
             python-version: "3.10"
             podman-version: stable
 
@@ -108,6 +108,7 @@ jobs:
           python3 -m pip install --user -r requirements.txt
           podman system service --time=0 unix:///tmp/podman.sock &
           sudo podman system service --time=0 unix:///tmp/root-podman.sock &
+          podman system service --time=0 tcp:localhost:25771 &
 
           echo $ANSIBLE_CONFIG
           command -v ansible-playbook

plugins/module_utils/podman/common.py

@@ -17,12 +17,18 @@
     try:
         from distutils.version import LooseVersion  # noqa: F401
     except ImportError as exc:
-        raise_from(ImportError('To use this plugin or module with ansible-core'
-                               ' < 2.11, you need to use Python < 3.12 with '
-                               'distutils.version present'), exc)
+        raise_from(
+            ImportError(
+                "To use this plugin or module with ansible-core"
+                " < 2.11, you need to use Python < 3.12 with "
+                "distutils.version present"
+            ),
+            exc,
+        )
 try:
     import requests  # pylint: disable=unused-import
     from .podman_api import PodmanAPIClient
+
     HAS_REQUESTS = True
 except ImportError:
     PodmanAPIClient = object
@@ -380,8 +386,8 @@ def createcommand(argument, info_config, boolean_type=False):
     all_values = []
     # Remove command args from the list
     container_cmd = info_config.get("cmd")
-    if container_cmd and container_cmd == cr_com[-len(container_cmd):]:
-        cr_com = cr_com[:-len(container_cmd)]
+    if container_cmd and container_cmd == cr_com[-len(container_cmd) :]:
+        cr_com = cr_com[: -len(container_cmd)]
     for arg in argument_values:
         for ind, cr_opt in enumerate(cr_com):
             if arg == cr_opt:
@@ -456,10 +462,9 @@ def diff_generic(params, info_config, module_arg, cmd_arg, boolean_type=False):
 
 class PodmanAPI:
     def __init__(self, module, module_params):
-        if module_params.get('podman_socket') and not HAS_REQUESTS:
-            module.fail_json(
-                msg="Requests module is not installed while socket was provided!")
-        self.client = PodmanAPIClient(module_params.get('podman_socket'))
+        if module_params.get("podman_socket") and not HAS_REQUESTS:
+            module.fail_json(msg="Requests module is not installed while socket was provided!")
+        self.client = PodmanAPIClient(module_params.get("podman_socket"))
         try:
             self.client.version()
         except Exception as api_error:

plugins/module_utils/podman/podman_api.py

@@ -1,24 +1,27 @@
-
 # The follwing code is taken from
 # https://github.com/msabramo/requests-unixsocket/blob/master/
 # requests_unixsocket/adapters.py
-from __future__ import (absolute_import, division, print_function)
+from __future__ import absolute_import, division, print_function
 
 import socket
+
 try:
     import requests
     from requests.adapters import HTTPAdapter
     from requests.compat import urlparse, unquote, quote
+
     HAS_REQUESTS = True
 except ImportError:
     HAS_REQUESTS = False
 
 try:
     from requests.packages import urllib3
+
     HAS_URLLIB3 = True
 except ImportError:
     try:
         import urllib3
+
         HAS_URLLIB3 = True
     except ImportError:
         HAS_URLLIB3 = False
@@ -34,7 +37,7 @@
 __metaclass__ = type
 
 
-DEFAULT_SCHEME = 'http+unix://'
+DEFAULT_SCHEME = "http+unix://"
 
 
 class PodmanAPIError(Exception):
@@ -51,7 +54,7 @@ def __init__(self, unix_socket_url, timeout=60):
         netloc is a percent-encoded path to a unix domain socket. E.g.:
         'http+unix://%2Ftmp%2Fprofilesvc.sock/status/pid'
         """
-        super(UnixHTTPConnection, self).__init__('localhost', timeout=timeout)
+        super(UnixHTTPConnection, self).__init__("localhost", timeout=timeout)
         self.unix_socket_url = unix_socket_url
         self.timeout = timeout
         self.sock = None
@@ -69,11 +72,11 @@ def connect(self):
 
 
 if HAS_URLLIB3:
+
     class UnixHTTPConnectionPool(urllib3.connectionpool.HTTPConnectionPool):
 
         def __init__(self, socket_path, timeout=60):
-            super(UnixHTTPConnectionPool, self).__init__(
-                'localhost', timeout=timeout)
+            super(UnixHTTPConnectionPool, self).__init__("localhost", timeout=timeout)
             self.socket_path = socket_path
             self.timeout = timeout
 
@@ -82,22 +85,20 @@ def _new_conn(self):
 
 
 if HAS_REQUESTS:
+
     class UnixAdapter(HTTPAdapter):
 
         def __init__(self, *args, timeout=60, pool_connections=25, **kwargs):
             super(UnixAdapter, self).__init__(*args, **kwargs)
             self.timeout = timeout
-            self.pools = urllib3._collections.RecentlyUsedContainer(
-                pool_connections, dispose_func=lambda p: p.close()
-            )
+            self.pools = urllib3._collections.RecentlyUsedContainer(pool_connections, dispose_func=lambda p: p.close())
 
         def get_connection(self, url, proxies=None):
             proxies = proxies or {}
             proxy = proxies.get(urlparse(url.lower()).scheme)
 
             if proxy:
-                raise ValueError('%s does not support specifying proxies'
-                                 % self.__class__.__name__)
+                raise ValueError("%s does not support specifying proxies" % self.__class__.__name__)
 
             with self.pools.lock:
                 pool = self.pools.get(url)
@@ -117,6 +118,7 @@ def close(self):
 
 
 if HAS_REQUESTS:
+
     class APISession(requests.Session):
         def __init__(self, *args, url_scheme=DEFAULT_SCHEME, **kwargs):
             super(APISession, self).__init__(*args, **kwargs)
@@ -125,9 +127,7 @@ def __init__(self, *args, url_scheme=DEFAULT_SCHEME, **kwargs):
 
 class PodmanAPIHTTP:
     def __init__(self, base_url, scheme=DEFAULT_SCHEME):
-        self.api_url = "".join((scheme,
-                                quote(base_url, safe=""),
-                                "/v2.0.0/libpod"))
+        self.api_url = "".join((scheme, quote(base_url, safe=""), "/v2.0.0/libpod"))
         if scheme == "http://":
             self.api_url = "".join((scheme, base_url, "/v2.0.0/libpod"))
         self.session = APISession()
@@ -136,28 +136,28 @@ def request(self, method, url, **kwargs):
         return self.session.request(method=method, url=self.api_url + url, **kwargs)
 
     def get(self, url, **kwargs):
-        kwargs.setdefault('allow_redirects', True)
-        return self.request('get', url, **kwargs)
+        kwargs.setdefault("allow_redirects", True)
+        return self.request("get", url, **kwargs)
 
     def head(self, url, **kwargs):
-        kwargs.setdefault('allow_redirects', False)
-        return self.request('head', url, **kwargs)
+        kwargs.setdefault("allow_redirects", False)
+        return self.request("head", url, **kwargs)
 
     def post(self, url, data=None, json=None, **kwargs):
-        return self.request('post', url, data=data, json=json, **kwargs)
+        return self.request("post", url, data=data, json=json, **kwargs)
 
     def patch(self, url, data=None, **kwargs):
-        return self.request('patch', url, data=data, **kwargs)
+        return self.request("patch", url, data=data, **kwargs)
 
     def put(self, url, data=None, **kwargs):
-        return self.request('put', url, data=data, **kwargs)
+        return self.request("put", url, data=data, **kwargs)
 
     def delete(self, url, **kwargs):
-        return self.request('delete', url, **kwargs)
+        return self.request("delete", url, **kwargs)
 
     def options(self, url, **kwargs):
-        kwargs.setdefault('allow_redirects', True)
-        return self.request('options', url, **kwargs)
+        kwargs.setdefault("allow_redirects", True)
+        return self.request("options", url, **kwargs)
 
 
 class PodmanAPIClient:
@@ -166,10 +166,7 @@ def __init__(self, base_url):
             raise PodmanAPIError("requests package is required for podman API")
         socket_opt = urlparse(base_url)
         if socket_opt.scheme not in ("unix", "http"):
-            raise PodmanAPIError("Scheme %s is not supported! Use %s" % (
-                socket_opt.scheme,
-                DEFAULT_SCHEME
-            ))
+            raise PodmanAPIError("Scheme %s is not supported! Use %s" % (socket_opt.scheme, DEFAULT_SCHEME))
         if socket_opt.scheme == "http":
             self.api = PodmanAPIHTTP(socket_opt.netloc, "http://")
         else:
@@ -178,8 +175,7 @@ def __init__(self, base_url):
         self.images = PodmanAPIImages(api=self.api)
 
     def version(self):
-        response = self.api.get(
-            '/version')
+        response = self.api.get("/version")
         return response.json()
 
 
@@ -188,8 +184,7 @@ def __init__(self, api):
         self.api = api
         self.quote = quote
 
-    def list(
-            self, all_=None, filters=None, limit=None, size=None, sync=None):
+    def list(self, all_=None, filters=None, limit=None, size=None, sync=None):
         """List all images for a Podman service."""
         query = {}
         if all_ is not None:
@@ -213,14 +208,12 @@ def create(self, **container_data):
         )
         if response.ok:
             return response.json()
-        raise PodmanAPIError("Container %s failed to create! Error: %s" %
-                             (container_data.get('name'), response.text))
+        raise PodmanAPIError("Container %s failed to create! Error: %s" % (container_data.get("name"), response.text))
 
     def get(self, name):
-        response = self.api.get(
-            '/containers/{0}/json'.format(self.quote(name)))
+        response = self.api.get("/containers/{0}/json".format(self.quote(name)))
         data = response.json()
-        if data.get('response') == 404:
+        if data.get("response") == 404:
             data = {}
             # raise Exception("Container %s not found!" % name)
         return data
@@ -253,8 +246,7 @@ def restart(self, name):
 
     def remove(self, name, force=False):
         _ = self.api.delete(  # pylint: disable=blacklisted-name
-            "/containers/{0}".format(self.quote(name)),
-            params={"force": force}
+            "/containers/{0}".format(self.quote(name)), params={"force": force}
         )
         return
 
@@ -266,31 +258,26 @@ def __init__(self, api):
         self.inspect = self.get
 
     def exists(self, name):
-        response = self.api.get(
-            '/images/{0}/exists'.format(self.quote(name)))
+        response = self.api.get("/images/{0}/exists".format(self.quote(name)))
         return response.status_code == 204
 
     def pull(self, reference):
-        response = self.api.post(
-            '/images/pull',
-            params={'reference': reference}
-        )
+        response = self.api.post("/images/pull", params={"reference": reference})
         if response.ok:
-            correct_response = {'stream': '', 'text': response.text}
+            correct_response = {"stream": "", "text": response.text}
             for i in response.text.splitlines():
                 if '"images"' in i:
-                    correct_response['images'] = json.loads(i)['images']
+                    correct_response["images"] = json.loads(i)["images"]
                 if '"id"' in i:
-                    correct_response['id'] = json.loads(i)['id']
+                    correct_response["id"] = json.loads(i)["id"]
                 elif '"stream"' in i:
-                    correct_response['stream'] += json.loads(i)['stream']
+                    correct_response["stream"] += json.loads(i)["stream"]
                 elif '"error"' in i:
-                    correct_response['error'] = json.loads(i)['error']
-            correct_response['code'] = response.status_code
+                    correct_response["error"] = json.loads(i)["error"]
+            correct_response["code"] = response.status_code
             return correct_response
-        return {"error": "HTTP %s Error: %s" % (response.json()['message'])}
+        return {"error": "HTTP %s Error: %s" % (response.json()["message"])}
 
     def get(self, name):
-        response = self.api.get(
-            '/images/{0}/json'.format(self.quote(name)))
+        response = self.api.get("/images/{0}/json".format(self.quote(name)))
         return response.json()