refactor: refactor install chain

Includes:

* refactor of install.sh, splitting it to libs
* fix of custompios module according to install changes
* added test script to verify install
* refactor of `make config` script

    Signed-off-by: Stephan Wendel <[email protected]>

Signed-off-by: Stephan Wendel <[email protected]>

Author: KwadFan

.gitignore

@@ -13,9 +13,6 @@ ERRORS.txt
 # Ignore leftover
 leftover*
 
-#Ignore Test Files
-test*
-
 # tmp file workaround
 lost*
 
@@ -30,3 +27,6 @@ bin/rtsp-simple-server/*.yml
 # Ignore Config for Intsaller
 tools/config.local
 tools/.config
+
+# Ignore pkglist
+tools/pkglist.sh

Makefile

@@ -1,64 +1,46 @@
-#### webcamd - A webcam Service for multiple Cams and Stream Services.
+#### crowsnest - A webcam Service for multiple Cams and Stream Services.
 ####
 #### Written by Stephan Wendel aka KwadFan <[email protected]>
-#### Copyright 2021 - 2022
+#### Copyright 2021 - till today
 #### https://github.com/mainsail-crew/crowsnest
 ####
 #### This File is distributed under GPLv3
 ####
 
-.PHONY: build buildclean config help install unsinstall update
+#### Self-Documenting Makefile
+#### This is based on https://gellardo.github.io/blog/posts/2021-06-10-self-documenting-makefile/
 
-# Setup
-USER = $(shell whoami)
-BIN_FOLDER = bin
+.DEFAULT_GOAL := help
+.PHONY: help
 
-all: help
-
-help:
-	@echo "This is intended to install crowsnest."
-	@echo ""
-	@echo "Some Parts need 'sudo' privileges."
-	@echo "You'll be asked for password, if needed."
-	@echo ""
-	@echo " Usage: make [action]"
-	@echo ""
-	@echo "  Available actions:"
-	@echo ""
-	@echo "   config       Configures Installer"
-	@echo "   install      Installs crowsnest (needs sudo)"
-	@echo "   uninstall    Uninstalls crowsnest (needs sudo)"
-	@echo "   build        builds binaries"
-	@echo "   buildclean   cleans binaries (for recompile)"
-	@echo "   clean        Removes Installer config"
-	@echo "   update       Pulls latest updates from repository"
-	@echo ""
-
-install:
+install: ## Install crowsnest (needs leading sudo)
 	@bash -c 'tools/install.sh'
 
-uninstall:
+uninstall: ## Uninstall crowsnest
 	@bash -c 'tools/uninstall.sh'
 
-build:
+build: ## Compile backends / streamer
 	bash -c 'bin/build.sh --build'
 
-buildclean:
+buildclean: ## Clean backends / streamer (for rebuilding)
 	bash -c 'bin/build.sh --clean'
 
-clean:
+clean: ## Clean .config
 	@if [ -f tools/.config ]; then rm -f tools/.config; fi
-	@echo "Removed installer config file ..."
+	@printf "Removed installer config file ...\n"
 
-config:
+config: ## Configure crowsnest installer
 	@bash -c 'tools/configure.sh'
 
-update:
+help: ## Shows this help
+	@printf "crowsnest - A webcam Service for multiple Cams and Stream Services.\n"
+	@printf "Usage:\n\n"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+update: ## Update crowsnest (fetches and pulls repository changes)
 	@git fetch && git pull
 
-report:
+report: ## Generate report.txt
 	@if [ -f ~/report.txt ]; then rm -f ~/report.txt; fi
 	@bash -c 'tools/dev-helper.sh -a >> ~/report.txt'
 	@sed -ri 's/\x1B\[([0-9]{1,3}(;[0-9]{1,2})?)?[mGK]//g' ~/report.txt
-
-

custompios/README.md

@@ -28,12 +28,6 @@ the folder you configured above.\
 Please feel free to Pull Request your config!
 I will add them.
 
-To ensure raspicam fix is applied during Image build set
-
-    CROWSNEST_RASPICAMFIX="1"
-
-This only works for Raspberry Pi OS! Will modify that in the future to support build images for other SBC's
-
 Last but not least:
 
     CROWSNEST_ADD_CROWSNEST_MOONRAKER="1"

custompios/crowsnest/config

@@ -2,7 +2,7 @@
 #### crowsnest - A webcam Service for multiple Cams and Stream Services.
 ####
 #### Written by Stephan Wendel aka KwadFan <[email protected]>
-#### Copyright 2021 - 2022
+#### Copyright 2021 - till today
 #### https://github.com/mainsail-crew/crowsnest
 ####
 #### This File is distributed under GPLv3

custompios/crowsnest/start_chroot_script

@@ -20,7 +20,25 @@ install_cleanup_trap
 
 # Module only Variables
 CN_BUILD_PACKAGE_FILE="/tmp/cn_packages.lst"
-CN_BUILD_INSTALL_SH="/home/${BASE_USER}/crowsnest/tools/install.sh"
+
+# Helper Func
+is_raspbian() {
+    if [[ -f /boot/config.txt ]] && [[ -f /etc/rpi-issue ]]; then
+        echo "1"
+    else
+        echo "0"
+    fi
+}
+
+get_pkglist() {
+    if [[ "$(is_raspbian)" = "1" ]]; then
+        CN_BUILD_INSTALL_SH="/home/${BASE_USER}/crowsnest/tools/libs/pkglist-rpi.sh"
+    fi
+    if [[ "$(is_raspbian)" = "0" ]]; then
+        CN_BUILD_INSTALL_SH="/home/${BASE_USER}/crowsnest/tools/libs/pkglist-generic.sh"
+    fi
+}
+
 
 echo_green "Installing crowsnest ..."
 
@@ -38,6 +56,7 @@ gitclone CROWSNEST_REPO crowsnest
 
 ## Step 3: grep PKGLIST from install.sh for dependencies
 echo_green "Generating packages file ..."
+get_pkglist
 grep "PKGLIST=" "${CN_BUILD_INSTALL_SH}" >> "${CN_BUILD_PACKAGE_FILE}"
 
 ## Step 4: Rename PKGLIST to Module usable Var

resources/crowsnest.conf

@@ -27,6 +27,7 @@
 log_path: %LOGPATH%
 log_level: verbose                      # Valid Options are quiet/verbose/debug
 delete_log: false                       # Deletes log on every restart, if set to true
+no_proxy: false
 
 [cam 1]
 mode: mjpg                              # mjpg/multi - Multi uses webrtc, mjpg and snapshots at the same time

resources/crowsnest.env

@@ -0,0 +1 @@
+CROWSNEST_ARGS="-c %CONFPATH%/crowsnest.conf"

resources/crowsnest.service

@@ -25,6 +25,6 @@ User=%USER%
 RemainAfterExit=Yes
 WorkingDirectory=/home/%USER%/crowsnest
 EnvironmentFile=%ENV%
-ExecStart= /usr/local/bin/crowsnest $CROWSNEST_ARGS
+ExecStart=/usr/local/bin/crowsnest $CROWSNEST_ARGS
 Restart=on-failure
 RestartSec=5

resources/moonraker_update.txt

@@ -5,4 +5,4 @@ type: git_repo
 path: ~/crowsnest
 origin: https://github.com/mainsail-crew/crowsnest.git
 managed_services: crowsnest
-install_script: tools/install.sh
+install_script: tools/pkglist.sh

tools/configure.sh

@@ -13,15 +13,17 @@
 
 # Exit on errors
 set -Ee
+set -x
+
 
 # Global Vars
 CN_CONFIG_USER=$(whoami)
 CN_CONFIG_CONFIGFILE="tools/.config"
 CN_CONFIG_ROOTPATH="/home/${CN_CONFIG_USER}/printer_data"
-CN_CONFIG_CONFIGPATH="${CN_CONFIG_ROOTPATH}/config"
-CN_CONFIG_LOGPATH="${CN_CONFIG_ROOTPATH}/logs"
-CN_CONFIG_ENVPATH="${CN_CONFIG_ROOTPATH}/systemd"
-CN_MOONRAKER_CONFIG_PATH="${CN_CONFIG_CONFIGPATH}/moonraker.conf"
+# CN_CONFIG_CONFIGPATH="${CN_CONFIG_ROOTPATH}/config"
+# CN_CONFIG_LOGPATH="${CN_CONFIG_ROOTPATH}/logs"
+# CN_CONFIG_ENVPATH="${CN_CONFIG_ROOTPATH}/systemd"
+# CN_MOONRAKER_CONFIG_PATH="${CN_CONFIG_CONFIGPATH}/moonraker.conf"
 CN_USTREAMER_REPO="https://github.com/pikvm/ustreamer.git"
 CN_USTREAMER_BRANCH="master"
 CN_CAMERA_STREAMER_REPO="https://github.com/ayufan-research/camera-streamer.git"
@@ -56,6 +58,14 @@ default_path_msg() {
     echo -e "Hit ENTER to use default."
 }
 
+root_path_msg() {
+    header_msg
+    echo -e "Please specify path to your 'printer_data' root path\n"
+    echo -e "For example: /home/pi/voron_data or /home/kwad/ender_data"
+    echo -e "\t\e[34mNOTE:\e[0m File names are hardcoded! Also skip trailing backslash!"
+    echo -e "\tDefault: \e[32m${CN_CONFIG_ROOTPATH}\e[0m\n"
+}
+
 config_path_msg() {
     header_msg
     echo -e "Please specify path to config file (crowsnest.conf)\n"
@@ -149,11 +159,31 @@ create_config_header() {
     } >> "${CN_CONFIG_CONFIGFILE}"
 }
 
+specify_root_path() {
+    local reply
+    root_path_msg
+    default_path_msg
+    read -erp "Please enter path: " reply
+    if [[ -z "${reply}" ]]; then
+        echo -e "CROWSNEST_CONFIG_PATH=\"${CN_CONFIG_CONFIGPATH}\"" >> \
+        "${CN_CONFIG_CONFIGFILE}"
+        return 0
+    fi
+    if [[ -n "${reply}" ]]; then
+        CN_CONFIG_ROOTPATH="${reply}"
+        CN_CONFIG_CONFIGPATH="${CN_CONFIG_ROOTPATH}/config"
+        CN_CONFIG_LOGPATH="${CN_CONFIG_ROOTPATH}/logs"
+        CN_CONFIG_ENVPATH="${CN_CONFIG_ROOTPATH}/systemd"
+        CN_MOONRAKER_CONFIG_PATH="${CN_CONFIG_CONFIGPATH}/moonraker.conf"
+        return 0
+    fi
+}
+
 specify_config_path() {
     local reply
     config_path_msg
     default_path_msg
-    read -erp "Please enter path: " reply
+    read -erp "Please enter path: " -i "${CN_CONFIG_CONFIGPATH}" reply
     if [[ -z "${reply}" ]]; then
         echo -e "CROWSNEST_CONFIG_PATH=\"${CN_CONFIG_CONFIGPATH}\"" >> \
         "${CN_CONFIG_CONFIGFILE}"
@@ -170,7 +200,7 @@ specify_log_path() {
     local reply
     log_path_msg
     default_path_msg
-    read -erp "Please enter path: " reply
+    read -erp "Please enter path: " -i "${CN_CONFIG_LOGPATH}" reply
     if [[ -z "${reply}" ]]; then
         echo -e "CROWSNEST_LOG_PATH=\"${CN_CONFIG_LOGPATH}\"" >> \
         "${CN_CONFIG_CONFIGFILE}"
@@ -186,7 +216,7 @@ specify_env_path() {
     local reply
     env_path_msg
     default_path_msg
-    read -erp "Please enter path: " reply
+    read -erp "Please enter path: " -i "${CN_CONFIG_ENVPATH}" reply
     if [[ -z "${reply}" ]]; then
         echo -e "CROWSNEST_ENV_PATH=\"${CN_CONFIG_ENVPATH}\"" >> \
         "${CN_CONFIG_CONFIGFILE}"
@@ -223,22 +253,15 @@ add_moonraker_entry() {
 
 ### Main func
 main() {
-    # Step 1: Welcome Message
     welcome_msg
     continue_config
-    # Step 2: Check for existing file
     check_config_file
-    # Step 3: Create config header
     create_config_header
-    # Step 4: Specify config file path.
+    specify_root_path
     specify_config_path
-    # Step 5: Specify log file path.
     specify_log_path
-    # Step 6: Specify env path.
     specify_env_path
-    # Step 7: Moonraker entry
     add_moonraker_entry
-    # Step 8: Display finished message
     goodbye_msg
 }