Option to auth with GITHUB_TOKEN env var, closes dogsheep#33

simonw · simonw · commit 10fb34de41aa · 2020-05-02T11:45:31.000-07:00
diff --git a/README.md b/README.md
@@ -25,6 +25,8 @@ Run this command and paste in your new token:
 
 This will create a file called `auth.json` in your current directory containing the required value. To save the file at a different path or filename, use the `--auth=myauth.json` option.
 
+As an alternative to using an `auth.json` file you can add your access token to an environment variable called `GITHUB_TOKEN`.
+
 ## Fetching issues for a repository
 
 The `issues` command retrieves all of the issues belonging to a specified repository.
diff --git a/github_to_sqlite/cli.py b/github_to_sqlite/cli.py
@@ -335,4 +335,7 @@ def load_token(auth):
         token = json.load(open(auth))["github_personal_token"]
     except (KeyError, FileNotFoundError):
         token = None
+    if token is None:
+        # Fallback to GITHUB_TOKEN environment variable
+        token = os.environ.get("GITHUB_TOKEN") or None
     return token
diff --git a/tests/test_auth.py b/tests/test_auth.py
@@ -0,0 +1,46 @@
+from click.testing import CliRunner
+from github_to_sqlite import cli
+import json
+import os
+import pytest
+
+
+@pytest.fixture
+def mocked_starred(requests_mock):
+    requests_mock.get("https://api.github.com/user", json={"id": 1, "login": "test"})
+    m = requests_mock.get("https://api.github.com/user/starred", json=[])
+    return m
+
+
+def test_auth_command():
+    runner = CliRunner()
+    with runner.isolated_filesystem():
+        assert [] == os.listdir(".")
+        result = runner.invoke(cli.cli, ["auth"], input="zzz")
+        assert 0 == result.exit_code
+        assert ["auth.json"] == os.listdir(".")
+        assert {"github_personal_token": "zzz"} == json.load(open("auth.json"))
+
+
+def test_auth_file(mocked_starred):
+    runner = CliRunner()
+    with runner.isolated_filesystem():
+        open("auth.json", "w").write(json.dumps({"github_personal_token": "xxx"}))
+        result = runner.invoke(
+            cli.cli, ["starred", "starred.db"], catch_exceptions=False
+        )
+        assert 0 == result.exit_code
+        assert mocked_starred.called
+        assert "token xxx" == mocked_starred.last_request.headers["authorization"]
+
+
+def test_auth_environment_variable(mocked_starred, monkeypatch):
+    monkeypatch.setenv("GITHUB_TOKEN", "xyz")
+    runner = CliRunner()
+    with runner.isolated_filesystem():
+        result = runner.invoke(
+            cli.cli, ["starred", "starred.db"], catch_exceptions=False
+        )
+        assert 0 == result.exit_code
+        assert mocked_starred.called
+        assert "token xyz" == mocked_starred.last_request.headers["authorization"]
