Skip to content
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.

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

Allow user override of project and version through blackDuckProperties #54

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,8 @@ public class ScanModuleConfig extends ModuleConfig {
private final Boolean policyBlockedEnabled;
private final List<String> policyRepos;
private final List<PolicyRuleSeverityType> policySeverityTypes;
private final String overrideProject;
private final String overrideVersion;

private final DateTimeManager dateTimeManager;

Expand All @@ -61,7 +63,9 @@ public ScanModuleConfig(
Boolean policyBlockedEnabled,
List<String> policyRepos,
List<PolicyRuleSeverityType> policySeverityTypes,
DateTimeManager dateTimeManager
DateTimeManager dateTimeManager,
String overrideProject,
String overrideVersion
) {
super(ScanModule.class.getSimpleName(), enabled);
this.cron = cron;
Expand All @@ -79,6 +83,8 @@ public ScanModuleConfig(
this.policyRepos = policyRepos;
this.policySeverityTypes = policySeverityTypes;
this.dateTimeManager = dateTimeManager;
this.overrideProject = overrideProject;
this.overrideVersion = overrideVersion;
}

public static ScanModuleConfig createFromProperties(
Expand Down Expand Up @@ -126,6 +132,16 @@ public static ScanModuleConfig createFromProperties(
.map(PolicyRuleSeverityType::valueOf)
.collect(Collectors.toList());

String overrideProject = configurationPropertyManager.getProperty(ScanModuleProperty.OVERRIDE_PROJECT);
if (overrideProject != null && !overrideProject.isEmpty()) {
logger.info(String.format("Found project override property for scans. Project override: %s", overrideProject));
}

String overrideVersion = configurationPropertyManager.getProperty(ScanModuleProperty.OVERRIDE_VERSION);
if (overrideVersion != null && !overrideVersion.isEmpty()) {
logger.info(String.format("Found version override property for scans. Version override: %s", overrideVersion));
}

return new ScanModuleConfig(
enabled,
cron,
Expand All @@ -142,7 +158,9 @@ public static ScanModuleConfig createFromProperties(
policyBlockedEnabled,
policyRepos,
policySeverityTypes,
dateTimeManager
dateTimeManager,
overrideProject,
overrideVersion
);
}

Expand Down Expand Up @@ -240,4 +258,12 @@ public Boolean isMetadataBlockEnabled() {
public List<String> getMetadataBlockRepos() {
return metadataBlockRepos;
}

public String getOverrideProject() {
return overrideProject;
}

public String getOverrideVersion() {
return overrideVersion;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ public enum ScanModuleProperty implements ConfigurationProperty {
METADATA_BLOCK_REPOS("metadata.block.repos"),
METADATA_BLOCK_REPOS_CSV_PATH("metadata.block.repos.csv.path"),
NAME_PATTERNS("name.patterns"),
OVERRIDE_PROJECT("override.project"),
OVERRIDE_VERSION("override.version"),
POLICY_BLOCK("policy.block"),
POLICY_REPOS("policy.repos"),
POLICY_REPOS_CSV_PATH("policy.repos.csv.path"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,18 @@ private NameVersion determineProjectNameVersion(RepoPath repoPath) {
String version = artifactoryPropertyService.getProperty(repoPath, BlackDuckArtifactoryProperty.BLACKDUCK_PROJECT_VERSION_NAME)
.orElse(fileLayoutInfo.getBaseRevision());

String overrideProject = scanModuleConfig.getOverrideProject();
if (overrideProject != null && !overrideProject.isEmpty()) {
logger.info(String.format("Overriding project. Original project: %s, Override project: %s", project, overrideProject));
project = overrideProject;
}

String overrideVersion = scanModuleConfig.getOverrideVersion();
if (overrideVersion != null && !overrideVersion.isEmpty()) {
logger.info(String.format("Overriding version. Original version: %s, Override version: %s", version, overrideVersion));
version = overrideVersion;
}

boolean missingProjectName = StringUtils.isBlank(project);
boolean missingProjectVersionName = StringUtils.isBlank(version);
if (missingProjectName || missingProjectVersionName) {
Expand Down
3 changes: 3 additions & 0 deletions src/main/resources/blackDuckPlugin.properties
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ blackduck.artifactory.scan.cron=0 0/1 * 1/1 * ?
blackduck.artifactory.scan.metadata.block=false
blackduck.artifactory.scan.metadata.block.repos=
blackduck.artifactory.scan.metadata.block.repos.csv.path=
# If override.project/override.version is set, the plugin will override project / version to the specified ones for all repositories scanned
blackduck.artifactory.scan.override.project=
blackduck.artifactory.scan.override.version=
# If policy.repos/policy.repos.csv.path is left blank, or not contained within scan.repos/scan.repos.csv.path, all scanned repositories will be used.
blackduck.artifactory.scan.policy.block=true
blackduck.artifactory.scan.policy.repos=
Expand Down