atk-common 1.6.0__tar.gz → 1.8.0__tar.gz

{atk_common-1.6.0 → atk_common-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atk_common
-Version: 1.6.0
+Version: 1.8.0
 Summary: ATK common methods
 Home-page: https://github.com/pypa/atk_common
 Author: Roger

{atk_common-1.6.0 → atk_common-1.8.0}/setup.py

@@ -36,7 +36,7 @@ setup(
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/guides/single-sourcing-package-version/
-    version="1.6.0",  # Required
+    version="1.8.0",  # Required
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:
     # https://packaging.python.org/specifications/core-metadata/#summary

{atk_common-1.6.0 → atk_common-1.8.0}/src/atk_common/__init__.py

@@ -6,7 +6,7 @@ from atk_common.http_utils import is_status_code_ok, get_test_response
 from atk_common.log_utils import add_log_item, add_log_item_http
 from atk_common.rabbitmq_consumer import RabbitMQConsumer
 from atk_common.response_utils import create_save_resp
-from atk_common.docker_utils import get_image_version, get_current_container_info
+from atk_common.docker_utils import get_current_container_info
 
 __all__ = [
     'date_time_utc',
@@ -23,6 +23,5 @@ __all__ = [
     'add_log_item_http',
     'RabbitMQConsumer',
     'create_save_resp',
-    'get_image_version',
     'get_current_container_info',
 ]

atk_common-1.8.0/src/atk_common/docker_utils.py

@@ -0,0 +1,57 @@
+import docker
+import socket
+from atk_common.log_utils import add_log_item
+
+def get_image_name_and_version(tags):
+    if tags:
+        # Use the first tag (usually only one)
+        full_tag = tags[0]  # e.g., 'bo-crypto-wrapper-api:latest'
+
+        if ":" in full_tag:
+            image_name, image_version = full_tag.split(":", 1)
+        else:
+            image_name = full_tag
+            image_version = "<none>"
+        return image_name, image_version
+    else:
+        return None, None
+    
+def create_port_item(port, binding):
+    data = {}
+    data['port'] = port
+    data['binding'] = binding
+    return data
+
+def create_container_log(container_data):
+    log_str = 'Container name: ' + container_data['containerName'] + ', image name: ' + container_data['imageName'] + ', image version: ' + container_data['imageVersion']
+    add_log_item(log_str)
+
+def get_current_container_info():
+    try:
+        data = {}
+        client = docker.from_env()
+
+        # Get current container's hostname (usually the container ID)
+        container_id = socket.gethostname()
+
+        # Fetch container object using partial ID
+        container = client.containers.get(container_id)
+
+        tags_info = get_image_name_and_version(container.image.tags)
+        data['imageName'] = tags_info[0]
+        data['imageVersion'] = tags_info[1]
+        data['containerName'] = container.name
+        ports = container.attrs['NetworkSettings']['Ports']
+        data['ports'] = []
+        if ports:
+            for container_port, host_bindings in ports.items():
+                if host_bindings:
+                    for binding in host_bindings:
+                        data['ports'].append(create_port_item(container_port, f"{binding['HostIp']}:{binding['HostPort']}"))
+                else:
+                    data['ports'].append(create_port_item(container_port, None))
+        create_container_log(data)
+        return data
+    except Exception as e:
+        add_log_item("Error getting container data:" + str(e))
+        return None

{atk_common-1.6.0 → atk_common-1.8.0}/src/atk_common/error_utils.py

@@ -1,7 +1,6 @@
 from datetime import datetime
 import json
 from atk_common.datetime_utils import get_utc_date_time
-from atk_common.docker_utils import get_image_version
 from atk_common.log_utils import add_log_item
 from atk_common.response_utils import create_save_resp
 
@@ -10,22 +9,36 @@ def get_message(error):
         return str(error.message)
     else:
         return str(error)
+    
+def create_error_log(data):
+    err_str = data['message'] + ', statusCode: ' + str(data['statusCode']) + ', method: ' + data['method']
+    if data['containerInfo'] is not None:
+        err_str += ', imageName: ' + data['containerInfo']['imageName']
+        err_str += ', imageVersion: ' + data['containerInfo']['imageVersion']
+        err_str += ', containerName: ' + data['containerInfo']['containerName']
+    else:
+        err_str += ', imageName: <none>'
+        err_str += ', imageVersion: <none>'
+        err_str += ', containerName: <none>'
+    add_log_item(err_str)
 
-def get_error_entity(app, error, component, method, error_type, status_code):
+def get_error_entity(app, error, method, error_type, status_code, container_info):
     data = {}
     data['statusCode'] = status_code
     data['exceptionType'] = str(type(error))
     data['errorType'] = error_type
     data['message'] = get_message(error)
-    data['component'] = component
     data['method'] = method
-    data['imageVersion'] = get_image_version(component)
     data['timestamp'] = get_utc_date_time()
-    return app.response_class(
-        response=json.dumps(data),
-        status=500,
-        mimetype='application/json'
-    )
+    data['containerInfo'] = container_info
+    create_error_log(data)
+    if app is not None:
+        return app.response_class(
+            response=json.dumps(data),
+            status=500,
+            mimetype='application/json'
+        )
+    return None
 
 def handle_error(resp, status):
     if resp.status_code == 500:

{atk_common-1.6.0 → atk_common-1.8.0}/src/atk_common/http_utils.py

@@ -1,24 +1,23 @@
 import json
 from atk_common.datetime_utils import get_utc_date_time
-from atk_common.docker_utils import get_current_container_info, get_image_version
+from atk_common.docker_utils import get_current_container_info
 from atk_common.env_utils import get_env_value
 
 def is_status_code_ok(status_code):
     return status_code >= 200 and status_code < 300
 
-def get_test_response(default_value=None):
+def get_test_response():
     data = {}
     container_info = get_current_container_info()
     if container_info is not None:
-        data['containerName'] = container_info.name
-        data['containerPorts'] = container_info.ports
+        data['imageName'] = container_info['imageName']
+        data['imageVersion'] = container_info['imageVersion']
+        data['containerName'] = container_info['containerName']
+        data['containerPorts'] = container_info['ports']
     else:
+        data['imageName'] = None
+        data['imageVersion'] = None
         data['containerName'] = None
         data['containerPorts'] = None
-    data['imageName'] = get_env_value('DOCKER_IMAGE_NAME', default_value)
-    if data['imageName'] is None:
-        data['imageVersion'] = None
-    else:
-        data['imageVersion'] = get_image_version(data['imageName'])
     data['timestamp'] = get_utc_date_time()
     return data

{atk_common-1.6.0 → atk_common-1.8.0}/src/atk_common.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: atk_common
-Version: 1.6.0
+Version: 1.8.0
 Summary: ATK common methods
 Home-page: https://github.com/pypa/atk_common
 Author: Roger

{atk_common-1.6.0 → atk_common-1.8.0}/src/atk_common.egg-info/SOURCES.txt

@@ -22,5 +22,6 @@ src/atk_common/enums/command_status_enum.py
 src/atk_common/enums/speed_control_status_enum.py
 src/shared_python_atk_enforcement/__init__.py
 tests/test_docker_utils.py
+tests/test_error_utils.py
 tests/test_http_utils.py
 tests/test_log_utils.py

atk_common-1.8.0/tests/test_docker_utils.py

@@ -0,0 +1,12 @@
+import unittest
+import sys, os
+from atk_common.docker_utils import get_current_container_info
+
+class TestDockerUtils(unittest.TestCase):
+
+    def test_get_container_info(self):
+        info = get_current_container_info()
+        self.assertIsNone(info)
+
+if __name__ == "__main__":
+    unittest.main()

atk_common-1.8.0/tests/test_error_utils.py

@@ -0,0 +1,21 @@
+import unittest
+import sys, os
+from atk_common.error_utils import get_error_entity
+
+class TestErrorUtils(unittest.TestCase):
+
+    def create_dummy_container_info(self):
+        data = {}
+        data['imageName'] = 'bo-test-api'
+        data['imageVersion'] = '1.0.0'
+        data['containerName'] = 'bo-test-api'
+        data['ports'] = []
+        data['ports'].append({'port': 8080, 'binding': 8080})
+        return data
+
+    def test_get_error_entity(self):
+        resp_json = get_error_entity(None, 'An new error occured', 'get-configuration', 1, 404, self.create_dummy_container_info())
+        self.assertIsNone(resp_json)
+
+if __name__ == "__main__":
+    unittest.main()

atk_common-1.8.0/tests/test_http_utils.py

@@ -0,0 +1,12 @@
+import unittest
+import sys, os
+from atk_common.http_utils import get_test_response
+
+class TestHttpUtils(unittest.TestCase):
+
+    def test_get_test_response_none(self):
+        resp_json = get_test_response()
+        self.assertIsNotNone(resp_json)
+
+if __name__ == "__main__":
+    unittest.main()

atk_common-1.6.0/src/atk_common/docker_utils.py

@@ -1,65 +0,0 @@
-import docker
-import os
-import socket
-from atk_common.env_utils import get_env_value
-
-def find_image_prop_list_by_name(image_list, image_name):
-    for image in image_list:
-        if image.tags and len(image.tags) > 0:
-            # Check if the image name is in the first tag
-            if image_name in image.tags[0]:
-                return image.tags[0]
-    return None
-
-def get_image_version(default_value=None):
-    """
-    Get the version of a Docker image.
-    
-    :param image_name: Name of the Docker image
-    :return: Version of the Docker image
-    """
-    try:
-        image_name = get_env_value('DOCKER_IMAGE_NAME', default_value)
-        if image_name is None:
-            return None
-        client = docker.from_env()
-        image_list = client.images.list()
-        image_prop_list = find_image_prop_list_by_name(image_list, image_name)
-        if image_prop_list is None:
-            return None
-        image_props = image_prop_list.split(':')
-        if len(image_props) < 2:
-            return None
-        return image_props[1] 
-    except docker.errors.ImageNotFound:
-        return None
-
-def get_current_container_info():
-    try:
-        client = docker.from_env()
-
-        # Get current container's hostname (usually the container ID)
-        container_id = socket.gethostname()
-
-        # Fetch container object using partial ID
-        container = client.containers.get(container_id)
-
-        name = container.name
-        ports = container.attrs['NetworkSettings']['Ports']
-
-        print(f"🔍 Container name: {name}")
-        print("🌐 Port mappings:")
-        if ports:
-            for container_port, host_bindings in ports.items():
-                if host_bindings:
-                    for binding in host_bindings:
-                        print(f"  {container_port} -> {binding['HostIp']}:{binding['HostPort']}")
-                else:
-                    print(f"  {container_port} -> Not bound to host")
-        else:
-            print("No exposed ports found.")
-        return None
-
-    except Exception as e:
-        print("❌ Error getting container info:", e)
-        return None

atk_common-1.6.0/tests/test_docker_utils.py

@@ -1,20 +0,0 @@
-import unittest
-import sys, os
-from atk_common.docker_utils import get_image_version, list_all_images
-
-class TestDockerUtils(unittest.TestCase):
-
-    def test_get_image_version_none(self):
-        ver = get_image_version()
-        self.assertIsNone(ver)
-
-    def test_get_image_version_not_none_1(self):
-        ver = get_image_version('bo-config-db-api')
-        self.assertIsNotNone(ver)
-
-    def test_get_image_version_not_none_2(self):
-        ver = get_image_version('bo-case-web')
-        self.assertIsNotNone(ver)
-
-if __name__ == "__main__":
-    unittest.main()

atk_common-1.6.0/tests/test_http_utils.py

@@ -1,20 +0,0 @@
-import unittest
-import sys, os
-from atk_common.http_utils import get_test_response
-
-class TestHttpUtils(unittest.TestCase):
-
-    def test_get_test_response_none(self):
-        resp_json = get_test_response()
-        self.assertIsNotNone(resp_json)
-
-    def test_get_image_version_not_none_1(self):
-        resp_json = get_test_response('bo-config-db-api')
-        self.assertIsNotNone(resp_json)
-
-    def test_get_image_version_not_none_2(self):
-        resp_json = get_test_response('bo-case-web')
-        self.assertIsNotNone(resp_json)
-
-if __name__ == "__main__":
-    unittest.main()