Add Nuget Exclude Dependency Type Option (#1032)

* Add New Nuget Exclude Dependency Property in Detect

* Uncomment integration tag

* Refactored Dockerfile name and version

* Add assert examples in test

Author: devmehtabd

detectable/src/main/java/com/synopsys/integration/detectable/detectables/nuget/NugetDependencyType.java

@@ -0,0 +1,5 @@
+package com.synopsys.integration.detectable.detectables.nuget;
+
+public enum NugetDependencyType {
+    DEV
+}

detectable/src/main/java/com/synopsys/integration/detectable/detectables/nuget/NugetInspectorArguments.java

@@ -5,6 +5,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
+import java.util.Set;
 
 import org.apache.commons.lang3.StringUtils;
 import org.slf4j.Logger;
@@ -37,6 +38,10 @@ public static List<String> fromInspectorOptions(NugetInspectorOptions nugetInspe
         nugetInspectorOptions.getNugetConfigPath()
             .ifPresent(arg -> options.add("--nuget_config_path=" + arg.toString()));
 
+        if(!nugetInspectorOptions.getNugetExcludedDependencyTypes().isEmpty()){
+            options.add("--excluded_dependency_types=" + toCommaSeparatedStringSet(nugetInspectorOptions.getNugetExcludedDependencyTypes()));
+        }
+
         if (logger.isTraceEnabled()) {
             options.add("-v");
         }
@@ -47,4 +52,8 @@ public static List<String> fromInspectorOptions(NugetInspectorOptions nugetInspe
     private static String toCommaSeparatedString(List<String> list) {
         return StringUtils.joinWith(",", list.toArray());
     }
+
+    private static String toCommaSeparatedStringSet(Set<NugetDependencyType> list) {
+        return StringUtils.joinWith(",", list.toArray());
+    }
 }

detectable/src/main/java/com/synopsys/integration/detectable/detectables/nuget/NugetInspectorOptions.java

@@ -3,6 +3,7 @@
 import java.nio.file.Path;
 import java.util.List;
 import java.util.Optional;
+import java.util.Set;
 
 import org.jetbrains.annotations.Nullable;
 
@@ -12,13 +13,15 @@ public class NugetInspectorOptions {
     private final List<String> includedModules;
     private final List<String> packagesRepoUrl;
     private final Path nugetConfigPath;
+    private final Set<NugetDependencyType> nugetExcludedDependencyTypes;
 
-    public NugetInspectorOptions(boolean ignoreFailures, List<String> excludedModules, List<String> includedModules, List<String> packagesRepoUrl, @Nullable Path nugetConfigPath) {
+    public NugetInspectorOptions(boolean ignoreFailures, List<String> excludedModules, List<String> includedModules, List<String> packagesRepoUrl, @Nullable Path nugetConfigPath, Set<NugetDependencyType> nugetExcludedDependencyTypes) {
         this.ignoreFailures = ignoreFailures;
         this.excludedModules = excludedModules;
         this.includedModules = includedModules;
         this.packagesRepoUrl = packagesRepoUrl;
         this.nugetConfigPath = nugetConfigPath;
+        this.nugetExcludedDependencyTypes = nugetExcludedDependencyTypes;
     }
 
     public boolean isIgnoreFailures() {
@@ -40,4 +43,6 @@ public List<String> getPackagesRepoUrl() {
     public Optional<Path> getNugetConfigPath() {
         return Optional.ofNullable(nugetConfigPath);
     }
+
+    public Set<NugetDependencyType> getNugetExcludedDependencyTypes() { return nugetExcludedDependencyTypes; }
 }

src/main/java/com/synopsys/integration/detect/configuration/DetectProperties.java

@@ -58,6 +58,7 @@
 import com.synopsys.integration.detectable.detectables.gradle.inspection.GradleConfigurationType;
 import com.synopsys.integration.detectable.detectables.lerna.LernaPackageType;
 import com.synopsys.integration.detectable.detectables.npm.NpmDependencyType;
+import com.synopsys.integration.detectable.detectables.nuget.NugetDependencyType;
 import com.synopsys.integration.detectable.detectables.packagist.PackagistDependencyType;
 import com.synopsys.integration.detectable.detectables.pear.PearDependencyType;
 import com.synopsys.integration.detectable.detectables.pipenv.parse.PipenvDependencyType;
@@ -1156,6 +1157,14 @@ private DetectProperties() {
             .setGroups(DetectGroup.NUGET, DetectGroup.GLOBAL)
             .build();
 
+    public static final NoneEnumListProperty<NugetDependencyType> DETECT_NUGET_DEPENDENCY_TYPES_EXCLUDED =
+            NoneEnumListProperty.newBuilder("detect.nuget.dependency.types.excluded", NoneEnum.NONE, NugetDependencyType.class)
+                    .setInfo("Nuget Dependency Types Excluded", DetectPropertyFromVersion.VERSION_9_4_0)
+                    .setHelp(createTypeFilterHelpText("Nuget dependency types"))
+                    .setExample(String.format("%s", NugetDependencyType.DEV.name()))
+                    .setGroups(DetectGroup.NUGET, DetectGroup.GLOBAL, DetectGroup.SOURCE_SCAN)
+                    .build();
+
     public static final NullablePathProperty DETECT_OUTPUT_PATH =
         NullablePathProperty.newBuilder("detect.output.path")
             .setInfo("Detect Output Path", DetectPropertyFromVersion.VERSION_3_0_0)

src/main/java/com/synopsys/integration/detect/configuration/DetectPropertyFromVersion.java

@@ -44,7 +44,8 @@ public enum DetectPropertyFromVersion implements PropertyVersion {
     VERSION_8_5_0("8.5.0"),
     VERSION_8_8_0("8.8.0"),
     VERSION_8_11_0("8.11.0"),
-    VERSION_9_1_0("9.1.0");
+    VERSION_9_1_0("9.1.0"),
+    VERSION_9_4_0("9.4.0");
 
     private final String version;
 

src/main/java/com/synopsys/integration/detect/configuration/DetectableOptionFactory.java

@@ -5,6 +5,7 @@
 import java.util.Map;
 import java.util.Set;
 
+import com.synopsys.integration.detectable.detectables.nuget.NugetDependencyType;
 import org.jetbrains.annotations.Nullable;
 
 import com.synopsys.integration.detect.workflow.ArtifactoryConstants;
@@ -287,7 +288,8 @@ public NugetInspectorOptions createNugetInspectorOptions() {
         List<String> includedModules = detectConfiguration.getValue(DetectProperties.DETECT_NUGET_INCLUDED_MODULES);
         List<String> packagesRepoUrl = detectConfiguration.getValue(DetectProperties.DETECT_NUGET_PACKAGES_REPO_URL);
         Path nugetConfigPath = detectConfiguration.getPathOrNull(DetectProperties.DETECT_NUGET_CONFIG_PATH);
-        return new NugetInspectorOptions(ignoreFailures, excludedModules, includedModules, packagesRepoUrl, nugetConfigPath);
+        Set<NugetDependencyType> nugetExcludedDependencyTypes = detectConfiguration.getValue(DetectProperties.DETECT_NUGET_DEPENDENCY_TYPES_EXCLUDED).representedValueSet();
+        return new NugetInspectorOptions(ignoreFailures, excludedModules, includedModules, packagesRepoUrl, nugetConfigPath, nugetExcludedDependencyTypes);
     }
 
     private boolean getFollowSymLinks() {

src/test/java/com/synopsys/integration/detect/battery/docker/NugetInspectorTests.java

@@ -80,4 +80,34 @@ void nugetMultiplePropsFileTest() throws IOException, IntegrationException {
             blackduckAssertions.hasComponents("Microsoft.UI.Xaml");
         }
     }
+
+    @Test
+    void nugetExcludeDevDependencyTest() throws IOException, IntegrationException {
+        try(DetectDockerTestRunner test = new DetectDockerTestRunner("detect-nuget-inspector-exclude-dependency","detect-dotnet-seven:1.0.3")) {
+            test.withImageProvider(BuildDockerImageProvider.forDockerfilResourceNamed("Nuget_ExcludeDevDependency.dockerfile"));
+
+            String projectVersion = PROJECT_NAME + "-exclude_dev_dependency";
+            BlackDuckTestConnection blackDuckTestConnection = BlackDuckTestConnection.fromEnvironment();
+            BlackDuckAssertions blackduckAssertions = blackDuckTestConnection.projectVersionAssertions(PROJECT_NAME, projectVersion);
+            blackduckAssertions.emptyOnBlackDuck();
+
+            DetectCommandBuilder commandBuilder = new DetectCommandBuilder().defaults().defaultDirectories(test);
+            commandBuilder.connectToBlackDuck(blackDuckTestConnection);
+            commandBuilder.projectNameVersion(blackduckAssertions);
+            commandBuilder.waitForResults();
+
+            commandBuilder.property(DetectProperties.DETECT_TOOLS, "DETECTOR");
+            commandBuilder.property(DetectProperties.DETECT_INCLUDED_DETECTOR_TYPES, DetectorType.NUGET.toString());
+            commandBuilder.property(DetectProperties.DETECT_NUGET_DEPENDENCY_TYPES_EXCLUDED,"DEV");
+            DockerAssertions dockerAssertions = test.run(commandBuilder);
+
+            dockerAssertions.logContains("NuGet Solution Native Inspector: SUCCESS");
+            dockerAssertions.atLeastOneBdioFile();
+
+            blackduckAssertions.doesNotHaveComponents("Microsoft.CodeAnalysis.NetAnalyzers");
+            blackduckAssertions.doesNotHaveComponents("Microsoft.Windows.CsWin32");
+            blackduckAssertions.hasComponents("CommunityToolkit.WinUI.Animations");
+            blackduckAssertions.hasComponents("Microsoft.Extensions.Logging");
+        }
+    }
 }

src/test/java/com/synopsys/integration/detect/battery/docker/integration/BlackDuckAssertions.java

@@ -2,7 +2,7 @@
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertTrue;
-
+import static org.junit.jupiter.api.Assertions.assertFalse;
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
@@ -113,6 +113,20 @@ public void hasComponents(Set<String> componentNames) throws IntegrationExceptio
         });
     }
 
+    public void doesNotHaveComponents(String... componentNames) throws IntegrationException {
+        doesNotHaveComponents(Bds.of(componentNames).toSet());
+    }
+
+    public void doesNotHaveComponents(Set<String> componentNames) throws IntegrationException {
+        List<ProjectVersionComponentVersionView> bomComponents = projectBomService.getComponentsForProjectVersion(retrieveProjectVersionWrapper().getProjectVersionView());
+        componentNames.forEach(componentName -> {
+            Optional<ProjectVersionComponentVersionView> blackDuckCommonComponent = bomComponents.stream()
+                    .filter(ProjectVersionComponentView -> componentName.equals(ProjectVersionComponentView.getComponentName()))
+                    .findFirst();
+            assertFalse(blackDuckCommonComponent.isPresent());
+        });
+    }
+
     public NameVersion getProjectNameVersion() {
         return projectNameVersion;
     }

src/test/resources/docker/Nuget_ExcludeDevDependency.dockerfile

@@ -0,0 +1,20 @@
+FROM mcr.microsoft.com/dotnet/sdk:7.0
+
+ENV SRC_DIR=/opt/project/src
+
+RUN apt-get update
+
+# Install java
+RUN mkdir -p /usr/share/man/man1/
+# Above due to: https://github.com/geerlingguy/ansible-role-java/issues/64
+RUN apt-get install -y openjdk-11-jre
+
+# Install git
+RUN apt-get install -y git
+
+RUN mkdir -p air-gap-docker
+
+# Set up the test project
+RUN mkdir -p ${SRC_DIR}
+WORKDIR ${SRC_DIR}
+RUN git clone --depth 1 https://github.com/microsoft/PowerToys.git ${SRC_DIR}