supervisor: add --ignore-needs-attention

During development, we may want to run the supervisor against
issues or errata that have been flagged for human attention.
This change adds a command-line option to allow that.

Author: owtaylor

Makefile

@@ -187,6 +187,13 @@ else
 DRY_RUN_FLAG :=
 endif
 
+IGNORE_NEEDS_ATTENTION_LOWER := $(shell echo $(IGNORE_NEEDS_ATTENTION) | tr '[:upper:]' '[:lower:]')
+ifeq ($(IGNORE_NEEDS_ATTENTION_LOWER),true)
+IGNORE_NEEDS_ATTENTION_FLAG := --ignore-needs-attention
+else
+IGNORE_NEEDS_ATTENTION_FLAG :=
+endif
+
 .PHONY: supervisor-clear-queue
 supervisor-clear-queue:
 	$(COMPOSE_SUPERVISOR) run --rm \
@@ -200,12 +207,12 @@ supervisor-collect:
 .PHONY: process-issue
 process-issue:
 	$(COMPOSE_SUPERVISOR) run --rm \
-		supervisor python -m supervisor.main $(DEBUG_FLAG) $(DRY_RUN_FLAG) process-issue $(JIRA_ISSUE)
+		supervisor python -m supervisor.main $(DEBUG_FLAG) $(IGNORE_NEEDS_ATTENTION_FLAG) $(DRY_RUN_FLAG) process-issue $(JIRA_ISSUE)
 
 .PHONY: process-erratum
 process-erratum:
 	$(COMPOSE_SUPERVISOR) run --rm \
-		supervisor python -m supervisor.main $(DEBUG_FLAG) $(DRY_RUN_FLAG) process-erratum $(ERRATA_ID)
+		supervisor python -m supervisor.main $(DEBUG_FLAG) $(IGNORE_NEEDS_ATTENTION_FLAG) $(DRY_RUN_FLAG) process-erratum $(ERRATA_ID)
 
 
 # Common utility targets

supervisor/erratum_handler.py

@@ -79,8 +79,10 @@ class ErratumHandler(WorkItemHandler):
     adding comments, or flagging it for human attention.
     """
 
-    def __init__(self, erratum: Erratum, *, dry_run: bool):
-        super().__init__(dry_run=dry_run)
+    def __init__(
+        self, erratum: Erratum, *, dry_run: bool, ignore_needs_attention: bool
+    ):
+        super().__init__(dry_run=dry_run, ignore_needs_attention=ignore_needs_attention)
         self.erratum = erratum
 
     def resolve_flag_attention(self, why: str):
@@ -183,7 +185,7 @@ async def run(self) -> WorkflowResult:
             erratum.full_advisory,
         )
 
-        if erratum_needs_attention(erratum.id):
+        if (not self.ignore_needs_attention) and erratum_needs_attention(erratum.id):
             return self.resolve_remove_work_item(
                 "Erratum already flagged for human attention"
             )

supervisor/issue_handler.py

@@ -27,8 +27,10 @@ class IssueHandler(WorkItemHandler):
     This includes changing the issue status, adding comments, and adding labels.
     """
 
-    def __init__(self, issue: FullIssue, *, dry_run: bool):
-        super().__init__(dry_run=dry_run)
+    def __init__(
+        self, issue: FullIssue, *, dry_run: bool, ignore_needs_attention: bool
+    ):
+        super().__init__(dry_run=dry_run, ignore_needs_attention=ignore_needs_attention)
         self.issue = issue
 
     def resolve_set_status(self, status: IssueStatus, why: str):
@@ -225,7 +227,10 @@ async def run(self) -> WorkflowResult:
 
         logger.info("Running workflow for issue %s", issue.url)
 
-        if JiraLabels.NEEDS_ATTENTION.value in issue.labels:
+        if (
+            JiraLabels.NEEDS_ATTENTION.value in issue.labels
+            and not self.ignore_needs_attention
+        ):
             return self.resolve_remove_work_item(
                 "Issue has the jotnar_needs_attention label"
             )

