Skip to content
This repository has been archived by the owner on Jan 5, 2021. It is now read-only.

Commit

Permalink
Cleaning up code to address pr comments
Browse files Browse the repository at this point in the history
  • Loading branch information
@rottebds
rottebds committed Nov 16, 2017
1 parent adbf36c commit d1f3d97
Show file tree
Hide file tree
Showing 3 changed files with 101 additions and 102 deletions.
36 changes: 18 additions & 18 deletions src/main/groovy/com/blackducksoftware/integration/hub/detect/bomtool/HexBomTool.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,52 +40,52 @@ import groovy.transform.TypeChecked
@Component
@TypeChecked
class HexBomTool extends BomTool {
private final Logger logger = LoggerFactory.getLogger(HexBomTool.class)
private final Logger logger = LoggerFactory.getLogger(HexBomTool.class);

public static final String REBAR_CONFIG = 'rebar.config'
public static final String REBAR_CONFIG = 'rebar.config';

@Autowired
DetectConfiguration detectConfiguration
DetectConfiguration detectConfiguration;

@Autowired
Rebar3TreeParser rebarTreeParser
Rebar3TreeParser rebarTreeParser;

private String rebarExePath
private boolean rebarApplies
private String rebarExePath;
private boolean rebarApplies;

@Override
public BomToolType getBomToolType() {
return BomToolType.HEX
return BomToolType.HEX;
}

@Override
public boolean isBomToolApplicable() {
boolean hasRebarConfig = detectFileManager.containsAllFiles(sourcePath, REBAR_CONFIG)
boolean hasRebarConfig = detectFileManager.containsAllFiles(sourcePath, REBAR_CONFIG);

if (hasRebarConfig) {
logger.info('Rebar3 build tool applies for HEX given the current configuration.')
rebarExePath = findExecutablePath(ExecutableType.REBAR3, true, detectConfiguration.getHexRebar3Path())
logger.info('Rebar3 build tool applies for HEX given the current configuration.');
rebarExePath = findExecutablePath(ExecutableType.REBAR3, true, detectConfiguration.getHexRebar3Path());
if (!rebarExePath) {
logger.warn('Could not find a rebar3 executable.')
logger.warn('Could not find a rebar3 executable.');
}
}

rebarApplies = rebarExePath && hasRebarConfig
rebarApplies = rebarExePath && hasRebarConfig;

return rebarApplies
return rebarApplies;
}


@Override
public List<DetectCodeLocation> extractDetectCodeLocations(DetectProject detectProject) {
if (rebarApplies) {
Executable rebar3TreeExe = new Executable(new File(sourcePath), ['REBAR_COLOR': 'none'], rebarExePath, ['tree'])
List<String> output = executableRunner.execute(rebar3TreeExe).standardOutputAsList
DetectCodeLocation projectCodeLocation = rebarTreeParser.parseRebarTreeOutput(output, detectProject, sourcePath)
Executable rebar3TreeExe = new Executable(new File(sourcePath), ['REBAR_COLOR': 'none'], rebarExePath, ['tree']);
List<String> output = executableRunner.execute(rebar3TreeExe).standardOutputAsList;
DetectCodeLocation projectCodeLocation = rebarTreeParser.parseRebarTreeOutput(output, detectProject, sourcePath);

return [projectCodeLocation]
return [projectCodeLocation];
}

[]
return [];
}
}
115 changes: 57 additions & 58 deletions ...n/groovy/com/blackducksoftware/integration/hub/detect/bomtool/hex/Rebar3TreeParser.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ import com.blackducksoftware.integration.hub.bdio.model.Forge
import com.blackducksoftware.integration.hub.bdio.model.dependency.Dependency
import com.blackducksoftware.integration.hub.bdio.model.externalid.ExternalId
import com.blackducksoftware.integration.hub.bdio.model.externalid.ExternalIdFactory
import com.blackducksoftware.integration.hub.detect.DetectConfiguration
import com.blackducksoftware.integration.hub.detect.model.BomToolType
import com.blackducksoftware.integration.hub.detect.model.DetectCodeLocation
import com.blackducksoftware.integration.hub.detect.model.DetectProject
Expand All @@ -43,117 +42,117 @@ import groovy.transform.TypeChecked
@Component
@TypeChecked
class Rebar3TreeParser {
private final Logger logger = LoggerFactory.getLogger(Rebar3TreeParser.class)
private final Logger logger = LoggerFactory.getLogger(Rebar3TreeParser.class);

public static final String LAST_DEPENDENCY_CHARACTER = '└'
public static final String NTH_DEPENDENCY_CHARACTER = '├'
public static final String HORIZONTAL_SEPARATOR_CHARACTER = '─'
public static final String INNER_LEVEL_CHARACTER = '│'
public static final String INNER_LEVEL_PREFIX = INNER_LEVEL_CHARACTER + ' '.multiply(2)
public static final String OUTER_LEVEL_PREFIX = ' '.multiply(3)
public static final String PROJECT_FORGE_STRING = '(project app)'
public static final String LAST_DEPENDENCY_CHARACTER = '└';
public static final String NTH_DEPENDENCY_CHARACTER = '├';
public static final String HORIZONTAL_SEPARATOR_CHARACTER = '─';
public static final String INNER_LEVEL_CHARACTER = '│';
public static final String INNER_LEVEL_PREFIX = INNER_LEVEL_CHARACTER + ' '.multiply(2);
public static final String OUTER_LEVEL_PREFIX = ' '.multiply(3);
public static final String PROJECT_IDENTIFIER = '(project app)';

@Autowired
DetectConfiguration detectConfiguration
ExternalIdFactory externalIdFactory;

@Autowired
ExternalIdFactory externalIdFactory

public DetectCodeLocation parseRebarTreeOutput(List<String> dependencyTreeOutput, DetectProject detectProject, String sourcePath) {
MutableDependencyGraph graph = new MutableMapDependencyGraph()
String projectName = ''
String projectVersionName = ''
Stack<Dependency> dependencyStack = new Stack<Dependency>()
int previousTreeLevel = 0
Dependency previousDependency
public DetectCodeLocation parseRebarTreeOutput(final List<String> dependencyTreeOutput, final DetectProject detectProject, final String sourcePath) {
MutableDependencyGraph graph = new MutableMapDependencyGraph();
String projectName = '';
String projectVersionName = '';
Stack<Dependency> dependencyStack = new Stack<Dependency>();
int previousTreeLevel = 0;
Dependency previousDependency;

try {
for (String line: dependencyTreeOutput) {
if (line.contains(HORIZONTAL_SEPARATOR_CHARACTER)) {
Dependency currentDependency = createDependencyFromLine(line)
Dependency currentDependency = createDependencyFromLine(line);

final int currentTreeLevel = getDependencyLevelFromLine(line)
final int currentTreeLevel = getDependencyLevelFromLine(line);

if (currentTreeLevel == previousTreeLevel + 1) {
dependencyStack.push(previousDependency)
dependencyStack.push(previousDependency);
} else if (currentTreeLevel < previousTreeLevel) {
int levelDelta = (previousTreeLevel - currentTreeLevel)
int levelDelta = (previousTreeLevel - currentTreeLevel);
for (int levels = 0; levels < levelDelta; levels++) {
dependencyStack.pop()
dependencyStack.pop();
}
} else if (currentTreeLevel != previousTreeLevel) {
logger.error(String.format('The tree level (%s) and this line (%s) with count %s can\'t be reconciled.', previousTreeLevel, line, currentTreeLevel))
logger.error(String.format('The tree level (%s) and this line (%s) with count %s can\'t be reconciled.', previousTreeLevel, line, currentTreeLevel));
}

if (dependencyStack.size() == 0) {
if ( isProject(line) ) {
projectName = currentDependency.name
projectVersionName = currentDependency.version
projectName = currentDependency.name;
projectVersionName = currentDependency.version;
} else {
graph.addChildToRoot(currentDependency)
graph.addChildToRoot(currentDependency);
}
} else if (dependencyStack.size() == 1 && dependencyStack.peek().name.equals(projectName) && dependencyStack.peek().version.equals(projectVersionName)) {
graph.addChildToRoot(currentDependency)
graph.addChildToRoot(currentDependency);
} else {
graph.addChildWithParents(currentDependency, dependencyStack.peek())
graph.addChildWithParents(currentDependency, dependencyStack.peek());
}

previousDependency = currentDependency
previousTreeLevel = currentTreeLevel
previousDependency = currentDependency;
previousTreeLevel = currentTreeLevel;
}
}
} catch (final Exception e) {
logger.error('Exception parsing rebar output: ' + e.getMessage())
logger.error('Exception parsing rebar output: ' + e.getMessage());
}
detectProject.setProjectNameIfNotSet(projectName)
detectProject.setProjectVersionNameIfNotSet(projectVersionName)
detectProject.setProjectNameIfNotSet(projectName);
detectProject.setProjectVersionNameIfNotSet(projectVersionName);

final ExternalId id = externalIdFactory.createNameVersionExternalId(Forge.HEX, projectName, projectVersionName)
final ExternalId id = externalIdFactory.createNameVersionExternalId(Forge.HEX, projectName, projectVersionName);

return new DetectCodeLocation(BomToolType.HEX, sourcePath, projectName, projectVersionName, id, graph)
return new DetectCodeLocation(BomToolType.HEX, sourcePath, projectName, projectVersionName, id, graph);
}

private Dependency createDependencyFromLine(String line) {
String nameVersionLine = reduceLineToNameVersion(line)
String name = nameVersionLine.substring(0, nameVersionLine.lastIndexOf(HORIZONTAL_SEPARATOR_CHARACTER))
String version = nameVersionLine.substring(nameVersionLine.lastIndexOf(HORIZONTAL_SEPARATOR_CHARACTER) + 1)
ExternalId externalId = externalIdFactory.createNameVersionExternalId(Forge.HEX, name, version)
private Dependency createDependencyFromLine(final String line) {
String nameVersionLine = reduceLineToNameVersion(line);
String name = nameVersionLine.substring(0, nameVersionLine.lastIndexOf(HORIZONTAL_SEPARATOR_CHARACTER));
String version = nameVersionLine.substring(nameVersionLine.lastIndexOf(HORIZONTAL_SEPARATOR_CHARACTER) + 1);
ExternalId externalId = externalIdFactory.createNameVersionExternalId(Forge.HEX, name, version);

return new Dependency(name, version, externalId)
return new Dependency(name, version, externalId);
}

private String reduceLineToNameVersion(String line) {
for (String specialCharacter : [
String[] ignoredSpecialCharacters = [
LAST_DEPENDENCY_CHARACTER,
NTH_DEPENDENCY_CHARACTER,
INNER_LEVEL_CHARACTER
]) {
line = line.replaceAll(specialCharacter, '')
];
for (final String specialCharacter : ignoredSpecialCharacters) {
line = line.replaceAll(specialCharacter, '');
}
line = line.replaceFirst(HORIZONTAL_SEPARATOR_CHARACTER, '')

line = line.replaceFirst(HORIZONTAL_SEPARATOR_CHARACTER, '');

if (line.endsWith(')')) {
line = line.substring(0, line.lastIndexOf('('))
line = line.substring(0, line.lastIndexOf('('));
}

return line.trim()
return line.trim();
}

private int getDependencyLevelFromLine(String line) {
int level = 0
int level = 0;
while(line.startsWith(INNER_LEVEL_PREFIX) || line.startsWith(OUTER_LEVEL_PREFIX)) {
line = line.substring(3)
level++
line = line.substring(3);
level++;
}

return level
return level;
}

private boolean isProject(String line) {
String forgeString = ''
private boolean isProject(final String line) {
String forgeString = '';
if (line.endsWith(')')) {
forgeString = line.substring(line.lastIndexOf('('))
forgeString = line.substring(line.lastIndexOf('('));
}

return PROJECT_FORGE_STRING.equals(forgeString)
return PROJECT_IDENTIFIER.equals(forgeString);
}
}
52 changes: 26 additions & 26 deletions ...blackducksoftware/integration/hub/detect/testutils/DependencyGraphResourceTestUtil.groovy
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,54 +10,54 @@ import com.google.gson.GsonBuilder

class DependencyGraphResourceTestUtil {
public static void assertGraph(String expectedResourceFile, DependencyGraph actualGraph) {
DependencyGraphSummarizer summarizer = new DependencyGraphSummarizer(new Gson())
DependencyGraphSummarizer summarizer = new DependencyGraphSummarizer(new Gson());

TestUtil testUtil = new TestUtil()
String json = testUtil.getResourceAsUTF8String(expectedResourceFile)
TestUtil testUtil = new TestUtil();
String json = testUtil.getResourceAsUTF8String(expectedResourceFile);

GraphSummary expected = summarizer.fromJson(json)
GraphSummary actual = summarizer.fromGraph(actualGraph)
println new GsonBuilder().setPrettyPrinting().create().toJson(actual)
assertSummarries(expected, actual)
GraphSummary expected = summarizer.fromJson(json);
GraphSummary actual = summarizer.fromGraph(actualGraph);
println new GsonBuilder().setPrettyPrinting().create().toJson(actual);
assertSummarries(expected, actual);
}

public static void assertGraph(DependencyGraph expectedGraph, DependencyGraph actualGraph) {
DependencyGraphSummarizer summarizer = new DependencyGraphSummarizer(new Gson())
GraphSummary expected = summarizer.fromGraph(expectedGraph)
GraphSummary actual = summarizer.fromGraph(actualGraph)
println new GsonBuilder().setPrettyPrinting().create().toJson(actual)
assertSummarries(expected, actual)
DependencyGraphSummarizer summarizer = new DependencyGraphSummarizer(new Gson());
GraphSummary expected = summarizer.fromGraph(expectedGraph);
GraphSummary actual = summarizer.fromGraph(actualGraph);
println new GsonBuilder().setPrettyPrinting().create().toJson(actual);
assertSummarries(expected, actual);
}

public static void assertSummarries(GraphSummary expected, GraphSummary actual) {
assertSet(expected.rootExternalDataIds, actual.rootExternalDataIds, "Root external ids")
assertSet(expected.dependencySummaries.keySet(), actual.dependencySummaries.keySet(), "Dependencies in graph")
assertSet(expected.rootExternalDataIds, actual.rootExternalDataIds, "Root external ids");
assertSet(expected.dependencySummaries.keySet(), actual.dependencySummaries.keySet(), "Dependencies in graph");

def expectedRelationshipIds = expected.externalDataIdRelationships.keySet()
def expectedRelationshipIds = expected.externalDataIdRelationships.keySet();
def expectedExistingRelationshipsIds = expectedRelationshipIds.findAll{ key -> expected.externalDataIdRelationships.get(key) != null && expected.externalDataIdRelationships.get(key).size() > 0}

def actualRelationshipIds = actual.externalDataIdRelationships.keySet()
def actualRelationshipIds = actual.externalDataIdRelationships.keySet();
def actualExistingRelationshipsIds = actualRelationshipIds.findAll{ key -> actual.externalDataIdRelationships.get(key) != null && actual.externalDataIdRelationships.get(key).size() > 0}

assertSet(expectedExistingRelationshipsIds, actualExistingRelationshipsIds, "Existing relationships")
assertSet(expectedExistingRelationshipsIds, actualExistingRelationshipsIds, "Existing relationships");

for (String key : expected.dependencySummaries.keySet()){
assertEquals(expected.dependencySummaries.get(key).name, actual.dependencySummaries.get(key).name)
assertEquals(expected.dependencySummaries.get(key).version, actual.dependencySummaries.get(key).version)
assertEquals(expected.dependencySummaries.get(key).name, actual.dependencySummaries.get(key).name);
assertEquals(expected.dependencySummaries.get(key).version, actual.dependencySummaries.get(key).version);
}
for (String key : expectedExistingRelationshipsIds){
assertSet(expected.externalDataIdRelationships.get(key), actual.externalDataIdRelationships.get(key), "External data id relationships for " + key)
assertSet(expected.externalDataIdRelationships.get(key), actual.externalDataIdRelationships.get(key), "External data id relationships for " + key);
}
}

public static <T> void assertSet (Set<T> expected, Set<T> actual, String title) {
Set<String> missingExpected = new HashSet<>(expected)
missingExpected.removeAll(actual)
Set<String> missingExpected = new HashSet<>(expected);
missingExpected.removeAll(actual);

Set<String> extraActual = new HashSet<>(actual)
extraActual.removeAll(expected)
Set<String> extraActual = new HashSet<>(actual);
extraActual.removeAll(expected);

assertTrue(title + ": Found missing expected " + missingExpected.toString(), missingExpected.size() == 0)
assertTrue(title + ": Found extra actual " + extraActual.toString(), extraActual.size() == 0)
assertTrue(title + ": Found missing expected " + missingExpected.toString(), missingExpected.size() == 0);
assertTrue(title + ": Found extra actual " + extraActual.toString(), extraActual.size() == 0);
}
}

0 comments on commit d1f3d97

Please sign in to comment.