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

1057 trigger running foxx tests as part of ci #1096

Conversation

JoshuaSBrown
Copy link
Collaborator

@JoshuaSBrown JoshuaSBrown commented Nov 14, 2024

Summary by Sourcery

Integrate Foxx tests into the CI pipeline, allowing them to be triggered conditionally based on the ENABLE_FOXX_TESTS environment variable. Update Docker entrypoint scripts to support this conditional testing and modify logging behavior to append rather than overwrite. Update documentation to include new installation instructions for Docker.

CI:

  • Integrate Foxx tests into the CI pipeline, allowing them to be triggered conditionally based on the ENABLE_FOXX_TESTS environment variable.

Documentation:

  • Update documentation to include new installation instructions for Docker.

theodore-s-beers and others added 30 commits September 10, 2024 10:24
Append to log file instead of rewriting
Update admin installation documentation
Feature 1005 - Consolidate development environment setup into admin scripts
Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
…tup-container-to-stdout

Add log output from ci end-to-end arango-setup job
…-node-setup-job

1073 add missing deployment key to node setup job
grab log output even if container fails
Copy link

sourcery-ai bot commented Nov 14, 2024

Reviewer's Guide by Sourcery

This PR implements Foxx testing in the CI pipeline by modifying the entrypoint script to conditionally run tests when enabled. The changes include adding a new CMake option for Foxx testing, updating CI configuration to enable these tests, and improving container logging and error handling.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added conditional Foxx testing capability in the entrypoint script
  • Added ENABLE_FOXX_TESTS CMake option
  • Modified CMake configuration to conditionally include test flags
  • Added test execution step after Foxx installation
  • Implemented proper exit code handling for test failures
  • Reduced sleep time after installation from 1000 to 60 seconds
docker/entrypoint_foxx.sh
CMakeLists.txt
Enhanced CI pipeline configuration for Foxx testing
  • Added ENABLE_FOXX_TESTS environment variable to container configuration
  • Improved container status checking and logging
  • Added exit code verification for failed containers
  • Updated container log capture to include stopped containers
.gitlab/end_to_end.yml
.gitlab/common.yml
Improved repository container logging behavior
  • Modified log file handling to append instead of overwrite
  • Cleaned up script formatting and indentation
repository/docker/entrypoint_repo.sh

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@JoshuaSBrown JoshuaSBrown self-assigned this Nov 14, 2024
@JoshuaSBrown JoshuaSBrown added the Type: Test Related to unit or integration testing label Nov 14, 2024
@JoshuaSBrown JoshuaSBrown merged commit 00b0fcc into 1055-fix-foxx-setup-script Nov 14, 2024
11 of 12 checks passed
@JoshuaSBrown JoshuaSBrown deleted the 1057-trigger-running-foxx-tests-as-part-of-ci branch November 14, 2024 18:23
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @JoshuaSBrown - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

=================

Deploying DataFed requires building, installing, and configuring DataFed service as well as several
third-party packages/services. The process described here is automated as much as possible
Copy link

Choose a reason for hiding this comment

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

nitpick (typo): There appears to be an extra space after 'automated'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Test Related to unit or integration testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants