ID-51: customized version name

Author: mlookaxw

CHANGELOG.adoc

@@ -4,6 +4,26 @@
 [cols="1,2,<10a", options="header"]
 |===
 |ID|Type|Description
+|https://github.com/Axway-API-Management-Plus/apigw-maven-plugin/issues/51[#51]
+|Enhancement
+|Customized version name for `.pol` and `.fed` packages.
+
+A new property `axway.project.version` is introduced to customize the version of `.pol` and `.fed` packages. As default the value will be set to ${project.version} . The version can be overwritten by a command line property of by a defined property within the pom.xml.
+
+*Example*
+
+Command line
+
+`$ mvn clean package -Daxway.project.version="${project.version}-BN20201031"`
+
+.pom.xml
+[source,xml]
+----
+<properties>
+  <axway.project.version>${project.version}-BN20201031</axway.project.version>
+</properties>
+----
+
 |https://github.com/Axway-API-Management-Plus/apigw-maven-plugin/pull/45[#45]
 |Enhancement
 |Docker capabilities.

doc/manual/_reference.adoc

@@ -236,6 +236,13 @@ Default: ${axway.home}/apigateway
 
 Default: ${axway.home}/policystudio
 
+|axway.project.version
+|Version name of the project.
+
+The version name is used for setting the version attribute of the policy properties within `.pol` or `.fed` packages.
+
+Default: ${project.version}
+
 |axway.dir.source
 |Directory of gateway or configuration file source code used by the plugin.
 ${basedir}/src/main/axwgw

src/main/java/com/axway/maven/apigw/AbstractGatewayMojo.java

@@ -110,6 +110,9 @@ public abstract class AbstractGatewayMojo extends AbstractMojo {
 
 	@Parameter(property = "axway.config.secrets.key", required = false)
 	protected File configSecretsKey = null;
+	
+	@Parameter(property = "axway.project.version", required = false, defaultValue="${project.version}")
+	protected String projectVersion;
 
 
 	@Parameter(defaultValue = "${project}", readonly = true)
@@ -296,4 +299,13 @@ protected ObjectNode buildBasicArtifactInfo() {
 
 		return root;
 	}
+	
+	protected Map<String, String> buildPolicyProperties() throws MojoExecutionException  {
+		Map<String, String> polProps = new HashMap<>();
+		polProps.put("Name", this.project.getGroupId() + ":" + this.project.getArtifactId());
+		polProps.put("Version", this.projectVersion);			
+		polProps.put("Type", getPackageType().getType());
+		
+		return polProps;
+	}
 }

src/main/java/com/axway/maven/apigw/ContainerMojo.java

