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

Problem: miss diff info when assert from test utils #1745

Merged
merged 3 commits into from
Feb 14, 2025

Conversation

mmsqe
Copy link
Collaborator

@mmsqe mmsqe commented Feb 13, 2025

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • Tests
    • Updated our testing configuration to specify which Python files to include for integration tests.
    • Simplified the command for running integration tests by removing the dependency on nix-shell.
    • Adjusted directory navigation in the test execution script for improved path structure.
    • Modified the coverage data input path for better organization.

@mmsqe mmsqe requested a review from a team as a code owner February 13, 2025 04:02
@mmsqe mmsqe requested review from JayT106 and leejw51crypto and removed request for a team February 13, 2025 04:02
Copy link
Contributor

coderabbitai bot commented Feb 13, 2025

Walkthrough

The pytest configuration for integration tests has been updated to specify that only Python files in the integration_tests directory (using the pattern integration_tests/*.py) should be considered for test discovery. Additionally, the Makefile has been modified to directly call the integration test script, simplifying the execution process. The run-integration-tests script has also been adjusted to navigate to a higher directory level and to specify the path for executing tests within a defined Nix shell environment.

Changes

File Change Summary
integration_tests/pytest.ini Added directive python_files = integration_tests/*.py to limit test files
Makefile Changed command to run integration tests from nix-shell to ./scripts/run-integration-tests
scripts/run-integration-tests Modified directory navigation from cd .. to cd ../.. and updated test execution command to nix-shell ./integration_tests/shell.nix --run "$cmd"
.github/workflows/test.yml Changed coverage data input path from integration_tests/coverage to coverage

Suggested reviewers

  • devashishdxt
  • yihuang
  • leejw51crypto

Poem

I’m a rabbit, hopping with delight,
Found tests confined and now in sight.
With ears alert and code so neat,
Integration paths make testing sweet.
Bounding forward with a cheerful beat! 🐰✨


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 115fe47 and 1efd266.

📒 Files selected for processing (1)
  • .github/workflows/test.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: integration_tests (gas)
  • GitHub Check: integration_tests (slow)
  • GitHub Check: integration_tests (upgrade)
  • GitHub Check: integration_tests (gov)
  • GitHub Check: integration_tests (ica)
  • GitHub Check: integration_tests (ibc_update_client)
  • GitHub Check: integration_tests (ibc_timeout)
  • GitHub Check: integration_tests (ibc_rly_gas)
  • GitHub Check: integration_tests (ibc_rly_evm)
  • GitHub Check: integration_tests (ibc)
  • GitHub Check: integration_tests (unmarked)
🔇 Additional comments (1)
.github/workflows/test.yml (1)

68-68:

❓ Verification inconclusive

LGTM! Coverage data path simplified.

The change to use coverage as the input path for coverage data aligns with the broader changes in test organization mentioned in the PR objectives and AI summary.

Let's verify that the coverage directory exists and is populated correctly:


🏁 Script executed:

#!/bin/bash
# Description: Verify the coverage directory structure and contents

# Check if the coverage directory exists and list its contents
ls -la coverage/

# Check if there are any references to the old path
rg -g '!.git' 'integration_tests/coverage'

Length of output: 118


Attention: Coverage Directory Missing

It appears that the workflow now references a coverage directory using the command:

go tool covdata textfmt -i=coverage -o profile.txt

However, our verification script shows that the coverage directory does not exist. Please check if the coverage data is being generated in a different directory or if an earlier step that should create this directory is missing. If the directory is generated dynamically, ensure that those steps run successfully before this command executes. Alternatively, update the workflow to point to the correct location.


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>, 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

codecov bot commented Feb 13, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 17.10%. Comparing base (a3c2f70) to head (1efd266).
Report is 36 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1745      +/-   ##
==========================================
+ Coverage   16.87%   17.10%   +0.23%     
==========================================
  Files          72       74       +2     
  Lines        6163     6184      +21     
==========================================
+ Hits         1040     1058      +18     
- Misses       5000     5002       +2     
- Partials      123      124       +1     

@yihuang
Copy link
Collaborator

yihuang commented Feb 13, 2025

What's the root cause?

@mmsqe
Copy link
Collaborator Author

mmsqe commented Feb 13, 2025

What's the root cause?

Seems only test_*.py and *_test.py has assert introspection by default, we might also include those test utils

@mmsqe mmsqe added this pull request to the merge queue Feb 14, 2025
Merged via the queue into crypto-org-chain:main with commit 5bdb927 Feb 14, 2025
35 checks passed
mmsqe added a commit to mmsqe/cronos that referenced this pull request Feb 18, 2025
…#1745)

* Problem: miss diff info when assert from test utils

* align rootdir

* fix upload
mmsqe added a commit that referenced this pull request Feb 20, 2025
* Problem: miss diff info when assert from test utils (#1745)

* Problem: miss diff info when assert from test utils

* align rootdir

* fix upload

* Problem: batch initialization when fixdata with dry-run is unnecessary (#1747)

* Problem: need batch initialization run fixdata with dry-run

* mod tidy

* skip flush

* Problem: need run fixdata multiple times when no timestamp checking

query with GetCFWithTS to compare both timestamp and key
mmsqe added a commit to mmsqe/cronos that referenced this pull request Feb 24, 2025
…#1745)

* Problem: miss diff info when assert from test utils

* align rootdir

* fix upload
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.

2 participants