Update tests and parmaterize

Author: nabobalis

tests/test_activity_window.py

@@ -3,11 +3,12 @@
 import datetime
 
 import pandas as pd
+import pytest
 
-from github_activity.github_activity import generate_activity_md
+from github_activity.github_activity import generate_activity_md, get_activity
 
 
-def _pr_row(number, title, closed_at, labels=None, created_at=None, merge_oid=None):
+def _pr_row(number, title, closed_at):
     return {
         "id": f"PR_{number}",
         "title": title,
@@ -22,98 +23,109 @@ def _pr_row(number, title, closed_at, labels=None, created_at=None, merge_oid=No
         "committers": ["manics"],
         "reviewers": [],
         "comments": {"edges": []},
-        "labels": labels or [],
+        "labels": [],
         "closedAt": closed_at,
-        "createdAt": created_at or "2022-08-20T10:00:00Z",
-        "mergeCommit": {"oid": merge_oid or f"sha{number}"},
+        "createdAt": "2022-08-20T10:00:00Z",
+        "mergeCommit": {"oid": f"sha{number}"},
         "baseRefName": "master",
     }
 
 
-def _activity_frame(rows, since_dt, until_dt, since_is_git_ref, until_is_git_ref=False):
-    data = pd.DataFrame(rows)
-    data.since_dt = since_dt
-    data.until_dt = until_dt
-    data.since_dt_str = f"{since_dt:%Y-%m-%dT%H:%M:%SZ}"
-    data.until_dt_str = f"{until_dt:%Y-%m-%dT%H:%M:%SZ}"
-    data.since_is_git_ref = since_is_git_ref
-    data.until_is_git_ref = until_is_git_ref
-    data.attrs["bot_users"] = set()
-    return data
+def _mock_get_activity_dependencies(
+    monkeypatch,
+    rows,
+    since_dt,
+    until_dt,
+    since_is_git_ref,
+):
+    datetime_results = iter(
+        [
+            (since_dt, since_is_git_ref),
+            (until_dt, False),
+        ]
+    )
+    monkeypatch.setattr(
+        "github_activity.github_activity._get_datetime_and_type",
+        lambda *args, **kwargs: next(datetime_results),
+    )
+    monkeypatch.setattr(
+        "github_activity.github_activity._validate_repository_exists",
+        lambda *args, **kwargs: None,
+    )
 
+    class FakeGitHubGraphQlQuery:
+        def __init__(self, *args, **kwargs):
+            self.data = pd.DataFrame(rows)
+            self.data.attrs["bot_users"] = set()
 
-def test_git_ref_since_excludes_pr_closed_at_tag(monkeypatch):
-    """A PR whose merge commit is the --since tag must not appear in the changelog.
+        request = lambda self: None  # noqa: E731
 
-    GitHub compare `tag...HEAD` is exclusive of the tag. Matching that window
-    means a PR closed at the tagged commit's timestamp belongs to the previous
-    release. Regression for executablebooks/github-activity#79.
-    """
-    since_dt = datetime.datetime(2022, 8, 21, 13, 29, 31, tzinfo=datetime.timezone.utc)
-    until_dt = datetime.datetime(2022, 11, 15, 19, 11, 20, tzinfo=datetime.timezone.utc)
-    data = _activity_frame(
-        [
-            _pr_row(
-                72,
-                "Earlier same-day PR",
-                "2022-08-21T10:00:00Z",
-                labels=["bug"],
-            ),
-            _pr_row(
-                73,
-                "Calico 3.24.0 (3.23 manifest URL is broken)",
-                "2022-08-21T13:29:31Z",
-                labels=["bug"],
-                merge_oid="d3c165a02b1c75b6e551da97970eecb401269750",
-            ),
-            _pr_row(
-                74,
-                "Add RELEASE.md",
-                "2022-08-21T15:22:38Z",
-            ),
-        ],
-        since_dt,
-        until_dt,
-        since_is_git_ref=True,
-        until_is_git_ref=True,
-    )
     monkeypatch.setattr(
-        "github_activity.github_activity.get_activity", lambda *args, **kwargs: data
+        "github_activity.github_activity.GitHubGraphQlQuery",
+        FakeGitHubGraphQlQuery,
     )
 
-    md = generate_activity_md(
+
+@pytest.mark.parametrize("api", [get_activity, generate_activity_md])
+@pytest.mark.parametrize(
+    "since,since_dt,since_is_git_ref,expected",
+    [
+        ("v3.0.5", "2022-08-21T13:29:31+00:00", True, [74]),
+        ("2022-08-21", "2022-08-21T00:00:00+00:00", False, [73, 74]),
+    ],
+    ids=["git-ref-exclusive", "date-inclusive"],
+)
+def test_activity_window(monkeypatch, api, since, since_dt, since_is_git_ref, expected):
+    """Both APIs exclude a git-ref boundary but include a date boundary (#79)."""
+    since_dt = datetime.datetime.fromisoformat(since_dt)
+    until_dt = datetime.datetime(2022, 11, 15, 19, 11, 20, tzinfo=datetime.timezone.utc)
+    rows = [
+        _pr_row(
+            number,
+            title,
+            f"{since_dt + datetime.timedelta(hours=offset):%Y-%m-%dT%H:%M:%SZ}",
+        )
+        for number, title, offset in [
+            (72, "Closed before boundary", -1),
+            (73, "Closed at boundary", 0),
+            (74, "Closed after boundary", 1),
+        ]
+    ]
+    _mock_get_activity_dependencies(
+        monkeypatch, rows, since_dt, until_dt, since_is_git_ref
+    )
+
+    result = api(
         target="jupyterhub/action-k3s-helm",
-        since="v3.0.5",
-        until="v3.0.6",
+        since=since,
+        until="2022-11-15T19:11:20Z",
+        auth="test-token",
     )
 
-    assert "[#73]" not in md
-    assert "[#72]" not in md
-    assert "[#74]" in md
+    if api is get_activity:
+        assert result["number"].tolist() == expected
+    else:
+        for number in [72, 73, 74]:
+            assert (f"[#{number}]" in result) == (number in expected)
 
 
-def test_date_since_still_includes_prs_at_window_start(monkeypatch):
-    """A calendar-date --since remains inclusive of activity at that instant."""
-    since_dt = datetime.datetime(2022, 8, 21, 0, 0, 0, tzinfo=datetime.timezone.utc)
-    until_dt = datetime.datetime(2022, 8, 22, 0, 0, 0, tzinfo=datetime.timezone.utc)
-    data = _activity_frame(
-        [
-            _pr_row(73, "Closed at start of since date", "2022-08-21T00:00:00Z"),
-            _pr_row(74, "Closed later the same day", "2022-08-21T15:22:38Z"),
-        ],
-        since_dt,
-        until_dt,
-        since_is_git_ref=False,
-    )
-    monkeypatch.setattr(
-        "github_activity.github_activity.get_activity", lambda *args, **kwargs: data
+@pytest.mark.parametrize("api", [get_activity, generate_activity_md])
+def test_empty_activity(monkeypatch, api):
+    """Empty searches return an empty frame or the intended Markdown error."""
+    since_dt = datetime.datetime(2022, 8, 21, tzinfo=datetime.timezone.utc)
+    until_dt = datetime.datetime(2022, 8, 22, tzinfo=datetime.timezone.utc)
+    _mock_get_activity_dependencies(
+        monkeypatch, [], since_dt, until_dt, since_is_git_ref=False
     )
-
-    md = generate_activity_md(
+    kwargs = dict(
         target="jupyterhub/action-k3s-helm",
         since="2022-08-21",
         until="2022-08-22",
+        auth="test-token",
     )
 
-    assert "[#73]" in md
-    assert "[#74]" in md
+    if api is get_activity:
+        assert api(**kwargs).empty
+    else:
+        with pytest.raises(ValueError, match="No activity found"):
+            api(**kwargs)