feat: server info command by loadinglucian · Pull Request #62 · loadinglucian/deployer-php

loadinglucian · 2025-11-02T10:11:16Z

Summary by CodeRabbit

Release Notes

New Features
- Added a new server information command to display server details, system distribution, user permissions, and active service ports
- Introduced standardized server environment data collection with YAML output
Chores
- Established Bash script formatting standards with quality gates
- Updated configuration for consistent shell script indentation
- Improved console output formatting with better visual separation

Add PlaybookHelpersTrait providing executePlaybook() method for: - SSH-based playbook execution on remote servers - Environment variable injection - YAML output parsing and error handling - Integration with IOService for user feedback

Add server:info command to display server information: - Gathers distro, permissions, and listening ports via playbook - Displays formatted server details and services - Uses server-info.sh playbook for remote execution - Integrates with existing server selection flow

- Clarify playbooks must return parsable YAML as final output - Document error detection via YAML parsing failure - Add progress message guidelines (stderr vs stdout) - Update bash rules with quality gates section

- Add composer bash and bash:check scripts for shfmt - Add npm format:bash and check:bash scripts - Update .editorconfig for bash formatting consistency

coderabbitai · 2025-11-02T10:11:25Z

Walkthrough

This pull request introduces a new server:info console command that gathers and displays server environment data. It adds supporting infrastructure including a remote playbook execution trait, a server information display trait, a bash script for data collection, and build configuration for bash script formatting.

Changes

Cohort / File(s)	Summary
CLI Command Registration `app/Console/Server/ServerInfoCommand.php`, `app/SymfonyApp.php`	Introduces new `ServerInfoCommand` class with `server:info` command attribute and configure/execute methods; registers command in SymfonyApp's command list.
Command Output Formatting `app/Console/Server/ServerAddCommand.php`, `app/Console/Site/SiteAddCommand.php`	Adds blank line output after displaying details to improve visual separation.
Helper Traits `app/Traits/PlaybookHelpersTrait.php`, `app/Traits/ServerInfoTrait.php`	Introduces trait for executing remote playbooks over SSH with error handling and YAML parsing; adds trait for displaying server information with distro mapping and services enumeration.
Playbook Script `playbooks/server-info.sh`	New bash script detecting Linux distribution, user permissions, gathering listening ports with processes, and outputting structured YAML report.
Build Configuration `composer.json`, `package.json`	Adds npm-style scripts for formatting and checking bash scripts (`shfmt` with specific flags on `playbooks/*.sh`).
Static Configuration `.editorconfig`, `.cursor/rules/05-bash.mdc`, `.cursor/rules/06-playbooks.mdc`	Adds tab indentation rules for shell scripts; adds Quality Gates subsection for bash formatting; rewrites playbook output guidelines to enforce YAML on stdout with errors as plain text and progress on stderr.

Sequence Diagram

sequenceDiagram
    actor User
    participant ServerInfoCommand
    participant PlaybookHelpersTrait
    participant SSHService
    participant server-info.sh
    participant ServerInfoTrait
    
    User->>ServerInfoCommand: Execute server:info --server=name
    ServerInfoCommand->>ServerInfoCommand: selectServer()
    ServerInfoCommand->>PlaybookHelpersTrait: executePlaybook(server, "server-info")
    PlaybookHelpersTrait->>SSHService: Execute script over SSH
    SSHService->>server-info.sh: Run remotely
    server-info.sh->>server-info.sh: detect_distro()
    server-info.sh->>server-info.sh: check_permissions()
    server-info.sh->>server-info.sh: get_listening_ports()
    server-info.sh-->>SSHService: Return YAML output
    SSHService-->>PlaybookHelpersTrait: SSH output
    PlaybookHelpersTrait->>PlaybookHelpersTrait: Parse YAML
    PlaybookHelpersTrait-->>ServerInfoCommand: Parsed array or error code
    ServerInfoCommand->>ServerInfoTrait: displayServerInfo(array)
    ServerInfoTrait->>ServerInfoTrait: Format and map distro/permissions
    ServerInfoTrait-->>User: Display server information

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Key areas requiring attention:

PlaybookHelpersTrait: SSH command construction with heredoc wrapping, YAML parsing logic, and error handling paths—verify proper escaping and exception propagation
server-info.sh: Bash functions for permission elevation (run_cmd), tool detection, and port enumeration—verify cross-distro compatibility (Debian, RedHat, Amazon)
ServerInfoTrait: Mapping logic for distro codes and permission levels; conditional services enumeration—ensure all cases are handled gracefully
Integration points: Verify that IOService, SSHService, and FilesystemService dependencies are properly available in ServerInfoCommand and trait contexts

