Skip to content

Allow Setuptools detector to succeed with empty BOM when no dependencies found #1738

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
bd-spratikbharti wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow Setuptools detector to succeed with empty BOM when no dependencies found #1738

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
11 changes: 8 additions & 3 deletions ...a/com/blackduck/integration/detectable/detectables/setuptools/SetupToolsExtractUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
import java.util.List;

import org.apache.commons.io.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.tomlj.Toml;
import org.tomlj.TomlArray;
import org.tomlj.TomlParseResult;
Expand All @@ -19,7 +21,9 @@
import com.blackduck.integration.detectable.detectables.setuptools.parse.SetupToolsTomlParser;

public class SetupToolsExtractUtils {


private static final Logger logger = LoggerFactory.getLogger(SetupToolsExtractUtils.class);

private static final String BUILD_KEY = "build-system.requires";
private static final String REQUIRED_KEY = "setuptools";
private static final String TOML_DEPENDENCIES = "project.dependencies";
Expand Down Expand Up @@ -87,7 +91,8 @@ public static SetupToolsParser resolveSetupToolsParser(TomlParseResult parsedTom
return cfgParser;
}
}

return null;

logger.warn("No dependencies found in pyproject.toml, setup.cfg, or setup.py. An empty BOM will be generated.");
return new SetupToolsTomlParser(parsedToml);
}
}
11 changes: 3 additions & 8 deletions ...ntegration/detectable/detectables/setuptools/buildless/SetupToolsBuildlessDetectable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import com.blackduck.integration.detectable.detectable.result.DetectableResult;
import com.blackduck.integration.detectable.detectable.result.ExceptionDetectableResult;
import com.blackduck.integration.detectable.detectable.result.PassedDetectableResult;
import com.blackduck.integration.detectable.detectable.result.SetupToolsNoDependenciesDetectableResult;
import com.blackduck.integration.detectable.detectable.result.SetupToolsRequiresNotFoundDetectableResult;
import com.blackduck.integration.detectable.detectables.setuptools.SetupToolsExtractUtils;
import com.blackduck.integration.detectable.detectables.setuptools.SetupToolsExtractor;
Expand Down Expand Up @@ -75,14 +74,10 @@ public DetectableResult applicable() {

@Override
public DetectableResult extractable() throws DetectableException {
try {
// Ensure dependencies/requirements are specified in a toml, cfg, or py file.
try {
// Resolve the appropriate parser for dependencies (toml, cfg, or py file).
setupToolsParser = SetupToolsExtractUtils.resolveSetupToolsParser(parsedToml, fileFinder, environment);

if (setupToolsParser == null) {
return new SetupToolsNoDependenciesDetectableResult();
}


return new PassedDetectableResult();
} catch (Exception e) {
return new ExceptionDetectableResult(e);
Expand Down
4 changes: 4 additions & 0 deletions ...m/blackduck/integration/detectable/detectables/setuptools/parse/SetupToolsTomlParser.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,10 @@ public List<PythonDependency> parseDirectDependencies(TomlParseResult tomlParseR

TomlArray dependencies = tomlParseResult.getArray("project.dependencies");

if (dependencies == null || dependencies.isEmpty()) {
return results;
}

for (int i = 0; i < dependencies.size(); i++) {
String dependencyLine = dependencies.getString(i);

Expand Down
9 changes: 2 additions & 7 deletions ...kduck/integration/detectable/detectables/setuptools/tbuild/SetupToolsBuildDetectable.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
import com.blackduck.integration.detectable.detectable.result.ExceptionDetectableResult;
import com.blackduck.integration.detectable.detectable.result.ExecutableNotFoundDetectableResult;
import com.blackduck.integration.detectable.detectable.result.PassedDetectableResult;
import com.blackduck.integration.detectable.detectable.result.SetupToolsNoDependenciesDetectableResult;
import com.blackduck.integration.detectable.detectable.result.SetupToolsRequiresNotFoundDetectableResult;
import com.blackduck.integration.detectable.detectables.setuptools.SetupToolsExtractUtils;
import com.blackduck.integration.detectable.detectables.setuptools.SetupToolsExtractor;
Expand Down Expand Up @@ -89,13 +88,9 @@ public DetectableResult extractable() throws DetectableException {
return new ExecutableNotFoundDetectableResult("pip");
}

// Ensure dependencies/requirements are specified in a toml, cfg, or py file.
// Resolve the appropriate parser for dependencies (toml, cfg, or py file).
setupToolsParser = SetupToolsExtractUtils.resolveSetupToolsParser(parsedToml, fileFinder, environment);

if (setupToolsParser == null) {
return new SetupToolsNoDependenciesDetectableResult();
}


return new PassedDetectableResult();
} catch (Exception e) {
return new ExceptionDetectableResult(e);
Expand Down