Skip to content

Fix handling of Ruby versions. #1833

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.

Sign up for GitHub

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

Open
cwize1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix handling of Ruby versions. #1833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions src/Microsoft.ComponentDetection.Detectors/ruby/RubyComponentDetector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,17 +220,27 @@ private void ParseSection(ISingleFileComponentRecorder singleFileComponentRecord
wasParentDependencyExcluded = false;
var splits = line.Trim().Split(" ");
name = splits[0].Trim();
var version = splits[1][1..^1];
var fullVersion = splits[1][1..^1];
TypedComponent newComponent;

if (this.IsVersionRelative(version))
if (this.IsVersionRelative(fullVersion))
{
this.Logger.LogWarning("Found component with invalid version, name = {RubyComponentName} and version = {RubyComponentVersion}", name, version);
singleFileComponentRecorder.RegisterPackageParseFailure($"{name} - {version}");
this.Logger.LogWarning("Found component with invalid version, name = {RubyComponentName} and version = {RubyComponentVersion}", name, fullVersion);
singleFileComponentRecorder.RegisterPackageParseFailure($"{name} - {fullVersion}");
wasParentDependencyExcluded = true;
continue;
}

// Ruby version strings are formatted differently from pure semantic versioning.
// Specifically, everything after the dash is the platform, not the pre-release version. For
// example: "1.19.4-x86_64-linux-gnu". Ruby represents pre-release versions by placing a letter
// in the main version string. For example: "2.0.0.rc1".
// See: https://guides.rubygems.org/patterns/#prerelease-gems

// Remove the platform from the version string (if it exists).
var versionParts = fullVersion.Split("-", 2);
var version = versionParts[0];

if (sectionType == SectionType.GEM || sectionType == SectionType.PATH)
{
newComponent = new RubyGemsComponent(name, version, remote);
Expand Down
35 changes: 35 additions & 0 deletions test/Microsoft.ComponentDetection.Detectors.Tests/RubyDetectorTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,41 @@ public async Task TestRubyDetector_DetectorRecognizeLocalDependenciesAsync()
this.AssertRubyComponentNameAndVersion(detectedComponents, name: "test2", version: "1.0.0");
}

[TestMethod]
public async Task TestRubyDetector_StripPlatformAsync()
{
var gemFileLockContent = @"GEM
remote: https://rubygems.org/
specs:
nokogiri (1.19.4-aarch64-linux-gnu)
racc (~> 1.4)
nokogiri (1.19.4-aarch64-linux-musl)
racc (~> 1.4)
nokogiri (1.19.4-arm-linux-gnu)
racc (~> 1.4)
nokogiri (1.19.4-arm-linux-musl)
racc (~> 1.4)
nokogiri (1.19.4-arm64-darwin)
racc (~> 1.4)
nokogiri (1.19.4-x86_64-darwin)
racc (~> 1.4)
nokogiri (1.19.4-x86_64-linux-gnu)
racc (~> 1.4)
nokogiri (1.19.4-x86_64-linux-musl)
racc (~> 1.4)";

var (scanResult, componentRecorder) = await this.detectorTestUtility
.WithFile("1Gemfile.lock", gemFileLockContent)
.ExecuteDetectorAsync();

scanResult.ResultCode.Should().Be(ProcessingResultCode.Success);

var detectedComponents = componentRecorder.GetDetectedComponents();
detectedComponents.Should().HaveCount(1);

this.AssertRubyComponentNameAndVersion(detectedComponents, "nokogiri", "1.19.4");
}

private void AssertRubyComponentNameAndVersion(IEnumerable<DetectedComponent> detectedComponents, string name, string version)
{
detectedComponents.SingleOrDefault(c =>
Expand Down
Loading