refactor(content-health-monitor): add tests (#259)

* Fix global scope access in content_health_utils.py

* Add unit tests for Python functions

* Add additional tests

* Update README

* Better implementation of shared globals

* Update unit tests to use globals module

* Add integration tests

* Update README.md

* Use a state object

* Update unit tests to use state object

* Refactor integration tests to use pytest and state object

* Fix bad import

* Add a makefile to make running the tests easier

* Update the manifest using the new makefile target

* Update makefile to install rsconnect-python and always use uv

* Update README

* Refactor integration tests to import once at module level, remove unnecessary reimport test

Author: cgraham-rs

extensions/content-health-monitor/Makefile

@@ -0,0 +1,70 @@
+# Makefile for Content Health Monitor
+
+# Default target
+.PHONY: all
+all: setup test
+
+# Setup the virtual environment with dependencies
+.PHONY: setup
+setup:
+	@echo "Setting up virtual environment and installing dependencies..."
+	pip install uv
+	uv venv
+	uv pip install -r requirements.txt
+	uv pip install pytest rsconnect-python
+
+# Run all tests
+.PHONY: test
+test:
+	@echo "Running all tests..."
+	uv run pytest -v
+
+# Run unit tests only
+.PHONY: test-unit
+test-unit:
+	@echo "Running unit tests..."
+	uv run pytest test_content_health_utils.py -v
+
+# Run integration tests only
+.PHONY: test-integration
+test-integration:
+	@echo "Running integration tests..."
+	uv run pytest test_integration.py -v
+
+# Clean up - remove virtual environment and cache files
+.PHONY: clean
+clean:
+	@echo "Cleaning up..."
+	rm -rf .venv
+	rm -rf .pytest_cache
+	rm -rf __pycache__
+	rm -rf *.pyc
+
+# This recipe updates the manifest, with a few helpful modifications:
+# - Uses rsconnect-python to generate the manifest
+# - Explicitly includes the necessary files in the manifest
+# - Copies over `extension` and `environment` blocks from the old manifest to
+#   the new one. These are Gallery-specific blocks, and not created by
+#   rsconnect-python.
+.PHONY: update-manifest
+update-manifest:
+	cp manifest.json manifest.old.json
+	uv run rsconnect write-manifest quarto content-health-monitor.qmd content_health_utils.py --overwrite
+	jq -n --slurpfile old manifest.old.json --slurpfile new manifest.json \
+		'{"version": $$new[0].version, "locale": $$new[0].locale, "metadata": $$new[0].metadata, "extension": $$old[0].extension, "environment": $$old[0].environment} * ($$new[0] | del(.version, .locale, .metadata))' \
+		> manifest.merged.json
+	mv manifest.merged.json manifest.json
+	rm -f manifest.old.json
+
+# Help command to show available targets
+.PHONY: help
+help:
+	@echo "Available targets:"
+	@echo "  setup           - Setup virtual environment and install dependencies"
+	@echo "  test            - Run all tests"
+	@echo "  test-unit       - Run unit tests only"
+	@echo "  test-integration - Run integration tests only"
+	@echo "  clean           - Clean up virtual environment and cache files"
+	@echo "  update-manifest - Update manifest.json preserving extension and environment blocks"
+	@echo "  help            - Show this help message"
+	@echo "  all             - Setup environment and run tests (default)"

extensions/content-health-monitor/README.md

@@ -28,16 +28,31 @@ For more advanced validation, modify the `validate()` function in `content_healt
 
 # Testing
 
-If customizing the code in this report here are some general test scenarios to consider:
-
- - No MONITORED_CONTENT_GUID env var set
-     - If scheduled, DOES NOT send an email
- - Invalid GUID
-     - If scheduled, sends an email
- - Valid GUID for content you are a owner of
- - Valid GUID for content you are a collaborator of
- - Valid GUID for content you are a viewer of
- - Valid GUID for content you do not have access to (not in ACL, etc.)
-     - In the above setup, where the monitored content passing validation, if scheduled, DOES NOT send an email
- - Valid GUID, content is published but fails validation
-     - If scheduled, sends an email
+The Content Health Monitor includes a comprehensive test suite. You can run the tests using the provided Makefile or manually with pytest.
+
+## Using the Makefile
+
+The project includes a Makefile with several targets to simplify common tasks:
+
+```bash
+# Setup environment and install dependencies
+make setup
+
+# Run all tests
+make test
+
+# Run only unit tests
+make test-unit
+
+# Run only integration tests
+make test-integration
+
+# Update manifest.json (preserves extension and environment blocks)
+make update-manifest
+
+# Show help with all available targets
+make help
+
+# Clean up virtual environment and cache files
+make clean
+```

extensions/content-health-monitor/content-health-monitor.qmd

@@ -16,33 +16,35 @@ import datetime
 from posit import connect
 from IPython.display import HTML, display
 from content_health_utils import *
+from content_health_utils import MonitorState
 
-# Initialize state variables
-show_instructions = False  # Used to display on-screen setup instructions if environment variables are missing
-instructions = []         # List to store setup instructions for the user
+# Create state object to share between this file and utils
+state = MonitorState()
+
+# Initialize state variables that are only used in this Quarto document
 show_error = False        # Used to display on-screen error messages if API errors occur
 error_message = None      # Error message to display if API errors occur
 error_guid = None         # GUID that caused the error
 content_result = None     # Variable to store content monitoring result
 
 # Read environment variables
-connect_server = get_env_var("CONNECT_SERVER") # Automatically provided by Connect, must be set when previewing locally
-api_key = get_env_var("CONNECT_API_KEY") # Automatically provided by Connect, must be set when previewing locally
-monitored_content_guid = get_env_var("MONITORED_CONTENT_GUID")
+connect_server = get_env_var("CONNECT_SERVER", state) # Automatically provided by Connect, must be set when previewing locally
+api_key = get_env_var("CONNECT_API_KEY", state) # Automatically provided by Connect, must be set when previewing locally
+monitored_content_guid = get_env_var("MONITORED_CONTENT_GUID", state)
 
 # Extract GUID if it's a string or URL containing a GUID
 if monitored_content_guid:
     monitored_content_guid = extract_guid(monitored_content_guid)
 
 # Only instantiate the client if we have the required environment variables
 client = None
-if not show_instructions:
+if not state.show_instructions:
     try:
         # Instantiate a Connect client using posit-sdk where api_key and url are automatically read from our environment vars
         client = connect.Client()
     except ValueError as e:
-        show_instructions = True
-        instructions.append(f"<b>Error initializing Connect client:</b> {str(e)}")
+        state.show_instructions = True
+        state.instructions.append(f"<b>Error initializing Connect client:</b> {str(e)}")
 
 
 # ------ DATA GATHERING SECTION ------ #
@@ -53,7 +55,7 @@ check_time = datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S')
 current_user_name = "the publisher"  # Default, used if no name is available
 
 # Get current user's full name if client is available
-if not show_instructions and client:
+if not state.show_instructions and client:
     try:
         user_name = get_current_user_full_name(client)
         if user_name:  # Only update if we got a valid name
@@ -62,8 +64,8 @@ if not show_instructions and client:
         print(f"Warning: Could not get current user name: {str(e)}")
 
 # Only proceed with content validation if we have all requirements
-# (show_instructions=False already tells us env vars are set and client was initialized)
-if not show_instructions:
+# (state.show_instructions=False already tells us env vars are set and client was initialized)
+if not state.show_instructions:
     try:
         # Check if server is reachable
         check_server_reachable(connect_server, api_key)
@@ -95,17 +97,17 @@ content becomes unreachable.
 
 
 # Prepare instructions HTML if needed
-if show_instructions:
-    instructions_html = "".join(f"<div style='margin-bottom: 10px;'>{instruction}</div>" for instruction in instructions)
+if state.show_instructions:
+    instructions_html = "".join(f"<div style='margin-bottom: 10px;'>{instruction}</div>" for instruction in state.instructions)
 else:
     instructions_html = None
 
 # Create all HTML components up front based on state
 html_components = {
-    'instructions': create_instructions_box(instructions_html) if show_instructions else None,
+    'instructions': create_instructions_box(instructions_html) if state.show_instructions else None,
     'error': create_error_box(error_guid, error_message) if show_error else None,
     'report': create_report_display(content_result, check_time, current_user_name) if content_result and not has_error(content_result) else None,
-    'no_results': create_no_results_box() if not (show_instructions or show_error or 
+    'no_results': create_no_results_box() if not (state.show_instructions or show_error or 
                                               (content_result and not has_error(content_result))) else None
 }
 

extensions/content-health-monitor/content_health_utils.py

@@ -4,6 +4,16 @@
 import requests
 from posit import connect
 
+class MonitorState:
+    """State container for content health monitor"""
+    
+    def __init__(self):
+        """Initialize with default values"""
+        # Flag to indicate if setup instructions should be displayed
+        self.show_instructions = False
+        # List to store setup instructions for the user
+        self.instructions = []
+
 # Define status constants
 STATUS_PASS = "PASS"
 STATUS_FAIL = "FAIL"
@@ -45,16 +55,11 @@
 CSS_GRID_STYLE = "display: grid; grid-template-columns: 150px auto; grid-gap: 8px; padding: 10px 0;"
 
 # Helper function to read environment variables and add instructions if missing
-def get_env_var(var_name, description=""):
+def get_env_var(var_name, state, description=""):
     """Get environment variable and add instruction if missing"""
-    # These variables are defined in the Quarto document
-    # We'll need to use them from the global scope
-    import sys
-    caller_globals = sys._getframe(1).f_globals
-    
     value = os.environ.get(var_name, "")
     if not value:
-        caller_globals["show_instructions"] = True
+        state.show_instructions = True
 
         # Generic instruction for most variables
         if var_name != "MONITORED_CONTENT_GUID":
@@ -69,7 +74,7 @@ def get_env_var(var_name, description=""):
 
         if description:
             instruction += f" {description}"
-        caller_globals["instructions"].append(instruction)
+        state.instructions.append(instruction)
     return value
 
 # Helper function to extract error messages from exceptions

extensions/content-health-monitor/manifest.json

@@ -4,7 +4,7 @@
   "metadata": {
     "appmode": "quarto-static"
   },
-    "extension": {
+  "extension": {
     "name": "content-health-monitor",
     "title": "Content Health Monitor",
     "description": "This report uses the publisher’s API key to monitor a single piece of content. It checks whether the content is reachable, but does not validate its functionality. When scheduled to run regularly, it will send an email alert if the content becomes unreachable.",
@@ -23,7 +23,7 @@
     }
   },
   "quarto": {
-    "version": "1.4.557",
+    "version": "1.6.43",
     "engines": [
       "jupyter"
     ]
@@ -32,16 +32,19 @@
     "version": "3.11.7",
     "package_manager": {
       "name": "pip",
-      "version": "23.2.1",
+      "version": "25.1.1",
       "package_file": "requirements.txt"
     }
   },
   "files": {
     "requirements.txt": {
-      "checksum": "09254fc2dfa7d869ffbc3da2abb1d224"
+      "checksum": "5f89d52674b219c0b0ed85f1a5785641"
     },
     "content-health-monitor.qmd": {
-      "checksum": "732af0f4ea846c37d3a7641c3bbd6ba3"
+      "checksum": "7a31430ef0d92505829e214ac85f8633"
+    },
+    "content_health_utils.py": {
+      "checksum": "73627372e41f90a2259ea5c0969d19a9"
     }
   }
 }