Java tutorial
/* * Copyright (C) 2010 JFrog Ltd. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.jfrog.hudson.ivy; import hudson.Extension; import hudson.FilePath; import hudson.Launcher; import hudson.ivy.AntIvyBuildWrapper; import hudson.model.*; import hudson.remoting.Which; import hudson.tasks.BuildWrapperDescriptor; import hudson.util.FormValidation; import hudson.util.ListBoxModel; import hudson.util.XStream2; import jenkins.model.Jenkins; import net.sf.json.JSONObject; import org.apache.commons.lang.StringUtils; import org.jfrog.build.extractor.listener.ArtifactoryBuildListener; import org.jfrog.hudson.*; import org.jfrog.hudson.action.ActionableHelper; import org.jfrog.hudson.pipeline.Utils; import org.jfrog.hudson.util.*; import org.jfrog.hudson.util.converters.DeployerResolverOverriderConverter; import org.jfrog.hudson.util.plugins.PluginsUtils; import org.jfrog.hudson.util.publisher.PublisherContext; import org.kohsuke.stapler.AncestorInPath; import org.kohsuke.stapler.DataBoundConstructor; import org.kohsuke.stapler.QueryParameter; import org.kohsuke.stapler.StaplerRequest; import org.kohsuke.stapler.bind.JavaScriptMethod; import java.io.File; import java.io.IOException; import java.util.Collection; import java.util.Collections; import java.util.List; import java.util.Map; /** * @author Tomer Cohen */ public class ArtifactoryIvyConfigurator extends AntIvyBuildWrapper implements DeployerOverrider, BuildInfoAwareConfigurator { private final CredentialsConfig deployerCredentialsConfig; private final IncludesExcludes artifactDeploymentPatterns; private final boolean discardBuildArtifacts; private final String matrixParams; private final boolean filterExcludedArtifactsFromBuild; private ServerDetails details; private boolean deployArtifacts; private boolean deployBuildInfo; private boolean includeEnvVars; private IncludesExcludes envVarsPatterns; private boolean runChecks; private String violationRecipients; private boolean includePublishArtifacts; private String scopes; private boolean licenseAutoDiscovery; private boolean disableLicenseAutoDiscovery; private boolean discardOldBuilds; private boolean notM2Compatible; private String ivyPattern; private String aggregationBuildStatus; private String artifactPattern; private boolean enableIssueTrackerIntegration; private boolean aggregateBuildIssues; private boolean blackDuckRunChecks; private String blackDuckAppName; private String blackDuckAppVersion; private String blackDuckReportRecipients; //csv private String blackDuckScopes; //csv private boolean blackDuckIncludePublishedArtifacts; private boolean autoCreateMissingComponentRequests; private boolean autoDiscardStaleComponentRequests; /** * @deprecated: Use org.jfrog.hudson.ivy.ArtifactoryIvyConfigurator#getDeployerCredentialsConfig()() */ @Deprecated private Credentials overridingDeployerCredentials; @DataBoundConstructor public ArtifactoryIvyConfigurator(ServerDetails details, CredentialsConfig deployerCredentialsConfig, boolean deployArtifacts, IncludesExcludes artifactDeploymentPatterns, boolean deployBuildInfo, boolean includeEnvVars, IncludesExcludes envVarsPatterns, boolean runChecks, String violationRecipients, boolean includePublishArtifacts, String scopes, boolean disableLicenseAutoDiscovery, boolean notM2Compatible, String ivyPattern, String artifactPattern, boolean discardOldBuilds, boolean discardBuildArtifacts, String matrixParams, boolean enableIssueTrackerIntegration, boolean aggregateBuildIssues, String aggregationBuildStatus, boolean blackDuckRunChecks, String blackDuckAppName, String blackDuckAppVersion, String blackDuckReportRecipients, String blackDuckScopes, boolean blackDuckIncludePublishedArtifacts, boolean autoCreateMissingComponentRequests, boolean autoDiscardStaleComponentRequests, boolean filterExcludedArtifactsFromBuild) { this.details = details; this.deployArtifacts = deployArtifacts; this.deployerCredentialsConfig = deployerCredentialsConfig; this.artifactDeploymentPatterns = artifactDeploymentPatterns; this.deployBuildInfo = deployBuildInfo; this.includeEnvVars = includeEnvVars; this.envVarsPatterns = envVarsPatterns; this.runChecks = runChecks; this.violationRecipients = violationRecipients; this.includePublishArtifacts = includePublishArtifacts; this.scopes = scopes; this.disableLicenseAutoDiscovery = disableLicenseAutoDiscovery; this.notM2Compatible = notM2Compatible; this.ivyPattern = ivyPattern; this.aggregationBuildStatus = aggregationBuildStatus; this.filterExcludedArtifactsFromBuild = filterExcludedArtifactsFromBuild; this.artifactPattern = clearApostrophes(artifactPattern); this.discardOldBuilds = discardOldBuilds; this.discardBuildArtifacts = discardBuildArtifacts; this.matrixParams = matrixParams; this.licenseAutoDiscovery = !disableLicenseAutoDiscovery; this.enableIssueTrackerIntegration = enableIssueTrackerIntegration; this.aggregateBuildIssues = aggregateBuildIssues; this.blackDuckRunChecks = blackDuckRunChecks; this.blackDuckAppName = blackDuckAppName; this.blackDuckAppVersion = blackDuckAppVersion; this.blackDuckReportRecipients = blackDuckReportRecipients; this.blackDuckScopes = blackDuckScopes; this.blackDuckIncludePublishedArtifacts = blackDuckIncludePublishedArtifacts; this.autoCreateMissingComponentRequests = autoCreateMissingComponentRequests; this.autoDiscardStaleComponentRequests = autoDiscardStaleComponentRequests; } /** * Clears the extra apostrophes from the start and the end of the string */ private String clearApostrophes(String artifactPattern) { return StringUtils.removeEnd(StringUtils.removeStart(artifactPattern, "\""), "\""); } public ServerDetails getDetails() { return details; } public String getMatrixParams() { return matrixParams; } public boolean isOverridingDefaultDeployer() { return deployerCredentialsConfig != null && deployerCredentialsConfig.isCredentialsProvided(); } public Credentials getOverridingDeployerCredentials() { return overridingDeployerCredentials; } public CredentialsConfig getDeployerCredentialsConfig() { return deployerCredentialsConfig; } public boolean isNotM2Compatible() { return notM2Compatible; } public void setNotM2Compatible(boolean notM2Compatible) { this.notM2Compatible = notM2Compatible; } public boolean isDiscardBuildArtifacts() { return discardBuildArtifacts; } public boolean isDiscardOldBuilds() { return discardOldBuilds; } public void setDiscardOldBuilds(boolean discardOldBuilds) { this.discardOldBuilds = discardOldBuilds; } public String getArtifactPattern() { return clearApostrophes(artifactPattern); } public void setArtifactPattern(String artifactPattern) { this.artifactPattern = clearApostrophes(artifactPattern); } public String getIvyPattern() { return ivyPattern; } public void setIvyPattern(String ivyPattern) { this.ivyPattern = ivyPattern; } public boolean isM2Compatible() { return !notM2Compatible; } public boolean isIncludePublishArtifacts() { return includePublishArtifacts; } public void setIncludePublishArtifacts(boolean includePublishArtifacts) { this.includePublishArtifacts = includePublishArtifacts; } public boolean isRunChecks() { return runChecks; } public void setRunChecks(boolean runChecks) { this.runChecks = runChecks; } public boolean isDisableLicenseAutoDiscovery() { return disableLicenseAutoDiscovery; } public String getScopes() { return scopes; } public boolean isLicenseAutoDiscovery() { return licenseAutoDiscovery; } public void setLicenseAutoDiscovery(boolean licenseAutoDiscovery) { this.licenseAutoDiscovery = licenseAutoDiscovery; } public boolean isDeployArtifacts() { return deployArtifacts; } public IncludesExcludes getArtifactDeploymentPatterns() { return artifactDeploymentPatterns; } public boolean isDeployBuildInfo() { return deployBuildInfo; } public boolean isIncludeEnvVars() { return includeEnvVars; } public IncludesExcludes getEnvVarsPatterns() { return envVarsPatterns; } public String getArtifactoryName() { return details != null ? details.artifactoryName : null; } public String getRepositoryKey() { return details != null ? details.getDeployReleaseRepository().getRepoKey() : null; } public String getDefaultPromotionTargetRepository() { //Not implemented return null; } public String getArtifactoryUrl() { ArtifactoryServer server = getArtifactoryServer(); return server != null ? server.getUrl() : null; } public String getViolationRecipients() { return violationRecipients; } public void setViolationRecipients(String violationRecipients) { this.violationRecipients = violationRecipients; } public boolean isEnableIssueTrackerIntegration() { return enableIssueTrackerIntegration; } public void setEnableIssueTrackerIntegration(boolean enableIssueTrackerIntegration) { this.enableIssueTrackerIntegration = enableIssueTrackerIntegration; } public boolean isAggregateBuildIssues() { return aggregateBuildIssues; } public void setAggregateBuildIssues(boolean aggregateBuildIssues) { this.aggregateBuildIssues = aggregateBuildIssues; } public String getAggregationBuildStatus() { return aggregationBuildStatus; } public void setAggregationBuildStatus(String aggregationBuildStatus) { this.aggregationBuildStatus = aggregationBuildStatus; } public boolean isBlackDuckRunChecks() { return blackDuckRunChecks; } public void setBlackDuckRunChecks(boolean blackDuckRunChecks) { this.blackDuckRunChecks = blackDuckRunChecks; } public String getBlackDuckAppName() { return blackDuckAppName; } public void setBlackDuckAppName(String blackDuckAppName) { this.blackDuckAppName = blackDuckAppName; } public String getBlackDuckAppVersion() { return blackDuckAppVersion; } public void setBlackDuckAppVersion(String blackDuckAppVersion) { this.blackDuckAppVersion = blackDuckAppVersion; } public String getBlackDuckReportRecipients() { return blackDuckReportRecipients; } public String getBlackDuckScopes() { return blackDuckScopes; } public boolean isBlackDuckIncludePublishedArtifacts() { return blackDuckIncludePublishedArtifacts; } public boolean isAutoCreateMissingComponentRequests() { return autoCreateMissingComponentRequests; } public boolean isAutoDiscardStaleComponentRequests() { return autoDiscardStaleComponentRequests; } public boolean isFilterExcludedArtifactsFromBuild() { return filterExcludedArtifactsFromBuild; } @Override public Collection<? extends Action> getProjectActions(AbstractProject project) { return ActionableHelper.getArtifactoryProjectAction(getArtifactoryName(), project); } @Override public Environment setUp(final AbstractBuild build, final Launcher launcher, final BuildListener listener) throws IOException, InterruptedException { String artifactoryPluginVersion = ActionableHelper.getArtifactoryPluginVersion(); listener.getLogger().println("Jenkins Artifactory Plugin version: " + artifactoryPluginVersion); File localDependencyFile = Which.jarFile(ArtifactoryBuildListener.class); final FilePath actualDependencyDir = PluginDependencyHelper .getActualDependencyDirectory(localDependencyFile, Utils.getNode(launcher).getRootPath()); final PublisherContext context = new PublisherContext.Builder().artifactoryServer(getArtifactoryServer()) .serverDetails(getDetails()).deployerOverrider(ArtifactoryIvyConfigurator.this) .runChecks(isRunChecks()).includePublishArtifacts(isIncludePublishArtifacts()) .violationRecipients(getViolationRecipients()).scopes(getScopes()) .licenseAutoDiscovery(licenseAutoDiscovery).discardOldBuilds(isDiscardOldBuilds()) .deployArtifacts(isDeployArtifacts()).includesExcludes(getArtifactDeploymentPatterns()) .skipBuildInfoDeploy(!isDeployBuildInfo()).includeEnvVars(isIncludeEnvVars()) .envVarsPatterns(getEnvVarsPatterns()).discardBuildArtifacts(isDiscardBuildArtifacts()) .matrixParams(getMatrixParams()).artifactsPattern(getArtifactPattern()).ivyPattern(getIvyPattern()) .maven2Compatible(isM2Compatible()).enableIssueTrackerIntegration(isEnableIssueTrackerIntegration()) .aggregateBuildIssues(isAggregateBuildIssues()).aggregationBuildStatus(getAggregationBuildStatus()) .integrateBlackDuck(isBlackDuckRunChecks(), getBlackDuckAppName(), getBlackDuckAppVersion(), getBlackDuckReportRecipients(), getBlackDuckScopes(), isBlackDuckIncludePublishedArtifacts(), isAutoCreateMissingComponentRequests(), isAutoDiscardStaleComponentRequests()) .filterExcludedArtifactsFromBuild(isFilterExcludedArtifactsFromBuild()) .artifactoryPluginVersion(artifactoryPluginVersion).build(); build.setResult(Result.SUCCESS); return new AntIvyBuilderEnvironment() { @Override public void buildEnvVars(Map<String, String> env) { try { ExtractorUtils.addBuilderInfoArguments(env, build, listener, context, null, build.getWorkspace(), launcher); } catch (Exception e) { throw new RuntimeException(e); } } @Override public String getAdditionalArgs() { StringBuilder targets = new StringBuilder(); String actualDependencyDirPath = actualDependencyDir.getRemote(); actualDependencyDirPath = actualDependencyDirPath.replace('\\', '/'); actualDependencyDirPath = "\"" + actualDependencyDirPath + "\""; targets.append("-lib ").append(actualDependencyDirPath).append(" "); targets.append("-listener ").append("org.jfrog.build.extractor.listener.ArtifactoryBuildListener") .append(" "); return targets.toString(); } }; } public ArtifactoryServer getArtifactoryServer() { return RepositoriesUtils.getArtifactoryServer(getArtifactoryName(), getDescriptor().getArtifactoryServers()); } public List<Repository> getReleaseRepositoryList() { return RepositoriesUtils.collectRepositories(details.getDeployReleaseRepository().getKeyFromSelect()); } @Override public DescriptorImpl getDescriptor() { return (DescriptorImpl) super.getDescriptor(); } @Extension(optional = true) public static class DescriptorImpl extends BuildWrapperDescriptor { private AbstractProject<?, ?> item; public DescriptorImpl() { super(ArtifactoryIvyConfigurator.class); load(); } @Override public boolean isApplicable(AbstractProject<?, ?> item) { this.item = item; return "hudson.ivy.IvyModuleSet".equals(item.getClass().getName()); } /** * This method triggered from the client side by Ajax call. * The Element that trig is the "Refresh Repositories" button. * * @param url Artifactory url * @param credentialsId credentials Id if using Credentials plugin * @param username credentials legacy mode username * @param password credentials legacy mode password * @param overrideCredentials credentials legacy mode overridden * @return {@link org.jfrog.hudson.util.RefreshServerResponse} object that represents the response of the repositories */ @JavaScriptMethod public RefreshServerResponse refreshFromArtifactory(String url, String credentialsId, String username, String password, boolean overrideCredentials) { CredentialsConfig credentialsConfig = new CredentialsConfig(username, password, credentialsId, overrideCredentials); RefreshServerResponse response = new RefreshServerResponse(); ArtifactoryServer artifactoryServer = RepositoriesUtils.getArtifactoryServer(url, RepositoriesUtils.getArtifactoryServers()); try { List<String> releaseRepositoryKeysFirst = RepositoriesUtils.getLocalRepositories(url, credentialsConfig, artifactoryServer, item); Collections.sort(releaseRepositoryKeysFirst); List<Repository> releaseRepositoryList = RepositoriesUtils .createRepositoriesList(releaseRepositoryKeysFirst); response.setRepositories(releaseRepositoryList); response.setSuccess(true); } catch (Exception e) { e.printStackTrace(); response.setResponseMessage(e.getMessage()); response.setSuccess(false); } return response; } @SuppressWarnings("unused") public ListBoxModel doFillCredentialsIdItems(@AncestorInPath Item project) { return PluginsUtils.fillPluginCredentials(project); } @Override public String getDisplayName() { return "Publish to Artifactory"; } @Override public String getHelpFile() { return "/plugin/artifactory/ivy/help-publish.html"; } @Override public boolean configure(StaplerRequest req, JSONObject json) throws FormException { req.bindParameters(this, "ivy"); save(); return true; } public FormValidation doCheckArtifactoryName(@QueryParameter String value) { return FormValidations.validateInternetAddress(value); } public FormValidation doCheckViolationRecipients(@QueryParameter String value) { return FormValidations.validateEmails(value); } /** * Returns the list of {@link org.jfrog.hudson.ArtifactoryServer} configured. * * @return can be empty but never null. */ public List<ArtifactoryServer> getArtifactoryServers() { return RepositoriesUtils.getArtifactoryServers(); } public boolean isUseCredentialsPlugin() { return PluginsUtils.isUseCredentialsPlugin(); } public boolean isJiraPluginEnabled() { return (Jenkins.getInstance().getPlugin("jira") != null); } } /** * Page Converter */ public static final class ConverterImpl extends DeployerResolverOverriderConverter { public ConverterImpl(XStream2 xstream) { super(xstream); } } }