ci: add a test to check that the Docker image config works

.github/workflows/continous-integration-docker.yml

@@ -299,6 +299,36 @@ jobs:
         env:
           ZEBRA_TEST_LIGHTWALLETD: '1'
 
+  # Test that Zebra works using the default config with the latest Zebra version
+  #
+  # Also check that $ZEBRA_CONF_PATH works
+  test-configuration-file:
+    name: Test Zebra configuration file
+    runs-on: ubuntu-latest
+    needs: build
+    if: ${{ github.event.inputs.regenerate-disks != 'true' && github.event.inputs.run-full-sync != 'true' && github.event.inputs.run-lwd-sync != 'true' && github.event.inputs.run-lwd-send-tx != 'true' }}
+    steps:
+      - name: Inject slug/short variables
+        uses: rlespinasse/github-slug-action@v4
+        with:
+          short-length: 7
+
+      - name: Run tests using the default config
+        run: |
+          docker pull ${{ env.GAR_BASE }}/${{ env.IMAGE_NAME }}:sha-${{ env.GITHUB_SHA_SHORT }}
+          docker run --detach --name default-conf-tests -t ${{ env.GAR_BASE }}/${{ env.IMAGE_NAME }}:sha-${{ env.GITHUB_SHA_SHORT }} zebrad start
+          docker logs --tail all --follow default-conf-tests | tee --output-error=exit /dev/stderr | grep --extended-regexp --max-count=1 -e 'estimated progress to chain tip.*BeforeOverwinter'
+          docker stop default-conf-tests
+
+      - name: Run tests using the $ZEBRA_CONF_PATH
+        run: |
+          docker pull ${{ env.GAR_BASE }}/${{ env.IMAGE_NAME }}:sha-${{ env.GITHUB_SHA_SHORT }}
+          docker run --detach -e ZEBRA_CONF_PATH --name variable-conf-tests -t ${{ env.GAR_BASE }}/${{ env.IMAGE_NAME }}:sha-${{ env.GITHUB_SHA_SHORT }} zebrad -c $ZEBRA_CONF_PATH start
+          docker logs --tail all --follow variable-conf-tests | tee --output-error=exit /dev/stderr | grep --extended-regexp --max-count=1 -e 'v1.0.0-rc.2.toml'
+          docker stop variable-conf-tests
+        env:
+          ZEBRA_CONF_PATH: 'zebra/zebrad/tests/common/configs/v1.0.0-rc.2.toml'
+
   # zebrad cached checkpoint state tests
 
   # Regenerate mandatory checkpoint Zebra cached state disks.

docker/Dockerfile

@@ -110,7 +110,6 @@ RUN chmod u+x /entrypoint.sh
 
 # By default, runs the entrypoint tests specified by the environmental variables (if any are set)
 ENTRYPOINT [ "/entrypoint.sh" ]
-CMD [ "cargo" ]
 
 # In this stage we build a release (generate the zebrad binary)
 #
@@ -140,12 +139,15 @@ ARG CHECKPOINT_SYNC=true
 ARG NETWORK=Mainnet
 
 # Use a configurable dir and file for the zebrad configuration file
-ARG ZEBRA_CONF_PATH=/etc/zebra
-ENV ZEBRA_CONF_PATH ${ZEBRA_CONF_PATH}
+ARG ZEBRA_CONF_DIR=/etc/zebra
+ENV ZEBRA_CONF_DIR ${ZEBRA_CONF_DIR}
 
 ARG ZEBRA_CONF_FILE=zebrad.toml
 ENV ZEBRA_CONF_FILE ${ZEBRA_CONF_FILE}
 
+ARG ZEBRA_CONF_PATH=${ZEBRA_CONF_DIR}/${ZEBRA_CONF_FILE}
+ENV ZEBRA_CONF_PATH ${ZEBRA_CONF_PATH}
+
 # Build the `zebrad.toml` before starting the container, using the arguments from build
 # time, or using the default values set just above. And create the conf path and file if
 # it does not exist.
@@ -160,8 +162,8 @@ ENV ZEBRA_CONF_FILE ${ZEBRA_CONF_FILE}
 #  - move this file creation to an entrypoint as we can use default values at runtime,
 #    and modify those as needed when starting the container (at runtime and not at build time)
 #  - make `cache_dir`, `rpc.listen_addr`, `metrics.endpoint_addr`, and `tracing.endpoint_addr` into Docker arguments
-RUN mkdir -p ${ZEBRA_CONF_PATH} \
-    && touch ${ZEBRA_CONF_PATH}/${ZEBRA_CONF_FILE}
+RUN mkdir -p ${ZEBRA_CONF_DIR} \
+    && touch ${ZEBRA_CONF_PATH}
 RUN set -ex; \
   { \
     echo "[network]"; \
@@ -177,7 +179,7 @@ RUN set -ex; \
     echo "#endpoint_addr = '127.0.0.1:9999'"; \
     echo "[tracing]"; \
     echo "#endpoint_addr = '127.0.0.1:3000'"; \
-  } > "${ZEBRA_CONF_PATH}/${ZEBRA_CONF_FILE}"
+  } > "${ZEBRA_CONF_PATH}"
 
 EXPOSE 8233 18233
 
@@ -188,4 +190,4 @@ ARG SENTRY_DSN
 ENV SENTRY_DSN ${SENTRY_DSN}
 
 # TODO: remove the specified config file location and use the default expected by zebrad
-CMD zebrad -c "${ZEBRA_CONF_PATH}/${ZEBRA_CONF_FILE}" start
+CMD zebrad -c "${ZEBRA_CONF_PATH}" start

docker/entrypoint.sh

@@ -15,7 +15,13 @@ echo "ZEBRA_CACHED_STATE_DIR=$ZEBRA_CACHED_STATE_DIR"
 echo "LIGHTWALLETD_DATA_DIR=$LIGHTWALLETD_DATA_DIR"
 
 case "$1" in
-    -- | cargo)
+    -- | zebrad)
+        exec zebrad "$@"
+        ;;
+    -*)
+        exec zebrad "$@"
+        ;;
+    *)
         # For these tests, we activate the gRPC feature to avoid recompiling `zebrad`,
         # but we might not actually run any gRPC tests.
         if [[ "$RUN_ALL_TESTS" -eq "1" ]]; then
@@ -86,17 +92,8 @@ case "$1" in
             # Starting with a cached Zebra tip, test sending a block to Zebra's RPC port.
             ls -lh "$ZEBRA_CACHED_STATE_DIR"/*/* || (echo "No $ZEBRA_CACHED_STATE_DIR/*/*"; ls -lhR  "$ZEBRA_CACHED_STATE_DIR" | head -50 || echo "No $ZEBRA_CACHED_STATE_DIR directory")
             cargo test --locked --release --features getblocktemplate-rpcs --package zebrad --test acceptance -- --nocapture --include-ignored submit_block
-
-        # These command-lines are provided by the caller.
-        #
-        # TODO: test that the following 3 cases actually work, or remove them
         else
             exec "$@"
         fi
         ;;
-    zebrad)
-        exec zebrad "$@"
-        ;;
-    *)
-        exec "$@"
 esac