verbose configuration files by printminion-co · Pull Request #103 · IONOS-Productivity/nc-config

printminion-co · 2025-07-11T15:21:50Z

No description provided.

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

in order to avoid occ vs. ooc typo Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…age instructions Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

… and spacing Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…tions for better error handling and output clarity in order to differentiate between error and fatal error Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…proved scope clarity Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…teps in configure.sh for improved clarity Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…on to prevent errors Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…app function for consistency Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…tion for consistency Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…disabling process Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…ility Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…g consistency Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…eport failed app enables do not exit on first app enable failure. output cumulated app enabling errors and exit Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…ommand for consistency Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

…handling Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

Copilot

Pull Request Overview

This PR refactors several shell scripts to introduce consistent logging, modularize configuration steps, and improve error handling with colorized output.

Introduced log_* and execute_occ_command utility functions for unified logging and OCC calls.
Broke monolithic scripts into smaller, well-named functions for each configuration task.
Updated apps-enable/disable scripts to track failures and provide clearer fatal error messages.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
readme.md	Removed an extraneous blank line.
configure.sh	Added logging functions, modularized OCC commands, and improved error handling.
configure-user-oidc.sh	Replaced `fail` with `log_fatal` and added usage comments.
configure-object-store.sh	Replaced `fail` with `log_fatal` and standardized error messages.
apps-enable.sh	Renamed `ooc` to `execute_occ_command`, added failure tracking, unified logging.
apps-disable.sh	Replaced `fail` with `log_fatal` for consistent fatal error handling.

Copilot · 2025-07-14T09:08:01Z

configure.sh

@@ -1,185 +1,302 @@
 #!/bin/sh


Consider adding set -euo pipefail after the shebang to ensure the script exits on errors and catches unset variables early.

Copilot · 2025-07-14T09:08:01Z

configure.sh

