Isolation of FTS to fts user

.devcontainer/Dockerfile

@@ -0,0 +1,4 @@
+FROM mcr.microsoft.com/devcontainers/base:ubuntu-22.04
+RUN apt-get update \
+    && apt-get install -y python3 python3-pip \
+    && pip3 install --upgrade pip

.devcontainer/devcontainer.json

@@ -0,0 +1,51 @@
+// For format details, see https://aka.ms/devcontainer.json.
+// For config options, see the README at: https://github.com/devcontainers/templates/tree/main/src/ubuntu
+{
+    "name": "FTS-Install",
+    // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+    "build": {
+        // Path is relative to the devcontainer.json file.
+        "dockerfile": "Dockerfile",
+        "context": "."
+    },
+
+    // Features to add to the dev container.  ore info: https://containers.dev/features.
+    "features": {
+          "ghcr.io/devcontainers/features/common-utils:2": {
+              "installZsh": "true",
+              "username": "vscode",
+              "userUid": "1000",
+              "userGid": "1000",
+              "upgradePackages": "true"
+          },
+          "ghcr.io/devcontainers/features/git:1": {
+              "version": "latest",
+              "ppa": "false"
+          }
+      },
+
+    // Use 'forwardPorts' to make a list of ports inside the container available locally.
+    // "forwardPorts": [],
+
+    // Use 'postCreateCommand' to run commands after the container is created.
+    // "postCreateCommand": "uname -a",
+
+    // Configure tool-specific properties.
+    "customizations" : {
+      "jetbrains" : {
+        "backend" : "IntelliJ"
+      }
+    },
+    "runArgs": [
+      "--net", "host",
+      "-e", "DISPLAY=:0",
+      "-e", "XAUTHORITY=/tmp/.Xauthority",
+      "-v", "${localEnv:HOME}/.Xauthority:/tmp/.Xauthority"
+    ],
+    "containerEnv": {
+      "DISPLAY": "unix:0"
+    },
+
+    // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+    // "remoteUser": "root"
+  }

.github/workflows/pending/compatibility.yml

@@ -74,9 +74,9 @@ jobs:
         uses: actions/cache@v2
         with:
           path: ~/.vagrant.d/boxes
-          key: ${{ runner.os }}-vagrant-${{ hashFiles('Vagrantfile') }}
+          key: "${{ runner.os }}-vagrant-${{ hashFiles('Vagrantfile') }}"
           restore-keys: |
-            ${{ runner.os }}-vagrant-
+            "${{ runner.os }}-vagrant-"
 
       - name: Run vagrant up
         run: |

.github/workflows/pending/lint.yml

@@ -30,9 +30,9 @@ jobs:
       - uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          key: "${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}"
           restore-keys: |
-            ${{ runner.os }}-pip-
+            "${{ runner.os }}-pip-"
 
       - name: Install test dependencies
         run: pip3 install yamllint

.github/workflows/pending/molecule_all_on_one.yml

@@ -36,9 +36,9 @@ jobs:
       - uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          key: "${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}"
           restore-keys: |
-            ${{ runner.os }}-pip-
+            "${{ runner.os }}-pip-"
 
       - name: Install test dependencies
         run: pip3 install ansible molecule[docker] docker

.github/workflows/pending/molecule_fts_core.yml

@@ -11,7 +11,7 @@ name: FTS CORE (DOCKER)
       - '**.md'
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
+  group: "${{ github.workflow }}-${{ github.ref }}"
   cancel-in-progress: true
 
 jobs:
@@ -69,9 +69,9 @@ jobs:
       - uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          key: "${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}"
           restore-keys: |
-            ${{ runner.os }}-pip-
+            "${{ runner.os }}-pip-"
 
       - name: Install test dependencies
         run: pip3 install ansible molecule[docker] docker

.github/workflows/pending/molecule_multiple.yml

@@ -36,9 +36,9 @@ jobs:
       - uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          key: "${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}"
           restore-keys: |
-            ${{ runner.os }}-pip-
+            "${{ runner.os }}-pip-"
 
       - name: Install test dependencies
         run: pip3 install ansible molecule[docker] docker

.github/workflows/pending/molecule_mumble.yml

@@ -69,9 +69,9 @@ jobs:
       - uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          key: "${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}"
           restore-keys: |
-            ${{ runner.os }}-pip-
+            "${{ runner.os }}-pip-"
 
       - name: Install test dependencies
         run: pip3 install ansible molecule[docker] docker

.github/workflows/pending/molecule_noderedserver.yml

@@ -68,9 +68,9 @@ jobs:
       - uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          key: "${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}"
           restore-keys: |
-            ${{ runner.os }}-pip-
+            "${{ runner.os }}-pip-"
 
       - name: Install test dependencies
         run: pip3 install ansible molecule[docker] docker

.github/workflows/pending/molecule_videoserver.yml

@@ -69,9 +69,9 @@ jobs:
       - uses: actions/cache@v3
         with:
           path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+          key: "${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}"
           restore-keys: |
-            ${{ runner.os }}-pip-
+            "${{ runner.os }}-pip-"
 
       - name: Install test dependencies
         run: pip3 install ansible molecule[docker] docker

.gitignore

