Skip to content

Lot of changes #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0n1cOn3 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Lot of changes #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 125 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,136 @@
# Tools for developemnt
# Zraxyl Build Toolset

* This is basic toolset of tools for Zraxyl development environment.
**Unified and Legacy-Compatible Development Environment Management**

# Packages needed to work with the scriptlets
---

```
## modules deps ( docker, mkiso and builder )
$ bottle -Syu --needed base-devel docker bash libisofs libisoburn dialog git
## Overview

- Integrated toolset for environment setup, module management, and consistent builds
- Supports both:
- Modern unified workflow (`build_toolset.sh`) with order enforcement, logging, CLI & TUI modes
- Original scriptlets (`envsetup.sh`, `load_modules.sh`, etc.) for legacy compatibility

---

## Required Packages

Install dependencies before use:

```sh
bottle -Syu --needed base-devel docker bash libisofs libisoburn dialog git
```

## Getting started
---

1. Make empty directory somewhere ( And dont use root user )
2. Clone this repository into empty directory.
3. Open terminal in that empty directory where you have repo called tools
## Getting Started

### 1. Prepare Your Environment

- Create a new, empty working directory (do **not** use root)

### 2. Clone the Repository

```sh
git clone https://github.com/Zraxyl/build_toolset
```
$ ln -sf tools/envsetup.sh envsetup

$ ./envsetup --help
---

## Two Supported Workflows

### A. Legacy Scripts (Fully Supported)

- `envsetup.sh` – Environment and `.env` setup
- `load_modules.sh` – Module updates and git submodules
- `initial_setup.sh` – First-time setup (calls other scripts)
- `dialog.sh` – Interactive TUI menu

**Example:**

```sh
ln -sf tools/envsetup.sh envsetup
./envsetup --help
./load_modules.sh
./initial_setup.sh
./dialog.sh
```

4. Now youre ready to start adding/changing packages
> **Note:** You must run these in logical order:
> `envsetup.sh` → `load_modules.sh` → `initial_setup.sh` → `dialog.sh`

---

### B. Unified Script (Recommended)

- Single script: `build_toolset.sh`
- Order-aware, idempotent, with comprehensive logging
- Supports both CLI flags and interactive TUI menu

---

## Unified Script Usage

- **CLI flags** (must appear in this order):

```sh
./build_toolset.sh --env --modules --init --dialog
./build_toolset.sh --env --modules
./build_toolset.sh --init
```

- **TUI menu only**:

```sh
./build_toolset.sh --dialog
```

- **No arguments** shows help:

```sh
./build_toolset.sh
```

---

## Logging

- All actions and errors are logged with timestamps to `build_toolset.log`

---

## Order Enforcement & Idempotency

- **Strict order:** Flags must follow `--env` → `--modules` → `--init` → `--dialog`
- **Idempotent:** Each step runs at most once per invocation, even if redundantly specified
- **Errors:** Out‑of‑order or invalid sequences abort with clear, actionable messages

---

## Contribution

- Fork the repo and submit pull requests
- Maintain **Bash 4.x+** compliance and use the central error/logging framework

---

## Support

- Check `build_toolset.log` for troubleshooting details
- Include log excerpts when requesting help

---

## Quick Reference

| Script | Purpose | Order Enforcement | Logging |
|----------------------|-------------------------------------------|-------------------|-------------------|
| `envsetup.sh` | Environment and `.env` setup | Manual | No |
| `load_modules.sh` | Module updates and git submodules | Manual | No |
| `initial_setup.sh` | First-time setup (calls others) | Manual | No |
| `dialog.sh` | Interactive TUI menu (legacy mode) | Manual | No |
| **`build_toolset.sh`** | **Unified, order‑aware CLI & TUI** | **Automatic** | **Yes** |

---

**Recommendation:** Use `build_toolset.sh` for reliable, traceable, and consistent workflows. Legacy scripts remain available for backward compatibility and phased migration.
211 changes: 211 additions & 0 deletions build_toolset.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
#!/usr/bin/env bash
set -euo pipefail

LOG_FILE="build_toolset.log"

declare -A ERROR_DB=(
[100]="dialog utility not found. Please install 'dialog'.|Install the dialog package for your distribution."
[101]=".env and .env.template missing.|Provide a .env.template file in the project root."
[102]="Unknown or invalid command: %s|Use --help to see available commands and required order."
[103]="Failed to copy .env.template to .env.|Check file permissions."
[104]="Cannot load modules before environment is set up.|You must run: $0 --env FIRST."
[105]="Operation cancelled by user.|No action taken."
[106]="You must specify commands in proper order: --env before --modules before --init before --dialog.|Correct example: $0 --env --modules --init --dialog"
[200]="Submodule install script failed: %s|Check the install.sh script in the affected module."
)

log() {
local level="$1"; shift
echo "[$(date '+%Y-%m-%d %H:%M:%S')] [$level] $*" >> "$LOG_FILE"
}

err() {
local code="$1"; shift
local msg hint
IFS="|" read -r msg hint <<< "${ERROR_DB[$code]:-Unknown error.}"
msg="${msg//%s/$1}"; shift || true
echo -e "\e[31m[ERROR]\e[0m (E$code) $msg" >&2
[[ -n "$hint" ]] && echo -e "\e[33m[HINT]\e[0m $hint" >&2
log "ERROR" "Code=$code $msg"
[[ -n "$hint" ]] && log "ERROR" "Hint: $hint"
exit "$code"
}

info() { echo -e "\e[34m[INFO]\e[0m $*"; log "INFO" "$*"; }
success() { echo -e "\e[32m[SUCCESS]\e[0m $*"; log "SUCCESS" "$*"; }

usage() {
cat <<EOF
Unified Build Toolset

Usage: $(basename "$0") [COMMANDS or --flags]

STRICT ORDER REQUIRED (super-sequences allowed):
--env Setup .env, make script executable, AND create legacy symlinks
--modules Load or update module dependencies (requires --env first)
--init Initial setup (env + modules)
--dialog Launch interactive menu (TUI)
--help Show this help message

Examples:
$0 --env --modules --init --dialog
$0 --env --modules
$0 --env
$0 --dialog
EOF
log "INFO" "Displayed usage"
}

check_env_present() {
if [[ -f .env ]]; then
log "DEBUG" ".env present"
return 0
else
log "DEBUG" ".env missing"
return 1
fi
}

bootstrap_legacy_links() {
info "Creating legacy symlinks..."
for script in envsetup load_modules initial_setup dialog; do
local target="tools/${script}.sh"
if [[ -f "$target" ]]; then
ln -sf "$target" "$script"
log "INFO" "Symlinked $script → $target"
else
log "WARN" "Missing $target; skipping symlink"
fi
done
success "Legacy symlinks created."
}

setup_env() {
log "INFO" "Starting environment setup"
info "Checking for .env file..."
if [[ ! -f .env ]]; then
if [[ -f .env.template ]]; then
read -p "No .env found. Create from template? [y/N]: " ans
log "DEBUG" "User answered: $ans"
if [[ "$ans" =~ ^[Yy]$ ]]; then
cp .env.template .env || err 103
success ".env created from template."
else
info ".env not created."
err 105
fi
else
err 101
fi
else
success ".env already present."
fi

# Ensure main script is executable
chmod +x build_toolset.sh
info "Ensured build_toolset.sh is executable."

# Create legacy symlinks
bootstrap_legacy_links
}

initial_setup() {
log "INFO" "Running initial setup"
info "Running initial setup (env + modules)..."
[[ -z "${RUN_ONCE_ENV:-}" ]] && { setup_env; RUN_ONCE_ENV=1; }
[[ -z "${RUN_ONCE_MODULES:-}" ]] && { load_modules; RUN_ONCE_MODULES=1; }
success "Initial setup complete."
}

load_modules() {
log "INFO" "Running load_modules"
! check_env_present && err 104
info "Updating git submodules..."
git submodule update --init --recursive
local failed=0
for module in modules/*/install.sh; do
if [[ -f "$module" ]]; then
info "Executing $module"
log "INFO" "Running installer: $module"
bash "$module" || err 200 "$module"
fi
done
success "Module loading complete."
}

run_dialog_menu() {
log "INFO" "Launching TUI menu"
command -v dialog >/dev/null 2>&1 || err 100

while true; do
local opts=(1 "Initial Setup" 2 "Load Modules" 3 "Env Setup" 4 "Exit")
[[ ! -f .env ]] && opts[3]="Load Modules [disabled]"

local choice
choice=$(dialog --backtitle "Build Toolset" --title "Main Menu" \
--menu "Choose an action:" 15 60 6 "${opts[@]}" 3>&1 1>&2 2>&3) || break
clear

case "$choice" in
1) initial_setup ;;
2) check_env_present && load_modules || dialog --msgbox "Run Env Setup first." 7 40 ;;
3) setup_env ;;
4) break ;;
*) err 102 "$choice" ;;
esac

read -p "Press Enter to continue..." _
done
}

main() {
log "INFO" "Invoked with args: $*"
[[ $# -eq 0 ]] && usage && exit 0

local norm=()
for arg in "$@"; do
case "$arg" in
--env|env) norm+=("env") ;;
--modules|modules)norm+=("modules") ;;
--init|init) norm+=("init") ;;
--dialog|dialog) norm+=("dialog") ;;
--help|help|-h) usage; exit 0 ;;
*) err 102 "$arg" ;;
esac
done

# Deduplicate and enforce order env→modules→init→dialog
local seen_env=0 seen_mod=0 seen_init=0
local cmds=()
for arg in "${norm[@]}"; do
case "$arg" in
env) (( seen_env++ == 0 )) && cmds+=("env") ;;
modules) (( seen_mod++ == 0 )) && cmds+=("modules") ;;
init) (( seen_init++ == 0 )) && cmds+=("init") ;;
dialog) cmds+=("dialog") ;;
esac
done

# Validate monotonic sequence
local order="env modules init dialog"
local last=0
for cmd in "${cmds[@]}"; do
local idx=$(echo "$order" | tr ' ' '\n' | grep -nx "^$cmd$" | cut -d: -f1)
(( idx >= last )) || err 106
last=$idx
done

for cmd in "${cmds[@]}"; do
log "INFO" "Executing: $cmd"
case "$cmd" in
env) setup_env ;;
modules) load_modules ;;
init) initial_setup ;;
dialog) run_dialog_menu ;;
esac
done

log "INFO" "All requested commands complete"
}

main "$@"
Loading