2lambda123 / ethereum-js-ethereum-cryptography

MIT License
0 stars 0 forks source link

Switch to micro-should #2

Closed 2lambda123 closed 3 months ago

2lambda123 commented 3 months ago

Description

In this pull request, several modifications and additions have been made to the test vectors across various test files in the project. Additionally, a new test-vectors/index.ts file has been added to aggregate and run tests for all modules. Here's a summary of the changes:

List of changes:

These changes aim to enhance the test structure and organization in the project by using the micro-should testing library and aggregating tests into a single file.

Summary by Sourcery

Switch to using 'micro-should' for test descriptions and assertions in various test files, removing the use of timeout settings in tests.

Enhancements:

Summary by CodeRabbit

cr-gpt[bot] commented 3 months ago

Seems you are using me but didn't get OPENAI_API_KEY seted in Variables/Secrets for this repo. you could follow readme for more information

code-companion-ai[bot] commented 3 months ago

Processing PR updates...

git-greetings[bot] commented 3 months ago

Thanks @2lambda123 for opening this PR!

For COLLABORATOR only :

performance-testing-bot[bot] commented 3 months ago

Unable to locate .performanceTestingBot config file

codeautopilot[bot] commented 3 months ago

Your organization has reached the subscribed usage limit. You can upgrade your account by purchasing a subscription at Stripe payment link

git-greetings[bot] commented 3 months ago
PR Details of @2lambda123 in ethereum-js-ethereum-cryptography : OPEN CLOSED TOTAL
2 0 2
sourcery-ai[bot] commented 3 months ago

Reviewer's Guide by Sourcery

This pull request switches the testing framework to micro-should. The changes involve importing the 'describe' and 'it' functions from micro-should in multiple test files, and removing or commenting out 'this.timeout()' calls. This change affects several test vector files across different cryptographic functions.

File-Level Changes

Files Changes
test/test-vectors/scrypt.ts
test/test-vectors/aes.ts
test/test-vectors/blake2b.ts
test/test-vectors/hdkey.ts
test/test-vectors/keccak.ts
test/test-vectors/pbkdf2.ts
test/test-vectors/ripemd160.ts
test/test-vectors/sha256.ts
test/test-vectors/sha512.ts
Import 'describe' and 'it' functions from micro-should
test/test-vectors/scrypt.ts Remove or comment out 'this.timeout()' calls

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
quine-bot[bot] commented 3 months ago

👋 Figuring out if a PR is useful is hard, hopefully this will help.

  • @2lambda123 has been on GitHub since 2019 and in that time has had 2579 public PRs merged
  • They haven't contributed to this repo before
  • Here's a good example of their work: black-forest-labs-flux
  • From looking at their profile, they seem to be good with Java and Shell.

Their most recently public accepted PR is: https://github.com/2lambda123/yotadevices-Viscera/pull/1

code-companion-ai[bot] commented 3 months ago

Description has been updated!

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@labels-and-badges[bot] has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 5 minutes and 30 seconds before requesting another review.

How to resolve this issue? After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.
How do rate limits work? CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between 9faadf5f1dda4aa95cc675d927281862ac7bf7e7 and 136f5f16bdc8a68e2c7dca46ec55c45fc75dedf6.

Walkthrough

The update introduces the micro-should testing library to enhance the project's testing framework. This change allows for a more structured, behavior-driven approach to test writing across various cryptographic modules. The addition promotes better readability and maintainability of the test code, while a new aggregate test index file organizes the testing environment.

Changes

Files Change Summary
package.json Added "micro-should": "^0.3.0" to dependencies for enhanced testing capabilities.
test/test-vectors/*.ts Imported describe and it from micro-should in multiple test files, enabling a structured testing approach for various cryptographic functionalities.
test/test-vectors/index.ts Introduced a new module to aggregate tests from various cryptographic utilities, setting up the testing environment with micro-should.

Sequence Diagram(s)

sequenceDiagram
    participant T as Test Files
    participant M as micro-should Library
    participant I as Index File

    T->>M: Import describe, it
    T->>I: Run tests
    I->>M: Execute test cases
    M-->>T: Return test results

Poem

🐰 In the garden of code, new blooms arise,
With micro-should sprouting, watch tests mesmerize.
Each case a delight, structured with care,
A dance of assertions, in the crisp morning air.
So hop with joy, for clarity's here,
In the realm of testing, let’s all cheer! 🎉


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.