Skip to content

Special case scratch base image #173

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

Merged
merged 3 commits into from
Aug 4, 2022
Merged

Special case scratch base image #173

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
33faf33
Special case scratch base image
Jul 21, 2022
a9b86fe
add test for scratch handling
Jul 21, 2022
cf5dbad
Merge branch 'main' into tofay/fix-scratch-based-image
JamieMagee Aug 4, 2022
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
6 changes: 5 additions & 1 deletion src/Microsoft.ComponentDetection.Detectors/linux/LinuxContainerDetector.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,10 +214,14 @@ private async Task<int> GetBaseImageLayerCount(ContainerDetails scannedImageDeta
record.BaseImageLayerMessage = $"Base image annotations not found on image {image}, Results will not be mapped to base image layers";
Logger.LogInfo(record.BaseImageLayerMessage);
return 0;
} else if (scannedImageDetails.BaseImageRef == "scratch") {
record.BaseImageLayerMessage = $"{image} has no base image";
Logger.LogInfo(record.BaseImageLayerMessage);
return 0;
}

var baseImageDigest = scannedImageDetails.BaseImageDigest;
var refWithDigest = scannedImageDetails.BaseImageRef + (baseImageDigest != string.Empty ? $"@{baseImageDigest}" : string.Empty);
var refWithDigest = scannedImageDetails.BaseImageRef + (!string.IsNullOrEmpty(baseImageDigest) ? $"@{baseImageDigest}" : string.Empty);
record.BaseImageDigest = baseImageDigest;
record.BaseImageRef = scannedImageDetails.BaseImageRef;

Expand Down
13 changes: 13 additions & 0 deletions test/Microsoft.ComponentDetection.Detectors.Tests/LinuxContainerDetectorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,5 +205,18 @@ public async Task TestLinuxContainerDetector_TimeoutParameterSpecified()
Func<Task> action = async () => await linuxContainerDetector.ExecuteDetectorAsync(scanRequest);
await action.Should().NotThrowAsync<OperationCanceledException>();
}

[TestMethod]
public async Task TestLinuxContainerDetector_HandlesScratchBase() {
// Setup docker service to throw an exception on scratch
// then specify that the base image is scratch, to test this
// is coped with.
mockDockerService.Setup(service => service.TryPullImageAsync("scratch", It.IsAny<CancellationToken>()))
.Throws(new IOException());
mockDockerService.Setup(service => service.InspectImageAsync(It.IsAny<string>(), It.IsAny<CancellationToken>()))
// Specify BaseImageRef = scratch to verify that cope
.ReturnsAsync(new ContainerDetails { Id = 1, ImageId = NodeLatestDigest, Layers = Enumerable.Empty<DockerLayer>() , BaseImageRef = "scratch"});
await TestLinuxContainerDetector();
}
}
}