Skip to content

Conversation

@UdjinM6
Copy link

@UdjinM6 UdjinM6 commented Dec 26, 2024

Issue being fixed or feature implemented

We kill CI script on test errors and it can't collect logs.

What was done?

Set CI_FAILFAST_TEST_LEAVE_DANGLING env variable to avoid that.

How Has This Been Tested?

1a69226: https://gitlab.com/dashpay/dash/-/jobs/8727924503

Breaking Changes

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have added or updated relevant unit/integration/functional/e2e tests
  • I have made corresponding changes to the documentation
  • I have assigned this pull request to a milestone (for repository code-owners and collaborators only)

@UdjinM6 UdjinM6 added this to the 22.1 milestone Dec 26, 2024
@UdjinM6 UdjinM6 changed the title Fix ci logs on failures ci: avoid killing the CI script itself on functional test error Dec 26, 2024
@UdjinM6 UdjinM6 changed the title ci: avoid killing the CI script itself on functional test error ci: avoid killing the CI script itself on functional test error Dec 26, 2024
@UdjinM6 UdjinM6 force-pushed the fix_ci_logs_on_failures branch from 1a69226 to 8413621 Compare December 26, 2024 21:15
@UdjinM6 UdjinM6 marked this pull request as ready for review December 26, 2024 21:15
@coderabbitai
Copy link

coderabbitai bot commented Dec 26, 2024

Walkthrough

The pull request modifies the .gitlab-ci.yml configuration by introducing a new environment variable CI_FAILFAST_TEST_LEAVE_DANGLING set to "1". This variable is added to the variables section of the GitLab CI configuration. The primary purpose of this change appears to be adjusting the CI pipeline's error handling mechanism, specifically related to how the pipeline manages dangling processes during test execution. By setting this variable, the CI script is configured to prevent premature termination when errors occur, potentially allowing for more comprehensive test execution and improved pipeline resilience. The modification is limited to this single variable addition and does not involve changes to other aspects of the CI pipeline's structure or logic.


📜 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 941e04e and 8413621.

📒 Files selected for processing (1)
  • .gitlab-ci.yml (1 hunks)
🔇 Additional comments (1)
.gitlab-ci.yml (1)

6-6: LGTM! Consider documenting cleanup procedures.

The addition of CI_FAILFAST_TEST_LEAVE_DANGLING effectively addresses the PR objective by preventing premature CI script termination, allowing proper collection of test logs for debugging. The inline comment clearly explains its purpose.

Let's verify the test job configurations:

Consider adding documentation about:

  1. How to identify and clean up any dangling processes that might be left behind
  2. Whether any manual intervention is needed after job completion
✅ Verification successful

Variable is correctly integrated and serves its intended purpose

After reviewing the codebase, I can confirm that:

  • The CI_FAILFAST_TEST_LEAVE_DANGLING variable is properly integrated into the test framework, specifically in test/functional/test_runner.py
  • The variable prevents the test runner from killing the process group when tests fail, allowing proper collection of logs and artifacts
  • The .test-template configuration properly handles test artifacts with after_script and artifacts sections that collect and preserve testlogs

The implementation is correct and safe because:

  1. The variable only affects the process cleanup behavior in the test runner
  2. Test artifacts are properly collected in the testlogs directory and preserved for 3 days
  3. The CI pipeline maintains proper job dependencies and artifact handling
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify test job configurations to ensure proper log collection
# Check if all test jobs inherit from .test-template and have proper artifact collection

# Look for test jobs and their configuration
rg "^[^.#].*-test:\$" -A 10

# Verify artifact collection in .test-template
rg "^\.test-template:" -A 20

Length of output: 59


Script:

#!/bin/bash
# Let's try a different approach to find test-related configurations
# First, let's see the content of .gitlab-ci.yml
cat .gitlab-ci.yml

# Also search for any references to CI_FAILFAST_TEST_LEAVE_DANGLING
rg "CI_FAILFAST_TEST_LEAVE_DANGLING" -B 2 -A 2

Length of output: 10511


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
Member

@PastaPastaPasta PastaPastaPasta left a comment

Choose a reason for hiding this comment

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

utACK 8413621

Copy link
Collaborator

@knst knst left a comment

Choose a reason for hiding this comment

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

LGTM 8413621

@PastaPastaPasta PastaPastaPasta merged commit da1963d into dashpay:develop Dec 28, 2024
21 checks passed
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.

3 participants