Possibly related PRs

feat: server crud commands #27: Introduces initial server CLI surface and ServerHelpersTrait that this PR builds upon with ServerInfoCommand and ServerInfoTrait
refactor: consolidate console io into ioservice #42: Establishes IOService I/O patterns and methods that PlaybookHelpersTrait and ServerInfoTrait depend on for output and error handling
feat: server repository crud #25: Introduces ServerDTO and ServerRepository infrastructure that ServerInfoCommand and related traits consume for server selection and data operations

Poem

🐰 A rabbit hops through servers far,
Gathering info near and far,
With YAML sage and playbooks keen,
The finest server facts we've seen!
Format bash, and info flows—
Adventure through the network shows! 🌟

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The pull request title "feat: server info command" accurately reflects the primary change in the changeset. The core addition is a new `ServerInfoCommand` console command that displays server information, as evidenced by the new `app/Console/Server/ServerInfoCommand.php` file and its registration in `app/SymfonyApp.php`. While the PR includes supporting infrastructure changes such as traits (`PlaybookHelpersTrait`, `ServerInfoTrait`), a new playbook script (`playbooks/server-info.sh`), and formatting configuration updates, these are all components that enable and support the main feature. The title is concise, uses conventional commit format, and clearly communicates the primary change without vagueness or unnecessary noise.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch feat/server-info-command

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

app/Traits/ServerInfoTrait.php (1)
63-79: Consider conditionally displaying the Services section.

Currently, displayDeets(['Services' => $services]) is called even when $services is empty (lines 78), which will render "Services:" with no items. Consider wrapping this in a condition:
-        $this->io->displayDeets(['Services' => $services]);
-        $this->io->writeln('');
+        if (count($services) > 0) {
+            $this->io->displayDeets(['Services' => $services]);
+            $this->io->writeln('');
+        }

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5c612de and 9d2281d.

📒 Files selected for processing (12)

.cursor/rules/05-bash.mdc (1 hunks)
.cursor/rules/06-playbooks.mdc (5 hunks)
.editorconfig (1 hunks)
app/Console/Server/ServerAddCommand.php (1 hunks)
app/Console/Server/ServerInfoCommand.php (1 hunks)
app/Console/Site/SiteAddCommand.php (1 hunks)
app/SymfonyApp.php (2 hunks)
app/Traits/PlaybookHelpersTrait.php (1 hunks)
app/Traits/ServerInfoTrait.php (1 hunks)
composer.json (1 hunks)
package.json (1 hunks)
playbooks/server-info.sh (1 hunks)

🧰 Additional context used

📓 Path-based instructions (5)

**/*.php

📄 CodeRabbit inference engine (.cursor/rules/00-main.mdc)

**/*.php: Eliminate single-use methods: inline if a method is called only once
Cache computed values: initialize expensive calculations in the constructor
Avoid method call overhead: prefer direct property access when appropriate

**/*.php: Adhere to PSR-12, enable strict_types, and leverage PHP 8.x features (union types, match, attributes, readonly)
Use explicit return types, including generic-like annotations where applicable (e.g., Collection<int, User>)
Prefer Symfony components (e.g., Filesystem, Process) over native PHP functions for testability
Always import classes via use statements; only use root FQDNs for core exceptions (e.g., \InvalidArgumentException, \RuntimeException). Do not use inline FQDNs for non-root namespaces
Create objects via $container->build(ClassName::class) everywhere except DTOs, value objects, and pure data structures
Use minimalist DocBlocks documenting description, parameters, and return types for classes and functions
Follow the specified comment structure with section headers/subheaders and spacing; remove obsolete comments with removed code

Files:

app/Console/Server/ServerAddCommand.php
app/Console/Site/SiteAddCommand.php
app/Traits/ServerInfoTrait.php
app/Traits/PlaybookHelpersTrait.php
app/SymfonyApp.php
app/Console/Server/ServerInfoCommand.php

**/*Command.php

📄 CodeRabbit inference engine (.cursor/rules/01-architecture.mdc)

**/*Command.php: Commands handle user interaction (I/O), orchestration, styling, error formatting, and prompts using SymfonyStyle
Commands must not contain business logic; delegate to Services
Commands must not invoke other commands (no proxy commands)

Files:

app/Console/Server/ServerAddCommand.php
app/Console/Site/SiteAddCommand.php
app/Console/Server/ServerInfoCommand.php

**/*{Command,Service}.php

