forked from vhaudiquet/weekly-activity
feat(config): menu-driven multi-account wizard, v2 schema, config-time Launchpad OAuth
Address review of PR #1 (Valentin): replace the linear config walk-through and single-section schema. - weekly-activity config becomes a menu loop: Current sources (masked) -> Add a new source (pick kind, repeatable) / Remove a source / Exit; the file is written only when something changed - new versioned config layout (version = 2): [[kind.accounts]] arrays so several accounts or instances per provider coexist; optional display labels; strict unknown-key/type validation kept (errors carry account position, e.g. [github.accounts[1]]) - legacy v1 files (no version key, one section per source) migrate transparently in memory on load; saving from the wizard persists v2; the file itself is never rewritten by load_config - non-anonymous Launchpad accounts now authenticate at config time: constructing LaunchpadSource runs launchpadlib's browser OAuth and the token lands in the system keyring before any report; an explicit credentials_file stays supported as an additive opt-out - report aggregates every configured account in stable order with failure isolation intact; headings add the account label when it disambiguates (source_label shared between aggregate and wizard) - GitHub accounts gain optional token_env resolved lazily against the environment before falling back to GITHUB_TOKEN / `gh auth token`
This commit is contained in:
+81
-13
@@ -48,29 +48,90 @@ def window() -> tuple[datetime, datetime]:
|
||||
class BuildSpecsTest(unittest.TestCase):
|
||||
def test_maps_every_section_in_order(self) -> None:
|
||||
config = ActivityConfig(
|
||||
launchpad=LaunchpadSettings(username="lp"),
|
||||
github=GithubSettings(username="gh"),
|
||||
gitlab=GitlabSettings(username="gl"),
|
||||
bts=BtsSettings(email="bts@mail"),
|
||||
launchpad=[LaunchpadSettings(username="lp")],
|
||||
github=[GithubSettings(username="gh")],
|
||||
gitlab=[GitlabSettings(username="gl")],
|
||||
bts=[BtsSettings(email="bts@mail")],
|
||||
)
|
||||
specs = build_specs(config)
|
||||
self.assertEqual([s.name for s in specs], ["launchpad", "github", "gitlab", "bts"])
|
||||
self.assertEqual([s.username for s in specs], ["lp", "gh", "gl", "bts@mail"])
|
||||
|
||||
def test_multiple_accounts_per_kind_in_listing_order(self) -> None:
|
||||
config = ActivityConfig(
|
||||
launchpad=[
|
||||
LaunchpadSettings(username="lp-a"),
|
||||
LaunchpadSettings(username="lp-b", mode="credentials"),
|
||||
],
|
||||
github=[
|
||||
GithubSettings(username="gh-a", name="work"),
|
||||
GithubSettings(username="gh-b"),
|
||||
],
|
||||
bts=[
|
||||
BtsSettings(email="one@x.org"),
|
||||
BtsSettings(email="two@x.org", name="two"),
|
||||
],
|
||||
)
|
||||
specs = build_specs(config)
|
||||
# All launchpad accounts first, then github, then bts; listing order kept.
|
||||
self.assertEqual([s.username for s in specs], ["lp-a", "lp-b", "gh-a", "gh-b",
|
||||
"one@x.org", "two@x.org"])
|
||||
self.assertEqual(
|
||||
[s.name for s in specs],
|
||||
[
|
||||
"launchpad/lp-a", # siblings force identity into the label
|
||||
"launchpad/lp-b",
|
||||
"github/work", # explicit label wins even among siblings
|
||||
"github/gh-b",
|
||||
"bts/one@x.org",
|
||||
"bts/two",
|
||||
],
|
||||
)
|
||||
|
||||
def test_single_unnamed_account_keeps_plain_kind_label(self) -> None:
|
||||
config = ActivityConfig(github=[GithubSettings(username="only-one")])
|
||||
specs = build_specs(config)
|
||||
self.assertEqual(specs[0].name, "github")
|
||||
|
||||
def test_disabled_sections_are_skipped(self) -> None:
|
||||
config = ActivityConfig(github=GithubSettings(username="only-one"))
|
||||
self.assertEqual([s.name for s in build_specs(config)], ["github"])
|
||||
config = ActivityConfig(bts=[BtsSettings(email="only@one")])
|
||||
self.assertEqual([s.name for s in build_specs(config)], ["bts"])
|
||||
|
||||
def test_launchpad_spec_expands_tilde_credentials_file(self) -> None:
|
||||
settings = LaunchpadSettings(
|
||||
username="u", mode="credentials", credentials_file="~/creds.json"
|
||||
)
|
||||
spec = build_specs(ActivityConfig(launchpad=settings))[0]
|
||||
config = ActivityConfig(launchpad=[LaunchpadSettings(username="anon")])
|
||||
config.launchpad.append(LaunchpadSettings(mode="credentials", username="u",
|
||||
credentials_file="~/creds.json"))
|
||||
specs = build_specs(config)
|
||||
with mock.patch("weekly_activity.aggregate.LaunchpadSource") as fake_source:
|
||||
for spec in specs:
|
||||
spec.make()
|
||||
anon_kwargs, cred_kwargs = (call.kwargs for call in fake_source.call_args_list)
|
||||
self.assertTrue(anon_kwargs["anonymous"])
|
||||
self.assertIsNone(anon_kwargs["credentials_file"])
|
||||
self.assertFalse(cred_kwargs["anonymous"])
|
||||
self.assertEqual(cred_kwargs["credentials_file"], os.path.expanduser("~") + "/creds.json")
|
||||
# The two accounts must not share one late-bound factory.
|
||||
self.assertNotEqual(anon_kwargs["credentials_file"], cred_kwargs["credentials_file"])
|
||||
|
||||
def test_github_token_env_resolved_lazily(self) -> None:
|
||||
config = ActivityConfig(github=[GithubSettings(username="u", token_env="MY_GH_TOKEN")])
|
||||
spec = build_specs(config)[0]
|
||||
with (
|
||||
mock.patch("weekly_activity.aggregate.GitHubSource") as fake_source,
|
||||
mock.patch.dict(os.environ, {"MY_GH_TOKEN": "env-token"}),
|
||||
):
|
||||
spec.make()
|
||||
kwargs = fake_source.call_args.kwargs
|
||||
self.assertEqual(kwargs["credentials_file"], os.path.expanduser("~") + "/creds.json")
|
||||
self.assertFalse(kwargs["anonymous"])
|
||||
self.assertEqual(fake_source.call_args.kwargs["token"], "env-token")
|
||||
|
||||
def test_github_stored_token_takes_precedence_over_env(self) -> None:
|
||||
config = ActivityConfig(github=[GithubSettings(username="u", token="tok")])
|
||||
spec = build_specs(config)[0]
|
||||
with (
|
||||
mock.patch("weekly_activity.aggregate.GitHubSource") as fake_source,
|
||||
mock.patch.dict(os.environ, {"MY_GH_TOKEN": "env-token"}),
|
||||
):
|
||||
spec.make()
|
||||
self.assertEqual(fake_source.call_args.kwargs["token"], "tok")
|
||||
|
||||
|
||||
class CollectAndFormatTest(unittest.TestCase):
|
||||
@@ -89,6 +150,13 @@ class CollectAndFormatTest(unittest.TestCase):
|
||||
self.assertIn("Activity report — alpha / ~a", text)
|
||||
self.assertIn("[skipped: beta — RuntimeError: kaput]", text)
|
||||
|
||||
def test_heading_uses_account_label_not_bare_source_name(self) -> None:
|
||||
since, until = window()
|
||||
specs = [SourceSpec(name="github/work", username="acme-jane",
|
||||
make=lambda: StubSource("github"))]
|
||||
text = format_combined(collect_specs(specs, since, until), since, until)
|
||||
self.assertIn("Activity report — github/work / ~acme-jane", text)
|
||||
|
||||
def test_warning_surfaced_inside_block(self) -> None:
|
||||
since, until = window()
|
||||
specs = [SourceSpec(name="gamma", username="g", make=lambda: StubSource("gamma"))]
|
||||
|
||||
Reference in New Issue
Block a user