mirror of
https://github.com/pypiserver/pypiserver
synced 2024-11-09 16:45:51 +01:00
d868005e1f
* Docker improvements This addresses much of what was brought up in #359. Specifically, it: - Significantly improves testing for the Docker image, adding a `docker/test_docker.py` file using the regular pytest machinery to set up and run docker images for testing - Hopefully addresses a variety of permissions issues, by being explicit about what access pypiserver needs and asking for it, only erroring if that access is not available - Requires RX permissions on `/data` (R to read files, X to list files and to be able to cd into the directory. This is important since `/data` is the `WORKDIR`) - Requires RWX permissions on `/data/packages`, so that we can list packages, write packages, and read packages. - When running in the default configuration (as root on Linux or as the pypiserver-named rootish user on Mac), with no volumes mounted, these requirements are all satisfied - Volume mounts still must be readable by the pypiserver user (UID 9898) in order for the container to run. However, we now error early if this is not the case, and direct users to a useful issue. - If the container is run as a non-root, non-pypiserver user (e.g. because someone ran `docker run --user=<user_id>`, we try to run pypiserver as that user). Provided that user has access to the necessary directories, it should run fine. - Fixes issues with running help and similar commands - Updates the Docker image to use `PYPISERVER_PORT` for port specification, while still falling back to `PORT` for backwards compatibility - Moves some docker-related things into a `/docker` directory - Adds a `Makefile` for building a test fixture package sdist and wheel, so that test code can call `make mypkg` and not need to worry about it potentially building multiple times The only issue #359 raises that's not addressed here is the one of running pypiserver in the Docker container using some non-default server for performance. I would like to do some benchmarking before deciding on what to do there.
106 lines
2.7 KiB
Python
106 lines
2.7 KiB
Python
"""
|
|
Test module for app initialization
|
|
"""
|
|
# Standard library imports
|
|
import logging
|
|
import pathlib
|
|
import typing as t
|
|
|
|
# Third party imports
|
|
import pytest
|
|
|
|
|
|
# Local imports
|
|
import pypiserver
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
TEST_DIR = pathlib.Path(__file__).parent
|
|
HTPASS_FILE = TEST_DIR / "../fixtures/htpasswd.a.a"
|
|
WELCOME_FILE = TEST_DIR / "sample_msg.html"
|
|
|
|
|
|
# TODO: make these tests meaningful
|
|
@pytest.mark.parametrize(
|
|
"conf_options",
|
|
[
|
|
{},
|
|
{"root": "~/stable_packages"},
|
|
{
|
|
"root": "~/unstable_packages",
|
|
"authenticated": "upload",
|
|
"passwords": str(HTPASS_FILE),
|
|
},
|
|
# Verify that the strip parser works properly.
|
|
{"authenticated": str("upload")},
|
|
],
|
|
)
|
|
def test_paste_app_factory(conf_options: dict) -> None:
|
|
"""Test the paste_app_factory method"""
|
|
pypiserver.paste_app_factory({}, **conf_options) # type: ignore
|
|
|
|
|
|
def test_app_factory() -> None:
|
|
assert pypiserver.app() is not pypiserver.app()
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"incoming, updated",
|
|
(
|
|
(
|
|
{"authenticated": []},
|
|
{"authenticate": []},
|
|
),
|
|
(
|
|
{"passwords": "./foo"},
|
|
{"password_file": "./foo"},
|
|
),
|
|
(
|
|
{"root": str(TEST_DIR)},
|
|
{"roots": [TEST_DIR.expanduser().resolve()]},
|
|
),
|
|
(
|
|
{"root": [str(TEST_DIR), str(TEST_DIR)]},
|
|
{
|
|
"roots": [
|
|
TEST_DIR.expanduser().resolve(),
|
|
TEST_DIR.expanduser().resolve(),
|
|
]
|
|
},
|
|
),
|
|
(
|
|
{"redirect_to_fallback": False},
|
|
{"disable_fallback": True},
|
|
),
|
|
(
|
|
{"server": "auto"},
|
|
{"server_method": "auto"},
|
|
),
|
|
(
|
|
{"welcome_file": str(WELCOME_FILE.resolve())},
|
|
{"welcome_msg": WELCOME_FILE.read_text()},
|
|
),
|
|
),
|
|
)
|
|
def test_backwards_compat_kwargs_conversion(
|
|
incoming: t.Dict[str, t.Any], updated: t.Dict[str, t.Any]
|
|
) -> None:
|
|
"""Test converting legacy kwargs to modern ones."""
|
|
assert pypiserver.backwards_compat_kwargs(incoming) == updated
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"kwargs",
|
|
(
|
|
{"redirect_to_fallback": False, "disable_fallback": False},
|
|
{"disable_fallback": False, "redirect_to_fallback": False},
|
|
),
|
|
)
|
|
def test_backwards_compat_kwargs_duplicate_check(
|
|
kwargs: t.Dict[str, t.Any]
|
|
) -> None:
|
|
"""Duplicate legacy and modern kwargs cause an error."""
|
|
with pytest.raises(ValueError) as err:
|
|
pypiserver.backwards_compat_kwargs(kwargs)
|
|
assert "('redirect_to_fallback', 'disable_fallback')" in str(err.value)
|