Merge pull request #69 from cdot65/67-implement-post-upgrade-snapshot…

…s-and-configuration-backups-with-diff-support

67 implement post upgrade snapshots and configuration backups with diff support

docker/Dockerfile

@@ -14,8 +14,8 @@ WORKDIR /app
 ADD settings.yaml /app
 
 # Install any needed packages specified in requirements.txt
-# Note: The requirements.txt should contain pan-os-upgrade==1.1.0
-RUN pip install --no-cache-dir pan-os-upgrade==1.1.0
+# Note: The requirements.txt should contain pan-os-upgrade==1.1.1
+RUN pip install --no-cache-dir pan-os-upgrade==1.1.1
 
 # Set the locale to avoid issues with emoji rendering
 ENV LANG C.UTF-8

docs/about/release-notes.md

@@ -2,10 +2,19 @@
 
 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 1.1.1
+
+**Release Date:** *<20240204>*
+
+### What's New
+
+- Fixed a bug that prevented access to the `logo.png` file used by the PDF generation process
+
 ## Version 1.1.0
 
 **Release Date:** *<20240204>*
 
+<!-- trunk-ignore(markdownlint/MD024) -->
 ### What's New
 
 - Pre/Post upgrade diff report created in PDF format

pan_os_upgrade/upgrade.py

@@ -72,6 +72,7 @@
 
 
 # standard library imports
+import importlib.resources as pkg_resources
 import ipaddress
 import json
 import logging
@@ -2969,11 +2970,13 @@ def generate_diff_report_pdf(
     content = []
     styles = getSampleStyleSheet()
 
-    # Custom Banner with Logo and Styling
-    logo = "assets/logo.png"
-    img = Image(logo, width=71, height=51)
-    img.hAlign = "LEFT"
-    content.append(img)
+    # Accessing logo.png using importlib.resources, creating a custom banner with logo and styling
+    with pkg_resources.files("pan_os_upgrade.assets").joinpath("logo.png") as logo_path:
+        img = Image(
+            str(logo_path), width=71, height=51
+        )  # Convert Traversable object to string for Image path
+        img.hAlign = "LEFT"
+        content.append(img)
 
     banner_style = styles["Title"]
     banner_style.fontSize = 24