@@ -72,3 +72,9 @@ ansible.cfg
 /.vagrant/*
 /.byebug_history
 /docs/DEV.md
+
+apt_inst.so
+apt_pkg.so
+
+git-error-*
+

.justfile

@@ -0,0 +1,24 @@
+
+default:
+  @just --list
+
+MY_WD := `pwd`
+MY_IPA := `ip -4 addr show docker0 | grep -oP '(?<=inet\s)\d+(\.\d+){3}'`
+MY_BRANCH := 'issue_118'
+NO_COLOR := `TRUE`
+
+alias dbox-act := dbox-activate
+
+dbox-activate:
+  -distrobox rm -f fts
+  distrobox create --image docker.io/library/ubuntu:22.04 --name fts --yes \
+     --init --additional-packages "systemd libpam-systemd pipewire-audio-client-libraries vim snapd"
+
+  distrobox enter --name fts
+  sudo snap install just --edge --classic
+
+
+dbox-install:
+  echo "My IPA: {{MY_IPA}}, WD: {{MY_WD}}, ISSUE: {{MY_BRANCH}}"
+  sudo bash {{MY_WD}}/scripts/easy_install.sh --repo file://{{MY_WD}}/.git --branch {{MY_BRANCH:-main}} --ip-addr {{MY_IPA}}
+

docs/configs/fts-test.yml

@@ -0,0 +1,21 @@
+description: "a VM for testing FTS"
+version: "24.4.0"
+
+#   see https://doc.qt.io/qt-5/qsysinfo.html#currentCpuArchitecture
+runs-on:
+- x86_64
+
+instances:
+  fts-test:
+    image: 22.04
+    limits:
+      min-cpu: 2
+      min-mem: 4G
+      min-disk: 10G
+#    timeout: <int>         # maximum time for the instance to launch, and separately for cloud-init to complete
+#    cloud-init:
+#      vendor-data: |       # cloud-init vendor data
+#        <string>
+# a health-check shell script ran by integration tests
+health-check: |
+  lsb_release -a

docs/ubuntu-test-container.md

@@ -0,0 +1,102 @@
+
+# Testing FTS Zero Touch Installer on Ubuntu 
+
+Obviously, the ZTI can be tested in a clean native Ubuntu environment.
+However, setting up such an environment can consume time.
+So, while in a production environment, running FTS on dedicated hardware is the correct choice,
+in a test environment it is more appropriate to use a container.
+
+## Setting up the container
+
+The test container can be constructed with any number of technologies.
+
+[Distrobox](https://wiki.archlinux.org/title/Distrobox)
+[Ptyrix](https://flathub.org/apps/app.devsuite.Ptyxis)
+[Boxbuddy](https://flathub.org/apps/io.github.dvlv.boxbuddyrs)
+
+We will want to specify a specific Ubuntu version we want `v22.04`.
+```shell
+distrobox create --image ubuntu:22.04 --name fts --yes \
+  --init --additional-packages "systemd libpam-systemd pipewire-audio-client-libraries" 
+```
+
+Enter the container
+```shell
+distrobox enter --name fts
+```
+
+## Use Zero Touch Intallation (ZTI)
+
+Note: The following steps may be modified to accommodate your situation.
+
+### The Working Repository
+
+The project working directory is mounted into the distrobox.
+The following is an example:
+```bash
+cd ./Projects/fts-install
+export MY_WD=$(pwd)
+```
+
+Your test will probably need the locally known IP address.
+You may change the configured IP address later,
+but it is easiest to handle it now.
+It is likely you will want the host interface the example here instead uses `docker0`.
+```bash
+export MY_IPA=$(ip -4 addr show docker0 | grep -oP '(?<=inet\s)\d+(\.\d+){3}')
+```
+
+You opened a branch for your issue.
+```bash
+export MY_BRANCH=issue_118
+```
+
+```bash
+echo "My IPA: ${MY_IPA}, WD: ${MY_WD}, ISSUE: ${MY_BRANCH}"
+```
+
+Install FTS using the candidate ZTI.
+The `--verbose` is optional.
+
+#### Use a Committed Branch from a Git Repository
+Notice that in the following command the `easy_install.sh` is taken from
+a working tree, while the branch is from the committed repository.
+
+```bash
+sudo bash ${MY_WD}/scripts/easy_install.sh -- --verbose --repo file://${MY_WD}/.git --branch ${MY_BRANCH:-main} --ip-addr ${MY_IPA} 
+```
+If you want to use Python packages from the https://test.pypi.org repository.
+```bash
+cat ${MY_WD}/scripts/easy_install.sh | sudo bash -s -- --verbose --repo file://${MY_WD}/.git --branch ${MY_BRANCH:-main} --ip-addr ${MY_IPA} --pypi https://test.pypi.org
+```
+
+### Configuration
+
+The official configuration instructions are
+[available in the user guide](https://freetakteam.github.io/FreeTAKServer-User-Docs/Installation/Operation/).
+Those instructions will not be duplicated here.
+
+## Running Installation Tests (smoke test)
+
+[Smoke testing](https://en.wikipedia.org/wiki/Smoke_testing_(software))
+is performed with the installation validation instructions.
+The official installation validation instructions are
+[available in the user guide](https://freetakteam.github.io/FreeTAKServer-User-Docs/Installation/Troubleshooting/InstallationCheck/).
+Those instructions will not be duplicated here.
+
+## Resetting the `distrobox`
+
+### Hard Reset
+The distrobox can be deleted and recreated.
+
+```shell
+distrobox rm fts
+```
+
+### Soft Reset
+
+The soft reset creates a new distrobox from a previous box.
+(You did make a snapshot, right?)
+```shell
+distrobox create --clone fts --name fts-test
+```