supervisor/main.py

@@ -27,6 +27,7 @@
 @dataclass
 class State:
     dry_run: bool = False
+    ignore_needs_attention: bool = False
 
 
 app_state = State()
@@ -108,7 +109,11 @@ async def process_once(queue: WorkQueue):
 
     if work_item.item_type == WorkItemType.PROCESS_ISSUE:
         issue = get_issue(work_item.item_data, full=True)
-        result = await IssueHandler(issue, dry_run=app_state.dry_run).run()
+        result = await IssueHandler(
+            issue,
+            dry_run=app_state.dry_run,
+            ignore_needs_attention=app_state.ignore_needs_attention,
+        ).run()
         if result.reschedule_in >= 0:
             await queue.schedule_work_items([work_item], delay=result.reschedule_in)
         else:
@@ -122,7 +127,11 @@ async def process_once(queue: WorkQueue):
         )
     elif work_item.item_type == WorkItemType.PROCESS_ERRATUM:
         erratum = get_erratum(work_item.item_data)
-        result = await ErratumHandler(erratum, dry_run=app_state.dry_run).run()
+        result = await ErratumHandler(
+            erratum,
+            dry_run=app_state.dry_run,
+            ignore_needs_attention=app_state.ignore_needs_attention,
+        ).run()
         if result.reschedule_in >= 0:
             await queue.schedule_work_items([work_item], delay=result.reschedule_in)
         else:
@@ -163,7 +172,11 @@ async def do_process_issue(key: str):
     await init_kerberos_ticket()
 
     issue = get_issue(key, full=True)
-    result = await IssueHandler(issue, dry_run=app_state.dry_run).run()
+    result = await IssueHandler(
+        issue,
+        dry_run=app_state.dry_run,
+        ignore_needs_attention=app_state.ignore_needs_attention,
+    ).run()
     logger.info(
         "Issue %s processed, status=%s, reschedule_in=%s",
         key,
@@ -197,7 +210,11 @@ async def do_process_erratum(id: str):
     await init_kerberos_ticket()
 
     erratum = get_erratum(id)
-    result = await ErratumHandler(erratum, dry_run=app_state.dry_run).run()
+    result = await ErratumHandler(
+        erratum,
+        dry_run=app_state.dry_run,
+        ignore_needs_attention=app_state.ignore_needs_attention,
+    ).run()
 
     logger.info(
         "Erratum %s (%s) processed, status=%s, reschedule_in=%s",
@@ -228,8 +245,9 @@ def process_erratum(id_or_url: str):
 @app.callback()
 def main(
     debug: bool = typer.Option(False, help="Enable debug mode."),
-    dry_run: bool = typer.Option(
-        False, "--dry-run", help="Don't actually change anything."
+    dry_run: bool = typer.Option(False, help="Don't actually change anything."),
+    ignore_needs_attention: bool = typer.Option(
+        False, help="Process issues or errata flagged with jotnar_needs_attention."
     ),
 ):
     if debug:
@@ -240,6 +258,7 @@ def main(
         logging.basicConfig(level=logging.INFO)
 
     app_state.dry_run = dry_run
+    app_state.ignore_needs_attention = ignore_needs_attention
 
     collector_endpoint = os.environ.get("COLLECTOR_ENDPOINT")
     if collector_endpoint is not None:

supervisor/work_item_handler.py

@@ -9,8 +9,9 @@
 
 
 class WorkItemHandler(ABC):
-    def __init__(self, dry_run: bool = False):
+    def __init__(self, dry_run: bool = False, ignore_needs_attention: bool = False):
         self.dry_run = dry_run
+        self.ignore_needs_attention = ignore_needs_attention
 
     def resolve_remove_work_item(self, why: str):
         return WorkflowResult(status=why, reschedule_in=-1)