Merge branch 'develop' into test-with-7.7-20200130

Author: Chris Wiechmann

.travis.yml

@@ -30,11 +30,9 @@ before_install:
   #- sudo apt-get install curl
   # All files in this folder will be cached for the next build
   - mkdir -p $CACHE_DIR
-  # Login to the Docker-Registry
-  - if [ ! -f $CACHE_FILE_APIM ]; then docker login --username $AXWAY_DOCKER_REG_USER --password $AXWAY_DOCKER_REG_PASS docker-registry.demo.axway.com; fi
   # Downloading the APIM-Docker-Image takes too long (Timeout 10 minutes) - Externalized to make use of travis_wait
   # In this script, we are either using the cached version or download a new Docker-Image
-  - travis_wait build/pull_apim_docker_image.sh $CACHE_FILE_APIM
+  - travis_wait build/pull_apim_docker_image.sh
   # Now it's time to safe the downloaded API-Management Docker-Image into the cache folder
   - if [ ! -f $CACHE_FILE_APIM ]; then docker save $APIM_DOCKER_IMAGE | gzip > $CACHE_FILE_APIM; fi
   # Pull Cassandra Image or use the cache

CHANGELOG.md

@@ -9,13 +9,25 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Search for APIs based on configured Inbound- and Outbound-Security (See issue [#86](https://github.com/Axway-API-Management-Plus/apim-cli/issues/86))
 - Added support for API-Manager Config/Alerts/Remote-Hosts (See issue [#68](https://github.com/Axway-API-Management-Plus/apim-cli/issues/68))
 - APIs now updated without Re-Creating them if possible (See issue [#95](https://github.com/Axway-API-Management-Plus/apim-cli/issues/95))
+- Support to manage the full Remote-Host introduced with the API-Manager September/2020 release
+- Capability to filter APIs based on their organization
+- New command to approve one or more APIs that are in pending state (See issue [#97](https://github.com/Axway-API-Management-Plus/apim-cli/issues/97))
+- Script apim.sh and apim.bat now optionally use AXWAY_APIM_CLI_HOME to setup the classpath (See issue [#100](https://github.com/Axway-API-Management-Plus/apim-cli/issues/100))
+- Staging support for applications, users and organizations
+- Support for custom properties for applications, users and organizations (See issue [#93](https://github.com/Axway-API-Management-Plus/apim-cli/issues/93))
 
 ### Fixed
 - Avoid NPE during API-Export if custom-properties config is inconsistent (See issue [#90](https://github.com/Axway-API-Management-Plus/apim-cli/issues/90))
 - Disabled applications not created as disabled (See issue [#89](https://github.com/Axway-API-Management-Plus/apim-cli/issues/89))
 - Support for special characters like an accent (See issue [#88](https://github.com/Axway-API-Management-Plus/apim-cli/issues/88))
 - Organizations now validated based on given stage (See issue [#58](https://github.com/Axway-API-Management-Plus/apim-cli/issues/58))
 - API-Import is now stopped if host and backendBasepath is missing (See issue [#53](https://github.com/Axway-API-Management-Plus/apim-cli/issues/53))
+- Command-Line option with or without arguments can now be given interchangeable (See issue [#102](https://github.com/Axway-API-Management-Plus/apim-cli/issues/102))
+- apim.bat now works with or without JAVA_HOME set (See issue [#105](https://github.com/Axway-API-Management-Plus/apim-cli/issues/105))
+
+### Changed
+- APIs no longer Re-Created if not needed (See issue [#95](https://github.com/Axway-API-Management-Plus/apim-cli/issues/95))
+- CLI Options parser refactored to be more flexible and support future requirements (See PR [#103](https://github.com/Axway-API-Management-Plus/apim-cli/pull/103))
 
 ## [1.2.3] 2020-09-24
 ### Added

build/pull_apim_docker_image.sh

@@ -1,10 +1,11 @@
 #!/bin/sh
 
-if [ -f $CACHE_FILE_APIM ]
+if [ -f $CACHE_FILE_APIM -a "$SKIP_CACHE" != "true" ]
 then
-	echo "Loading API-Manager docker image: $APIM_DOCKER_IMAGE from $CACHE_FILE_APIM"
+	echo "Using cached API-Manager docker image: $APIM_DOCKER_IMAGE from $CACHE_FILE_APIM"
 	gunzip -c $CACHE_FILE_APIM | docker load
 else
 	echo "Pulling APIM docker from registry, this will take a while"
+	docker login --username $AXWAY_DOCKER_REG_USER --password $AXWAY_DOCKER_REG_PASS docker-registry.demo.axway.com
 	docker pull $APIM_DOCKER_IMAGE
 fi

distribution/assembly/dist-release.xml

@@ -17,7 +17,7 @@
         <include>com.github.axway-api-management-plus.apim-cli:apimcli-apps</include>
         <include>com.github.axway-api-management-plus.apim-cli:apimcli-organizations</include>
         <include>com.github.axway-api-management-plus.apim-cli:apimcli-users</include>
-		<include>com.github.axway-api-management-plus.apim-cli:apimcli-setup</include>
+		<include>com.github.axway-api-management-plus.apim-cli:apimcli-settings</include>
         <include>com.github.axway-api-management-plus.apim-cli:apimcli-tool</include>
       </includes>
       <binaries>

distribution/pom.xml

@@ -38,7 +38,7 @@
 		</dependency>
 		<dependency>
 			<groupId>com.github.axway-api-management-plus.apim-cli</groupId>
-			<artifactId>apimcli-setup</artifactId>
+			<artifactId>apimcli-settings</artifactId>
 		</dependency>
 	</dependencies>
 

modules/apim-adapter/assembly/conf/env.properties.sample

@@ -65,4 +65,18 @@ admin_password=changeme
 # want. 
 # The following example maps the return code 10 (NO_CHANGE) and 56 (UNKNOWN_API) into a SUCCESS.
 # Call api-import with option: -returnCode to see all possible return codes.
-# returnCodeMapping=10:0, 56:0
+# returnCodeMapping=10:0, 56:0
+
+# If a published API can be updated without the need to re-import the 
+# backend API (e.g. changing a policy, tags, etc.), the frontend API is unpublished, 
+# changed and then republished. 
+# This process only takes a few seconds, but technically leads to a short downtime for consumers. 
+# The advantage is that in this mode the API-ID and used runtime quotas of applications are preserved.
+# This is the default behavior since version 1.3.0.
+#
+# You can set the switch zeroDowntimeUpdate to true to update APIs with zero downtime as before. 
+# That means that when updating a published API, the CLI always creates a completely new API, 
+# configures it according to the old API and finally clients are switched to the new API. 
+# This new API then has a new ID and runtime quotas are lost. The configured quotas are 
+# transferred to the new API. 
+# zeroDowntimeUpdate=true

modules/apim-adapter/src/main/java/com/axway/apim/adapter/APIManagerAdapter.java

@@ -8,10 +8,8 @@
 import java.util.Collection;
 import java.util.Date;
 import java.util.HashMap;
-import java.util.Iterator;
 import java.util.List;
 import java.util.Map;
-import java.util.Map.Entry;
 
 import org.apache.commons.io.IOUtils;
 import org.apache.http.Header;
@@ -44,6 +42,8 @@
 import com.axway.apim.adapter.apis.APIManagerQuotaAdapter;
 import com.axway.apim.adapter.apis.APIManagerRemoteHostsAdapter;
 import com.axway.apim.adapter.clientApps.APIMgrAppsAdapter;
+import com.axway.apim.adapter.customProperties.APIManager762CustomPropertiesAdapter;
+import com.axway.apim.adapter.customProperties.APIManagerCustomPropertiesAdapter;
 import com.axway.apim.adapter.user.APIManagerUserAdapter;
 import com.axway.apim.api.model.CaCert;
 import com.axway.apim.api.model.Image;
@@ -60,7 +60,6 @@
 import com.axway.apim.lib.utils.rest.GETRequest;
 import com.axway.apim.lib.utils.rest.POSTRequest;
 import com.axway.apim.lib.utils.rest.RestAPICall;
-import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
@@ -99,18 +98,12 @@ public class APIManagerAdapter {
 	public final static String TYPE_FRONT_END = "proxies";
 	public final static String TYPE_BACK_END = "apirepo";
 
-	public static enum CUSTOM_PROP_TYPE {
-		api, 
-		user, 
-		organization, 
-		application
-	}
-	
 	private CoreParameters cmd;
 
 	private static CacheManager cacheManager;
 
 	public APIManagerConfigAdapter configAdapter;
+	public APIManagerCustomPropertiesAdapter customPropertiesAdapter;
 	public APIManagerAlertsAdapter alertsAdapter;
 	public APIManagerRemoteHostsAdapter remoteHostsAdapter;
 	public APIManagerAPIAdapter apiAdapter;
@@ -167,7 +160,21 @@ public static synchronized void deleteInstance() throws AppException {
 	private APIManagerAdapter() throws AppException {
 		super();
 		this.cmd = CoreParameters.getInstance();
+		cmd.validateRequiredParameters();
+		
 		this.configAdapter = new APIManagerConfigAdapter();
+
+		if(TestIndicator.getInstance().isTestRunning()) {
+			this.hasAdminAccount = true; // For unit tests we have an admin account
+		} else {
+			// No need to login, when running unit tests
+			loginToAPIManager(false); // Login with the provided user (might be an Org-Admin)
+			loginToAPIManager(true); // Second, login if needed with an admin account
+			APIManagerAdapter.apiManagerVersion = configAdapter.getConfig(false).getProductVersion();
+		}
+
+		// For now this okay, may be replaced with a Factory later
+		this.customPropertiesAdapter = (hasAPIManagerVersion("7.7")) ? new APIManagerCustomPropertiesAdapter() : new APIManager762CustomPropertiesAdapter();
 		this.alertsAdapter = new APIManagerAlertsAdapter();
 		this.remoteHostsAdapter = new APIManagerRemoteHostsAdapter();
 		this.apiAdapter = new APIManagerAPIAdapter();
@@ -179,13 +186,6 @@ private APIManagerAdapter() throws AppException {
 		this.oauthClientAdapter = new APIManagerOAuthClientProfilesAdapter();
 		this.appAdapter = new APIMgrAppsAdapter();
 		this.userAdapter = new APIManagerUserAdapter();
-		if(TestIndicator.getInstance().isTestRunning()) {
-			this.hasAdminAccount = true; // For unit tests we have an admin account
-			return; // No need to initialize just for Unit-Tests
-		}
-		
-		loginToAPIManager(false); // Login with the provided user (might be an Org-Admin)
-		loginToAPIManager(true); // Second, login if needed with an admin account
 	}
 
 	public void loginToAPIManager(boolean useAdminClient) throws AppException {
@@ -546,67 +546,6 @@ public static String getApiManagerName() throws AppException {
 		return APIManagerAdapter.apiManagerName;
 	}
 
-	public static Map<String, String> getAllConfiguredCustomProperties(CUSTOM_PROP_TYPE type) {
-    	Map<String, String> allCustomProps = new HashMap<String, String>();
-    	try {
-    		JsonNode appConfig = getCustomPropertiesConfig();
-    		JsonNode apiCustomProps = appConfig.get(type.name());
-    		if(apiCustomProps==null) return null;
-    		Iterator<Entry<String, JsonNode>> it = apiCustomProps.fields();
-    		while(it.hasNext()) {
-    			Entry<String, JsonNode> entry = it.next();
-    			allCustomProps.put(entry.getKey(), null);
-    		}
-    		return allCustomProps;
-    	} catch (Exception e) {
-    		LOG.error("Error loading configured custom properties from API-Manager", e);
-    		return null;
-    	}
-    }
-	
-	public static JsonNode getCustomPropertiesConfig() throws AppException {
-		
-		String appConfig = null;
-		URI uri;
-		HttpEntity httpResponse = null;
-		try {
-			uri = new URIBuilder(CoreParameters.getInstance().getAPIManagerURL()).setPath("/vordel/apiportal/app/app.config").build();
-			RestAPICall getRequest = new GETRequest(uri);
-			httpResponse = getRequest.execute().getEntity();
-			appConfig = IOUtils.toString(httpResponse.getContent(), "UTF-8");
-			return parseAppConfig(appConfig);
-		} catch (Exception e) {
-			throw new AppException("Can't read app.config from API-Manager: '" + appConfig + "'", ErrorCode.API_MANAGER_COMMUNICATION, e);
-		} finally {
-			try {
-				if(httpResponse!=null) 
-					((CloseableHttpResponse)httpResponse).close();
-			} catch (Exception ignore) {}
-		}
-	}
-	
-	/**
-	 * Helper method to validate that configured Custom-Properties are really configured 
-	 * in the API-Manager configuration.<br>
-	 * Will become obsolete sine the API-Manager REST-API provides an endpoint for that.
-	 * @param appConfig from the API-Manager (which isn't JSON)
-	 * @return JSON-Configuration with the custom-properties section
-	 * @throws AppException if the app.config can't be parsed
-	 */
-	public static JsonNode parseAppConfig(String appConfig) throws AppException {
-		ObjectMapper mapper = new ObjectMapper();
-		try {
-			appConfig = appConfig.substring(appConfig.indexOf("customPropertiesConfig:")+23, appConfig.indexOf("wizardModels"));
-			//appConfig = appConfig.substring(0, appConfig.length()-1); // Remove the tail comma
-			mapper.configure(JsonParser.Feature.ALLOW_UNQUOTED_FIELD_NAMES, true);
-			mapper.configure(JsonParser.Feature.ALLOW_COMMENTS, true);
-			mapper.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true);
-			return mapper.readTree(appConfig);
-		} catch (Exception e) {
-			throw new AppException("Can't parse API-Manager app.config.", ErrorCode.API_MANAGER_COMMUNICATION, e);
-		}
-	}
-	
 	/**
 	 * Helper method to fulfill the given certificates by the API-Developer into the required 
 	 * format as it's needed by the API-Manager.