task completeで保留中タスクをデフォルト除外する

Author: yuji38kwmt

annofabcli/task/complete_tasks.py

@@ -35,9 +35,10 @@
 
 
 class CompleteTasksMain(CommandLineWithConfirm):
-    def __init__(self, service: annofabapi.Resource, all_yes: bool = False) -> None:  # noqa: FBT001, FBT002
+    def __init__(self, service: annofabapi.Resource, all_yes: bool = False, include_on_hold_task: bool = False) -> None:  # noqa: FBT001, FBT002
         self.service = service
         self.facade = AnnofabApiFacade(service)
+        self.include_on_hold_task = include_on_hold_task
         CommandLineWithConfirm.__init__(self, all_yes)
 
     def reply_inspection_comment(
@@ -286,8 +287,7 @@ def complete_task_for_inspection_acceptance_phase(
         logger.info(f"task_id='{task.task_id}' :: 検査/受入フェーズを次のフェーズに進めました。")
         return True
 
-    @staticmethod
-    def _validate_task(task: Task, target_phase: TaskPhase, target_phase_stage: int, task_query: TaskQuery | None) -> bool:
+    def _validate_task(self, task: Task, target_phase: TaskPhase, target_phase_stage: int, task_query: TaskQuery | None) -> bool:
         if not (task.phase == target_phase and task.phase_stage == target_phase_stage):
             logger.warning(f"task_id='{task.task_id}'のタスクは操作対象のフェーズ、フェーズステージではないため、スキップします。")
             return False
@@ -296,6 +296,10 @@ def _validate_task(task: Task, target_phase: TaskPhase, target_phase_stage: int,
             logger.warning(f"task_id='{task.task_id}'のタスクは作業中または完了状態であるため、スキップします。")
             return False
 
+        if task.status == TaskStatus.ON_HOLD and not self.include_on_hold_task:
+            logger.warning(f"task_id='{task.task_id}'のタスクは保留中状態であるため、スキップします。保留中状態のタスクも次のフェーズに進める場合は、'--include_on_hold_task'を指定してください。")
+            return False
+
         if not match_task_with_query(task, task_query):
             logger.debug(f"task_id='{task.task_id}' は `--task_query` の条件にマッチしないため、スキップします。 :: task_query={task_query}")
             return False
@@ -468,7 +472,7 @@ def main(self) -> None:
         dict_task_query = annofabcli.common.cli.get_json_from_args(args.task_query)
         task_query: TaskQuery | None = TaskQuery.from_dict(dict_task_query) if dict_task_query is not None else None
 
-        main_obj = CompleteTasksMain(self.service, all_yes=self.all_yes)
+        main_obj = CompleteTasksMain(self.service, all_yes=self.all_yes, include_on_hold_task=args.include_on_hold_task)
         main_obj.complete_task_list(
             project_id,
             task_id_list=task_id_list,
@@ -527,6 +531,12 @@ def parse_args(parser: argparse.ArgumentParser) -> None:
 
     argument_parser.add_task_query()
 
+    parser.add_argument(
+        "--include_on_hold_task",
+        action="store_true",
+        help="指定した場合、保留中状態のタスクも次のフェーズに進めます。指定しない場合、保留中状態のタスクはスキップします。",
+    )
+
     parser.add_argument(
         "--parallelism",
         type=int,
@@ -553,6 +563,7 @@ def add_parser(subparsers: argparse._SubParsersAction | None = None) -> argparse
         "検査/受入フェーズを完了する場合は、未処置の検査コメントを対応完了/対応不要状態に変更できます"
         "（未処置の検査コメントが残っている状態では、タスクを合格にできないため）。"
         "作業中また完了状態のタスクは、次のフェーズに進めません。"
+        "保留中状態のタスクは、デフォルトでは次のフェーズに進めません。"
     )
     epilog = "チェッカーまたはオーナロールを持つユーザで実行してください。"
 

tests/task/test_complete_tasks.py

@@ -0,0 +1,106 @@
+from __future__ import annotations
+
+import argparse
+from unittest.mock import Mock
+
+import pytest
+from annofabapi.models import TaskPhase
+
+from annofabcli.task import complete_tasks
+
+
+def create_task_dict(*, status: str = "not_started", phase: str = "annotation") -> dict[str, object]:
+    return {
+        "project_id": "project1",
+        "task_id": "task1",
+        "phase": phase,
+        "phase_stage": 1,
+        "status": status,
+        "input_data_id_list": ["input_data1"],
+        "account_id": "account1",
+        "histories_by_phase": [],
+        "work_time_span": 0,
+        "number_of_rejections": 0,
+        "started_datetime": None,
+        "updated_datetime": "2024-01-01T00:00:00+00:00",
+        "operation_updated_datetime": None,
+        "sampling": None,
+        "metadata": {},
+    }
+
+
+def test_complete_task_skips_on_hold_task_by_default(monkeypatch: pytest.MonkeyPatch) -> None:
+    service = Mock()
+    service.wrapper.get_task_or_none.return_value = create_task_dict(status="on_hold")
+    main_obj = complete_tasks.CompleteTasksMain(service, all_yes=True)
+    complete_task_mock = Mock(return_value=True)
+    monkeypatch.setattr(main_obj, "complete_task_for_annotation_phase", complete_task_mock)
+
+    result = main_obj.complete_task(
+        project_id="project1",
+        task_id="task1",
+        target_phase=TaskPhase.ANNOTATION,
+        target_phase_stage=1,
+    )
+
+    assert result is False
+    complete_task_mock.assert_not_called()
+
+
+def test_complete_task_allows_on_hold_task_when_option_is_enabled(monkeypatch: pytest.MonkeyPatch) -> None:
+    service = Mock()
+    service.wrapper.get_task_or_none.return_value = create_task_dict(status="on_hold")
+    main_obj = complete_tasks.CompleteTasksMain(service, all_yes=True, include_on_hold_task=True)
+    complete_task_mock = Mock(return_value=True)
+    monkeypatch.setattr(main_obj, "complete_task_for_annotation_phase", complete_task_mock)
+
+    result = main_obj.complete_task(
+        project_id="project1",
+        task_id="task1",
+        target_phase=TaskPhase.ANNOTATION,
+        target_phase_stage=1,
+    )
+
+    assert result is True
+    complete_task_mock.assert_called_once()
+
+
+def test_main_passes_include_on_hold_task_to_main_object(monkeypatch: pytest.MonkeyPatch) -> None:
+    service = Mock()
+    facade = Mock()
+    args = argparse.Namespace(
+        project_id="project1",
+        task_id=["task1"],
+        phase="annotation",
+        phase_stage=1,
+        inspection_status=None,
+        reply_comment=None,
+        task_query=None,
+        parallelism=None,
+        include_on_hold_task=True,
+        yes=True,
+    )
+
+    complete_task_list_mock = Mock()
+    complete_tasks_main_init_mock = Mock()
+
+    class CompleteTasksMainStub:
+        def __init__(self, _service, *, all_yes, include_on_hold_task):
+            complete_tasks_main_init_mock(all_yes=all_yes, include_on_hold_task=include_on_hold_task)
+
+        def complete_task_list(self, *args, **kwargs):
+            complete_task_list_mock(*args, **kwargs)
+
+    monkeypatch.setattr(complete_tasks, "CompleteTasksMain", CompleteTasksMainStub)
+    monkeypatch.setattr(complete_tasks.annofabcli.common.cli, "get_list_from_args", lambda value: value)
+    monkeypatch.setattr(complete_tasks.annofabcli.common.cli, "get_json_from_args", lambda _value: None)
+
+    command = complete_tasks.CompleteTasks(service, facade, args)
+    monkeypatch.setattr(command, "validate_project", Mock())
+
+    command.main()
+
+    complete_tasks_main_init_mock.assert_called_once_with(all_yes=True, include_on_hold_task=True)
+    complete_task_list_mock.assert_called_once()
+    assert complete_task_list_mock.call_args.args[0] == "project1"
+    assert complete_task_list_mock.call_args.kwargs["target_phase"] == TaskPhase.ANNOTATION