+# Check if required dependencies are available
+# Usage: check_dependencies
+check_dependencies() {
 	if ! which php >/dev/null 2>&1; then


Using which can be non‐portable; consider command -v php >/dev/null 2>&1 for POSIX compliance.

Suggested change

if ! which php >/dev/null 2>&1; then

if ! command -v php >/dev/null 2>&1; then

Copilot · 2025-07-14T09:08:01Z

configure.sh

+# Usage: verify_nextcloud_installation
+verify_nextcloud_installation() {
+	log_info "Verifying HiDrive Next installation status..."
+	_main_status="$( execute_occ_command status 2>/dev/null | grep 'installed: ' | sed -r 's/^.*installed: (.+)$/\1/' )"


sed -r is not portable on macOS (BSD sed); use sed -E for extended regex support.

Suggested change

_main_status="$( execute_occ_command status 2>/dev/null | grep 'installed: ' | sed -r 's/^.*installed: (.+)$/\1/' )"

_main_status="$( execute_occ_command status 2>/dev/null | grep 'installed: ' | sed -E 's/^.*installed: (.+)$/\1/' )"

Copilot · 2025-07-14T09:08:02Z

apps-enable.sh

+		if ! execute_occ_command app:enable "${app_name}"
 		then
-			fail "Enabling app \"${app_name}\" failed."
+			echo "ERROR: Enabling app \"${app_name}\" failed."


[nitpick] This error branch uses a plain echo while other failures use log_fatal; consider unifying to a consistent logging function for maintainability.

Suggested change

echo "ERROR: Enabling app \"${app_name}\" failed."

log_error "Enabling app \"${app_name}\" failed."

printminion-co added 4 commits July 11, 2025 17:17

chore(readme): remove unnecessary trailing newline in code block

855b64d

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

refactor: replace ooc function calls with execute_occ_command

8c3a082

in order to avoid occ vs. ooc typo Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

refactor: rename functions in configure.sh for clarity and consistency

02a9225

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

feat(config): enhance configure.sh with detailed documentation and us…

efb1b26

…age instructions Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

printminion-co force-pushed the mk/dev/verbose_make_file branch from 9d33492 to 12e129b Compare July 11, 2025 16:16

printminion-co added 16 commits July 11, 2025 18:54

feat(config): improve output messages in configure.sh for better clarity

b151c01

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

refactor(config): update script directory variable for improved clarity

01b5dde

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

refactor(config): make script variables readonly for improved safety

31ebc2a

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

refactor(config): improve script readability by standardizing quoting…

c1b7fc8

… and spacing Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

feat(config): enhance logging in configure.sh with dedicated log func…

9c021a1

…tions for better error handling and output clarity in order to differentiate between error and fatal error Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

refactor(config): rename internal variable for homepage URL in for im…

af24076

…proved scope clarity Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

refactor(config): add comments for initial checks and configuration s…

c28529e

…teps in configure.sh for improved clarity Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(config): add validation for app name in disable_single_app functi…

3731d0e

…on to prevent errors Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(config): rename internal variable for app name in disable_single_…

469c1d1

…app function for consistency Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(config): update command execution in disable_configured_apps func…

8a5872a

…tion for consistency Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(config): rename internal variable in loop for consistency in app …

0619dd9

…disabling process Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(logging): enhance log messages with color coding for better visib…

fe82abf

…ility Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(logging): replace echo statements with log_info for better loggin…

b6c1593

…g consistency Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(installation): extract nextcloud installation as own function

be4b489

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(apps-enable): improve error handling in enable_app function and r…

db257ca

…eport failed app enables do not exit on first app enable failure. output cumulated app enabling errors and exit Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(apps-enable): redirect error messages to stderr in fail function

6359d8b

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

printminion-co force-pushed the mk/dev/verbose_make_file branch from 12e129b to 6359d8b Compare July 11, 2025 16:56

printminion-co requested a review from Copilot July 11, 2025 16:57

This comment was marked as outdated.

Sign in to view

printminion-co changed the title ~~Mk/dev/verbose make file~~ verbose make file Jul 11, 2025

printminion-co changed the title ~~verbose make file~~ verbose configuration files Jul 14, 2025

printminion-co added 4 commits July 14, 2025 09:25

fix(apps-enable): rename ooc function to execute_occ_command for clarity

df1bdda

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(apps-enable): replace direct occ command calls with execute_occ_c…

d89f5ab

…ommand for consistency Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(configure): correct boolean comparison for main status check

d5bb851

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

fix(apps-enable): quote variable in failed apps count check for safety

b4a88f2

Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

printminion-co requested a review from Copilot July 14, 2025 07:33

This comment was marked as outdated.

Sign in to view

printminion-co requested a review from Copilot July 14, 2025 08:25

This comment was marked as outdated.

Sign in to view

fix(apps): replace fail function with log_fatal for consistent error …

2c6df09

…handling Signed-off-by: Misha M.-Kupriyanov <kupriyanov@strato.de>

printminion-co force-pushed the mk/dev/verbose_make_file branch from 14ecedf to 2c6df09 Compare July 14, 2025 08:30

printminion-co requested a review from Copilot July 14, 2025 09:06

Copilot AI reviewed Jul 14, 2025

View reviewed changes

tanyaka approved these changes Jul 14, 2025

View reviewed changes

printminion-co merged commit 872e7aa into master Jul 14, 2025
7 checks passed

printminion-co deleted the mk/dev/verbose_make_file branch July 14, 2025 12:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

verbose configuration files#103

verbose configuration files#103
printminion-co merged 25 commits intomasterfrom
mk/dev/verbose_make_file

printminion-co commented Jul 11, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 14, 2025

Uh oh!

Copilot AI Jul 14, 2025

Uh oh!

Copilot AI Jul 14, 2025

Uh oh!

Copilot AI Jul 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	if ! which php >/dev/null 2>&1; then
	if ! command -v php >/dev/null 2>&1; then

	_main_status="$( execute_occ_command status 2>/dev/null \| grep 'installed: ' \| sed -r 's/^.*installed: (.+)$/\1/' )"
	_main_status="$( execute_occ_command status 2>/dev/null \| grep 'installed: ' \| sed -E 's/^.*installed: (.+)$/\1/' )"

	echo "ERROR: Enabling app \"${app_name}\" failed."
	log_error "Enabling app \"${app_name}\" failed."

Conversation

printminion-co commented Jul 11, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants