Merge pull request #47 from cdot65/46-duplicate-log-entries-in-script…

…-execution-due-to-logger-propagation

Refactor logging configuration

docker/Dockerfile

@@ -10,12 +10,9 @@ RUN apk add --no-cache gcc musl-dev libffi-dev make
 # Set the working directory in the container to /app
 WORKDIR /app
 
-# Copy the requirements file into the container at /app
-COPY requirements.txt /app/
-
 # Install any needed packages specified in requirements.txt
-# Note: The requirements.txt should contain pan-os-upgrade==0.2.3
-RUN pip install --no-cache-dir pan-os-upgrade==0.2.3
+# Note: The requirements.txt should contain pan-os-upgrade==0.2.4
+RUN pip install --no-cache-dir pan-os-upgrade==0.2.4
 
 # Set the locale to avoid issues with emoji rendering
 ENV LANG C.UTF-8

docs/about/release-notes.md

@@ -2,10 +2,21 @@
 
 Welcome to the release notes for the `pan-os-upgrade` tool. This document provides a detailed record of changes, enhancements, and fixes in each version of the tool.
 
-## Version 0.2.3
+## Version 0.2.4
+
+**Release Date:** *<20240122>*
+
+### What's New
+
+- Resolved a bug where console logging was duplicated
+- Simplified the non-debug console log output
+- Removed `requirements.txt` from Docker container image
+
+## Version 0.2.4
 
 **Release Date:** *<20240121>*
 
+<!-- trunk-ignore(markdownlint/MD024) -->
 ### What's New
 
 - Improved error handling for network layer transport.
@@ -15,6 +26,7 @@ Welcome to the release notes for the `pan-os-upgrade` tool. This document provid
 
 **Release Date:** *<20240121>*
 
+<!-- trunk-ignore(markdownlint/MD024) -->
 ### What's New
 
 - Optimized for Docker execution.
@@ -24,6 +36,7 @@ Welcome to the release notes for the `pan-os-upgrade` tool. This document provid
 
 **Release Date:** *<20240121>*
 
+<!-- trunk-ignore(markdownlint/MD024) -->
 ### What's New
 
 - Adjusting the execution of our script to instead reference the Typer app `app()` instead of `main()`.
@@ -33,6 +46,7 @@ Welcome to the release notes for the `pan-os-upgrade` tool. This document provid
 
 **Release Date:** *<20240121>*
 
+<!-- trunk-ignore(markdownlint/MD024) -->
 ### What's New
 
 - Allow for simply running `pan-os-upgrade` without arguments, providing an interactive prompt for missing variables
@@ -50,7 +64,8 @@ Welcome to the release notes for the `pan-os-upgrade` tool. This document provid
 
 **Release Date:** *<20240119>*
 
-### Highlights
+<!-- trunk-ignore(markdownlint/MD024) -->
+### What's New
 
 - First official release of the `pan-os-upgrade` tool on PyPi.
 - Made available for wide usage and distribution.

pan_os_upgrade/upgrade.py

@@ -267,10 +267,14 @@ def configure_logging(level: str) -> None:
     """
     logging_level = getattr(logging, level.upper(), None)
 
-    # Create a logger
+    # Get the root logger
     logger = logging.getLogger()
     logger.setLevel(logging_level)
 
+    # Remove any existing handlers
+    for handler in logger.handlers[:]:
+        logger.removeHandler(handler)
+
     # Create handlers (console and file handler)
     console_handler = logging.StreamHandler()
     file_handler = RotatingFileHandler(
@@ -288,12 +292,11 @@ def configure_logging(level: str) -> None:
             "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
         )
     else:
-        console_format = logging.Formatter(
-            "%(levelname)s - %(message)s",
-        )
+        console_format = logging.Formatter("%(message)s")
         file_format = logging.Formatter(
             "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
         )
+
     console_handler.setFormatter(console_format)
     file_handler.setFormatter(file_format)
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pan-os-upgrade"
-version = "0.2.3"
+version = "0.2.4"
 description = "Python script to automate the upgrade process of PAN-OS firewalls."
 authors = ["Calvin Remsburg <cremsburg.dev@gmail.com>"]
 license = "Apache 2.0"