Lazily read plugin environment variables

Author: patrick91

README.md

@@ -44,7 +44,7 @@ Plugin path:
 strawberry_autopub_plugins.invite_contributors:InviteContributorsPlugin
 ```
 
-Required environment variables:
+Environment variables used when the plugin needs to call the GitHub API:
 
 - `GITHUB_TOKEN`
 - `GITHUB_REPOSITORY`
@@ -86,7 +86,7 @@ Plugin path:
 strawberry_autopub_plugins.typefully:TypefullyPlugin
 ```
 
-Required environment variables:
+Environment variables used when the plugin needs to create a Typefully draft:
 
 - `TYPEFULLY_API_KEY`
 
@@ -95,6 +95,7 @@ Optional environment variables:
 - `TYPEFULLY_SOCIAL_SET_ID`
 
 You can provide the social set ID either through `social-set-id` in config or `TYPEFULLY_SOCIAL_SET_ID`.
+In `dry-run` mode, the plugin can render the request body without requiring either value.
 
 Example config:
 

src/strawberry_autopub_plugins/invite_contributors.py

@@ -48,15 +48,19 @@ class InviteContributorsPlugin(AutopubPlugin):
     id = "invite_contributors"
     Config = InviteContributorsConfig
 
-    def __init__(self) -> None:
-        self.github_token = os.environ.get("GITHUB_TOKEN")
-        self.repository_name = os.environ.get("GITHUB_REPOSITORY")
-
-        if not self.github_token:
+    @property
+    def github_token(self) -> str:
+        github_token = os.environ.get("GITHUB_TOKEN")
+        if not github_token:
             raise AutopubException("GITHUB_TOKEN environment variable is required")
+        return github_token
 
-        if not self.repository_name:
+    @property
+    def repository_name(self) -> str:
+        repository_name = os.environ.get("GITHUB_REPOSITORY")
+        if not repository_name:
             raise AutopubException("GITHUB_REPOSITORY environment variable is required")
+        return repository_name
 
     @cached_property
     def _github(self) -> Github:

src/strawberry_autopub_plugins/typefully.py

@@ -55,11 +55,12 @@ class TypefullyPlugin(AutopubPlugin):
     Config = TypefullyConfig
     BASE_URL = "https://api.typefully.com"
 
-    def __init__(self) -> None:
-        self.api_key = os.environ.get("TYPEFULLY_API_KEY")
-
-        if not self.api_key:
+    @property
+    def api_key(self) -> str:
+        api_key = os.environ.get("TYPEFULLY_API_KEY")
+        if not api_key:
             raise _autopub_error("TYPEFULLY_API_KEY environment variable is required")
+        return api_key
 
     def _format_message(
         self,
@@ -197,17 +198,17 @@ def _create_draft(self, body: dict[str, object]) -> None:
             ) from exc
 
     def post_publish(self, release_info: ReleaseInfo) -> None:
-        if not self.config.social_set_id:
-            raise _autopub_error(
-                "social-set-id config or TYPEFULLY_SOCIAL_SET_ID environment variable is required"
-            )
-
         body = self._build_request_body(release_info)
 
         if self.config.dry_run:
             print(f"[typefully] dry run — request body: {body}")
             return
 
+        if not self.config.social_set_id:
+            raise _autopub_error(
+                "social-set-id config or TYPEFULLY_SOCIAL_SET_ID environment variable is required"
+            )
+
         self._create_draft(body)
 
 

tests/test_invite_contributors.py

@@ -2,8 +2,10 @@
 
 from unittest.mock import MagicMock
 
+import pytest
 from github.GithubException import GithubException
 
+from autopub.exceptions import AutopubException
 from autopub.types import ReleaseInfo
 from strawberry_autopub_plugins.invite_contributors import (
     KNOWN_BOT_EXCLUSIONS,
@@ -144,3 +146,21 @@ def test_default_config_skips_known_bot_usernames(monkeypatch) -> None:
     assert plugin.config.skip_bots is True
     assert plugin.config.exclude_users == KNOWN_BOT_EXCLUSIONS
     assert filtered == ["author"]
+
+
+def test_missing_github_env_is_only_checked_when_needed(monkeypatch) -> None:
+    monkeypatch.delenv("GITHUB_TOKEN", raising=False)
+    monkeypatch.delenv("GITHUB_REPOSITORY", raising=False)
+
+    plugin = InviteContributorsPlugin()
+    plugin.validate_config({})
+
+    plugin.pull_request = None
+    plugin.post_publish(_release_info())
+
+    plugin.pull_request = MagicMock()
+    plugin.pull_request.user.login = "author"
+    plugin.pull_request.get_commits.return_value = []
+
+    with pytest.raises(AutopubException, match="GITHUB_TOKEN"):
+        plugin.post_publish(_release_info())

tests/test_typefully.py

@@ -72,8 +72,24 @@ def _get_request_body(mock_urlopen) -> dict:
 def test_missing_api_key_raises(monkeypatch) -> None:
     monkeypatch.delenv("TYPEFULLY_API_KEY", raising=False)
 
+    plugin = TypefullyPlugin()
+    plugin.validate_config({"plugin_config": {"typefully": {"social-set-id": "abc-123"}}})
+
     with pytest.raises(AutopubException, match="TYPEFULLY_API_KEY"):
-        TypefullyPlugin()
+        plugin.post_publish(_release_info())
+
+
+def test_dry_run_does_not_require_api_key_or_social_set_id(monkeypatch, capsys) -> None:
+    monkeypatch.delenv("TYPEFULLY_API_KEY", raising=False)
+    monkeypatch.delenv("TYPEFULLY_SOCIAL_SET_ID", raising=False)
+
+    plugin = TypefullyPlugin()
+    plugin.validate_config({"plugin_config": {"typefully": {"dry-run": True}}})
+
+    plugin.post_publish(_release_info())
+
+    output = capsys.readouterr().out
+    assert "[typefully] dry run" in output
 
 
 @patch("strawberry_autopub_plugins.typefully.urlopen")