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: plugin-tee - adjusting project structure and new tests #2508

Merged
merged 3 commits into from
Jan 19, 2025

Conversation

ai16z-demirix
Copy link
Contributor

@ai16z-demirix ai16z-demirix commented Jan 18, 2025

Relates to

#2507

Risks

Low: adding tests and adjusting configuration

Background

What does this PR do?

#2507

What kind of change is this?

Features:tests

#2507

Documentation changes needed?

None

Testing

Where should a reviewer start?

Detailed testing steps

Summary by CodeRabbit

  • Refactor

    • Updated import paths in test files to reference the src directory
    • Simplified test cases for key derivation and remote attestation
  • Tests

    • Added new test suite for timeout handling in TEE providers
    • Modified assertions in remote attestation and key derivation tests
    • Improved error handling test coverage for API timeouts

Copy link
Contributor

coderabbitai bot commented Jan 18, 2025

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/plugin-tee/__tests__/deriveKey.test.ts

Oops! Something went wrong! :(

ESLint: 9.18.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

📝 Walkthrough

Walkthrough

The pull request focuses on updating import paths in the plugin-tee package's test files, specifically moving imports from relative paths to explicitly reference the src directory. The changes primarily affect test files for deriveKey, remoteAttestation, remoteAttestationAction, and introduce a new timeout.test.ts file for testing timeout scenarios in TEE providers.

Changes

File Change Summary
__tests__/deriveKey.test.ts - Updated import paths for DeriveKeyProvider and TEEMode to use ../src/
- Simplified test case for deriveEd25519Keypair
- Removed deriveEcdsaKeypair test
__tests__/remoteAttestation.test.ts - Updated import paths for RemoteAttestationProvider and TEEMode to use ../src/
__tests__/remoteAttestationAction.test.ts - Updated import paths for remoteAttestationAction and RemoteAttestationProvider
- Modified assertions in example conversations
__tests__/timeout.test.ts - Added new test suite for timeout handling
- Implemented tests for RemoteAttestationProvider and DeriveKeyProvider timeout scenarios

Possibly related PRs

Finishing Touches

  • 📝 Generate Docstrings (Beta)

🪧 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. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (3)
packages/plugin-tee/__tests__/timeout.test.ts (2)

8-13: Consider adding timeout duration to mock implementation.

The mock could be enhanced to simulate different timeout durations and verify timeout handling behavior.

 vi.mock('@phala/dstack-sdk', () => ({
     TappdClient: vi.fn().mockImplementation(() => ({
-        tdxQuote: vi.fn(),
-        deriveKey: vi.fn()
+        tdxQuote: vi.fn().mockImplementation(() => new Promise((_, reject) => 
+            setTimeout(() => reject(new Error('Request timed out')), 5000)
+        )),
+        deriveKey: vi.fn().mockImplementation(() => new Promise((_, reject) => 
+            setTimeout(() => reject(new Error('Request timed out')), 5000)
+        ))
     }))
 }));

35-61: Test edge cases in DeriveKeyProvider timeout handling.

The test suite should verify behavior with:

  • Partial timeouts (success after initial failure)
  • Multiple consecutive timeouts
  • Different key types
packages/plugin-tee/__tests__/remoteAttestationAction.test.ts (1)

95-101: Enhance example conversation test coverage.

The test verifies basic action properties but could be expanded to test:

  • Multiple conversation examples
  • Error scenarios in conversations
  • Action parameter validation
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3512475 and 9e48e09.

📒 Files selected for processing (4)
  • packages/plugin-tee/__tests__/deriveKey.test.ts (2 hunks)
  • packages/plugin-tee/__tests__/remoteAttestation.test.ts (1 hunks)
  • packages/plugin-tee/__tests__/remoteAttestationAction.test.ts (2 hunks)
  • packages/plugin-tee/__tests__/timeout.test.ts (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • packages/plugin-tee/tests/remoteAttestation.test.ts
🔇 Additional comments (1)
packages/plugin-tee/__tests__/deriveKey.test.ts (1)

104-108: Verify if ECDSA support has been deprecated.

The ECDSA test case was removed. Please confirm if ECDSA support is still maintained.

packages/plugin-tee/__tests__/timeout.test.ts Outdated Show resolved Hide resolved
@ai16z-demirix ai16z-demirix changed the title test: plugin-tee - adjusting project strucutre and new tests test: plugin-tee - adjusting project structure and new tests Jan 18, 2025
Copy link
Collaborator

@HashWarlock HashWarlock left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for updating tests

@ai16z-demirix
Copy link
Contributor Author

@HashWarlock Thank you for setting a very good base here.

@wtfsayo wtfsayo merged commit 319840c into elizaOS:develop Jan 19, 2025
6 of 7 checks passed
mgunnin added a commit to mgunnin/eliza-agent that referenced this pull request Jan 19, 2025
* upstream/develop:
  plugin-tts: enhance TTS generation flow and caching (elizaOS#2506)
  chore: add eliza technical report/paper (elizaOS#2517)
  feat: plugin rabbi trader tests (elizaOS#2520)
  Replace user ID with room ID in MemoryManager and other improvements (elizaOS#2492)
  test: plugin-tee - adjusting project structure and new tests (elizaOS#2508)
  fix: use header key from api config (elizaOS#2518)
  docs: add docs/README_JA.md (elizaOS#2515)
  AgentKit - Default Agent Config (elizaOS#2505)
  feat(plugin-openai): add OpenAI integration for text generation (elizaOS#2463)
  feat: add support for NVIDIA inference for ElizaOS (elizaOS#2512)
  test: api timeout handling for plugin-binance (elizaOS#2504)
  Replace type assertions
  Replace type assertions
  destroy file system after sending media
  support multimedia
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants