Pi-hole/pi-hole
Pi-hole/pi-hole
1
0
Fork 0
mirror of https://github.com/pi-hole/pi-hole.git synced 2024-11-25 15:43:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Remove obsolet getFTLPIDFile() (#5710)

Browse source
This commit is contained in:
yubiuser 2024-07-29 09:23:34 +02:00 committed by GitHub
commit 67de7be802
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 9 additions and 60 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
advanced/Scripts/utils.sh
View file

@ -81,25 +81,6 @@ removeKey() {
sed -i "/^${key}/d" "${file}" sed -i "/^${key}/d" "${file}"
} }
#######################
# returns path of FTL's PID file
#######################
getFTLPIDFile() {
local FTLCONFFILE="/etc/pihole/pihole-FTL.conf"
local DEFAULT_PID_FILE="/run/pihole-FTL.pid"
local FTL_PID_FILE
if [ -s "${FTLCONFFILE}" ]; then
# if PIDFILE is not set in pihole-FTL.conf, use the default path
FTL_PID_FILE="$({ grep '^PIDFILE=' "${FTLCONFFILE}" || echo "${DEFAULT_PID_FILE}"; } | cut -d'=' -f2-)"
else
# if there is no pihole-FTL.conf, use the default path
FTL_PID_FILE="${DEFAULT_PID_FILE}"
fi
echo "${FTL_PID_FILE}"
}
####################### #######################
# returns FTL's PID based on the content of the pihole-FTL.pid file # returns FTL's PID based on the content of the pihole-FTL.pid file
# #

4
advanced/Templates/pihole-FTL-poststop.sh
View file

@ -1,13 +1,13 @@
#!/usr/bin/env sh #!/usr/bin/env sh
# Source utils.sh for getFTLPIDFile() # Source utils.sh for getFTLConfigValue()
PI_HOLE_SCRIPT_DIR='/opt/pihole' PI_HOLE_SCRIPT_DIR='/opt/pihole'
utilsfile="${PI_HOLE_SCRIPT_DIR}/utils.sh" utilsfile="${PI_HOLE_SCRIPT_DIR}/utils.sh"
# shellcheck disable=SC1090 # shellcheck disable=SC1090
. "${utilsfile}" . "${utilsfile}"
# Get file paths # Get file paths
FTL_PID_FILE="$(getFTLPIDFile)" FTL_PID_FILE="$(getFTLConfigValue files.pid)"
# Cleanup # Cleanup
rm -f /run/pihole/FTL.sock /dev/shm/FTL-* "${FTL_PID_FILE}" rm -f /run/pihole/FTL.sock /dev/shm/FTL-* "${FTL_PID_FILE}"

4
advanced/Templates/pihole-FTL-prestart.sh
View file

@ -1,13 +1,13 @@
#!/usr/bin/env sh #!/usr/bin/env sh
# Source utils.sh for getFTLPIDFile() # Source utils.sh for getFTLConfigValue()
PI_HOLE_SCRIPT_DIR='/opt/pihole' PI_HOLE_SCRIPT_DIR='/opt/pihole'
utilsfile="${PI_HOLE_SCRIPT_DIR}/utils.sh" utilsfile="${PI_HOLE_SCRIPT_DIR}/utils.sh"
# shellcheck disable=SC1090 # shellcheck disable=SC1090
. "${utilsfile}" . "${utilsfile}"
# Get file paths # Get file paths
FTL_PID_FILE="$(getFTLPIDFile)" FTL_PID_FILE="$(getFTLConfigValue files.pid)"
# Ensure that permissions are set so that pihole-FTL can edit all necessary files # Ensure that permissions are set so that pihole-FTL can edit all necessary files
# shellcheck disable=SC2174 # shellcheck disable=SC2174

4
advanced/Templates/pihole-FTL.service
View file

@ -9,7 +9,7 @@
# Description: Enable service provided by pihole-FTL daemon # Description: Enable service provided by pihole-FTL daemon
### END INIT INFO ### END INIT INFO
# Source utils.sh for getFTLPIDFile(), getFTLPID() # Source utils.sh for getFTLConfigValue(), getFTLPID()
PI_HOLE_SCRIPT_DIR="/opt/pihole" PI_HOLE_SCRIPT_DIR="/opt/pihole"
utilsfile="${PI_HOLE_SCRIPT_DIR}/utils.sh" utilsfile="${PI_HOLE_SCRIPT_DIR}/utils.sh"
# shellcheck disable=SC1090 # shellcheck disable=SC1090
@ -98,7 +98,7 @@ status() {
trap 'cleanup; exit 1' INT HUP TERM ABRT trap 'cleanup; exit 1' INT HUP TERM ABRT
# Get FTL's PID file path # Get FTL's PID file path
FTL_PID_FILE="$(getFTLPIDFile)" FTL_PID_FILE="$(getFTLConfigValue files.pid)"
# Get FTL's current PID # Get FTL's current PID
FTL_PID="$(getFTLPID "${FTL_PID_FILE}")" FTL_PID="$(getFTLPID "${FTL_PID_FILE}")"

4
pihole
View file

@ -152,7 +152,7 @@ restartDNS() {
svcOption="${1:-restart}" svcOption="${1:-restart}"
# get the current path to the pihole-FTL.pid # get the current path to the pihole-FTL.pid
FTL_PID_FILE="$(getFTLPIDFile)" FTL_PID_FILE="$(getFTLConfigValue files.pid)"
# Determine if we should reload or restart # Determine if we should reload or restart
if [[ "${svcOption}" =~ "reload-lists" ]]; then if [[ "${svcOption}" =~ "reload-lists" ]]; then
@ -337,7 +337,7 @@ statusFunc() {
# Determine if there is pihole-FTL service is listening # Determine if there is pihole-FTL service is listening
local pid port ftl_pid_file block_status local pid port ftl_pid_file block_status
ftl_pid_file="$(getFTLPIDFile)" ftl_pid_file="$(getFTLConfigValue files.pid)"
pid="$(getFTLPID ${ftl_pid_file})" pid="$(getFTLPID ${ftl_pid_file})"

34
test/test_any_utils.py
View file

@ -82,18 +82,6 @@ def test_key_removal_works(host):
assert expected_stdout == output.stdout assert expected_stdout == output.stdout
def test_getFTLPIDFile_default(host):
"""Confirms getFTLPIDFile returns the default PID file path"""
output = host.run(
"""
source /opt/pihole/utils.sh
getFTLPIDFile
"""
)
expected_stdout = "/run/pihole-FTL.pid\n"
assert expected_stdout == output.stdout
def test_getFTLPID_default(host): def test_getFTLPID_default(host):
"""Confirms getFTLPID returns the default value if FTL is not running""" """Confirms getFTLPID returns the default value if FTL is not running"""
output = host.run( output = host.run(
@ -106,27 +94,7 @@ def test_getFTLPID_default(host):
assert expected_stdout == output.stdout assert expected_stdout == output.stdout
def test_getFTLPIDFile_and_getFTLPID_custom(host): def test_setFTLConfigValue_getFTLConfigValue(host):
"""Confirms getFTLPIDFile returns a custom PID file path"""
host.run(
"""
tmpfile=$(mktemp)
echo "PIDFILE=${tmpfile}" > /etc/pihole/pihole-FTL.conf
echo "1234" > ${tmpfile}
"""
)
output = host.run(
"""
source /opt/pihole/utils.sh
FTL_PID_FILE=$(getFTLPIDFile)
getFTLPID "${FTL_PID_FILE}"
"""
)
expected_stdout = "1234\n"
assert expected_stdout == output.stdout
def test_getFTLConfigValue_getFTLConfigValue(host):
""" """
Confirms getFTLConfigValue works (also assumes setFTLConfigValue works) Confirms getFTLConfigValue works (also assumes setFTLConfigValue works)
Requires FTL to be installed, so we do that first Requires FTL to be installed, so we do that first