atk-common 1.3.0__py3-none-any.whl → 1.5.0__py3-none-any.whl

atk_common/__init__.py

@@ -2,10 +2,11 @@
 from atk_common.datetime_utils import date_time_utc, get_utc_date_time
 from atk_common.env_utils import get_env_value
 from atk_common.error_utils import get_message, get_error_entity, handle_error, get_response_error, get_error_type
-from atk_common.http_utils import is_status_code_ok
+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
 
 __all__ = [
     'date_time_utc',
@@ -17,8 +18,11 @@ __all__ = [
     'get_response_error',
     'get_error_type',
     'is_status_code_ok',
+    'get_test_response',
     'add_log_item',
     'add_log_item_http',
     'RabbitMQConsumer',
-    'create_save_resp'
+    'create_save_resp',
+    'get_image_version',
+    'get_current_container_info'
 ]

atk_common/docker_utils.py

@@ -0,0 +1,65 @@
+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/env_utils.py

@@ -3,6 +3,8 @@ from atk_common.log_utils import add_log_item
 
 def get_env_value(key, default_value):
     try:
+        if default_value is None:
+            return None
         val = os.environ[key]
         add_log_item(key + ':' + val)
         return val

atk_common/error_utils.py

@@ -1,6 +1,7 @@
 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
 
@@ -18,6 +19,7 @@ def get_error_entity(app, error, component, method, error_type, status_code):
     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),
@@ -41,7 +43,7 @@ def get_response_error(resp):
 
 # Return values:
 # 1 - Connection error
-# 2 - Database error
+# 2 - Internal error
 def get_error_type(conn):
     if conn is None:
         return 1

atk_common/http_utils.py

@@ -1,2 +1,24 @@
+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.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):
+    data = {}
+    container_info = get_current_container_info()
+    if container_info is not None:
+        data['containerName'] = container_info.name
+        data['containerPorts'] = container_info.ports
+    else:
+        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/rabbitmq_consumer.py

@@ -3,12 +3,11 @@ import socket
 import time
 
 class RabbitMQConsumer:
-    def __init__(self, queue_name, user, pwd, host, vhost, dlx, dlq, encoding, message_handler, log):
+    def __init__(self, queue_name, user, pwd, host, vhost, dlx, dlq, content_type, message_handler, log):
 
         rabbit_url = 'amqp://' + user + ':' + pwd + '@' + host + '/' + vhost
 
         self.connection = Connection(rabbit_url, heartbeat=10)
-        queue = None
         if dlx is not None and dlq is not None:
             queue = Queue(name=queue_name,
                         queue_arguments={
@@ -17,7 +16,10 @@ class RabbitMQConsumer:
                         )
         else:
             queue = Queue(name=queue_name)
-        self.consumer = Consumer(self.connection, queues=queue, callbacks=[message_handler], accept=[encoding])
+        if content_type is not None:
+            self.consumer = Consumer(self.connection, queues=queue, callbacks=[message_handler], accept=[content_type])
+        else:
+            self.consumer = Consumer(self.connection, queues=queue, callbacks=[message_handler], accept=None)
         self.consumer.consume()
 
         self.message_handler = message_handler  # Custom message handler

{atk_common-1.3.0.dist-info → atk_common-1.5.0.dist-info}/METADATA

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

{atk_common-1.3.0.dist-info → atk_common-1.5.0.dist-info}/RECORD

@@ -1,10 +1,11 @@
-atk_common/__init__.py,sha256=EceDa352WFHTdC_LxYANXf_TS9pGzK3MCx87bwAKTvg,811
+atk_common/__init__.py,sha256=u4ue9lkuw1ImDdWClEB1z6k_8eHjfm-1wvJipZV5JnM,1000
 atk_common/datetime_utils.py,sha256=qsVF7l90P1-xukG2tV_jLqG9J_Yfl5wTpyfrdPBlyMo,239
-atk_common/env_utils.py,sha256=bXOrxM3fZUslqfmZt75iphbEJHbG4riJa8XOVzPwIII,313
-atk_common/error_utils.py,sha256=cBDe5zOzOOuzRCs5WHo55knx74-ZUnDvaqrQtXBuZKw,1421
-atk_common/http_utils.py,sha256=5PjGYy-TiBbtNOElEDhsCs3BPDTfqg_aMQBNCuHfcrQ,90
+atk_common/docker_utils.py,sha256=BuulyBYuUoNS-iV4ZsknRifx5L2KWcKrrHDRqg6zqaY,2194
+atk_common/env_utils.py,sha256=66v-S0vlkJNaun6ay1XcOGRtYJb4Ce4odJsWxuaHsQc,373
+atk_common/error_utils.py,sha256=5OiL5nMBEkDc193m2cVMD2Bs-fwRvPeSlI7PwnqB0o4,1533
+atk_common/http_utils.py,sha256=t2XmuDMBjUAH071qwarZ6hcTBzpO_4a9x10E8MU2EMc,924
 atk_common/log_utils.py,sha256=DGGwXjD5jvpMZJNW1QBoJRdDaTY1e1Z69j0LSOOzsWA,419
-atk_common/rabbitmq_consumer.py,sha256=wmZQieeONkfXB5RmM6yiNkwl0_QK4oWWDBSfiD47CdA,1753
+atk_common/rabbitmq_consumer.py,sha256=4MhuwZs47Jt1fX4sUxr1MKRe7o2QRbPe9_utXEsa8QE,1907
 atk_common/response_utils.py,sha256=ezqTSNdGwueFXzijKB7CKPWxZml39bqjAZOeIMWMntk,197
 atk_common/enums/__init__.py,sha256=oW0aVnwewfH6sNu14jjZ5_uP4iRN4pRmGdTNC204rHo,236
 atk_common/enums/command_status_enum.py,sha256=M2Nln27a_DbzI07-gfytWQk2X087JhkU6Fmard5qVHs,127
@@ -21,8 +22,8 @@ atk_package/enums/__init__.py,sha256=oW0aVnwewfH6sNu14jjZ5_uP4iRN4pRmGdTNC204rHo
 atk_package/enums/command_status_enum.py,sha256=M2Nln27a_DbzI07-gfytWQk2X087JhkU6Fmard5qVHs,127
 atk_package/enums/speed_control_status_enum.py,sha256=qpURh0K1L1tSpbrzVnckoe4hUn1illIkbo7k4mLfzIM,182
 shared_python_atk_enforcement/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-atk_common-1.3.0.dist-info/METADATA,sha256=XAqiKPtEPWZ2NmEwxPp0BWwxo2zzhHeDzNscV3VdoCE,1193
-atk_common-1.3.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-atk_common-1.3.0.dist-info/license.txt,sha256=_0O6fWM00-wTurDjnZhUP_N5QiwGhItaQZqHq5eqadA,1063
-atk_common-1.3.0.dist-info/top_level.txt,sha256=4CwRjkLnheIdI4jQwc4tK3dbRc58WqUmoqjkdDTWlME,41
-atk_common-1.3.0.dist-info/RECORD,,
+atk_common-1.5.0.dist-info/METADATA,sha256=Qa-31_dqBulVz-F3gzWuvkalmUrfWjHo1PGsQhEFCRw,1193
+atk_common-1.5.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+atk_common-1.5.0.dist-info/license.txt,sha256=_0O6fWM00-wTurDjnZhUP_N5QiwGhItaQZqHq5eqadA,1063
+atk_common-1.5.0.dist-info/top_level.txt,sha256=4CwRjkLnheIdI4jQwc4tK3dbRc58WqUmoqjkdDTWlME,41
+atk_common-1.5.0.dist-info/RECORD,,