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: testground testcase output artifact not collectiable in k8s workflow #1535

Merged
merged 2 commits into from
Aug 2, 2024

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Aug 2, 2024

Solution:

  • create static filename for argo artifact collection

The k8s workflow will have a static path to collect the artifacts: /data.tar.bz2

👮🏻👮🏻👮🏻 !!!! 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

  • New Features

    • Improved output data handling by creating tarballs in a temporary location before transferring to the final output directory.
  • Bug Fixes

    • Enhanced error reduction related to file handling during tarball creation and output.
  • Refactor

    • Simplified the run function by removing unnecessary filename generation logic, leading to clearer code structure.

…workflow

Solution:
- create static filename for argo artifact collection
Copy link
Contributor

coderabbitai bot commented Aug 2, 2024

Walkthrough

The recent changes in the stateless.py file streamline output data management by creating a tarball in a temporary location before copying it to the output directory. This adjustment simplifies the process, enhances maintainability, and clarifies file handling by decoupling tarball creation from its final destination.

Changes

Files Change Summary
testground/benchmark/benchmark/stateless.py The run function now creates a tarball in a temporary location and copies it to the output directory instead of creating it directly there. The function parameters have been simplified by removing the group and group sequence.

Sequence Diagram(s)

sequenceDiagram
    participant A as Process
    participant B as Temp Storage
    participant C as Output Directory

    A->>B: Create tarball at /data.tar.bz2
    B->>C: Copy tarball to output directory
    C-->>A: Confirmation of file copy
Loading

Poem

🐇 In a world of data, a rabbit hops,
Through tarballs and paths, it never stops.
A temporary home, then off to roam,
To the output's embrace, it finds its home.
With joy in the bytes, we celebrate now,
For clarity reigns, and we take a bow! 🌟


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.
    • @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 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 Aug 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 15.24%. Comparing base (281b830) to head (4a2d546).

❗ There is a different number of reports uploaded between BASE (281b830) and HEAD (4a2d546). Click for more details.

HEAD has 12 uploads less than BASE
Flag BASE (281b830) HEAD (4a2d546)
2 0
integration_tests 20 10
Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #1535       +/-   ##
===========================================
- Coverage   36.12%   15.24%   -20.89%     
===========================================
  Files          97       67       -30     
  Lines        7725     4874     -2851     
===========================================
- Hits         2791      743     -2048     
+ Misses       4585     4037      -548     
+ Partials      349       94      -255     

see 47 files with indirect coverage changes

@yihuang yihuang marked this pull request as ready for review August 2, 2024 03:11
@yihuang yihuang requested a review from a team as a code owner August 2, 2024 03:11
@yihuang yihuang requested review from JayT106, thomas-nguy and mmsqe and removed request for a team August 2, 2024 03:11
@yihuang yihuang enabled auto-merge August 2, 2024 03:12
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: 2

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 281b830 and ee2b8b7.

Files selected for processing (1)
  • testground/benchmark/benchmark/stateless.py (1 hunks)
Additional comments not posted (1)
testground/benchmark/benchmark/stateless.py (1)

154-156: Verify the function usage in the codebase.

The function signature has been modified. Ensure that all calls to the run function are updated to match the new signature.

testground/benchmark/benchmark/stateless.py Show resolved Hide resolved
testground/benchmark/benchmark/stateless.py Show resolved Hide resolved
@yihuang yihuang requested a review from mmsqe August 2, 2024 04:46
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

Outside diff range, codebase verification and nitpick comments (1)
testground/benchmark/benchmark/stateless.py (1)

154-154: Ensure the directory check is necessary.

The assertion ensures that outdir is a directory. If this check is necessary, consider adding a more descriptive error message for clarity.

assert outdir.is_dir(), f"Output directory {outdir} is not a directory."
Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ee2b8b7 and 4a2d546.

Files selected for processing (1)
  • testground/benchmark/benchmark/stateless.py (1 hunks)
Additional comments not posted (2)
testground/benchmark/benchmark/stateless.py (2)

149-151: Add error handling for file operations.

The current implementation does not handle potential errors that might occur during file operations, such as creating or writing to the tarball.

try:
    with tarfile.open(output, "x:bz2") as tar:
        tar.add(home, arcname="data")
except Exception as e:
    print(f"Error creating tarball: {e}")
    return

149-149: Avoid using hardcoded paths.

The use of hardcoded paths like /data.tar.bz2 can lead to issues in different environments. Consider using a more flexible approach.

output = Path(tempfile.gettempdir()) / "data.tar.bz2"

testground/benchmark/benchmark/stateless.py Show resolved Hide resolved
@yihuang yihuang added this pull request to the merge queue Aug 2, 2024
Merged via the queue into crypto-org-chain:main with commit 918fede Aug 2, 2024
33 of 34 checks passed
@yihuang yihuang deleted the output-artifact branch August 2, 2024 05:19
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