Merge pull request #4 from mstred/testing

"Testing" chapter

Author: mstred

.gitignore

@@ -1 +1,4 @@
 **/__pycache__
+.coverage
+.nox
+.pytest_cache

docker-compose.yaml

@@ -5,5 +5,5 @@ services:
     image: docker.pkg.github.com/mstred/hypermodern-python/image
     build: .
     volumes:
-      - ${PWD}:/app
+      - .:/app
     working_dir: /app

noxfile.py

@@ -0,0 +1,8 @@
+from nox import session as nox_session
+
+
+@nox_session()
+def tests(session):
+    session.run("poetry", "install", external=True)
+    session.run("pytest", *(session.posargs or ["--cov", "-m", "not e2e"]))
+

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "hypermodern"
-version = "0.2.0"
+version = "0.3.0"
 description = ""
 authors = ["Edson Samuel Jr <[email protected]>"]
 repository = "https://github.com/mstred/hypermodern-python"
@@ -11,10 +11,26 @@ click = "^7.1.2"
 requests = "^2.25.1"
 
 [tool.poetry.dev-dependencies]
+coverage = {extras = ["toml"], version = "^5.3"}
+nox = "^2020.8.22"
+pytest = "^6.2.1"
+pytest-cov = "^2.10.1"
+pytest-mock = "^3.4.0"
 
 [tool.poetry.scripts]
 app = "hypermodern.app:main"
 
+[tool.coverage.paths]
+source = ["src", "*/site-packages"]
+
+[tool.coverage.run]
+branch = true
+source = ["hypermodern"]
+
+[tool.coverage.report]
+show_missing = true
+fail_under = 100
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -1 +1 @@
-__version__ = "0.2.0"
+__version__ = "0.3.0"

src/hypermodern/__init__.py

@@ -1,21 +1,26 @@
 from textwrap import fill
 
-from click import command, secho, version_option
-from requests import get
+import click
 
 from hypermodern import __version__ as version
+from hypermodern import wikipedia
 
-API_URL = "https://en.wikipedia.org/api/rest_v1/page/random/summary"
 
-@command()
-@version_option(version)
-def main():
-    secho(f"Hello, this is hypermodern {version}!", fg="green")
+@click.command()
+@click.option(
+    "--language", 
+    "-l", 
+    default="en", 
+    help="Choose an ISO-639 code for language", 
+    metavar="LANG", 
+    show_default=True
+)
+@click.version_option(version)
+def main(language):
+    click.secho(f"Hello, this is hypermodern {version}!", fg="green")
 
-    with get(API_URL) as response:
-        response.raise_for_status()
-        data = response.json()
+    data = wikipedia.get_random_page(language=language)
 
-    secho(data["title"], fg="yellow")
-    secho(fill(data["extract"]))
+    click.secho(data["title"], fg="yellow")
+    click.secho(fill(data["extract"]))
 

src/hypermodern/app.py

@@ -0,0 +1,14 @@
+from click import ClickException
+from requests import get, RequestException
+
+
+def get_random_page(language="en"):
+    API_URL = f"https://{language}.wikipedia.org/api/rest_v1/page/random/summary"
+
+    try:
+        with get(API_URL) as response:
+            response.raise_for_status()
+            return response.json()
+    except RequestException as exception:
+        raise ClickException(str(exception))
+

src/hypermodern/wikipedia.py

@@ -0,0 +1,28 @@
+from click.testing import CliRunner
+from pytest import fixture
+
+
+@fixture
+def runner():
+    return CliRunner()
+
+
+@fixture
+def mock_requests_get(mocker):
+    mock = mocker.patch("hypermodern.wikipedia.get")
+    mock.return_value.__enter__.return_value.json.return_value = {
+        "title": "title",
+        "extract": "extract"
+    }
+
+    return mock
+
+
+@fixture
+def mock_get_random_page(mocker):
+    return mocker.patch("hypermodern.wikipedia.get_random_page")
+
+
+def pytest_configure(config):
+    config.addinivalue_line("markers", "e2e: mark as end-to-end test")
+

tests/__init__.py

@@ -0,0 +1,51 @@
+from pytest import mark
+from requests import RequestException
+
+from hypermodern import app
+from hypermodern.wikipedia import get_random_page
+
+
+@mark.e2e
+def test_main_pass(runner):
+    result = runner.invoke(app.main)
+    assert result.exit_code == 0
+
+
+def test_main_pass_mocked(runner, mock_requests_get):
+    result = runner.invoke(app.main)
+    assert result.exit_code == 0
+
+
+def test_main_requests_get_is_called(runner, mock_requests_get):
+    runner.invoke(app.main)
+    assert mock_requests_get.called
+
+
+def test_main_requests_wikipedia_api(runner, mock_requests_get):
+    runner.invoke(app.main)
+    assert "en.wikipedia.org/api" in str(mock_requests_get.call_args.args)
+
+
+def test_main_check_content(runner, mock_requests_get):
+    result = runner.invoke(app.main)
+    assert "title" in result.output and "extract" in result.output
+
+
+def test_main_request_failed(runner, mock_requests_get):
+    mock_requests_get.side_effect = Exception()
+    result = runner.invoke(app.main)
+    assert result.exit_code != 0
+
+
+def test_main_prints_on_failed_request(runner, mock_requests_get):
+    mock_requests_get.side_effect = RequestException()
+    result = runner.invoke(app.main)
+    print(result.output)
+    assert "Error" in result.output
+
+
+def test_main_with_specific_language(runner, mock_get_random_page):
+    language = "pt"
+    runner.invoke(app.main, [f"--language={language}"])
+    assert mock_get_random_page.called_with(language=language)
+

tests/conftest.py

@@ -0,0 +1,7 @@
+from hypermodern.wikipedia import get_random_page
+
+
+def test_get_random_page_with_specific_language(mock_requests_get):
+    get_random_page(language="de")
+    assert "de.wikipedia.org" in str(mock_requests_get.call_args.args)
+