Merge pull request #1864 from pi-hole/development

Development

Author: PromoFaux

.github/workflows/build-and-publish.yml

@@ -16,11 +16,23 @@ env:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.runner }}
     strategy:
       fail-fast: false
       matrix:
-        platform: [linux/amd64, linux/386, linux/arm/v6, linux/arm/v7, linux/arm64, linux/riscv64]
+        include:
+          - platform: linux/amd64
+            runner: ubuntu-latest
+          - platform: linux/386
+            runner: ubuntu-latest
+          - platform: linux/arm/v6
+            runner: ubuntu-24.04-arm
+          - platform: linux/arm/v7
+            runner: ubuntu-24.04-arm
+          - platform: linux/arm64
+            runner: ubuntu-24.04-arm
+          - platform: linux/riscv64
+            runner: ubuntu-24.04-arm
 
     steps:
       - name: Prepare name for digest up/download

.github/workflows/build-and-test.yml

@@ -3,30 +3,49 @@ on:
   pull_request:
 
 jobs:
-  test:
-    runs-on: ubuntu-latest
+  build-and-test:
+    runs-on: ${{ matrix.runner }}
     strategy:
       fail-fast: false
       matrix:
-        # Official docker images for docker are only available for amd64 and arm64
-        # TODO: Look at: https://github.com/docker-library/official-images#architectures-other-than-amd64
-        # Is testing on all platforms really necessary?
-        # Disabled arm64 tests for the time being, something is wrong with the test config and the volumes are getting shared between the test containers on different architectures
-        #platform: [linux/amd64, linux/arm64]
-        platform: [linux/amd64]
+        include:
+          - platform: linux/amd64
+            runner: ubuntu-latest
+          - platform: linux/386
+            runner: ubuntu-latest
+          - platform: linux/arm/v6
+            runner: ubuntu-24.04-arm
+          - platform: linux/arm/v7
+            runner: ubuntu-24.04-arm
+          - platform: linux/arm64
+            runner: ubuntu-24.04-arm
+          - platform: linux/riscv64
+            runner: ubuntu-24.04-arm
+    env:
+      CI_ARCH: ${{ matrix.platform }}
     steps:
     - name: Checkout Repo
       uses: actions/checkout@v4
 
     - name: Set up QEMU
       uses: docker/setup-qemu-action@v3
+
+    - name: Set up Python
+      uses: actions/[email protected]
       with:
-        platforms: ${{ matrix.platform }}
+        python-version: "3.13"
+    
+    - name: Run black formatter
+      run: |
+        pip install black
+        black --check --diff test/tests/
+
+    - name: Install wheel
+      run:  pip install wheel
 
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v3
+    - name: Install dependencies
+      run: pip install -r test/requirements.txt
 
-    - name: Run Tests
+    - name: Test with tox
       run: |
-        echo "Building image to test"
-        PLATFORM=${{ matrix.platform }} ./build-and-test.sh
+        CIPLATFORM=${{ env.CI_ARCH }} tox -c test/tox.ini

README.md

