Merge pull request #46 from rnetser/align_code

4.11 - Align code to main

Author: myakove

.flake8

@@ -1,5 +1,4 @@
 [flake8]
-max-line-length = 120
 exclude =
     doc,
     .tox,
@@ -10,9 +9,9 @@ exclude =
     .cache/*
 
 enable-extensions =
-    FCFN,
+    FCN,
 
-fcfn_exclude_functions =
+fcn_exclude_functions =
     LOGGER,
     os,
     fd,

.github/workflows/create-auto-pr-for-merge-pr-in-main.yml.xxx

@@ -12,7 +12,7 @@ repos:
           - --remove-all-unused-imports
 
   - repo: https://github.com/hadialqattan/pycln
-    rev: "v1.2.5"
+    rev: "v2.1.1"
     hooks:
         - id: pycln
 
@@ -22,12 +22,12 @@ repos:
       - id: isort
 
   - repo: https://github.com/psf/black
-    rev: "22.3.0"
+    rev: "22.6.0"
     hooks:
     - id: black
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: "v4.1.0"
+    rev: "v4.3.0"
     hooks:
     - id: check-merge-conflict
     - id: debug-statements
@@ -38,16 +38,17 @@ repos:
     - id: check-builtin-literals
 
   - repo: https://github.com/PyCQA/flake8
-    rev: "4.0.1"
+    rev: "5.0.4"
     hooks:
       - id: flake8
+        args: [--max-line-length=120]
         additional_dependencies: [
           "git+https://github.com/RedHatQE/flake8-plugins.git",
           "pep8-naming",
           "flake8-mutable",
         ]
 
   - repo: https://github.com/Yelp/detect-secrets
-    rev: v1.2.0
+    rev: v1.3.0
     hooks:
       - id: detect-secrets

.github/workflows/upload-to-pypi.yml.xxxx

@@ -1,6 +1,6 @@
-class ClusterSanityError(Exception):
-    def __init__(self, err_str):
-        self.err_str = err_str
+class NodeNotReadyError(Exception):
+    pass
 
-    def __str__(self):
-        return self.err_str
+
+class NodeUnschedulableError(Exception):
+    pass

.pre-commit-config.yaml

@@ -1,87 +1,43 @@
-import logging
-import subprocess
+from ocp_utilities.exceptions import NodeNotReadyError, NodeUnschedulableError
+from ocp_utilities.logger import get_logger
 
-import kubernetes as kubernetes
-from kubernetes.dynamic import DynamicClient
 
-from ocp_utilities.exceptions import ClusterSanityError
+LOGGER = get_logger(name=__name__)
 
 
-LOGGER = logging.getLogger(__name__)
-
-
-def validate_nodes_ready(nodes):
+def assert_nodes_ready(nodes):
     """
     Validates all nodes are in ready
 
     Args:
          nodes(list): List of Node objects
 
     Raises:
-        AssertionError: Assert on node(s) in not ready state
+        NodeNotReadyError: Assert on node(s) in not ready state
     """
     LOGGER.info("Verify all nodes are ready.")
     not_ready_nodes = [node.name for node in nodes if not node.kubelet_ready]
     if not_ready_nodes:
-        raise ClusterSanityError(
-            err_str=f"Following nodes are not in ready state: {not_ready_nodes}",
+        raise NodeNotReadyError(
+            f"Following nodes are not in ready state: {not_ready_nodes}"
         )
 
 
-def validate_nodes_schedulable(nodes):
+def assert_nodes_schedulable(nodes):
     """
     Validates all nodes are in schedulable state
 
     Args:
          nodes(list): List of Node objects
 
     Raises:
-        AssertionError: Asserts on node(s) not schedulable
+        NodeUnschedulableError: Asserts on node(s) not schedulable
     """
     LOGGER.info("Verify all nodes are schedulable.")
     unschedulable_nodes = [
         node.name for node in nodes if node.instance.spec.unschedulable
     ]
     if unschedulable_nodes:
-        raise ClusterSanityError(
-            err_str=f"Following nodes are in unschedulable state: {unschedulable_nodes}",
+        raise NodeUnschedulableError(
+            f"Following nodes are in unscheduled state: {unschedulable_nodes}"
         )
-
-
-def get_admin_client():
-    return DynamicClient(client=kubernetes.config.new_client_from_config())
-
-
-def run_command(command, verify_stderr=True, shell=False):
-    """
-    Run command locally.
-
-    Args:
-        command (list): Command to run
-        verify_stderr (bool, default True): Check command stderr
-        shell (bool, default False): run subprocess with shell toggle
-
-    Returns:
-        tuple: True, out if command succeeded, False, err otherwise.
-    """
-    sub_process = subprocess.Popen(
-        command,
-        stdout=subprocess.PIPE,
-        stderr=subprocess.PIPE,
-        shell=shell,
-    )
-    out, err = sub_process.communicate()
-    out_decoded = out.decode("utf-8")
-    err_decoded = err.decode("utf-8")
-
-    error_msg = f"Failed to run {command}. rc: {sub_process.returncode}, out: {out_decoded}, error: {err_decoded}"
-    if sub_process.returncode != 0:
-        LOGGER.error(error_msg)
-        return False, out_decoded, err_decoded
-
-    # From this point and onwards we are guaranteed that sub_process.returncode == 0
-    if err_decoded and verify_stderr:
-        LOGGER.error(error_msg)
-        return False, out_decoded, err_decoded
-
-    return True, out_decoded, err_decoded

ocp_utilities/exceptions.py

@@ -1,5 +1,6 @@
 import logging
-import shutil
+import os
+from datetime import datetime
 from logging.handlers import RotatingFileHandler
 
 from colorlog import ColoredFormatter
@@ -26,23 +27,20 @@ def filter(self, record):
         return False
 
 
-def separator(symbol_, val=None):
-    terminal_width = shutil.get_terminal_size(fallback=(120, 40))[0]
-    if not val:
-        return f"{symbol_ * terminal_width}"
+class BaseLogFormatter(ColoredFormatter):
+    def formatTime(self, record, datefmt=None):  # noqa: N802
+        return datetime.fromtimestamp(record.created).isoformat()
 
-    sepa = int((terminal_width - len(val) - 2) // 2)
-    return f"{symbol_ * sepa} {val} {symbol_ * sepa}"
 
+def get_logger(name):
+    log_level = os.environ.get("OPENSHIFT_PYTHON_UTILITIES_LOG_LEVEL", "INFO")
+    log_file = os.environ.get("OPENSHIFT_PYTHON_UTILITIES_LOG_FILE", "")
+    if log_level not in ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"]:
+        raise ValueError(f"Invalid log level: {log_level}")
 
-def setup_logging(log_level, log_file="/tmp/pytest-tests.log"):
-    logger_obj = logging.getLogger()
-    basic_logger = logging.getLogger("basic")
-
-    root_log_formatter = logging.Formatter(fmt="%(message)s")
-    log_formatter = ColoredFormatter(
-        fmt="%(name)s %(asctime)s %(log_color)s%(levelname) s%(reset)s %(message)s",
-        datefmt="%Y-%m-%d %H:%M:%S",
+    logger_obj = logging.getLogger(name)
+    log_formatter = BaseLogFormatter(
+        fmt="%(asctime)s %(name)s %(log_color)s%(levelname)s%(reset)s %(message)s",
         log_colors={
             "DEBUG": "cyan",
             "INFO": "green",
@@ -54,29 +52,20 @@ def setup_logging(log_level, log_file="/tmp/pytest-tests.log"):
     )
 
     console_handler = logging.StreamHandler()
-    log_handler = RotatingFileHandler(
-        filename=log_file, maxBytes=100 * 1024 * 1024, backupCount=20
-    )
-    basic_console_handler = logging.StreamHandler()
-    basic_log_handler = RotatingFileHandler(
-        filename=log_file, maxBytes=100 * 1024 * 1024, backupCount=20
-    )
-
-    basic_log_handler.setFormatter(fmt=root_log_formatter)
-    basic_console_handler.setFormatter(fmt=root_log_formatter)
-    basic_logger.addHandler(hdlr=basic_log_handler)
-    basic_logger.addHandler(hdlr=basic_console_handler)
-    basic_logger.setLevel(level=log_level)
-
-    log_handler.setFormatter(fmt=log_formatter)
     console_handler.setFormatter(fmt=log_formatter)
+    console_handler.addFilter(filter=DuplicateFilter())
 
     logger_obj.addHandler(hdlr=console_handler)
-    logger_obj.addHandler(hdlr=log_handler)
     logger_obj.setLevel(level=log_level)
-
     logger_obj.addFilter(filter=DuplicateFilter())
-    console_handler.addFilter(filter=DuplicateFilter())
+
+    if log_file:
+        log_handler = RotatingFileHandler(
+            filename=log_file, maxBytes=100 * 1024 * 1024, backupCount=20
+        )
+        log_handler.setFormatter(fmt=log_formatter)
+        log_handler.setLevel(level=log_level)
+        logger_obj.addHandler(hdlr=log_handler)
 
     logger_obj.propagate = False
-    basic_logger.propagate = False
+    return logger_obj