Release v1.2.0 (#57)

mlookaxw · web-flow · commit a4b0af0dd58c · 2021-06-03T12:54:47.000+02:00
* ID-55: support multiple base directories for certs

* Start work on next release

* ID-56: read properties from stdin

* ID-56: amend documentation

* Release v1.2.0
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -1,10 +1,46 @@
 = Changelog
 
+== Version 1.2.0
+[cols="1,2,<10a", options="header"]
+|===
+|ID|Type|Description
+|https://github.com/Axway-API-Management-Plus/apigw-maven-plugin/issues/55[#55]
+|Enhancement
+|Add support for multiple base directories for certificates.
+
+|https://github.com/Axway-API-Management-Plus/apigw-maven-plugin/issues/56[#56]
+|Enhancement
+|Read properties from stdin.
+
+If the filename of the  `--prop` parameter is a single dash `-`, stdin will be used to read properties from a flat key/value JSON document.
+
+.Example of flat key/value JSON
+[source, json]
+----
+{
+  "prop1": "value1",
+  "prop2": "value2"
+}
+----
+
+[NOTE]
+====
+This feature can be used to read properties from external sources (e.g. AWS Secrets Manager or Hashicorp Vault).
+
+[source, shell]
+----
+# Get properties from Vault key/value engine
+vault kv get -format=json kv/apim \| jq .data.data \| buildfed --prop - -p src/gw.pol -e src/gw.env -c config/gw.config.json
+----
+====
+
+|===
+
 == Version 1.1.0
 [cols="1,2,<10a", options="header"]
 |===
 |ID|Type|Description
-|https://github.com/Axway-API-Management-Plus/apigw-maven-plugin/pull/53[#53]
+|https://github.com/Axway-API-Management-Plus/apigw-maven-plugin/issues/53[#53]
 |Enhancement
 |The property configuration now supports JSON boolean values.
 
diff --git a/doc/getting-started/getting-started.adoc b/doc/getting-started/getting-started.adoc
@@ -5,7 +5,7 @@
 :sectnums:
 :source-highlighter: prettify
 
-:mvn-plugin-ver: 1.1.0
+:mvn-plugin-ver: 1.2.0
 
 Here you get a simple introduction on how to use the _Maven Plugin for Axway API Gateway_.
 It assumes that you are familiar with https://maven.apache.org[Apache Maven] and that you are familiar with PolicyStudio and the API Gateway.
diff --git a/doc/manual/_config-tool.adoc b/doc/manual/_config-tool.adoc
@@ -57,9 +57,9 @@ Options:
                         Passphrase for output archive files [optional]
   -s, --simulate        Enable simulation mode [optional]
   -b DIRECTORY, --base-dir=DIRECTORY
-                        Base directory for certificate files [optional]
+                        Base directory for certificate files [multiple]
   --secrets-file=FILEPATH
-                        Path of JSON file containing confidential propertiers
+                        Path of JSON file containing confidential properties
                         [optional]
   --secrets-key=FILEPATH
                         Path to key file to decrypt confidential properties [optional]
@@ -91,6 +91,9 @@ Multiple files are supported by specifying the parameter multiple times.
 
 If a property occurs in multiple files the value from the last file is used.
 
+Specify a single dash '-' as filename to read properties from `stdin`.
+The input must be a flat key/value JSON document (e.g., `{"p1": "v1", "p2": "v2"}`).
+
 |--cert
 |An optional JSON file containing the certificate configuration.
 
@@ -154,7 +157,11 @@ To avoid errors due to incompatible types (e.g. placeholder string used for an i
 
 |-b, --base-dir
 |Base directory for certificate files.
-If specified relative path to certificate files is based on this directory.
+
+Multiple directories can be specified by adding the parameter multiple times.
+
+If specified, the given directories are scanned for certificate files.
+If multiple certificate files exists the first one will be used.
 
 |--secrets-file
 |Path of JSON file containing confidential properties.
diff --git a/doc/manual/_reference.adoc b/doc/manual/_reference.adoc
@@ -413,9 +413,12 @@ The plugin can also be configured in the `pom.xml` via the <configuration> eleme
     </configPropertFiles>
 
     <configCertsBaseDir>${basedir}/src/main/axwgw/certs</configCertsBaseDir> <!--5-->
-
-    <configSecretsFile>${basedir}/src/main/axwgw/gateway.crypt.json</configSecretsFile> <!--6-->
-    <configSecretsKey>${user.home}/secrets.key</configSecretsKey> <!--7-->
+    <configCertsBaseDirs>
+      <configCertsBaseDir>${basedir}/src/main/axwgw/certs/common</configCertsBaseDir> <!--6-->
+      <configCertsBaseDir>${basedir}/src/main/axwgw/certs/ca</configCertsBaseDir>
+    </configCertsBaseDirs>
+    <configSecretsFile>${basedir}/src/main/axwgw/gateway.crypt.json</configSecretsFile> <!--7-->
+    <configSecretsKey>${user.home}/secrets.key</configSecretsKey> <!--8-->
   </configuration>
 </plugin>
 <!- ... ->
@@ -425,5 +428,6 @@ The plugin can also be configured in the `pom.xml` via the <configuration> eleme
 <3> Location of a configuration file for properties.
 <4> Location of a list of configuration files for properties.
 <5> Base directory for certificate files.
-<6> Path to secrets file.
-<7> Key file to decrypt/encrypt values of secrets file.
+<6> Additional base directories for certificate files supported.
+<7> Path to secrets file.
+<8> Key file to decrypt/encrypt values of secrets file.
diff --git a/doc/manual/user-guide.adoc b/doc/manual/user-guide.adoc
@@ -1,7 +1,7 @@
 = Maven Plugin for API Gateway Policy Development: User Guide
 :Author: Martin Look
 :Email: mlook@axway.com
-:revnumber: 1.1.0
+:revnumber: 1.2.0
 :toc:
 :sectnums:
 :source-highlighter: prettify
diff --git a/example/config-tool/config/certs/common/staged-root-ca.crt b/example/config-tool/config/certs/common/staged-root-ca.crt
diff --git a/example/config-tool/run.cmd b/example/config-tool/run.cmd
@@ -8,5 +8,5 @@ REM Define environment variables for field value and password configuration
 SET INFO_NAME=Demo
 SET NEW_SERVER_PASSWORD=changeme
 
-CALL %BUILDFED% -v -e src\gateway.env -p src\gateway.pol -c config\gateway.config.json --cert=config\gateway.certs.json --prop=config\gateway.props.json --secrets-file=config\gateway.crypt.json --secrets-key=key.binary -D artifact:demo-1.0.0 -F info.descr:config\description.txt --output-fed=gateway.fed --passphrase-in=changeme --passphrase-out=changed --base-dir=config/certs
+CALL %BUILDFED% -v -e src\gateway.env -p src\gateway.pol -c config\gateway.config.json --cert=config\gateway.certs.json --prop=config\gateway.props.json --secrets-file=config\gateway.crypt.json --secrets-key=key.binary -D artifact:demo-1.0.0 -F info.descr:config\description.txt --output-fed=gateway.fed --passphrase-in=changeme --passphrase-out=changed --base-dir=config/certs/common --base-dir=config/certs
 ENDLOCAL
diff --git a/example/getting-started/pom.xml b/example/getting-started/pom.xml
@@ -7,7 +7,7 @@
   <packaging>pom</packaging>
 
   <properties>
-      <axway.maven.plugin.ver>1.1.0</axway.maven.plugin.ver>
+      <axway.maven.plugin.ver>1.2.0</axway.maven.plugin.ver>
   </properties>
 
   <modules>
diff --git a/pom.xml b/pom.xml
@@ -19,7 +19,7 @@
 
 	<groupId>com.axway.maven.plugins</groupId>
 	<artifactId>apigw-maven-plugin</artifactId>
-	<version>1.1.0</version>
+	<version>1.2.0</version>
 	<packaging>maven-plugin</packaging>
 
 	<name>Axway API Gateway Maven Plugin</name>
@@ -65,6 +65,8 @@
 		<maven.compiler.target>1.8</maven.compiler.target>
 
 		<jackson.version>[2.9.9.1,)</jackson.version>
+		<karate.version>0.9.6</karate.version>
+		<cucumber.version>5.4.0</cucumber.version>
 
 		<maven.wagon.http.pool>false</maven.wagon.http.pool>
 	</properties>
@@ -111,6 +113,26 @@
 			<artifactId>jackson-databind</artifactId>
 			<version>${jackson.version}</version>
 		</dependency>
+		<dependency>
+			<groupId>com.intuit.karate</groupId>
+			<artifactId>karate-core</artifactId>
+			<version>${karate.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>com.intuit.karate</groupId>
+			<artifactId>karate-apache</artifactId>
+			<version>${karate.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>com.intuit.karate</groupId>
+			<artifactId>karate-junit5</artifactId>
+			<version>${karate.version}</version>
+		</dependency>
+		<dependency>
+			<groupId>net.masterthought</groupId>
+			<artifactId>cucumber-reporting</artifactId>
+			<version>${cucumber.version}</version>
+		</dependency>
 	</dependencies>
 
 	<build>
diff --git a/src/main/java/com/axway/maven/apigw/AbstractGatewayMojo.java b/src/main/java/com/axway/maven/apigw/AbstractGatewayMojo.java
@@ -98,7 +98,10 @@ public abstract class AbstractGatewayMojo extends AbstractMojo {
 
 	@Parameter(property = "axway.config.certs.basedir", required = false)
 	protected File configCertsBaseDir = null;
-	
+
+	@Parameter(property = "axway.config.certs.basedirs", required = false)
+	protected File[] configCertsBaseDirs = null;
+
 	@Parameter(property = "axway.tools.cfg.cert.expirationDays", required = false)
 	protected int certExpirationDays = 10;
 
@@ -308,4 +311,17 @@ protected Map<String, String> buildPolicyProperties() throws MojoExecutionExcept
 		
 		return polProps;
 	}
+	
+	protected List<File> getCertificateBaseDirs() {
+		ArrayList<File> baseDirs = new ArrayList<>();
+		if (this.configCertsBaseDir != null) {
+			baseDirs.add(this.configCertsBaseDir);
+		}
+		if (this.configCertsBaseDirs != null) {
+			for (File f : this.configCertsBaseDirs) {
+				baseDirs.add(f);
+			}
+		}
+		return baseDirs;
+	}
 }
diff --git a/src/main/java/com/axway/maven/apigw/DeploymentArchiveMojo.java b/src/main/java/com/axway/maven/apigw/DeploymentArchiveMojo.java
@@ -160,7 +160,7 @@ private void buildFedArchive(File targetDir, File srcPolFile, File srcEnvFile, F
 			fedBuilder.setCertificatesFile(this.configCertsFile);
 			fedBuilder.setCertificateExpirationDays(this.certExpirationDays);
 			fedBuilder.enableCertificateConfigFileUpdate(this.updateCertConfigFile);
-			fedBuilder.setCertificatesBasePath(this.configCertsBaseDir);
+			fedBuilder.setCertificatesBasePath(getCertificateBaseDirs());
 		}
 		if (this.configSecretsFile != null) {
 			if (this.configSecretsKey == null)
diff --git a/src/main/java/com/axway/maven/apigw/DeploymentMojo.java b/src/main/java/com/axway/maven/apigw/DeploymentMojo.java
@@ -137,7 +137,7 @@ private File configFed(File pol, File env, File info) throws MojoExecutionExcept
 			fb.setCertificatesFile(this.configCertsFile);
 			fb.setCertificateExpirationDays(this.certExpirationDays);
 			fb.enableCertificateConfigFileUpdate(this.updateCertConfigFile);
-			fb.setCertificatesBasePath(this.configCertsBaseDir);
+			fb.setCertificatesBasePath(getCertificateBaseDirs());
 		}
 		if (this.configSecretsFile != null) {
 			if (this.configSecretsKey == null)
diff --git a/src/main/java/com/axway/maven/apigw/utils/FedBuilder.java b/src/main/java/com/axway/maven/apigw/utils/FedBuilder.java
@@ -20,7 +20,7 @@ public class FedBuilder {
 
 	private final List<File> propertyFiles = new ArrayList<File>();
 	private File certsFile = null;
-	private File certsBaseDir = null;
+	private List<File> certsBaseDirs = null;
 
 	private int certExpirationDays = -1;
 
@@ -69,8 +69,8 @@ public void setCertificatesFile(File certsFile) {
 		this.certsFile = certsFile;
 	}
 
-	public void setCertificatesBasePath(File baseDir) {
-		this.certsBaseDir = baseDir;
+	public void setCertificatesBasePath(List<File> baseDirs) {
+		this.certsBaseDirs = baseDirs;
 	}
 
 	public void setCertificateExpirationDays(int days) {
@@ -130,9 +130,11 @@ public int execute(File targetFed, Map<String, String> props) throws MojoExecuti
 				if (this.updateCertConfigFile) {
 					args.add("--cert-config-update");
 				}
-				if (this.certsBaseDir != null) {
-					args.add("--base-dir");
-					args.add(this.certsBaseDir.getAbsolutePath());
+				if (this.certsBaseDirs != null) {
+					for (File bd : this.certsBaseDirs) {
+						args.add("--base-dir");
+						args.add(bd.getAbsolutePath());
+					}
 				}
 			}
 			if (this.secretsFile != null) {
diff --git a/src/main/resources-filtered/META-INF/plexus/components.xml b/src/main/resources-filtered/META-INF/plexus/components.xml
@@ -66,19 +66,5 @@
 				<packaging>axway-server-archive</packaging>
 			</configuration>
 		</component>
-		<component>
-			<role>org.apache.maven.artifact.handler.ArtifactHandler</role>
-			<role-hint>axway-deployment-archive</role-hint>
-			<implementation>org.apache.maven.artifact.handler.DefaultArtifactHandler</implementation>
-			<configuration>
-				<!--the extension used by Maven in the repository -->
-				<extension>axdar</extension>
-				<!--the type used when specifying dependencies etc. -->
-				<type>axway-deployment-archive</type>
-				<!--the packaging used when declaring an implementation of the packaging -->
-				<packaging>axway-deployment-archive</packaging>
-			</configuration>
-		</component>
-
 	</components>
 </component-set>
diff --git a/src/main/resources/scripts/lib/buildfed.py b/src/main/resources/scripts/lib/buildfed.py
@@ -31,7 +31,7 @@ def parse_cli_property(cli_prop):
 
 def main():
     prog = sys.argv[0]
-    version = "%prog 1.2.0"
+    version = "%prog 1.3.0"
     usage = "%prog OPTIONS"
     epilog = "Build configured .fed package."
  
@@ -51,7 +51,7 @@ def main():
     parser.add_option("--passphrase-in", dest="passphrase_in", help="Passphrase of input archive files [optional]", metavar="PASSPHRASE")
     parser.add_option("--passphrase-out", dest="passphrase_out", help="Passphrase for output archive files [optional]", metavar="PASSPHRASE")
     parser.add_option("-s", "--simulate", dest="simulate", help="Enable simulation mode [optional]", action="store_true")
-    parser.add_option("-b", "--base-dir", dest="base_dir", help="Base directory for certificate files [optional]", metavar="DIRECTORY")
+    parser.add_option("-b", "--base-dir", dest="base_dirs", help="Base directory for certificate files [multiple]", metavar="DIRECTORY", action="append")
     parser.add_option("--secrets-file", dest="secrets_file", help="Path of JSON file containing confidential properties [optional]", metavar="FILEPATH")
     parser.add_option("--secrets-key", dest="secrets_key_file", help="Path to key file to decrypt confidential properties [optional]", metavar="FILEPATH")
     
@@ -88,7 +88,7 @@ def main():
             if not os.path.isfile(prop_file):
                 raise ValueError("File for command line property '%s' doesn't exist: %s" % (name, prop_file))
             
-            logging.debug("Reading command line property '%s' from file '%s'" % (name, prop_file))
+            logging.info("Reading command line property '%s' from file '%s'" % (name, prop_file))
             with codecs.open(prop_file, encoding='utf-8', mode='r') as pf:
                 cli_properties[name] = pf.read()
 
@@ -115,8 +115,8 @@ def main():
 
         # Setup configuration
         fed_config = FedConfigurator(options.pol_file_path, options.env_file_path, options.config_file_path, options.cert_file_path, properties, passphrase_in, secrets)
-        if options.base_dir:
-            fed_config.set_base_dir(options.base_dir)
+        if options.base_dirs:
+            fed_config.set_base_dirs(options.base_dirs)
 
         if options.simulate:
             fed_config.enable_simulation_mode()
diff --git a/src/main/resources/scripts/lib/envconfig.py b/src/main/resources/scripts/lib/envconfig.py
@@ -2,6 +2,7 @@
 import os
 import logging
 import base64
+import sys
 
 from com.vordel.es.xes import PortableESPKFactory
 from java.text import SimpleDateFormat
@@ -24,23 +25,40 @@ def __init__(self, field_key, value):
 
 class PropConfig:
     def __init__(self, property_file_path_list):
+        stdin_loaded = False
         self.__properties = {}
         if not property_file_path_list:
             return
 
         for property_file_path in property_file_path_list:
-            if not os.path.exists(property_file_path):
-                raise ValueError("Property file '%s' doesn't exist!" % (property_file_path))
+            properties = None
+            if "-" == property_file_path:
+                if stdin_loaded:
+                    # properties already loaded from stdin
+                    continue
+                stdin_loaded = True
+                logging.info("Reading properties from stdin")
+                properties = json.load(sys.stdin)
+            else:
+                if not os.path.exists(property_file_path):
+                    raise ValueError("Property file '%s' doesn't exist!" % (property_file_path))
 
-            logging.info("Reading property file '%s'" % (property_file_path))
-            with open(property_file_path) as property_file:
-                properties_json = json.load(property_file)
+                logging.info("Reading property file '%s'" % (property_file_path))
+                with open(property_file_path) as property_file:
+                    properties_json = json.load(property_file)
 
-                if "properties" not in properties_json:
-                    raise ValueError("File '%s' is not a valid property file; missing 'properties' attribute!" % (property_file_path))
-                
-                for p in properties_json["properties"]:
-                    self.__properties[p] = properties_json["properties"][p]
+                    if "properties" not in properties_json:
+                        raise ValueError("File '%s' is not a valid property file; missing 'properties' attribute!" % (property_file_path))
+
+                    properties = properties_json["properties"]
+
+            # Add or overwrite properties
+            for p in properties:
+                if p not in self.__properties:
+                    logging.debug("set property '%s' from '%s'" % (p, property_file_path))
+                else:
+                    logging.debug("override property '%s' from '%s'" % (p, property_file_path))
+                self.__properties[p] = properties[p]
         return
 
     def get_property(self, key):
@@ -255,7 +273,7 @@ def get_file(self):
     def get_password(self):
         return self.__password
     
-    def is_empty():
+    def is_empty(self):
         return self.__type == "empty"
 
 class CertInfo:
diff --git a/src/main/resources/scripts/lib/fedconfig.py b/src/main/resources/scripts/lib/fedconfig.py
