post_comment_for_job_results.py added

Author: dconeybe

firebase-dataconnect/ci/post_comment_for_job_results.py

@@ -0,0 +1,188 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from __future__ import annotations
+
+import argparse
+import dataclasses
+import logging
+import pathlib
+import subprocess
+import tempfile
+import typing
+
+if typing.TYPE_CHECKING:
+  from collections.abc import Iterable, Sequence
+
+
+def main() -> None:
+  args = parse_args()
+  logging.basicConfig(format="%(message)s", level=logging.INFO)
+
+  message_lines = tuple(generate_message_lines(args))
+
+  issue_url = f"{args.github_repository_html_url}/issues/{args.github_issue}"
+  logging.info("Posting the following comment to GitHub Issue %s", issue_url)
+  for line in message_lines:
+    logging.info(line)
+
+  message_bytes = "\n".join(message_lines).encode("utf8", errors="replace")
+  with tempfile.TemporaryDirectory() as tempdir_path:
+    message_file = pathlib.Path(tempdir_path) / "message_text.txt"
+    message_file.write_bytes(message_bytes)
+    post_github_issue_comment(
+      issue_number=args.github_issue,
+      body_file=message_file,
+      github_repository=args.github_repository,
+    )
+
+
+def generate_message_lines(data: ParsedArgs) -> Iterable[str]:
+  yield f"Result of workflows at {data.github_sha}:"
+
+  for job_result in data.job_results:
+    result_symbol = "✅" if job_result.result == "success" else "❌"
+    yield f"  - {job_result.job_id}: {result_symbol} {job_result.result}"
+
+  yield ""
+  yield f"{data.github_repository_html_url}/actions/runs/{data.github_run_id}"
+
+  yield ""
+  yield (
+    f"run_id={data.github_run_id} "
+    f"run_number={data.github_run_number} "
+    f"run_attempt={data.github_run_attempt}"
+  )
+
+
+def post_github_issue_comment(
+  issue_number: int, body_file: pathlib.Path, github_repository: str
+) -> None:
+  gh_args = post_issue_comment_gh_args(
+    issue_number=issue_number, body_file=body_file, github_repository=github_repository
+  )
+  gh_args = tuple(gh_args)
+  logging.info("Running command: %s", subprocess.list2cmdline(gh_args))
+  subprocess.check_call(gh_args)  # noqa: S603
+
+
+def post_issue_comment_gh_args(
+  issue_number: int, body_file: pathlib.Path, github_repository: str
+) -> Iterable[str]:
+  yield "gh"
+  yield "issue"
+  yield "comment"
+  yield str(issue_number)
+  yield "--body-file"
+  yield str(body_file)
+  yield "-R"
+  yield github_repository
+
+
+@dataclasses.dataclass(frozen=True)
+class JobResult:
+  job_id: str
+  result: str
+
+  @classmethod
+  def parse(cls, s: str) -> JobResult:
+    colon_index = s.find(":")
+    if colon_index < 0:
+      raise ParseError(
+        "no colon (:) character found in job result specfication, "
+        "which is required to delimit the job ID from the job result"
+      )
+    job_id = s[:colon_index]
+    job_result = s[colon_index + 1 :]
+    return cls(job_id=job_id, result=job_result)
+
+
+class ParsedArgs(typing.Protocol):
+  job_results: Sequence[JobResult]
+  github_issue: int
+  github_repository: str
+  github_sha: str
+  github_repository_html_url: str
+  github_run_id: str
+  github_run_number: str
+  github_run_attempt: str
+
+
+class ParseError(Exception):
+  pass
+
+
+def parse_args() -> ParsedArgs:
+  arg_parser = argparse.ArgumentParser()
+  arg_parser.add_argument(
+    "job_results",
+    nargs="+",
+    help="The results of the jobs in question, of the form "
+    "'job-id:${{ needs.job-id.result }}' where 'job-id' is the id of the corresponding job "
+    "in the 'needs' section of the job.",
+  )
+  arg_parser.add_argument(
+    "--github-issue",
+    required=True,
+    help="The GitHub Issue number to which to post a comment",
+  )
+  arg_parser.add_argument(
+    "--github-repository",
+    required=True,
+    help="The value of ${{ github.repository }} in the workflow",
+  )
+  arg_parser.add_argument(
+    "--github-sha",
+    required=True,
+    help="The value of ${{ github.sha }} in the workflow",
+  )
+  arg_parser.add_argument(
+    "--github-repository-html-url",
+    required=True,
+    help="The value of ${{ github.event.repository.html_url }} in the workflow",
+  )
+  arg_parser.add_argument(
+    "--github-run-id",
+    required=True,
+    help="The value of ${{ github.run_id }} in the workflow",
+  )
+  arg_parser.add_argument(
+    "--github-run-number",
+    required=True,
+    help="The value of ${{ github.run_number }} in the workflow",
+  )
+  arg_parser.add_argument(
+    "--github-run-attempt",
+    required=True,
+    help="The value of ${{ github.run_attempt }} in the workflow",
+  )
+
+  parse_result = arg_parser.parse_args()
+
+  job_results: list[JobResult] = []
+  for job_result_str in parse_result.job_results:
+    try:
+      job_result = JobResult.parse(job_result_str)
+    except ParseError as e:
+      arg_parser.error(f"invalid job result specification: {job_result_str} ({e})")
+      typing.assert_never("the line above should have raised an exception")
+    else:
+      job_results.append(job_result)
+  parse_result.job_results = tuple(job_results)
+
+  return typing.cast("ParsedArgs", parse_result)
+
+
+if __name__ == "__main__":
+  main()

firebase-dataconnect/ci/pyproject.toml

@@ -28,7 +28,9 @@ ignore = [
   "D211", # no-blank-line-before-class
   "D212", # multi-line-summary-second-line
   "E501", # Line too long (will be fixed by the formatter)
+  "EM101", # Exception must not use a string literal, assign to variable first
   "LOG015", # root-logger-call
+  "TRY003", # Avoid specifying long messages outside the exception class
 ]
 
 [tool.ruff.lint.per-file-ignores]
@@ -42,3 +44,4 @@ quote-style = "double"
 indent-style = "space"
 skip-magic-trailing-comma = false
 docstring-code-format = true
+SUCCESS!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!