Add flatpak metadata

- Change how `docker-command` is parsed to allow for command line options.
- Add CI test build

Signed-off-by: Nicolas Bock <[email protected]>

Author: nicolasbock

.github/workflows/build.yaml

@@ -1,4 +1,4 @@
-name: build
+name: Build and Test ebuildtester
 
 on:
   pull_request:

.github/workflows/flatpak.yaml

@@ -0,0 +1,33 @@
+name: Build flatpack package
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  
+  build:
+    runs-on: ubuntu-latest
+    name: Build flatpak
+    steps:
+     
+      - name: Check out sources
+        uses: actions/checkout@v2
+
+      - name: Set up flatpak build tools
+        run: |
+          set -e -u -x
+
+          sudo apt update
+          sudo apt install flatpak flatpak-builder
+          sudo flatpak remote-add --if-not-exists \
+            flathub https://flathub.org/repo/flathub.flatpakrepo
+          sudo flatpak install --assumeyes flathub \
+            org.freedesktop.Platform//21.08 org.freedesktop.Sdk//21.08
+
+      - name: Build flatpak
+        run: make flatpak

.github/workflows/publish.yaml

@@ -1,6 +1,6 @@
 ---
 
-name: Publish
+name: Publish PyPI Package
 
 on:
   release:

.gitignore

@@ -2,3 +2,4 @@ build/
 dist/
 ebuildtester.egg-info/
 *__pycache__*
+.vscode/

Makefile

