Skip to content

Fix freshly-cloned shared library checkout detection#489

Merged
nikita-tkachenko-datadog merged 3 commits into
masterfrom
nikita-tkachenko/shared-library-fresh-clone-fix
Jan 10, 2025
Merged

Fix freshly-cloned shared library checkout detection#489
nikita-tkachenko-datadog merged 3 commits into
masterfrom
nikita-tkachenko/shared-library-fresh-clone-fix

Conversation

@nikita-tkachenko-datadog

Copy link
Copy Markdown
Collaborator

Requirements for Contributing to this repository

  • Fill out the template below. Any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
  • The pull request must only fix one issue at the time.
  • The pull request must update the test suite to demonstrate the changed functionality.
  • After you create the pull request, all status checks must be pass before a maintainer reviews your contribution. For more details, please see CONTRIBUTING.

What does this PR do?

Fixes the logic that detects whether an SCM checkout is a shared library.

Current logic relies on the checked out folder path to detect shared libraries (there's a subfolder whose name ends with @libs in this case).
However, this does not work if the shared library is configured with a "Fresh clone per build" setting: in this case the folder structure is different, and the logic has to account for that.

Description of the Change

Alternate Designs

Possible Drawbacks

Verification Process

Additional Notes

Release Notes

Review checklist (to be filled by reviewers)

  • Feature or bug fix MUST have appropriate tests (unit, integration, etc...)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have one changelog/ label attached. If applicable it should have the backward-incompatible label attached.
  • PR should not have do-not-merge/ label attached.
  • If Applicable, issue must have kind/ and severity/ labels attached at least.

@nikita-tkachenko-datadog nikita-tkachenko-datadog added the changelog/Fixed Fixed features results into a bug fix version bump label Jan 8, 2025
@nikita-tkachenko-datadog
nikita-tkachenko-datadog marked this pull request as ready for review January 8, 2025 16:02

@drodriguezhdez drodriguezhdez left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Is it possible to add this new case to the current test?

@nikita-tkachenko-datadog

nikita-tkachenko-datadog commented Jan 10, 2025

Copy link
Copy Markdown
Collaborator Author

Is it possible to add this new case to the current test?

I've added some unit tests that verify the basic logic. It's rather difficult to cover this with proper tests because of the complexity of shared libraries set up (the library has to be checked out from a separate repository, and mocking is problematic too because many of the shared libs plugin classes are not public).

@nikita-tkachenko-datadog

Copy link
Copy Markdown
Collaborator Author

This can be tested manually too: the Dockerized instance contains a sample library and a pipeline that uses it.
The "fresh clone" option is a checkbox in the library settings:

image

@nikita-tkachenko-datadog
nikita-tkachenko-datadog merged commit 2fa7650 into master Jan 10, 2025
@nikita-tkachenko-datadog
nikita-tkachenko-datadog deleted the nikita-tkachenko/shared-library-fresh-clone-fix branch January 10, 2025 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog/Fixed Fixed features results into a bug fix version bump

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants