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

fix: [OSM-1797] Fixing multi-project bug related to Improved .NET scans #5354

Merged

Conversation

dotkas
Copy link
Contributor

@dotkas dotkas commented Jun 28, 2024

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

Fixes a bug related to multi-project .NET folder structures.

Where should the reviewer start?

How should this be manually tested?

  • git clone git@github.com:snyk/dotnet-fixtures.git
  • cd project-files/csproj/multiple-csproj-in-same-folder
  • snyk test --dotnet-runtime-resolution

Test fails with a dotnet error related to multiple projects in the same folder.

Do the same with this update, now it works.

Risk assessment

Low, no breaking changes are introduced.

Any background context you want to provide?

This is a part of the Improved .NET Beta and the changes have already been merged to the SCM version of this logic.

What are the relevant tickets?

https://snyksec.atlassian.net/browse/OSM-1797

Screenshots

N/A

Additional questions

We should wait with merging this until #5309 and #5276 are merged. This will most likely cause some simple merge conflicts.

@dotkas dotkas changed the title fix: [OSM-1797] Fixing bug with improved .NET scanning failing on multiple projects in same folder fix: [OSM-1797] Fixing multi-project bug related to Improved .NET scans Jun 28, 2024
@dotkas dotkas force-pushed the dotkas/OSM-1797/add-multi-project-support-for-improved-dotnet branch from 7c2bc17 to fbdbb31 Compare June 28, 2024 09:39
@dotkas dotkas marked this pull request as ready for review June 28, 2024 09:39
@dotkas dotkas requested a review from a team as a code owner June 28, 2024 09:39
@dotkas dotkas force-pushed the dotkas/OSM-1797/add-multi-project-support-for-improved-dotnet branch 3 times, most recently from 54f97f2 to 032f888 Compare July 2, 2024 08:48
Running `snyk test --dotnet-runtime-resolution` in folders that contained multiple `.csproj` files would fail as our logic was not directly referencing the project in question.

The updated plugin version fixes this and this PR contains acceptance tests for proof.
@dotkas dotkas force-pushed the dotkas/OSM-1797/add-multi-project-support-for-improved-dotnet branch from 032f888 to 83b5457 Compare July 8, 2024 08:28
Copy link
Contributor

github-actions bot commented Jul 8, 2024

Warnings
⚠️

Since the CLI is unifying on a standard and improved tooling, we're starting to migrate old-style imports and exports to ES6 ones.
A file you've modified is using either module.exports or require(). If you can, please update them to ES6 import syntax and export syntax.
Files found:

  • test/tap/cli-monitor.acceptance.test.ts

Generated by 🚫 dangerJS against d5ad0da

@dotkas dotkas force-pushed the dotkas/OSM-1797/add-multi-project-support-for-improved-dotnet branch 2 times, most recently from 4783446 to 93bdecd Compare July 9, 2024 06:56
@dotkas dotkas force-pushed the dotkas/OSM-1797/add-multi-project-support-for-improved-dotnet branch from 93bdecd to 987150e Compare July 9, 2024 08:17
@dotkas dotkas enabled auto-merge July 9, 2024 08:18
@dotkas dotkas merged commit b082b4c into main Jul 9, 2024
11 checks passed
@dotkas dotkas deleted the dotkas/OSM-1797/add-multi-project-support-for-improved-dotnet branch July 9, 2024 08:55
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