Compare commits
27 Commits
v1.1.1
...
7ecb26cc92
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
7ecb26cc92 | ||
|
|
5d4a2d59db | ||
|
|
1847c14b63 | ||
|
|
29e812f584 | ||
|
|
1c8de40a05 | ||
|
|
4bfa7433f4 | ||
|
|
00c012e553 | ||
|
|
1bebeb8abc | ||
|
|
01d1626cf2 | ||
|
|
5bbe78b272 | ||
|
|
865d5155d5 | ||
|
|
209037cd64 | ||
|
|
ba2d84b6cb | ||
|
|
4f5c41753f | ||
|
|
aac01810a1 | ||
|
|
fb42167b89 | ||
|
|
7836dbacf9 | ||
|
|
d380b1493c | ||
|
|
e81c5262b0 | ||
|
|
f35ea04d66 | ||
|
|
37a17b536d | ||
|
|
c80fdf8d01 | ||
|
|
276833bd16 | ||
|
|
9e267ec83f | ||
|
|
20274985bc | ||
|
|
cf473d4f3f | ||
|
|
84323bd2aa |
69
.github/workflows/ci.yml
vendored
69
.github/workflows/ci.yml
vendored
@@ -1,11 +1,76 @@
|
|||||||
name: ci
|
name: ci
|
||||||
|
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request: {}
|
||||||
push:
|
push:
|
||||||
branches:
|
branches:
|
||||||
- main
|
- "**"
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
packages: write
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
tests:
|
tests:
|
||||||
uses: ./.github/workflows/reusable-test.yml
|
uses: ./.github/workflows/reusable-test.yml
|
||||||
|
with:
|
||||||
|
python-version: "3.12"
|
||||||
|
matomo-token-description: "ci-token"
|
||||||
|
|
||||||
|
detect-release:
|
||||||
|
# Only consider releases on main branch pushes (not PRs, not other branches)
|
||||||
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
outputs:
|
||||||
|
is_semver_tag: ${{ steps.detect.outputs.is_semver_tag }}
|
||||||
|
version_tag: ${{ steps.detect.outputs.version_tag }}
|
||||||
|
steps:
|
||||||
|
- name: Checkout (full history for tags)
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- id: detect
|
||||||
|
shell: bash
|
||||||
|
run: |
|
||||||
|
set -euo pipefail
|
||||||
|
git fetch --tags --force
|
||||||
|
|
||||||
|
# Tags that point to the current commit
|
||||||
|
TAGS="$(git tag --points-at "$GITHUB_SHA" || true)"
|
||||||
|
|
||||||
|
# Pick the first strict SemVer tag: vX.Y.Z
|
||||||
|
VERSION_TAG="$(echo "$TAGS" | grep -E '^v[0-9]+\.[0-9]+\.[0-9]+$' | head -n1 || true)"
|
||||||
|
|
||||||
|
if [ -n "$VERSION_TAG" ]; then
|
||||||
|
echo "is_semver_tag=true" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "version_tag=$VERSION_TAG" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "Release tag detected on this commit: $VERSION_TAG"
|
||||||
|
else
|
||||||
|
echo "is_semver_tag=false" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "version_tag=" >> "$GITHUB_OUTPUT"
|
||||||
|
echo "No SemVer tag on this commit."
|
||||||
|
fi
|
||||||
|
|
||||||
|
publish-image:
|
||||||
|
# Only on main, and only if detect-release found a SemVer tag on this commit
|
||||||
|
if: needs.detect-release.outputs.is_semver_tag == 'true'
|
||||||
|
needs: [tests, detect-release]
|
||||||
|
uses: ./.github/workflows/publish-image.yml
|
||||||
|
with:
|
||||||
|
version_tag: ${{ needs.detect-release.outputs.version_tag }}
|
||||||
|
sha: ${{ github.sha }}
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: write
|
||||||
|
|
||||||
|
tag-stable:
|
||||||
|
# Only after tests + publish succeeded
|
||||||
|
if: needs.detect-release.outputs.is_semver_tag == 'true'
|
||||||
|
needs: [tests, detect-release, publish-image]
|
||||||
|
uses: ./.github/workflows/stable-tag.yml
|
||||||
|
with:
|
||||||
|
version_tag: ${{ needs.detect-release.outputs.version_tag }}
|
||||||
|
sha: ${{ github.sha }}
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|||||||
36
.github/workflows/publish-image.yml
vendored
36
.github/workflows/publish-image.yml
vendored
@@ -1,32 +1,28 @@
|
|||||||
name: publish-image
|
name: publish-image
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
workflow_call:
|
||||||
tags:
|
inputs:
|
||||||
- "v*.*.*"
|
version_tag:
|
||||||
|
type: string
|
||||||
workflow_run:
|
required: true
|
||||||
workflows: ["Stable Tag"] # MUST match stable-tag.yml -> name: Stable Tag
|
sha:
|
||||||
types: [completed]
|
type: string
|
||||||
|
required: true
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build-and-push:
|
build-and-push:
|
||||||
if: |
|
|
||||||
(github.event_name == 'push') ||
|
|
||||||
(github.event_name == 'workflow_run' && github.event.workflow_run.conclusion == 'success')
|
|
||||||
|
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
packages: write
|
packages: write
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout (exact commit)
|
||||||
uses: actions/checkout@v4
|
uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
# push: checks out the tag ref
|
fetch-depth: 0
|
||||||
# workflow_run: checks out the exact commit that the Stable Tag workflow ran on
|
ref: ${{ inputs.sha }}
|
||||||
ref: ${{ github.event_name == 'workflow_run' && github.event.workflow_run.head_sha || github.ref }}
|
|
||||||
|
|
||||||
- name: Set up QEMU
|
- name: Set up QEMU
|
||||||
uses: docker/setup-qemu-action@v3
|
uses: docker/setup-qemu-action@v3
|
||||||
@@ -47,13 +43,9 @@ jobs:
|
|||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
IMAGE="ghcr.io/${{ github.repository }}"
|
IMAGE="ghcr.io/${{ github.repository }}"
|
||||||
|
RAW_TAG="${{ inputs.version_tag }}" # e.g. v1.1.8
|
||||||
if [ "${{ github.event_name }}" = "push" ]; then
|
TAG="${RAW_TAG#v}" # -> 1.1.8
|
||||||
TAG="${{ github.ref_name }}" # e.g. v1.1.0
|
echo "tags=$IMAGE:$TAG,$IMAGE:latest" >> "$GITHUB_OUTPUT"
|
||||||
echo "tags=$IMAGE:$TAG,$IMAGE:latest" >> "$GITHUB_OUTPUT"
|
|
||||||
else
|
|
||||||
echo "tags=$IMAGE:stable" >> "$GITHUB_OUTPUT"
|
|
||||||
fi
|
|
||||||
|
|
||||||
- name: Build and push
|
- name: Build and push
|
||||||
uses: docker/build-push-action@v6
|
uses: docker/build-push-action@v6
|
||||||
|
|||||||
15
.github/workflows/reusable-test.yml
vendored
15
.github/workflows/reusable-test.yml
vendored
@@ -52,6 +52,21 @@ jobs:
|
|||||||
ruff check .
|
ruff check .
|
||||||
ruff format --check .
|
ruff format --check .
|
||||||
|
|
||||||
|
integration:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: lint
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v5
|
||||||
|
with:
|
||||||
|
python-version: ${{ inputs.python-version }}
|
||||||
|
|
||||||
|
- name: Integration tests
|
||||||
|
run: make test-integration
|
||||||
|
|
||||||
e2e:
|
e2e:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
timeout-minutes: 30
|
timeout-minutes: 30
|
||||||
|
|||||||
29
.github/workflows/stable-tag.yml
vendored
29
.github/workflows/stable-tag.yml
vendored
@@ -1,24 +1,21 @@
|
|||||||
name: Stable Tag
|
name: Stable Tag
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
workflow_call:
|
||||||
tags:
|
inputs:
|
||||||
- "v*"
|
version_tag:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
sha:
|
||||||
|
type: string
|
||||||
|
required: true
|
||||||
|
|
||||||
permissions:
|
permissions:
|
||||||
contents: write
|
contents: write
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
|
||||||
uses: ./.github/workflows/reusable-test.yml
|
|
||||||
with:
|
|
||||||
python-version: "3.12"
|
|
||||||
matomo-token-description: "stable-ci-token"
|
|
||||||
|
|
||||||
tag-stable:
|
tag-stable:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
needs: test
|
|
||||||
if: startsWith(github.ref, 'refs/tags/v')
|
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout (full history for tags)
|
- name: Checkout (full history for tags)
|
||||||
@@ -26,17 +23,17 @@ jobs:
|
|||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
|
|
||||||
- name: Move stable tag to this version tag commit
|
- name: Move stable tag to the release commit
|
||||||
|
shell: bash
|
||||||
run: |
|
run: |
|
||||||
set -euo pipefail
|
set -euo pipefail
|
||||||
|
|
||||||
echo "Triggered by tag: ${GITHUB_REF_NAME}"
|
echo "Release tag: ${{ inputs.version_tag }}"
|
||||||
echo "Commit: ${GITHUB_SHA}"
|
echo "Commit: ${{ inputs.sha }}"
|
||||||
|
|
||||||
git config user.name "github-actions[bot]"
|
git config user.name "github-actions[bot]"
|
||||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||||
|
|
||||||
git fetch --tags --force
|
git fetch --tags --force
|
||||||
|
git tag -fa stable -m "stable -> ${{ inputs.version_tag }} (${{ inputs.sha }})" "${{ inputs.sha }}"
|
||||||
git tag -fa stable -m "stable -> ${GITHUB_REF_NAME} (${GITHUB_SHA})" "${GITHUB_SHA}"
|
|
||||||
git push --force origin stable
|
git push --force origin stable
|
||||||
|
|||||||
50
CHANGELOG.md
50
CHANGELOG.md
@@ -1,3 +1,53 @@
|
|||||||
|
## [1.1.11] - 2026-02-14
|
||||||
|
|
||||||
|
* This release improves matomo-bootstrap installer resilience by adding robust setupSuperUser field and button detection to prevent intermittent bootstrap failures.
|
||||||
|
|
||||||
|
|
||||||
|
## [1.1.10] - 2026-02-14
|
||||||
|
|
||||||
|
* This release fixes a reproducible Playwright navigation race in the Matomo installer (setupSuperUser), hardens the Next/Continue flow, and adds integration tests for transient locator errors and progress detection without a visible Next button.
|
||||||
|
|
||||||
|
|
||||||
|
## [1.1.9] - 2026-02-14
|
||||||
|
|
||||||
|
* Reworked CI to run on all branches while restricting Docker image publishing and stable tagging to tagged commits on main, using git-based SemVer detection.
|
||||||
|
|
||||||
|
|
||||||
|
## [1.1.8] - 2026-02-14
|
||||||
|
|
||||||
|
* Refactored CI to use a single coordinator workflow with strict SemVer-based release gating and adjusted Docker image publishing to strip the leading v from version tags.
|
||||||
|
|
||||||
|
|
||||||
|
## [1.1.7] - 2026-02-14
|
||||||
|
|
||||||
|
* Harden compose installer timeouts and e2e stack diagnostics
|
||||||
|
|
||||||
|
|
||||||
|
## [1.1.6] - 2026-02-14
|
||||||
|
|
||||||
|
* Add installer table-step timeout env vars (MATOMO_INSTALLER_TABLES_CREATION_TIMEOUT_S, MATOMO_INSTALLER_TABLES_ERASE_TIMEOUT_S) to compose/docs and e2e checks.
|
||||||
|
|
||||||
|
|
||||||
|
## [1.1.5] - 2026-02-14
|
||||||
|
|
||||||
|
* Harden web installer flow for nix e2e
|
||||||
|
|
||||||
|
|
||||||
|
## [1.1.4] - 2026-02-13
|
||||||
|
|
||||||
|
* This release hardens Matomo bootstrap by adding installer UI readiness waits/retries.
|
||||||
|
|
||||||
|
|
||||||
|
## [1.1.3] - 2026-02-12
|
||||||
|
|
||||||
|
* Increase Playwright step wait from 200ms to 1000ms to improve CI stability during Matomo installation.
|
||||||
|
|
||||||
|
|
||||||
|
## [1.1.2] - 2025-12-24
|
||||||
|
|
||||||
|
* **Improved error visibility during Matomo installation**: When the setup fails (for example due to an invalid admin email or missing required fields), the installer now **prints the actual Matomo error messages to the logs**, instead of failing with a generic error.
|
||||||
|
|
||||||
|
|
||||||
## [1.1.1] - 2025-12-24
|
## [1.1.1] - 2025-12-24
|
||||||
|
|
||||||
* Improved Docker image publishing: automatic `vX.Y.Z`, `latest`, and `stable` tags for releases.
|
* Improved Docker image publishing: automatic `vX.Y.Z`, `latest`, and `stable` tags for releases.
|
||||||
|
|||||||
53
Makefile
53
Makefile
@@ -34,12 +34,13 @@ COMPOSE_STACK := docker compose -f $(COMPOSE_STACK_FILE)
|
|||||||
|
|
||||||
.PHONY: help \
|
.PHONY: help \
|
||||||
venv deps-e2e playwright-install e2e-up e2e-install e2e-test e2e-down e2e logs clean \
|
venv deps-e2e playwright-install e2e-up e2e-install e2e-test e2e-down e2e logs clean \
|
||||||
|
test-integration \
|
||||||
image-build image-run image-shell image-push image-clean \
|
image-build image-run image-shell image-push image-clean \
|
||||||
stack-up stack-down stack-logs stack-ps stack-bootstrap stack-rebootstrap stack-clean stack-reset
|
stack-up stack-down stack-logs stack-ps stack-bootstrap stack-rebootstrap stack-clean stack-reset
|
||||||
|
|
||||||
help:
|
help:
|
||||||
@echo "Targets:"
|
@echo "Targets:"
|
||||||
@echo " venv Create local venv in $(VENV_DIR)"
|
@echo " venv Create local venv in $(VENV_DIR)"
|
||||||
@echo " deps-e2e Install package + E2E deps into venv"
|
@echo " deps-e2e Install package + E2E deps into venv"
|
||||||
@echo " playwright-install Install Chromium for Playwright (inside venv)"
|
@echo " playwright-install Install Chromium for Playwright (inside venv)"
|
||||||
@echo " e2e-up Start Matomo + DB for E2E tests"
|
@echo " e2e-up Start Matomo + DB for E2E tests"
|
||||||
@@ -49,6 +50,7 @@ help:
|
|||||||
@echo " e2e Full cycle: up → install → test → down"
|
@echo " e2e Full cycle: up → install → test → down"
|
||||||
@echo " logs Show Matomo logs (E2E compose)"
|
@echo " logs Show Matomo logs (E2E compose)"
|
||||||
@echo " clean Stop E2E containers + remove venv"
|
@echo " clean Stop E2E containers + remove venv"
|
||||||
|
@echo " test-integration Run integration tests (unittest)"
|
||||||
@echo ""
|
@echo ""
|
||||||
@echo "Container image targets:"
|
@echo "Container image targets:"
|
||||||
@echo " image-build Build matomo-bootstrap container image"
|
@echo " image-build Build matomo-bootstrap container image"
|
||||||
@@ -76,8 +78,46 @@ help:
|
|||||||
# ----------------------------
|
# ----------------------------
|
||||||
|
|
||||||
venv:
|
venv:
|
||||||
@test -x "$(VENV_PY)" || ($(PYTHON) -m venv $(VENV_DIR))
|
@set -e; \
|
||||||
@$(VENV_PIP) -q install -U pip setuptools wheel >/dev/null
|
if [ ! -d "$(VENV_DIR)" ]; then \
|
||||||
|
echo "Creating $(VENV_DIR) ..."; \
|
||||||
|
$(PYTHON) -m venv "$(VENV_DIR)"; \
|
||||||
|
fi; \
|
||||||
|
if ! [ -x "$(VENV_PY)" ] || ! "$(VENV_PY)" -V >/dev/null 2>&1; then \
|
||||||
|
echo "Repairing $(VENV_PY) symlink ..."; \
|
||||||
|
fix_target=""; \
|
||||||
|
for cand in "$(VENV_DIR)/bin/python3.14" "$(VENV_DIR)/bin/python3.13" "$(VENV_DIR)/bin/python3.12" "$(VENV_DIR)/bin/python3.11" "$(VENV_DIR)/bin/python3.10"; do \
|
||||||
|
if [ -x "$$cand" ]; then \
|
||||||
|
fix_target="$$(basename "$$cand")"; \
|
||||||
|
break; \
|
||||||
|
fi; \
|
||||||
|
done; \
|
||||||
|
if [ -z "$$fix_target" ] && [ -x "$(VENV_PIP)" ]; then \
|
||||||
|
shebang="$$(head -n1 "$(VENV_PIP)" | sed 's/^#!//')"; \
|
||||||
|
if [ -n "$$shebang" ] && [ -x "$$shebang" ]; then \
|
||||||
|
fix_target="$$(basename "$$shebang")"; \
|
||||||
|
fi; \
|
||||||
|
fi; \
|
||||||
|
if [ -n "$$fix_target" ] && [ -x "$(VENV_DIR)/bin/$$fix_target" ]; then \
|
||||||
|
ln -sfn "$$fix_target" "$(VENV_PY)"; \
|
||||||
|
ln -sfn "$$fix_target" "$(VENV_DIR)/bin/python3"; \
|
||||||
|
fi; \
|
||||||
|
fi; \
|
||||||
|
if ! [ -x "$(VENV_PIP)" ] || ! "$(VENV_PIP)" --version >/dev/null 2>&1; then \
|
||||||
|
echo "Repairing pip via ensurepip ..."; \
|
||||||
|
"$(VENV_PY)" -m ensurepip --upgrade >/dev/null 2>&1 || true; \
|
||||||
|
fi; \
|
||||||
|
if ! [ -x "$(VENV_PY)" ] || ! "$(VENV_PY)" -V >/dev/null 2>&1; then \
|
||||||
|
echo "ERROR: Could not repair $(VENV_PY) in existing $(VENV_DIR)."; \
|
||||||
|
echo "Run 'make clean' once or remove $(VENV_DIR) manually."; \
|
||||||
|
exit 2; \
|
||||||
|
fi; \
|
||||||
|
if ! [ -x "$(VENV_PIP)" ] || ! "$(VENV_PIP)" --version >/dev/null 2>&1; then \
|
||||||
|
echo "ERROR: Could not repair $(VENV_PIP) in existing $(VENV_DIR)."; \
|
||||||
|
echo "Run 'make clean' once or remove $(VENV_DIR) manually."; \
|
||||||
|
exit 2; \
|
||||||
|
fi; \
|
||||||
|
"$(VENV_PIP)" -q install -U pip setuptools wheel >/dev/null
|
||||||
|
|
||||||
deps-e2e: venv
|
deps-e2e: venv
|
||||||
@$(VENV_PIP) install -e ".[e2e]"
|
@$(VENV_PIP) install -e ".[e2e]"
|
||||||
@@ -129,6 +169,13 @@ logs:
|
|||||||
clean: e2e-down
|
clean: e2e-down
|
||||||
rm -rf $(VENV_DIR)
|
rm -rf $(VENV_DIR)
|
||||||
|
|
||||||
|
# ----------------------------
|
||||||
|
# Integration tests
|
||||||
|
# ----------------------------
|
||||||
|
|
||||||
|
test-integration:
|
||||||
|
PYTHONPATH=src $(PYTHON) -m unittest discover -s tests/integration -v
|
||||||
|
|
||||||
# ----------------------------
|
# ----------------------------
|
||||||
# Container image workflow
|
# Container image workflow
|
||||||
# ----------------------------
|
# ----------------------------
|
||||||
|
|||||||
14
README.md
14
README.md
@@ -1,4 +1,6 @@
|
|||||||
# matomo-bootstrap
|
# matomo-bootstrap
|
||||||
|
[](https://github.com/sponsors/kevinveenbirkenbach) [](https://www.patreon.com/c/kevinveenbirkenbach) [](https://buymeacoffee.com/kevinveenbirkenbach) [](https://s.veen.world/paypaldonate)
|
||||||
|
|
||||||
|
|
||||||
Headless bootstrap tooling for **Matomo**. Automates **first-time installation** and **API token provisioning** for fresh Matomo instances.
|
Headless bootstrap tooling for **Matomo**. Automates **first-time installation** and **API token provisioning** for fresh Matomo instances.
|
||||||
---
|
---
|
||||||
@@ -170,7 +172,7 @@ services:
|
|||||||
volumes:
|
volumes:
|
||||||
- matomo_data:/var/www/html
|
- matomo_data:/var/www/html
|
||||||
healthcheck:
|
healthcheck:
|
||||||
test: ["CMD-SHELL", "wget -qO- http://127.0.0.1/ >/dev/null || exit 1"]
|
test: ["CMD-SHELL", "curl -fsS http://127.0.0.1/ >/dev/null || exit 1"]
|
||||||
interval: 10s
|
interval: 10s
|
||||||
timeout: 5s
|
timeout: 5s
|
||||||
retries: 60
|
retries: 60
|
||||||
@@ -207,10 +209,16 @@ services:
|
|||||||
MATOMO_TIMEZONE: "Germany - Berlin"
|
MATOMO_TIMEZONE: "Germany - Berlin"
|
||||||
|
|
||||||
# Optional stability knobs
|
# Optional stability knobs
|
||||||
MATOMO_TIMEOUT: "30"
|
MATOMO_TIMEOUT: "60"
|
||||||
MATOMO_PLAYWRIGHT_HEADLESS: "1"
|
MATOMO_PLAYWRIGHT_HEADLESS: "1"
|
||||||
MATOMO_PLAYWRIGHT_NAV_TIMEOUT_MS: "60000"
|
MATOMO_PLAYWRIGHT_NAV_TIMEOUT_MS: "60000"
|
||||||
MATOMO_PLAYWRIGHT_SLOWMO_MS: "0"
|
MATOMO_PLAYWRIGHT_SLOWMO_MS: "0"
|
||||||
|
MATOMO_INSTALLER_READY_TIMEOUT_S: "240"
|
||||||
|
MATOMO_INSTALLER_STEP_TIMEOUT_S: "45"
|
||||||
|
MATOMO_INSTALLER_STEP_DEADLINE_S: "240"
|
||||||
|
MATOMO_INSTALLER_TABLES_CREATION_TIMEOUT_S: "240"
|
||||||
|
MATOMO_INSTALLER_TABLES_ERASE_TIMEOUT_S: "180"
|
||||||
|
MATOMO_INSTALLER_DEBUG_DIR: "/tmp/matomo-bootstrap"
|
||||||
|
|
||||||
restart: "no"
|
restart: "no"
|
||||||
|
|
||||||
@@ -267,6 +275,8 @@ matomo-bootstrap
|
|||||||
2. **Installation (if needed)**
|
2. **Installation (if needed)**
|
||||||
|
|
||||||
* uses a recorded Playwright flow to complete the Matomo web installer
|
* uses a recorded Playwright flow to complete the Matomo web installer
|
||||||
|
* waits until installer controls are interactive before clicking next steps
|
||||||
|
* writes screenshot/HTML debug artifacts on installer failure
|
||||||
3. **Authentication**
|
3. **Authentication**
|
||||||
|
|
||||||
* logs in using Matomo’s `Login.logme` controller (cookie session)
|
* logs in using Matomo’s `Login.logme` controller (cookie session)
|
||||||
|
|||||||
@@ -34,7 +34,7 @@ services:
|
|||||||
volumes:
|
volumes:
|
||||||
- matomo_data:/var/www/html
|
- matomo_data:/var/www/html
|
||||||
healthcheck:
|
healthcheck:
|
||||||
test: ["CMD-SHELL", "wget -qO- http://127.0.0.1/ >/dev/null || exit 1"]
|
test: ["CMD-SHELL", "curl -fsS http://127.0.0.1/ >/dev/null || exit 1"]
|
||||||
interval: 10s
|
interval: 10s
|
||||||
timeout: 5s
|
timeout: 5s
|
||||||
retries: 60
|
retries: 60
|
||||||
@@ -47,7 +47,7 @@ services:
|
|||||||
container_name: matomo-bootstrap
|
container_name: matomo-bootstrap
|
||||||
depends_on:
|
depends_on:
|
||||||
matomo:
|
matomo:
|
||||||
condition: service_started
|
condition: service_healthy
|
||||||
environment:
|
environment:
|
||||||
MATOMO_URL: "http://matomo"
|
MATOMO_URL: "http://matomo"
|
||||||
MATOMO_ADMIN_USER: "administrator"
|
MATOMO_ADMIN_USER: "administrator"
|
||||||
@@ -61,10 +61,16 @@ services:
|
|||||||
MATOMO_TIMEZONE: "Germany - Berlin"
|
MATOMO_TIMEZONE: "Germany - Berlin"
|
||||||
|
|
||||||
# Optional stability knobs
|
# Optional stability knobs
|
||||||
MATOMO_TIMEOUT: "30"
|
MATOMO_TIMEOUT: "60"
|
||||||
MATOMO_PLAYWRIGHT_HEADLESS: "1"
|
MATOMO_PLAYWRIGHT_HEADLESS: "1"
|
||||||
MATOMO_PLAYWRIGHT_NAV_TIMEOUT_MS: "60000"
|
MATOMO_PLAYWRIGHT_NAV_TIMEOUT_MS: "60000"
|
||||||
MATOMO_PLAYWRIGHT_SLOWMO_MS: "0"
|
MATOMO_PLAYWRIGHT_SLOWMO_MS: "0"
|
||||||
|
MATOMO_INSTALLER_READY_TIMEOUT_S: "240"
|
||||||
|
MATOMO_INSTALLER_STEP_TIMEOUT_S: "45"
|
||||||
|
MATOMO_INSTALLER_STEP_DEADLINE_S: "240"
|
||||||
|
MATOMO_INSTALLER_TABLES_CREATION_TIMEOUT_S: "240"
|
||||||
|
MATOMO_INSTALLER_TABLES_ERASE_TIMEOUT_S: "180"
|
||||||
|
MATOMO_INSTALLER_DEBUG_DIR: "/tmp/matomo-bootstrap"
|
||||||
# bootstrap is a one-shot command that prints the token and exits
|
# bootstrap is a one-shot command that prints the token and exits
|
||||||
# if you want to re-run, do: docker compose run --rm bootstrap
|
# if you want to re-run, do: docker compose run --rm bootstrap
|
||||||
restart: "no"
|
restart: "no"
|
||||||
|
|||||||
@@ -27,3 +27,11 @@ MATOMO_TIMEZONE=Germany - Berlin
|
|||||||
# MATOMO_PLAYWRIGHT_HEADLESS=1
|
# MATOMO_PLAYWRIGHT_HEADLESS=1
|
||||||
# MATOMO_PLAYWRIGHT_NAV_TIMEOUT_MS=60000
|
# MATOMO_PLAYWRIGHT_NAV_TIMEOUT_MS=60000
|
||||||
# MATOMO_PLAYWRIGHT_SLOWMO_MS=0
|
# MATOMO_PLAYWRIGHT_SLOWMO_MS=0
|
||||||
|
|
||||||
|
# Installer readiness / step guards
|
||||||
|
# MATOMO_INSTALLER_READY_TIMEOUT_S=240
|
||||||
|
# MATOMO_INSTALLER_STEP_TIMEOUT_S=45
|
||||||
|
# MATOMO_INSTALLER_STEP_DEADLINE_S=240
|
||||||
|
# MATOMO_INSTALLER_TABLES_CREATION_TIMEOUT_S=240
|
||||||
|
# MATOMO_INSTALLER_TABLES_ERASE_TIMEOUT_S=180
|
||||||
|
# MATOMO_INSTALLER_DEBUG_DIR=/tmp/matomo-bootstrap
|
||||||
|
|||||||
@@ -20,7 +20,7 @@
|
|||||||
rec {
|
rec {
|
||||||
matomo-bootstrap = python.pkgs.buildPythonApplication {
|
matomo-bootstrap = python.pkgs.buildPythonApplication {
|
||||||
pname = "matomo-bootstrap";
|
pname = "matomo-bootstrap";
|
||||||
version = "1.1.1"; # keep in sync with pyproject.toml
|
version = "1.1.11"; # keep in sync with pyproject.toml
|
||||||
pyproject = true;
|
pyproject = true;
|
||||||
src = self;
|
src = self;
|
||||||
|
|
||||||
|
|||||||
@@ -4,12 +4,12 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "matomo-bootstrap"
|
name = "matomo-bootstrap"
|
||||||
version = "1.1.1"
|
version = "1.1.11"
|
||||||
description = "Headless bootstrap tooling for Matomo (installation + API token provisioning)"
|
description = "Headless bootstrap tooling for Matomo (installation + API token provisioning)"
|
||||||
readme = "README.md"
|
readme = "README.md"
|
||||||
requires-python = ">=3.10"
|
requires-python = ">=3.10"
|
||||||
authors = [{ name = "Kevin Veen-Birkenbach", email = "kevin@veen.world" }]
|
authors = [{ name = "Kevin Veen-Birkenbach", email = "kevin@veen.world" }]
|
||||||
license = { text = "MIT" }
|
license = "MIT"
|
||||||
urls = { Homepage = "https://github.com/kevinveenbirkenbach/matomo-bootstrap" }
|
urls = { Homepage = "https://github.com/kevinveenbirkenbach/matomo-bootstrap" }
|
||||||
|
|
||||||
dependencies = ["playwright>=1.46.0,<2"]
|
dependencies = ["playwright>=1.46.0,<2"]
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@@ -1,5 +1,7 @@
|
|||||||
import os
|
import os
|
||||||
|
import re
|
||||||
import subprocess
|
import subprocess
|
||||||
|
import textwrap
|
||||||
import unittest
|
import unittest
|
||||||
|
|
||||||
|
|
||||||
@@ -7,14 +9,24 @@ MATOMO_URL = os.environ.get("MATOMO_URL", "http://127.0.0.1:8080")
|
|||||||
ADMIN_USER = os.environ.get("MATOMO_ADMIN_USER", "administrator")
|
ADMIN_USER = os.environ.get("MATOMO_ADMIN_USER", "administrator")
|
||||||
ADMIN_PASSWORD = os.environ.get("MATOMO_ADMIN_PASSWORD", "AdminSecret123!")
|
ADMIN_PASSWORD = os.environ.get("MATOMO_ADMIN_PASSWORD", "AdminSecret123!")
|
||||||
ADMIN_EMAIL = os.environ.get("MATOMO_ADMIN_EMAIL", "administrator@example.org")
|
ADMIN_EMAIL = os.environ.get("MATOMO_ADMIN_EMAIL", "administrator@example.org")
|
||||||
|
TOKEN_RE = re.compile(r"^[a-f0-9]{32,64}$")
|
||||||
|
|
||||||
|
|
||||||
class TestMatomoBootstrapE2ENix(unittest.TestCase):
|
class TestMatomoBootstrapE2ENix(unittest.TestCase):
|
||||||
def test_bootstrap_creates_api_token_via_nix(self) -> None:
|
def test_bootstrap_creates_api_token_via_nix(self) -> None:
|
||||||
script = f"""set -euo pipefail
|
script = textwrap.dedent(
|
||||||
|
f"""\
|
||||||
|
set -eux
|
||||||
|
|
||||||
export NIX_CONFIG='experimental-features = nix-command flakes'
|
export NIX_CONFIG='experimental-features = nix-command flakes'
|
||||||
export TERM='xterm'
|
export TERM='xterm'
|
||||||
|
# Improve CI resilience for slow installer pages.
|
||||||
|
export MATOMO_INSTALLER_READY_TIMEOUT_S="${{MATOMO_INSTALLER_READY_TIMEOUT_S:-240}}"
|
||||||
|
export MATOMO_INSTALLER_STEP_TIMEOUT_S="${{MATOMO_INSTALLER_STEP_TIMEOUT_S:-45}}"
|
||||||
|
export MATOMO_INSTALLER_STEP_DEADLINE_S="${{MATOMO_INSTALLER_STEP_DEADLINE_S:-240}}"
|
||||||
|
export MATOMO_INSTALLER_TABLES_CREATION_TIMEOUT_S="${{MATOMO_INSTALLER_TABLES_CREATION_TIMEOUT_S:-240}}"
|
||||||
|
export MATOMO_INSTALLER_TABLES_ERASE_TIMEOUT_S="${{MATOMO_INSTALLER_TABLES_ERASE_TIMEOUT_S:-180}}"
|
||||||
|
export MATOMO_INSTALLER_DEBUG_DIR="${{MATOMO_INSTALLER_DEBUG_DIR:-/tmp/matomo-bootstrap}}"
|
||||||
|
|
||||||
# Make sure we have a writable HOME (compose already sets HOME=/tmp/home)
|
# Make sure we have a writable HOME (compose already sets HOME=/tmp/home)
|
||||||
mkdir -p "$HOME" "$HOME/.cache" "$HOME/.config" "$HOME/.local/share"
|
mkdir -p "$HOME" "$HOME/.cache" "$HOME/.config" "$HOME/.local/share"
|
||||||
@@ -25,6 +37,16 @@ mkdir -p "$HOME" "$HOME/.cache" "$HOME/.config" "$HOME/.local/share"
|
|||||||
# Mark it as safe explicitly.
|
# Mark it as safe explicitly.
|
||||||
git config --global --add safe.directory /work
|
git config --global --add safe.directory /work
|
||||||
|
|
||||||
|
# Preflight checks to surface "command not executable" failures (exit 126) clearly.
|
||||||
|
playwright_app="$(nix eval --raw .#apps.x86_64-linux.matomo-bootstrap-playwright-install.program)"
|
||||||
|
bootstrap_app="$(nix eval --raw .#apps.x86_64-linux.matomo-bootstrap.program)"
|
||||||
|
if [ -e "$playwright_app" ]; then
|
||||||
|
test -x "$playwright_app"
|
||||||
|
fi
|
||||||
|
if [ -e "$bootstrap_app" ]; then
|
||||||
|
test -x "$bootstrap_app"
|
||||||
|
fi
|
||||||
|
|
||||||
# 1) Install Playwright Chromium (cached in the container environment)
|
# 1) Install Playwright Chromium (cached in the container environment)
|
||||||
nix run --no-write-lock-file -L .#matomo-bootstrap-playwright-install
|
nix run --no-write-lock-file -L .#matomo-bootstrap-playwright-install
|
||||||
|
|
||||||
@@ -36,13 +58,18 @@ nix run --no-write-lock-file -L .#matomo-bootstrap -- \\
|
|||||||
--admin-email '{ADMIN_EMAIL}' \\
|
--admin-email '{ADMIN_EMAIL}' \\
|
||||||
--token-description 'e2e-test-token-nix'
|
--token-description 'e2e-test-token-nix'
|
||||||
"""
|
"""
|
||||||
|
)
|
||||||
|
|
||||||
cmd = [
|
cmd = [
|
||||||
"docker",
|
"docker",
|
||||||
"compose",
|
"compose",
|
||||||
"-f",
|
"-f",
|
||||||
"tests/e2e/docker-compose.yml",
|
"tests/e2e/docker-compose.yml",
|
||||||
"exec",
|
# Use `run` instead of `exec` to avoid runtime-specific
|
||||||
|
# `/etc/group` lookup issues seen with nix image + compose exec.
|
||||||
|
"run",
|
||||||
|
"--rm",
|
||||||
|
"--no-deps",
|
||||||
"-T",
|
"-T",
|
||||||
"nix",
|
"nix",
|
||||||
"sh",
|
"sh",
|
||||||
@@ -50,8 +77,30 @@ nix run --no-write-lock-file -L .#matomo-bootstrap -- \\
|
|||||||
script,
|
script,
|
||||||
]
|
]
|
||||||
|
|
||||||
token = subprocess.check_output(cmd).decode().strip()
|
result = subprocess.run(
|
||||||
self.assertRegex(token, r"^[a-f0-9]{32,64}$")
|
cmd,
|
||||||
|
check=False,
|
||||||
|
stdout=subprocess.PIPE,
|
||||||
|
stderr=subprocess.PIPE,
|
||||||
|
text=True,
|
||||||
|
)
|
||||||
|
if result.returncode != 0:
|
||||||
|
self.fail(
|
||||||
|
"nix bootstrap command failed\n"
|
||||||
|
f"exit={result.returncode}\n"
|
||||||
|
f"stdout:\n{result.stdout}\n"
|
||||||
|
f"stderr:\n{result.stderr}"
|
||||||
|
)
|
||||||
|
|
||||||
|
stdout_lines = [
|
||||||
|
line.strip() for line in result.stdout.splitlines() if line.strip()
|
||||||
|
]
|
||||||
|
token = stdout_lines[-1] if stdout_lines else ""
|
||||||
|
self.assertRegex(
|
||||||
|
token,
|
||||||
|
TOKEN_RE,
|
||||||
|
f"Expected token on last stdout line, got stdout={result.stdout!r}",
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
@@ -56,6 +56,29 @@ def _wait_for_http_any_status(url: str, timeout_s: int) -> None:
|
|||||||
raise RuntimeError(f"Matomo did not become reachable at {url} ({last_exc})")
|
raise RuntimeError(f"Matomo did not become reachable at {url} ({last_exc})")
|
||||||
|
|
||||||
|
|
||||||
|
def _extract_service_block(compose_config: str, service_name: str) -> str:
|
||||||
|
lines = compose_config.splitlines()
|
||||||
|
marker = f" {service_name}:"
|
||||||
|
start = -1
|
||||||
|
for idx, line in enumerate(lines):
|
||||||
|
if line == marker:
|
||||||
|
start = idx
|
||||||
|
break
|
||||||
|
if start < 0:
|
||||||
|
raise AssertionError(
|
||||||
|
f"service block not found in compose config: {service_name}"
|
||||||
|
)
|
||||||
|
|
||||||
|
end = len(lines)
|
||||||
|
for idx in range(start + 1, len(lines)):
|
||||||
|
line = lines[idx]
|
||||||
|
if line.startswith(" ") and not line.startswith(" "):
|
||||||
|
end = idx
|
||||||
|
break
|
||||||
|
|
||||||
|
return "\n".join(lines[start:end])
|
||||||
|
|
||||||
|
|
||||||
class TestRootDockerComposeStack(unittest.TestCase):
|
class TestRootDockerComposeStack(unittest.TestCase):
|
||||||
"""
|
"""
|
||||||
E2E test for repository root docker-compose.yml:
|
E2E test for repository root docker-compose.yml:
|
||||||
@@ -89,28 +112,65 @@ class TestRootDockerComposeStack(unittest.TestCase):
|
|||||||
# Build bootstrap image from Dockerfile (as defined in docker-compose.yml)
|
# Build bootstrap image from Dockerfile (as defined in docker-compose.yml)
|
||||||
build = _run(
|
build = _run(
|
||||||
_compose_cmd("build", "bootstrap"),
|
_compose_cmd("build", "bootstrap"),
|
||||||
check=True,
|
check=False,
|
||||||
extra_env={"MATOMO_PORT": MATOMO_PORT},
|
extra_env={"MATOMO_PORT": MATOMO_PORT},
|
||||||
)
|
)
|
||||||
self.assertEqual(build.returncode, 0, build.stderr)
|
self.assertEqual(
|
||||||
|
build.returncode,
|
||||||
|
0,
|
||||||
|
f"compose build failed\nstdout:\n{build.stdout}\nstderr:\n{build.stderr}",
|
||||||
|
)
|
||||||
|
|
||||||
# Start db + matomo (bootstrap is one-shot and started via "run")
|
# Start db + matomo (bootstrap is one-shot and started via "run")
|
||||||
up = _run(
|
up = _run(
|
||||||
_compose_cmd("up", "-d", "db", "matomo"),
|
_compose_cmd("up", "-d", "db", "matomo"),
|
||||||
check=True,
|
check=False,
|
||||||
extra_env={"MATOMO_PORT": MATOMO_PORT},
|
extra_env={"MATOMO_PORT": MATOMO_PORT},
|
||||||
)
|
)
|
||||||
self.assertEqual(up.returncode, 0, up.stderr)
|
self.assertEqual(
|
||||||
|
up.returncode,
|
||||||
|
0,
|
||||||
|
f"compose up failed\nstdout:\n{up.stdout}\nstderr:\n{up.stderr}",
|
||||||
|
)
|
||||||
|
|
||||||
# Wait until Matomo answers on the published port
|
# Wait until Matomo answers on the published port
|
||||||
_wait_for_http_any_status(MATOMO_HOST_URL + "/", WAIT_TIMEOUT_SECONDS)
|
_wait_for_http_any_status(MATOMO_HOST_URL + "/", WAIT_TIMEOUT_SECONDS)
|
||||||
|
|
||||||
# Run bootstrap: it should print ONLY the token to stdout
|
# Run bootstrap: it should print ONLY the token to stdout.
|
||||||
boot = _run(
|
# Retry once because first-run installer startup can be flaky on slow CI.
|
||||||
_compose_cmd("run", "--rm", "bootstrap"),
|
boot_attempts: list[subprocess.CompletedProcess] = []
|
||||||
check=True,
|
for _ in range(2):
|
||||||
extra_env={"MATOMO_PORT": MATOMO_PORT},
|
boot = _run(
|
||||||
)
|
_compose_cmd("run", "--rm", "bootstrap"),
|
||||||
|
check=False,
|
||||||
|
extra_env={"MATOMO_PORT": MATOMO_PORT},
|
||||||
|
)
|
||||||
|
boot_attempts.append(boot)
|
||||||
|
if boot.returncode == 0:
|
||||||
|
break
|
||||||
|
time.sleep(5)
|
||||||
|
|
||||||
|
if boot.returncode != 0:
|
||||||
|
matomo_logs = _run(
|
||||||
|
_compose_cmd("logs", "--no-color", "--tail=200", "matomo"),
|
||||||
|
check=False,
|
||||||
|
extra_env={"MATOMO_PORT": MATOMO_PORT},
|
||||||
|
)
|
||||||
|
attempts_dump = "\n\n".join(
|
||||||
|
[
|
||||||
|
(
|
||||||
|
f"[attempt {i}] rc={attempt.returncode}\n"
|
||||||
|
f"stdout:\n{attempt.stdout}\n"
|
||||||
|
f"stderr:\n{attempt.stderr}"
|
||||||
|
)
|
||||||
|
for i, attempt in enumerate(boot_attempts, 1)
|
||||||
|
]
|
||||||
|
)
|
||||||
|
self.fail(
|
||||||
|
"bootstrap container failed after retry.\n"
|
||||||
|
f"{attempts_dump}\n\n"
|
||||||
|
f"[matomo logs]\n{matomo_logs.stdout}\n{matomo_logs.stderr}"
|
||||||
|
)
|
||||||
|
|
||||||
token = (boot.stdout or "").strip()
|
token = (boot.stdout or "").strip()
|
||||||
self.assertRegex(
|
self.assertRegex(
|
||||||
@@ -131,5 +191,32 @@ class TestRootDockerComposeStack(unittest.TestCase):
|
|||||||
self.assertIsInstance(data, list)
|
self.assertIsInstance(data, list)
|
||||||
|
|
||||||
|
|
||||||
|
class TestRootDockerComposeDefinition(unittest.TestCase):
|
||||||
|
def test_bootstrap_service_waits_for_healthy_matomo_and_has_readiness_knobs(
|
||||||
|
self,
|
||||||
|
) -> None:
|
||||||
|
cfg = _run(
|
||||||
|
_compose_cmd("config"),
|
||||||
|
check=True,
|
||||||
|
extra_env={"MATOMO_PORT": MATOMO_PORT},
|
||||||
|
)
|
||||||
|
self.assertEqual(cfg.returncode, 0, cfg.stderr)
|
||||||
|
|
||||||
|
bootstrap_block = _extract_service_block(cfg.stdout, "bootstrap")
|
||||||
|
|
||||||
|
self.assertIn("depends_on:", bootstrap_block)
|
||||||
|
self.assertIn("matomo:", bootstrap_block)
|
||||||
|
self.assertIn("condition: service_healthy", bootstrap_block)
|
||||||
|
self.assertIn("MATOMO_INSTALLER_READY_TIMEOUT_S:", bootstrap_block)
|
||||||
|
self.assertIn("MATOMO_INSTALLER_STEP_TIMEOUT_S:", bootstrap_block)
|
||||||
|
self.assertIn("MATOMO_INSTALLER_STEP_DEADLINE_S:", bootstrap_block)
|
||||||
|
self.assertIn("MATOMO_INSTALLER_TABLES_CREATION_TIMEOUT_S:", bootstrap_block)
|
||||||
|
self.assertIn("MATOMO_INSTALLER_TABLES_ERASE_TIMEOUT_S:", bootstrap_block)
|
||||||
|
|
||||||
|
matomo_block = _extract_service_block(cfg.stdout, "matomo")
|
||||||
|
self.assertIn("healthcheck:", matomo_block)
|
||||||
|
self.assertIn("curl -fsS http://127.0.0.1/ >/dev/null || exit 1", matomo_block)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|||||||
0
tests/integration/__init__.py
Normal file
0
tests/integration/__init__.py
Normal file
173
tests/integration/test_web_installer_locator_count.py
Normal file
173
tests/integration/test_web_installer_locator_count.py
Normal file
@@ -0,0 +1,173 @@
|
|||||||
|
import unittest
|
||||||
|
|
||||||
|
from matomo_bootstrap.installers.web import _click_next_with_wait, _count_locator
|
||||||
|
|
||||||
|
|
||||||
|
class _FlakyLocator:
|
||||||
|
def __init__(self, outcomes):
|
||||||
|
self._outcomes = list(outcomes)
|
||||||
|
self.calls = 0
|
||||||
|
|
||||||
|
def count(self) -> int:
|
||||||
|
self.calls += 1
|
||||||
|
outcome = self._outcomes.pop(0)
|
||||||
|
if isinstance(outcome, Exception):
|
||||||
|
raise outcome
|
||||||
|
return int(outcome)
|
||||||
|
|
||||||
|
|
||||||
|
class _StaticLocator:
|
||||||
|
def __init__(self, page, selector: str):
|
||||||
|
self._page = page
|
||||||
|
self._selector = selector
|
||||||
|
|
||||||
|
def count(self) -> int:
|
||||||
|
if self._selector == "#login-0":
|
||||||
|
return 1 if self._page.login_visible else 0
|
||||||
|
if self._selector == "#siteName-0":
|
||||||
|
return 0
|
||||||
|
return 0
|
||||||
|
|
||||||
|
@property
|
||||||
|
def first(self):
|
||||||
|
return self
|
||||||
|
|
||||||
|
def is_visible(self) -> bool:
|
||||||
|
return self.count() > 0
|
||||||
|
|
||||||
|
|
||||||
|
class _RoleLocator:
|
||||||
|
def __init__(self, count_value: int):
|
||||||
|
self._count_value = count_value
|
||||||
|
|
||||||
|
def count(self) -> int:
|
||||||
|
return self._count_value
|
||||||
|
|
||||||
|
@property
|
||||||
|
def first(self):
|
||||||
|
return self
|
||||||
|
|
||||||
|
def is_visible(self) -> bool:
|
||||||
|
return self._count_value > 0
|
||||||
|
|
||||||
|
|
||||||
|
class _NameOnlyStaticLocator:
|
||||||
|
def __init__(self, page, selector: str):
|
||||||
|
self._page = page
|
||||||
|
self._selector = selector
|
||||||
|
|
||||||
|
def count(self) -> int:
|
||||||
|
if self._selector == "input[name='login']":
|
||||||
|
return 1 if self._page.login_visible else 0
|
||||||
|
if self._selector == "input[name='siteName']":
|
||||||
|
return 0
|
||||||
|
return 0
|
||||||
|
|
||||||
|
@property
|
||||||
|
def first(self):
|
||||||
|
return self
|
||||||
|
|
||||||
|
def is_visible(self) -> bool:
|
||||||
|
return self.count() > 0
|
||||||
|
|
||||||
|
|
||||||
|
class _NoNextButLoginAppearsPage:
|
||||||
|
def __init__(self):
|
||||||
|
self.url = "http://matomo/index.php?action=setupSuperUser&module=Installation"
|
||||||
|
self.login_visible = False
|
||||||
|
self._wait_calls = 0
|
||||||
|
|
||||||
|
def locator(self, selector: str):
|
||||||
|
return _StaticLocator(self, selector)
|
||||||
|
|
||||||
|
def get_by_role(self, role: str, name: str):
|
||||||
|
return _RoleLocator(0)
|
||||||
|
|
||||||
|
def get_by_text(self, *_args, **_kwargs):
|
||||||
|
return _RoleLocator(0)
|
||||||
|
|
||||||
|
def title(self) -> str:
|
||||||
|
return "setupSuperUser"
|
||||||
|
|
||||||
|
def wait_for_load_state(self, *_args, **_kwargs):
|
||||||
|
return None
|
||||||
|
|
||||||
|
def wait_for_timeout(self, *_args, **_kwargs):
|
||||||
|
self._wait_calls += 1
|
||||||
|
if self._wait_calls >= 1:
|
||||||
|
self.login_visible = True
|
||||||
|
|
||||||
|
|
||||||
|
class _NoNextButNamedLoginAppearsPage:
|
||||||
|
def __init__(self):
|
||||||
|
self.url = "http://matomo/index.php?action=setupSuperUser&module=Installation"
|
||||||
|
self.login_visible = False
|
||||||
|
self._wait_calls = 0
|
||||||
|
|
||||||
|
def locator(self, selector: str):
|
||||||
|
return _NameOnlyStaticLocator(self, selector)
|
||||||
|
|
||||||
|
def get_by_role(self, role: str, name: str):
|
||||||
|
return _RoleLocator(0)
|
||||||
|
|
||||||
|
def get_by_text(self, *_args, **_kwargs):
|
||||||
|
return _RoleLocator(0)
|
||||||
|
|
||||||
|
def title(self) -> str:
|
||||||
|
return "setupSuperUser"
|
||||||
|
|
||||||
|
def wait_for_load_state(self, *_args, **_kwargs):
|
||||||
|
return None
|
||||||
|
|
||||||
|
def wait_for_timeout(self, *_args, **_kwargs):
|
||||||
|
self._wait_calls += 1
|
||||||
|
if self._wait_calls >= 1:
|
||||||
|
self.login_visible = True
|
||||||
|
|
||||||
|
|
||||||
|
class TestWebInstallerLocatorCountIntegration(unittest.TestCase):
|
||||||
|
def test_retries_transient_navigation_error(self) -> None:
|
||||||
|
locator = _FlakyLocator(
|
||||||
|
[
|
||||||
|
RuntimeError(
|
||||||
|
"Locator.count: Execution context was destroyed, most likely because of a navigation"
|
||||||
|
),
|
||||||
|
RuntimeError(
|
||||||
|
"Locator.count: Execution context was destroyed, most likely because of a navigation"
|
||||||
|
),
|
||||||
|
1,
|
||||||
|
]
|
||||||
|
)
|
||||||
|
|
||||||
|
result = _count_locator(locator, timeout_s=0.5, retry_interval_s=0.0)
|
||||||
|
|
||||||
|
self.assertEqual(result, 1)
|
||||||
|
self.assertEqual(locator.calls, 3)
|
||||||
|
|
||||||
|
def test_raises_non_transient_error_without_retry(self) -> None:
|
||||||
|
locator = _FlakyLocator([RuntimeError("Locator is not attached to DOM")])
|
||||||
|
|
||||||
|
with self.assertRaises(RuntimeError):
|
||||||
|
_count_locator(locator, timeout_s=0.5, retry_interval_s=0.0)
|
||||||
|
|
||||||
|
self.assertEqual(locator.calls, 1)
|
||||||
|
|
||||||
|
def test_click_next_wait_treats_login_form_as_progress(self) -> None:
|
||||||
|
page = _NoNextButLoginAppearsPage()
|
||||||
|
|
||||||
|
step = _click_next_with_wait(page, timeout_s=1)
|
||||||
|
|
||||||
|
self.assertEqual(step, "Installation:setupSuperUser")
|
||||||
|
self.assertTrue(page.login_visible)
|
||||||
|
|
||||||
|
def test_click_next_wait_treats_named_login_form_as_progress(self) -> None:
|
||||||
|
page = _NoNextButNamedLoginAppearsPage()
|
||||||
|
|
||||||
|
step = _click_next_with_wait(page, timeout_s=1)
|
||||||
|
|
||||||
|
self.assertEqual(step, "Installation:setupSuperUser")
|
||||||
|
self.assertTrue(page.login_visible)
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
128
tests/integration/test_web_installer_warnings.py
Normal file
128
tests/integration/test_web_installer_warnings.py
Normal file
@@ -0,0 +1,128 @@
|
|||||||
|
import io
|
||||||
|
import unittest
|
||||||
|
from contextlib import redirect_stderr
|
||||||
|
|
||||||
|
|
||||||
|
# Import the function under test.
|
||||||
|
# This keeps the test close to real integration behavior without requiring Playwright.
|
||||||
|
from matomo_bootstrap.installers.web import _page_warnings
|
||||||
|
|
||||||
|
|
||||||
|
class _FakeLocatorNth:
|
||||||
|
def __init__(self, text: str):
|
||||||
|
self._text = text
|
||||||
|
|
||||||
|
def inner_text(self) -> str:
|
||||||
|
return self._text
|
||||||
|
|
||||||
|
|
||||||
|
class _FakeLocator:
|
||||||
|
def __init__(self, texts: list[str]):
|
||||||
|
self._texts = texts
|
||||||
|
|
||||||
|
def count(self) -> int:
|
||||||
|
return len(self._texts)
|
||||||
|
|
||||||
|
def nth(self, i: int) -> _FakeLocatorNth:
|
||||||
|
return _FakeLocatorNth(self._texts[i])
|
||||||
|
|
||||||
|
|
||||||
|
class _FakePage:
|
||||||
|
"""
|
||||||
|
Minimal Playwright-like page stub:
|
||||||
|
- locator(selector) -> object with count() / nth(i).inner_text()
|
||||||
|
- url, title()
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, *, url: str, title: str, selector_texts: dict[str, list[str]]):
|
||||||
|
self.url = url
|
||||||
|
self._title = title
|
||||||
|
self._selector_texts = selector_texts
|
||||||
|
|
||||||
|
def title(self) -> str:
|
||||||
|
return self._title
|
||||||
|
|
||||||
|
def locator(self, selector: str) -> _FakeLocator:
|
||||||
|
return _FakeLocator(self._selector_texts.get(selector, []))
|
||||||
|
|
||||||
|
|
||||||
|
class TestWebInstallerWarningsIntegration(unittest.TestCase):
|
||||||
|
def test_detects_bootstrap_alert_warning_block(self) -> None:
|
||||||
|
"""
|
||||||
|
Matomo installer commonly renders validation errors like:
|
||||||
|
<div class="alert alert-warning"> ... <ul><li>...</li></ul> ... </div>
|
||||||
|
We must detect and print those messages to stderr.
|
||||||
|
"""
|
||||||
|
page = _FakePage(
|
||||||
|
url="http://matomo/index.php?action=setupSuperUser&module=Installation",
|
||||||
|
title="Superuser",
|
||||||
|
selector_texts={
|
||||||
|
# The key selector from the observed DOM
|
||||||
|
".alert.alert-warning": [
|
||||||
|
"Please fix the following errors:\n"
|
||||||
|
"Password required\n"
|
||||||
|
"Password (repeat) required\n"
|
||||||
|
"The email doesn't have a valid format."
|
||||||
|
],
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
buf = io.StringIO()
|
||||||
|
with redirect_stderr(buf):
|
||||||
|
warnings = _page_warnings(page, prefix="[install]")
|
||||||
|
|
||||||
|
# Function must return the warning text
|
||||||
|
self.assertEqual(len(warnings), 1)
|
||||||
|
self.assertIn("Please fix the following errors:", warnings[0])
|
||||||
|
self.assertIn("The email doesn't have a valid format.", warnings[0])
|
||||||
|
|
||||||
|
# And it must print it to stderr (stdout must remain token-only in the app)
|
||||||
|
out = buf.getvalue()
|
||||||
|
self.assertIn("[install] page warnings/errors detected", out)
|
||||||
|
self.assertIn("Superuser", out)
|
||||||
|
self.assertIn("The email doesn't have a valid format.", out)
|
||||||
|
|
||||||
|
def test_deduplicates_repeated_warning_blocks(self) -> None:
|
||||||
|
"""
|
||||||
|
Some Matomo versions repeat the same alert in multiple containers.
|
||||||
|
We must return/log each unique text only once.
|
||||||
|
"""
|
||||||
|
repeated = (
|
||||||
|
"Please fix the following errors:\nThe email doesn't have a valid format."
|
||||||
|
)
|
||||||
|
page = _FakePage(
|
||||||
|
url="http://matomo/index.php?action=setupSuperUser&module=Installation",
|
||||||
|
title="Superuser",
|
||||||
|
selector_texts={
|
||||||
|
".alert.alert-warning": [repeated, repeated],
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
buf = io.StringIO()
|
||||||
|
with redirect_stderr(buf):
|
||||||
|
warnings = _page_warnings(page, prefix="[install]")
|
||||||
|
|
||||||
|
self.assertEqual(warnings, [repeated])
|
||||||
|
|
||||||
|
out = buf.getvalue()
|
||||||
|
# Only a single numbered entry should be printed
|
||||||
|
self.assertIn("[install] 1) ", out)
|
||||||
|
self.assertNotIn("[install] 2) ", out)
|
||||||
|
|
||||||
|
def test_no_output_when_no_warnings(self) -> None:
|
||||||
|
page = _FakePage(
|
||||||
|
url="http://matomo/",
|
||||||
|
title="Welcome",
|
||||||
|
selector_texts={},
|
||||||
|
)
|
||||||
|
|
||||||
|
buf = io.StringIO()
|
||||||
|
with redirect_stderr(buf):
|
||||||
|
warnings = _page_warnings(page, prefix="[install]")
|
||||||
|
|
||||||
|
self.assertEqual(warnings, [])
|
||||||
|
self.assertEqual(buf.getvalue(), "")
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
unittest.main()
|
||||||
Reference in New Issue
Block a user