A case study... (#194)

* Use a third-party dependency in the sample

A case study of "test it if you expect it to work".

* Add types-requests for mypy

* Install requirements.txt as expected

The conclusion of the case study.

Author: Preocts

noxfile.py

@@ -71,7 +71,9 @@ def run_tests_with_coverage(session: nox.Session) -> None:
     """Run pytest with coverage, outputs console report and json."""
     print_standard_logs(session)
 
-    session.install(".", "-r", f"{REQUIREMENTS_PATH}/requirements-test.txt")
+    session.install(".")
+    session.install("-r", f"{REQUIREMENTS_PATH}/requirements.txt")
+    session.install("-r", f"{REQUIREMENTS_PATH}/requirements-test.txt")
 
     coverage = partial(session.run, "python", "-m", "coverage")
 
@@ -103,7 +105,9 @@ def run_linters_and_formatters(session: nox.Session) -> None:
     """Run code formatters, linters, and type checking against all files."""
     print_standard_logs(session)
 
-    session.install(".", "-r", f"{REQUIREMENTS_PATH}/requirements-dev.txt")
+    session.install(".")
+    session.install("-r", f"{REQUIREMENTS_PATH}/requirements.txt")
+    session.install("-r", f"{REQUIREMENTS_PATH}/requirements-dev.txt")
 
     python = partial(session.run, "python", "-m")
 

requirements/requirements-dev.txt

@@ -12,3 +12,4 @@ isort
 
 # type checking
 mypy
+types-requests

src/module_name/sample.py

@@ -2,6 +2,8 @@
 
 from __future__ import annotations
 
+import requests
+
 
 def main() -> bool:
     """Main"""
@@ -17,3 +19,8 @@ def squared(value: int) -> int:
 def isodd(value: int) -> bool:
     """Return if value is odd."""
     return bool(value % 2)
+
+
+def health_check() -> bool:
+    """Returns true when github.com is accessible."""
+    return requests.get("https://github.com").ok

tests/test_sample.py tests/sample_test.pytests/test_sample.py renamed to tests/sample_test.py

@@ -7,7 +7,7 @@
 from module_name import sample
 
 
-def test_main():
+def test_main() -> None:
     """Main test"""
     assert sample.main()
 
@@ -20,5 +20,9 @@ def test_main():
         (16, 256),
     ),
 )
-def test_squared(value_in, expected):
+def test_squared(value_in: int, expected: int) -> None:
     assert sample.squared(value_in) == expected
+
+
+def test_health_check() -> None:
+    assert sample.health_check()