timestamp consistency

Author: hovey

.github/workflows/pylint.yml

@@ -64,6 +64,7 @@ jobs:
         python src/rattlesnake/cicd/report_pylint.py \
           --input_file ${{ env.PYLINT_OUTPUT_FILE }} \
           --output_file pylint_report.html \
+          --timestamp ${{ env.TIMESTAMP }} \
           --run_id ${{ github.run_id }} \
           --ref_name ${{ github.ref_name }} \
           --github_sha ${{ github.sha }} \

src/rattlesnake/cicd/report_pylint.py

@@ -15,7 +15,7 @@
 
 # import pytz  # unused import
 
-from rattlesnake.cicd.utilities import get_score_color, get_timestamp
+from rattlesnake.cicd.utilities import get_score_color, extend_timestamp
 
 
 # def get_timestamp() -> str:
@@ -180,6 +180,7 @@ def get_report_html(
     issues: List[str],
     summary_lines: List[str],
     pylint_score: str,
+    timestamp: str,
     run_id: str,
     ref_name: str,
     github_sha: str,
@@ -201,7 +202,8 @@ def get_report_html(
     Returns:
         Complete HTML report as string
     """
-    timestamp: str = get_timestamp()
+    # timestamp: str = get_timestamp()
+    timestamp_ext: str = extend_timestamp(short=timestamp)
     score_color: str = get_score_color(pylint_score)
     issue_counts: Dict[str, int] = get_issue_counts(issues)
     issues_html: str = get_issues_list_html(issues)
@@ -286,7 +288,7 @@ def get_report_html(
             <h1>Rattlesnake Pylint Report</h1>
             <div class="score">{pylint_score}/10</div>
             <div class="metadata">
-                <div><strong>Generated:</strong> {timestamp}</div>
+                <div><strong>Generated:</strong> {timestamp_ext}</div>
                 <div><strong>Run ID:</strong> <a href="https://github.com/{github_repo}/actions/runs/{run_id}"> {run_id}</a></div>
                 <div><strong>Branch:</strong> <a href="https://github.com/{github_repo}/tree/{ref_name}"> {ref_name}</a></div>
                 <div><strong>Commit:</strong> <a href="https://github.com/{github_repo}/commit/{github_sha}"> {github_sha[:7]}</a></div>
@@ -365,6 +367,7 @@ def write_report(html_content: str, output_file: str) -> None:
 def run_pylint_report(
     input_file: str,
     output_file: str,
+    timestamp: str,
     run_id: str,
     ref_name: str,
     github_sha: str,
@@ -376,6 +379,8 @@ def run_pylint_report(
     Args:
         input_file: Path to the pylint output text file
         output_file: Path for the generated HTML report
+        timestamp: The timestampe from bash when pylint ran, in format YYYYMMDD_HHMMSS_UTC
+            e.g., 20250815_211112_UTC
         run_id: GitHub Actions run ID
         ref_name: Git reference name (branch)
         github_sha: GitHub commit SHA
@@ -399,6 +404,7 @@ def run_pylint_report(
         issues,
         summary_lines,
         pylint_score,
+        timestamp,
         run_id,
         ref_name,
         github_sha,
@@ -429,6 +435,7 @@ def parse_arguments() -> argparse.Namespace:
   python pylint_report.py \
     --input_file pylint_output_20240101_120000_UTC.txt \
     --output_file pylint_report.html \
+    --timestamp 20240101_120000_UTC \
     --run_id 1234567890 \
     --ref_name main \
     --github_sha abc123def456 \
@@ -440,6 +447,10 @@ def parse_arguments() -> argparse.Namespace:
 
     parser.add_argument("--output_file", required=True, help="Output HTML report file")
 
+    parser.add_argument(
+        "--timestamp", required=True, help="UTC timestamp, e.g., 20240101_120000_UTC"
+    )
+
     parser.add_argument("--run_id", required=True, help="GitHub Actions run ID")
 
     parser.add_argument(
@@ -468,6 +479,7 @@ def main() -> int:
         total_issues, issue_counts, pylint_score = run_pylint_report(
             args.input_file,
             args.output_file,
+            args.timestamp,
             args.run_id,
             args.ref_name,
             args.github_sha,

src/rattlesnake/cicd/utilities.py

@@ -5,6 +5,7 @@
 
 from datetime import datetime
 import pytz
+import re
 
 
 def get_score_color(pylint_score: str) -> str:
@@ -75,12 +76,28 @@ def extend_timestamp(short: str) -> str:
         Extended timestamp, for example
         2025-08-15 21:11:12 UTC (2025-08-15 17:11:12 EST / 2025-08-15 15:11:12 MST)
     """
-    # The format of the input timestamp
+    # Regex pattern to match the required format: YYYYMMDD_HHMMSS_TZ
+    # The timezone abbreviation must be 'UTC', 'GMT', or 'Z'
+    pattern: re.Pattern = re.compile(r"^(\d{8})_(\d{6})_(UTC|GMT|Z)$")
+    match = pattern.match(short)
+
+    if not match:
+        raise ValueError(
+            f"Invalid timestamp format: '{short}'. "
+            f"Expected format is YYYYMMDD_HHMMSS_TZ, where TZ is one of UTC, GMT, or Z."
+        )
+
+    # Extract the date and time parts from the regex match
+    date_part, time_part, _ = match.groups()
+
+    # Combine the parts into a format that can be parsed by datetime
+    datetime_str: str = f"{date_part}_{time_part}_UTC"
     input_format: str = "%Y%m%d_%H%M%S_%Z"
 
     # Convert the input string to a datetime object
-    utc_datetime: datetime = datetime.strptime(short, input_format)
-    # The datetime object is naive, so we make it timezone-aware
+    utc_datetime: datetime = datetime.strptime(datetime_str, input_format)
+
+    # Make the datetime object timezone-aware
     utc_now: datetime = pytz.utc.localize(utc_datetime)
 
     # Define the time zones
@@ -92,12 +109,71 @@ def extend_timestamp(short: str) -> str:
     mst_now: datetime = utc_now.astimezone(timezone_mst)
 
     # Format the output
-    df: str = "%Y-%m-%d %H:%M:%S "  # Date format
-    utc: str = utc_now.strftime(df + "UTC")
-    est: str = est_now.strftime(df + "EST")
-    mst: str = mst_now.strftime(df + "MST")
+    df: str = "%Y-%m-%d %H:%M:%S"  # Date format without trailing space
+    utc: str = utc_now.strftime(df)
+    est: str = est_now.strftime(df)
+    mst: str = mst_now.strftime(df)
+
+    # Use timezone abbreviations from the datetime objects
+    utc_tz_abbr: str = utc_now.strftime("%Z")
+    # est_tz_abbr: str = est_now.strftime("%Z")
+    est_tz_abbr: str = "EST"
+    # mst_tz_abbr: str = mst_now.strftime("%Z")
+    mst_tz_abbr: str = "MST"
 
     # Combine the formatted times
-    timestamp: str = f"{utc} ({est} / {mst})"
+    timestamp: str = f"{utc} {utc_tz_abbr} ({est} {est_tz_abbr} / {mst} {mst_tz_abbr})"
 
     return timestamp
+
+    # try:
+    #     # The format of the input timestamp
+    #     # Use a flexible format to parse a naive datetime object first
+    #     input_format_naive: str = "%Y%m%d_%H%M%S"
+
+    #     # Separate the datetime part and the timezone abbreviation
+    #     dt_part, tz_part = short.rsplit("_", 1)
+
+    #     # Handle different UTC-like timezone abbreviations
+    #     if tz_part not in ["UTC", "GMT", "Z"]:
+    #         # Raise an error if the timezone is not recognized
+    #         raise ValueError(f"Unrecognized timezone abbreviation: {tz_part}")
+
+    #     # Convert the input string to a naive datetime object
+    #     utc_datetime: datetime = datetime.strptime(dt_part, input_format_naive)
+
+    #     # Make the datetime object timezone-aware by localizing to UTC
+    #     utc_now: datetime = pytz.utc.localize(utc_datetime)
+
+    #     # Define the time zones
+    #     timezone_est: pytz.BaseTzInfo = pytz.timezone("America/New_York")
+    #     timezone_mst: pytz.BaseTzInfo = pytz.timezone("America/Denver")
+
+    #     # Convert UTC time to EST and MST
+    #     est_now: datetime = utc_now.astimezone(timezone_est)
+    #     mst_now: datetime = utc_now.astimezone(timezone_mst)
+
+    #     # Format the output
+    #     df: str = "%Y-%m-%d %H:%M:%S"  # Date format without trailing space
+    #     utc: str = utc_now.strftime(df)
+    #     est: str = est_now.strftime(df)
+    #     mst: str = mst_now.strftime(df)
+
+    #     # Use timezone abbreviations from the datetime objects
+    #     utc_tz_abbr: str = utc_now.strftime("%Z")
+    #     est_tz_abbr: str = est_now.strftime("%Z")
+    #     mst_tz_abbr: str = mst_now.strftime("%Z")
+
+    #     # Combine the formatted times
+    #     timestamp: str = (
+    #         f"{utc} {utc_tz_abbr} ({est} {est_tz_abbr} / {mst} {mst_tz_abbr})"
+    #     )
+
+    #     return timestamp
+
+    # except (ValueError, IndexError) as e:
+    #     # Catch errors from strptime or rsplit and raise a more descriptive ValueError
+    #     raise ValueError(
+    #         f"Invalid timestamp format: '{short}'. "
+    #         f"Expected format is YYYYMMDD_HHMMSS_UTC, YYYYMMDD_HHMMSS_GMT, or YYYYMMDD_HHMMSS_Z."
+    #     ) from e

tests/test_report_pylint.py

@@ -25,7 +25,6 @@
     get_pylint_sections,
     get_report_html,
     get_score_from_summary,
-    get_timestamp,
     main,
     run_pylint_report,
     write_report,
@@ -96,6 +95,7 @@ def test_main_success(monkeypatch, capsys):
     mock_args = types.SimpleNamespace(
         input_file="dummy_input.txt",
         output_file="dummy_output.html",
+        timestamp="20240101_120000_UTC",
         run_id="123",
         ref_name="main",
         github_sha="abc",
@@ -127,6 +127,7 @@ def test_main_file_not_found(monkeypatch, capsys):
     mock_args = types.SimpleNamespace(
         input_file="non_existent.txt",
         output_file="dummy_output.html",
+        timestamp="20240101_120000_UTC",
         run_id="123",
         ref_name="main",
         github_sha="abc",
@@ -151,6 +152,7 @@ def test_main_io_error(monkeypatch, capsys):
     mock_args = types.SimpleNamespace(
         input_file="dummy_input.txt",
         output_file="dummy_output.html",
+        timestamp="20240101_120000_UTC",
         run_id="123",
         ref_name="main",
         github_sha="abc",
@@ -175,6 +177,7 @@ def test_main_unexpected_error(monkeypatch, capsys):
     mock_args = types.SimpleNamespace(
         input_file="dummy_input.txt",
         output_file="dummy_output.html",
+        timestamp="20240101_120000_UTC",
         run_id="123",
         ref_name="main",
         github_sha="abc",
@@ -211,19 +214,19 @@ def test_get_score_color():
     assert get_score_color("") == "gray", "Test failed for empty string"
 
 
-def test_get_timestamp():
-    """Test that formatted_timestamp() returns valid datetime string.
-
-    Confirms output includes expected format components like UTC, EST, MST,
-    and a recognizable timestamp pattern.
-
-    Example get_formatted_timestamp output:
-        '2025-07-31 18:33:56 UTC (2025-07-31 14:33:56 EST / 2025-07-31 12:33:56 MST)'
-    """
-    ts = get_timestamp()
-
-    assert "UTC" in ts
-    assert re.search(r"\d{4}-\d{2}-\d{2}", ts)
+# def test_get_timestamp_ext():
+#     """Test that formatted_timestamp() returns valid datetime string.
+#
+#     Confirms output includes expected format components like UTC, EST, MST,
+#     and a recognizable timestamp pattern.
+#
+#     Example get_formatted_timestamp output:
+#         '2025-07-31 18:33:56 UTC (2025-07-31 14:33:56 EST / 2025-07-31 12:33:56 MST)'
+#     """
+#     ts = get_timestamp()
+#
+#     assert "UTC" in ts
+#     assert re.search(r"\d{4}-\d{2}-\d{2}", ts)
 
 
 def test_get_issue_counts():
@@ -326,6 +329,7 @@ def test_get_report_html():
         issues=issues,
         summary_lines=summary,
         pylint_score="9.00",
+        timestamp="20250815_211112_UTC",
         run_id="123",
         ref_name="main",
         github_sha="abc123def456",
@@ -355,6 +359,7 @@ def test_run_pylint_report():
     _total_issues, _issue_counts, _pylint_score = run_pylint_report(
         input_file=str(fin),
         output_file=str(fout),
+        timestamp="20250815_211112_UTC",
         run_id="1234567890",
         ref_name="main",
         github_sha="abc123def456",