@@ -13,3 +13,6 @@ docs:
 
 distclean:
 	rm -rf dist/*
+
+flatpak:
+	flatpak-builder --force-clean build-dir org.nicolasbock.ebuildtester.yaml

ebuildtester-wrapper.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+set -e -u
+
+/app/usr/bin/ebuildtester --docker-command "flatpak-spawn --host docker" "$@"

ebuildtester/docker.py

@@ -8,11 +8,12 @@
 
 
 class ExecuteFailure(Exception):
+    """Failure to execute command."""
     pass
 
 
 class Docker:
-
+    """The Docker class."""
     def __init__(self, local_portage, overlay_dirs):
         """Create a new container."""
 
@@ -44,7 +45,7 @@ def execute(self, cmd):
         """
 
         options.log.info("%s %s" % (self.cid[:6], cmd))
-        docker_cmd = [options.options.docker_command, "exec", "--interactive"]
+        docker_cmd = options.options.docker_command + ["exec", "--interactive"]
         docker_cmd += [self.cid, "/bin/bash"]
         docker = subprocess.Popen(docker_cmd,
                                   stdout=subprocess.PIPE,
@@ -94,9 +95,9 @@ def shell(self):
         """Run an interactive shell in container."""
 
         options.log.info("running interactive shell in container")
-        docker = subprocess.Popen([options.options.docker_command,
-                                   "exec", "--tty", "--interactive",
-                                   self.cid, "/bin/bash"])
+        docker = subprocess.Popen(options.options.docker_command
+                                  + ["exec", "--tty", "--interactive",
+                                     self.cid, "/bin/bash"])
         try:
             docker.wait()
         except KeyboardInterrupt:
@@ -112,12 +113,12 @@ def remove(self):
         """Remove the docker container."""
 
         options.log.info("stopping container")
-        docker = subprocess.Popen([options.options.docker_command,
-                                   "kill", self.cid])
+        docker = subprocess.Popen(options.options.docker_command
+                                  + ["kill", self.cid])
         docker.wait()
         options.log.info("deleting container")
-        docker = subprocess.Popen([options.options.docker_command,
-                                   "rm", self.cid])
+        docker = subprocess.Popen(options.options.docker_command
+                                  + ["rm", self.cid])
         docker.wait()
 
     def _reader(self, proc, stream, name):
@@ -135,27 +136,27 @@ def _setup_container(self, docker_image):
         """Setup the container."""
 
         if options.options.pull:
-            docker_args = [options.options.docker_command,
-                           "pull", docker_image]
+            docker_args = options.options.docker_command \
+                + ["pull", docker_image]
             docker = subprocess.Popen(docker_args)
             docker.wait()
 
     def _create_container(self, docker_image, local_portage, overlays):
         """Create new container."""
 
-        docker_args = [
-            options.options.docker_command, "create",
-            "--tty",
-            "--cap-add", "CAP_SYS_ADMIN",
-            "--cap-add", "CAP_MKNOD",
-            "--cap-add", "CAP_NET_ADMIN",
-            # https://github.com/moby/moby/issues/16429
-            "--security-opt", "apparmor:unconfined",
-            "--device", "/dev/fuse",
-            "--workdir", "/root",
-            "--volume", "%s:/var/db/repos/gentoo" % local_portage,
-            "--volume", "%s/distfiles:/var/cache/distfiles" % local_portage,
-            "--volume", "%s/packages:/var/cache/binpkgs" % local_portage]
+        docker_args = options.options.docker_command \
+            + ["create",
+               "--tty",
+               "--cap-add", "CAP_SYS_ADMIN",
+               "--cap-add", "CAP_MKNOD",
+               "--cap-add", "CAP_NET_ADMIN",
+               # https://github.com/moby/moby/issues/16429
+               "--security-opt", "apparmor:unconfined",
+               "--device", "/dev/fuse",
+               "--workdir", "/root",
+               "--volume", "%s:/var/db/repos/gentoo" % local_portage,
+               "--volume", "%s/distfiles:/var/cache/distfiles" % local_portage,
+               "--volume", "%s/packages:/var/cache/binpkgs" % local_portage]
 
         if options.options.storage_opt:
             for s in options.options.storage_opt:
@@ -182,8 +183,8 @@ def _create_container(self, docker_image, local_portage, overlays):
     def _start_container(self):
         """Start the container."""
 
-        docker_args = [options.options.docker_command,
-                       "start", "%s" % self.cid]
+        docker_args = options.options.docker_command \
+            + ["start", "%s" % self.cid]
         docker = subprocess.Popen(docker_args, stdout=subprocess.PIPE)
         docker.wait()
         if docker.returncode != 0:

ebuildtester/parse.py

@@ -150,6 +150,10 @@ def parse_commandline(args):
     if not options.docker_command:
         options.docker_command = os.getenv('DOCKER_COMMAND', default='docker')
 
+    # Convert docker command into list so that `subprocess` can run the command
+    # and add command line options if they are present.
+    options.docker_command = options.docker_command.split()
+
     if options.show_options:
         print(options)
 

org.nicolasbock.ebuildtester.yaml

@@ -0,0 +1,20 @@
+app-id: org.nicolasbock.ebuildtester
+runtime: org.freedesktop.Platform
+runtime-version: '21.08'
+sdk: org.freedesktop.Sdk
+command: ebuildtester
+finish-args:
+  - --talk-name=org.freedesktop.Flatpak
+modules:
+  - python3-modules.json
+  - name: ebuildtester
+    buildsystem: simple
+    build-commands:
+      - pip3 install --prefix /app --verbose .
+      - python setup.py install --prefix /app --verbose
+      - mkdir --parents /app/usr/bin
+      - mv --verbose /app/bin/ebuildtester /app/usr/bin/ebuildtester
+      - install --verbose -D ebuildtester-wrapper.sh /app/bin/ebuildtester
+    sources:
+      - type: dir
+        path: .

python3-modules.json

@@ -0,0 +1,29 @@
+{
+    "name": "python3-setuptools-scm",
+    "buildsystem": "simple",
+    "build-commands": [
+        "pip3 install --verbose --exists-action=i --no-index --find-links=\"file://${PWD}\" --prefix=${FLATPAK_DEST} \"setuptools-scm\" --no-build-isolation"
+    ],
+    "sources": [
+        {
+            "type": "file",
+            "url": "https://files.pythonhosted.org/packages/97/75/10a9ebee3fd790d20926a90a2547f0bf78f371b2f13aa822c759680ca7b9/tomli-2.0.1-py3-none-any.whl",
+            "sha256": "939de3e7a6161af0c887ef91b7d41a53e7c5a1ca976325f429cb46ea9bc30ecc"
+        },
+        {
+            "type": "file",
+            "url": "https://files.pythonhosted.org/packages/05/8e/8de486cbd03baba4deef4142bd643a3e7bbe954a784dc1bb17142572d127/packaging-21.3-py3-none-any.whl",
+            "sha256": "ef103e05f519cdc783ae24ea4e2e0f508a9c99b2d4969652eed6a2e1ea5bd522"
+        },
+        {
+            "type": "file",
+            "url": "https://files.pythonhosted.org/packages/e3/e5/c28b544051340e63e0d507eb893c9513d3a300e5e9183e2990518acbfe36/setuptools_scm-6.4.2-py3-none-any.whl",
+            "sha256": "acea13255093849de7ccb11af9e1fb8bde7067783450cee9ef7a93139bddf6d4"
+        },
+        {
+            "type": "file",
+            "url": "https://files.pythonhosted.org/packages/d9/41/d9cfb4410589805cd787f8a82cddd13142d9bf7449d12adf2d05a4a7d633/pyparsing-3.0.8-py3-none-any.whl",
+            "sha256": "ef7b523f6356f763771559412c0d7134753f037822dad1b16945b7b846f7ad06"
+        }
+    ]
+}