Skip to content
Snippets Groups Projects

Add config file class for C# nuget `*.csproj`

Merged Leaminn Ma requested to merge add-c-sharp-nuget-config-file-class into master
All threads resolved!

What does this MR do and why?

Background

The Repository X-Ray is a tool that searches for dependency manager configuration or lock files and then extracts a list of libraries from the content.

In #474306 (comment 2025085630), we decided to migrate the Repository X-Ray functionality into the GitLab Rails monolith. This gives us two main benefits: (i) it will eventually allow us to run the service outside of the CI pipeline, and (ii) we can maintain the parsing logic centrally so that other domains can utilize it.

Base MR

In !162313 (merged), we introduced the ConfigFiles::Base class where the intention is for each dependency manager config file type to be represented by a child class. The child class contains the parsing logic to extract a list of libraries and their versions from the file content.

This MR

In this MR, we introduce the CsharpNuget config file class that parses *.csproj for the language C#.

For references to the existing parsing logic in the Repository X-Ray repo, see:

Resolves part of #476177 (closed).

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

How to set up and validate locally

  1. Enable the feature flag: Feature.enable(:ai_enable_internal_repository_xray_service)

  2. Create a new blank project and add the following file to the repo:

subdir/MyProj.csproj:

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net8.0</TargetFramework>
    <Nullable>enable</Nullable>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.1" />
    <PackageReference Include="MessagePack" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Design">
      <PrivateAssets>all</PrivateAssets>
    </PackageReference>
    <PackageReference Include="Sentry" Version="5.3.1" PrivateAssets="All" />
  </ItemGroup>

  <ItemGroup>
    <ProjectReference Include="..local/.Date.csproj" />
  </ItemGroup>

  <ItemGroup>
    <None Include="artifacts-icon.png" Pack="true" />
    <None Include="README.md" Pack="true" />
  </ItemGroup>
</Project>
  1. Observe that the X-ray report for the config file is recorded:
project = Project.last # Should be the project you created earlier
project.reload.xray_reports

Screenshot_2024-09-17_at_3.28.51_PM

Related to #476177 (closed)

Edited by Leaminn Ma

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
  • Leaminn Ma added 215 commits

    added 215 commits

    Compare with previous version

  • A deleted user added documentation label

    added documentation label

  • Leaminn Ma requested review from @imand3r and removed review request for @praba.m7n

    requested review from @imand3r and removed review request for @praba.m7n

  • Ian Anderson approved this merge request

    approved this merge request

  • Ian Anderson requested review from @hustewart

    requested review from @hustewart

  • Hunter Stewart approved this merge request

    approved this merge request

  • Before you set this MR to auto-merge

    This merge request will progress on pipeline tiers until it reaches the last tier: pipelinetier-3. We will trigger a new pipeline for each transition to a higher tier.

    Before you set this MR to auto-merge, please check the following:

    • You are the last maintainer of this merge request
    • The latest pipeline for this merge request is pipelinetier-3 (You can find which tier it is in the pipeline name)
    • This pipeline is recent enough (created in the last 8 hours)

    If all the criteria above apply, please set auto-merge for this merge request.

    See pipeline tiers and merging a merge request for more details.

  • Hunter Stewart resolved all threads

    resolved all threads

  • Hunter Stewart enabled automatic add to merge train when checks pass

    enabled automatic add to merge train when checks pass

  • E2E Test Result Summary

    allure-report-publisher generated test report!

    e2e-test-on-gdk: :white_check_mark: test report for 0cf7f419

    expand test summary
    +------------------------------------------------------------------+
    |                          suites summary                          |
    +-------------+--------+--------+---------+-------+-------+--------+
    |             | passed | failed | skipped | flaky | total | result |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Data Stores | 33     | 0      | 1       | 0     | 34    | ✅     |
    | Package     | 24     | 0      | 11      | 0     | 35    | ✅     |
    | Release     | 5      | 0      | 0       | 0     | 5     | ✅     |
    | Create      | 128    | 0      | 17      | 0     | 145   | ✅     |
    | Plan        | 75     | 0      | 1       | 1     | 76    | ✅     |
    | Verify      | 46     | 0      | 2       | 0     | 48    | ✅     |
    | Secure      | 4      | 0      | 0       | 0     | 4     | ✅     |
    | Govern      | 72     | 0      | 0       | 0     | 72    | ✅     |
    | Monitor     | 8      | 0      | 0       | 0     | 8     | ✅     |
    | Analytics   | 2      | 0      | 0       | 0     | 2     | ✅     |
    | Manage      | 1      | 0      | 1       | 0     | 2     | ✅     |
    | Fulfillment | 2      | 0      | 0       | 0     | 2     | ✅     |
    +-------------+--------+--------+---------+-------+-------+--------+
    | Total       | 400    | 0      | 33      | 1     | 433   | ✅     |
    +-------------+--------+--------+---------+-------+-------+--------+

    e2e-test-on-omnibus: :x: test report for 0cf7f419

    expand test summary
    +-------------------------------------------------------------+
    |                       suites summary                        |
    +--------+--------+--------+---------+-------+-------+--------+
    |        | passed | failed | skipped | flaky | total | result |
    +--------+--------+--------+---------+-------+-------+--------+
    | Create | 553    | 1      | 76      | 2     | 630   | ❌     |
    +--------+--------+--------+---------+-------+-------+--------+
    | Total  | 553    | 1      | 76      | 2     | 630   | ❌     |
    +--------+--------+--------+---------+-------+-------+--------+
  • Hunter Stewart mentioned in commit 896f8a79

    mentioned in commit 896f8a79

  • added workflowstaging label and removed workflowcanary label

  • Please register or sign in to reply
    Loading