@@ -253,10 +253,10 @@ private void deployFed(File fed) throws MojoExecutionException {
 			Source source = new Source(fed, this.passphraseFed);
 			Target target = new Target(this.deployGroup, this.passphraseDeploy);
 
-			AbstractCommandExecutor deploy;
+			DockerImage deploy;
 
 			// containerName is populated, so we are going to create a new container
-			AbstractCommandExecutor dockerCommands = new DockerCommands("Docker Commands", getLog());
+			DockerCommands dockerCommands = new DockerCommands("Docker Commands", getLog());
 			int exitCode = dockerCommands.execute("Remove Container", this.isRemoveContainer(), this.containerName,
 					null, null, null, null, null,
 					null, null, null, null);

src/main/java/com/axway/maven/apigw/DeploymentMojo.java

@@ -2,10 +2,8 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.util.HashMap;
 import java.util.Map;
 
-import com.axway.maven.apigw.utils.*;
 import org.apache.commons.io.FileUtils;
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
@@ -14,6 +12,11 @@
 import org.apache.maven.plugins.annotations.Mojo;
 import org.apache.maven.plugins.annotations.Parameter;
 
+import com.axway.maven.apigw.utils.FedBuilder;
+import com.axway.maven.apigw.utils.ProjectDeploy;
+import com.axway.maven.apigw.utils.ProjectPack;
+import com.axway.maven.apigw.utils.Source;
+import com.axway.maven.apigw.utils.Target;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.node.ObjectNode;
 
@@ -77,7 +80,7 @@ private void deployPolicyProject() throws MojoExecutionException {
 			// pack test server project
 			ProjectPack packer = new ProjectPack(this.homeAxwayGW, getLog());
 			packer.setPassphrasePol(this.passphrasePol);
-			int exitCode = packer.execute(getTempDir(), PROJECT_NAME, this.testServerDirectory, null);
+			int exitCode = packer.execute(getTempDir(), PROJECT_NAME, this.testServerDirectory, buildPolicyProperties());
 			if (exitCode != 0) {
 				throw new MojoExecutionException("failed to build packed project");
 			}
@@ -154,19 +157,14 @@ private File configFed(File pol, File env, File info) throws MojoExecutionExcept
 
 	private void deployFed(File fed) throws MojoExecutionException {
 		try {
-			Map<String, String> polProps = new HashMap<>();
-			polProps.put("Name", this.project.getGroupId() + ":" + this.project.getArtifactId());
-			polProps.put("Version", this.project.getVersion());
-			polProps.put("Type", "Test Deployment");
+			Map<String, String> polProps = buildPolicyProperties();
 
 			Source source = new Source(fed, this.passphraseFed);
 			Target target = new Target(this.deployGroup, this.passphraseDeploy);
 
-			AbstractCommandExecutor deploy;
-
 			// Deploying to a Classic Gateway, ok to use projdeploy
 			this.getLog().info("Using projdeploy to deploy the fed file");
-			deploy = new ProjectDeploy(this.homeAxwayGW, getDomain(), getLog());
+			ProjectDeploy deploy = new ProjectDeploy(this.homeAxwayGW, getDomain(), getLog());
 			int exitCode = deploy.execute(source, target, polProps, null);
 			if (exitCode != 0) {
 				throw new MojoExecutionException("Failed to deploy project: exitCode=" + exitCode);

src/main/java/com/axway/maven/apigw/ServerArchiveMojo.java

@@ -5,7 +5,6 @@
 import java.text.SimpleDateFormat;
 import java.util.ArrayList;
 import java.util.Date;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 
@@ -46,7 +45,7 @@ protected List<ArchiveDir> prepareDirs() throws MojoExecutionException {
 		File outDir = executeProjPack();
 		File polFile = new File(outDir, FILE_GATEWAY_POL);
 		File envFile = new File(outDir, FILE_GATEWAY_ENV);
-		
+
 		File archiveBuildDir = getArchiveBuildDir();
 
 		try {
@@ -84,15 +83,15 @@ private void prepareReadme(File targetDir) throws IOException, MojoExecutionExce
 
 		FileUtils.writeStringToFile(readme, str.toString(), "UTF-8");
 	}
-	
+
 	private void prepareInfoJson(File targetDir) throws IOException, MojoExecutionException {
 		ObjectMapper mapper = new ObjectMapper();
 		File info = new File(targetDir, FILE_GATEWAY_INFO);
-	
+
 		ObjectNode root = buildBasicArtifactInfo();
-		
+
 		String json = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(root);
-		
+
 		FileUtils.writeStringToFile(info, json, "UTF-8");
 	}
 
@@ -126,20 +125,17 @@ private void prepareJars(File targetDir) throws IOException, MojoExecutionExcept
 	private File executeProjPack() throws MojoExecutionException {
 		try {
 			File outDir = new File(getTargetDir(), DIR_ARCHIVE_ROOT);
-			
+
 			ProjectPack packer = new ProjectPack(this.homeAxwayGW, getLog());
 			packer.setPassphrasePol(this.passphrasePol);
-			Map<String, String> polProps = new HashMap<>();
-			polProps.put("Name", this.project.getGroupId() + ":" + this.project.getArtifactId());
-			polProps.put("Version", this.project.getVersion());			
-			polProps.put("Type", getType());
-			
+			Map<String, String> polProps = buildPolicyProperties();
+
 			int index = 0;
 			for (Artifact a : getDependentPolicyArchives()) {
 				polProps.put("Dependency_" + index, a.getId());
 				index++;
 			}
-			
+
 			packer.execute(outDir, FILE_GATEWAY, getPoliciesDirectory(), polProps);
 
 			return outDir;

src/main/java/com/axway/maven/apigw/utils/AbstractCommandExecutor.java

@@ -6,7 +6,6 @@
 import java.io.InputStreamReader;
 import java.util.ArrayList;
 import java.util.List;
-import java.util.Map;
 import java.util.Objects;
 
 import org.apache.maven.plugin.logging.Log;
@@ -29,16 +28,6 @@ protected Log getLog() {
 		return this.log;
 	}
 
-	protected int execute () throws IOException { return 0; }
-
-	public int execute ( String task, boolean remove, String containerName, String imageName, String imageTag,
-						 Map<String, String> ports, Map<String, String> links,
-						 Map<String, String> environmentVariables, String adminNodeManagerHost, String metricsDbUrl,
-						 String metricsDbUsername, String metricsDbPassword )
-			throws IOException { return 0; }
-
-	public int execute(Source source, Target target, Map<String, String> polProperties,
-					   Map<String, String> envProperties) throws IOException { return 0; }
 
 	protected int execute(List<String> parameters) throws IOException {
 		List<String> inputParam = new ArrayList<String>();

src/main/java/com/axway/maven/apigw/utils/DockerCommands.java

@@ -13,7 +13,6 @@ public DockerCommands(String name, Log log) {
         super(name, log);
     }
 
-    @Override
     public int execute ( String task, boolean remove, String containerName, String imageName, String imageTag,
                          Map<String, String> ports, Map<String, String> links,
                          Map<String, String> environmentVariables, String adminNodeManagerHost, String metricsDbUrl,

src/main/java/com/axway/maven/apigw/utils/DockerImage.java

@@ -39,7 +39,6 @@ public DockerImage(File axwayContainerScriptHome, String axwayImageName, String
         this.domainKeyPassFile = domainKeyPassFile;
     }
 
-    @Override
     public int execute(Source source, Target target, Map<String, String> polProperties, Map<String,
             String> envProperties) throws IOException {
         List<String> inputParam = new ArrayList<String>();