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

chore: run e2e tests in github actions #11

Merged
merged 6 commits into from
May 9, 2024
Merged

Conversation

boojamya
Copy link
Member

@boojamya boojamya commented Apr 29, 2024

closes #6

Summary by CodeRabbit

  • New Features

    • Introduced a Docker ignore configuration to enhance Docker build efficiency.
    • Added new GitHub Actions workflows for automated end-to-end and unit testing.
    • Updated configuration to specify build directories in chains.yaml.
  • Bug Fixes

    • Removed an unnecessary version specification in end-to-end test configuration to streamline testing procedures.
  • Chores

    • Adjusted Makefile to refine build target settings for better build process management.

Copy link

coderabbitai bot commented Apr 29, 2024

Warning

Rate Limit Exceeded

@johnletey has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 23 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 for further information.

Commits Files that changed from the base of the PR and between 8afaa84 and ca875d6.

Walkthrough

The updates focus on enhancing CI/CD processes by integrating end-to-end (E2E) and unit testing within GitHub Actions. A Dockerfile and .dockerignore streamline the Docker build context, while new workflows manage automated testing. Changes in configuration files and test scripts refine the setup, ensuring the application builds and tests efficiently across different environments.

Changes

File Path Change Summary
.dockerignore Excludes .github directory from Docker build context.
.github/workflows/... Added e2e-tests.yaml for E2E testing and unit-tests.yaml for unit testing in GitHub Actions.
Dockerfile Prepared for E2E testing by setting up build environment and application execution.
chains.yaml, simapp/Makefile Updated build-dir in chains.yaml and modified .PHONY declaration in Makefile.
e2e/forwarding_test.go Removed Version field from ChainSpec struct.

Assessment against linked issues

Objective Addressed Explanation
Running existing tests inside GitHub Actions (#6)

Poem

"In the burrows of code, where the data hops around,
A rabbit tweaked the lines, with hardly a sound.
🐇 Builds and tests, now smoothly flow,
In GitHub Actions, the CI does glow.
Cheers to the devs, from the burrows we cheer, 🎉
For making the code, ever so 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
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>.
    • 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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@boojamya boojamya force-pushed the dan/gh-actions-run-tests branch 2 times, most recently from ed0acff to 7892b89 Compare April 30, 2024 06:01
@boojamya boojamya marked this pull request as ready for review April 30, 2024 06:26
Copy link
Member

@johnletey johnletey left a comment

Choose a reason for hiding this comment

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

@boojamya Let's chat in our sync today about this. I was under the impression that we could simply use the heighliner-build-action, but also like the approach of a simple Dockerfile.

Either way, could we get newlines added to all end of files? See one of my comments below.

simapp/Makefile Outdated Show resolved Hide resolved
chains.yaml Show resolved Hide resolved
Copy link

@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

Out of diff range and nitpick comments (2)
.github/workflows/e2e-tests.bak (2)

1-1: Ensure the workflow name is descriptive and specific.

Consider renaming the workflow to something more descriptive, such as "Docker-based End-to-End Tests", to clearly distinguish its purpose in the CI/CD pipeline.


22-30: Optimize Docker image build process.

Consider optimizing the Docker image build process by specifying more efficient caching mechanisms or exploring multi-stage builds to reduce the build time and size of the Docker image.

.github/workflows/e2e-tests.bak Outdated Show resolved Hide resolved
@boojamya boojamya marked this pull request as draft April 30, 2024 20:37
Co-authored-by: John Letey <[email protected]>
Signed-off-by: Dan Kanefsky <[email protected]>
@boojamya boojamya marked this pull request as ready for review May 1, 2024 18:25
@boojamya
Copy link
Member Author

boojamya commented May 1, 2024

@boojamya Let's chat in our sync today about this. I was under the impression that we could simply use the heighliner-build-action, but also like the approach of a simple Dockerfile.

Either way, could we get newlines added to all end of files? See one of my comments below.

After a lot of testing, the action is working!

It required the SL team cutting a new release of heighliner as the old release was not compatible with go 1.22. For context, the action automatically uses the latest release of heighliner.

@boojamya boojamya requested a review from johnletey May 1, 2024 18:29
Copy link

@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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 337c6cf and 30dd707.
Files selected for processing (1)
  • .github/workflows/e2e-tests.yaml (1 hunks)
Files skipped from review due to trivial changes (1)
  • .github/workflows/e2e-tests.yaml

@johnletey johnletey changed the title chore: run e2e and unit tests in gh actions chore: run e2e tests in github actions May 9, 2024
Copy link

@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: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 30dd707 and 8afaa84.
Files selected for processing (1)
  • .github/workflows/e2e-tests.yaml (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • .github/workflows/e2e-tests.yaml

@coderabbitai coderabbitai bot changed the title chore: run e2e tests in github actions chore: run e2e and unit tests in gh actions May 9, 2024
@johnletey johnletey changed the title chore: run e2e and unit tests in gh actions chore: run e2e tests in github actions May 9, 2024
@johnletey johnletey merged commit 3cf6a2c into main May 9, 2024
7 checks passed
@johnletey johnletey deleted the dan/gh-actions-run-tests branch May 9, 2024 13:17
@johnletey johnletey added this to the v2.0.0 milestone May 30, 2024
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.

Running existing tests inside GitHub Actions
2 participants