Contributing guide update for unit testing

[MichaelThamm]

• https://matthewjohn.github.io/terrareg/LOCAL_DEVELOPMENT/#running-tests

The Running tests section mentions requirements-dev.txt, but this does not exist. I assume after a migration to pyproject.toml?

I was able to build Terrareg and run it on port 5000 in my Ubuntu VM. But now I want to contribute some code and execute the unit tests to check if my changes are good. So I try to pull in all the deps in the pyproject.toml with the following:

ubuntu@terrareg:~/terrareg$ uv sync --all-extras --all-groups && source .venv/bin/activate
Resolved 76 packages in 1.74s
  × Failed to build `terrareg @ file:///home/ubuntu/terrareg`
  ├─▶ The build backend returned an error
  ╰─▶ Call to `poetry.core.masonry.api.build_editable` failed (exit status: 1)

      [stderr]
      Traceback (most recent call last):
        File "<string>", line 11, in <module>
        File
      "/home/ubuntu/.cache/uv/builds-v0/.tmpHOIjCd/lib/python3.12/site-packages/poetry/core/masonry/api.py",
      line 87, in build_editable
          return WheelBuilder.make_in(
                 ^^^^^^^^^^^^^^^^^^^^^
        File
      "/home/ubuntu/.cache/uv/builds-v0/.tmpHOIjCd/lib/python3.12/site-packages/poetry/core/masonry/builders/wheel.py",
      line 95, in make_in
          wb.build(target_dir=directory)
        File
      "/home/ubuntu/.cache/uv/builds-v0/.tmpHOIjCd/lib/python3.12/site-packages/poetry/core/masonry/builders/wheel.py",
      line 129, in build
          self._add_pth(zip_file)
        File
      "/home/ubuntu/.cache/uv/builds-v0/.tmpHOIjCd/lib/python3.12/site-packages/poetry/core/masonry/builders/wheel.py",
      line 158, in _add_pth
          for include in self._module.includes:
                         ^^^^^^^^^^^^
        File "/usr/lib/python3.12/functools.py", line 995, in __get__
          val = self.func(instance)
                ^^^^^^^^^^^^^^^^^^^
        File
      "/home/ubuntu/.cache/uv/builds-v0/.tmpHOIjCd/lib/python3.12/site-packages/poetry/core/masonry/builders/builder.py",
      line 70, in _module
          return Module(
                 ^^^^^^^
        File
      "/home/ubuntu/.cache/uv/builds-v0/.tmpHOIjCd/lib/python3.12/site-packages/poetry/core/masonry/utils/module.py",
      line 44, in __init__
          raise ValueError(f"Both {pkg_dir} and {py_file} exist")
      ValueError: Both /home/ubuntu/terrareg/terrareg and /home/ubuntu/terrareg/terrareg.py exist

      hint: This usually indicates a problem with the package or the build environment.

I am not sure how to proceed :/

[MatthewJohn]

Created gitlab issue: https://gitlab.dockstudios.co.uk/pub/terrareg/-/issues/579
gitlab-issue-id:579

[MatthewJohn]

Hey @MichaelThamm ,

I'd suspsect it's something to do with the installed version of poetry.
I always, personally, use dev containers, so working within the Docker container, which seems to work reliably cross-platform.

However, the setup is currently fashioned around using poetry:

poetry install --no-root

The error:

      ValueError: Both /home/ubuntu/terrareg/terrareg and /home/ubuntu/terrareg/terrareg.py exist

I wonder if this is because uv is trying to install it as a package, rather than just installing the dependencies, perhaps you could try:

uv sync --no-install-project

[MichaelThamm]

uv sync --no-install-project did work in installing the deps, but running pytest did not; returning the same build errors. Likely user error on my part, but it would be nice if a user could run pytests without having to use docker.

[MatthewJohn]

How are you running the tests? Using uv to execute, e.g. uv run pytest?