Merge pull request #36 from psafont/dev/pau/package

Properly package the python script

Author: ydirson

.github/workflows/main.yaml

@@ -11,9 +11,14 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
+    - name: Install uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        version: "0.7.x"
+    - name: Install dependencies
+      run: uv sync --frozen
     - name: Test
+      # use script to provide a tty (workaround of systematic "docker -t"?)
       shell: 'script -q -e -c "bash {0}"'
       run: |
-        ./test/test.sh
+        uv run ./test/test.sh

.gitignore

@@ -0,0 +1,4 @@
+# Distribution / packaging
+build/
+*.egg-info/
+__pycache__/

README.md

@@ -22,90 +22,74 @@ If you have both installed, docker will be used by default.  If you
 want to use a specific container runtime, set `XCPNG_OCI_RUNNER` to
 the docker-compatible command to use (typically `podman` or `docker`).
 
+You'll need to install git-lfs to be able to download the source tarballs from
+git, otherwise when running xcp-ng-dev, it won't be able to extract the sources.
+
+## Installation
+
+This can be done with `uv`:
+```
+uv tool install --from git+https://github.com/xcp-ng/xcp-ng-build-env xcp-ng-dev
+```
+or `pipx:`
+```
+pipx install git+https://github.com/xcp-ng/xcp-ng-build-env
+```
+
+After this, two new commands will be available: `xcp-ng-dev-env-create` and
+`xcp-ng-dev`.
+
+If you want to develop the package and try the changes as you develop the
+package, clone the repository and install the `xcp-ng-dev` package:
+
+```bash
+git clone github.com:xcp-ng/xcp-ng-build-env
+cd xcp-ng-build-env
+uv tool install --editable .
+```
+
+If `uv` is not available you can use other tools to install python packages,
+like `pipx install --editable .`
+
+If you do not want this behaviour, use: `uv tool install --from . xcp-ng-dev`
+or `pipx install .`
+
+## Completion
+
+### Bash
+
+To install the completion, add `eval "$(register-python-argcomplete xcp-ng-dev)"` to `~/.bash_completion` and relaunch Bash.
+
+### Zsh
+
+To install the completion, add `eval "$(register-python-argcomplete xcp-ng-dev)"` to `~/.zshrc` and relaunch Zsh.
+
+### Fish
+
+To install the completion, run `register-python-argcomplete --shell fish xcp-ng-dev > ~/.config/fish/completions/xcp-ng-dev.fish` and relaunch fish.
+
 ## Building the container image(s)
 
 You need one container image per target version of XCP-ng.
 
-Clone this repository (outside any container), then use `build.sh` to
+Clone this repository (outside any container), then use `xcp-ng-dev-env-create` to
 generate the images for the wanted releases of XCP-ng.
 Note that Docker and Podman store container images separately.
 
 ```
-Usage: ./build.sh {version_of_XCP_ng}
+Usage: xcp-ng-dev-env-create {version_of_XCP_ng}
 ... where {version_of_XCP_ng} is a 'x.y' version such as 8.0.
 ```
 
 ## Using the container
 
-Use the `run.py` script. It accepts a variety of parameters allowing for different uses:
+Use `xcp-ng-dev`. It accepts a variety of parameters allowing for different uses:
 * rebuild an existing source RPM (with automated installation of the build dependencies)
 * build a package from an already extracted source RPM (sources and spec file), or from a directory that follows the rpmbuild convention (a `SOURCES/` directory and a `SPECS/` directory). Most useful for building packages from XCP-ng's git repositories of RPM sources: https://github.com/xcp-ng-rpms.
 * or simply start a shell in the build environment, with the appropriate CentOS, EPEL and XCP-ng yum repositories enabled.
 
-```sh
-usage: run.py [-h] [-b BRANCH] [-l BUILD_LOCAL] [--define DEFINE]
-              [-r REBUILD_SRPM] [-o OUTPUT_DIR] [-n] [-p PACKAGE] [-s SRPM]
-              [-d DIR] [-e ENV] [-v VOLUME] [--rm] [--syslog] [--name NAME]
-              [-a ENABLEREPO] [--fail-on-error]
-              ...
-
-positional arguments:
-  command               Command to run inside the prepared container
-
-optional arguments:
-  -h, --help            show this help message and exit
-  -b BRANCH, --branch BRANCH
-                        XCP-ng version: 7.6, 8.0, etc. If not set, will
-                        default to 8.0.
-  -l BUILD_LOCAL, --build-local BUILD_LOCAL
-                        Install dependencies for the spec file(s) found in the
-                        SPECS/ subdirectory of the directory passed as
-                        parameter, then build the RPM(s). Built RPMs and SRPMs
-                        will be in RPMS/ and SRPMS/ subdirectories. Any
-                        preexisting BUILD, BUILDROOT, RPMS or SRPMS
-                        directories will be removed first. If --output-dir is
-                        set, the RPMS and SRPMS directories will be copied to
-                        it after the build.
-  --define DEFINE       Definitions to be passed to rpmbuild (if --build-local
-                        or --rebuild-srpm are passed too). Example: --define
-                        'xcp_ng_section extras', for building the 'extras'
-                        version of a package which exists in both 'base' and
-                        'extras' versions.
-  -r REBUILD_SRPM, --rebuild-srpm REBUILD_SRPM
-                        Install dependencies for the SRPM passed as parameter,
-                        then build it. Requires the --output-dir parameter to
-                        be set.
-  -o OUTPUT_DIR, --output-dir OUTPUT_DIR
-                        Output directory for --rebuild-srpm and --build-local.
-  -n, --no-exit         After executing either an automated build or a custom
-                        command passed as parameter, drop user into a shell
-  -p PACKAGE, --package PACKAGE
-                        Packages for which dependencies will be installed
-  -s SRPM, --srpm SRPM  SRPMs for which dependencies will be installed
-  -d DIR, --dir DIR     Local dir to mount in the image. Will be mounted at
-                        /external/<dirname>
-  -e ENV, --env ENV     Environment variables passed directly to docker -e
-  -v VOLUME, --volume VOLUME
-                        Volume mounts passed directly to docker -v
-  --rm                  Destroy the container on exit
-  --syslog              Enable syslog to host by mounting in /dev/log
-  --name NAME           Assign a name to the container
-  -a ENABLEREPO, --enablerepo ENABLEREPO
-                        additional repositories to enable before installing
-                        build dependencies. Same syntax as yum's --enablerepo
-                        parameter. Available additional repositories: xcp-ng-
-                        updates_testing, xcp-ng-extras, xcp-ng-extras_testing.
-  --fail-on-error       If container initialisation fails, exit rather than
-                        dropping the user into a command shell
-```
-
 **Examples**
 