@@ -144,7 +144,7 @@ If this variable is not detected and you have not already set one via `pihole se
 | `FTLCONF_[SETTING]` | unset | As per documentation | Customize pihole.toml with settings described in the [API Documentation](https://docs.pi-hole.net/api).<br><br>Replace `.` with `_`, e.g for `dns.dnssec=true` use `FTLCONF_dns_dnssec: 'true'`.<br/>Array type configs should be delimited with `;`.|
 | `PIHOLE_UID` | `1000` | Number | Overrides image's default pihole user id to match a host user id.<br/>**IMPORTANT**: id must not already be in use inside the container!|
 | `PIHOLE_GID` | `1000` | Number | Overrides image's default pihole group id to match a host group id.<br/>**IMPORTANT**: id must not already be in use inside the container!|
-| `WEBPASSWORD_FILE` | unset| `<Docker secret file>` | Set an Admin password using [Docker secrets](https://docs.docker.com/engine/swarm/secrets/). If `FTLCONF_webserver_api_password` is set, `WEBPASSWORD_FILE` is ignored. If `FTLCONF_webserver_api_password` is empty, and `WEBPASSWORD_FILE` is set to a valid readable file, then `FTLCONF_webserver_api_password` will be set to the contents of `WEBPASSWORD_FILE`. |
+| `WEBPASSWORD_FILE` | unset| `<Docker secret file>` | Set an Admin password using Docker secrets with [Swarm](https://docs.docker.com/engine/swarm/secrets/) or [Compose](https://docs.docker.com/compose/how-tos/use-secrets/). If `FTLCONF_webserver_api_password` is set, `WEBPASSWORD_FILE` is ignored. If `FTLCONF_webserver_api_password` is empty, and `WEBPASSWORD_FILE` is set to a valid readable file, then `FTLCONF_webserver_api_password` will be set to the contents of `WEBPASSWORD_FILE`. See [WEBPASSWORD_FILE Example](https://docs.pi-hole.net/docker/configuration/#webpassword_file-example) for additional information.|
 
 ### Advanced Variables
 
@@ -183,36 +183,8 @@ Here is a rundown of other arguments for your docker-compose / docker run.
 - Docker's default network mode `bridge` isolates the container from the host's network. This is a more secure setting, but requires setting the Pi-hole DNS option for _Interface listening behavior_ to "Listen on all interfaces, permit all origins".
 - If you're using a Red Hat based distribution with an SELinux Enforcing policy, add `:z` to line with volumes.
 
-### Installing on Ubuntu or Fedora
-
-Modern releases of Ubuntu (17.10+) and Fedora (33+) include [`systemd-resolved`](http://manpages.ubuntu.com/manpages/bionic/man8/systemd-resolved.service.8.html) which is configured by default to implement a caching DNS stub resolver. This will prevent pi-hole from listening on port 53.
-The stub resolver should be disabled with: `sudo sed -r -i.orig 's/#?DNSStubListener=yes/DNSStubListener=no/g' /etc/systemd/resolved.conf`.
-
-This will not change the nameserver settings, which point to the stub resolver thus preventing DNS resolution. Change the `/etc/resolv.conf` symlink to point to `/run/systemd/resolve/resolv.conf`, which is automatically updated to follow the system's [`netplan`](https://netplan.io/):
-`sudo sh -c 'rm /etc/resolv.conf && ln -s /run/systemd/resolve/resolv.conf /etc/resolv.conf'`.
-After making these changes, you should restart systemd-resolved using `systemctl restart systemd-resolved`.
-
-Once pi-hole is installed, you'll want to configure your clients to use it ([see here](https://discourse.pi-hole.net/t/how-do-i-configure-my-devices-to-use-pi-hole-as-their-dns-server/245)). If you used the symlink above, your docker host will either use whatever is served by DHCP, or whatever static setting you've configured. If you want to explicitly set your docker host's nameservers you can edit the netplan(s) found at `/etc/netplan`, then run `sudo netplan apply`.
-
-Example netplan:
-
-```yaml
-network:
-    ethernets:
-        ens160:
-            dhcp4: true
-            dhcp4-overrides:
-                use-dns: false
-            nameservers:
-                addresses: [127.0.0.1]
-    version: 2
-```
-
-Note that it is also possible to disable `systemd-resolved` entirely. However, this can cause problems with name resolution in vpns ([see bug report](https://bugs.launchpad.net/network-manager/+bug/1624317)).\
-It also disables the functionality of netplan since systemd-resolved is used as the default renderer ([see `man netplan`](http://manpages.ubuntu.com/manpages/bionic/man5/netplan.5.html#description)).\
-If you choose to disable the service, you will need to manually set the nameservers, for example by creating a new `/etc/resolv.conf`.
-
-Users of older Ubuntu releases (circa 17.04) will need to disable dnsmasq.
+> [!TIP]
+> All further tips and tricks can be found in the [Pi-hole documentation](https://docs.pi-hole.net/docker/tips-and-tricks/)
 
 ## Installing on Dokku
 

build-and-test.sh

@@ -1,17 +1,7 @@
 # syntax=docker/dockerfile:1
 ARG FTL_SOURCE=remote
 # Pull Stable images
-FROM alpine:3.22 AS base-stable
-FROM base-stable AS base-386
-FROM base-stable AS base-amd64
-FROM base-stable AS base-arm
-FROM base-stable AS base-arm64
-# Pull Edge images
-FROM alpine:edge AS base-edge
-FROM base-edge   AS base-riscv64
-# Use the base image for the current architecture
-FROM base-${TARGETARCH} AS base
-# https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope
+FROM alpine:3.22 AS base
 
 ARG TARGETPLATFORM
 ARG WEB_BRANCH="development"
@@ -40,7 +30,7 @@ RUN apk add --no-cache \
     git \
     # Install grep to avoid issues in pihole -w/b with the default busybox grep
     grep \
-    iproute2-ss \
+    iproute2 \
     jq \
     libcap \
     logrotate \

src/Dockerfile

@@ -1,19 +1,12 @@
 # Prerequisites
 
-Make sure you have bash & docker installed.
-Python and some test hacks are crammed into the `Dockerfile_build` file for now.
-Revisions in the future may re-enable running python on your host (not just in docker).
+Make sure you have `docker`, `python` and `tox` installed.
 
 # Running tests locally
 
-`./build-and-test.sh`
+`tox -c test/tox.ini`
 
 Should result in:
 
-- An image named `pihole:[branch-name]` being built
+- An image named `pihole:CI_container` being built
 - Tests being ran to confirm the image doesn't have any regressions
-
-# Modify Pipfile
-
-You can enter into the test docker image using `./build-and-test.sh enter`.
-From there, you can `cd test` and execute any needed pipenv commands.

test/Dockerfile

@@ -1,5 +1,6 @@
-pytest == 8.4.0
-pytest-xdist == 3.7.0
+pytest == 8.4.1
 pytest-testinfra == 10.2.2
-black == 25.1.0
 pytest-clarity == 1.0.1
+tox == 4.27.0
+# Not adding pytest-xdist as using pytest with n > 1 cores 
+# causes random issues with the emulated architectures