Compare commits
7 Commits
v3.0.1
...
v3.1.2-pre
| Author | SHA1 | Date | |
|---|---|---|---|
| 5f4f3ecbc3 | |||
| 806f81c6a0 | |||
| 88e353eec6 | |||
| 80ff1b1230 | |||
| 1075335497 | |||
| eafb5207a4 | |||
| 9969e0f703 |
20
changelog.md
20
changelog.md
@@ -1,5 +1,25 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-03-28 - 3.1.2 - fix(cli/ups-handler)
|
||||
Improve UPS device listing table formatting for better column alignment
|
||||
|
||||
- Adjusted header spacing for the Host column and overall table alignment in the UPS handler output.
|
||||
|
||||
## 2025-03-28 - 3.1.1 - fix(cli)
|
||||
Improve table header formatting in group and UPS listings
|
||||
|
||||
- Adjusted column padding in group listing for proper alignment
|
||||
- Fixed UPS table header spacing for consistent CLI output
|
||||
|
||||
## 2025-03-28 - 3.1.0 - feat(cli)
|
||||
Refactor CLI commands to use dedicated handlers for UPS, group, and service management
|
||||
|
||||
- Extracted UPS-related CLI logic into a new UpsHandler
|
||||
- Introduced GroupHandler to manage UPS groups commands
|
||||
- Added ServiceHandler for systemd service operations
|
||||
- Updated CLI routing in cli.ts to delegate commands to the new handlers
|
||||
- Exposed getters for the new handlers in the Nupst class
|
||||
|
||||
## 2025-03-28 - 3.0.1 - fix(cli)
|
||||
Simplify UPS ID generation by removing the redundant promptForUniqueUpsId function in the CLI module and replacing it with the shortId helper.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@serve.zone/nupst",
|
||||
"version": "3.0.1",
|
||||
"version": "3.1.2",
|
||||
"description": "Node.js UPS Shutdown Tool for SNMP-enabled UPS devices",
|
||||
"main": "dist/index.js",
|
||||
"bin": {
|
||||
|
||||
566
readme.plan.md
Normal file
566
readme.plan.md
Normal file
@@ -0,0 +1,566 @@
|
||||
# NUPST Migration Plan: Node.js → Deno v4.0.0
|
||||
|
||||
**Migration Goal**: Convert NUPST from Node.js to Deno with single-executable distribution
|
||||
**Version**: 3.1.2 → 4.0.0 (breaking changes)
|
||||
**Platforms**: Linux x64/ARM64, macOS x64/ARM64, Windows x64
|
||||
|
||||
---
|
||||
|
||||
## Phase 0: Planning & Preparation
|
||||
|
||||
- [x] Research Deno compilation targets and npm: specifier support
|
||||
- [x] Analyze current codebase structure and dependencies
|
||||
- [x] Define CLI command structure simplification
|
||||
- [x] Create detailed migration task list
|
||||
- [ ] Create feature branch: `migration/deno-v4`
|
||||
- [ ] Backup current working state with git tag: `v3.1.2-pre-deno-migration`
|
||||
|
||||
---
|
||||
|
||||
## Phase 1: Dependency Migration (4-6 hours)
|
||||
|
||||
### 1.1 Analyze Current Dependencies
|
||||
- [ ] List all production dependencies from `package.json`
|
||||
- Current: `net-snmp@3.20.0`
|
||||
- [ ] List all dev dependencies to be removed
|
||||
- `@git.zone/tsbuild`, `@git.zone/tsrun`, `@git.zone/tstest`, `@push.rocks/qenv`, `@push.rocks/tapbundle`, `@types/node`
|
||||
- [ ] Identify Node.js built-in module usage
|
||||
- `child_process` (execSync)
|
||||
- `https` (for version checking)
|
||||
- `fs` (readFileSync, writeFileSync, existsSync, mkdirSync)
|
||||
- `path` (join, dirname, resolve)
|
||||
|
||||
### 1.2 Create Deno Configuration
|
||||
- [ ] Create `deno.json` with project configuration
|
||||
```json
|
||||
{
|
||||
"name": "@serve.zone/nupst",
|
||||
"version": "4.0.0",
|
||||
"exports": "./mod.ts",
|
||||
"tasks": {
|
||||
"dev": "deno run --allow-all mod.ts",
|
||||
"compile": "deno task compile:all",
|
||||
"compile:all": "bash scripts/compile-all.sh",
|
||||
"test": "deno test --allow-all tests/",
|
||||
"check": "deno check mod.ts"
|
||||
},
|
||||
"lint": {
|
||||
"rules": {
|
||||
"tags": ["recommended"]
|
||||
}
|
||||
},
|
||||
"fmt": {
|
||||
"useTabs": false,
|
||||
"lineWidth": 100,
|
||||
"indentWidth": 2,
|
||||
"semiColons": true
|
||||
},
|
||||
"compilerOptions": {
|
||||
"lib": ["deno.window"],
|
||||
"strict": true
|
||||
},
|
||||
"imports": {
|
||||
"@std/cli": "jsr:@std/cli@^1.0.0",
|
||||
"@std/fmt": "jsr:@std/fmt@^1.0.0",
|
||||
"@std/path": "jsr:@std/path@^1.0.0"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### 1.3 Update Import Statements
|
||||
- [ ] `ts/snmp/manager.ts`: Change `import * as snmp from 'net-snmp'` to `import * as snmp from "npm:net-snmp@3.20.0"`
|
||||
- [ ] `ts/cli.ts`: Change `import { execSync } from 'child_process'` to `import { execSync } from "node:child_process"`
|
||||
- [ ] `ts/nupst.ts`: Change `import * as https from 'https'` to `import * as https from "node:https"`
|
||||
- [ ] Search for all `fs` imports and update to `node:fs`
|
||||
- [ ] Search for all `path` imports and update to `node:path`
|
||||
- [ ] Update all relative imports to use `.ts` extension instead of `.js`
|
||||
- Example: `'./nupst.js'` → `'./nupst.ts'`
|
||||
|
||||
### 1.4 Test npm: Specifier Compatibility
|
||||
- [ ] Create test file: `tests/snmp_compatibility_test.ts`
|
||||
- [ ] Test SNMP v1 connection with npm:net-snmp
|
||||
- [ ] Test SNMP v2c connection with npm:net-snmp
|
||||
- [ ] Test SNMP v3 connection with npm:net-snmp
|
||||
- [ ] Verify native addon loading works in compiled binary
|
||||
|
||||
---
|
||||
|
||||
## Phase 2: Code Structure Refactoring (3-4 hours)
|
||||
|
||||
### 2.1 Create Main Entry Point
|
||||
- [ ] Create `mod.ts` as main Deno entry point:
|
||||
```typescript
|
||||
#!/usr/bin/env -S deno run --allow-all
|
||||
|
||||
/**
|
||||
* NUPST - UPS Shutdown Tool for Deno
|
||||
*
|
||||
* Required Permissions:
|
||||
* --allow-net: SNMP communication with UPS devices
|
||||
* --allow-read: Configuration file access (/etc/nupst/config.json)
|
||||
* --allow-write: Configuration file updates
|
||||
* --allow-run: System commands (systemctl, shutdown)
|
||||
* --allow-sys: System information (hostname, OS info)
|
||||
* --allow-env: Environment variables
|
||||
*/
|
||||
|
||||
import { NupstCli } from './ts/cli.ts';
|
||||
|
||||
const cli = new NupstCli();
|
||||
await cli.parseAndExecute(Deno.args);
|
||||
```
|
||||
|
||||
### 2.2 Update All Import Extensions
|
||||
Files to update (change .js → .ts in imports):
|
||||
- [ ] `ts/index.ts`
|
||||
- [ ] `ts/cli.ts` (imports from ./nupst.js, ./logger.js)
|
||||
- [ ] `ts/nupst.ts` (imports from ./snmp/manager.js, ./daemon.js, etc.)
|
||||
- [ ] `ts/daemon.ts` (imports from ./snmp/manager.js, ./logger.js, ./helpers/)
|
||||
- [ ] `ts/systemd.ts` (imports from ./daemon.js, ./logger.js)
|
||||
- [ ] `ts/cli/service-handler.ts`
|
||||
- [ ] `ts/cli/group-handler.ts`
|
||||
- [ ] `ts/cli/ups-handler.ts`
|
||||
- [ ] `ts/snmp/index.ts`
|
||||
- [ ] `ts/snmp/manager.ts` (imports from ./types.js, ./oid-sets.js)
|
||||
- [ ] `ts/snmp/oid-sets.ts` (imports from ./types.js)
|
||||
- [ ] `ts/helpers/index.ts`
|
||||
- [ ] `ts/logger.ts`
|
||||
|
||||
### 2.3 Update process.argv References
|
||||
- [ ] `ts/cli.ts`: Replace `process.argv` with `Deno.args` (adjust indexing: process.argv[2] → Deno.args[0])
|
||||
- [ ] Update parseAndExecute method to work with Deno.args (0-indexed vs 2-indexed)
|
||||
|
||||
### 2.4 Update File System Operations
|
||||
- [ ] Search for `fs.readFileSync()` → Consider using `Deno.readTextFile()` or keep node:fs
|
||||
- [ ] Search for `fs.writeFileSync()` → Consider using `Deno.writeTextFile()` or keep node:fs
|
||||
- [ ] Search for `fs.existsSync()` → Keep node:fs or use Deno.stat
|
||||
- [ ] Search for `fs.mkdirSync()` → Keep node:fs or use Deno.mkdir
|
||||
- [ ] Decision: Keep node:fs for consistency or migrate to Deno APIs?
|
||||
|
||||
### 2.5 Update Path Operations
|
||||
- [ ] Verify all `path.join()`, `path.resolve()`, `path.dirname()` work with node:path
|
||||
- [ ] Consider using `@std/path` from JSR for better Deno integration
|
||||
|
||||
### 2.6 Handle __dirname and __filename
|
||||
- [ ] Find all `__dirname` usage
|
||||
- [ ] Replace with `import.meta.dirname` (Deno) or `dirname(fromFileUrl(import.meta.url))`
|
||||
- [ ] Find all `__filename` usage
|
||||
- [ ] Replace with `import.meta.filename` or `fromFileUrl(import.meta.url)`
|
||||
|
||||
---
|
||||
|
||||
## Phase 3: CLI Command Simplification (3-4 hours)
|
||||
|
||||
### 3.1 Design New Command Structure
|
||||
Current → New mapping:
|
||||
```
|
||||
OLD NEW
|
||||
=== ===
|
||||
nupst enable → nupst service enable
|
||||
nupst disable → nupst service disable
|
||||
nupst daemon-start → nupst service start-daemon
|
||||
nupst logs → nupst service logs
|
||||
nupst stop → nupst service stop
|
||||
nupst start → nupst service start
|
||||
nupst status → nupst service status
|
||||
|
||||
nupst add → nupst ups add
|
||||
nupst edit [id] → nupst ups edit [id]
|
||||
nupst delete <id> → nupst ups remove <id>
|
||||
nupst list → nupst ups list
|
||||
nupst setup → nupst ups edit (removed alias)
|
||||
nupst test → nupst ups test
|
||||
|
||||
nupst group list → nupst group list
|
||||
nupst group add → nupst group add
|
||||
nupst group edit <id> → nupst group edit <id>
|
||||
nupst group delete <id> → nupst group remove <id>
|
||||
|
||||
nupst config → nupst config show
|
||||
nupst update → nupst update
|
||||
nupst uninstall → nupst uninstall
|
||||
nupst help → nupst help / nupst --help
|
||||
(new) → nupst --version
|
||||
```
|
||||
|
||||
### 3.2 Update CLI Parser (ts/cli.ts)
|
||||
- [ ] Refactor `parseAndExecute()` to handle new command structure
|
||||
- [ ] Add `service` subcommand handler
|
||||
- [ ] Add `ups` subcommand handler
|
||||
- [ ] Keep `group` subcommand handler (already exists, just update delete→remove)
|
||||
- [ ] Add `config` subcommand handler with `show` default
|
||||
- [ ] Add `--version` flag handler
|
||||
- [ ] Update `help` command to show new structure
|
||||
- [ ] Add command aliases: `rm` → `remove`, `ls` → `list`
|
||||
- [ ] Add `--json` flag for machine-readable output (future enhancement)
|
||||
|
||||
### 3.3 Update Command Handlers
|
||||
- [ ] `ts/cli/service-handler.ts`: Update method names if needed
|
||||
- [ ] `ts/cli/ups-handler.ts`: Rename `delete()` → `remove()`, remove `setup` method
|
||||
- [ ] `ts/cli/group-handler.ts`: Rename `delete()` → `remove()`
|
||||
|
||||
### 3.4 Improve Help Messages
|
||||
- [ ] Update `showHelp()` in ts/cli.ts with new command structure
|
||||
- [ ] Update `showGroupHelp()` in ts/cli.ts
|
||||
- [ ] Add `showServiceHelp()` method
|
||||
- [ ] Add `showUpsHelp()` method
|
||||
- [ ] Add `showConfigHelp()` method
|
||||
- [ ] Include usage examples in help text
|
||||
|
||||
### 3.5 Add Version Command
|
||||
- [ ] Read version from deno.json
|
||||
- [ ] Create `--version` handler in CLI
|
||||
- [ ] Display version with build info
|
||||
|
||||
---
|
||||
|
||||
## Phase 4: Compilation & Distribution (2-3 hours)
|
||||
|
||||
### 4.1 Create Compilation Script
|
||||
- [ ] Create directory: `scripts/`
|
||||
- [ ] Create `scripts/compile-all.sh`:
|
||||
```bash
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
VERSION=$(cat deno.json | jq -r '.version')
|
||||
BINARY_DIR="dist/binaries"
|
||||
|
||||
echo "Compiling NUPST v${VERSION} for all platforms..."
|
||||
mkdir -p "$BINARY_DIR"
|
||||
|
||||
# Linux x86_64
|
||||
echo "→ Linux x86_64..."
|
||||
deno compile --allow-all --output "$BINARY_DIR/nupst-linux-x64" \
|
||||
--target x86_64-unknown-linux-gnu mod.ts
|
||||
|
||||
# Linux ARM64
|
||||
echo "→ Linux ARM64..."
|
||||
deno compile --allow-all --output "$BINARY_DIR/nupst-linux-arm64" \
|
||||
--target aarch64-unknown-linux-gnu mod.ts
|
||||
|
||||
# macOS x86_64
|
||||
echo "→ macOS x86_64..."
|
||||
deno compile --allow-all --output "$BINARY_DIR/nupst-macos-x64" \
|
||||
--target x86_64-apple-darwin mod.ts
|
||||
|
||||
# macOS ARM64
|
||||
echo "→ macOS ARM64..."
|
||||
deno compile --allow-all --output "$BINARY_DIR/nupst-macos-arm64" \
|
||||
--target aarch64-apple-darwin mod.ts
|
||||
|
||||
# Windows x86_64
|
||||
echo "→ Windows x86_64..."
|
||||
deno compile --allow-all --output "$BINARY_DIR/nupst-windows-x64.exe" \
|
||||
--target x86_64-pc-windows-msvc mod.ts
|
||||
|
||||
echo ""
|
||||
echo "✓ Compilation complete!"
|
||||
ls -lh "$BINARY_DIR/"
|
||||
```
|
||||
- [ ] Make script executable: `chmod +x scripts/compile-all.sh`
|
||||
|
||||
### 4.2 Test Local Compilation
|
||||
- [ ] Run `deno task compile` to compile for all platforms
|
||||
- [ ] Verify all 5 binaries are created
|
||||
- [ ] Check binary sizes (should be reasonable, < 100MB each)
|
||||
- [ ] Test local binary on current platform: `./dist/binaries/nupst-linux-x64 --version`
|
||||
|
||||
### 4.3 Update Installation Scripts
|
||||
- [ ] Update `install.sh`:
|
||||
- Remove Node.js download logic (lines dealing with vendor/node-*)
|
||||
- Add detection for binary download from GitHub releases
|
||||
- Simplify to download appropriate binary based on OS/arch
|
||||
- Place binary in `/opt/nupst/bin/nupst`
|
||||
- Create symlink: `/usr/local/bin/nupst → /opt/nupst/bin/nupst`
|
||||
- Update to v4.0.0 in script
|
||||
- [ ] Simplify or remove `setup.sh` (no longer needed without Node.js)
|
||||
- [ ] Update `bin/nupst` launcher:
|
||||
- Option A: Keep as simple wrapper
|
||||
- Option B: Remove and symlink directly to binary
|
||||
- [ ] Update `uninstall.sh`:
|
||||
- Remove vendor directory cleanup
|
||||
- Update paths to new binary location
|
||||
|
||||
### 4.4 Update Systemd Service
|
||||
- [ ] Update systemd service file path in `ts/systemd.ts`
|
||||
- [ ] Verify ExecStart points to correct binary location: `/opt/nupst/bin/nupst daemon-start`
|
||||
- [ ] Remove Node.js environment variables if any
|
||||
- [ ] Test service installation and startup
|
||||
|
||||
---
|
||||
|
||||
## Phase 5: Testing & Validation (4-6 hours)
|
||||
|
||||
### 5.1 Create Deno Test Suite
|
||||
- [ ] Create `tests/` directory (or migrate from existing `test/`)
|
||||
- [ ] Create `tests/snmp_test.ts`: Test SNMP manager functionality
|
||||
- [ ] Create `tests/config_test.ts`: Test configuration loading/saving
|
||||
- [ ] Create `tests/cli_test.ts`: Test CLI parsing and command routing
|
||||
- [ ] Create `tests/daemon_test.ts`: Test daemon logic
|
||||
- [ ] Remove dependency on @git.zone/tstest and @push.rocks/tapbundle
|
||||
- [ ] Use Deno's built-in test runner (`Deno.test()`)
|
||||
|
||||
### 5.2 Unit Tests
|
||||
- [ ] Test SNMP connection with mock responses
|
||||
- [ ] Test configuration validation
|
||||
- [ ] Test UPS status parsing for different models
|
||||
- [ ] Test group logic (redundant/non-redundant modes)
|
||||
- [ ] Test threshold checking
|
||||
- [ ] Test version comparison logic
|
||||
|
||||
### 5.3 Integration Tests
|
||||
- [ ] Test CLI command parsing for all commands
|
||||
- [ ] Test config file creation and updates
|
||||
- [ ] Test UPS add/edit/remove operations
|
||||
- [ ] Test group add/edit/remove operations
|
||||
- [ ] Mock systemd operations for testing
|
||||
|
||||
### 5.4 Binary Testing
|
||||
- [ ] Test compiled binary on Linux x64
|
||||
- [ ] Test compiled binary on Linux ARM64 (if available)
|
||||
- [ ] Test compiled binary on macOS x64 (if available)
|
||||
- [ ] Test compiled binary on macOS ARM64 (if available)
|
||||
- [ ] Test compiled binary on Windows x64 (if available)
|
||||
- [ ] Verify SNMP functionality works in compiled binary
|
||||
- [ ] Verify config file operations work in compiled binary
|
||||
- [ ] Test systemd integration with compiled binary
|
||||
|
||||
### 5.5 Performance Testing
|
||||
- [ ] Measure binary size for each platform
|
||||
- [ ] Measure startup time: `time ./nupst-linux-x64 --version`
|
||||
- [ ] Measure memory footprint during daemon operation
|
||||
- [ ] Compare with Node.js version performance
|
||||
- [ ] Document performance metrics
|
||||
|
||||
### 5.6 Upgrade Path Testing
|
||||
- [ ] Create test with v3.x config
|
||||
- [ ] Verify v4.x can read existing config
|
||||
- [ ] Test migration from old commands to new commands
|
||||
- [ ] Verify systemd service upgrade path
|
||||
|
||||
---
|
||||
|
||||
## Phase 6: Distribution Strategy (2-3 hours)
|
||||
|
||||
### 6.1 GitHub Actions Workflow
|
||||
- [ ] Create `.github/workflows/release.yml`:
|
||||
```yaml
|
||||
name: Release
|
||||
on:
|
||||
push:
|
||||
tags:
|
||||
- 'v*'
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- uses: denoland/setup-deno@v1
|
||||
with:
|
||||
deno-version: v1.x
|
||||
- name: Compile binaries
|
||||
run: deno task compile
|
||||
- name: Generate checksums
|
||||
run: |
|
||||
cd dist/binaries
|
||||
sha256sum * > SHA256SUMS
|
||||
- name: Create Release
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
files: dist/binaries/*
|
||||
generate_release_notes: true
|
||||
```
|
||||
|
||||
### 6.2 Update package.json for npm
|
||||
- [ ] Update version to 4.0.0
|
||||
- [ ] Update description to mention Deno
|
||||
- [ ] Add postinstall script to symlink appropriate binary:
|
||||
```json
|
||||
{
|
||||
"name": "@serve.zone/nupst",
|
||||
"version": "4.0.0",
|
||||
"description": "UPS Shutdown Tool - Deno-based single executable",
|
||||
"bin": {
|
||||
"nupst": "bin/nupst-npm-wrapper.js"
|
||||
},
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"postinstall": "node bin/setup-npm-binary.js"
|
||||
},
|
||||
"files": [
|
||||
"dist/binaries/*",
|
||||
"bin/*"
|
||||
]
|
||||
}
|
||||
```
|
||||
- [ ] Create `bin/setup-npm-binary.js` to symlink correct binary
|
||||
- [ ] Create `bin/nupst-npm-wrapper.js` as entry point
|
||||
|
||||
### 6.3 Verify Distribution Methods
|
||||
- [ ] Test GitHub release download and installation
|
||||
- [ ] Test npm install from tarball
|
||||
- [ ] Test direct install.sh script
|
||||
- [ ] Verify all methods create working installation
|
||||
|
||||
---
|
||||
|
||||
## Phase 7: Documentation Updates (2-3 hours)
|
||||
|
||||
### 7.1 Update README.md
|
||||
- [ ] Remove Node.js requirements section
|
||||
- [ ] Update features list (mention Deno, single executable)
|
||||
- [ ] Update installation methods:
|
||||
- Method 1: Quick install script (updated)
|
||||
- Method 2: GitHub releases (new)
|
||||
- Method 3: npm (updated with notes)
|
||||
- [ ] Update usage section with new command structure
|
||||
- [ ] Add command mapping table (v3 → v4)
|
||||
- [ ] Update platform support matrix (note: no Windows ARM)
|
||||
- [ ] Update "System Changes" section (no vendor directory)
|
||||
- [ ] Update security section (remove Node.js mentions)
|
||||
- [ ] Update uninstallation instructions
|
||||
|
||||
### 7.2 Create MIGRATION.md
|
||||
- [ ] Create detailed migration guide from v3.x to v4.x
|
||||
- [ ] List all breaking changes:
|
||||
1. CLI command structure reorganization
|
||||
2. No Node.js requirement
|
||||
3. Windows ARM not supported
|
||||
4. Installation path changes
|
||||
- [ ] Provide command mapping table
|
||||
- [ ] Explain config compatibility
|
||||
- [ ] Document upgrade procedure
|
||||
- [ ] Add rollback instructions
|
||||
|
||||
### 7.3 Update CHANGELOG.md
|
||||
- [ ] Add v4.0.0 section with all breaking changes
|
||||
- [ ] List new features (Deno, single executable)
|
||||
- [ ] List improvements (startup time, binary size)
|
||||
- [ ] List removed features (Windows ARM, setup command alias)
|
||||
- [ ] Migration guide reference
|
||||
|
||||
### 7.4 Update Help Text
|
||||
- [ ] Ensure all help commands show new structure
|
||||
- [ ] Add examples for common operations
|
||||
- [ ] Include migration notes in help output
|
||||
|
||||
---
|
||||
|
||||
## Phase 8: Cleanup & Finalization (1 hour)
|
||||
|
||||
### 8.1 Remove Obsolete Files
|
||||
- [ ] Delete `vendor/` directory (Node.js binaries)
|
||||
- [ ] Delete `dist/` directory (old compiled JS)
|
||||
- [ ] Delete `dist_ts/` directory (old compiled TS)
|
||||
- [ ] Delete `node_modules/` directory
|
||||
- [ ] Remove or update `tsconfig.json` (decide if needed for npm compatibility)
|
||||
- [ ] Remove `setup.sh` if no longer needed
|
||||
- [ ] Remove old test files in `test/` if migrated to `tests/`
|
||||
- [ ] Delete `pnpm-lock.yaml`
|
||||
|
||||
### 8.2 Update Git Configuration
|
||||
- [ ] Update `.gitignore`:
|
||||
```
|
||||
# Deno
|
||||
.deno/
|
||||
deno.lock
|
||||
|
||||
# Compiled binaries
|
||||
dist/binaries/
|
||||
|
||||
# Old Node.js artifacts (to be removed)
|
||||
node_modules/
|
||||
vendor/
|
||||
dist/
|
||||
dist_ts/
|
||||
pnpm-lock.yaml
|
||||
```
|
||||
- [ ] Add `deno.lock` to version control
|
||||
- [ ] Create `.denoignore` if needed
|
||||
|
||||
### 8.3 Final Validation
|
||||
- [ ] Run `deno check mod.ts` - verify no type errors
|
||||
- [ ] Run `deno lint` - verify code quality
|
||||
- [ ] Run `deno fmt --check` - verify formatting
|
||||
- [ ] Run `deno task test` - verify all tests pass
|
||||
- [ ] Run `deno task compile` - verify all binaries compile
|
||||
- [ ] Test each binary manually
|
||||
|
||||
### 8.4 Prepare for Release
|
||||
- [ ] Create git tag: `v4.0.0`
|
||||
- [ ] Push to main branch
|
||||
- [ ] Push tags to trigger release workflow
|
||||
- [ ] Verify GitHub Actions workflow succeeds
|
||||
- [ ] Verify binaries are attached to release
|
||||
- [ ] Test installation from GitHub release
|
||||
- [ ] Publish to npm: `npm publish`
|
||||
- [ ] Test npm installation
|
||||
|
||||
---
|
||||
|
||||
## Rollback Strategy
|
||||
|
||||
If critical issues are discovered:
|
||||
- [ ] Keep `v3.1.2` tag available for rollback
|
||||
- [ ] Create `v3-stable` branch for continued v3 maintenance
|
||||
- [ ] Update install.sh to offer v3/v4 choice
|
||||
- [ ] Document known issues in GitHub Issues
|
||||
- [ ] Provide downgrade instructions in docs
|
||||
|
||||
---
|
||||
|
||||
## Success Criteria Checklist
|
||||
|
||||
- [ ] ✅ All 5 platform binaries compile successfully
|
||||
- [ ] ✅ Binary sizes are reasonable (< 100MB per platform)
|
||||
- [ ] ✅ Startup time < 2 seconds
|
||||
- [ ] ✅ SNMP v1/v2c/v3 functionality verified on real UPS device
|
||||
- [ ] ✅ All CLI commands work with new structure
|
||||
- [ ] ✅ Config file compatibility maintained
|
||||
- [ ] ✅ Systemd integration works on Linux
|
||||
- [ ] ✅ Installation scripts work on fresh systems
|
||||
- [ ] ✅ npm package still installable and functional
|
||||
- [ ] ✅ All tests pass
|
||||
- [ ] ✅ Documentation is complete and accurate
|
||||
- [ ] ✅ GitHub release created with binaries
|
||||
- [ ] ✅ Migration guide tested by following it step-by-step
|
||||
|
||||
---
|
||||
|
||||
## Timeline
|
||||
|
||||
- **Phase 0**: 1 hour ✓ (in progress)
|
||||
- **Phase 1**: 4-6 hours
|
||||
- **Phase 2**: 3-4 hours
|
||||
- **Phase 3**: 3-4 hours
|
||||
- **Phase 4**: 2-3 hours
|
||||
- **Phase 5**: 4-6 hours
|
||||
- **Phase 6**: 2-3 hours
|
||||
- **Phase 7**: 2-3 hours
|
||||
- **Phase 8**: 1 hour
|
||||
|
||||
**Total Estimate**: 22-31 hours
|
||||
|
||||
---
|
||||
|
||||
## Notes & Decisions
|
||||
|
||||
### Key Decisions Made:
|
||||
1. ✅ Use npm:net-snmp (no pure Deno SNMP library available)
|
||||
2. ✅ Major version bump to 4.0.0 (breaking changes)
|
||||
3. ✅ CLI reorganization with subcommands
|
||||
4. ✅ Keep npm publishing alongside binary distribution
|
||||
5. ✅ 5 platform targets (Windows ARM not supported by Deno yet)
|
||||
|
||||
### Open Questions:
|
||||
- [ ] Should we keep tsconfig.json for npm package compatibility?
|
||||
- [ ] Should we fully migrate to Deno APIs (Deno.readFile) or keep node:fs?
|
||||
- [ ] Should we remove the `bin/nupst` wrapper or keep it?
|
||||
- [ ] Should setup.sh be completely removed or kept for dependencies?
|
||||
|
||||
### Risk Areas:
|
||||
- ⚠️ SNMP native addon compatibility in compiled binaries (HIGH PRIORITY TO TEST)
|
||||
- ⚠️ Systemd integration with new binary structure
|
||||
- ⚠️ Config migration from v3 to v4
|
||||
- ⚠️ npm package installation with embedded binaries
|
||||
@@ -3,6 +3,6 @@
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@serve.zone/nupst',
|
||||
version: '3.0.1',
|
||||
version: '3.1.2',
|
||||
description: 'Node.js UPS Shutdown Tool for SNMP-enabled UPS devices'
|
||||
}
|
||||
|
||||
565
ts/cli/group-handler.ts
Normal file
565
ts/cli/group-handler.ts
Normal file
@@ -0,0 +1,565 @@
|
||||
import { Nupst } from '../nupst.js';
|
||||
import { logger } from '../logger.js';
|
||||
import * as helpers from '../helpers/index.js';
|
||||
import { type IGroupConfig } from '../daemon.js';
|
||||
|
||||
/**
|
||||
* Class for handling group-related CLI commands
|
||||
* Provides interface for managing UPS groups
|
||||
*/
|
||||
export class GroupHandler {
|
||||
private readonly nupst: Nupst;
|
||||
|
||||
/**
|
||||
* Create a new Group handler
|
||||
* @param nupst Reference to the main Nupst instance
|
||||
*/
|
||||
constructor(nupst: Nupst) {
|
||||
this.nupst = nupst;
|
||||
}
|
||||
|
||||
/**
|
||||
* List all UPS groups
|
||||
*/
|
||||
public async list(): Promise<void> {
|
||||
try {
|
||||
// Try to load configuration
|
||||
try {
|
||||
await this.nupst.getDaemon().loadConfig();
|
||||
} catch (error) {
|
||||
const errorBoxWidth = 45;
|
||||
logger.logBoxTitle('Configuration Error', errorBoxWidth);
|
||||
logger.logBoxLine('No configuration found.');
|
||||
logger.logBoxLine("Please run 'nupst setup' first to create a configuration.");
|
||||
logger.logBoxEnd();
|
||||
return;
|
||||
}
|
||||
|
||||
// Get current configuration
|
||||
const config = this.nupst.getDaemon().getConfig();
|
||||
|
||||
// Check if multi-UPS config
|
||||
if (!config.groups || !Array.isArray(config.groups)) {
|
||||
// Legacy or missing groups configuration
|
||||
const boxWidth = 45;
|
||||
logger.logBoxTitle('UPS Groups', boxWidth);
|
||||
logger.logBoxLine('No groups configured.');
|
||||
logger.logBoxLine('Use "nupst group add" to add a UPS group.');
|
||||
logger.logBoxEnd();
|
||||
return;
|
||||
}
|
||||
|
||||
// Display group list
|
||||
const boxWidth = 60;
|
||||
logger.logBoxTitle('UPS Groups', boxWidth);
|
||||
|
||||
if (config.groups.length === 0) {
|
||||
logger.logBoxLine('No UPS groups configured.');
|
||||
logger.logBoxLine('Use "nupst group add" to add a UPS group.');
|
||||
} else {
|
||||
logger.logBoxLine(`Found ${config.groups.length} group(s)`);
|
||||
logger.logBoxLine('');
|
||||
logger.logBoxLine('ID | Name | Mode | UPS Devices');
|
||||
logger.logBoxLine('-----------+----------------------+--------------+----------------');
|
||||
|
||||
for (const group of config.groups) {
|
||||
const id = group.id.padEnd(10, ' ').substring(0, 10);
|
||||
const name = (group.name || '').padEnd(20, ' ').substring(0, 20);
|
||||
const mode = (group.mode || 'unknown').padEnd(12, ' ').substring(0, 12);
|
||||
|
||||
// Count UPS devices in this group
|
||||
const upsInGroup = config.upsDevices.filter(ups => ups.groups.includes(group.id));
|
||||
const upsCount = upsInGroup.length;
|
||||
const upsNames = upsInGroup.map(ups => ups.name).join(', ');
|
||||
|
||||
logger.logBoxLine(`${id} | ${name} | ${mode} | ${upsCount > 0 ? upsNames : 'None'}`);
|
||||
}
|
||||
}
|
||||
|
||||
logger.logBoxEnd();
|
||||
} catch (error) {
|
||||
logger.error(`Failed to list UPS groups: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a new UPS group
|
||||
*/
|
||||
public async add(): Promise<void> {
|
||||
try {
|
||||
// Import readline module for user input
|
||||
const readline = await import('readline');
|
||||
|
||||
const rl = readline.createInterface({
|
||||
input: process.stdin,
|
||||
output: process.stdout,
|
||||
});
|
||||
|
||||
// Helper function to prompt for input
|
||||
const prompt = (question: string): Promise<string> => {
|
||||
return new Promise((resolve) => {
|
||||
rl.question(question, (answer: string) => {
|
||||
resolve(answer);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
try {
|
||||
// Try to load configuration
|
||||
try {
|
||||
await this.nupst.getDaemon().loadConfig();
|
||||
} catch (error) {
|
||||
logger.error('No configuration found. Please run "nupst setup" first to create a configuration.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Get current configuration
|
||||
const config = this.nupst.getDaemon().getConfig();
|
||||
|
||||
// Initialize groups array if not exists
|
||||
if (!config.groups) {
|
||||
config.groups = [];
|
||||
}
|
||||
|
||||
// Check if upsDevices is initialized
|
||||
if (!config.upsDevices) {
|
||||
config.upsDevices = [];
|
||||
}
|
||||
|
||||
logger.log('\nNUPST Add Group');
|
||||
logger.log('==============\n');
|
||||
logger.log('This will guide you through creating a new UPS group.\n');
|
||||
|
||||
// Generate a new unique group ID
|
||||
const groupId = helpers.shortId();
|
||||
|
||||
// Get group name
|
||||
const name = await prompt('Group Name: ');
|
||||
|
||||
// Get group mode
|
||||
const modeInput = await prompt('Group Mode (redundant/nonRedundant) [redundant]: ');
|
||||
const mode = modeInput.toLowerCase() === 'nonredundant' ? 'nonRedundant' : 'redundant';
|
||||
|
||||
// Get optional description
|
||||
const description = await prompt('Group Description (optional): ');
|
||||
|
||||
// Create the new group
|
||||
const newGroup: IGroupConfig = {
|
||||
id: groupId,
|
||||
name: name || `Group-${groupId}`,
|
||||
mode,
|
||||
description: description || undefined
|
||||
};
|
||||
|
||||
// Add the group to the configuration
|
||||
config.groups.push(newGroup);
|
||||
|
||||
// Save the configuration
|
||||
await this.nupst.getDaemon().saveConfig(config);
|
||||
|
||||
// Display summary
|
||||
const boxWidth = 45;
|
||||
logger.logBoxTitle('Group Created', boxWidth);
|
||||
logger.logBoxLine(`ID: ${newGroup.id}`);
|
||||
logger.logBoxLine(`Name: ${newGroup.name}`);
|
||||
logger.logBoxLine(`Mode: ${newGroup.mode}`);
|
||||
if (newGroup.description) {
|
||||
logger.logBoxLine(`Description: ${newGroup.description}`);
|
||||
}
|
||||
logger.logBoxEnd();
|
||||
|
||||
// Check if there are UPS devices to assign to this group
|
||||
if (config.upsDevices.length > 0) {
|
||||
const assignUps = await prompt('Would you like to assign UPS devices to this group now? (y/N): ');
|
||||
if (assignUps.toLowerCase() === 'y') {
|
||||
await this.assignUpsToGroup(newGroup.id, config, prompt);
|
||||
|
||||
// Save again after assigning UPS devices
|
||||
await this.nupst.getDaemon().saveConfig(config);
|
||||
}
|
||||
}
|
||||
|
||||
// Check if service is running and restart it if needed
|
||||
this.nupst.getUpsHandler().restartServiceIfRunning();
|
||||
|
||||
logger.log('\nGroup setup complete!');
|
||||
} finally {
|
||||
rl.close();
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error(`Add group error: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit an existing UPS group
|
||||
* @param groupId ID of the group to edit
|
||||
*/
|
||||
public async edit(groupId: string): Promise<void> {
|
||||
try {
|
||||
// Import readline module for user input
|
||||
const readline = await import('readline');
|
||||
|
||||
const rl = readline.createInterface({
|
||||
input: process.stdin,
|
||||
output: process.stdout,
|
||||
});
|
||||
|
||||
// Helper function to prompt for input
|
||||
const prompt = (question: string): Promise<string> => {
|
||||
return new Promise((resolve) => {
|
||||
rl.question(question, (answer: string) => {
|
||||
resolve(answer);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
try {
|
||||
// Try to load configuration
|
||||
try {
|
||||
await this.nupst.getDaemon().loadConfig();
|
||||
} catch (error) {
|
||||
logger.error('No configuration found. Please run "nupst setup" first to create a configuration.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Get current configuration
|
||||
const config = this.nupst.getDaemon().getConfig();
|
||||
|
||||
// Check if groups are initialized
|
||||
if (!config.groups || !Array.isArray(config.groups)) {
|
||||
logger.error('No groups configured. Please run "nupst group add" first to create a group.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Find the group to edit
|
||||
const groupIndex = config.groups.findIndex(group => group.id === groupId);
|
||||
if (groupIndex === -1) {
|
||||
logger.error(`Group with ID "${groupId}" not found.`);
|
||||
return;
|
||||
}
|
||||
|
||||
const group = config.groups[groupIndex];
|
||||
|
||||
logger.log(`\nNUPST Edit Group: ${group.name} (${group.id})`);
|
||||
logger.log('==============================================\n');
|
||||
|
||||
// Edit group name
|
||||
const newName = await prompt(`Group Name [${group.name}]: `);
|
||||
if (newName.trim()) {
|
||||
group.name = newName;
|
||||
}
|
||||
|
||||
// Edit group mode
|
||||
const currentMode = group.mode || 'redundant';
|
||||
const modeInput = await prompt(`Group Mode (redundant/nonRedundant) [${currentMode}]: `);
|
||||
if (modeInput.trim()) {
|
||||
group.mode = modeInput.toLowerCase() === 'nonredundant' ? 'nonRedundant' : 'redundant';
|
||||
}
|
||||
|
||||
// Edit description
|
||||
const currentDesc = group.description || '';
|
||||
const newDesc = await prompt(`Group Description [${currentDesc}]: `);
|
||||
if (newDesc.trim() || newDesc === '') {
|
||||
group.description = newDesc.trim() || undefined;
|
||||
}
|
||||
|
||||
// Update the group in the configuration
|
||||
config.groups[groupIndex] = group;
|
||||
|
||||
// Save the configuration
|
||||
await this.nupst.getDaemon().saveConfig(config);
|
||||
|
||||
// Display summary
|
||||
const boxWidth = 45;
|
||||
logger.logBoxTitle('Group Updated', boxWidth);
|
||||
logger.logBoxLine(`ID: ${group.id}`);
|
||||
logger.logBoxLine(`Name: ${group.name}`);
|
||||
logger.logBoxLine(`Mode: ${group.mode}`);
|
||||
if (group.description) {
|
||||
logger.logBoxLine(`Description: ${group.description}`);
|
||||
}
|
||||
logger.logBoxEnd();
|
||||
|
||||
// Edit UPS assignments if requested
|
||||
const editAssignments = await prompt('Would you like to edit UPS assignments for this group? (y/N): ');
|
||||
if (editAssignments.toLowerCase() === 'y') {
|
||||
await this.assignUpsToGroup(group.id, config, prompt);
|
||||
|
||||
// Save again after editing assignments
|
||||
await this.nupst.getDaemon().saveConfig(config);
|
||||
}
|
||||
|
||||
// Check if service is running and restart it if needed
|
||||
this.nupst.getUpsHandler().restartServiceIfRunning();
|
||||
|
||||
logger.log('\nGroup edit complete!');
|
||||
} finally {
|
||||
rl.close();
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error(`Edit group error: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete an existing UPS group
|
||||
* @param groupId ID of the group to delete
|
||||
*/
|
||||
public async delete(groupId: string): Promise<void> {
|
||||
try {
|
||||
// Try to load configuration
|
||||
try {
|
||||
await this.nupst.getDaemon().loadConfig();
|
||||
} catch (error) {
|
||||
logger.error('No configuration found. Please run "nupst setup" first to create a configuration.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Get current configuration
|
||||
const config = this.nupst.getDaemon().getConfig();
|
||||
|
||||
// Check if groups are initialized
|
||||
if (!config.groups || !Array.isArray(config.groups)) {
|
||||
logger.error('No groups configured.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Find the group to delete
|
||||
const groupIndex = config.groups.findIndex(group => group.id === groupId);
|
||||
if (groupIndex === -1) {
|
||||
logger.error(`Group with ID "${groupId}" not found.`);
|
||||
return;
|
||||
}
|
||||
|
||||
const groupToDelete = config.groups[groupIndex];
|
||||
|
||||
// Get confirmation before deleting
|
||||
const readline = await import('readline');
|
||||
const rl = readline.createInterface({
|
||||
input: process.stdin,
|
||||
output: process.stdout,
|
||||
});
|
||||
|
||||
const confirm = await new Promise<string>(resolve => {
|
||||
rl.question(`Are you sure you want to delete group "${groupToDelete.name}" (${groupId})? [y/N]: `, answer => {
|
||||
resolve(answer.toLowerCase());
|
||||
});
|
||||
});
|
||||
|
||||
rl.close();
|
||||
|
||||
if (confirm !== 'y' && confirm !== 'yes') {
|
||||
logger.log('Deletion cancelled.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Remove this group from all UPS device group assignments
|
||||
if (config.upsDevices && Array.isArray(config.upsDevices)) {
|
||||
for (const ups of config.upsDevices) {
|
||||
const groupIndex = ups.groups.indexOf(groupId);
|
||||
if (groupIndex !== -1) {
|
||||
ups.groups.splice(groupIndex, 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Remove the group from the array
|
||||
config.groups.splice(groupIndex, 1);
|
||||
|
||||
// Save the configuration
|
||||
await this.nupst.getDaemon().saveConfig(config);
|
||||
|
||||
logger.log(`Group "${groupToDelete.name}" (${groupId}) has been deleted.`);
|
||||
|
||||
// Check if service is running and restart it if needed
|
||||
this.nupst.getUpsHandler().restartServiceIfRunning();
|
||||
} catch (error) {
|
||||
logger.error(`Failed to delete group: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Assign UPS devices to groups
|
||||
* @param ups UPS configuration to update
|
||||
* @param groups Available groups
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
public async assignUpsToGroups(
|
||||
ups: any,
|
||||
groups: any[],
|
||||
prompt: (question: string) => Promise<string>
|
||||
): Promise<void> {
|
||||
// Initialize groups array if it doesn't exist
|
||||
if (!ups.groups) {
|
||||
ups.groups = [];
|
||||
}
|
||||
|
||||
// Show current group assignments
|
||||
logger.log('\nCurrent Group Assignments:');
|
||||
if (ups.groups && ups.groups.length > 0) {
|
||||
for (const groupId of ups.groups) {
|
||||
const group = groups.find(g => g.id === groupId);
|
||||
if (group) {
|
||||
logger.log(`- ${group.name} (${group.id})`);
|
||||
} else {
|
||||
logger.log(`- Unknown group (${groupId})`);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
logger.log('- None');
|
||||
}
|
||||
|
||||
// Show available groups
|
||||
logger.log('\nAvailable Groups:');
|
||||
if (groups.length === 0) {
|
||||
logger.log('- No groups available. Use "nupst group add" to create groups.');
|
||||
return;
|
||||
}
|
||||
|
||||
for (let i = 0; i < groups.length; i++) {
|
||||
const group = groups[i];
|
||||
const assigned = ups.groups && ups.groups.includes(group.id);
|
||||
logger.log(`${i + 1}) ${group.name} (${group.id}) [${assigned ? 'Assigned' : 'Not Assigned'}]`);
|
||||
}
|
||||
|
||||
// Prompt for group selection
|
||||
const selection = await prompt('\nSelect groups to assign/unassign (comma-separated numbers, or "clear" to remove all): ');
|
||||
|
||||
if (selection.toLowerCase() === 'clear') {
|
||||
// Clear all group assignments
|
||||
ups.groups = [];
|
||||
logger.log('All group assignments cleared.');
|
||||
return;
|
||||
}
|
||||
|
||||
if (!selection.trim()) {
|
||||
// No change if empty input
|
||||
return;
|
||||
}
|
||||
|
||||
// Process selections
|
||||
const selections = selection.split(',').map(s => s.trim());
|
||||
|
||||
for (const sel of selections) {
|
||||
const index = parseInt(sel, 10) - 1;
|
||||
if (isNaN(index) || index < 0 || index >= groups.length) {
|
||||
logger.error(`Invalid selection: ${sel}`);
|
||||
continue;
|
||||
}
|
||||
|
||||
const group = groups[index];
|
||||
|
||||
// Initialize groups array if needed (should already be done above)
|
||||
if (!ups.groups) {
|
||||
ups.groups = [];
|
||||
}
|
||||
|
||||
// Toggle assignment
|
||||
const groupIndex = ups.groups.indexOf(group.id);
|
||||
if (groupIndex === -1) {
|
||||
// Add to group
|
||||
ups.groups.push(group.id);
|
||||
logger.log(`Added to group: ${group.name} (${group.id})`);
|
||||
} else {
|
||||
// Remove from group
|
||||
ups.groups.splice(groupIndex, 1);
|
||||
logger.log(`Removed from group: ${group.name} (${group.id})`);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Assign UPS devices to a specific group
|
||||
* @param groupId Group ID to assign UPS devices to
|
||||
* @param config Full configuration
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
public async assignUpsToGroup(
|
||||
groupId: string,
|
||||
config: any,
|
||||
prompt: (question: string) => Promise<string>
|
||||
): Promise<void> {
|
||||
if (!config.upsDevices || config.upsDevices.length === 0) {
|
||||
logger.log('No UPS devices available. Use "nupst add" to add UPS devices.');
|
||||
return;
|
||||
}
|
||||
|
||||
const group = config.groups.find(g => g.id === groupId);
|
||||
if (!group) {
|
||||
logger.error(`Group with ID "${groupId}" not found.`);
|
||||
return;
|
||||
}
|
||||
|
||||
// Show current assignments
|
||||
logger.log(`\nUPS devices in group "${group.name}" (${group.id}):`);
|
||||
const upsInGroup = config.upsDevices.filter(ups => ups.groups && ups.groups.includes(groupId));
|
||||
if (upsInGroup.length === 0) {
|
||||
logger.log('- None');
|
||||
} else {
|
||||
for (const ups of upsInGroup) {
|
||||
logger.log(`- ${ups.name} (${ups.id})`);
|
||||
}
|
||||
}
|
||||
|
||||
// Show all UPS devices
|
||||
logger.log('\nAvailable UPS devices:');
|
||||
for (let i = 0; i < config.upsDevices.length; i++) {
|
||||
const ups = config.upsDevices[i];
|
||||
const assigned = ups.groups && ups.groups.includes(groupId);
|
||||
logger.log(`${i + 1}) ${ups.name} (${ups.id}) [${assigned ? 'Assigned' : 'Not Assigned'}]`);
|
||||
}
|
||||
|
||||
// Prompt for UPS selection
|
||||
const selection = await prompt('\nSelect UPS devices to assign/unassign (comma-separated numbers, or "clear" to remove all): ');
|
||||
|
||||
if (selection.toLowerCase() === 'clear') {
|
||||
// Clear all UPS from this group
|
||||
for (const ups of config.upsDevices) {
|
||||
if (ups.groups) {
|
||||
const groupIndex = ups.groups.indexOf(groupId);
|
||||
if (groupIndex !== -1) {
|
||||
ups.groups.splice(groupIndex, 1);
|
||||
}
|
||||
}
|
||||
}
|
||||
logger.log(`All UPS devices removed from group "${group.name}".`);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!selection.trim()) {
|
||||
// No change if empty input
|
||||
return;
|
||||
}
|
||||
|
||||
// Process selections
|
||||
const selections = selection.split(',').map(s => s.trim());
|
||||
|
||||
for (const sel of selections) {
|
||||
const index = parseInt(sel, 10) - 1;
|
||||
if (isNaN(index) || index < 0 || index >= config.upsDevices.length) {
|
||||
logger.error(`Invalid selection: ${sel}`);
|
||||
continue;
|
||||
}
|
||||
|
||||
const ups = config.upsDevices[index];
|
||||
|
||||
// Initialize groups array if needed
|
||||
if (!ups.groups) {
|
||||
ups.groups = [];
|
||||
}
|
||||
|
||||
// Toggle assignment
|
||||
const groupIndex = ups.groups.indexOf(groupId);
|
||||
if (groupIndex === -1) {
|
||||
// Add to group
|
||||
ups.groups.push(groupId);
|
||||
logger.log(`Added "${ups.name}" to group "${group.name}"`);
|
||||
} else {
|
||||
// Remove from group
|
||||
ups.groups.splice(groupIndex, 1);
|
||||
logger.log(`Removed "${ups.name}" from group "${group.name}"`);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
320
ts/cli/service-handler.ts
Normal file
320
ts/cli/service-handler.ts
Normal file
@@ -0,0 +1,320 @@
|
||||
import { execSync } from 'child_process';
|
||||
import { Nupst } from '../nupst.js';
|
||||
import { logger } from '../logger.js';
|
||||
|
||||
/**
|
||||
* Class for handling service-related CLI commands
|
||||
* Provides interface for managing systemd service
|
||||
*/
|
||||
export class ServiceHandler {
|
||||
private readonly nupst: Nupst;
|
||||
|
||||
/**
|
||||
* Create a new Service handler
|
||||
* @param nupst Reference to the main Nupst instance
|
||||
*/
|
||||
constructor(nupst: Nupst) {
|
||||
this.nupst = nupst;
|
||||
}
|
||||
|
||||
/**
|
||||
* Enable the service (requires root)
|
||||
*/
|
||||
public async enable(): Promise<void> {
|
||||
this.checkRootAccess('This command must be run as root.');
|
||||
await this.nupst.getSystemd().install();
|
||||
logger.log('NUPST service has been installed. Use "nupst start" to start the service.');
|
||||
}
|
||||
|
||||
/**
|
||||
* Start the daemon directly
|
||||
* @param debugMode Whether to enable debug mode
|
||||
*/
|
||||
public async daemonStart(debugMode: boolean = false): Promise<void> {
|
||||
logger.log('Starting NUPST daemon...');
|
||||
try {
|
||||
// Enable debug mode for SNMP if requested
|
||||
if (debugMode) {
|
||||
this.nupst.getSnmp().enableDebug();
|
||||
logger.log('SNMP debug mode enabled');
|
||||
}
|
||||
await this.nupst.getDaemon().start();
|
||||
} catch (error) {
|
||||
// Error is already logged and process.exit is called in daemon.start()
|
||||
// No need to handle it here
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Show logs of the systemd service
|
||||
*/
|
||||
public async logs(): Promise<void> {
|
||||
try {
|
||||
// Use exec with spawn to properly follow logs in real-time
|
||||
const { spawn } = await import('child_process');
|
||||
logger.log('Tailing nupst service logs (Ctrl+C to exit)...\n');
|
||||
|
||||
const journalctl = spawn('journalctl', ['-u', 'nupst.service', '-n', '50', '-f'], {
|
||||
stdio: ['ignore', 'inherit', 'inherit'],
|
||||
});
|
||||
|
||||
// Forward signals to child process
|
||||
process.on('SIGINT', () => {
|
||||
journalctl.kill('SIGINT');
|
||||
process.exit(0);
|
||||
});
|
||||
|
||||
// Wait for process to exit
|
||||
await new Promise<void>((resolve) => {
|
||||
journalctl.on('exit', () => resolve());
|
||||
});
|
||||
} catch (error) {
|
||||
logger.error(`Failed to retrieve logs: ${error}`);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Stop the systemd service
|
||||
*/
|
||||
public async stop(): Promise<void> {
|
||||
await this.nupst.getSystemd().stop();
|
||||
}
|
||||
|
||||
/**
|
||||
* Start the systemd service
|
||||
*/
|
||||
public async start(): Promise<void> {
|
||||
try {
|
||||
await this.nupst.getSystemd().start();
|
||||
} catch (error) {
|
||||
// Error will be displayed by systemd.start()
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Show status of the systemd service and UPS
|
||||
*/
|
||||
public async status(): Promise<void> {
|
||||
// Extract debug options from args array
|
||||
const debugOptions = this.extractDebugOptions(process.argv);
|
||||
await this.nupst.getSystemd().getStatus(debugOptions.debugMode);
|
||||
}
|
||||
|
||||
/**
|
||||
* Disable the service (requires root)
|
||||
*/
|
||||
public async disable(): Promise<void> {
|
||||
this.checkRootAccess('This command must be run as root.');
|
||||
await this.nupst.getSystemd().disable();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the user has root access
|
||||
* @param errorMessage Error message to display if not root
|
||||
*/
|
||||
private checkRootAccess(errorMessage: string): void {
|
||||
if (process.getuid && process.getuid() !== 0) {
|
||||
logger.error(errorMessage);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Update NUPST from repository and refresh systemd service
|
||||
*/
|
||||
public async update(): Promise<void> {
|
||||
try {
|
||||
// Check if running as root
|
||||
this.checkRootAccess(
|
||||
'This command must be run as root to update NUPST and refresh the systemd service.'
|
||||
);
|
||||
|
||||
const boxWidth = 45;
|
||||
logger.logBoxTitle('NUPST Update Process', boxWidth);
|
||||
logger.logBoxLine('Updating NUPST from repository...');
|
||||
|
||||
// Determine the installation directory (assuming it's either /opt/nupst or the current directory)
|
||||
const { existsSync } = await import('fs');
|
||||
let installDir = '/opt/nupst';
|
||||
|
||||
if (!existsSync(installDir)) {
|
||||
// If not installed in /opt/nupst, use the current directory
|
||||
const { dirname } = await import('path');
|
||||
installDir = dirname(dirname(process.argv[1])); // Go up two levels from the executable
|
||||
logger.logBoxLine(`Using local installation directory: ${installDir}`);
|
||||
}
|
||||
|
||||
try {
|
||||
// 1. Update the repository
|
||||
logger.logBoxLine('Pulling latest changes from git repository...');
|
||||
execSync(`cd ${installDir} && git fetch origin && git reset --hard origin/main`, {
|
||||
stdio: 'pipe',
|
||||
});
|
||||
|
||||
// 2. Run the install.sh script
|
||||
logger.logBoxLine('Running install.sh to update NUPST...');
|
||||
execSync(`cd ${installDir} && bash ./install.sh`, { stdio: 'pipe' });
|
||||
|
||||
// 3. Run the setup.sh script with force flag to update Node.js and dependencies
|
||||
logger.logBoxLine('Running setup.sh to update Node.js and dependencies...');
|
||||
execSync(`cd ${installDir} && bash ./setup.sh --force`, { stdio: 'pipe' });
|
||||
|
||||
// 4. Refresh the systemd service
|
||||
logger.logBoxLine('Refreshing systemd service...');
|
||||
|
||||
// First check if service exists
|
||||
let serviceExists = false;
|
||||
try {
|
||||
const output = execSync('systemctl list-unit-files | grep nupst.service').toString();
|
||||
serviceExists = output.includes('nupst.service');
|
||||
} catch (error) {
|
||||
// If grep fails (service not found), serviceExists remains false
|
||||
serviceExists = false;
|
||||
}
|
||||
|
||||
if (serviceExists) {
|
||||
// Stop the service if it's running
|
||||
const isRunning =
|
||||
execSync('systemctl is-active nupst.service || true').toString().trim() === 'active';
|
||||
if (isRunning) {
|
||||
logger.logBoxLine('Stopping nupst service...');
|
||||
execSync('systemctl stop nupst.service');
|
||||
}
|
||||
|
||||
// Reinstall the service
|
||||
logger.logBoxLine('Reinstalling systemd service...');
|
||||
await this.nupst.getSystemd().install();
|
||||
|
||||
// Restart the service if it was running
|
||||
if (isRunning) {
|
||||
logger.logBoxLine('Restarting nupst service...');
|
||||
execSync('systemctl start nupst.service');
|
||||
}
|
||||
} else {
|
||||
logger.logBoxLine('Systemd service not installed, skipping service refresh.');
|
||||
logger.logBoxLine('Run "nupst enable" to install the service.');
|
||||
}
|
||||
|
||||
logger.logBoxLine('Update completed successfully!');
|
||||
logger.logBoxEnd();
|
||||
} catch (error) {
|
||||
logger.logBoxLine('Error during update process:');
|
||||
logger.logBoxLine(`${error.message}`);
|
||||
logger.logBoxEnd();
|
||||
process.exit(1);
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error(`Update failed: ${error.message}`);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Completely uninstall NUPST from the system
|
||||
*/
|
||||
public async uninstall(): Promise<void> {
|
||||
// Check if running as root
|
||||
this.checkRootAccess('This command must be run as root.');
|
||||
|
||||
try {
|
||||
// Import readline module for user input
|
||||
const readline = await import('readline');
|
||||
|
||||
const rl = readline.createInterface({
|
||||
input: process.stdin,
|
||||
output: process.stdout,
|
||||
});
|
||||
|
||||
// Helper function to prompt for input
|
||||
const prompt = (question: string): Promise<string> => {
|
||||
return new Promise((resolve) => {
|
||||
rl.question(question, (answer: string) => {
|
||||
resolve(answer);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
console.log('\nNUPST Uninstaller');
|
||||
console.log('===============');
|
||||
console.log('This will completely remove NUPST from your system.\n');
|
||||
|
||||
// Ask about removing configuration
|
||||
const removeConfig = await prompt(
|
||||
'Do you want to remove the NUPST configuration files? (y/N): '
|
||||
);
|
||||
|
||||
// Find the uninstall.sh script location
|
||||
let uninstallScriptPath: string;
|
||||
|
||||
// Try to determine script location based on executable path
|
||||
try {
|
||||
// For ESM, we can use import.meta.url, but since we might be in CJS
|
||||
// we'll use a more reliable approach based on process.argv[1]
|
||||
const binPath = process.argv[1];
|
||||
const { dirname, join } = await import('path');
|
||||
const modulePath = dirname(dirname(binPath));
|
||||
uninstallScriptPath = join(modulePath, 'uninstall.sh');
|
||||
|
||||
// Check if the script exists
|
||||
const { access } = await import('fs/promises');
|
||||
await access(uninstallScriptPath);
|
||||
} catch (error) {
|
||||
// If we can't find it in the expected location, try common installation paths
|
||||
const commonPaths = ['/opt/nupst/uninstall.sh', `${process.cwd()}/uninstall.sh`];
|
||||
const { existsSync } = await import('fs');
|
||||
|
||||
uninstallScriptPath = '';
|
||||
for (const path of commonPaths) {
|
||||
if (existsSync(path)) {
|
||||
uninstallScriptPath = path;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (!uninstallScriptPath) {
|
||||
console.error('Could not locate uninstall.sh script. Aborting uninstall.');
|
||||
rl.close();
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
// Close readline before executing script
|
||||
rl.close();
|
||||
|
||||
// Execute uninstall.sh with the appropriate option
|
||||
console.log(`\nRunning uninstaller from ${uninstallScriptPath}...`);
|
||||
|
||||
// Pass the configuration removal option as an environment variable
|
||||
const env = {
|
||||
...process.env,
|
||||
REMOVE_CONFIG: removeConfig.toLowerCase() === 'y' ? 'yes' : 'no',
|
||||
REMOVE_REPO: 'yes', // Always remove repo as requested
|
||||
NUPST_CLI_CALL: 'true', // Flag to indicate this is being called from CLI
|
||||
};
|
||||
|
||||
// Run the uninstall script with sudo
|
||||
execSync(`sudo bash ${uninstallScriptPath}`, {
|
||||
env,
|
||||
stdio: 'inherit', // Show output in the terminal
|
||||
});
|
||||
} catch (error) {
|
||||
console.error(`Uninstall failed: ${error.message}`);
|
||||
process.exit(1);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Extract and remove debug options from args array
|
||||
* @param args Command line arguments
|
||||
* @returns Object with debug flags and cleaned args
|
||||
*/
|
||||
private extractDebugOptions(args: string[]): { debugMode: boolean; cleanedArgs: string[] } {
|
||||
const debugMode = args.includes('--debug') || args.includes('-d');
|
||||
// Remove debug flags from args
|
||||
const cleanedArgs = args.filter((arg) => arg !== '--debug' && arg !== '-d');
|
||||
|
||||
return { debugMode, cleanedArgs };
|
||||
}
|
||||
}
|
||||
986
ts/cli/ups-handler.ts
Normal file
986
ts/cli/ups-handler.ts
Normal file
@@ -0,0 +1,986 @@
|
||||
import { execSync } from 'child_process';
|
||||
import { Nupst } from '../nupst.js';
|
||||
import { logger } from '../logger.js';
|
||||
import * as helpers from '../helpers/index.js';
|
||||
|
||||
/**
|
||||
* Class for handling UPS-related CLI commands
|
||||
* Provides interface for managing UPS devices
|
||||
*/
|
||||
export class UpsHandler {
|
||||
private readonly nupst: Nupst;
|
||||
|
||||
/**
|
||||
* Create a new UPS handler
|
||||
* @param nupst Reference to the main Nupst instance
|
||||
*/
|
||||
constructor(nupst: Nupst) {
|
||||
this.nupst = nupst;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add a new UPS configuration
|
||||
*/
|
||||
public async add(): Promise<void> {
|
||||
try {
|
||||
// Import readline module for user input
|
||||
const readline = await import('readline');
|
||||
|
||||
const rl = readline.createInterface({
|
||||
input: process.stdin,
|
||||
output: process.stdout,
|
||||
});
|
||||
|
||||
// Helper function to prompt for input
|
||||
const prompt = (question: string): Promise<string> => {
|
||||
return new Promise((resolve) => {
|
||||
rl.question(question, (answer: string) => {
|
||||
resolve(answer);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
try {
|
||||
await this.runAddProcess(prompt);
|
||||
} finally {
|
||||
rl.close();
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error(`Add UPS error: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Run the interactive process to add a new UPS
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
public async runAddProcess(prompt: (question: string) => Promise<string>): Promise<void> {
|
||||
logger.log('\nNUPST Add UPS');
|
||||
logger.log('=============\n');
|
||||
logger.log('This will guide you through configuring a new UPS.\n');
|
||||
|
||||
// Try to load existing config if available
|
||||
let config;
|
||||
try {
|
||||
await this.nupst.getDaemon().loadConfig();
|
||||
config = this.nupst.getDaemon().getConfig();
|
||||
|
||||
// Convert old format to new format if needed
|
||||
if (!config.upsDevices) {
|
||||
// Initialize with the current config as the first UPS
|
||||
config = {
|
||||
checkInterval: config.checkInterval,
|
||||
upsDevices: [{
|
||||
id: 'default',
|
||||
name: 'Default UPS',
|
||||
snmp: config.snmp,
|
||||
thresholds: config.thresholds,
|
||||
groups: []
|
||||
}],
|
||||
groups: []
|
||||
};
|
||||
logger.log('Converting existing configuration to multi-UPS format.');
|
||||
}
|
||||
} catch (error) {
|
||||
// If config doesn't exist, initialize with empty config
|
||||
config = {
|
||||
checkInterval: 30000, // Default check interval
|
||||
upsDevices: [],
|
||||
groups: []
|
||||
};
|
||||
logger.log('No existing configuration found. Creating a new configuration.');
|
||||
}
|
||||
|
||||
// Get UPS ID and name
|
||||
const upsId = helpers.shortId();
|
||||
const name = await prompt('UPS Name: ');
|
||||
|
||||
// Create a new UPS configuration object with defaults
|
||||
const newUps = {
|
||||
id: upsId,
|
||||
name: name || `UPS-${upsId}`,
|
||||
snmp: {
|
||||
host: '127.0.0.1',
|
||||
port: 161,
|
||||
community: 'public',
|
||||
version: 1,
|
||||
timeout: 5000,
|
||||
upsModel: 'cyberpower'
|
||||
},
|
||||
thresholds: {
|
||||
battery: 60,
|
||||
runtime: 20
|
||||
},
|
||||
groups: []
|
||||
};
|
||||
|
||||
// Gather SNMP settings
|
||||
await this.gatherSnmpSettings(newUps.snmp, prompt);
|
||||
|
||||
// Gather threshold settings
|
||||
await this.gatherThresholdSettings(newUps.thresholds, prompt);
|
||||
|
||||
// Gather UPS model settings
|
||||
await this.gatherUpsModelSettings(newUps.snmp, prompt);
|
||||
|
||||
// Get access to GroupHandler for group assignments
|
||||
const groupHandler = this.nupst.getGroupHandler();
|
||||
|
||||
// Assign to groups if any exist
|
||||
if (config.groups && config.groups.length > 0) {
|
||||
await groupHandler.assignUpsToGroups(newUps, config.groups, prompt);
|
||||
}
|
||||
|
||||
// Add the new UPS to the config
|
||||
config.upsDevices.push(newUps);
|
||||
|
||||
// Save the configuration
|
||||
await this.nupst.getDaemon().saveConfig(config);
|
||||
|
||||
this.displayUpsConfigSummary(newUps);
|
||||
|
||||
// Test the connection if requested
|
||||
await this.optionallyTestConnection(newUps.snmp, prompt);
|
||||
|
||||
// Check if service is running and restart it if needed
|
||||
await this.restartServiceIfRunning();
|
||||
|
||||
logger.log('\nSetup complete!');
|
||||
}
|
||||
|
||||
/**
|
||||
* Edit an existing UPS configuration
|
||||
* @param upsId ID of the UPS to edit (undefined for default UPS)
|
||||
*/
|
||||
public async edit(upsId?: string): Promise<void> {
|
||||
try {
|
||||
// Import readline module for user input
|
||||
const readline = await import('readline');
|
||||
|
||||
const rl = readline.createInterface({
|
||||
input: process.stdin,
|
||||
output: process.stdout,
|
||||
});
|
||||
|
||||
// Helper function to prompt for input
|
||||
const prompt = (question: string): Promise<string> => {
|
||||
return new Promise((resolve) => {
|
||||
rl.question(question, (answer: string) => {
|
||||
resolve(answer);
|
||||
});
|
||||
});
|
||||
};
|
||||
|
||||
try {
|
||||
await this.runEditProcess(upsId, prompt);
|
||||
} finally {
|
||||
rl.close();
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error(`Edit UPS error: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Run the interactive process to edit a UPS
|
||||
* @param upsId ID of the UPS to edit (undefined for default UPS)
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
public async runEditProcess(upsId: string | undefined, prompt: (question: string) => Promise<string>): Promise<void> {
|
||||
logger.log('\nNUPST Edit UPS');
|
||||
logger.log('=============\n');
|
||||
|
||||
// Try to load existing config
|
||||
try {
|
||||
await this.nupst.getDaemon().loadConfig();
|
||||
} catch (error) {
|
||||
if (!upsId) {
|
||||
// For default UPS (no ID specified), run setup if no config exists
|
||||
logger.log('No existing configuration found. Running setup for new UPS.');
|
||||
await this.runAddProcess(prompt);
|
||||
return;
|
||||
} else {
|
||||
// For specific UPS ID, error if config doesn't exist
|
||||
logger.error('No configuration found. Please run "nupst setup" first.');
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
// Get the config
|
||||
const config = this.nupst.getDaemon().getConfig();
|
||||
|
||||
// Convert old format to new format if needed
|
||||
if (!config.upsDevices) {
|
||||
// Initialize with the current config as the first UPS
|
||||
config.upsDevices = [{
|
||||
id: 'default',
|
||||
name: 'Default UPS',
|
||||
snmp: config.snmp,
|
||||
thresholds: config.thresholds,
|
||||
groups: []
|
||||
}];
|
||||
config.groups = [];
|
||||
logger.log('Converting existing configuration to multi-UPS format.');
|
||||
}
|
||||
|
||||
// Find the UPS to edit
|
||||
let upsToEdit;
|
||||
if (upsId) {
|
||||
// Find specific UPS by ID
|
||||
upsToEdit = config.upsDevices.find(ups => ups.id === upsId);
|
||||
if (!upsToEdit) {
|
||||
logger.error(`UPS with ID "${upsId}" not found.`);
|
||||
return;
|
||||
}
|
||||
logger.log(`Editing UPS: ${upsToEdit.name} (${upsToEdit.id})\n`);
|
||||
} else {
|
||||
// For backward compatibility, edit the first UPS if no ID specified
|
||||
if (config.upsDevices.length === 0) {
|
||||
logger.error('No UPS devices configured. Please run "nupst add" to add a UPS.');
|
||||
return;
|
||||
}
|
||||
upsToEdit = config.upsDevices[0];
|
||||
logger.log(`Editing default UPS: ${upsToEdit.name} (${upsToEdit.id})\n`);
|
||||
}
|
||||
|
||||
// Allow editing UPS name
|
||||
const newName = await prompt(`UPS Name [${upsToEdit.name}]: `);
|
||||
if (newName.trim()) {
|
||||
upsToEdit.name = newName;
|
||||
}
|
||||
|
||||
// Edit SNMP settings
|
||||
await this.gatherSnmpSettings(upsToEdit.snmp, prompt);
|
||||
|
||||
// Edit threshold settings
|
||||
await this.gatherThresholdSettings(upsToEdit.thresholds, prompt);
|
||||
|
||||
// Edit UPS model settings
|
||||
await this.gatherUpsModelSettings(upsToEdit.snmp, prompt);
|
||||
|
||||
// Get access to GroupHandler for group assignments
|
||||
const groupHandler = this.nupst.getGroupHandler();
|
||||
|
||||
// Edit group assignments
|
||||
if (config.groups && config.groups.length > 0) {
|
||||
await groupHandler.assignUpsToGroups(upsToEdit, config.groups, prompt);
|
||||
}
|
||||
|
||||
// Save the configuration
|
||||
await this.nupst.getDaemon().saveConfig(config);
|
||||
|
||||
this.displayUpsConfigSummary(upsToEdit);
|
||||
|
||||
// Test the connection if requested
|
||||
await this.optionallyTestConnection(upsToEdit.snmp, prompt);
|
||||
|
||||
// Check if service is running and restart it if needed
|
||||
await this.restartServiceIfRunning();
|
||||
|
||||
logger.log('\nEdit complete!');
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a UPS by ID
|
||||
* @param upsId ID of the UPS to delete
|
||||
*/
|
||||
public async delete(upsId: string): Promise<void> {
|
||||
try {
|
||||
// Try to load configuration
|
||||
try {
|
||||
await this.nupst.getDaemon().loadConfig();
|
||||
} catch (error) {
|
||||
const errorBoxWidth = 45;
|
||||
logger.logBoxTitle('Configuration Error', errorBoxWidth);
|
||||
logger.logBoxLine('No configuration found.');
|
||||
logger.logBoxLine("Please run 'nupst setup' first to create a configuration.");
|
||||
logger.logBoxEnd();
|
||||
return;
|
||||
}
|
||||
|
||||
// Get current configuration
|
||||
const config = this.nupst.getDaemon().getConfig();
|
||||
|
||||
// Check if multi-UPS config
|
||||
if (!config.upsDevices || !Array.isArray(config.upsDevices)) {
|
||||
logger.error('Legacy single-UPS configuration detected. Cannot delete UPS.');
|
||||
logger.log('Use "nupst add" to migrate to multi-UPS configuration format first.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Find the UPS to delete
|
||||
const upsIndex = config.upsDevices.findIndex(ups => ups.id === upsId);
|
||||
if (upsIndex === -1) {
|
||||
logger.error(`UPS with ID "${upsId}" not found.`);
|
||||
return;
|
||||
}
|
||||
|
||||
const upsToDelete = config.upsDevices[upsIndex];
|
||||
|
||||
// Get confirmation before deleting
|
||||
const readline = await import('readline');
|
||||
const rl = readline.createInterface({
|
||||
input: process.stdin,
|
||||
output: process.stdout,
|
||||
});
|
||||
|
||||
const confirm = await new Promise<string>(resolve => {
|
||||
rl.question(`Are you sure you want to delete UPS "${upsToDelete.name}" (${upsId})? [y/N]: `, answer => {
|
||||
resolve(answer.toLowerCase());
|
||||
});
|
||||
});
|
||||
|
||||
rl.close();
|
||||
|
||||
if (confirm !== 'y' && confirm !== 'yes') {
|
||||
logger.log('Deletion cancelled.');
|
||||
return;
|
||||
}
|
||||
|
||||
// Remove the UPS from the array
|
||||
config.upsDevices.splice(upsIndex, 1);
|
||||
|
||||
// Save the configuration
|
||||
await this.nupst.getDaemon().saveConfig(config);
|
||||
|
||||
logger.log(`UPS "${upsToDelete.name}" (${upsId}) has been deleted.`);
|
||||
|
||||
// Check if service is running and restart it if needed
|
||||
await this.restartServiceIfRunning();
|
||||
} catch (error) {
|
||||
logger.error(`Failed to delete UPS: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* List all configured UPS devices
|
||||
*/
|
||||
public async list(): Promise<void> {
|
||||
try {
|
||||
// Try to load configuration
|
||||
try {
|
||||
await this.nupst.getDaemon().loadConfig();
|
||||
} catch (error) {
|
||||
const errorBoxWidth = 45;
|
||||
logger.logBoxTitle('Configuration Error', errorBoxWidth);
|
||||
logger.logBoxLine('No configuration found.');
|
||||
logger.logBoxLine("Please run 'nupst setup' first to create a configuration.");
|
||||
logger.logBoxEnd();
|
||||
return;
|
||||
}
|
||||
|
||||
// Get current configuration
|
||||
const config = this.nupst.getDaemon().getConfig();
|
||||
|
||||
// Check if multi-UPS config
|
||||
if (!config.upsDevices || !Array.isArray(config.upsDevices)) {
|
||||
// Legacy single UPS configuration
|
||||
const boxWidth = 45;
|
||||
logger.logBoxTitle('UPS Devices', boxWidth);
|
||||
logger.logBoxLine('Legacy single-UPS configuration detected.');
|
||||
logger.logBoxLine('');
|
||||
logger.logBoxLine('Default UPS:');
|
||||
logger.logBoxLine(` Host: ${config.snmp.host}:${config.snmp.port}`);
|
||||
logger.logBoxLine(` Model: ${config.snmp.upsModel || 'cyberpower'}`);
|
||||
logger.logBoxLine(` Thresholds: ${config.thresholds.battery}% battery, ${config.thresholds.runtime} min runtime`);
|
||||
logger.logBoxLine('');
|
||||
logger.logBoxLine('Use "nupst add" to add more UPS devices and migrate');
|
||||
logger.logBoxLine('to the multi-UPS configuration format.');
|
||||
logger.logBoxEnd();
|
||||
return;
|
||||
}
|
||||
|
||||
// Display UPS list
|
||||
const boxWidth = 60;
|
||||
logger.logBoxTitle('UPS Devices', boxWidth);
|
||||
|
||||
if (config.upsDevices.length === 0) {
|
||||
logger.logBoxLine('No UPS devices configured.');
|
||||
logger.logBoxLine('Use "nupst add" to add a UPS device.');
|
||||
} else {
|
||||
logger.logBoxLine(`Found ${config.upsDevices.length} UPS device(s)`);
|
||||
logger.logBoxLine('');
|
||||
logger.logBoxLine('ID | Name | Host | Mode | Groups');
|
||||
logger.logBoxLine('-----------+----------------------+-----------------+--------------+----------------');
|
||||
|
||||
for (const ups of config.upsDevices) {
|
||||
const id = ups.id.padEnd(10, ' ').substring(0, 10);
|
||||
const name = (ups.name || '').padEnd(20, ' ').substring(0, 20);
|
||||
const host = `${ups.snmp.host}:${ups.snmp.port}`.padEnd(15, ' ').substring(0, 15);
|
||||
const model = (ups.snmp.upsModel || 'cyberpower').padEnd(12, ' ').substring(0, 12);
|
||||
const groups = ups.groups.length > 0 ? ups.groups.join(', ') : 'None';
|
||||
|
||||
logger.logBoxLine(`${id} | ${name} | ${host} | ${model} | ${groups}`);
|
||||
}
|
||||
}
|
||||
|
||||
logger.logBoxEnd();
|
||||
} catch (error) {
|
||||
logger.error(`Failed to list UPS devices: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Test the current configuration by connecting to the UPS
|
||||
* @param debugMode Whether to enable debug mode
|
||||
*/
|
||||
public async test(debugMode: boolean = false): Promise<void> {
|
||||
try {
|
||||
// Debug mode is now handled in parseAndExecute
|
||||
if (debugMode) {
|
||||
const boxWidth = 45;
|
||||
logger.logBoxTitle('Debug Mode', boxWidth);
|
||||
logger.logBoxLine('SNMP debugging enabled - detailed logs will be shown');
|
||||
logger.logBoxEnd();
|
||||
}
|
||||
|
||||
// Try to load the configuration
|
||||
try {
|
||||
await this.nupst.getDaemon().loadConfig();
|
||||
} catch (error) {
|
||||
const errorBoxWidth = 45;
|
||||
logger.logBoxTitle('Configuration Error', errorBoxWidth);
|
||||
logger.logBoxLine('No configuration found.');
|
||||
logger.logBoxLine("Please run 'nupst setup' first to create a configuration.");
|
||||
logger.logBoxEnd();
|
||||
return;
|
||||
}
|
||||
|
||||
// Get current configuration
|
||||
const config = this.nupst.getDaemon().getConfig();
|
||||
|
||||
// Handle new multi-UPS configuration format
|
||||
if (config.upsDevices && config.upsDevices.length > 0) {
|
||||
logger.log(`Found ${config.upsDevices.length} UPS devices in configuration.`);
|
||||
|
||||
for (let i = 0; i < config.upsDevices.length; i++) {
|
||||
const ups = config.upsDevices[i];
|
||||
logger.log(`\nTesting UPS: ${ups.name} (${ups.id})`);
|
||||
this.displayTestConfig(ups);
|
||||
await this.testConnection(ups);
|
||||
}
|
||||
} else {
|
||||
// Legacy configuration format
|
||||
this.displayTestConfig(config);
|
||||
await this.testConnection(config);
|
||||
}
|
||||
} catch (error) {
|
||||
logger.error(`Test failed: ${error.message}`);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Display the configuration for testing
|
||||
* @param config Current configuration or individual UPS configuration
|
||||
*/
|
||||
private displayTestConfig(config: any): void {
|
||||
// Check if this is a UPS device or full configuration
|
||||
const isUpsConfig = config.snmp && config.thresholds;
|
||||
const snmpConfig = isUpsConfig ? config.snmp : config.snmp || {};
|
||||
const thresholds = isUpsConfig ? config.thresholds : config.thresholds || {};
|
||||
const checkInterval = config.checkInterval || 30000;
|
||||
|
||||
// Get UPS name and ID if available
|
||||
const upsName = config.name ? config.name : 'Default UPS';
|
||||
const upsId = config.id ? config.id : 'default';
|
||||
|
||||
const boxWidth = 45;
|
||||
logger.logBoxTitle(`Testing Configuration: ${upsName}`, boxWidth);
|
||||
logger.logBoxLine(`UPS ID: ${upsId}`);
|
||||
logger.logBoxLine('SNMP Settings:');
|
||||
logger.logBoxLine(` Host: ${snmpConfig.host}`);
|
||||
logger.logBoxLine(` Port: ${snmpConfig.port}`);
|
||||
logger.logBoxLine(` Version: ${snmpConfig.version}`);
|
||||
logger.logBoxLine(` UPS Model: ${snmpConfig.upsModel || 'cyberpower'}`);
|
||||
|
||||
if (snmpConfig.version === 1 || snmpConfig.version === 2) {
|
||||
logger.logBoxLine(` Community: ${snmpConfig.community}`);
|
||||
} else if (snmpConfig.version === 3) {
|
||||
logger.logBoxLine(` Security Level: ${snmpConfig.securityLevel}`);
|
||||
logger.logBoxLine(` Username: ${snmpConfig.username}`);
|
||||
|
||||
// Show auth and privacy details based on security level
|
||||
if (snmpConfig.securityLevel === 'authNoPriv' || snmpConfig.securityLevel === 'authPriv') {
|
||||
logger.logBoxLine(` Auth Protocol: ${snmpConfig.authProtocol || 'None'}`);
|
||||
}
|
||||
|
||||
if (snmpConfig.securityLevel === 'authPriv') {
|
||||
logger.logBoxLine(` Privacy Protocol: ${snmpConfig.privProtocol || 'None'}`);
|
||||
}
|
||||
|
||||
// Show timeout value
|
||||
logger.logBoxLine(` Timeout: ${snmpConfig.timeout / 1000} seconds`);
|
||||
}
|
||||
|
||||
// Show OIDs if custom model is selected
|
||||
if (snmpConfig.upsModel === 'custom' && snmpConfig.customOIDs) {
|
||||
logger.logBoxLine('Custom OIDs:');
|
||||
logger.logBoxLine(` Power Status: ${snmpConfig.customOIDs.POWER_STATUS || 'Not set'}`);
|
||||
logger.logBoxLine(` Battery Capacity: ${snmpConfig.customOIDs.BATTERY_CAPACITY || 'Not set'}`);
|
||||
logger.logBoxLine(` Battery Runtime: ${snmpConfig.customOIDs.BATTERY_RUNTIME || 'Not set'}`);
|
||||
}
|
||||
logger.logBoxLine('Thresholds:');
|
||||
logger.logBoxLine(` Battery: ${thresholds.battery}%`);
|
||||
logger.logBoxLine(` Runtime: ${thresholds.runtime} minutes`);
|
||||
|
||||
// Show group assignments if this is a UPS config
|
||||
if (config.groups && Array.isArray(config.groups)) {
|
||||
logger.logBoxLine(`Group Assignments: ${config.groups.length === 0 ? 'None' : config.groups.join(', ')}`);
|
||||
}
|
||||
|
||||
logger.logBoxLine(`Check Interval: ${checkInterval / 1000} seconds`);
|
||||
logger.logBoxEnd();
|
||||
}
|
||||
|
||||
/**
|
||||
* Test connection to the UPS
|
||||
* @param config Current UPS configuration or legacy config
|
||||
*/
|
||||
private async testConnection(config: any): Promise<void> {
|
||||
const upsId = config.id || 'default';
|
||||
const upsName = config.name || 'Default UPS';
|
||||
logger.log(`\nTesting connection to UPS: ${upsName} (${upsId})...`);
|
||||
|
||||
try {
|
||||
// Create a test config with a short timeout
|
||||
const snmpConfig = config.snmp ? config.snmp : config.snmp;
|
||||
const thresholds = config.thresholds ? config.thresholds : config.thresholds;
|
||||
|
||||
const testConfig = {
|
||||
...snmpConfig,
|
||||
timeout: Math.min(snmpConfig.timeout, 10000), // Use at most 10 seconds for testing
|
||||
};
|
||||
|
||||
const status = await this.nupst.getSnmp().getUpsStatus(testConfig);
|
||||
|
||||
const boxWidth = 45;
|
||||
logger.logBoxTitle(`Connection Successful: ${upsName}`, boxWidth);
|
||||
logger.logBoxLine('UPS Status:');
|
||||
logger.logBoxLine(` Power Status: ${status.powerStatus}`);
|
||||
logger.logBoxLine(` Battery Capacity: ${status.batteryCapacity}%`);
|
||||
logger.logBoxLine(` Runtime Remaining: ${status.batteryRuntime} minutes`);
|
||||
logger.logBoxEnd();
|
||||
|
||||
// Check status against thresholds if on battery
|
||||
if (status.powerStatus === 'onBattery') {
|
||||
this.analyzeThresholds(status, thresholds);
|
||||
}
|
||||
} catch (error) {
|
||||
const errorBoxWidth = 45;
|
||||
logger.logBoxTitle(`Connection Failed: ${upsName}`, errorBoxWidth);
|
||||
logger.logBoxLine(`Error: ${error.message}`);
|
||||
logger.logBoxEnd();
|
||||
logger.log("\nPlease check your settings and run 'nupst edit' to reconfigure this UPS.");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Analyze UPS status against thresholds
|
||||
* @param status UPS status
|
||||
* @param thresholds Threshold configuration
|
||||
*/
|
||||
private analyzeThresholds(status: any, thresholds: any): void {
|
||||
const boxWidth = 45;
|
||||
logger.logBoxTitle('Threshold Analysis', boxWidth);
|
||||
|
||||
if (status.batteryCapacity < thresholds.battery) {
|
||||
logger.logBoxLine('⚠️ WARNING: Battery capacity below threshold');
|
||||
logger.logBoxLine(
|
||||
` Current: ${status.batteryCapacity}% | Threshold: ${thresholds.battery}%`
|
||||
);
|
||||
logger.logBoxLine(' System would initiate shutdown');
|
||||
} else {
|
||||
logger.logBoxLine('✓ Battery capacity above threshold');
|
||||
logger.logBoxLine(
|
||||
` Current: ${status.batteryCapacity}% | Threshold: ${thresholds.battery}%`
|
||||
);
|
||||
}
|
||||
|
||||
if (status.batteryRuntime < thresholds.runtime) {
|
||||
logger.logBoxLine('⚠️ WARNING: Runtime below threshold');
|
||||
logger.logBoxLine(
|
||||
` Current: ${status.batteryRuntime} min | Threshold: ${thresholds.runtime} min`
|
||||
);
|
||||
logger.logBoxLine(' System would initiate shutdown');
|
||||
} else {
|
||||
logger.logBoxLine('✓ Runtime above threshold');
|
||||
logger.logBoxLine(
|
||||
` Current: ${status.batteryRuntime} min | Threshold: ${thresholds.runtime} min`
|
||||
);
|
||||
}
|
||||
|
||||
logger.logBoxEnd();
|
||||
}
|
||||
|
||||
/**
|
||||
* Gather SNMP settings
|
||||
* @param snmpConfig SNMP configuration object to update
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
private async gatherSnmpSettings(
|
||||
snmpConfig: any,
|
||||
prompt: (question: string) => Promise<string>
|
||||
): Promise<void> {
|
||||
// SNMP IP Address
|
||||
const defaultHost = snmpConfig.host || '127.0.0.1';
|
||||
const host = await prompt(`UPS IP Address [${defaultHost}]: `);
|
||||
snmpConfig.host = host.trim() || defaultHost;
|
||||
|
||||
// SNMP Port
|
||||
const defaultPort = snmpConfig.port || 161;
|
||||
const portInput = await prompt(`SNMP Port [${defaultPort}]: `);
|
||||
const port = parseInt(portInput, 10);
|
||||
snmpConfig.port = portInput.trim() && !isNaN(port) ? port : defaultPort;
|
||||
|
||||
// SNMP Version
|
||||
const defaultVersion = snmpConfig.version || 1;
|
||||
console.log('\nSNMP Version:');
|
||||
console.log(' 1) SNMPv1');
|
||||
console.log(' 2) SNMPv2c');
|
||||
console.log(' 3) SNMPv3 (with security features)');
|
||||
const versionInput = await prompt(`Select SNMP version [${defaultVersion}]: `);
|
||||
const version = parseInt(versionInput, 10);
|
||||
snmpConfig.version =
|
||||
versionInput.trim() && (version === 1 || version === 2 || version === 3)
|
||||
? version
|
||||
: defaultVersion;
|
||||
|
||||
if (snmpConfig.version === 1 || snmpConfig.version === 2) {
|
||||
// SNMP Community String (for v1/v2c)
|
||||
const defaultCommunity = snmpConfig.community || 'public';
|
||||
const community = await prompt(`SNMP Community String [${defaultCommunity}]: `);
|
||||
snmpConfig.community = community.trim() || defaultCommunity;
|
||||
} else if (snmpConfig.version === 3) {
|
||||
// SNMP v3 settings
|
||||
await this.gatherSnmpV3Settings(snmpConfig, prompt);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gather SNMPv3 specific settings
|
||||
* @param snmpConfig SNMP configuration object to update
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
private async gatherSnmpV3Settings(
|
||||
snmpConfig: any,
|
||||
prompt: (question: string) => Promise<string>
|
||||
): Promise<void> {
|
||||
console.log('\nSNMPv3 Security Settings:');
|
||||
|
||||
// Security Level
|
||||
console.log('\nSecurity Level:');
|
||||
console.log(' 1) noAuthNoPriv (No Authentication, No Privacy)');
|
||||
console.log(' 2) authNoPriv (Authentication, No Privacy)');
|
||||
console.log(' 3) authPriv (Authentication and Privacy)');
|
||||
const defaultSecLevel = snmpConfig.securityLevel
|
||||
? snmpConfig.securityLevel === 'noAuthNoPriv'
|
||||
? 1
|
||||
: snmpConfig.securityLevel === 'authNoPriv'
|
||||
? 2
|
||||
: 3
|
||||
: 3;
|
||||
const secLevelInput = await prompt(`Select Security Level [${defaultSecLevel}]: `);
|
||||
const secLevel = parseInt(secLevelInput, 10) || defaultSecLevel;
|
||||
|
||||
if (secLevel === 1) {
|
||||
snmpConfig.securityLevel = 'noAuthNoPriv';
|
||||
// No auth, no priv - clear out authentication and privacy settings
|
||||
snmpConfig.authProtocol = '';
|
||||
snmpConfig.authKey = '';
|
||||
snmpConfig.privProtocol = '';
|
||||
snmpConfig.privKey = '';
|
||||
// Set appropriate timeout for security level
|
||||
snmpConfig.timeout = 5000; // 5 seconds for basic security
|
||||
} else if (secLevel === 2) {
|
||||
snmpConfig.securityLevel = 'authNoPriv';
|
||||
// Auth, no priv - clear out privacy settings
|
||||
snmpConfig.privProtocol = '';
|
||||
snmpConfig.privKey = '';
|
||||
// Set appropriate timeout for security level
|
||||
snmpConfig.timeout = 10000; // 10 seconds for authentication
|
||||
} else {
|
||||
snmpConfig.securityLevel = 'authPriv';
|
||||
// Set appropriate timeout for security level
|
||||
snmpConfig.timeout = 15000; // 15 seconds for full encryption
|
||||
}
|
||||
|
||||
// Username
|
||||
const defaultUsername = snmpConfig.username || '';
|
||||
const username = await prompt(`SNMPv3 Username [${defaultUsername}]: `);
|
||||
snmpConfig.username = username.trim() || defaultUsername;
|
||||
|
||||
if (secLevel >= 2) {
|
||||
// Authentication settings
|
||||
await this.gatherAuthenticationSettings(snmpConfig, prompt);
|
||||
|
||||
if (secLevel === 3) {
|
||||
// Privacy settings
|
||||
await this.gatherPrivacySettings(snmpConfig, prompt);
|
||||
}
|
||||
|
||||
// Allow customizing the timeout value
|
||||
const defaultTimeout = snmpConfig.timeout / 1000; // Convert from ms to seconds for display
|
||||
console.log(
|
||||
'\nSNMPv3 operations with authentication and privacy may require longer timeouts.'
|
||||
);
|
||||
const timeoutInput = await prompt(`SNMP Timeout in seconds [${defaultTimeout}]: `);
|
||||
const timeout = parseInt(timeoutInput, 10);
|
||||
if (timeoutInput.trim() && !isNaN(timeout)) {
|
||||
snmpConfig.timeout = timeout * 1000; // Convert to ms
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gather authentication settings for SNMPv3
|
||||
* @param snmpConfig SNMP configuration object to update
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
private async gatherAuthenticationSettings(
|
||||
snmpConfig: any,
|
||||
prompt: (question: string) => Promise<string>
|
||||
): Promise<void> {
|
||||
// Authentication protocol
|
||||
console.log('\nAuthentication Protocol:');
|
||||
console.log(' 1) MD5');
|
||||
console.log(' 2) SHA');
|
||||
const defaultAuthProtocol = snmpConfig.authProtocol === 'SHA' ? 2 : 1;
|
||||
const authProtocolInput = await prompt(
|
||||
`Select Authentication Protocol [${defaultAuthProtocol}]: `
|
||||
);
|
||||
const authProtocol = parseInt(authProtocolInput, 10) || defaultAuthProtocol;
|
||||
snmpConfig.authProtocol = authProtocol === 2 ? 'SHA' : 'MD5';
|
||||
|
||||
// Authentication Key/Password
|
||||
const defaultAuthKey = snmpConfig.authKey || '';
|
||||
const authKey = await prompt(`Authentication Password ${defaultAuthKey ? '[*****]' : ''}: `);
|
||||
snmpConfig.authKey = authKey.trim() || defaultAuthKey;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gather privacy settings for SNMPv3
|
||||
* @param snmpConfig SNMP configuration object to update
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
private async gatherPrivacySettings(
|
||||
snmpConfig: any,
|
||||
prompt: (question: string) => Promise<string>
|
||||
): Promise<void> {
|
||||
// Privacy protocol
|
||||
console.log('\nPrivacy Protocol:');
|
||||
console.log(' 1) DES');
|
||||
console.log(' 2) AES');
|
||||
const defaultPrivProtocol = snmpConfig.privProtocol === 'AES' ? 2 : 1;
|
||||
const privProtocolInput = await prompt(`Select Privacy Protocol [${defaultPrivProtocol}]: `);
|
||||
const privProtocol = parseInt(privProtocolInput, 10) || defaultPrivProtocol;
|
||||
snmpConfig.privProtocol = privProtocol === 2 ? 'AES' : 'DES';
|
||||
|
||||
// Privacy Key/Password
|
||||
const defaultPrivKey = snmpConfig.privKey || '';
|
||||
const privKey = await prompt(`Privacy Password ${defaultPrivKey ? '[*****]' : ''}: `);
|
||||
snmpConfig.privKey = privKey.trim() || defaultPrivKey;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gather threshold settings
|
||||
* @param thresholds Thresholds configuration object to update
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
private async gatherThresholdSettings(
|
||||
thresholds: any,
|
||||
prompt: (question: string) => Promise<string>
|
||||
): Promise<void> {
|
||||
console.log('\nShutdown Thresholds:');
|
||||
|
||||
// Battery threshold
|
||||
const defaultBatteryThreshold = thresholds.battery || 60;
|
||||
const batteryThresholdInput = await prompt(
|
||||
`Battery percentage threshold [${defaultBatteryThreshold}%]: `
|
||||
);
|
||||
const batteryThreshold = parseInt(batteryThresholdInput, 10);
|
||||
thresholds.battery =
|
||||
batteryThresholdInput.trim() && !isNaN(batteryThreshold)
|
||||
? batteryThreshold
|
||||
: defaultBatteryThreshold;
|
||||
|
||||
// Runtime threshold
|
||||
const defaultRuntimeThreshold = thresholds.runtime || 20;
|
||||
const runtimeThresholdInput = await prompt(
|
||||
`Runtime minutes threshold [${defaultRuntimeThreshold} minutes]: `
|
||||
);
|
||||
const runtimeThreshold = parseInt(runtimeThresholdInput, 10);
|
||||
thresholds.runtime =
|
||||
runtimeThresholdInput.trim() && !isNaN(runtimeThreshold)
|
||||
? runtimeThreshold
|
||||
: defaultRuntimeThreshold;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gather UPS model settings
|
||||
* @param snmpConfig SNMP configuration object to update
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
private async gatherUpsModelSettings(
|
||||
snmpConfig: any,
|
||||
prompt: (question: string) => Promise<string>
|
||||
): Promise<void> {
|
||||
console.log('\nUPS Model Selection:');
|
||||
console.log(' 1) CyberPower');
|
||||
console.log(' 2) APC');
|
||||
console.log(' 3) Eaton');
|
||||
console.log(' 4) TrippLite');
|
||||
console.log(' 5) Liebert/Vertiv');
|
||||
console.log(' 6) Custom (Advanced)');
|
||||
|
||||
const defaultModelValue =
|
||||
snmpConfig.upsModel === 'cyberpower'
|
||||
? 1
|
||||
: snmpConfig.upsModel === 'apc'
|
||||
? 2
|
||||
: snmpConfig.upsModel === 'eaton'
|
||||
? 3
|
||||
: snmpConfig.upsModel === 'tripplite'
|
||||
? 4
|
||||
: snmpConfig.upsModel === 'liebert'
|
||||
? 5
|
||||
: snmpConfig.upsModel === 'custom'
|
||||
? 6
|
||||
: 1;
|
||||
|
||||
const modelInput = await prompt(`Select UPS model [${defaultModelValue}]: `);
|
||||
const modelValue = parseInt(modelInput, 10) || defaultModelValue;
|
||||
|
||||
if (modelValue === 1) {
|
||||
snmpConfig.upsModel = 'cyberpower';
|
||||
} else if (modelValue === 2) {
|
||||
snmpConfig.upsModel = 'apc';
|
||||
} else if (modelValue === 3) {
|
||||
snmpConfig.upsModel = 'eaton';
|
||||
} else if (modelValue === 4) {
|
||||
snmpConfig.upsModel = 'tripplite';
|
||||
} else if (modelValue === 5) {
|
||||
snmpConfig.upsModel = 'liebert';
|
||||
} else if (modelValue === 6) {
|
||||
snmpConfig.upsModel = 'custom';
|
||||
console.log('\nEnter custom OIDs for your UPS:');
|
||||
console.log('(Leave blank to use standard RFC 1628 OIDs as fallback)');
|
||||
|
||||
// Custom OIDs
|
||||
const powerStatusOID = await prompt('Power Status OID: ');
|
||||
const batteryCapacityOID = await prompt('Battery Capacity OID: ');
|
||||
const batteryRuntimeOID = await prompt('Battery Runtime OID: ');
|
||||
|
||||
// Create custom OIDs object
|
||||
snmpConfig.customOIDs = {
|
||||
POWER_STATUS: powerStatusOID.trim(),
|
||||
BATTERY_CAPACITY: batteryCapacityOID.trim(),
|
||||
BATTERY_RUNTIME: batteryRuntimeOID.trim(),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Display UPS configuration summary
|
||||
* @param ups UPS configuration
|
||||
*/
|
||||
private displayUpsConfigSummary(ups: any): void {
|
||||
const boxWidth = 45;
|
||||
logger.log('');
|
||||
logger.logBoxTitle(`UPS Configuration: ${ups.name}`, boxWidth);
|
||||
logger.logBoxLine(`UPS ID: ${ups.id}`);
|
||||
logger.logBoxLine(`SNMP Host: ${ups.snmp.host}:${ups.snmp.port}`);
|
||||
logger.logBoxLine(`SNMP Version: ${ups.snmp.version}`);
|
||||
logger.logBoxLine(`UPS Model: ${ups.snmp.upsModel}`);
|
||||
logger.logBoxLine(
|
||||
`Thresholds: ${ups.thresholds.battery}% battery, ${ups.thresholds.runtime} min runtime`
|
||||
);
|
||||
if (ups.groups && ups.groups.length > 0) {
|
||||
logger.logBoxLine(`Groups: ${ups.groups.join(', ')}`);
|
||||
} else {
|
||||
logger.logBoxLine('Groups: None');
|
||||
}
|
||||
logger.logBoxEnd();
|
||||
logger.log('');
|
||||
}
|
||||
|
||||
/**
|
||||
* Optionally test connection to UPS
|
||||
* @param snmpConfig SNMP configuration to test
|
||||
* @param prompt Function to prompt for user input
|
||||
*/
|
||||
private async optionallyTestConnection(
|
||||
snmpConfig: any,
|
||||
prompt: (question: string) => Promise<string>
|
||||
): Promise<void> {
|
||||
const testConnection = await prompt(
|
||||
'Would you like to test the connection to your UPS? (y/N): '
|
||||
);
|
||||
if (testConnection.toLowerCase() === 'y') {
|
||||
logger.log('\nTesting connection to UPS...');
|
||||
try {
|
||||
// Create a test config with a short timeout
|
||||
const testConfig = {
|
||||
...snmpConfig,
|
||||
timeout: Math.min(snmpConfig.timeout, 10000), // Use at most 10 seconds for testing
|
||||
};
|
||||
|
||||
const status = await this.nupst.getSnmp().getUpsStatus(testConfig);
|
||||
const boxWidth = 45;
|
||||
logger.log('');
|
||||
logger.logBoxTitle('Connection Successful!', boxWidth);
|
||||
logger.logBoxLine('UPS Status:');
|
||||
logger.logBoxLine(`✓ Power Status: ${status.powerStatus}`);
|
||||
logger.logBoxLine(`✓ Battery Capacity: ${status.batteryCapacity}%`);
|
||||
logger.logBoxLine(`✓ Runtime Remaining: ${status.batteryRuntime} minutes`);
|
||||
logger.logBoxEnd();
|
||||
} catch (error) {
|
||||
const errorBoxWidth = 45;
|
||||
logger.log('');
|
||||
logger.logBoxTitle('Connection Failed!', errorBoxWidth);
|
||||
logger.logBoxLine(`Error: ${error.message}`);
|
||||
logger.logBoxEnd();
|
||||
logger.log('\nPlease check your settings and try again.');
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the systemd service is running and restart it if it is
|
||||
* This is useful after configuration changes
|
||||
*/
|
||||
public async restartServiceIfRunning(): Promise<void> {
|
||||
try {
|
||||
// Check if the service is active
|
||||
const isActive =
|
||||
execSync('systemctl is-active nupst.service || true').toString().trim() === 'active';
|
||||
|
||||
if (isActive) {
|
||||
// Service is running, restart it
|
||||
const boxWidth = 45;
|
||||
logger.logBoxTitle('Service Update', boxWidth);
|
||||
logger.logBoxLine('Configuration has changed.');
|
||||
logger.logBoxLine('Restarting NUPST service to apply changes...');
|
||||
|
||||
try {
|
||||
if (process.getuid && process.getuid() === 0) {
|
||||
// We have root access, restart directly
|
||||
execSync('systemctl restart nupst.service');
|
||||
logger.logBoxLine('Service restarted successfully.');
|
||||
} else {
|
||||
// No root access, show instructions
|
||||
logger.logBoxLine('Please restart the service with:');
|
||||
logger.logBoxLine(' sudo systemctl restart nupst.service');
|
||||
}
|
||||
} catch (error) {
|
||||
logger.logBoxLine(`Error restarting service: ${error.message}`);
|
||||
logger.logBoxLine('You may need to restart the service manually:');
|
||||
logger.logBoxLine(' sudo systemctl restart nupst.service');
|
||||
}
|
||||
|
||||
logger.logBoxEnd();
|
||||
}
|
||||
} catch (error) {
|
||||
// Ignore errors checking service status
|
||||
}
|
||||
}
|
||||
}
|
||||
38
ts/nupst.ts
38
ts/nupst.ts
@@ -2,9 +2,11 @@ import { NupstSnmp } from './snmp/manager.js';
|
||||
import { NupstDaemon } from './daemon.js';
|
||||
import { NupstSystemd } from './systemd.js';
|
||||
import { commitinfo } from './00_commitinfo_data.js';
|
||||
import { spawn } from 'child_process';
|
||||
import * as https from 'https';
|
||||
import { logger } from './logger.js';
|
||||
import { UpsHandler } from './cli/ups-handler.js';
|
||||
import { GroupHandler } from './cli/group-handler.js';
|
||||
import { ServiceHandler } from './cli/service-handler.js';
|
||||
import * as https from 'https';
|
||||
|
||||
/**
|
||||
* Main Nupst class that coordinates all components
|
||||
@@ -14,6 +16,9 @@ export class Nupst {
|
||||
private readonly snmp: NupstSnmp;
|
||||
private readonly daemon: NupstDaemon;
|
||||
private readonly systemd: NupstSystemd;
|
||||
private readonly upsHandler: UpsHandler;
|
||||
private readonly groupHandler: GroupHandler;
|
||||
private readonly serviceHandler: ServiceHandler;
|
||||
private updateAvailable: boolean = false;
|
||||
private latestVersion: string = '';
|
||||
|
||||
@@ -21,10 +26,16 @@ export class Nupst {
|
||||
* Create a new Nupst instance with all necessary components
|
||||
*/
|
||||
constructor() {
|
||||
// Initialize core components
|
||||
this.snmp = new NupstSnmp();
|
||||
this.snmp.setNupst(this); // Set up bidirectional reference
|
||||
this.daemon = new NupstDaemon(this.snmp);
|
||||
this.systemd = new NupstSystemd(this.daemon);
|
||||
|
||||
// Initialize handlers
|
||||
this.upsHandler = new UpsHandler(this);
|
||||
this.groupHandler = new GroupHandler(this);
|
||||
this.serviceHandler = new ServiceHandler(this);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -48,6 +59,27 @@ export class Nupst {
|
||||
return this.systemd;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the UPS handler for UPS management
|
||||
*/
|
||||
public getUpsHandler(): UpsHandler {
|
||||
return this.upsHandler;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Group handler for group management
|
||||
*/
|
||||
public getGroupHandler(): GroupHandler {
|
||||
return this.groupHandler;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the Service handler for service management
|
||||
*/
|
||||
public getServiceHandler(): ServiceHandler {
|
||||
return this.serviceHandler;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the current version of NUPST
|
||||
* @returns The current version string
|
||||
@@ -192,4 +224,4 @@ export class Nupst {
|
||||
logger.logBoxEnd();
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user