search

metaschema-framework / oscal-server

Other
3 stars 2 forks source link

use metaschema cli when needed #39

Open wandmagic opened 1 week ago

wandmagic commented 1 week ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 week ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The changes in the `OscalVerticle` class primarily involve enhancements to logging and error handling within the command execution methods. Key modifications include the addition of logging statements in the `executeCommand` and `handleValidateRequest` methods to improve traceability and debugging. The `handleValidateFileUpload` method has been updated to consistently include the `--show-stack-trace` argument, and the error handling in `executeCommand` has been refined to differentiate between commands from `metaschema` and `oscal` CLI tools. ## Changes | File Path | Change Summary | |-------------------------------------------------------|-----------------------------------------------------------------------------------------------------| | `src/main/kotlin/gov/nist/secauto/oscal/tools/server/OscalVerticle.kt` | - Added logging statements in `executeCommand` and `handleValidateRequest` methods.
- Updated `handleValidateFileUpload` to consistently add `--show-stack-trace` argument.
- Refined error handling in `executeCommand` to differentiate between `metaschema` and `oscal` commands.
- Updated method signature for `executeCommand`. | | `pom.xml` | - Updated `metaschema-framework.version` from `2.0.1` to `2.0.0`. | ## Poem > In the code where commands take flight, > Logging now shines, making errors bright. > With stack traces shown, we’ll see the way, > Debugging made easy, come what may. > A hop and a skip, through code we prance, > Enhancing our tools, giving bugs no chance! 🐇✨
📜 Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
📥 Commits Reviewing files that changed from the base of the PR and between 538d9cab5a1f704411c012238e058611a2eeffe0 and 99ec391c1289a75943e71bd8438719ac905624c9.
📒 Files selected for processing (2) * `pom.xml` (1 hunks) * `src/main/kotlin/gov/nist/secauto/oscal/tools/server/OscalVerticle.kt` (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * src/main/kotlin/gov/nist/secauto/oscal/tools/server/OscalVerticle.kt
🔇 Additional comments (2)
pom.xml (2) `27-27`: **Verify rationale for version downgrade** The metaschema-framework version is being downgraded from 2.0.1 to 2.0.0. This is unusual as it moves backwards in versioning, which could potentially introduce compatibility issues or regressions. ```shell #!/bin/bash # Description: Check release notes and issues for both versions to understand the changes and potential impacts # Check for issues mentioning version 2.0.1 echo "Checking for issues related to version 2.0.1..." gh issue list --repo metaschema-framework/metaschema -S "2.0.1 in:title,body" # Check for issues mentioning version 2.0.0 echo "Checking for issues related to version 2.0.0..." gh issue list --repo metaschema-framework/metaschema -S "2.0.0 in:title,body" # Check git tags for release notes echo "Checking release notes..." gh release view 2.0.1 --repo metaschema-framework/metaschema gh release view 2.0.0 --repo metaschema-framework/metaschema ``` --- `27-27`: **Verify compatibility across dependent components** The metaschema-framework version change affects multiple dependent components: - cli-processor - metaschema-cli - metaschema-schema-generator Please ensure that all these components are compatible with version 2.0.0 and that their functionality remains intact. Also applies to: 108-157

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.