Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

test: Add CLI tests for setup commands, agent commands, and customizations #4060

Closed

Conversation

Samarthsinghal28
Copy link

Relates to

Ticket URL: Sifchain#394

Risks

Low – Changes are limited to CLI tests and should not affect other parts of the project.

Background

What does this PR do?

Adds CLI tests to the CLI package to improve test coverage and ensure CLI commands function correctly.

What kind of change is this?

  • Improvements (misc. changes to existing features)
  • Bug fixes (non-breaking change which fixes an issue)
  • Features (non-breaking change which adds functionality)
  • Updates (new versions of included code)

Documentation changes needed?

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.

Testing

Where should a reviewer start?

Start by reviewing the new CLI test cases in the cli package.

Detailed testing steps

  1. cd packages/cli
  2. Run the following test commands:
    • bun run test:setup-commands → Runs vitest test/setup-commands.test.js
    • bun run test:agent-commands → Runs vitest test/agent-commands.test.js
    • bun run test:agent-customisations → Runs vitest test/agent-customisation.test.js
  3. Verify that all new CLI tests pass.
  4. Check test coverage to ensure sufficient coverage of CLI functionality.

Copy link
Contributor

coderabbitai bot commented Mar 24, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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 docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@monilpat
Copy link
Collaborator

Thanks for adding this can you add either a screenshot or screen grab of a run of each of these tests? so output of bun run test:setup-commands → Runs vitest test/setup-commands.test.js bun run test:agent-commands → Runs vitest test/agent-commands.test.js bun run test:agent-customisations → Runs vitest test/agent-customisation.test.js

Copy link
Collaborator

@monilpat monilpat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing job on these tests thank you for getting to these so quickly and overall doing a great job of implementation. Added some comments that apply across all files to the first test file. Please let me know if you have any questions!

"clean": "rm -rf dist .turbo node_modules .turbo-tsconfig.json tsconfig.tsbuildinfo",
"test:setup-commands": "vitest test/setup-commands.test.js",
"test:agent-commands": "vitest test/agent-commands.test.js",
"test:agent-customisations": "vitest test/agent-customisation.test.js"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

customizations for both the command and file name

try {
await execAsync('elizaos stop', { reject: false });
} catch (e) {
// Server might not be running
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we elizaLogger.error the exception in this case?

bio: ["A test agent for integration testing."],
plugins: []
});
const projectRoot = path.resolve(__dirname, '../../..');
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any way to get the root without a relative path here as the file structure could change - no worries if not

@monilpat monilpat changed the title Add CLI tests for setup commands, agent commands, and customizations test: Add CLI tests for setup commands, agent commands, and customizations Mar 24, 2025
@wtfsayo wtfsayo added the V2 Eliza 0.2.0 label Mar 25, 2025
@harshal247
Copy link

harshal247 commented Mar 25, 2025

In reference to: Thanks for adding this can you add either a screenshot or screen grab of a run of each of these tests? so output of bun run test:setup-commands → Runs vitest test/setup-commands.test.js bun run test:agent-commands → Runs vitest test/agent-commands.test.js bun run test:agent-customisations → Runs vitest test/agent-customisation.test.js

Output of each execution (03/24/2025):

  1. bun run test:setup-commands → Runs vitest test/setup-commands.test.js
Screenshot 2025-03-25 at 11 33 26 AM
  1. bun run test:agent-commands → Runs vitest test/agent-commands.test.js
Screenshot 2025-03-25 at 10 35 46 AM
  1. bun run test:agent-customisations → Runs vitest test/agent-customisation.test.js
Screenshot 2025-03-25 at 11 33 43 AM

@harshal247 harshal247 mentioned this pull request Mar 25, 2025
@monilpat
Copy link
Collaborator

Closing as another PR is taking care of this

@monilpat monilpat closed this Mar 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
V2 Eliza 0.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants