deploy-checkup 0.1.0__tar.gz → 0.1.1__tar.gz

{deploy_checkup-0.1.0/src/deploy_checkup.egg-info → deploy_checkup-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deploy-checkup
-Version: 0.1.0
+Version: 0.1.1
 Summary: Check whether your deployed app is set up safely, in plain language, with fixes for your host.
 Author: Nandhagopal
 License-Expression: MIT

{deploy_checkup-0.1.0 → deploy_checkup-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "deploy-checkup"
-version = "0.1.0"
+version = "0.1.1"
 description = "Check whether your deployed app is set up safely, in plain language, with fixes for your host."
 readme = "README.md"
 license = "MIT"

{deploy_checkup-0.1.0 → deploy_checkup-0.1.1}/src/deploy_checkup/checks/cors.py

@@ -1,6 +1,6 @@
 import httpx
 
-from deploy_checkup.models import Finding, Level
+from deploy_checkup.models import Finding, Level, could_not_finish
 
 CHECK = "cors"
 MADE_UP_SITE = "https://deploy-checkup-test.invalid"  # .invalid can never be a real website
@@ -12,9 +12,8 @@ def check_cors(client: httpx.Client, api_url: str, frontend_url: str) -> list[Fi
     try:
         as_frontend = client.get(api_url, headers={"Origin": frontend})
         as_stranger = client.get(api_url, headers={"Origin": MADE_UP_SITE})
-    except httpx.RequestError:
-        return []  # the other checks already report connection problems
-
+    except httpx.RequestError as error:
+        return [could_not_finish(CHECK, error)]
     return [
         _check_own_frontend(as_frontend, frontend),
         _check_other_sites(as_stranger),

{deploy_checkup-0.1.0 → deploy_checkup-0.1.1}/src/deploy_checkup/checks/exposed_files.py

@@ -2,8 +2,7 @@ import re
 
 import httpx
 
-from deploy_checkup.models import Finding, Level
-
+from deploy_checkup.models import Finding, Level, could_not_finish
 CHECK = "exposed_files"
 
 
@@ -28,8 +27,8 @@ def check_exposed_files(client: httpx.Client, url: str) -> list[Finding]:
     for path, looks_real in PATHS.items():
         try:
             response = client.get(httpx.URL(url).join(path))
-        except httpx.RequestError:
-            return []  # the other checks already report connection problems
+        except httpx.RequestError as error:
+            return findings + [could_not_finish(CHECK, error)]
 
         is_html = "text/html" in response.headers.get("content-type", "")
         if response.status_code == 200 and not is_html and looks_real(response.text):

{deploy_checkup-0.1.0 → deploy_checkup-0.1.1}/src/deploy_checkup/checks/headers.py

@@ -1,6 +1,5 @@
 import httpx
-from deploy_checkup.models import Finding, Level
-
+from deploy_checkup.models import Finding, Level, could_not_finish
 
 CHECK = "headers"
 SIX_MONTHS= 15_552_000 #seconds
@@ -10,8 +9,8 @@ def check_headers(client: httpx.Client , url:str)->list[Finding]:
     try:
         response = client.get(url, follow_redirects=True)
         
-    except httpx.RequestError:
-        return []
+    except httpx.RequestError as error:
+        return [could_not_finish(CHECK, error)]
     
     headers = response.headers
     return [

deploy_checkup-0.1.1/src/deploy_checkup/models.py

@@ -0,0 +1,31 @@
+from dataclasses import dataclass
+from enum import Enum
+
+
+class Level(str, Enum):
+    PASS = "pass"
+    WARNING = "warning"
+    FAIL = "fail"
+    INFO = "info"
+
+
+@dataclass(frozen=True)
+class Finding:
+    check: str
+    level: Level
+    title: str
+    why: str = ""
+    fix: str = ""  # works on any host
+    render_fix: str = ""  # replaces fix when the site is on Render
+    
+
+
+def could_not_finish(check: str, error: Exception) -> Finding:
+    """A check that hit a network error says so, instead of quietly disappearing."""
+    return Finding(
+        check=check,
+        level=Level.INFO,
+        title=f"Couldn't finish the {check} check ({type(error).__name__})",
+        why="The site stopped answering partway through, so this part wasn't checked.",
+        fix="Run deploy-checkup again. If it keeps happening, check your site's logs.",
+    )

{deploy_checkup-0.1.0 → deploy_checkup-0.1.1/src/deploy_checkup.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: deploy-checkup
-Version: 0.1.0
+Version: 0.1.1
 Summary: Check whether your deployed app is set up safely, in plain language, with fixes for your host.
 Author: Nandhagopal
 License-Expression: MIT

{deploy_checkup-0.1.0 → deploy_checkup-0.1.1}/tests/test_cors.py

@@ -77,4 +77,19 @@ def test_sends_frontend_origin_then_made_up_origin():
 
 def test_origin_drops_path_and_keeps_unusual_port():
     assert _origin("https://app.example.com/dashboard?x=1") == "https://app.example.com"
-    assert _origin("http://127.0.0.1:8000/") == "http://127.0.0.1:8000"
+    assert _origin("http://127.0.0.1:8000/") == "http://127.0.0.1:8000"
+    
+def test_network_error_partway_is_reported_not_hidden():
+    calls = []
+
+    def handler(request):
+        calls.append(request)
+        if len(calls) == 2:
+            raise httpx.ReadTimeout("timed out", request=request)
+        return httpx.Response(200)
+
+    findings = check(handler)
+
+    assert len(findings) == 1
+    assert findings[0].level == Level.INFO
+    assert "ReadTimeout" in findings[0].title

{deploy_checkup-0.1.0 → deploy_checkup-0.1.1}/tests/test_exposed_files.py

@@ -57,4 +57,16 @@ def test_secret_values_are_never_shown():
     findings = check(site({"/.env": "SECRET_KEY=abc123\n"}))
 
     for finding in findings:
-        assert "abc123" not in finding.title + finding.why + finding.fix
+        assert "abc123" not in finding.title + finding.why + finding.fix
+
+def test_network_error_keeps_earlier_results_and_says_so():
+    def handler(request):
+        if request.url.path == "/.git/config":
+            raise httpx.ReadTimeout("timed out", request=request)
+        return httpx.Response(404)
+
+    findings = check(handler)
+
+    assert find(findings, "/.env").level == Level.PASS
+    assert findings[-1].level == Level.INFO
+    assert "Couldn't finish" in findings[-1].title

{deploy_checkup-0.1.0 → deploy_checkup-0.1.1}/tests/test_headers.py

@@ -52,13 +52,15 @@ def test_nosniff_missing_warns():
     assert find(findings, "X-Content-Type-Options").level == Level.WARNING
 
 
-def test_connection_error_returns_nothing():
+def test_connection_error_is_reported_not_hidden():
     def handler(request):
         raise httpx.ConnectError("connection refused", request=request)
 
     findings = check_headers(httpx.Client(transport=httpx.MockTransport(handler)), URL)
 
-    assert findings == []
+    assert len(findings) == 1
+    assert findings[0].level == Level.INFO
+    assert "Couldn't finish the headers check" in findings[0].title
 
 def test_csp_present_passes():
     findings = run_with_headers({"Content-Security-Policy": "default-src 'self'"})

{deploy_checkup-0.1.0 → deploy_checkup-0.1.1}/tests/test_models.py

@@ -36,4 +36,11 @@ def test_level_from_string():
     assert Level("warning") is Level.WARNING
     
     with pytest.raises(ValueError):
-        Level("warn")
+        Level("warn")
+def test_could_not_finish_names_the_check_and_error():
+    from deploy_checkup.models import could_not_finish
+
+    finding = could_not_finish("cors", TimeoutError("slow"))
+
+    assert finding.level == Level.INFO
+    assert finding.title == "Couldn't finish the cors check (TimeoutError)"

deploy_checkup-0.1.0/src/deploy_checkup/models.py

@@ -1,19 +0,0 @@
-from dataclasses import dataclass
-from enum import Enum
-
-
-class Level(str, Enum):
-    PASS = "pass"
-    WARNING = "warning"
-    FAIL = "fail"
-    INFO = "info"
-
-
-@dataclass(frozen=True)
-class Finding:
-    check: str
-    level: Level
-    title: str
-    why: str = ""
-    fix: str = ""  # works on any host
-    render_fix: str = ""  # replaces fix when the site is on Render