Compare commits
11 Commits
use-bats-e
...
unsupporte
| Author | SHA1 | Date | |
|---|---|---|---|
| ba86a1c23f | |||
| 1703f169ba | |||
| fbb3798dc2 | |||
|
|
a393dd83f3 | ||
|
|
5ed52554d7 | ||
|
|
a9e3d3b728 | ||
|
|
a8db4def9a | ||
|
|
463086ef23 | ||
|
|
f3e04117f6 | ||
|
|
f67a8e5110 | ||
|
|
3f7f6f0294 |
6
.github/workflows/codeql-analysis.yml
vendored
6
.github/workflows/codeql-analysis.yml
vendored
@@ -29,12 +29,12 @@ jobs:
|
|||||||
# Initializes the CodeQL tools for scanning.
|
# Initializes the CodeQL tools for scanning.
|
||||||
-
|
-
|
||||||
name: Initialize CodeQL
|
name: Initialize CodeQL
|
||||||
uses: github/codeql-action/init@0d579ffd059c29b07949a3cce3983f0780820c98 #v4.32.6
|
uses: github/codeql-action/init@9e907b5e64f6b83e7804b09294d44122997950d6 #v4.32.3
|
||||||
with:
|
with:
|
||||||
languages: 'python'
|
languages: 'python'
|
||||||
-
|
-
|
||||||
name: Autobuild
|
name: Autobuild
|
||||||
uses: github/codeql-action/autobuild@0d579ffd059c29b07949a3cce3983f0780820c98 #v4.32.6
|
uses: github/codeql-action/autobuild@9e907b5e64f6b83e7804b09294d44122997950d6 #v4.32.3
|
||||||
-
|
-
|
||||||
name: Perform CodeQL Analysis
|
name: Perform CodeQL Analysis
|
||||||
uses: github/codeql-action/analyze@0d579ffd059c29b07949a3cce3983f0780820c98 #v4.32.6
|
uses: github/codeql-action/analyze@9e907b5e64f6b83e7804b09294d44122997950d6 #v4.32.3
|
||||||
|
|||||||
2
.github/workflows/stale.yml
vendored
2
.github/workflows/stale.yml
vendored
@@ -17,7 +17,7 @@ jobs:
|
|||||||
issues: write
|
issues: write
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@b5d41d4e1d5dceea10e7104786b73624c18a190f #v10.2.0
|
- uses: actions/stale@997185467fa4f803885201cee163a9f38240193d #v10.1.1
|
||||||
with:
|
with:
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
days-before-stale: 30
|
days-before-stale: 30
|
||||||
|
|||||||
2
.github/workflows/stale_pr.yml
vendored
2
.github/workflows/stale_pr.yml
vendored
@@ -17,7 +17,7 @@ jobs:
|
|||||||
pull-requests: write
|
pull-requests: write
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@b5d41d4e1d5dceea10e7104786b73624c18a190f #v10.2.0
|
- uses: actions/stale@997185467fa4f803885201cee163a9f38240193d #v10.1.1
|
||||||
with:
|
with:
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
# Do not automatically mark PR/issue as stale
|
# Do not automatically mark PR/issue as stale
|
||||||
|
|||||||
32
.github/workflows/test.yml
vendored
32
.github/workflows/test.yml
vendored
@@ -7,6 +7,11 @@ on:
|
|||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
|
|
||||||
|
env:
|
||||||
|
FORCE_COLOR: 1
|
||||||
|
PYTHONUNBUFFERED: 1
|
||||||
|
PYTHONUTF8: 1
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
smoke-tests:
|
smoke-tests:
|
||||||
if: github.event.pull_request.draft == false
|
if: github.event.pull_request.draft == false
|
||||||
@@ -20,18 +25,18 @@ jobs:
|
|||||||
- name: Check scripts in repository are executable
|
- name: Check scripts in repository are executable
|
||||||
run: |
|
run: |
|
||||||
IFS=$'\n';
|
IFS=$'\n';
|
||||||
for f in $(find . -name '*.sh' -o -name '*.bats'); do if [[ ! -x $f ]]; then echo "$f is not executable" && FAIL=1; fi ;done
|
for f in $(find . -name '*.sh'); do if [[ ! -x $f ]]; then echo "$f is not executable" && FAIL=1; fi ;done
|
||||||
unset IFS;
|
unset IFS;
|
||||||
# If FAIL is 1 then we fail.
|
# If FAIL is 1 then we fail.
|
||||||
[[ $FAIL == 1 ]] && exit 1 || echo "Scripts are executable!"
|
[[ $FAIL == 1 ]] && exit 1 || echo "Scripts are executable!"
|
||||||
|
|
||||||
- name: Differential ShellCheck
|
- name: Differential ShellCheck
|
||||||
if: github.event_name == 'pull_request'
|
|
||||||
uses: redhat-plumbers-in-action/differential-shellcheck@d965e66ec0b3b2f821f75c8eff9b12442d9a7d1e #v5.5.6
|
uses: redhat-plumbers-in-action/differential-shellcheck@d965e66ec0b3b2f821f75c8eff9b12442d9a7d1e #v5.5.6
|
||||||
with:
|
with:
|
||||||
severity: warning
|
severity: warning
|
||||||
display-engine: sarif-fmt
|
display-engine: sarif-fmt
|
||||||
|
|
||||||
|
|
||||||
- name: Spell-Checking
|
- name: Spell-Checking
|
||||||
uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579 #v2.2
|
uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579 #v2.2
|
||||||
with:
|
with:
|
||||||
@@ -43,6 +48,12 @@ jobs:
|
|||||||
- name: Run editorconfig-checker
|
- name: Run editorconfig-checker
|
||||||
run: editorconfig-checker
|
run: editorconfig-checker
|
||||||
|
|
||||||
|
- name: Check python code formatting with black
|
||||||
|
uses: psf/black@6305bf1ae645ab7541be4f5028a86239316178eb #26.1.0
|
||||||
|
with:
|
||||||
|
src: "./test"
|
||||||
|
options: "--check --diff --color"
|
||||||
|
|
||||||
distro-test:
|
distro-test:
|
||||||
if: github.event.pull_request.draft == false
|
if: github.event.pull_request.draft == false
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -68,9 +79,22 @@ jobs:
|
|||||||
alpine_3_22,
|
alpine_3_22,
|
||||||
alpine_3_23,
|
alpine_3_23,
|
||||||
]
|
]
|
||||||
|
env:
|
||||||
|
DISTRO: ${{matrix.distro}}
|
||||||
steps:
|
steps:
|
||||||
- name: Checkout repository
|
- name: Checkout repository
|
||||||
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd #v6.0.2
|
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd #v6.0.2
|
||||||
|
|
||||||
- name: Run BATS test suite for ${{ matrix.distro }}
|
- name: Set up Python
|
||||||
run: DISTRO=${{ matrix.distro }} bash test/run.sh
|
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 #v6.2.0
|
||||||
|
with:
|
||||||
|
python-version: "3.13"
|
||||||
|
|
||||||
|
- name: Install wheel
|
||||||
|
run: pip install wheel
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: pip install -r test/requirements.txt
|
||||||
|
|
||||||
|
- name: Test with tox
|
||||||
|
run: tox -c test/tox.${DISTRO}.ini
|
||||||
|
|||||||
10
.gitignore
vendored
10
.gitignore
vendored
@@ -1,7 +1,15 @@
|
|||||||
.DS_Store
|
.DS_Store
|
||||||
|
*.pyc
|
||||||
*.swp
|
*.swp
|
||||||
|
__pycache__
|
||||||
|
.cache
|
||||||
|
.pytest_cache
|
||||||
|
.tox
|
||||||
|
.eggs
|
||||||
|
*.egg-info
|
||||||
.idea/
|
.idea/
|
||||||
*.iml
|
*.iml
|
||||||
.vscode/
|
.vscode/
|
||||||
|
.venv/
|
||||||
.fleet/
|
.fleet/
|
||||||
test/libs/
|
.cache/
|
||||||
|
|||||||
@@ -41,6 +41,22 @@ warning1() {
|
|||||||
}
|
}
|
||||||
|
|
||||||
checkout() {
|
checkout() {
|
||||||
|
|
||||||
|
local skipFTL additionalFlag
|
||||||
|
skipFTL=false
|
||||||
|
# Check arguments
|
||||||
|
for var in "$@"; do
|
||||||
|
case "$var" in
|
||||||
|
"--skipFTL") skipFTL=true ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ "${skipFTL}" == true ]; then
|
||||||
|
additionalFlag="--skipFTL"
|
||||||
|
else
|
||||||
|
additionalFlag=""
|
||||||
|
fi
|
||||||
|
|
||||||
local corebranches
|
local corebranches
|
||||||
local webbranches
|
local webbranches
|
||||||
|
|
||||||
@@ -235,7 +251,7 @@ checkout() {
|
|||||||
# Force updating everything
|
# Force updating everything
|
||||||
if [[ ! "${1}" == "web" && ! "${1}" == "ftl" ]]; then
|
if [[ ! "${1}" == "web" && ! "${1}" == "ftl" ]]; then
|
||||||
echo -e " ${INFO} Running installer to upgrade your installation"
|
echo -e " ${INFO} Running installer to upgrade your installation"
|
||||||
if "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh" --unattended; then
|
if "${PI_HOLE_FILES_DIR}/automated install/basic-install.sh" --unattended ${additionalFlag}; then
|
||||||
exit 0
|
exit 0
|
||||||
else
|
else
|
||||||
echo -e " ${COL_RED} Error: Unable to complete update, please contact support${COL_NC}"
|
echo -e " ${COL_RED} Error: Unable to complete update, please contact support${COL_NC}"
|
||||||
|
|||||||
@@ -169,7 +169,7 @@ initialize_debug() {
|
|||||||
# Display that the debug process is beginning
|
# Display that the debug process is beginning
|
||||||
log_write "${COL_PURPLE}*** [ INITIALIZING ]${COL_NC}"
|
log_write "${COL_PURPLE}*** [ INITIALIZING ]${COL_NC}"
|
||||||
# Timestamp the start of the log
|
# Timestamp the start of the log
|
||||||
log_write "${INFO} $(date "+%Y-%m-%d %H:%M:%S") debug log has been initialized."
|
log_write "${INFO} $(date "+%Y-%m-%d:%H:%M:%S") debug log has been initialized."
|
||||||
# Uptime of the system
|
# Uptime of the system
|
||||||
# credits to https://stackoverflow.com/questions/28353409/bash-format-uptime-to-show-days-hours-minutes
|
# credits to https://stackoverflow.com/questions/28353409/bash-format-uptime-to-show-days-hours-minutes
|
||||||
system_uptime=$(uptime | awk -F'( |,|:)+' '{if ($7=="min") m=$6; else {if ($7~/^day/){if ($9=="min") {d=$6;m=$8} else {d=$6;h=$8;m=$9}} else {h=$6;m=$7}}} {print d+0,"days,",h+0,"hours,",m+0,"minutes"}')
|
system_uptime=$(uptime | awk -F'( |,|:)+' '{if ($7=="min") m=$6; else {if ($7~/^day/){if ($9=="min") {d=$6;m=$8} else {d=$6;h=$8;m=$9}} else {h=$6;m=$7}}} {print d+0,"days,",h+0,"hours,",m+0,"minutes"}')
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ if [[ -f ${coltable} ]]; then
|
|||||||
source ${coltable}
|
source ${coltable}
|
||||||
fi
|
fi
|
||||||
|
|
||||||
PI_HOLE_SCRIPT_DIR="/opt/pihole"
|
readonly PI_HOLE_SCRIPT_DIR="/opt/pihole"
|
||||||
utilsfile="${PI_HOLE_SCRIPT_DIR}/utils.sh"
|
utilsfile="${PI_HOLE_SCRIPT_DIR}/utils.sh"
|
||||||
# shellcheck source=./advanced/Scripts/utils.sh
|
# shellcheck source=./advanced/Scripts/utils.sh
|
||||||
source "${utilsfile}"
|
source "${utilsfile}"
|
||||||
|
|||||||
@@ -149,31 +149,37 @@ main() {
|
|||||||
echo -e " ${INFO} Web Interface:\\t${COL_GREEN}up to date${COL_NC}"
|
echo -e " ${INFO} Web Interface:\\t${COL_GREEN}up to date${COL_NC}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
local funcOutput
|
# Allow the user to skip this check if they are using a self-compiled FTL binary from an unsupported architecture
|
||||||
funcOutput=$(get_binary_name) #Store output of get_binary_name here
|
if [ "${skipFTL}" != true ]; then
|
||||||
local binary
|
local funcOutput
|
||||||
binary="pihole-FTL${funcOutput##*pihole-FTL}" #binary name will be the last line of the output of get_binary_name (it always begins with pihole-FTL)
|
funcOutput=$(get_binary_name) #Store output of get_binary_name here
|
||||||
|
local binary
|
||||||
|
binary="pihole-FTL${funcOutput##*pihole-FTL}" #binary name will be the last line of the output of get_binary_name (it always begins with pihole-FTL)
|
||||||
|
|
||||||
if FTLcheckUpdate "${binary}" &>/dev/null; then
|
if FTLcheckUpdate "${binary}" &>/dev/null; then
|
||||||
FTL_update=true
|
FTL_update=true
|
||||||
echo -e " ${INFO} FTL:\\t\\t${COL_YELLOW}update available${COL_NC}"
|
echo -e " ${INFO} FTL:\\t\\t${COL_YELLOW}update available${COL_NC}"
|
||||||
|
else
|
||||||
|
case $? in
|
||||||
|
1)
|
||||||
|
echo -e " ${INFO} FTL:\\t\\t${COL_GREEN}up to date${COL_NC}"
|
||||||
|
;;
|
||||||
|
2)
|
||||||
|
echo -e " ${INFO} FTL:\\t\\t${COL_RED}Branch is not available.${COL_NC}\\n\\t\\t\\tUse ${COL_GREEN}pihole checkout ftl [branchname]${COL_NC} to switch to a valid branch."
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
3)
|
||||||
|
echo -e " ${INFO} FTL:\\t\\t${COL_RED}Something has gone wrong, cannot reach download server${COL_NC}"
|
||||||
|
exit 1
|
||||||
|
;;
|
||||||
|
*)
|
||||||
|
echo -e " ${INFO} FTL:\\t\\t${COL_RED}Something has gone wrong, contact support${COL_NC}"
|
||||||
|
exit 1
|
||||||
|
esac
|
||||||
|
FTL_update=false
|
||||||
|
fi
|
||||||
else
|
else
|
||||||
case $? in
|
echo -e " ${INFO} FTL:\\t\\t${COL_YELLOW}--skipFTL set - update check skipped${COL_NC}"
|
||||||
1)
|
|
||||||
echo -e " ${INFO} FTL:\\t\\t${COL_GREEN}up to date${COL_NC}"
|
|
||||||
;;
|
|
||||||
2)
|
|
||||||
echo -e " ${INFO} FTL:\\t\\t${COL_RED}Branch is not available.${COL_NC}\\n\\t\\t\\tUse ${COL_GREEN}pihole checkout ftl [branchname]${COL_NC} to switch to a valid branch."
|
|
||||||
exit 1
|
|
||||||
;;
|
|
||||||
3)
|
|
||||||
echo -e " ${INFO} FTL:\\t\\t${COL_RED}Something has gone wrong, cannot reach download server${COL_NC}"
|
|
||||||
exit 1
|
|
||||||
;;
|
|
||||||
*)
|
|
||||||
echo -e " ${INFO} FTL:\\t\\t${COL_RED}Something has gone wrong, contact support${COL_NC}"
|
|
||||||
exit 1
|
|
||||||
esac
|
|
||||||
FTL_update=false
|
FTL_update=false
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@@ -222,7 +228,14 @@ main() {
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ "${FTL_update}" == true || "${core_update}" == true ]]; then
|
if [[ "${FTL_update}" == true || "${core_update}" == true ]]; then
|
||||||
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --repair --unattended || \
|
local addionalFlag
|
||||||
|
|
||||||
|
if [[ ${skipFTL} == true ]]; then
|
||||||
|
addionalFlag="--skipFTL"
|
||||||
|
else
|
||||||
|
addionalFlag=""
|
||||||
|
fi
|
||||||
|
${PI_HOLE_FILES_DIR}/automated\ install/basic-install.sh --repair --unattended ${addionalFlag} || \
|
||||||
echo -e "${basicError}" && exit 1
|
echo -e "${basicError}" && exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
@@ -242,8 +255,15 @@ main() {
|
|||||||
exit 0
|
exit 0
|
||||||
}
|
}
|
||||||
|
|
||||||
if [[ "$1" == "--check-only" ]]; then
|
CHECK_ONLY=false
|
||||||
CHECK_ONLY=true
|
skipFTL=false
|
||||||
fi
|
|
||||||
|
# Check arguments
|
||||||
|
for var in "$@"; do
|
||||||
|
case "$var" in
|
||||||
|
"--check-only") CHECK_ONLY=true ;;
|
||||||
|
"--skipFTL") skipFTL=true ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
main
|
main
|
||||||
|
|||||||
@@ -188,14 +188,27 @@ PIHOLE_META_DEPS_APK=(
|
|||||||
# The runUnattended flag is one example of this
|
# The runUnattended flag is one example of this
|
||||||
repair=false
|
repair=false
|
||||||
runUnattended=false
|
runUnattended=false
|
||||||
|
skipFTL=false
|
||||||
# Check arguments for the undocumented flags
|
# Check arguments for the undocumented flags
|
||||||
for var in "$@"; do
|
for var in "$@"; do
|
||||||
case "${var}" in
|
case "${var}" in
|
||||||
"--repair") repair=true ;;
|
"--repair") repair=true ;;
|
||||||
"--unattended") runUnattended=true ;;
|
"--unattended") runUnattended=true ;;
|
||||||
|
"--skipFTL") skipFTL=true ;;
|
||||||
esac
|
esac
|
||||||
done
|
done
|
||||||
|
|
||||||
|
if [[ "${runUnattended}" == true ]]; then
|
||||||
|
# In order to run an unattended setup, a pre-seeded /etc/pihole/pihole.toml must exist
|
||||||
|
if [[ ! -f "${PI_HOLE_CONFIG_DIR}/pihole.toml" ]]; then
|
||||||
|
printf " %b Error: \"%s\" not found. Cannot run unattended setup\\n" "${CROSS}" "${PI_HOLE_CONFIG_DIR}/pihole.toml"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
printf " %b Performing unattended setup, no dialogs will be displayed\\n" "${INFO}"
|
||||||
|
# also disable debconf-apt-progress dialogs
|
||||||
|
export DEBIAN_FRONTEND="noninteractive"
|
||||||
|
fi
|
||||||
|
|
||||||
# If the color table file exists,
|
# If the color table file exists,
|
||||||
if [[ -f "${coltable}" ]]; then
|
if [[ -f "${coltable}" ]]; then
|
||||||
# source it
|
# source it
|
||||||
@@ -2322,21 +2335,18 @@ main() {
|
|||||||
|
|
||||||
# Check if there is a usable FTL binary available on this architecture - do
|
# Check if there is a usable FTL binary available on this architecture - do
|
||||||
# this early on as FTL is a hard dependency for Pi-hole
|
# this early on as FTL is a hard dependency for Pi-hole
|
||||||
local funcOutput
|
# Allow the user to skip this check if they are using a self-compiled FTL binary from an unsupported architecture
|
||||||
funcOutput=$(get_binary_name) #Store output of get_binary_name here
|
if [ "${skipFTL}" != true ]; then
|
||||||
# Abort early if this processor is not supported (get_binary_name returns empty string)
|
# Get the binary name for the current architecture
|
||||||
if [[ "${funcOutput}" == "" ]]; then
|
local funcOutput
|
||||||
printf " %b Upgrade/install aborted\\n" "${CROSS}" "${DISTRO_NAME}"
|
funcOutput=$(get_binary_name) #Store output of get_binary_name here
|
||||||
exit 1
|
# Abort early if this processor is not supported (get_binary_name returns empty string)
|
||||||
fi
|
if [[ "${funcOutput}" == "" ]]; then
|
||||||
|
printf " %b Upgrade/install aborted\\n" "${CROSS}" "${DISTRO_NAME}"
|
||||||
if [[ "${fresh_install}" == false ]]; then
|
exit 1
|
||||||
# if it's running unattended,
|
|
||||||
if [[ "${runUnattended}" == true ]]; then
|
|
||||||
printf " %b Performing unattended setup, no dialogs will be displayed\\n" "${INFO}"
|
|
||||||
# also disable debconf-apt-progress dialogs
|
|
||||||
export DEBIAN_FRONTEND="noninteractive"
|
|
||||||
fi
|
fi
|
||||||
|
else
|
||||||
|
printf " %b %b--skipFTL set - skipping architecture check%b\\n" "${INFO}" "${COL_YELLOW}" "${COL_NC}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ "${fresh_install}" == true ]]; then
|
if [[ "${fresh_install}" == true ]]; then
|
||||||
@@ -2369,13 +2379,18 @@ main() {
|
|||||||
create_pihole_user
|
create_pihole_user
|
||||||
|
|
||||||
# Download and install FTL
|
# Download and install FTL
|
||||||
local binary
|
# Allow the user to skip this check if they are using a self-compiled FTL binary from an unsupported architecture
|
||||||
binary="pihole-FTL${funcOutput##*pihole-FTL}" #binary name will be the last line of the output of get_binary_name (it always begins with pihole-FTL)
|
if [ "${skipFTL}" != true ]; then
|
||||||
local theRest
|
local binary
|
||||||
theRest="${funcOutput%pihole-FTL*}" # Print the rest of get_binary_name's output to display (cut out from first instance of "pihole-FTL")
|
binary="pihole-FTL${funcOutput##*pihole-FTL}" #binary name will be the last line of the output of get_binary_name (it always begins with pihole-FTL)
|
||||||
if ! FTLdetect "${binary}" "${theRest}"; then
|
local theRest
|
||||||
printf " %b FTL Engine not installed\\n" "${CROSS}"
|
theRest="${funcOutput%pihole-FTL*}" # Print the rest of get_binary_name's output to display (cut out from first instance of "pihole-FTL")
|
||||||
exit 1
|
if ! FTLdetect "${binary}" "${theRest}"; then
|
||||||
|
printf " %b FTL Engine not installed\\n" "${CROSS}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
printf " %b %b--skipFTL set - skipping FTL binary installation%b\\n" "${INFO}" "${COL_YELLOW}" "${COL_NC}"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Install and log everything to a file
|
# Install and log everything to a file
|
||||||
|
|||||||
19
pihole
19
pihole
@@ -125,7 +125,22 @@ repairPiholeFunc() {
|
|||||||
if [ -n "${DOCKER_VERSION}" ]; then
|
if [ -n "${DOCKER_VERSION}" ]; then
|
||||||
unsupportedFunc
|
unsupportedFunc
|
||||||
else
|
else
|
||||||
/etc/.pihole/automated\ install/basic-install.sh --repair
|
local skipFTL additionalFlag
|
||||||
|
skipFTL=false
|
||||||
|
# Check arguments
|
||||||
|
for var in "$@"; do
|
||||||
|
case "$var" in
|
||||||
|
"--skipFTL") skipFTL=true ;;
|
||||||
|
esac
|
||||||
|
done
|
||||||
|
|
||||||
|
if [ "${skipFTL}" == true ]; then
|
||||||
|
additionalFlag="--skipFTL"
|
||||||
|
else
|
||||||
|
additionalFlag=""
|
||||||
|
fi
|
||||||
|
|
||||||
|
/etc/.pihole/automated\ install/basic-install.sh --repair ${additionalFlag}
|
||||||
exit 0;
|
exit 0;
|
||||||
fi
|
fi
|
||||||
}
|
}
|
||||||
@@ -601,7 +616,7 @@ case "${1}" in
|
|||||||
"-d" | "debug" ) debugFunc "$@";;
|
"-d" | "debug" ) debugFunc "$@";;
|
||||||
"-f" | "flush" ) flushFunc "$@";;
|
"-f" | "flush" ) flushFunc "$@";;
|
||||||
"-up" | "updatePihole" ) updatePiholeFunc "$@";;
|
"-up" | "updatePihole" ) updatePiholeFunc "$@";;
|
||||||
"-r" | "repair" ) repairPiholeFunc;;
|
"-r" | "repair" ) repairPiholeFunc "$@";;
|
||||||
"-g" | "updateGravity" ) updateGravityFunc "$@";;
|
"-g" | "updateGravity" ) updateGravityFunc "$@";;
|
||||||
"-l" | "logging" ) piholeLogging "$@";;
|
"-l" | "logging" ) piholeLogging "$@";;
|
||||||
"uninstall" ) uninstallFunc;;
|
"uninstall" ) uninstallFunc;;
|
||||||
|
|||||||
0
test/__init__.py
Normal file
0
test/__init__.py
Normal file
175
test/conftest.py
Normal file
175
test/conftest.py
Normal file
@@ -0,0 +1,175 @@
|
|||||||
|
import pytest
|
||||||
|
import testinfra
|
||||||
|
import testinfra.backend.docker
|
||||||
|
import subprocess
|
||||||
|
from textwrap import dedent
|
||||||
|
|
||||||
|
IMAGE = "pytest_pihole:test_container"
|
||||||
|
tick_box = "[✓]"
|
||||||
|
cross_box = "[✗]"
|
||||||
|
info_box = "[i]"
|
||||||
|
|
||||||
|
|
||||||
|
# Monkeypatch sh to bash, if they ever support non hard code /bin/sh this can go away
|
||||||
|
# https://github.com/pytest-dev/pytest-testinfra/blob/master/testinfra/backend/docker.py
|
||||||
|
def run_bash(self, command, *args, **kwargs):
|
||||||
|
cmd = self.get_command(command, *args)
|
||||||
|
if self.user is not None:
|
||||||
|
out = self.run_local(
|
||||||
|
"docker exec -u %s %s /bin/bash -c %s", self.user, self.name, cmd
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
out = self.run_local("docker exec %s /bin/bash -c %s", self.name, cmd)
|
||||||
|
out.command = self.encode(cmd)
|
||||||
|
return out
|
||||||
|
|
||||||
|
|
||||||
|
testinfra.backend.docker.DockerBackend.run = run_bash
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def host():
|
||||||
|
# run a container
|
||||||
|
docker_id = (
|
||||||
|
subprocess.check_output(["docker", "run", "-t", "-d", "--cap-add=ALL", IMAGE])
|
||||||
|
.decode()
|
||||||
|
.strip()
|
||||||
|
)
|
||||||
|
|
||||||
|
# return a testinfra connection to the container
|
||||||
|
docker_host = testinfra.get_host("docker://" + docker_id)
|
||||||
|
|
||||||
|
yield docker_host
|
||||||
|
# at the end of the test suite, destroy the container
|
||||||
|
subprocess.check_call(["docker", "rm", "-f", docker_id])
|
||||||
|
|
||||||
|
|
||||||
|
# Helper functions
|
||||||
|
def mock_command(script, args, container):
|
||||||
|
"""
|
||||||
|
Allows for setup of commands we don't really want to have to run for real
|
||||||
|
in unit tests
|
||||||
|
"""
|
||||||
|
full_script_path = "/usr/local/bin/{}".format(script)
|
||||||
|
mock_script = dedent(r"""\
|
||||||
|
#!/bin/bash -e
|
||||||
|
echo "\$0 \$@" >> /var/log/{script}
|
||||||
|
case "\$1" in""".format(script=script))
|
||||||
|
for k, v in args.items():
|
||||||
|
case = dedent("""
|
||||||
|
{arg})
|
||||||
|
echo {res}
|
||||||
|
exit {retcode}
|
||||||
|
;;""".format(arg=k, res=v[0], retcode=v[1]))
|
||||||
|
mock_script += case
|
||||||
|
mock_script += dedent("""
|
||||||
|
esac""")
|
||||||
|
container.run(
|
||||||
|
"""
|
||||||
|
cat <<EOF> {script}\n{content}\nEOF
|
||||||
|
chmod +x {script}
|
||||||
|
rm -f /var/log/{scriptlog}""".format(
|
||||||
|
script=full_script_path, content=mock_script, scriptlog=script
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def mock_command_passthrough(script, args, container):
|
||||||
|
"""
|
||||||
|
Per other mock_command* functions, allows intercepting of commands we don't want to run for real
|
||||||
|
in unit tests, however also allows only specific arguments to be mocked. Anything not defined will
|
||||||
|
be passed through to the actual command.
|
||||||
|
|
||||||
|
Example use-case: mocking `git pull` but still allowing `git clone` to work as intended
|
||||||
|
"""
|
||||||
|
orig_script_path = container.check_output("command -v {}".format(script))
|
||||||
|
full_script_path = "/usr/local/bin/{}".format(script)
|
||||||
|
mock_script = dedent(r"""\
|
||||||
|
#!/bin/bash -e
|
||||||
|
echo "\$0 \$@" >> /var/log/{script}
|
||||||
|
case "\$1" in""".format(script=script))
|
||||||
|
for k, v in args.items():
|
||||||
|
case = dedent("""
|
||||||
|
{arg})
|
||||||
|
echo {res}
|
||||||
|
exit {retcode}
|
||||||
|
;;""".format(arg=k, res=v[0], retcode=v[1]))
|
||||||
|
mock_script += case
|
||||||
|
mock_script += dedent(r"""
|
||||||
|
*)
|
||||||
|
{orig_script_path} "\$@"
|
||||||
|
;;""".format(orig_script_path=orig_script_path))
|
||||||
|
mock_script += dedent("""
|
||||||
|
esac""")
|
||||||
|
container.run(
|
||||||
|
"""
|
||||||
|
cat <<EOF> {script}\n{content}\nEOF
|
||||||
|
chmod +x {script}
|
||||||
|
rm -f /var/log/{scriptlog}""".format(
|
||||||
|
script=full_script_path, content=mock_script, scriptlog=script
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def mock_command_run(script, args, container):
|
||||||
|
"""
|
||||||
|
Allows for setup of commands we don't really want to have to run for real
|
||||||
|
in unit tests
|
||||||
|
"""
|
||||||
|
full_script_path = "/usr/local/bin/{}".format(script)
|
||||||
|
mock_script = dedent(r"""\
|
||||||
|
#!/bin/bash -e
|
||||||
|
echo "\$0 \$@" >> /var/log/{script}
|
||||||
|
case "\$1 \$2" in""".format(script=script))
|
||||||
|
for k, v in args.items():
|
||||||
|
case = dedent("""
|
||||||
|
\"{arg}\")
|
||||||
|
echo {res}
|
||||||
|
exit {retcode}
|
||||||
|
;;""".format(arg=k, res=v[0], retcode=v[1]))
|
||||||
|
mock_script += case
|
||||||
|
mock_script += dedent(r"""
|
||||||
|
esac""")
|
||||||
|
container.run(
|
||||||
|
"""
|
||||||
|
cat <<EOF> {script}\n{content}\nEOF
|
||||||
|
chmod +x {script}
|
||||||
|
rm -f /var/log/{scriptlog}""".format(
|
||||||
|
script=full_script_path, content=mock_script, scriptlog=script
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def mock_command_2(script, args, container):
|
||||||
|
"""
|
||||||
|
Allows for setup of commands we don't really want to have to run for real
|
||||||
|
in unit tests
|
||||||
|
"""
|
||||||
|
full_script_path = "/usr/local/bin/{}".format(script)
|
||||||
|
mock_script = dedent(r"""\
|
||||||
|
#!/bin/bash -e
|
||||||
|
echo "\$0 \$@" >> /var/log/{script}
|
||||||
|
case "\$1 \$2" in""".format(script=script))
|
||||||
|
for k, v in args.items():
|
||||||
|
case = dedent("""
|
||||||
|
\"{arg}\")
|
||||||
|
echo \"{res}\"
|
||||||
|
exit {retcode}
|
||||||
|
;;""".format(arg=k, res=v[0], retcode=v[1]))
|
||||||
|
mock_script += case
|
||||||
|
mock_script += dedent(r"""
|
||||||
|
esac""")
|
||||||
|
container.run(
|
||||||
|
"""
|
||||||
|
cat <<EOF> {script}\n{content}\nEOF
|
||||||
|
chmod +x {script}
|
||||||
|
rm -f /var/log/{scriptlog}""".format(
|
||||||
|
script=full_script_path, content=mock_script, scriptlog=script
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def run_script(Pihole, script):
|
||||||
|
result = Pihole.run(script)
|
||||||
|
assert result.rc == 0
|
||||||
|
return result
|
||||||
@@ -1,106 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
# Mock command helpers for BATS tests.
|
|
||||||
#
|
|
||||||
# These are the BATS equivalents of the mock_command* functions in conftest.py.
|
|
||||||
# Each function writes a bash case-statement script to /usr/local/bin/<name>
|
|
||||||
# inside the container, allowing tests to intercept command invocations.
|
|
||||||
#
|
|
||||||
# Usage:
|
|
||||||
# mock_command CONTAINER SCRIPT ARG1 OUTPUT1 RC1 [ARG2 OUTPUT2 RC2 ...]
|
|
||||||
# mock_command_2 CONTAINER SCRIPT ARG1 OUTPUT1 RC1 [ARG2 OUTPUT2 RC2 ...]
|
|
||||||
# mock_command_passthrough CONTAINER SCRIPT ARG1 OUTPUT1 RC1 [...]
|
|
||||||
#
|
|
||||||
# mock_command: matches on $1 (first argument); unquoted case pattern
|
|
||||||
# mock_command_2: matches on "$1 $2" (first two args joined); quoted pattern
|
|
||||||
# mock_command_passthrough: like mock_command but falls through to real binary
|
|
||||||
#
|
|
||||||
# Use '*' as ARG for a catch-all case (only works in mock_command and
|
|
||||||
# mock_command_passthrough; in mock_command_2 it matches the literal string '*').
|
|
||||||
#
|
|
||||||
# Content is transferred to the container via base64 to avoid quoting issues.
|
|
||||||
|
|
||||||
_write_mock_to_container() {
|
|
||||||
local container="$1" script_name="$2" script_content="$3"
|
|
||||||
# base64 alphabet is [A-Za-z0-9+/=] — safe to single-quote in the shell
|
|
||||||
local encoded
|
|
||||||
encoded=$(printf '%s' "$script_content" | base64 | tr -d '\n')
|
|
||||||
docker exec "$container" bash -c \
|
|
||||||
"printf '%s' '${encoded}' | base64 -d > /usr/local/bin/${script_name} && chmod +x /usr/local/bin/${script_name} && rm -f /var/log/${script_name}"
|
|
||||||
}
|
|
||||||
|
|
||||||
# mock_command — matches on $1
|
|
||||||
mock_command() {
|
|
||||||
local container="$1" script_name="$2"
|
|
||||||
shift 2
|
|
||||||
|
|
||||||
local script
|
|
||||||
script='#!/bin/bash -e'$'\n'
|
|
||||||
script+="echo \"\$0 \$@\" >> /var/log/${script_name}"$'\n'
|
|
||||||
script+='case "$1" in'$'\n'
|
|
||||||
|
|
||||||
while (( $# >= 3 )); do
|
|
||||||
local arg="$1" output="$2" rc="$3"
|
|
||||||
shift 3
|
|
||||||
script+=" ${arg})"$'\n'
|
|
||||||
script+=" echo ${output}"$'\n'
|
|
||||||
script+=" exit ${rc}"$'\n'
|
|
||||||
script+=" ;;"$'\n'
|
|
||||||
done
|
|
||||||
script+='esac'$'\n'
|
|
||||||
|
|
||||||
_write_mock_to_container "$container" "$script_name" "$script"
|
|
||||||
}
|
|
||||||
|
|
||||||
# mock_command_2 — matches on "$1 $2" (quoted pattern, quoted echo output)
|
|
||||||
mock_command_2() {
|
|
||||||
local container="$1" script_name="$2"
|
|
||||||
shift 2
|
|
||||||
|
|
||||||
local script
|
|
||||||
script='#!/bin/bash -e'$'\n'
|
|
||||||
script+="echo \"\$0 \$@\" >> /var/log/${script_name}"$'\n'
|
|
||||||
script+='case "$1 $2" in'$'\n'
|
|
||||||
|
|
||||||
while (( $# >= 3 )); do
|
|
||||||
local arg="$1" output="$2" rc="$3"
|
|
||||||
shift 3
|
|
||||||
script+=" \"${arg}\")"$'\n'
|
|
||||||
script+=" echo \"${output}\""$'\n'
|
|
||||||
script+=" exit ${rc}"$'\n'
|
|
||||||
script+=" ;;"$'\n'
|
|
||||||
done
|
|
||||||
script+='esac'$'\n'
|
|
||||||
|
|
||||||
_write_mock_to_container "$container" "$script_name" "$script"
|
|
||||||
}
|
|
||||||
|
|
||||||
# mock_command_passthrough — matches on $1; falls through to real binary for
|
|
||||||
# unmatched arguments
|
|
||||||
mock_command_passthrough() {
|
|
||||||
local container="$1" script_name="$2"
|
|
||||||
shift 2
|
|
||||||
|
|
||||||
# Find the real binary path before we shadow it
|
|
||||||
local orig_path
|
|
||||||
orig_path=$(docker exec "$container" bash -c "command -v ${script_name}")
|
|
||||||
|
|
||||||
local script
|
|
||||||
script='#!/bin/bash -e'$'\n'
|
|
||||||
script+="echo \"\$0 \$@\" >> /var/log/${script_name}"$'\n'
|
|
||||||
script+='case "$1" in'$'\n'
|
|
||||||
|
|
||||||
while (( $# >= 3 )); do
|
|
||||||
local arg="$1" output="$2" rc="$3"
|
|
||||||
shift 3
|
|
||||||
script+=" ${arg})"$'\n'
|
|
||||||
script+=" echo ${output}"$'\n'
|
|
||||||
script+=" exit ${rc}"$'\n'
|
|
||||||
script+=" ;;"$'\n'
|
|
||||||
done
|
|
||||||
script+=' *)'$'\n'
|
|
||||||
script+=" ${orig_path} \"\$@\""$'\n'
|
|
||||||
script+=' ;;'$'\n'
|
|
||||||
script+='esac'$'\n'
|
|
||||||
|
|
||||||
_write_mock_to_container "$container" "$script_name" "$script"
|
|
||||||
}
|
|
||||||
6
test/requirements.txt
Normal file
6
test/requirements.txt
Normal file
@@ -0,0 +1,6 @@
|
|||||||
|
pyyaml == 6.0.3
|
||||||
|
pytest == 9.0.2
|
||||||
|
pytest-xdist == 3.8.0
|
||||||
|
pytest-testinfra == 10.2.2
|
||||||
|
tox == 4.35.0
|
||||||
|
pytest-clarity == 1.0.1
|
||||||
91
test/run.sh
91
test/run.sh
@@ -1,91 +0,0 @@
|
|||||||
#!/usr/bin/env bash
|
|
||||||
set -euo pipefail
|
|
||||||
|
|
||||||
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
||||||
cd "$SCRIPT_DIR"
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Distro selection
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
if [[ -z "${DISTRO:-}" ]]; then
|
|
||||||
echo "Error: DISTRO is required."
|
|
||||||
echo "Example: DISTRO=debian_12 bash test/run.sh"
|
|
||||||
echo ""
|
|
||||||
echo "Available distros:"
|
|
||||||
ls _*.Dockerfile | sed 's/^_//;s/\.Dockerfile$//' | sort
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
DOCKERFILE="_${DISTRO}.Dockerfile"
|
|
||||||
if [[ ! -f "$DOCKERFILE" ]]; then
|
|
||||||
echo "Error: Dockerfile not found: $DOCKERFILE"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# Determine distro family to select which test files to run.
|
|
||||||
# rhel: CentOS/Fedora — includes SELinux tests
|
|
||||||
# alpine: Alpine Linux
|
|
||||||
# debian: Debian/Ubuntu (default)
|
|
||||||
distro_family() {
|
|
||||||
case "$1" in
|
|
||||||
centos_* | fedora_*) echo "rhel" ;;
|
|
||||||
alpine_*) echo "alpine" ;;
|
|
||||||
*) echo "debian" ;;
|
|
||||||
esac
|
|
||||||
}
|
|
||||||
DISTRO_FAMILY=$(distro_family "$DISTRO")
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Build the test image
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
IMAGE_TAG="pihole_test:${DISTRO}"
|
|
||||||
|
|
||||||
docker buildx build \
|
|
||||||
--load \
|
|
||||||
--progress plain \
|
|
||||||
-f "$DOCKERFILE" \
|
|
||||||
-t "$IMAGE_TAG" \
|
|
||||||
../
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Install BATS and helper libraries (on-demand, not committed)
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
mkdir -p libs
|
|
||||||
if [[ ! -d libs/bats ]]; then
|
|
||||||
echo "Cloning bats-core..."
|
|
||||||
git clone --depth=1 --quiet https://github.com/bats-core/bats-core libs/bats
|
|
||||||
fi
|
|
||||||
if [[ ! -d libs/bats-support ]]; then
|
|
||||||
echo "Cloning bats-support..."
|
|
||||||
git clone --depth=1 --quiet https://github.com/bats-core/bats-support libs/bats-support
|
|
||||||
fi
|
|
||||||
if [[ ! -d libs/bats-assert ]]; then
|
|
||||||
echo "Cloning bats-assert..."
|
|
||||||
git clone --depth=1 --quiet https://github.com/bats-core/bats-assert libs/bats-assert
|
|
||||||
fi
|
|
||||||
|
|
||||||
BATS="${BATS:-libs/bats/bin/bats}"
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Run tests
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
export IMAGE_TAG DISTRO DISTRO_FAMILY
|
|
||||||
|
|
||||||
TEST_FILES=(
|
|
||||||
test_automated_install.bats
|
|
||||||
test_ftl.bats
|
|
||||||
test_network.bats
|
|
||||||
test_utils.bats
|
|
||||||
)
|
|
||||||
[[ "$DISTRO_FAMILY" == "rhel" ]] && TEST_FILES+=(test_selinux.bats)
|
|
||||||
|
|
||||||
# Use pretty output only when stdout is a real terminal; fall back to TAP in CI.
|
|
||||||
# Parallelise across files with --jobs when GNU parallel is available.
|
|
||||||
BATS_FLAGS=()
|
|
||||||
[[ -t 1 ]] && BATS_FLAGS+=("-p")
|
|
||||||
command -v parallel > /dev/null 2>&1 && BATS_FLAGS+=("--jobs" "$(nproc)")
|
|
||||||
"$BATS" "${BATS_FLAGS[@]}" "${TEST_FILES[@]}"
|
|
||||||
7
test/setup.py
Normal file
7
test/setup.py
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
from setuptools import setup
|
||||||
|
|
||||||
|
setup(
|
||||||
|
py_modules=[],
|
||||||
|
setup_requires=["pytest-runner"],
|
||||||
|
tests_require=["pytest"],
|
||||||
|
)
|
||||||
472
test/test_any_automated_install.py
Normal file
472
test/test_any_automated_install.py
Normal file
@@ -0,0 +1,472 @@
|
|||||||
|
import pytest
|
||||||
|
from textwrap import dedent
|
||||||
|
import re
|
||||||
|
from .conftest import (
|
||||||
|
tick_box,
|
||||||
|
info_box,
|
||||||
|
cross_box,
|
||||||
|
mock_command,
|
||||||
|
mock_command_2,
|
||||||
|
mock_command_passthrough,
|
||||||
|
)
|
||||||
|
|
||||||
|
FTL_BRANCH = "development"
|
||||||
|
|
||||||
|
|
||||||
|
def test_supported_package_manager(host):
|
||||||
|
"""
|
||||||
|
confirm installer exits when no supported package manager found
|
||||||
|
"""
|
||||||
|
# break supported package managers
|
||||||
|
host.run("rm -rf /usr/bin/apt-get")
|
||||||
|
host.run("rm -rf /usr/bin/rpm")
|
||||||
|
host.run("rm -rf /sbin/apk")
|
||||||
|
package_manager_detect = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
package_manager_detect
|
||||||
|
""")
|
||||||
|
expected_stdout = cross_box + " No supported package manager found"
|
||||||
|
assert expected_stdout in package_manager_detect.stdout
|
||||||
|
# assert package_manager_detect.rc == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_selinux_not_detected(host):
|
||||||
|
"""
|
||||||
|
confirms installer continues when SELinux configuration file does not exist
|
||||||
|
"""
|
||||||
|
check_selinux = host.run("""
|
||||||
|
rm -f /etc/selinux/config
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
checkSelinux
|
||||||
|
""")
|
||||||
|
expected_stdout = info_box + " SELinux not detected"
|
||||||
|
assert expected_stdout in check_selinux.stdout
|
||||||
|
assert check_selinux.rc == 0
|
||||||
|
|
||||||
|
|
||||||
|
def get_directories_recursive(host, directory):
|
||||||
|
if directory is None:
|
||||||
|
return directory
|
||||||
|
# returns all non-hidden subdirs of 'directory'
|
||||||
|
dirs_raw = host.run("find {} -type d -not -path '*/.*'".format(directory))
|
||||||
|
dirs = list(filter(bool, dirs_raw.stdout.splitlines()))
|
||||||
|
return dirs
|
||||||
|
|
||||||
|
|
||||||
|
def test_installPihole_fresh_install_readableFiles(host):
|
||||||
|
"""
|
||||||
|
confirms all necessary files are readable by pihole user
|
||||||
|
"""
|
||||||
|
# dialog returns Cancel for user prompt
|
||||||
|
mock_command("dialog", {"*": ("", "0")}, host)
|
||||||
|
# mock git pull
|
||||||
|
mock_command_passthrough("git", {"pull": ("", "0")}, host)
|
||||||
|
# mock systemctl to not start FTL
|
||||||
|
mock_command_2(
|
||||||
|
"systemctl",
|
||||||
|
{
|
||||||
|
"enable pihole-FTL": ("", "0"),
|
||||||
|
"restart pihole-FTL": ("", "0"),
|
||||||
|
"start pihole-FTL": ("", "0"),
|
||||||
|
"*": ('echo "systemctl call with $@"', "0"),
|
||||||
|
},
|
||||||
|
host,
|
||||||
|
)
|
||||||
|
mock_command_2(
|
||||||
|
"rc-service",
|
||||||
|
{
|
||||||
|
"rc-service pihole-FTL enable": ("", "0"),
|
||||||
|
"rc-service pihole-FTL restart": ("", "0"),
|
||||||
|
"rc-service pihole-FTL start": ("", "0"),
|
||||||
|
"*": ('echo "rc-service call with $@"', "0"),
|
||||||
|
},
|
||||||
|
host,
|
||||||
|
)
|
||||||
|
# try to install man
|
||||||
|
host.run("command -v apt-get > /dev/null && apt-get install -qq man")
|
||||||
|
host.run("command -v dnf > /dev/null && dnf install -y man")
|
||||||
|
host.run("command -v yum > /dev/null && yum install -y man")
|
||||||
|
host.run("command -v apk > /dev/null && apk add mandoc man-pages")
|
||||||
|
# Workaround to get FTLv6 installed until it reaches master branch
|
||||||
|
host.run('echo "' + FTL_BRANCH + '" > /etc/pihole/ftlbranch')
|
||||||
|
install = host.run("""
|
||||||
|
export TERM=xterm
|
||||||
|
export DEBIAN_FRONTEND=noninteractive
|
||||||
|
umask 0027
|
||||||
|
runUnattended=true
|
||||||
|
source /opt/pihole/basic-install.sh > /dev/null
|
||||||
|
runUnattended=true
|
||||||
|
main
|
||||||
|
/opt/pihole/pihole-FTL-prestart.sh
|
||||||
|
""")
|
||||||
|
assert 0 == install.rc
|
||||||
|
maninstalled = True
|
||||||
|
if (info_box + " man not installed") in install.stdout:
|
||||||
|
maninstalled = False
|
||||||
|
if (info_box + " man pages not installed") in install.stdout:
|
||||||
|
maninstalled = False
|
||||||
|
piholeuser = "pihole"
|
||||||
|
exit_status_success = 0
|
||||||
|
test_cmd = 'su -s /bin/bash -c "test -{0} {1}" -p {2}'
|
||||||
|
# check files in /etc/pihole for read, write and execute permission
|
||||||
|
check_etc = test_cmd.format("r", "/etc/pihole", piholeuser)
|
||||||
|
actual_rc = host.run(check_etc).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
check_etc = test_cmd.format("x", "/etc/pihole", piholeuser)
|
||||||
|
actual_rc = host.run(check_etc).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
# readable and writable dhcp.leases
|
||||||
|
check_leases = test_cmd.format("r", "/etc/pihole/dhcp.leases", piholeuser)
|
||||||
|
actual_rc = host.run(check_leases).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
check_leases = test_cmd.format("w", "/etc/pihole/dhcp.leases", piholeuser)
|
||||||
|
actual_rc = host.run(check_leases).rc
|
||||||
|
# readable install.log
|
||||||
|
check_install = test_cmd.format("r", "/etc/pihole/install.log", piholeuser)
|
||||||
|
actual_rc = host.run(check_install).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
# readable versions
|
||||||
|
check_localversion = test_cmd.format("r", "/etc/pihole/versions", piholeuser)
|
||||||
|
actual_rc = host.run(check_localversion).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
# readable macvendor.db
|
||||||
|
check_macvendor = test_cmd.format("r", "/etc/pihole/macvendor.db", piholeuser)
|
||||||
|
actual_rc = host.run(check_macvendor).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
# check readable and executable /etc/init.d/pihole-FTL
|
||||||
|
check_init = test_cmd.format("x", "/etc/init.d/pihole-FTL", piholeuser)
|
||||||
|
actual_rc = host.run(check_init).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
check_init = test_cmd.format("r", "/etc/init.d/pihole-FTL", piholeuser)
|
||||||
|
actual_rc = host.run(check_init).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
# check readable and executable manpages
|
||||||
|
if maninstalled is True:
|
||||||
|
check_man = test_cmd.format("x", "/usr/local/share/man", piholeuser)
|
||||||
|
actual_rc = host.run(check_man).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
check_man = test_cmd.format("r", "/usr/local/share/man", piholeuser)
|
||||||
|
actual_rc = host.run(check_man).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
check_man = test_cmd.format("x", "/usr/local/share/man/man8", piholeuser)
|
||||||
|
actual_rc = host.run(check_man).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
check_man = test_cmd.format("r", "/usr/local/share/man/man8", piholeuser)
|
||||||
|
actual_rc = host.run(check_man).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
check_man = test_cmd.format(
|
||||||
|
"r", "/usr/local/share/man/man8/pihole.8", piholeuser
|
||||||
|
)
|
||||||
|
actual_rc = host.run(check_man).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
# check not readable cron file
|
||||||
|
check_sudo = test_cmd.format("x", "/etc/cron.d/", piholeuser)
|
||||||
|
actual_rc = host.run(check_sudo).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
check_sudo = test_cmd.format("r", "/etc/cron.d/", piholeuser)
|
||||||
|
actual_rc = host.run(check_sudo).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
check_sudo = test_cmd.format("r", "/etc/cron.d/pihole", piholeuser)
|
||||||
|
actual_rc = host.run(check_sudo).rc
|
||||||
|
assert exit_status_success == actual_rc
|
||||||
|
directories = get_directories_recursive(host, "/etc/.pihole/")
|
||||||
|
for directory in directories:
|
||||||
|
check_pihole = test_cmd.format("r", directory, piholeuser)
|
||||||
|
actual_rc = host.run(check_pihole).rc
|
||||||
|
check_pihole = test_cmd.format("x", directory, piholeuser)
|
||||||
|
actual_rc = host.run(check_pihole).rc
|
||||||
|
findfiles = 'find "{}" -maxdepth 1 -type f -exec echo {{}} \\;;'
|
||||||
|
filelist = host.run(findfiles.format(directory))
|
||||||
|
files = list(filter(bool, filelist.stdout.splitlines()))
|
||||||
|
for file in files:
|
||||||
|
check_pihole = test_cmd.format("r", file, piholeuser)
|
||||||
|
actual_rc = host.run(check_pihole).rc
|
||||||
|
|
||||||
|
|
||||||
|
def test_update_package_cache_success_no_errors(host):
|
||||||
|
"""
|
||||||
|
confirms package cache was updated without any errors
|
||||||
|
"""
|
||||||
|
updateCache = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
package_manager_detect
|
||||||
|
update_package_cache
|
||||||
|
""")
|
||||||
|
expected_stdout = tick_box + " Update local cache of available packages"
|
||||||
|
assert expected_stdout in updateCache.stdout
|
||||||
|
assert "error" not in updateCache.stdout.lower()
|
||||||
|
|
||||||
|
|
||||||
|
def test_update_package_cache_failure_no_errors(host):
|
||||||
|
"""
|
||||||
|
confirms package cache was not updated
|
||||||
|
"""
|
||||||
|
mock_command("apt-get", {"update": ("", "1")}, host)
|
||||||
|
updateCache = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
package_manager_detect
|
||||||
|
update_package_cache
|
||||||
|
""")
|
||||||
|
expected_stdout = cross_box + " Update local cache of available packages"
|
||||||
|
assert expected_stdout in updateCache.stdout
|
||||||
|
assert "Error: Unable to update package cache." in updateCache.stdout
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
"arch,detected_string,supported",
|
||||||
|
[
|
||||||
|
("aarch64", "AArch64 (64 Bit ARM)", True),
|
||||||
|
("armv6", "ARMv6", True),
|
||||||
|
("armv7l", "ARMv7 (or newer)", True),
|
||||||
|
("armv7", "ARMv7 (or newer)", True),
|
||||||
|
("armv8a", "ARMv7 (or newer)", True),
|
||||||
|
("x86_64", "x86_64", True),
|
||||||
|
("riscv64", "riscv64", True),
|
||||||
|
("mips", "mips", False),
|
||||||
|
],
|
||||||
|
)
|
||||||
|
def test_FTL_detect_no_errors(host, arch, detected_string, supported):
|
||||||
|
"""
|
||||||
|
confirms only correct package is downloaded for FTL engine
|
||||||
|
"""
|
||||||
|
# mock uname to return passed platform
|
||||||
|
mock_command("uname", {"-m": (arch, "0")}, host)
|
||||||
|
# mock readelf to respond with passed CPU architecture
|
||||||
|
mock_command_2(
|
||||||
|
"readelf",
|
||||||
|
{
|
||||||
|
"-A /bin/sh": ("Tag_CPU_arch: " + arch, "0"),
|
||||||
|
"-A /usr/bin/sh": ("Tag_CPU_arch: " + arch, "0"),
|
||||||
|
"-A /usr/sbin/sh": ("Tag_CPU_arch: " + arch, "0"),
|
||||||
|
},
|
||||||
|
host,
|
||||||
|
)
|
||||||
|
host.run('echo "' + FTL_BRANCH + '" > /etc/pihole/ftlbranch')
|
||||||
|
detectPlatform = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
create_pihole_user
|
||||||
|
funcOutput=$(get_binary_name)
|
||||||
|
binary="pihole-FTL${funcOutput##*pihole-FTL}"
|
||||||
|
theRest="${funcOutput%pihole-FTL*}"
|
||||||
|
FTLdetect "${binary}" "${theRest}"
|
||||||
|
""")
|
||||||
|
if supported:
|
||||||
|
expected_stdout = info_box + " FTL Checks..."
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
expected_stdout = tick_box + " Detected " + detected_string + " architecture"
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
expected_stdout = tick_box + " Downloading and Installing FTL"
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
else:
|
||||||
|
expected_stdout = (
|
||||||
|
"Not able to detect architecture (unknown: " + detected_string + ")"
|
||||||
|
)
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_FTL_development_binary_installed_and_responsive_no_errors(host):
|
||||||
|
"""
|
||||||
|
confirms FTL development binary is copied and functional in installed location
|
||||||
|
"""
|
||||||
|
host.run('echo "' + FTL_BRANCH + '" > /etc/pihole/ftlbranch')
|
||||||
|
host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
create_pihole_user
|
||||||
|
funcOutput=$(get_binary_name)
|
||||||
|
binary="pihole-FTL${funcOutput##*pihole-FTL}"
|
||||||
|
theRest="${funcOutput%pihole-FTL*}"
|
||||||
|
FTLdetect "${binary}" "${theRest}"
|
||||||
|
""")
|
||||||
|
version_check = host.run("""
|
||||||
|
VERSION=$(pihole-FTL version)
|
||||||
|
echo ${VERSION:0:1}
|
||||||
|
""")
|
||||||
|
expected_stdout = "v"
|
||||||
|
assert expected_stdout in version_check.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_IPv6_only_link_local(host):
|
||||||
|
"""
|
||||||
|
confirms IPv6 blocking is disabled for Link-local address
|
||||||
|
"""
|
||||||
|
# mock ip -6 address to return Link-local address
|
||||||
|
mock_command_2(
|
||||||
|
"ip",
|
||||||
|
{"-6 address": ("inet6 fe80::d210:52fa:fe00:7ad7/64 scope link", "0")},
|
||||||
|
host,
|
||||||
|
)
|
||||||
|
detectPlatform = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
find_IPv6_information
|
||||||
|
""")
|
||||||
|
expected_stdout = "Unable to find IPv6 ULA/GUA address"
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_IPv6_only_ULA(host):
|
||||||
|
"""
|
||||||
|
confirms IPv6 blocking is enabled for ULA addresses
|
||||||
|
"""
|
||||||
|
# mock ip -6 address to return ULA address
|
||||||
|
mock_command_2(
|
||||||
|
"ip",
|
||||||
|
{
|
||||||
|
"-6 address": (
|
||||||
|
"inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global",
|
||||||
|
"0",
|
||||||
|
)
|
||||||
|
},
|
||||||
|
host,
|
||||||
|
)
|
||||||
|
detectPlatform = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
find_IPv6_information
|
||||||
|
""")
|
||||||
|
expected_stdout = "Found IPv6 ULA address"
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_IPv6_only_GUA(host):
|
||||||
|
"""
|
||||||
|
confirms IPv6 blocking is enabled for GUA addresses
|
||||||
|
"""
|
||||||
|
# mock ip -6 address to return GUA address
|
||||||
|
mock_command_2(
|
||||||
|
"ip",
|
||||||
|
{
|
||||||
|
"-6 address": (
|
||||||
|
"inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global",
|
||||||
|
"0",
|
||||||
|
)
|
||||||
|
},
|
||||||
|
host,
|
||||||
|
)
|
||||||
|
detectPlatform = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
find_IPv6_information
|
||||||
|
""")
|
||||||
|
expected_stdout = "Found IPv6 GUA address"
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_IPv6_GUA_ULA_test(host):
|
||||||
|
"""
|
||||||
|
confirms IPv6 blocking is enabled for GUA and ULA addresses
|
||||||
|
"""
|
||||||
|
# mock ip -6 address to return GUA and ULA addresses
|
||||||
|
mock_command_2(
|
||||||
|
"ip",
|
||||||
|
{
|
||||||
|
"-6 address": (
|
||||||
|
"inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global\n"
|
||||||
|
"inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global",
|
||||||
|
"0",
|
||||||
|
)
|
||||||
|
},
|
||||||
|
host,
|
||||||
|
)
|
||||||
|
detectPlatform = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
find_IPv6_information
|
||||||
|
""")
|
||||||
|
expected_stdout = "Found IPv6 ULA address"
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_IPv6_ULA_GUA_test(host):
|
||||||
|
"""
|
||||||
|
confirms IPv6 blocking is enabled for GUA and ULA addresses
|
||||||
|
"""
|
||||||
|
# mock ip -6 address to return ULA and GUA addresses
|
||||||
|
mock_command_2(
|
||||||
|
"ip",
|
||||||
|
{
|
||||||
|
"-6 address": (
|
||||||
|
"inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global\n"
|
||||||
|
"inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global",
|
||||||
|
"0",
|
||||||
|
)
|
||||||
|
},
|
||||||
|
host,
|
||||||
|
)
|
||||||
|
detectPlatform = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
find_IPv6_information
|
||||||
|
""")
|
||||||
|
expected_stdout = "Found IPv6 ULA address"
|
||||||
|
assert expected_stdout in detectPlatform.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_validate_ip(host):
|
||||||
|
"""
|
||||||
|
Tests valid_ip for various IP addresses
|
||||||
|
"""
|
||||||
|
|
||||||
|
def test_address(addr, success=True):
|
||||||
|
output = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
valid_ip "{addr}"
|
||||||
|
""".format(addr=addr))
|
||||||
|
|
||||||
|
assert output.rc == 0 if success else 1
|
||||||
|
|
||||||
|
test_address("192.168.1.1")
|
||||||
|
test_address("127.0.0.1")
|
||||||
|
test_address("255.255.255.255")
|
||||||
|
test_address("255.255.255.256", False)
|
||||||
|
test_address("255.255.256.255", False)
|
||||||
|
test_address("255.256.255.255", False)
|
||||||
|
test_address("256.255.255.255", False)
|
||||||
|
test_address("1092.168.1.1", False)
|
||||||
|
test_address("not an IP", False)
|
||||||
|
test_address("8.8.8.8#", False)
|
||||||
|
test_address("8.8.8.8#0")
|
||||||
|
test_address("8.8.8.8#1")
|
||||||
|
test_address("8.8.8.8#42")
|
||||||
|
test_address("8.8.8.8#888")
|
||||||
|
test_address("8.8.8.8#1337")
|
||||||
|
test_address("8.8.8.8#65535")
|
||||||
|
test_address("8.8.8.8#65536", False)
|
||||||
|
test_address("8.8.8.8#-1", False)
|
||||||
|
test_address("00.0.0.0", False)
|
||||||
|
test_address("010.0.0.0", False)
|
||||||
|
test_address("001.0.0.0", False)
|
||||||
|
test_address("0.0.0.0#00", False)
|
||||||
|
test_address("0.0.0.0#01", False)
|
||||||
|
test_address("0.0.0.0#001", False)
|
||||||
|
test_address("0.0.0.0#0001", False)
|
||||||
|
test_address("0.0.0.0#00001", False)
|
||||||
|
|
||||||
|
|
||||||
|
def test_package_manager_has_pihole_deps(host):
|
||||||
|
"""Confirms OS is able to install the required packages for Pi-hole"""
|
||||||
|
mock_command("dialog", {"*": ("", "0")}, host)
|
||||||
|
output = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
package_manager_detect
|
||||||
|
update_package_cache
|
||||||
|
build_dependency_package
|
||||||
|
install_dependent_packages
|
||||||
|
""")
|
||||||
|
|
||||||
|
assert "No package" not in output.stdout
|
||||||
|
assert output.rc == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_meta_package_uninstall(host):
|
||||||
|
"""Confirms OS is able to install and uninstall the Pi-hole meta package"""
|
||||||
|
mock_command("dialog", {"*": ("", "0")}, host)
|
||||||
|
install = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
package_manager_detect
|
||||||
|
update_package_cache
|
||||||
|
build_dependency_package
|
||||||
|
install_dependent_packages
|
||||||
|
""")
|
||||||
|
assert install.rc == 0
|
||||||
|
|
||||||
|
uninstall = host.run("""
|
||||||
|
source /opt/pihole/uninstall.sh
|
||||||
|
removeMetaPackage
|
||||||
|
""")
|
||||||
|
assert uninstall.rc == 0
|
||||||
49
test/test_any_utils.py
Normal file
49
test/test_any_utils.py
Normal file
@@ -0,0 +1,49 @@
|
|||||||
|
def test_key_val_replacement_works(host):
|
||||||
|
"""Confirms addOrEditKeyValPair either adds or replaces a key value pair in a given file"""
|
||||||
|
host.run("""
|
||||||
|
source /opt/pihole/utils.sh
|
||||||
|
addOrEditKeyValPair "./testoutput" "KEY_ONE" "value1"
|
||||||
|
addOrEditKeyValPair "./testoutput" "KEY_TWO" "value2"
|
||||||
|
addOrEditKeyValPair "./testoutput" "KEY_ONE" "value3"
|
||||||
|
addOrEditKeyValPair "./testoutput" "KEY_FOUR" "value4"
|
||||||
|
""")
|
||||||
|
output = host.run("""
|
||||||
|
cat ./testoutput
|
||||||
|
""")
|
||||||
|
expected_stdout = "KEY_ONE=value3\nKEY_TWO=value2\nKEY_FOUR=value4\n"
|
||||||
|
assert expected_stdout == output.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_getFTLPID_default(host):
|
||||||
|
"""Confirms getFTLPID returns the default value if FTL is not running"""
|
||||||
|
output = host.run("""
|
||||||
|
source /opt/pihole/utils.sh
|
||||||
|
getFTLPID
|
||||||
|
""")
|
||||||
|
expected_stdout = "-1\n"
|
||||||
|
assert expected_stdout == output.stdout
|
||||||
|
|
||||||
|
|
||||||
|
def test_setFTLConfigValue_getFTLConfigValue(host):
|
||||||
|
"""
|
||||||
|
Confirms getFTLConfigValue works (also assumes setFTLConfigValue works)
|
||||||
|
Requires FTL to be installed, so we do that first
|
||||||
|
(taken from test_FTL_development_binary_installed_and_responsive_no_errors)
|
||||||
|
"""
|
||||||
|
host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
create_pihole_user
|
||||||
|
funcOutput=$(get_binary_name)
|
||||||
|
echo "development" > /etc/pihole/ftlbranch
|
||||||
|
binary="pihole-FTL${funcOutput##*pihole-FTL}"
|
||||||
|
theRest="${funcOutput%pihole-FTL*}"
|
||||||
|
FTLdetect "${binary}" "${theRest}"
|
||||||
|
""")
|
||||||
|
|
||||||
|
output = host.run("""
|
||||||
|
source /opt/pihole/utils.sh
|
||||||
|
setFTLConfigValue "dns.upstreams" '["9.9.9.9"]' > /dev/null
|
||||||
|
getFTLConfigValue "dns.upstreams"
|
||||||
|
""")
|
||||||
|
|
||||||
|
assert "[ 9.9.9.9 ]" in output.stdout
|
||||||
@@ -1,188 +0,0 @@
|
|||||||
#!/usr/bin/env bats
|
|
||||||
# Core installer tests — package manager, cache, fresh install, dependencies
|
|
||||||
|
|
||||||
load 'libs/bats-support/load'
|
|
||||||
load 'libs/bats-assert/load'
|
|
||||||
load 'helpers/mocks'
|
|
||||||
|
|
||||||
TICK="[✓]"
|
|
||||||
CROSS="[✗]"
|
|
||||||
INFO="[i]"
|
|
||||||
|
|
||||||
FTL_BRANCH="development"
|
|
||||||
|
|
||||||
CID=""
|
|
||||||
|
|
||||||
setup() {
|
|
||||||
CID=$(docker run -d -t --cap-add=ALL "$IMAGE_TAG")
|
|
||||||
}
|
|
||||||
|
|
||||||
teardown() {
|
|
||||||
if [[ -n "$CID" ]]; then
|
|
||||||
docker rm -f "$CID" > /dev/null 2>&1 || true
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
@test "installer exits when no supported package manager found" {
|
|
||||||
docker exec "$CID" bash -c "rm -rf /usr/bin/apt-get /usr/bin/rpm /sbin/apk"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
package_manager_detect
|
|
||||||
"
|
|
||||||
assert_output --partial "${CROSS} No supported package manager found"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "installer continues when SELinux config file does not exist" {
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
rm -f /etc/selinux/config
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
checkSelinux
|
|
||||||
"
|
|
||||||
assert_output --partial "${INFO} SELinux not detected"
|
|
||||||
assert_success
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "fresh install: all necessary files are readable by pihole user" {
|
|
||||||
mock_command "$CID" dialog "*" "" "0"
|
|
||||||
mock_command_passthrough "$CID" git "pull" "" "0"
|
|
||||||
mock_command_2 "$CID" systemctl \
|
|
||||||
"enable pihole-FTL" "" "0" \
|
|
||||||
"restart pihole-FTL" "" "0" \
|
|
||||||
"start pihole-FTL" "" "0"
|
|
||||||
mock_command_2 "$CID" rc-service \
|
|
||||||
"pihole-FTL enable" "" "0" \
|
|
||||||
"pihole-FTL restart" "" "0" \
|
|
||||||
"pihole-FTL start" "" "0"
|
|
||||||
|
|
||||||
# Install man pages if available (best-effort)
|
|
||||||
docker exec "$CID" bash -c "command -v apt-get > /dev/null && apt-get install -qq man" || true
|
|
||||||
docker exec "$CID" bash -c "command -v dnf > /dev/null && dnf install -y man" || true
|
|
||||||
docker exec "$CID" bash -c "command -v yum > /dev/null && yum install -y man" || true
|
|
||||||
docker exec "$CID" bash -c "command -v apk > /dev/null && apk add mandoc man-pages" || true
|
|
||||||
|
|
||||||
docker exec "$CID" bash -c "echo '${FTL_BRANCH}' > /etc/pihole/ftlbranch"
|
|
||||||
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
export TERM=xterm
|
|
||||||
export DEBIAN_FRONTEND=noninteractive
|
|
||||||
umask 0027
|
|
||||||
runUnattended=true
|
|
||||||
source /opt/pihole/basic-install.sh > /dev/null
|
|
||||||
runUnattended=true
|
|
||||||
main
|
|
||||||
/opt/pihole/pihole-FTL-prestart.sh
|
|
||||||
"
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
# Detect whether man was installed
|
|
||||||
local maninstalled=true
|
|
||||||
if [[ "$output" == *"${INFO} man not installed"* ]] || [[ "$output" == *"${INFO} man pages not installed"* ]]; then
|
|
||||||
maninstalled=false
|
|
||||||
fi
|
|
||||||
|
|
||||||
local piholeuser="pihole"
|
|
||||||
_check_perm() { docker exec "$CID" bash -c "su -s /bin/bash -c 'test -${1} ${2}' -p ${piholeuser}"; }
|
|
||||||
|
|
||||||
# /etc/pihole
|
|
||||||
run _check_perm r /etc/pihole; assert_success
|
|
||||||
run _check_perm x /etc/pihole; assert_success
|
|
||||||
|
|
||||||
# /etc/pihole/dhcp.leases
|
|
||||||
run _check_perm r /etc/pihole/dhcp.leases; assert_success
|
|
||||||
|
|
||||||
# /etc/pihole/install.log
|
|
||||||
run _check_perm r /etc/pihole/install.log; assert_success
|
|
||||||
|
|
||||||
# /etc/pihole/versions
|
|
||||||
run _check_perm r /etc/pihole/versions; assert_success
|
|
||||||
|
|
||||||
# /etc/pihole/macvendor.db
|
|
||||||
run _check_perm r /etc/pihole/macvendor.db; assert_success
|
|
||||||
|
|
||||||
# /etc/init.d/pihole-FTL
|
|
||||||
run _check_perm x /etc/init.d/pihole-FTL; assert_success
|
|
||||||
run _check_perm r /etc/init.d/pihole-FTL; assert_success
|
|
||||||
|
|
||||||
# man pages (if installed)
|
|
||||||
if [[ "$maninstalled" == "true" ]]; then
|
|
||||||
run _check_perm x /usr/local/share/man; assert_success
|
|
||||||
run _check_perm r /usr/local/share/man; assert_success
|
|
||||||
run _check_perm x /usr/local/share/man/man8; assert_success
|
|
||||||
run _check_perm r /usr/local/share/man/man8; assert_success
|
|
||||||
run _check_perm r /usr/local/share/man/man8/pihole.8; assert_success
|
|
||||||
fi
|
|
||||||
|
|
||||||
# /etc/cron.d
|
|
||||||
run _check_perm x /etc/cron.d/; assert_success
|
|
||||||
run _check_perm r /etc/cron.d/; assert_success
|
|
||||||
run _check_perm r /etc/cron.d/pihole; assert_success
|
|
||||||
|
|
||||||
# All files and directories under /etc/.pihole/
|
|
||||||
local dirs
|
|
||||||
dirs=$(docker exec "$CID" bash -c "find /etc/.pihole/ -type d -not -path '*/.*'" 2>/dev/null || true)
|
|
||||||
while IFS= read -r dir; do
|
|
||||||
[[ -z "$dir" ]] && continue
|
|
||||||
run _check_perm r "$dir"; assert_success
|
|
||||||
run _check_perm x "$dir"; assert_success
|
|
||||||
local files
|
|
||||||
files=$(docker exec "$CID" bash -c "find '${dir}' -maxdepth 1 -type f -exec echo {} \\;" 2>/dev/null || true)
|
|
||||||
while IFS= read -r file; do
|
|
||||||
[[ -z "$file" ]] && continue
|
|
||||||
run _check_perm r "$file"; assert_success
|
|
||||||
done <<< "$files"
|
|
||||||
done <<< "$dirs"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "package cache update succeeds without errors" {
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
package_manager_detect
|
|
||||||
update_package_cache
|
|
||||||
"
|
|
||||||
assert_output --partial "${TICK} Update local cache of available packages"
|
|
||||||
refute_output --partial "error"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "package cache update reports failure correctly" {
|
|
||||||
mock_command "$CID" apt-get "update" "" "1"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
package_manager_detect
|
|
||||||
update_package_cache
|
|
||||||
"
|
|
||||||
assert_output --partial "${CROSS} Update local cache of available packages"
|
|
||||||
assert_output --partial "Error: Unable to update package cache."
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "OS can install required Pi-hole dependency packages" {
|
|
||||||
mock_command "$CID" dialog "*" "" "0"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
package_manager_detect
|
|
||||||
update_package_cache
|
|
||||||
build_dependency_package
|
|
||||||
install_dependent_packages
|
|
||||||
"
|
|
||||||
refute_output --partial "No package"
|
|
||||||
assert_success
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "OS can install and uninstall the Pi-hole meta package" {
|
|
||||||
mock_command "$CID" dialog "*" "" "0"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
package_manager_detect
|
|
||||||
update_package_cache
|
|
||||||
build_dependency_package
|
|
||||||
install_dependent_packages
|
|
||||||
"
|
|
||||||
assert_success
|
|
||||||
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/uninstall.sh
|
|
||||||
removeMetaPackage
|
|
||||||
"
|
|
||||||
assert_success
|
|
||||||
}
|
|
||||||
65
test/test_centos_fedora_common_support.py
Normal file
65
test/test_centos_fedora_common_support.py
Normal file
@@ -0,0 +1,65 @@
|
|||||||
|
from .conftest import (
|
||||||
|
tick_box,
|
||||||
|
cross_box,
|
||||||
|
mock_command,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def mock_selinux_config(state, host):
|
||||||
|
"""
|
||||||
|
Creates a mock SELinux config file with expected content
|
||||||
|
"""
|
||||||
|
# validate state string
|
||||||
|
valid_states = ["enforcing", "permissive", "disabled"]
|
||||||
|
assert state in valid_states
|
||||||
|
# getenforce returns the running state of SELinux
|
||||||
|
mock_command("getenforce", {"*": (state.capitalize(), "0")}, host)
|
||||||
|
# create mock configuration with desired content
|
||||||
|
host.run("""
|
||||||
|
mkdir /etc/selinux
|
||||||
|
echo "SELINUX={state}" > /etc/selinux/config
|
||||||
|
""".format(state=state.lower()))
|
||||||
|
|
||||||
|
|
||||||
|
def test_selinux_enforcing_exit(host):
|
||||||
|
"""
|
||||||
|
confirms installer prompts to exit when SELinux is Enforcing by default
|
||||||
|
"""
|
||||||
|
mock_selinux_config("enforcing", host)
|
||||||
|
check_selinux = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
checkSelinux
|
||||||
|
""")
|
||||||
|
expected_stdout = cross_box + " Current SELinux: enforcing"
|
||||||
|
assert expected_stdout in check_selinux.stdout
|
||||||
|
expected_stdout = "SELinux Enforcing detected, exiting installer"
|
||||||
|
assert expected_stdout in check_selinux.stdout
|
||||||
|
assert check_selinux.rc == 1
|
||||||
|
|
||||||
|
|
||||||
|
def test_selinux_permissive(host):
|
||||||
|
"""
|
||||||
|
confirms installer continues when SELinux is Permissive
|
||||||
|
"""
|
||||||
|
mock_selinux_config("permissive", host)
|
||||||
|
check_selinux = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
checkSelinux
|
||||||
|
""")
|
||||||
|
expected_stdout = tick_box + " Current SELinux: permissive"
|
||||||
|
assert expected_stdout in check_selinux.stdout
|
||||||
|
assert check_selinux.rc == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_selinux_disabled(host):
|
||||||
|
"""
|
||||||
|
confirms installer continues when SELinux is Disabled
|
||||||
|
"""
|
||||||
|
mock_selinux_config("disabled", host)
|
||||||
|
check_selinux = host.run("""
|
||||||
|
source /opt/pihole/basic-install.sh
|
||||||
|
checkSelinux
|
||||||
|
""")
|
||||||
|
expected_stdout = tick_box + " Current SELinux: disabled"
|
||||||
|
assert expected_stdout in check_selinux.stdout
|
||||||
|
assert check_selinux.rc == 0
|
||||||
@@ -1,104 +0,0 @@
|
|||||||
#!/usr/bin/env bats
|
|
||||||
# FTL architecture detection and binary installation tests
|
|
||||||
|
|
||||||
load 'libs/bats-support/load'
|
|
||||||
load 'libs/bats-assert/load'
|
|
||||||
load 'helpers/mocks'
|
|
||||||
|
|
||||||
TICK="[✓]"
|
|
||||||
INFO="[i]"
|
|
||||||
|
|
||||||
FTL_BRANCH="development"
|
|
||||||
|
|
||||||
CID=""
|
|
||||||
|
|
||||||
setup() {
|
|
||||||
CID=$(docker run -d -t --cap-add=ALL "$IMAGE_TAG")
|
|
||||||
}
|
|
||||||
|
|
||||||
teardown() {
|
|
||||||
if [[ -n "$CID" ]]; then
|
|
||||||
docker rm -f "$CID" > /dev/null 2>&1 || true
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# FTL architecture detection — one @test per arch (replaces parametrize)
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
_test_ftl_arch() {
|
|
||||||
local arch="$1" detected_string="$2" supported="$3"
|
|
||||||
|
|
||||||
mock_command "$CID" uname "-m" "$arch" "0"
|
|
||||||
mock_command_2 "$CID" readelf \
|
|
||||||
"-A /bin/sh" "Tag_CPU_arch: ${arch}" "0" \
|
|
||||||
"-A /usr/bin/sh" "Tag_CPU_arch: ${arch}" "0" \
|
|
||||||
"-A /usr/sbin/sh" "Tag_CPU_arch: ${arch}" "0"
|
|
||||||
docker exec "$CID" bash -c "echo '${FTL_BRANCH}' > /etc/pihole/ftlbranch"
|
|
||||||
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
create_pihole_user
|
|
||||||
funcOutput=\$(get_binary_name)
|
|
||||||
binary=\"pihole-FTL\${funcOutput##*pihole-FTL}\"
|
|
||||||
theRest=\"\${funcOutput%pihole-FTL*}\"
|
|
||||||
FTLdetect \"\${binary}\" \"\${theRest}\"
|
|
||||||
"
|
|
||||||
|
|
||||||
if [[ "$supported" == "true" ]]; then
|
|
||||||
assert_output --partial "${INFO} FTL Checks..."
|
|
||||||
assert_output --partial "${TICK} Detected ${detected_string} architecture"
|
|
||||||
assert_output --partial "${TICK} Downloading and Installing FTL"
|
|
||||||
else
|
|
||||||
assert_output --partial "Not able to detect architecture (unknown: ${detected_string})"
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "FTL detects aarch64 architecture" {
|
|
||||||
_test_ftl_arch "aarch64" "AArch64 (64 Bit ARM)" "true"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "FTL detects ARMv6 architecture" {
|
|
||||||
_test_ftl_arch "armv6" "ARMv6" "true"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "FTL detects ARMv7l architecture" {
|
|
||||||
_test_ftl_arch "armv7l" "ARMv7 (or newer)" "true"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "FTL detects ARMv7 architecture" {
|
|
||||||
_test_ftl_arch "armv7" "ARMv7 (or newer)" "true"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "FTL detects ARMv8a architecture" {
|
|
||||||
_test_ftl_arch "armv8a" "ARMv7 (or newer)" "true"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "FTL detects x86_64 architecture" {
|
|
||||||
_test_ftl_arch "x86_64" "x86_64" "true"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "FTL detects riscv64 architecture" {
|
|
||||||
_test_ftl_arch "riscv64" "riscv64" "true"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "FTL reports unsupported architecture" {
|
|
||||||
_test_ftl_arch "mips" "mips" "false"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "FTL development binary is installed and responsive" {
|
|
||||||
docker exec "$CID" bash -c "echo '${FTL_BRANCH}' > /etc/pihole/ftlbranch"
|
|
||||||
docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
create_pihole_user
|
|
||||||
funcOutput=\$(get_binary_name)
|
|
||||||
binary=\"pihole-FTL\${funcOutput##*pihole-FTL}\"
|
|
||||||
theRest=\"\${funcOutput%pihole-FTL*}\"
|
|
||||||
FTLdetect \"\${binary}\" \"\${theRest}\"
|
|
||||||
"
|
|
||||||
run docker exec "$CID" bash -c '
|
|
||||||
VERSION=$(pihole-FTL version)
|
|
||||||
echo "${VERSION:0:1}"
|
|
||||||
'
|
|
||||||
assert_output --partial "v"
|
|
||||||
}
|
|
||||||
@@ -1,116 +0,0 @@
|
|||||||
#!/usr/bin/env bats
|
|
||||||
# Network detection tests — IPv6 address detection and IP validation
|
|
||||||
|
|
||||||
load 'libs/bats-support/load'
|
|
||||||
load 'libs/bats-assert/load'
|
|
||||||
load 'helpers/mocks'
|
|
||||||
|
|
||||||
CID=""
|
|
||||||
|
|
||||||
setup() {
|
|
||||||
CID=$(docker run -d -t --cap-add=ALL "$IMAGE_TAG")
|
|
||||||
}
|
|
||||||
|
|
||||||
teardown() {
|
|
||||||
if [[ -n "$CID" ]]; then
|
|
||||||
docker rm -f "$CID" > /dev/null 2>&1 || true
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# IPv6 detection
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
@test "IPv6 link-local only: blocking disabled" {
|
|
||||||
mock_command_2 "$CID" ip \
|
|
||||||
"-6 address" "inet6 fe80::d210:52fa:fe00:7ad7/64 scope link" "0"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
find_IPv6_information
|
|
||||||
"
|
|
||||||
assert_output --partial "Unable to find IPv6 ULA/GUA address"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "IPv6 ULA only: blocking enabled" {
|
|
||||||
mock_command_2 "$CID" ip \
|
|
||||||
"-6 address" "inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global" "0"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
find_IPv6_information
|
|
||||||
"
|
|
||||||
assert_output --partial "Found IPv6 ULA address"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "IPv6 GUA only: blocking enabled" {
|
|
||||||
mock_command_2 "$CID" ip \
|
|
||||||
"-6 address" "inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global" "0"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
find_IPv6_information
|
|
||||||
"
|
|
||||||
assert_output --partial "Found IPv6 GUA address"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "IPv6 GUA + ULA: ULA takes precedence" {
|
|
||||||
mock_command_2 "$CID" ip \
|
|
||||||
"-6 address" "inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global
|
|
||||||
inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global" "0"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
find_IPv6_information
|
|
||||||
"
|
|
||||||
assert_output --partial "Found IPv6 ULA address"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "IPv6 ULA + GUA: ULA takes precedence" {
|
|
||||||
mock_command_2 "$CID" ip \
|
|
||||||
"-6 address" "inet6 fda2:2001:5555:0:d210:52fa:fe00:7ad7/64 scope global
|
|
||||||
inet6 2003:12:1e43:301:d210:52fa:fe00:7ad7/64 scope global" "0"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
find_IPv6_information
|
|
||||||
"
|
|
||||||
assert_output --partial "Found IPv6 ULA address"
|
|
||||||
}
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# IP address validation
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
@test "valid_ip accepts and rejects addresses correctly" {
|
|
||||||
_valid() {
|
|
||||||
run docker exec "$CID" bash -c "source /opt/pihole/basic-install.sh; valid_ip '${1}'"
|
|
||||||
assert_success
|
|
||||||
}
|
|
||||||
_invalid() {
|
|
||||||
run docker exec "$CID" bash -c "source /opt/pihole/basic-install.sh; valid_ip '${1}'"
|
|
||||||
assert_failure
|
|
||||||
}
|
|
||||||
|
|
||||||
_valid "192.168.1.1"
|
|
||||||
_valid "127.0.0.1"
|
|
||||||
_valid "255.255.255.255"
|
|
||||||
_invalid "255.255.255.256"
|
|
||||||
_invalid "255.255.256.255"
|
|
||||||
_invalid "255.256.255.255"
|
|
||||||
_invalid "256.255.255.255"
|
|
||||||
_invalid "1092.168.1.1"
|
|
||||||
_invalid "not an IP"
|
|
||||||
_invalid "8.8.8.8#"
|
|
||||||
_valid "8.8.8.8#0"
|
|
||||||
_valid "8.8.8.8#1"
|
|
||||||
_valid "8.8.8.8#42"
|
|
||||||
_valid "8.8.8.8#888"
|
|
||||||
_valid "8.8.8.8#1337"
|
|
||||||
_valid "8.8.8.8#65535"
|
|
||||||
_invalid "8.8.8.8#65536"
|
|
||||||
_invalid "8.8.8.8#-1"
|
|
||||||
_invalid "00.0.0.0"
|
|
||||||
_invalid "010.0.0.0"
|
|
||||||
_invalid "001.0.0.0"
|
|
||||||
_invalid "0.0.0.0#00"
|
|
||||||
_invalid "0.0.0.0#01"
|
|
||||||
_invalid "0.0.0.0#001"
|
|
||||||
_invalid "0.0.0.0#0001"
|
|
||||||
_invalid "0.0.0.0#00001"
|
|
||||||
}
|
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
#!/usr/bin/env bats
|
|
||||||
# Tests for SELinux handling in basic-install.sh.
|
|
||||||
# Translated from test_centos_fedora_common_support.py.
|
|
||||||
# Only runs on rhel family (CentOS/Fedora) — selected by run.sh.
|
|
||||||
|
|
||||||
load 'libs/bats-support/load'
|
|
||||||
load 'libs/bats-assert/load'
|
|
||||||
load 'helpers/mocks'
|
|
||||||
|
|
||||||
TICK="[✓]"
|
|
||||||
CROSS="[✗]"
|
|
||||||
|
|
||||||
CID=""
|
|
||||||
|
|
||||||
setup() {
|
|
||||||
CID=$(docker run -d -t --cap-add=ALL "$IMAGE_TAG")
|
|
||||||
}
|
|
||||||
|
|
||||||
teardown() {
|
|
||||||
if [[ -n "$CID" ]]; then
|
|
||||||
docker rm -f "$CID" > /dev/null 2>&1 || true
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
# Helper: write a mock SELinux config with the given state
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
_mock_selinux_config() {
|
|
||||||
local state="$1" # enforcing, permissive, or disabled
|
|
||||||
local capitalized
|
|
||||||
capitalized=$(echo "${state}" | awk '{print toupper(substr($0,1,1)) substr($0,2)}')
|
|
||||||
mock_command "$CID" getenforce "*" "$capitalized" "0"
|
|
||||||
docker exec "$CID" bash -c "
|
|
||||||
mkdir -p /etc/selinux
|
|
||||||
echo 'SELINUX=${state}' > /etc/selinux/config
|
|
||||||
"
|
|
||||||
}
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
@test "SELinux enforcing: installer exits with error" {
|
|
||||||
_mock_selinux_config "enforcing"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
checkSelinux
|
|
||||||
"
|
|
||||||
assert_output --partial "${CROSS} Current SELinux: enforcing"
|
|
||||||
assert_output --partial "SELinux Enforcing detected, exiting installer"
|
|
||||||
assert_failure
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "SELinux permissive: installer continues" {
|
|
||||||
_mock_selinux_config "permissive"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
checkSelinux
|
|
||||||
"
|
|
||||||
assert_output --partial "${TICK} Current SELinux: permissive"
|
|
||||||
assert_success
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "SELinux disabled: installer continues" {
|
|
||||||
_mock_selinux_config "disabled"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
checkSelinux
|
|
||||||
"
|
|
||||||
assert_output --partial "${TICK} Current SELinux: disabled"
|
|
||||||
assert_success
|
|
||||||
}
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
#!/usr/bin/env bats
|
|
||||||
# Tests for utils.sh — translated from test_any_utils.py
|
|
||||||
|
|
||||||
load 'libs/bats-support/load'
|
|
||||||
load 'libs/bats-assert/load'
|
|
||||||
|
|
||||||
CID=""
|
|
||||||
|
|
||||||
setup() {
|
|
||||||
CID=$(docker run -d -t --cap-add=ALL "$IMAGE_TAG")
|
|
||||||
}
|
|
||||||
|
|
||||||
teardown() {
|
|
||||||
if [[ -n "$CID" ]]; then
|
|
||||||
docker rm -f "$CID" > /dev/null 2>&1 || true
|
|
||||||
fi
|
|
||||||
}
|
|
||||||
|
|
||||||
# ---------------------------------------------------------------------------
|
|
||||||
|
|
||||||
@test "addOrEditKeyValPair adds and replaces key-value pairs correctly" {
|
|
||||||
docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/utils.sh
|
|
||||||
addOrEditKeyValPair './testoutput' 'KEY_ONE' 'value1'
|
|
||||||
addOrEditKeyValPair './testoutput' 'KEY_TWO' 'value2'
|
|
||||||
addOrEditKeyValPair './testoutput' 'KEY_ONE' 'value3'
|
|
||||||
addOrEditKeyValPair './testoutput' 'KEY_FOUR' 'value4'
|
|
||||||
"
|
|
||||||
run docker exec "$CID" bash -c "cat ./testoutput"
|
|
||||||
assert_output "KEY_ONE=value3
|
|
||||||
KEY_TWO=value2
|
|
||||||
KEY_FOUR=value4"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "getFTLPID returns -1 when FTL is not running" {
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/utils.sh
|
|
||||||
getFTLPID
|
|
||||||
"
|
|
||||||
assert_output "-1"
|
|
||||||
}
|
|
||||||
|
|
||||||
@test "setFTLConfigValue and getFTLConfigValue round-trip" {
|
|
||||||
# FTL must be installed for this test
|
|
||||||
docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/basic-install.sh
|
|
||||||
create_pihole_user
|
|
||||||
funcOutput=\$(get_binary_name)
|
|
||||||
echo 'development' > /etc/pihole/ftlbranch
|
|
||||||
binary=\"pihole-FTL\${funcOutput##*pihole-FTL}\"
|
|
||||||
theRest=\"\${funcOutput%pihole-FTL*}\"
|
|
||||||
FTLdetect \"\${binary}\" \"\${theRest}\"
|
|
||||||
"
|
|
||||||
run docker exec "$CID" bash -c "
|
|
||||||
source /opt/pihole/utils.sh
|
|
||||||
setFTLConfigValue 'dns.upstreams' '[\"9.9.9.9\"]' > /dev/null
|
|
||||||
getFTLConfigValue 'dns.upstreams'
|
|
||||||
"
|
|
||||||
assert_output --partial "[ 9.9.9.9 ]"
|
|
||||||
}
|
|
||||||
10
test/tox.alpine_3_21.ini
Normal file
10
test/tox.alpine_3_21.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _alpine_3_21.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py
|
||||||
10
test/tox.alpine_3_22.ini
Normal file
10
test/tox.alpine_3_22.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _alpine_3_22.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py
|
||||||
10
test/tox.alpine_3_23.ini
Normal file
10
test/tox.alpine_3_23.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _alpine_3_23.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py
|
||||||
10
test/tox.centos_10.ini
Normal file
10
test/tox.centos_10.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _centos_10.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py ./test_centos_fedora_common_support.py
|
||||||
10
test/tox.centos_9.ini
Normal file
10
test/tox.centos_9.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _centos_9.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py ./test_centos_fedora_common_support.py
|
||||||
10
test/tox.debian_11.ini
Normal file
10
test/tox.debian_11.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _debian_11.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py
|
||||||
10
test/tox.debian_12.ini
Normal file
10
test/tox.debian_12.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _debian_12.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py
|
||||||
10
test/tox.debian_13.ini
Normal file
10
test/tox.debian_13.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _debian_13.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py
|
||||||
10
test/tox.fedora_40.ini
Normal file
10
test/tox.fedora_40.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _fedora_40.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py ./test_centos_fedora_common_support.py
|
||||||
10
test/tox.fedora_41.ini
Normal file
10
test/tox.fedora_41.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _fedora_41.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py ./test_centos_fedora_common_support.py
|
||||||
10
test/tox.fedora_42.ini
Normal file
10
test/tox.fedora_42.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _fedora_42.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py ./test_centos_fedora_common_support.py
|
||||||
10
test/tox.fedora_43.ini
Normal file
10
test/tox.fedora_43.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _fedora_43.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py ./test_centos_fedora_common_support.py
|
||||||
10
test/tox.ubuntu_20.ini
Normal file
10
test/tox.ubuntu_20.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _ubuntu_20.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py
|
||||||
10
test/tox.ubuntu_22.ini
Normal file
10
test/tox.ubuntu_22.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _ubuntu_22.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py
|
||||||
10
test/tox.ubuntu_24.ini
Normal file
10
test/tox.ubuntu_24.ini
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[tox]
|
||||||
|
envlist = py3
|
||||||
|
|
||||||
|
[testenv:py3]
|
||||||
|
allowlist_externals = docker
|
||||||
|
deps = -rrequirements.txt
|
||||||
|
setenv =
|
||||||
|
COLUMNS=120
|
||||||
|
commands = docker buildx build --load --progress plain -f _ubuntu_24.Dockerfile -t pytest_pihole:test_container ../
|
||||||
|
pytest {posargs:-vv -n auto} ./test_any_automated_install.py ./test_any_utils.py
|
||||||
Reference in New Issue
Block a user