Shut cannot be run as python -m shut or coverage run -m shut pkg test

When doing so:

$> python -m shut
/...bin/python: No module named shut.__main__; 'shut' is a package and cannot be directly executed
$> coverage run -m shut pkg test --no-capture
No module named shut.__main__; 'shut' is a package and cannot be directly executed

This is an example of a __main__.py file (from pytest)

https://github.com/pytest-dev/pytest/blob/main/src/pytest/main.py

"""The pytest entry point."""
import pytest

if __name__ == "__main__":    
    raise SystemExit(pytest.console_main())

In a mono repository, a package can inherit the license file of the repo by temporarily copying it into the package folder during setup.py. This doesn't work anymore. Looking at databind.core==1.1.3's setup.py, I can see

_tempcopy('../../LICENSE.txt', 'LICENSE.txt')

I belive that is one ../ too many.

I have a parametrized test with marks=[pytest.mark.xfail] where I expect it to fail.

However, I get an exception when running shut pkg test --no-capture:

Traceback (most recent call last):
  File "/.../bin/shut", line 8, in <module>
    sys.exit(shut())
  File "/.../lib/python3.9/site-packages/click/core.py", line 829, in __call__
    return self.main(*args, **kwargs)
  File "/.../lib/python3.9/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
  File "/.../lib/python3.9/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/.../lib/python3.9/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/.../lib/python3.9/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/.../lib/python3.9/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "/.../lib/python3.9/site-packages/shut/commands/pkg/test.py", line 153, in test
    test_run = test_package(package, isolate, keep_test_env, capture)
  File "/.../lib/python3.9/site-packages/shut/commands/pkg/test.py", line 70, in test_package
    return package.test_driver.test_package(package, runtime, capture)
  File "/.../lib/python3.9/site-packages/shut/test/pytest.py", line 126, in test_package
    test_run = load_report_file(self.report_file)
  File "/.../lib/python3.9/site-packages/shut/test/pytest.py", line 81, in load_report_file
    test_status = {'passed': TestStatus.PASSED, 'failed': TestStatus.FAILED, 'skipped': TestStatus.SKIPPED}[test['outcome']]
KeyError: 'xfailed'

Indeed, only passed, failed and skipped are acknowledged. Whereas xfailed and xpassed are not.

Documentation: https://docs.pytest.org/en/6.2.x/example/parametrize.html

shut versions 0.10.x may not have required data folder in package

version 0.9.0

user@computer:~/project$ 
user@computer:~/project$ shut --version
shut, version 0.9.0
user@computer:~/project$ shut pkg checks

  ✔️   classifiers
  ✔️   license
  ✔️   namespace files
  ✔️   package-author
  ✔️   package-url
  ✔️   package-version
  ✔️   readme
  ✔️   up to date

ran 8 checks for package project in 0.011s
user@computer:~/project$ 

version 0.10.3

user@computer:~/project$ shut --version
shut, version 0.10.3
user@computer:~/project$ shut pkg checks
/usr/lib/python3/dist-packages/apport/report.py:13: DeprecationWarning: the imp module is deprecated in favour of importlib; see the module's documentation for alternative uses
  import fnmatch, glob, traceback, errno, sys, atexit, locale, imp, stat