-Rebuild an existing source RPM (with automated installation of the build dependencies)
-```sh
-./run.py -b 8.0 --rebuild-srpm /path/to/some-source-rpm.src.rpm --output-dir /path/to/output/directory --rm
-```
-
 Build from git (and put the result into RPMS/ and SRPMS/ subdirectories)
 ```sh
 # Find the relevant repository at https://github.com/xcp-ng-rpms/
@@ -116,7 +100,7 @@ git clone https://github.com/xcp-ng-rpms/xapi.git
 # ... Here add your patches ...
 
 # Build.
-/path/to/run.py -b 8.0 --build-local xapi/ --rm
+xcp-ng-dev container build -b 8.2 --rm xapi/
 ```
 
 **Important switches**
@@ -135,15 +119,15 @@ fully automated.
 1. modify the specfile to add `-Squilt` to `%autosetup` or
    `%autopatch` in the `%prep` block; add `BuildRequires: quilt`
 2. let quilt apply them in a 8.3 buildenv (`quilt` in 8.3 is only in EPEL) and get you a shell:
-   ```
-xcpng/build-env/run.py --rm -b 8.3 -l . --rpmbuild-stage=p -n --enablerepo=epel
-   ```
+```sh
+xcp-ng-dev container build --rm -b 8.3 --rpmbuild-stage=p -n --enablerepo=epel .
+```
 3. ask `quilt` to refresh all your patches (alternatively just the one you want)
-   ```
-$ cd rpmbuild/BUILD/$dir
-$ quilt pop -a --refresh
-$ cp patches/* ../../SOURCES/
-   ```
+```sh
+cd rpmbuild/BUILD/$dir
+quilt pop -a --refresh
+cp patches/* ../../SOURCES/
+```
 4. carefully pick up the bits you need
 
 Note: unfortunately `rpmbuild` (in 8.3 at least) does not add all
@@ -180,11 +164,11 @@ make
 
 If you'd like to develop using the tools on your host and preserve the changes
 to source and revision control but still use the container for building, you
-can do using by mouning a volume in the container, using the `-v` option to mount
+can do so by mounting a volume in the container, using the `-v` option to mount
 a directory from your host to a suitable point inside the container. For
 example, if I clone some repos into a directory on my host, say `/work/code/`,
 then I can mount it inside the container as follows:
 
 ```sh
-./run.py -b 8.0 -v /work/code:/mnt/repos
+xcp-ng-dev container shell -b 8.2 -v /work/code:/mnt/repos
 ```

pyproject.toml

@@ -0,0 +1,24 @@
+[project]
+name = "xcp-ng-dev"
+description = "A tool to develop and build XCP-ng packages"
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT"
+license-files = ["LICENSE"]
+dynamic = ["version"]
+dependencies = [
+    "argcomplete",
+]
+
+[project.scripts]
+xcp-ng-dev = "xcp_ng_dev.cli:main"
+xcp-ng-dev-env-create = "xcp_ng_dev.cli:build"
+
+[project.urls]
+Homepage = "https://github.com/xcp-ng/xcp-ng-build-env/"
+
+[build-system]
+requires = ["setuptools >= 77.0.3", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]

src/xcp_ng_dev/__init__.py

@@ -1,6 +1,8 @@
 #!/usr/bin/env bash
 set -e
 
+SELF_NAME="xcp-ng-dev-env-create"
+
 die() {
     echo >&2
     echo >&2 "ERROR: $*"
@@ -15,7 +17,7 @@ die_usage() {
 
 usage() {
     cat <<EOF
-Usage: $0 [--platform PF] <version>
+Usage: $SELF_NAME [--platform PF] <version>
 ... where <version> is a 'x.y' version such as 8.0.
 
 --platform override the default platform for the build container.
@@ -71,12 +73,12 @@ ALMA_VERSION=
 CENTOS_VERSION=
 case "$1" in
     9.*)
-        DOCKERFILE=Dockerfile-9.x
+        DOCKERFILE=files/Dockerfile-9.x
         ALMA_VERSION=10.0
         : ${PLATFORM:=linux/amd64/v2}
         ;;
     8.*)
-        DOCKERFILE=Dockerfile-8.x
+        DOCKERFILE=files/Dockerfile-8.x
         : ${PLATFORM:=linux/amd64}
         ;;
     7.*)