📄 CodeRabbit inference engine (.cursor/rules/01-architecture.mdc)

All dependencies should be expressed in constructor signatures; avoid circular dependencies

Files:

app/Console/Server/ServerAddCommand.php
app/Console/Site/SiteAddCommand.php
app/Console/Server/ServerInfoCommand.php

{composer.json,package.json}

📄 CodeRabbit inference engine (.cursor/rules/00-main.mdc)

Check composer.json and package.json for installed packages before any task

Files:

package.json
composer.json

**/SymfonyApp.php

📄 CodeRabbit inference engine (.cursor/rules/01-architecture.mdc)

Register console commands in SymfonyApp.php

Files:

app/SymfonyApp.php

🧠 Learnings (17)

📚 Learning: 2025-10-24T20:03:23.947Z

Learnt from: CR
Repo: bigpixelrocket/deployer-php PR: 0
File: .cursor/rules/rules.mdc:0-0
Timestamp: 2025-10-24T20:03:23.947Z
Learning: Applies to **/*.{md,mdc} : Before commit: confirm critical rules are still emphasized (without repetition)

Applied to files:

.cursor/rules/05-bash.mdc

📚 Learning: 2025-09-22T11:10:45.309Z

Learnt from: CR
Repo: deployer-plus/deployer-php PR: 0
File: .cursor/rules/02-code-quality.mdc:0-0
Timestamp: 2025-09-22T11:10:45.309Z
Learning: Applies to {app,tests}/**/*.php : Run Pint (code style fixer) on all changed PHP files before completing a task

Applied to files:

.cursor/rules/05-bash.mdc

📚 Learning: 2025-10-24T20:03:23.947Z

Learnt from: CR
Repo: bigpixelrocket/deployer-php PR: 0
File: .cursor/rules/rules.mdc:0-0
Timestamp: 2025-10-24T20:03:23.947Z
Learning: Applies to **/*.{md,mdc} : Target rule density per file: Language style (Bash/PHP) 60–100 lines

Applied to files:

.cursor/rules/05-bash.mdc

📚 Learning: 2025-10-24T19:59:22.873Z

Learnt from: CR
Repo: bigpixelrocket/deployer-php PR: 0
File: .cursor/rules/01-architecture.mdc:0-0
Timestamp: 2025-10-24T19:59:22.873Z
Learning: Applies to bin/deployer : Application entry point is bin/deployer

Applied to files:

.cursor/rules/06-playbooks.mdc

📚 Learning: 2025-09-21T08:52:38.782Z

Learnt from: CR
Repo: deployer-plus/deployer-php PR: 0
File: .cursor/rules/00-main.mdc:0-0
Timestamp: 2025-09-21T08:52:38.782Z
Learning: Applies to **/{composer.json,package.json} : Plan implementation using features supported by the major versions specified in composer.json and package.json

Applied to files:

composer.json

📚 Learning: 2025-09-21T08:52:38.782Z

Learnt from: CR
Repo: deployer-plus/deployer-php PR: 0
File: .cursor/rules/00-main.mdc:0-0
Timestamp: 2025-09-21T08:52:38.782Z
Learning: Applies to **/{composer.json,package.json} : Check composer.json and package.json for installed packages before starting any task

Applied to files:

composer.json

📚 Learning: 2025-10-24T19:58:34.899Z

Learnt from: CR
Repo: bigpixelrocket/deployer-php PR: 0
File: .cursor/rules/00-main.mdc:0-0
Timestamp: 2025-10-24T19:58:34.899Z
Learning: Applies to {composer.json,package.json} : Check composer.json and package.json for installed packages before any task

Applied to files:

composer.json

📚 Learning: 2025-10-24T19:59:22.873Z

Learnt from: CR
Repo: bigpixelrocket/deployer-php PR: 0
File: .cursor/rules/01-architecture.mdc:0-0
Timestamp: 2025-10-24T19:59:22.873Z
Learning: Applies to **/SymfonyApp.php : Register console commands in SymfonyApp.php

Applied to files:

app/SymfonyApp.php

📚 Learning: 2025-10-24T20:01:06.242Z

Learnt from: CR
Repo: bigpixelrocket/deployer-php PR: 0
File: .cursor/rules/03-commands.mdc:0-0
Timestamp: 2025-10-24T20:01:06.242Z
Learning: Applies to src/Command/**/*Command.php : Option naming: --server/--site select existing resources; --name defines a new resource property; follow the provided table for common options.

Applied to files:

app/SymfonyApp.php
app/Console/Server/ServerInfoCommand.php