Define errors log location and name it with product & version

Author: yma955

charon/cmd/command.py

@@ -15,10 +15,11 @@
 """
 from typing import List
 from charon.config import CharonConfig, get_config
-from charon.utils.logs import set_logging, getLogger
+from charon.utils.logs import set_logging, set_log_file_handler
 from charon.utils.archive import detect_npm_archive, download_archive, NpmArchiveType
 from charon.pkgs.maven import handle_maven_uploading, handle_maven_del
 from charon.pkgs.npm import handle_npm_uploading, handle_npm_del
+from charon.utils.product_version import ProductVersion
 from click import command, option, argument, group
 from json import loads
 from shutil import rmtree
@@ -28,7 +29,7 @@
 import os
 import sys
 
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 @argument(
@@ -124,6 +125,7 @@ def upload(
     Service. The REPO points to a product released tarball which
     is hosted in a remote url or a local path.
     """
+    set_log_file_handler(logger, ProductVersion(product, version))
     tmp_dir = work_dir
     try:
         if dryrun:
@@ -277,6 +279,7 @@ def delete(
     Ronda Service. The REPO points to a product released
     tarball which is hosted in a remote url or a local path.
     """
+    set_log_file_handler(logger, ProductVersion(product, version))
     tmp_dir = work_dir
     try:
         if dryrun:

charon/config.py

@@ -16,14 +16,16 @@
 from typing import Dict, List
 from ruamel.yaml import YAML
 from pathlib import Path
-from charon.utils.logs import getLogger
+from charon.utils.logs import set_log_file_handler
 import os
+import logging
 
 from charon.utils.strings import remove_prefix
+from charon.utils.product_version import ProductVersion
 
 CONFIG_FILE = "charon.yaml"
 
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 class CharonConfig(object):
@@ -74,6 +76,7 @@ def get_bucket_prefix(self, target: str) -> str:
 
 
 def get_config() -> CharonConfig:
+    set_log_file_handler(logger, ProductVersion())
     config_file = os.path.join(os.getenv("HOME"), ".charon", CONFIG_FILE)
     try:
         yaml = YAML(typ='safe')

charon/constants.py

@@ -175,3 +175,5 @@
 '''
 
 PROD_INFO_SUFFIX = ".prodinfo"
+
+DEFAULT_ERRORS_LOG = "errors.log"

charon/pkgs/indexing.py

@@ -17,14 +17,14 @@
 from charon.storage import S3Client
 from charon.constants import (INDEX_HTML_TEMPLATE, NPM_INDEX_HTML_TEMPLATE,
                               PACKAGE_TYPE_MAVEN, PACKAGE_TYPE_NPM, PROD_INFO_SUFFIX)
-from charon.utils.logs import getLogger
 from jinja2 import Template
 import os
+import logging
 from typing import List, Set
 
 from charon.utils.strings import remove_prefix
 
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 def __get_index_template(package_type: str) -> str:

charon/pkgs/maven.py

@@ -25,19 +25,21 @@
                               META_FILE_FAILED, MAVEN_METADATA_TEMPLATE,
                               ARCHETYPE_CATALOG_TEMPLATE, ARCHETYPE_CATALOG_FILENAME,
                               PACKAGE_TYPE_MAVEN)
-from charon.utils.logs import getLogger
+from charon.utils.logs import set_log_file_handler
+from charon.utils.product_version import ProductVersion
 from typing import Dict, List, Tuple
 from jinja2 import Template
 from datetime import datetime
 from zipfile import ZipFile, BadZipFile
 from tempfile import mkdtemp
 from defusedxml import ElementTree
 
+import logging
 import os
 import sys
 import re
 
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 def __get_mvn_template(kind: str, default: str) -> str:
@@ -278,6 +280,7 @@ def handle_maven_uploading(
 
         Returns the directory used for archive processing.
     """
+    set_log_file_handler(logger, ProductVersion())
     # 1. extract tarball
     tmp_root = _extract_tarball(repo, prod_key, dir__=dir_)
 
@@ -414,6 +417,7 @@ def handle_maven_del(
 
         Returns the directory used for archive processing.
     """
+    set_log_file_handler(logger, ProductVersion())
     # 1. extract tarball
     tmp_root = _extract_tarball(repo, prod_key, dir__=dir_)
 

charon/pkgs/npm.py

@@ -28,9 +28,12 @@
 from charon.utils.archive import extract_npm_tarball
 from charon.pkgs.pkg_utils import upload_post_process, rollback_post_process
 from charon.utils.strings import remove_prefix
-from charon.utils.logs import getLogger
+from charon.utils.logs import set_log_file_handler
+from charon.utils.product_version import ProductVersion
 
-logger = getLogger(__name__)
+import logging
+
+logger = logging.getLogger(__name__)
 
 PACKAGE_JSON = "package.json"
 
@@ -80,6 +83,7 @@ def handle_npm_uploading(
 
         Returns the directory used for archive processing.
     """
+    set_log_file_handler(logger, ProductVersion())
     target_dir, valid_paths, package_metadata = _scan_metadata_paths_from_archive(
         tarball_path, prod=product, dir__=dir_
     )
@@ -160,6 +164,7 @@ def handle_npm_del(
 
         Returns the directory used for archive processing
     """
+    set_log_file_handler(logger, ProductVersion())
     target_dir, package_name_path, valid_paths = _scan_paths_from_archive(
         tarball_path, prod=product, dir__=dir_
     )

charon/pkgs/pkg_utils.py

@@ -1,8 +1,10 @@
 from typing import List
-from charon.utils.logs import getLogger
+from charon.utils.logs import set_log_file_handler
+from charon.utils.product_version import ProductVersion
 import sys
+import logging
 
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 def is_metadata(file: str) -> bool:
@@ -34,6 +36,7 @@ def __post_process(
     product_key: str,
     operation: str
 ):
+    set_log_file_handler(logger, ProductVersion())
     if len(failed_files) == 0 and len(failed_metas) == 0:
         logger.info("Product release is successfully %s "
                     " %s Ronda service.", operation, product_key)

charon/storage.py

@@ -15,7 +15,8 @@
 """
 from boto3_type_annotations.s3.service_resource import Object
 from charon.utils.files import read_sha1
-from charon.utils.logs import getLogger
+from charon.utils.logs import set_log_file_handler
+from charon.utils.product_version import ProductVersion
 from charon.constants import PROD_INFO_SUFFIX
 
 from boto3 import session
@@ -26,8 +27,9 @@
 from typing import Callable, Dict, List, Optional, Tuple
 import os
 import mimetypes
+import logging
 
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 PRODUCT_META_KEY = "rh-products"
 CHECKSUM_META_KEY = "checksum"
@@ -47,6 +49,7 @@ def __init__(self, aws_profile=None, extra_conf=None, dry_run=False) -> None:
         self.__client: s3.ServiceResource = self.__init_aws_client(aws_profile, extra_conf)
         self.__bucket: s3.Bucket = None
         self.__dry_run = dry_run
+        set_log_file_handler(logger, ProductVersion())
 
     def __init_aws_client(
         self, aws_profile=None, extra_conf=None, enable_acc=False

charon/utils/archive.py

@@ -19,13 +19,15 @@
 import requests
 import tempfile
 import shutil
+import logging
 from enum import Enum
 from json import load, JSONDecodeError
 from typing import Tuple
 from zipfile import ZipFile, is_zipfile
-from charon.utils.logs import getLogger
+from charon.utils.logs import set_log_file_handler
+from charon.utils.product_version import ProductVersion
 
-logger = getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 def extract_zip_all(zf: ZipFile, target_dir: str):
@@ -82,6 +84,7 @@ def _get_tgz_name(path: str):
 
 
 def __parse_npm_package_version_paths(path: str) -> list:
+    set_log_file_handler(logger, ProductVersion())
     try:
         with open(path, encoding='utf-8') as version_package:
             data = load(version_package)
@@ -105,7 +108,7 @@ def detect_npm_archive(repo):
     :parameter repo repository directory
     :return NpmArchiveType value
     """
-
+    set_log_file_handler(logger, ProductVersion())
     expanded_repo = os.path.expanduser(repo)
     if not os.path.exists(expanded_repo):
         logger.error("Repository %s does not exist!", expanded_repo)

charon/utils/logs.py

@@ -15,18 +15,19 @@
 """
 import logging
 import sys
+import os
 from locale import nl_langinfo, CODESET
-from os import fdopen, dup
 
-from charon.constants import CHARON_LOGGING_FMT
+from charon.constants import CHARON_LOGGING_FMT, DEFAULT_ERRORS_LOG
+from charon.utils.product_version import ProductVersion
 
 
 class EncodedStream(object):
     # The point of this class is to force python to encode UTF-8
     # over stderr.  Normal techniques were not working, so we dup
     # the file handler and force it UTF-8.  :-(
     def __init__(self, fileno, encoding):
-        self.binarystream = fdopen(dup(fileno), 'wb')
+        self.binarystream = os.fdopen(os.dup(fileno), 'wb')
         self.encoding = encoding
 
     def write(self, text):
@@ -74,13 +75,16 @@ def set_logging(name="charon", level=logging.DEBUG, handler=None):
         hdlr.setFormatter(formatter)
 
 
-def getLogger(name: str) -> logging:
-    error_log = "./errors.log"
+def set_log_file_handler(logger: logging, pv: ProductVersion):
+    log_loc = os.getenv("ERROR_LOG_LOCATION")
+    error_log = DEFAULT_ERRORS_LOG
+    if pv.get_product() and pv.get_version():
+        error_log = "".join([pv.get_product(), "-", pv.get_version(), ".", DEFAULT_ERRORS_LOG])
+    if log_loc:
+        os.makedirs(log_loc, exist_ok=True)
+        error_log = os.path.join(log_loc, error_log)
     handler = logging.FileHandler(error_log)
-    formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+    formatter = logging.Formatter(fmt=CHARON_LOGGING_FMT)
     handler.setFormatter(formatter)
     handler.setLevel(logging.WARN)
-
-    logger = logging.getLogger(name)
     logger.addHandler(handler)
-    return logger