feat: add library structure, togheter with exception and logger classes (#1) (#2)

mithenks · sofygalante · web-flow · commit 1c0232e0da0b · 2024-11-21T16:07:01.000+01:00
* feat: add library structure, togheter with exception and logger classes (#1) * feat: configured ZcsLogging to support enhanced local logging and cloud format (#1) --------- Co-authored-by: Sofia Galante <s.galante@zcscompany.com>
diff --git a/.build/dockerfiles/Dockerfile b/.build/dockerfiles/Dockerfile
@@ -0,0 +1,49 @@
+#
+# STAGE 1 - Dev
+#
+# Dev image used for local development
+#
+FROM zcscompany/python:3.11-dev AS dev
+
+ARG FIX_UID
+ARG FIX_GID
+ARG DOCKER_USER=bob
+ARG DOCKER_GROUP=bob
+
+USER 0
+RUN /fix-perm.sh
+
+RUN pip install --upgrade pip
+
+# Run as normal user
+USER ${DOCKER_USER}
+
+
+#
+# STAGE 2 - Dist
+#
+# Image used for application distribution
+#
+FROM zcscompany/python:3.11-dist AS dist
+
+ARG DOCKER_USER=bob
+ARG DOCKER_GROUP=bob
+
+USER 0
+RUN pip install --upgrade pip
+
+# Run as normal user
+USER ${DOCKER_USER}
+
+# Copy application requirement file
+COPY --chown=$DOCKER_USER:$DOCKER_GROUP app/requirements.txt .
+
+# Install app requirements
+RUN pip install --user --no-cache-dir --disable-pip-version-check -r requirements.txt
+
+# Copy application code
+COPY --chown=$DOCKER_USER:$DOCKER_GROUP app/ .
+
+# Build and install the library
+RUN python -m build && \
+    pip install --user --no-cache-dir --disable-pip-version-check --editable .
diff --git a/.data/bob-s-home/.bashrc b/.data/bob-s-home/.bashrc
@@ -0,0 +1,4 @@
+
+PS1='\[\033[01;32m\][\[\033[01;32;4m\]${APP_NAME}\[\033[00m\]\[\033[01;32m\]]\[\033[00m\]:\[\033[01;33m\]\w\[\033[00m\]\$ \[\033[00m\]'
+
+alias ls="ls --color"
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,11 @@
+
+**/__pycache__
+**/.pytest_cache
+**/*.egg-info/
+
+.data/
+.github/
+.vscode/
+
+app/dist
+app/ai-accounting*json
diff --git a/.github/workflows/pr_build-and-test.yaml b/.github/workflows/pr_build-and-test.yaml
@@ -0,0 +1,27 @@
+name: PR - Build and test library
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  docker-build-and-test:
+    name: Build dist docker image and run tests
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: 'read'
+      id-token: 'write'
+
+    steps:
+      - id: checkout
+        name: Checkout project
+        uses: actions/checkout@v4
+
+      - id: build
+        name: Build dist docker image
+        run: docker build -f .build/dockerfiles/Dockerfile -t dist .
+    
+      - id: test
+        name: Run python tests on dist image
+        run: docker run --rm dist pytest
diff --git a/.github/workflows/publish-tag.yaml b/.github/workflows/publish-tag.yaml
@@ -0,0 +1,57 @@
+name: Publish application tag
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  setup-build-publish-deploy:
+    name: Setup, Build, Publish tagged package
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: 'read'
+      id-token: 'write'
+
+    steps:
+      - id: checkout
+        name: Checkout
+        uses: actions/checkout@v4
+
+      - id: auth
+        name: Authenticate with Google Cloud
+        uses: google-github-actions/auth@v2
+        with:
+          token_format: access_token
+          workload_identity_provider: projects/51853309262/locations/global/workloadIdentityPools/my-pool/providers/my-provider
+          service_account: github-actions-sa@ai-accounting-405809.iam.gserviceaccount.com
+          access_token_lifetime: 600s
+
+      - name: Setup Python
+        uses: actions/setup-python@v3
+
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build
+          python -m pip install wheel
+          python -m pip install twine
+          python -m pip install keyring keyrings.google-artifactregistry-auth
+
+      - name: Build wheel
+        working-directory: ./app
+        run: python -m build
+        
+      - name: 'Set up Cloud SDK'
+        uses: 'google-github-actions/setup-gcloud@v2'
+        with:
+          version: '>= 363.0.0'
+
+      - name: Upload to Artifact Registry
+        working-directory: ./app
+        run: |
+          gcloud config set artifacts/repository python
+          gcloud config set artifacts/location europe-west1
+          gcloud artifacts print-settings python > ~/.pypirc
+          python -m twine upload --repository python dist/*
diff --git a/README.md b/README.md
@@ -0,0 +1,93 @@
+# ZCS Python Core Library
+
+This repository contains the core python library developed by Madness Lab Team at Zucchetti Centro Sistemi.
+
+The library provides a `Logger` allowing the user to receive logging messages from Uvicorn and send them to Google Cloud.
+
+```text
+
+░▒▓████████▓▒░░▒▓██████▓▒░ ░▒▓███████▓▒░                                             
+       ░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░                                                    
+     ░▒▓██▓▒░░▒▓█▓▒░      ░▒▓█▓▒░                                                    
+   ░▒▓██▓▒░  ░▒▓█▓▒░       ░▒▓██████▓▒░                                              
+ ░▒▓██▓▒░    ░▒▓█▓▒░             ░▒▓█▓▒░                                             
+░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░      ░▒▓█▓▒░                                             
+░▒▓████████▓▒░░▒▓██████▓▒░░▒▓███████▓▒░                                              
+                                                                                     
+                                                                                     
+░▒▓███████▓▒░░▒▓█▓▒░░▒▓█▓▒░▒▓████████▓▒░▒▓█▓▒░░▒▓█▓▒░░▒▓██████▓▒░░▒▓███████▓▒░       
+░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░  ░▒▓█▓▒░   ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░      
+░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░  ░▒▓█▓▒░   ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░      
+░▒▓███████▓▒░ ░▒▓██████▓▒░   ░▒▓█▓▒░   ░▒▓████████▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░      
+░▒▓█▓▒░         ░▒▓█▓▒░      ░▒▓█▓▒░   ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░      
+░▒▓█▓▒░         ░▒▓█▓▒░      ░▒▓█▓▒░   ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░      
+░▒▓█▓▒░         ░▒▓█▓▒░      ░▒▓█▓▒░   ░▒▓█▓▒░░▒▓█▓▒░░▒▓██████▓▒░░▒▓█▓▒░░▒▓█▓▒░      
+                                                                                     
+                                                                                     
+ ░▒▓██████▓▒░ ░▒▓██████▓▒░░▒▓███████▓▒░░▒▓████████▓▒░                                
+░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░                                       
+░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░                                       
+░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓███████▓▒░░▒▓██████▓▒░                                  
+░▒▓█▓▒░      ░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░                                       
+░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░░▒▓█▓▒░▒▓█▓▒░                                       
+ ░▒▓██████▓▒░ ░▒▓██████▓▒░░▒▓█▓▒░░▒▓█▓▒░▒▓████████▓▒░                                
+                                                                                     
+                                                                                                                  
+```
+
+## Usage
+
+### Requirements
+
+The library doesn't require directly third party dependencies. This will let you install only the requirements needed by the utils you will effectively use.
+
+### Use the library in your project
+
+To use the library from ZCS repository you need to have a valid access.
+
+Add the following line to the top of your `requirements.txt` file:
+
+```bash
+--extra-index-url https://europe-west1-python.pkg.dev/ai-accounting-405809/python/simple/
+```
+
+Then add the library `zcs-python-core` to the same file.
+
+In your code, you can import and use the library like this:
+
+```python
+from zcs.core.exception import ZCSException
+```
+
+```python
+from zcs.core.logger import Logger
+```
+
+## Local development
+
+### Run library tests
+
+If you want to run libraray tests against your local docker development environment, you can run:
+
+```bash
+./run.sh -t
+```
+
+### Run tests in a dist docker image
+
+To be sure that anything is going the right way, you can run the library tests against a dist docker image. This will assure that anything is working properly in a fresh installed environment.
+
+```bash
+./run.sh -i
+```
+
+### Other commands and help
+
+```bash
+./run.sh -h
+```
+
+## Support
+
+[Claudio Cavina](mailto:c.cavina@zcscompany.com)  
+[Michele Mondelli](mailto:m.mondelli@zcscompany.com)
diff --git a/app/pyproject.toml b/app/pyproject.toml
@@ -0,0 +1,11 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "zcs-python-core"
+version = "0.1.0"
+description = "A Python library that provides core functionalities for ZCS projects"
+
+[tool.setuptools.packages.find]
+where = ["./src"]
diff --git a/app/requirements.txt b/app/requirements.txt
@@ -0,0 +1,3 @@
+build==1.2.1
+pytest==8.3.3
+
diff --git a/app/src/zcs/core/exception/__init__.py b/app/src/zcs/core/exception/__init__.py
@@ -0,0 +1 @@
+from .exception import ZcsException as ZcsException
diff --git a/app/src/zcs/core/exception/exception.py b/app/src/zcs/core/exception/exception.py
@@ -0,0 +1,37 @@
+import random
+import string
+
+class ZcsException(Exception):
+
+    def __init__(self, user_message, error_source = "Unspecified", status_code = 500, internal_message = None):
+        super().__init__(user_message)
+        
+        self.__error_source = error_source
+        self.__status_code = status_code
+        self.__user_message = user_message
+        self.__internal_message = internal_message
+        self.__error_code = ''.join(random.choices(string.ascii_uppercase + string.digits, k=5))
+
+    def get_status_code(self):
+        return self.__status_code
+    
+    def get_error_source(self):
+        return self.__error_source
+    
+    def get_user_message(self):
+        return self.__user_message
+    
+    def get_internal_message(self):
+        return self.__internal_message
+    
+    def get_error_code(self):
+        return self.__error_code
+
+    def get_as_dict(self):
+        return {
+            'error_code': self.get_error_code(),
+            'user_message': self.get_user_message(),
+            'internal_message': self.get_internal_message(),
+            'error_source': self.get_error_source(),
+            'status_code': self.get_status_code()
+        }
diff --git a/app/src/zcs/core/logger/__init__.py b/app/src/zcs/core/logger/__init__.py
@@ -0,0 +1 @@
+from .logger import ZcsLogging as ZcsLogging
diff --git a/app/src/zcs/core/logger/logger.py b/app/src/zcs/core/logger/logger.py
@@ -0,0 +1,79 @@
+import json
+import logging
+
+class CloudJsonFormatter(logging.Formatter):
+    def format(self, record):
+        log_record = {
+            "severity": record.levelname,
+            "message": record.getMessage(),
+            "time": self.formatTime(record, self.datefmt)
+        }
+        return json.dumps(log_record)
+
+class ConsoleCustomFormatter(logging.Formatter):
+
+    def __init__(self, verbose = False):
+        super().__init__()
+        
+        set_grey = "\x1b[38;20m"
+        set_green = "\x1b[32;20m"
+        set_yellow = "\x1b[33;20m"
+        set_red = "\x1b[31;20m"
+        set_bold_red = "\x1b[31;1m"
+        reset = "\x1b[0m"
+
+        # https://docs.python.org/3/library/logging.html#logrecord-attributes
+        base_format = "%(levelname)-8s %(asctime)s - %(message)s"
+        if verbose:
+            base_format += " (%(filename)s:%(lineno)d)"
+
+        self.FORMATTERS = {
+            logging.DEBUG: logging.Formatter(set_grey + base_format + reset),
+            logging.INFO: logging.Formatter(set_green + base_format + reset),
+            logging.WARNING: logging.Formatter(set_yellow + base_format + reset),
+            logging.ERROR: logging.Formatter(set_red + base_format + reset),
+            logging.CRITICAL: logging.Formatter(set_bold_red + base_format + reset)
+        }
+
+    def format(self, record):
+        formatter = self.FORMATTERS.get(record.levelno)
+        return formatter.format(record)
+
+class ZcsLogging:
+
+    def __init__(self, enable_cloud_logging: bool = True, log_level: str = logging.INFO):
+
+        self.__log_level = log_level
+
+        # Create a custom logger for ZCS application
+        self.__logger = logging.getLogger('zcsapp')
+
+        # Create a custom handler for logging
+        custom_handler = logging.StreamHandler()
+        if enable_cloud_logging:
+            custom_handler.setFormatter(CloudJsonFormatter())
+        else:
+            custom_handler.setFormatter(ConsoleCustomFormatter())
+
+        # Apply custom handler to all configured loggers
+        configured_loggers = [logging.getLogger(name) for name in logging.root.manager.loggerDict]
+        for p_logger in configured_loggers:
+            p_logger.setLevel(self.__log_level)
+            if len(p_logger.handlers) == 0:
+                continue
+            p_logger.handlers = [ custom_handler ]
+        
+        zcs_handler = logging.StreamHandler()
+        if enable_cloud_logging:
+            zcs_handler.setFormatter(CloudJsonFormatter())
+        else:
+            zcs_handler.setFormatter(ConsoleCustomFormatter(True))
+
+        # Set log level and handler for the root logger
+        logging.basicConfig(
+            level=self.__log_level,
+            handlers=[ zcs_handler ]
+        )
+
+    def get_logger(self):
+        return self.__logger
diff --git a/app/tests/zcs/core/exception/exception_test.py b/app/tests/zcs/core/exception/exception_test.py
diff --git a/app/tests/zcs/core/logger/logger_test.py b/app/tests/zcs/core/logger/logger_test.py
diff --git a/docker-compose.yml b/docker-compose.yml
diff --git a/run.sh b/run.sh

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
++
 +PS1='\[\033[01;32m\][\[\033[01;32;4m\]${APP_NAME}\[\033[00m\]\[\033[01;32m\]]\[\033[00m\]:\[\033[01;33m\]\w\[\033[00m\]\$ \[\033[00m\]'
++
 +alias ls="ls --color"
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+build==1.2.1`
	`2`	`+pytest==8.3.3`
	`3`	`+`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+from .exception import ZcsException as ZcsException`