fix: diagnostics: prevent warnings for non-existent files

[ljm42]

Summary by CodeRabbit

• Bug Fixes
  • Improved reliability of diagnostics by ensuring configuration and VM XML files are only copied if they exist, preventing unnecessary errors.
  • Enhanced error log formatting for better compatibility with Windows environments.

[coderabbitai]

Walkthrough

The diagnostics script was updated to enhance its robustness and compatibility when copying configuration and VM XML files. The log_error function was modified to use Windows-style line endings for error logs. Before attempting to copy configuration (.cfg, .conf, .dat) and VM XML files, the script now checks if such files exist using glob() with GLOB_BRACE. The cp command is invoked with -- to safely handle filenames that might start with hyphens, and copy operations are only performed if matching files are present.

Changes

File(s)	Change Summary
emhttp/plugins/dynamix/scripts/diagnostics	Updated log_error to use \r\n line endings; added existence checks using glob() before copying config and XML files; used cp -- for safer file copying.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DiagnosticsScript
    participant FileSystem

    User->>DiagnosticsScript: Run diagnostics
    DiagnosticsScript->>FileSystem: Check for config files (*.cfg, *.conf, *.dat)
    alt Config files exist
        DiagnosticsScript->>FileSystem: Copy config files to diagnostics dir
    end
    DiagnosticsScript->>FileSystem: Check for VM XML files (*.xml)
    alt XML files exist
        DiagnosticsScript->>FileSystem: Copy XML files to diagnostics dir
    end
    DiagnosticsScript->>FileSystem: Log errors with Windows line endings

Loading

Possibly related PRs

• fix: diagnostics improvements #2163: Refines the log_error function and adds existence checks before copying files, extending diagnostics script improvements.
• fix: diagnostics: ensure commands run with UTF-8 charset #2170: Modifies the log_error function and introduces conditional copying, directly building upon previous error logging enhancements.

Poem

A hop and a skip, diagnostics improved,
Checking for files before moves are approved.
With safer commands and logs crisp and clean,
The script now is smarter, robust, and keen.
🐇✨

No more errors from files that are gone—
The diagnostics rabbit hops on!

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro (Legacy)

📥 Commits

Reviewing files that changed from the base of the PR and between 1d45c81 and ce08973.

📒 Files selected for processing (1)

• emhttp/plugins/dynamix/scripts/diagnostics (3 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• emhttp/plugins/dynamix/scripts/diagnostics

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.