search

onflow / flow-jvm-sdk

Flow JVM SDK
Apache License 2.0
16 stars 16 forks source link

Reorganize crypto-related test files #72

Closed tarakby closed 4 months ago

tarakby commented 4 months ago

This PR reorganizes the crypto related test files, to prepare for a follow-up refactor PR. There are no logic changes:

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

This update introduces significant changes to the cryptographic testing framework within the Flow SDK. The previous CryptoTest class has been replaced by a focused HashTest class, emphasizing hashing functionalities. Moreover, new tests have been added to ensure the reliability of key pair generation, decoding, and signature operations. Overall, these changes enhance the robustness and clarity of the cryptographic testing suite, promoting better maintenance and accuracy in future developments.

Changes

Files Change Summary
sdk/src/test/kotlin/org/onflow/flow/sdk/crypto/HashTest.kt, .../SignTest.kt HashTest replaces CryptoTest, focusing on hashing. New SignTest file adds tests for key pair generation, decoding, and signatures.
sdk/src/test/kotlin/org/onflow/flow/sdk/models/HashSigningAlgorithmTest.kt New tests for SignatureAlgorithm and HashAlgorithm, validating method functionalities and input handling.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CryptoClass
    participant HashingAlgorithm
    participant SignatureAlgorithm

    User->>CryptoClass: Request hasher
    CryptoClass->>HashingAlgorithm: Obtain hasher
    HashingAlgorithm->>CryptoClass: Return hasher
    CryptoClass->>User: Provide hasher

    User->>CryptoClass: Generate key pair
    CryptoClass->>SignatureAlgorithm: Create key pair
    SignatureAlgorithm->>CryptoClass: Return key pair
    CryptoClass->>User: Provide key pair

🐇 In the meadow where bunnies hop,
New tests flourish, they never stop!
Hashes and signatures, all in line,
With every change, the code will shine!
So let’s celebrate, with joy and cheer,
A cryptographic world, bright and clear! 🌟

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 .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### 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](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 4 months ago

Unit Test Results

0 files  ±0  0 suites  ±0   0s :stopwatch: ±0s 0 tests ±0  0 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit 78df08b2. ± Comparison against base commit 78df08b2.

:recycle: This comment has been updated with latest results.

github-actions[bot] commented 4 months ago

SDK Examples Unit Test Results

2 files  2 suites   33s :stopwatch: 6 tests 6 :heavy_check_mark: 0 :zzz: 0 :x:

Results for commit a8076aed.

github-actions[bot] commented 4 months ago

Integration Test Results

0 files  ±0  0 suites  ±0   0s :stopwatch: ±0s 0 tests ±0  0 :heavy_check_mark: ±0  0 :zzz: ±0  0 :x: ±0 

Results for commit 78df08b2. ± Comparison against base commit 78df08b2.

:recycle: This comment has been updated with latest results.