Improve test and add tox

- Isolation: Build test should not hit the internet now - Add tox: Running from 3.8..3.12 - Fix incompat: 3.11/3.12 were complaining about RepoStatus dataclass
pulp · Jan 16, 2024 · f678a19 · f678a19
1 parent 3324111
commit f678a19
Show file tree

Hide file tree

Showing 32 changed files with 34 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -36,17 +36,11 @@ And thats it, the magic is done.
 
 ## Setup
 
-Recommended of getting it up and running:
+Recommended way for daily usage:
 
 ```bash
-$ virtualenv --python python3.8 pulpdocs-venv
-$ . pulpdocs-venv/bin/activate
-$ pip install git+https://github.com/pedro-psb/pulp-docs
-$ pulp-docs --help
+$ pipx install git+https://github.com/pedro-psb/pulp-docs --include-deps
 $ pulp-docs serve
 ```
 
-Known issues:
-- doesn't work with newer versions of python, like 3.12
-- doesn't work with pipx (some problem with data assets packaging)
-
+For development, use your prefered method!
diff --git a/pyproject.toml b/pyproject.toml
@@ -25,4 +25,3 @@ pulp_docs = ["data/**"]
 [tool.setuptools.packages.find]
 where = ["src"]
 
-
diff --git a/src/pulp_docs/plugin_repos.py b/src/pulp_docs/plugin_repos.py
@@ -26,19 +26,22 @@
 RESTAPI_TEMPLATE = "https://docs.pulpproject.org/{}/restapi.html"
 
 
-@dataclass
+# @dataclass # raising errors in py311/312
 class RepoStatus:
     """
     Usefull status information about a downloaded repository.
     """
 
-    download_source: t.Optional[str] = None
-    use_local_checkout: bool = False
-    has_readme: bool = True
-    has_changelog: bool = True
-    has_staging_docs: bool = True
-    using_cache: bool = False
-    original_refs: t.Optional[str] = None # as defined in repolist.yml
+    def __init__(self, **kwargs):
+        self.download_source = kwargs.get("download_source", None)
+        self.download_source = kwargs.get("download_source", None)
+        self.use_local_checkout = kwargs.get("use_local_checkout", False)
+        self.has_readme = kwargs.get("has_readme", True)
+        self.has_changelog = kwargs.get("has_changelog", True)
+        self.has_staging_docs = kwargs.get("has_staging_docs", True)
+        self.using_cache = kwargs.get("using_cache", False)
+        self.original_refs = kwargs.get("original_refs", None)
+
 
 @dataclass
 class Repo:

diff --git a/tests/fixtures/pulpcore/docs/index.md → ...s/fixtures/pulpcore/staging_docs/index.md b/tests/fixtures/pulpcore/docs/index.md → ...s/fixtures/pulpcore/staging_docs/index.md
@@ -45,3 +45,4 @@ This is a landing page.
     [:octicons-arrow-right-24: License](#)
 
 </div>
+
diff --git a/.../fixtures/pulpcore/docs/reference/main.md → ...s/pulpcore/staging_docs/reference/main.md b/.../fixtures/pulpcore/docs/reference/main.md → ...s/pulpcore/staging_docs/reference/main.md
diff --git a/...ent/guides/How to bind analysis trade..md → ...ent/guides/How to bind analysis trade..md b/...ent/guides/How to bind analysis trade..md → ...ent/guides/How to bind analysis trade..md
diff --git a/...lpcore/docs/sections/development/index.md → ...taging_docs/sections/development/index.md b/...lpcore/docs/sections/development/index.md → ...taging_docs/sections/development/index.md
diff --git a/...ding/About autonomous Model deployment.md → ...ding/About autonomous Model deployment.md b/...ding/About autonomous Model deployment.md → ...ding/About autonomous Model deployment.md
diff --git a/...ding/On autonomous Database deployment.md → ...ding/On autonomous Database deployment.md b/...ding/On autonomous Database deployment.md → ...ding/On autonomous Database deployment.md
diff --git a/...arding/On scalable Database ecossystem.md → ...arding/On scalable Database ecossystem.md b/...arding/On scalable Database ecossystem.md → ...arding/On scalable Database ecossystem.md
diff --git a/...Understanding complex Model deployment.md → ...Understanding complex Model deployment.md b/...Understanding complex Model deployment.md → ...Understanding complex Model deployment.md
diff --git a/...development/quickstart/01-doc-workflow.md → ...development/quickstart/01-doc-workflow.md b/...development/quickstart/01-doc-workflow.md → ...development/quickstart/01-doc-workflow.md
diff --git a/...evelopment/quickstart/02-code-workflow.md → ...evelopment/quickstart/02-code-workflow.md b/...evelopment/quickstart/02-code-workflow.md → ...evelopment/quickstart/02-code-workflow.md
diff --git a/...evelopment/quickstart/_03-commit-guide.md → ...evelopment/quickstart/_03-commit-guide.md b/...evelopment/quickstart/_03-commit-guide.md → ...evelopment/quickstart/_03-commit-guide.md
diff --git a/...tals/About autonomous Model deployment.md → ...tals/About autonomous Model deployment.md b/...tals/About autonomous Model deployment.md → ...tals/About autonomous Model deployment.md
diff --git a/...tals/On autonomous Database deployment.md → ...tals/On autonomous Database deployment.md b/...tals/On autonomous Database deployment.md → ...tals/On autonomous Database deployment.md
diff --git a/...entals/On scalable Database ecossystem.md → ...entals/On scalable Database ecossystem.md b/...entals/On scalable Database ecossystem.md → ...entals/On scalable Database ecossystem.md
diff --git a/...Understanding complex Model deployment.md → ...Understanding complex Model deployment.md b/...Understanding complex Model deployment.md → ...Understanding complex Model deployment.md
diff --git a/...re/docs/sections/getting_started/index.md → ...ng_docs/sections/getting_started/index.md b/...re/docs/sections/getting_started/index.md → ...ng_docs/sections/getting_started/index.md
diff --git a/...getting_started/quickstart/01-overview.md → ...getting_started/quickstart/01-overview.md b/...getting_started/quickstart/01-overview.md → ...getting_started/quickstart/01-overview.md
diff --git a/...ns/getting_started/quickstart/02-setup.md → ...ns/getting_started/quickstart/02-setup.md b/...ns/getting_started/quickstart/02-setup.md → ...ns/getting_started/quickstart/02-setup.md
diff --git a/...ing_started/quickstart/03-installation.md → ...ing_started/quickstart/03-installation.md b/...ing_started/quickstart/03-installation.md → ...ing_started/quickstart/03-installation.md
diff --git a/...ng_started/quickstart/04-configuration.md → ...ng_started/quickstart/04-configuration.md b/...ng_started/quickstart/04-configuration.md → ...ng_started/quickstart/04-configuration.md
diff --git a/...tting_started/quickstart/05-deployment.md → ...tting_started/quickstart/05-deployment.md b/...tting_started/quickstart/05-deployment.md → ...tting_started/quickstart/05-deployment.md
diff --git a/...tting_started/quickstart/06-conclusion.md → ...tting_started/quickstart/06-conclusion.md b/...tting_started/quickstart/06-conclusion.md → ...tting_started/quickstart/06-conclusion.md
diff --git a/...es/pulpcore/docs/sections/guides/index.md → ...ore/staging_docs/sections/guides/index.md b/...es/pulpcore/docs/sections/guides/index.md → ...ore/staging_docs/sections/guides/index.md
diff --git a/...res/pulpcore/docs/sections/learn/index.md → ...core/staging_docs/sections/learn/index.md b/...res/pulpcore/docs/sections/learn/index.md → ...core/staging_docs/sections/learn/index.md
diff --git a/...s/sections/reference/01-repository-map.md → ...s/sections/reference/01-repository-map.md b/...s/sections/reference/01-repository-map.md → ...s/sections/reference/01-repository-map.md
diff --git a/...re/docs/sections/reference/02-glossary.md → ...ng_docs/sections/reference/02-glossary.md b/...re/docs/sections/reference/02-glossary.md → ...ng_docs/sections/reference/02-glossary.md
diff --git a/...pulpcore/docs/sections/reference/index.md → .../staging_docs/sections/reference/index.md b/...pulpcore/docs/sections/reference/index.md → .../staging_docs/sections/reference/index.md
diff --git a/tests/test_cli.py b/tests/test_cli.py
@@ -3,6 +3,7 @@
 from pathlib import Path
 
 import pytest
+import subprocess
 from click.testing import CliRunner
 
 from pulp_docs.main import main
@@ -23,8 +24,16 @@ def test_trivial():
 
 
 def test_build(tmp_path):
+    """Sanity check build cmd"""
+    # setup folder structure so test uses local fixtures
+    fixture_path = Path("tests/fixtures/pulpcore").absolute()
+    dest_path = tmp_path / "workdir" / fixture_path.name
+    shutil.copytree(fixture_path, dest_path)
+    subprocess.run(["git", "-C", str(dest_path.absolute()), "init"])
+
     runner = CliRunner()
     with runner.isolated_filesystem(temp_dir=tmp_path):
+        os.chdir(dest_path) # using local checkout depends on cwd
         result = runner.invoke(main, "build", env={"TMPDIR": str(tmp_path.absolute())})
         assert result.exit_code == 0
         assert Path("site").exists()
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,10 @@
+[tox]
+requires =
+    tox>=4
+env_list = py{38,39,310,311,312}
+
+[testenv]
+description = run tests
+deps = pytest
+commands =
+    pytest {posargs:tests}