Traceback (most recent call last):
  File "/home/user/.local/bin/shut", line 8, in <module>
    sys.exit(shut())
  File "/home/user/.local/lib/python3.8/site-packages/click/core.py", line 829, in __call__
    return self.main(*args, **kwargs)
  File "/home/user/.local/lib/python3.8/site-packages/click/core.py", line 782, in main
    rv = self.invoke(ctx)
  File "/home/user/.local/lib/python3.8/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/user/.local/lib/python3.8/site-packages/click/core.py", line 1259, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/user/.local/lib/python3.8/site-packages/click/core.py", line 1066, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/user/.local/lib/python3.8/site-packages/click/core.py", line 610, in invoke
    return callback(*args, **kwargs)
  File "/home/user/.local/lib/python3.8/site-packages/shut/commands/pkg/checks.py", line 80, in checks
    sys.exit(check_package(package, warnings_as_errors))
  File "/home/user/.local/lib/python3.8/site-packages/shut/commands/pkg/checks.py", line 61, in check_package
    checks = get_package_checks(package)
  File "/home/user/.local/lib/python3.8/site-packages/shut/commands/pkg/checks.py", line 44, in get_package_checks
    checks = list(get_checks(package))
  File "/home/user/.local/lib/python3.8/site-packages/shut/checkers/base.py", line 125, in get_checks
    yield from checker().get_checks(obj)
  File "/home/user/.local/lib/python3.8/site-packages/shut/checkers/base.py", line 101, in get_checks
    for index, result in enumerate(value(subject)):
  File "/home/user/.local/lib/python3.8/site-packages/shut/checkers/package.py", line 137, in _check_up_to_date
    files = get_files(package)
  File "/home/user/.local/lib/python3.8/site-packages/shut/renderers/core.py", line 78, in get_files
    renderer().get_files(files, obj)
  File "/home/user/.local/lib/python3.8/site-packages/shut/renderers/license.py", line 81, in get_files
    get_license_template(model.license)
  File "/home/user/.local/lib/python3.8/site-packages/shut/renderers/license.py", line 34, in get_license_template
    return resource_string('shut', f'data/license_templates/{license_name}.txt').decode('utf-8')
  File "/home/user/.local/lib/python3.8/site-packages/pkg_resources/__init__.py", line 1155, in resource_string
    return get_provider(package_or_requirement).get_resource_string(
  File "/home/user/.local/lib/python3.8/site-packages/pkg_resources/__init__.py", line 1401, in get_resource_string
    return self._get(self._fn(self.module_path, resource_name))
  File "/home/user/.local/lib/python3.8/site-packages/pkg_resources/__init__.py", line 1626, in _get
    with open(path, 'rb') as stream:
FileNotFoundError: [Errno 2] No such file or directory: '/home/user/.local/lib/python3.8/site-packages/shut/data/license_templates/MIT.txt'
user@computer:~/project$ 
user@computer:~/project$ ls -al /home/user/.local/lib/python3.8/site-packages/shut
total 68
drwxrwxr-x  16 user user 4096 Nov 30 13:29 .
drwx------ 137 user user 4096 Nov 30 13:29 ..
drwxrwxr-x   3 user user 4096 Nov 30 13:29 builders
drwxrwxr-x   3 user user 4096 Nov 30 13:29 changelog
drwxrwxr-x   3 user user 4096 Nov 30 13:29 checkers
drwxrwxr-x   7 user user 4096 Nov 30 13:29 commands
-rw-rw-r--   1 user user 1205 Nov 30 13:29 __init__.py
drwxrwxr-x   3 user user 4096 Nov 30 13:29 lifecycle
drwxrwxr-x   3 user user 4096 Nov 30 13:29 lint
drwxrwxr-x   3 user user 4096 Nov 30 13:29 model
drwxrwxr-x   3 user user 4096 Nov 30 13:29 publish
drwxrwxr-x   3 user user 4096 Nov 30 13:29 publishers
drwxrwxr-x   2 user user 4096 Nov 30 13:29 __pycache__
-rw-rw-r--   1 user user    0 Nov 30 13:29 py.typed
drwxrwxr-x   3 user user 4096 Nov 30 13:29 renderers
drwxrwxr-x   3 user user 4096 Nov 30 13:29 test
drwxrwxr-x   5 user user 4096 Nov 30 13:29 utils
drwxrwxr-x   3 user user 4096 Nov 30 13:29 vcs
user@computer:~/project$ 
user@computer:~/project$ which shut
/home/user/.local/bin/shut
user@computer:~/project$

We're currently relying on the old behaviour that is fixed in https://github.com/python-poetry/poetry-core/pull/461 whereas an invalid constraint, such as an empty one, is treated as *. Now we have to be explicit about it.

Poetry dependencies can be defined like

[tool.poetry.dependencies]
package1 = "^0.1.0"
package2 = { version = "^0.1.0" }

And currently, we only support the first format.

The second format comes with the additional complexity of support different types of dependencies, sources (PyPI indices) and marking dependencies as optional.

The project dependencies are loaded with every invocation of Slap right now because of how Project._get_projects() already orders the project list topologically. Most Slap commands don't care about the order (like slap release, etc.) and we can skip loading the dependencies if we instead create a separate API to retrieve the projects in topological order explicitly.

1. The GitHub runner doesn't get an environment variable that tells us what the fork repository is
2. We might not even have write permission on the forked repository from the GitHub runner anyway?

Having multiple independent test drivers could be run in parallel to improve response rate. Parallelism should be disabled when stdout capture is disabled.

Lines that don't have any effect in MANIFEST.in do not cause an error or easily surface-able warning when building the package. The Shut package checks should validate that each line in the manifest serves a purpose. Lines that do not may be a mistake that needs to be corrected by the user.

If you use readme.md, setuptools will complain that no README.{,rst,txt,md} file was found. The setup file we render passes the readme file content to setuptools.setup(), so not sure why this is an issue for setuptools.

This occurs when creating a Python 3.8 virtual environment and using slap install to install kraken-core. It has an optional runtime-dependency on pytest and a non-optional development dependency on it.

[tool.poetry.dependencies]
pytest = { version = ">=6.0.0", optional = true }  # For the testing fixture provided by kraken.core

[tool.poetry.dev-dependencies]
pytest = "*"

Upgrading Pip in the virtual environment makes it work.

.venvs/3.8/bin/pip install --upgrade pip

Consider adding pyupio/safety to the default pyproject.toml

I'm finding that having safety as a part of my Slap tests helps me stay aware of possible issues with dependencies sooner in the development cycle, thus saving time (ie shift-left SecDevops language) - other Slap users may find this helpful too.

[tool.slap.test]
safety = "pip freeze | safety check --stdin --output bare"

Also - totally love Slap and it's evolution from Slam and Shut - keep the tool going, it massively helps in delivering awesome Python packages.

The slap venv -i command is something you might run from ~/.profile or similar files, so it's not uncommon that it might be invoked in a directory that has a pyproject.toml but is not a compatible Slap project.

Example error?

[ ... ]
  File "/Users/niklas.rosenstein/gitme/slap/.venvs/3.10/lib/python3.10/site-packages/nr/util/functional/_once.py", line 29, in __call__
    self._value = self._supplier()
  File "/Users/niklas.rosenstein/gitme/slap/.venvs/3.10/lib/python3.10/site-packages/slap/project.py", line 150, in _get_dist_name
    return self.handler().get_dist_name(self)
  File "/Users/niklas.rosenstein/gitme/slap/.venvs/3.10/lib/python3.10/site-packages/nr/util/functional/_once.py", line 29, in __call__
    self._value = self._supplier()
  File "/Users/niklas.rosenstein/gitme/slap/.venvs/3.10/lib/python3.10/site-packages/slap/project.py", line 120, in _get_project_handler
    raise RuntimeError(f"unable to identify project handler for {self!r}")
RuntimeError: unable to identify project handler for Project(directory="/Users/niklas.rosenstein/gitme/kraken-base-image")

Using slap venv -c defaults topython3while theslap installcommand defaults topython. Usingpythonin the install command is OK because in a virtual environment it always points to the right environment. But probably we should haveslap venvusepython` by default.