fix: Remove copy of s5cmd from source tree and update install rule

Add test_executable based on https://github.com/scikit-build/cmake-python-distributions

Author: jcfr

.github/workflows/cd.yml

@@ -48,7 +48,10 @@ jobs:
 
       - name: Install dependencies
         run: |
-          pip install pytest pytest-cov
+          # Waiting pip supports `--only-deps=test`, explicitly extract the test dependencies
+          # See https://github.com/pypa/pip/issues/11440
+          pip install yq
+          tomlq -r '.project."optional-dependencies".test[]' pyproject.toml | xargs -d '\n' pip install
 
       - uses: actions/download-artifact@v4
         with:

CMakeLists.txt

@@ -64,18 +64,10 @@ file(ARCHIVE_EXTRACT
   VERBOSE
   )
 
-set(s5cmd_package "src/s5cmd")
-
-message(STATUS "Copying ${executable_name} to ${s5cmd_package}")
-file(COPY ${extract_dir}/${executable_name} DESTINATION ${PROJECT_SOURCE_DIR}/${s5cmd_package})
-
 set(_permissions PERMISSIONS
   OWNER_READ OWNER_WRITE OWNER_EXECUTE
   GROUP_READ GROUP_EXECUTE
   WORLD_READ WORLD_EXECUTE
   )
 
-message(STATUS "Changing ${executable_name} permissions to be executable")
-file(CHMOD ${PROJECT_SOURCE_DIR}/${s5cmd_package}/${executable_name} ${_permissions})
-
-install(PROGRAMS ${extract_dir}/${executable_name} DESTINATION "${s5cmd_package}" ${_permissions})
+install(PROGRAMS ${extract_dir}/${executable_name} DESTINATION "s5cmd" ${_permissions})

pyproject.toml

@@ -34,6 +34,7 @@ dependencies = []
 
 [project.optional-dependencies]
 test = [
+  "importlib_metadata>=2.0; python_version<'3.10'",
   "pytest >=6",
   "pytest-cov >=3",
 ]
@@ -113,6 +114,9 @@ module = "s5cmd.*"
 disallow_untyped_defs = true
 disallow_incomplete_defs = true
 
+[[tool.mypy.overrides]]
+module = "tests.*"
+ignore_errors = true
 
 [tool.ruff]
 src = ["src"]

tests/__init__.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+import sys
+from contextlib import contextmanager
+
+
+@contextmanager
+def push_argv(argv):
+    old_argv = sys.argv
+    sys.argv = argv
+    yield
+    sys.argv = old_argv

tests/test_executable.py

@@ -0,0 +1,55 @@
+from __future__ import annotations
+
+import subprocess
+import sys
+import sysconfig
+from pathlib import Path
+
+import pytest
+
+if sys.version_info < (3, 10):
+    from importlib_metadata import distribution
+else:
+    from importlib.metadata import distribution
+
+import s5cmd
+
+from . import push_argv
+
+all_tools = pytest.mark.parametrize("tool", ["s5cmd"])
+
+
+def _run(program, args):
+    func = getattr(s5cmd, program)
+    args = [f"{program}.py", *args]
+    with push_argv(args), pytest.raises(SystemExit) as excinfo:
+        func()
+    assert excinfo.value.code == 0
+
+
+@all_tools
+def test_module(tool):
+    _run(tool, ["version"])
+
+
+def _get_scripts():
+    dist = distribution("s5cmd")
+    scripts_paths = [
+        Path(sysconfig.get_path("scripts", scheme)).resolve()
+        for scheme in sysconfig.get_scheme_names()
+    ]
+    scripts = []
+    for file in dist.files:
+        if file.locate().parent.resolve(strict=True) in scripts_paths:
+            scripts.append(file.locate().resolve(strict=True))
+    return scripts
+
+
+@all_tools
+def test_package_script(tool):
+    expected_version = "2.2.2"
+    scripts = [script for script in _get_scripts() if script.stem == tool]
+    assert len(scripts) == 1
+    output = subprocess.check_output([str(scripts[0]), "version"]).decode("ascii")
+    # Output of the form "vX.Y.Z-SHA{N}"
+    assert output.splitlines()[0].split("-")[0] == f"v{expected_version}"