refactor: update SkipUnlessChanged optimization to use new 'files_changed' parameter

Author: ahal

src/taskgraph/optimize/strategies.py

@@ -1,8 +1,8 @@
 import logging
 from datetime import datetime
 
-from taskgraph import files_changed
 from taskgraph.optimize.base import OptimizationStrategy, register_strategy
+from taskgraph.util.path import match as match_path
 from taskgraph.util.taskcluster import find_task_id, status_task
 
 logger = logging.getLogger(__name__)
@@ -48,12 +48,20 @@ def should_replace_task(self, task, params, deadline, index_paths):
 
 @register_strategy("skip-unless-changed")
 class SkipUnlessChanged(OptimizationStrategy):
+
+    def check(self, files_changed, patterns):
+        for pattern in patterns:
+            for path in files_changed:
+                if match_path(path, pattern):
+                    return True
+        return False
+
     def should_remove_task(self, task, params, file_patterns):
         # pushlog_id == -1 - this is the case when run from a cron.yml job or on a git repository
         if params.get("repository_type") == "hg" and params.get("pushlog_id") == -1:
             return False
 
-        changed = files_changed.check(params, file_patterns)
+        changed = self.check(params["files_changed"], file_patterns)
         if not changed:
             logger.debug(
                 f'no files found matching a pattern in `skip-unless-changed` for "{task.label}"'

test/test_optimize_strategies.py

@@ -3,11 +3,12 @@
 
 import os
 from datetime import datetime
+from test.fixtures.gen import make_task
 from time import mktime
 
 import pytest
 
-from taskgraph.optimize.strategies import IndexSearch
+from taskgraph.optimize.strategies import IndexSearch, SkipUnlessChanged
 
 
 @pytest.fixture
@@ -68,3 +69,34 @@ def test_index_search(responses, params, state, expires, expected):
     opt = IndexSearch()
     deadline = "2021-06-07T19:03:20.482Z"
     assert opt.should_replace_task({}, params, deadline, (index_path,)) == expected
+
+
+@pytest.mark.parametrize(
+    "params,file_patterns,should_optimize",
+    (
+        pytest.param({"files_changed": []}, ["foo.txt"], True, id="no files changed"),
+        pytest.param(
+            {"files_changed": ["foo.txt"]}, ["foo.txt"], False, id="files match"
+        ),
+        pytest.param(
+            {"files_changed": ["foo.txt"]},
+            ["bar.tx", "foo.txt"],
+            False,
+            id="files match multiple",
+        ),
+        pytest.param(
+            {"files_changed": ["bar.txt"]}, ["foo.txt"], True, id="files don't match"
+        ),
+        pytest.param(
+            {"repository_type": "hg", "pushlog_id": -1, "files_changed": ["bar.txt"]},
+            ["foo.txt"],
+            False,
+            id="cron task",
+        ),
+    ),
+)
+def test_skip_unless_changed(params, file_patterns, should_optimize):
+    task = make_task("task")
+
+    opt = SkipUnlessChanged()
+    assert opt.should_remove_task(task, params, file_patterns) == should_optimize