chore(deps): update from template

helmut-hoffer-von-ankershoffen · helmut-hoffer-von-ankershoffen · commit 5ed5c7467999 · 2025-04-08T10:32:41.000+02:00
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,4 +1,4 @@
-_commit: v0.9.4
+_commit: v0.9.6
 _src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template
 attestations_enabled: true
 author_email: helmuthva@googlemail.com
diff --git a/ATTRIBUTIONS.md b/ATTRIBUTIONS.md
@@ -1963,7 +1963,7 @@ SOFTWARE.
 
 ```
 
-## brave-search-python-client (0.4.15) - MIT License
+## brave-search-python-client (0.4.18) - MIT License
 
 🦁 Brave Search Python Client supporting Web, Image, News and Video search.
 
diff --git a/CLI_REFERENCE.md b/CLI_REFERENCE.md
@@ -12,7 +12,7 @@ $ brave-search-python-client [OPTIONS] COMMAND [ARGS]...
 * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
 * `--help`: Show this message and exit.
 
-🦁 Brave Search Python Client v0.4.16 - built with love in Berlin 🐻
+🦁 Brave Search Python Client v0.4.18 - built with love in Berlin 🐻
 
 **Commands**:
 
diff --git a/Dockerfile b/Dockerfile
@@ -17,26 +17,30 @@ ENV PATH="/app/.venv/bin:$PATH"
 RUN --mount=type=cache,target=/root/.cache/uv \
     --mount=type=bind,source=uv.lock,target=uv.lock \
     --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
-    uv sync --frozen --no-install-project --no-dev --no-editable
+    uv sync --frozen --no-install-project --all-extras --no-dev --no-editable
 
 # Then, add the rest of the project source code and install it
 # Installing separately from its dependencies allows optimal layer caching
 COPY pyproject.toml /app
+COPY .python-version /app
 COPY uv.lock /app
 COPY src /app/src
-COPY .env.example /app/.env.example
-COPY tests /app/tests
 COPY LICENSE /app
 COPY *.md /app
-COPY .python-version /app
+
+COPY .env.example /app/.env.example
+COPY tests /app/tests
+
+# Install project specifics
+# Nothing yet
 
 RUN --mount=type=cache,target=/root/.cache/uv \
-    uv sync --frozen --no-dev --no-editable
+    uv sync --frozen --all-extras --no-dev --no-editable
 
 ENV BRAVE_SEARCH_PYTHON_CLIENT_RUNNING_IN_CONTAINER=1
 
 # No healthcheck by default
 HEALTHCHECK NONE
 
 # But feel free to add arguments and options as needed when doing a docker run
-ENTRYPOINT ["uv", "run", "--no-dev", "brave-search-python-client"]
+ENTRYPOINT ["uv", "run", "--all-extras", "--no-dev", "brave-search-python-client"]
diff --git a/Makefile b/Makefile
@@ -1,7 +1,7 @@
 # Makefile for running common development tasks
 
 # Define all PHONY targets
-.PHONY: all act audit bump clean dist docs docker_build lint setup setup test test_scheduled update_from_template
+.PHONY: all act audit bump clean dist docs docker_build lint setup setup test test_scheduled test_long_running update_from_template
 
 # Main target i.e. default sessions defined in noxfile.py
 all:
@@ -34,6 +34,10 @@ act audit bump dist docs lint setup test update_from_template:
 test_scheduled:
 	uv run --all-extras nox -s test -p 3.11 -- -m scheduled
 
+## Run tests marked as long_running
+test_long_running:
+	uv run --all-extras nox -s test -p 3.11 -- -m long_running
+
 ## Clean build artifacts and caches
 clean:
 	rm -rf .mypy_cache
@@ -73,6 +77,7 @@ help:
 	@echo "  setup                 - Setup development environment"
 	@echo "  test [3.11|3.12|3.13] - Run tests (for specific Python version)"
 	@echo "  test_scheduled        - Run tests marked as scheduled with Python 3.11"
+	@echo "  test_long_running     - Run tests marked as long running with Python 3.11"
 	@echo "  update_from_template  - Update from template using copier"
 	@echo ""
 	@echo "Built with love in Berlin 🐻"
diff --git a/README.md b/README.md
diff --git a/noxfile.py b/noxfile.py
@@ -467,6 +467,8 @@ def test(session: nox.Session) -> None:
     pytest_args = ["pytest", "--disable-warnings", JUNIT_XML, "-n", "auto", "--dist", "loadgroup"]
     if _is_act_environment():
         pytest_args.extend(["-k", NOT_SKIP_WITH_ACT])
+    if session.posargs:
+        pytest_args.extend(session.posargs)
     session.run(*pytest_args)
 
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -255,10 +255,12 @@ asyncio_default_fixture_loop_scope = "function"
 env = ["COVERAGE_FILE=.coverage", "COVERAGE_PROCESS_START=pyproject.toml"]
 markers = [
     # From Template
-    "no_extras: tests that do require no extras installed",
-    "scheduled: tests to run on a schedule",
-    "sequential: exclude from parallel test execution",
-    "skip_with_act: don't run with act",
+    "no_extras: Tests that do require no extras installed.",
+    "scheduled: Tests to run on a schedule. They will still be part on non-scheduled test executions.",
+    "sequential: Exclude from parallel test execution.",
+    "skip_with_act: Don't run with act.",
+    "docker: tests That require Docker.",
+    "long_running: Tests that take a long time to run. Tests marked as long runing excluded from execution by default. Enable by passing any -m your_marker that matches a marker of the test.",
     # Custom
     # Nothing yet
 ]
diff --git a/sonar-project.properties b/sonar-project.properties
@@ -8,5 +8,5 @@ sonar.links.ci=https://github.com/helmut-hoffer-von-ankershoffen/brave-search-py
 sonar.links.issues=https://github.com/helmut-hoffer-von-ankershoffen/brave-search-python-client/issues
 sonar.python.coverage.reportPaths=reports/coverage.xml
 sonar.python.version=3.11, 3.12, 3.13
-sonar.coverage.exclusions=noxfile.py, tests/**, examples/**, docs/**
-sonar.exclusions=examples/**, docs/**
+sonar.coverage.exclusions=noxfile.py, tests/**, examples/**, docs/**, dist/**, dist_vercel/**
+sonar.exclusions=examples/**, docs/**, dist/**, dist_vercel/**
diff --git a/tests/brave_search_python_client/__init__.py b/tests/brave_search_python_client/__init__.py
@@ -0,0 +1 @@
+"""Test suite for package brave_search_python_client."""
diff --git a/tests/brave_search_python_client/cli_test.py b/tests/brave_search_python_client/cli_test.py
@@ -0,0 +1,96 @@
+"""Tests to verify the CLI functionality of Brave Search Python Client."""
+
+import json
+from unittest.mock import patch
+
+import pytest
+from typer.testing import CliRunner
+
+from brave_search_python_client import (
+    BraveSearch,
+    ImageSearchApiResponse,
+    NewsSearchApiResponse,
+    VideoSearchApiResponse,
+    WebSearchApiResponse,
+    __version__,
+)
+from brave_search_python_client.cli import cli
+
+TEST_QUERY = "hello world"
+BUILT_WITH_LOVE = "built with love in Berlin"
+SEARCH_QUERY_HELP = "The search query to perform"
+
+with open("tests/fixtures/web.json", encoding="utf-8") as f:
+    mock_web_search_response_data = json.load(f)
+mock_web_search_response = WebSearchApiResponse.model_validate(
+    mock_web_search_response_data,
+)
+
+with open("tests/fixtures/images.json", encoding="utf-8") as f:
+    mock_image_search_response_data = json.load(f)
+mock_image_search_response = ImageSearchApiResponse.model_validate(
+    mock_image_search_response_data,
+)
+
+with open("tests/fixtures/videos.json", encoding="utf-8") as f:
+    mock_video_search_response_data = json.load(f)
+mock_video_search_response = VideoSearchApiResponse.model_validate(
+    mock_video_search_response_data,
+)
+
+with open("tests/fixtures/news.json", encoding="utf-8") as f:
+    mock_news_search_response_data = json.load(f)
+mock_news_search_response = NewsSearchApiResponse.model_validate(
+    mock_news_search_response_data,
+)
+
+
+@pytest.fixture
+def runner() -> CliRunner:
+    """Provide a CLI test runner fixture."""
+    return CliRunner()
+
+
+def test_cli_built_with_love(runner) -> None:
+    """Check epilog shown."""
+    result = runner.invoke(cli, ["--help"])
+    assert result.exit_code == 0
+    assert BUILT_WITH_LOVE in result.output
+    assert __version__ in result.output
+
+
+def test_cli_commands(runner: CliRunner) -> None:
+    """Check commands exist and show help and epilog."""
+    for command in ["web", "images", "videos", "news"]:
+        result = runner.invoke(cli, [command, "--help"])
+    assert result.exit_code == 0
+    assert SEARCH_QUERY_HELP in result.output
+    assert f"Search {command}" in result.output or f"Search the {command}" in result.output
+    assert __version__ in result.output
+
+
+def test_cli_search(runner: CliRunner) -> None:
+    """Check search triggered."""
+    with patch.object(BraveSearch, "web", return_value=mock_web_search_response):
+        result = runner.invoke(cli, ["web", TEST_QUERY])
+        assert result.exit_code == 0
+        response = json.loads(result.output)
+        assert response["type"] == "search"
+
+    with patch.object(BraveSearch, "images", return_value=mock_image_search_response):
+        result = runner.invoke(cli, ["images", TEST_QUERY])
+        assert result.exit_code == 0
+        response = json.loads(result.output)
+        assert response["type"] == "images"
+
+    with patch.object(BraveSearch, "videos", return_value=mock_video_search_response):
+        result = runner.invoke(cli, ["videos", TEST_QUERY])
+        assert result.exit_code == 0
+        response = json.loads(result.output)
+        assert response["type"] == "videos"
+
+    with patch.object(BraveSearch, "news", return_value=mock_news_search_response):
+        result = runner.invoke(cli, ["news", TEST_QUERY])
+        assert result.exit_code == 0
+        response = json.loads(result.output)
+        assert response["type"] == "news"
diff --git a/tests/brave_search_python_client/docker_test.py b/tests/brave_search_python_client/docker_test.py
@@ -0,0 +1,17 @@
+"""Tests to verify the CLI functionality of Brave Search Python Client works with Docker."""
+
+import pytest
+
+BUILT_WITH_LOVE = "built with love in Berlin"
+
+
+@pytest.mark.xdist_group(name="docker")
+@pytest.mark.skip_with_act
+@pytest.mark.docker
+@pytest.mark.long_running
+@pytest.mark.scheduled
+def test_core_docker_cli_help_with_love(docker_services) -> None:
+    """Test the CLI help command with docker services returns expected output."""
+    out = docker_services._docker_compose.execute("run brave-search-python-client --help")
+    out_str = out.decode("utf-8")
+    assert "built with love in Berlin" in out_str
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,15 +1,60 @@
 """Common test fixtures and configuration."""
 
+import os
 from pathlib import Path
 
 import pytest
 
 
+def pytest_collection_modifyitems(config, items) -> None:
+    """Modify collected test items by skipping tests marked as 'long_running' unless matching marker given.
+
+    Args:
+        config: The pytest configuration object.
+        items: The list of collected test items.
+    """
+    if not config.getoption("-m"):
+        skip_me = pytest.mark.skip(reason="skipped as no marker given on execution using '-m'")
+        for item in items:
+            if "long_running" in item.keywords:
+                item.add_marker(skip_me)
+
+
 @pytest.fixture(scope="session")
 def docker_compose_file(pytestconfig) -> str:
     """Get the path to the docker compose file.
 
+    Args:
+        pytestconfig: The pytest configuration object.
+
     Returns:
         str: The path to the docker compose file.
     """
+    # We want to test the compose.yaml file in the root of the project.
     return str(Path(pytestconfig.rootdir) / "compose.yaml")
+
+
+@pytest.fixture(scope="session")
+def docker_setup() -> list[str] | str:
+    """Commands to run when spinning up services.
+
+    Args:
+        scope: The scope of the fixture.
+
+    Returns:
+        list[str] | str: The commands to run.
+    """
+    # You can consider to return an empty list so you can decide on the
+    # commands to run in the test itself
+    return ["up --build -d"]
+
+
+def docker_compose_project_name() -> str:
+    """Generate a project name using the current process PID.
+
+    Returns:
+        str: The project name.
+    """
+    # You can consider to override this with a project name to reuse the stack
+    # across test executions.
+    return f"pytest{os.getpid()}"
diff --git a/tests/fixtures/.keep b/tests/fixtures/.keep
diff --git a/tests/fixtures/__init__.py b/tests/fixtures/__init__.py
@@ -0,0 +1 @@
+"""Fixtures shared accross test suite."""

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-_commit: v0.9.4`
	`1`	`+_commit: v0.9.6`
`2`	`2`	`_src_path: gh:helmut-hoffer-von-ankershoffen/oe-python-template`
`3`	`3`	`attestations_enabled: true`
`4`	`4`	`author_email: helmuthva@googlemail.com`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+"""Test suite for package brave_search_python_client."""`