Skip to content

ArtifactsSdkPredictor: Fix Artifact item name #113

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
dfederm merged 2 commits into from
Sep 26, 2024
Merged

ArtifactsSdkPredictor: Fix Artifact item name #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
17ba3bb
ArtifactsSdkPredictor: Fix Artifact item name
dfederm Sep 26, 2024
d8308b6
Consider EnableArtifacts property
dfederm Sep 26, 2024
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
11 changes: 10 additions & 1 deletion src/BuildPrediction/Predictors/ArtifactsSdkPredictor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ public sealed class ArtifactsSdkPredictor : IProjectPredictor
{
internal const string UsingMicrosoftArtifactsSdkPropertyName = "UsingMicrosoftArtifactsSdk";

internal const string ArtifactsItemName = "Artifacts";
internal const string EnableArtifactsPropertyName = "EnableArtifacts";

internal const string ArtifactsItemName = "Artifact";

internal const string RobocopyItemName = "Robocopy";

Expand Down Expand Up @@ -50,6 +52,13 @@ public void PredictInputsAndOutputs(ProjectInstance projectInstance, ProjectPred
return;
}

// Check property which disables the functionality.
var enableArtifacts = projectInstance.GetPropertyValue(EnableArtifactsPropertyName);
if (enableArtifacts.Equals("false", StringComparison.OrdinalIgnoreCase))
{
return;
}

// The Sdk allows both Artifacts and Robocopy items
ProcessItems(projectInstance.GetItems(ArtifactsItemName), predictionReporter);
ProcessItems(projectInstance.GetItems(RobocopyItemName), predictionReporter);
Expand Down
20 changes: 20 additions & 0 deletions src/BuildPredictionTests/Predictors/ArtifactsSdkPredictorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,26 @@ public void SkipWhenNotUsingSdk()
.AssertNoPredictions();
}

[Fact]
public void SkipWhenDisabled()
{
ProjectRootElement projectRootElement = ProjectRootElement.Create(Path.Combine(_rootDir, @"src\project.csproj"));
projectRootElement.AddProperty(ArtifactsSdkPredictor.UsingMicrosoftArtifactsSdkPropertyName, "true");
projectRootElement.AddProperty(ArtifactsSdkPredictor.EnableArtifactsPropertyName, "false");
projectRootElement.AddProperty("ArtifactsPath", Path.Combine(_rootDir, "out"));

var artifactItem = projectRootElement.AddItem(ArtifactsSdkPredictor.ArtifactsItemName, "Artifact.txt");
artifactItem.AddMetadata(ArtifactsSdkPredictor.DestinationFolderMetadata, @"$(ArtifactsPath)\Project");

Directory.CreateDirectory(Path.Combine(_rootDir, "src"));
File.WriteAllText(Path.Combine(_rootDir, @"src\Artifact.txt"), "SomeContent");

ProjectInstance projectInstance = TestHelpers.CreateProjectInstanceFromRootElement(projectRootElement);
new ArtifactsSdkPredictor()
.GetProjectPredictions(projectInstance)
.AssertNoPredictions();
}

[Fact]
public void FindArtifactsForExistingFile()
{
Expand Down