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

Author: Chris Wiechmann

CHANGELOG.md

@@ -5,21 +5,30 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Fixed
+- Created BE-API response was parsing the response wrong. This could lead to an issue, if the API contains a createdOn field. (See issue [#112](https://github.com/Axway-API-Management-Plus/apim-cli/issues/112))
+- Unicode API-Name was not shown correctly in the Backend-API overview (See issue [#113](https://github.com/Axway-API-Management-Plus/apim-cli/issues/113))
+- Application-Subscription not restored, when API is Republished to be updated (See issue [#114](https://github.com/Axway-API-Management-Plus/apim-cli/issues/114))
+
+### Added
+- Support to use a proxy for the API-Manager communication (See issue [#109](https://github.com/Axway-API-Management-Plus/apim-cli/issues/109))
+
+## [1.3.0] 2020-11-10
 ### Added
 - 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))
+- Scripts 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))
-- Support to read API-Description from  a local markdown See issue [#110](https://github.com/Axway-API-Management-Plus/apim-cli/issues/110))
+- Support to read the API-Description from  a local markdown file See issue [#110](https://github.com/Axway-API-Management-Plus/apim-cli/issues/110))
 
 ### 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))
+- Avoid NPE during API-Export if API-Custom-properties are not configured (See issue [#90](https://github.com/Axway-API-Management-Plus/apim-cli/issues/90))
+- Disabled applications not created as disabled in API-Manager (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))
@@ -29,6 +38,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### 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))
+- Updated Commons-text from version 1.8 to version 1.9
+- Updated Jackson-Databind from version 2.9.10.5 to 2.9.10.6
+- Updated commons-lang3 from version 3.10 to 3.11
+- Updated commons-io from version 2.7 to 2.8.0
+- Updated org.apache.httpcomponents httpclient from version 4.5.12 to 4.5.13
+- Updated Jackson from 2.9.10 to 2.11.3
 
 ## [1.2.3] 2020-09-24
 ### Added

README.md

@@ -12,7 +12,7 @@ Watch this video (28 min): https://youtu.be/2i8i1zMAMps to get an overview + dem
 
 With that, an API developer or the operations team is just providing the desired state configuration of the API, Application. When checked in, the [CI/CD-Pipeline](https://github.com/Axway-API-Management-Plus/apim-cli/wiki/7.-Pipeline-integration) picks it up and replicates it into the API Manager. 
 
-![API Manager Swagger-Promote overview](https://github.com/Axway-API-Management-Plus/apim-cli/blob/develop/misc/images/apimanager-swagger-promote-overview.png )
+![API Manager CLI overview](https://github.com/Axway-API-Management-Plus/apim-cli/blob/develop/misc/images/apim-cli-overview.png )
 
 ## Supported commands
 

distribution/pom.xml

@@ -5,7 +5,7 @@
 	<parent>
 		<groupId>com.github.axway-api-management-plus.apim-cli</groupId>
 		<artifactId>parent</artifactId>
-		<version>1.3.0-SNAPSHOT</version>
+		<version>1.3.1-SNAPSHOT</version>
 		<relativePath>../pom.xml</relativePath>
 	</parent>
 

modules/apim-adapter/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>com.github.axway-api-management-plus.apim-cli</groupId>
 		<artifactId>parent</artifactId>
-		<version>1.3.0-SNAPSHOT</version>
+		<version>1.3.1-SNAPSHOT</version>
 		<relativePath>../../pom.xml</relativePath>
 	</parent>
 

modules/apim-adapter/src/main/java/com/axway/apim/adapter/apis/APIManagerAPIAdapter.java

@@ -718,9 +718,9 @@ public API importBackendAPI(API api) throws AppException {
 				jsonNode =  importFromSwagger(api);
 			}
 			API createdAPI = new APIBaseDefinition();
-			createdAPI.setApiId(jsonNode.findPath("id").asText());
-			createdAPI.setName(jsonNode.findPath("name").asText());
-			createdAPI.setCreatedOn(Long.parseLong(jsonNode.findPath("createdOn").asText()));
+			createdAPI.setApiId(jsonNode.get("id").asText());
+			createdAPI.setName(jsonNode.get("name").asText());
+			createdAPI.setCreatedOn(Long.parseLong(jsonNode.get("createdOn").asText()));
 			return createdAPI;
 		} catch (Exception e) {
 			throw new AppException("Can't import definition / Create BE-API.", ErrorCode.CANT_CREATE_BE_API, e);
@@ -788,10 +788,10 @@ private JsonNode importFromSwagger(API api) throws URISyntaxException, AppExcept
 		}
 		try {
 			entity = MultipartEntityBuilder.create()
-					.addTextBody("name", api.getName())
+					.addTextBody("name", api.getName(), ContentType.create("text/plain", StandardCharsets.UTF_8))
 					.addTextBody("type", "swagger")
 					.addBinaryBody("file", api.getApiDefinition().getApiSpecificationContent(), ContentType.create("application/json"), "filename")
-					.addTextBody("fileName", "XYZ").addTextBody("organizationId", api.getOrganization().getId())
+					.addTextBody("fileName", "XYZ").addTextBody("organizationId", api.getOrganization().getId(), ContentType.create("text/plain", StandardCharsets.UTF_8))
 					.addTextBody("integral", "false").addTextBody("uploadType", "html5").build();
 			RestAPICall importSwagger = new POSTRequest(entity, uri);
 			importSwagger.setContentType(null);

modules/apim-adapter/src/main/java/com/axway/apim/adapter/clientApps/APIMgrAppsAdapter.java

@@ -225,7 +225,7 @@ void addApplicationCredentials(ClientApplication app, boolean addCredentials) th
 		for(int i=0; i<types.length; i++) {
 			try {
 				String type = types[i];
-				TypeReference classType = classTypes[i];
+				TypeReference<List<ClientAppCredential>> classType = classTypes[i];
 				if(!applicationsCredentialCache.containsKey(app.getId()+"|"+type)) {
 					uri = new URIBuilder(cmd.getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/applications/"+app.getId()+"/"+type)
 							.build();
@@ -272,7 +272,7 @@ private void addOauthResources(ClientApplication app, boolean includeOauthResour
 						LOG.error("Error reading application oauth resources. Response-Code: "+statusCode+". Got response: '"+response+"'");
 						throw new AppException("Error creating application' Response-Code: "+statusCode+"", ErrorCode.API_MANAGER_COMMUNICATION);
 					}
-					TypeReference classType = new TypeReference<List<ClientAppOauthResource>>() {};
+					TypeReference<List<ClientAppOauthResource>> classType = new TypeReference<List<ClientAppOauthResource>>() {};
 					oauthResources = mapper.readValue(response, classType);
 					app.getOauthResources().addAll(oauthResources);
 			} catch (Exception e) {

modules/apim-adapter/src/main/java/com/axway/apim/api/API.java

@@ -249,7 +249,6 @@ public void setState(String state) {
 	 * To make Desired and Actual API comparable this method is encapsulating the difference. 
 	 * @see com.axway.apim.api.API#getState()
 	 * @return the state of the API (unpublished, deprecated, etc.)
-	 * @throws AppException in case of an error
 	 */
 	public String getState() {
 		if(this.deprecated!=null 

modules/apim-adapter/src/main/java/com/axway/apim/lib/CoreCLIOptions.java

@@ -38,6 +38,11 @@ public Parameters getParams() throws AppException {
 		// Also support -f for backwards compatibility
 		if(!params.isForce()) params.setForce(Boolean.parseBoolean(getValue("f")));
 
+		params.setProxyHost(getValue("httpProxyHost"));
+		params.setProxyPort((getValue("httpProxyPort")!=null) ? Integer.valueOf(getValue("httpProxyPort")) : null);
+		params.setProxyUsername(getValue("httpProxyUsername"));
+		params.setProxyPassword(getValue("httpProxyPassword"));
+		
 		return (Parameters) params;
 	}
 
@@ -116,6 +121,26 @@ public void addOptions() {
 		option.setRequired(false);
 		option.setArgName("true");
 		cliOptions.addInternalOption(option);
+		
+		option = new Option("httpProxyHost", true, "Name of the proxy host");
+		option.setRequired(false);
+		option.setArgName("true");
+		cliOptions.addInternalOption(option);
+		
+		option = new Option("httpProxyPort", true, "The proxy port");
+		option.setRequired(false);
+		option.setArgName("true");
+		cliOptions.addInternalOption(option);
+		
+		option = new Option("httpProxyUsername", true, "The proxy username");
+		option.setRequired(false);
+		option.setArgName("true");
+		cliOptions.addInternalOption(option);
+		
+		option = new Option("httpProxyPassword", true, "The proxy username");
+		option.setRequired(false);
+		option.setArgName("true");
+		cliOptions.addInternalOption(option);
 	}
 
 	@Override

modules/apim-adapter/src/main/java/com/axway/apim/lib/CoreParameters.java

@@ -90,6 +90,14 @@ public static Mode valueOfDefault(String key) {
 
 	private String apimCLIHome;
 
+	private String proxyHost;
+	
+	private Integer proxyPort;
+	
+	private String proxyUsername;
+	
+	private String proxyPassword;
+	
 	public CoreParameters() {
 		super();
 		CoreParameters.instance = this;
@@ -358,6 +366,39 @@ public void setApimCLIHome(String apimCLIHome) {
 		this.apimCLIHome = apimCLIHome;
 	}
 
+	public String getProxyHost() {
+		return proxyHost;
+	}
+
+	public void setProxyHost(String proxyHost) {
+		this.proxyHost = proxyHost;
+	}
+
+	public Integer getProxyPort() {
+		if(proxyPort == null) return -1;
+		return proxyPort;
+	}
+
+	public void setProxyPort(Integer proxyPort) {
+		this.proxyPort = proxyPort;
+	}
+
+	public String getProxyUsername() {
+		return proxyUsername;
+	}
+
+	public void setProxyUsername(String proxyUsername) {
+		this.proxyUsername = proxyUsername;
+	}
+
+	public String getProxyPassword() {
+		return proxyPassword;
+	}
+
+	public void setProxyPassword(String proxyPassword) {
+		this.proxyPassword = proxyPassword;
+	}
+
 	public List<CacheType> clearCaches() {
 		if(getClearCache()==null) return null;
 		if(cachesToClear!=null) return cachesToClear;

modules/apim-adapter/src/main/java/com/axway/apim/lib/utils/rest/APIMHttpClient.java

@@ -5,20 +5,26 @@
 import java.util.Map;
 
 import org.apache.http.HttpHost;
+import org.apache.http.auth.AuthScope;
+import org.apache.http.auth.UsernamePasswordCredentials;
+import org.apache.http.client.CredentialsProvider;
 import org.apache.http.client.HttpClient;
 import org.apache.http.client.config.CookieSpecs;
 import org.apache.http.client.config.RequestConfig;
 import org.apache.http.client.protocol.HttpClientContext;
 import org.apache.http.config.Registry;
 import org.apache.http.config.RegistryBuilder;
 import org.apache.http.conn.routing.HttpRoute;
+import org.apache.http.conn.routing.HttpRoutePlanner;
 import org.apache.http.conn.socket.ConnectionSocketFactory;
 import org.apache.http.conn.socket.PlainConnectionSocketFactory;
 import org.apache.http.conn.ssl.NoopHostnameVerifier;
 import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
 import org.apache.http.conn.ssl.TrustAllStrategy;
 import org.apache.http.impl.client.BasicCookieStore;
+import org.apache.http.impl.client.BasicCredentialsProvider;
 import org.apache.http.impl.client.HttpClientBuilder;
+import org.apache.http.impl.conn.DefaultProxyRoutePlanner;
 import org.apache.http.impl.conn.PoolingHttpClientConnectionManager;
 import org.apache.http.ssl.SSLContextBuilder;
 
@@ -104,13 +110,27 @@ private void createConnection(String apiManagerURL) throws AppException {
 			// We have make sure, that cookies are correclty parsed!
 			RequestConfig defaultRequestConfig = RequestConfig.custom()
 			        .setCookieSpec(CookieSpecs.STANDARD).build();
-			
-			this.httpClient = HttpClientBuilder.create()
+			CoreParameters params = CoreParameters.getInstance();
+
+			HttpClientBuilder clientBuilder = HttpClientBuilder.create()
 					.disableRedirectHandling()
 					.setConnectionManager(cm)
 					.useSystemProperties()
-					.setDefaultRequestConfig(defaultRequestConfig)
-					.build();
+					.setDefaultRequestConfig(defaultRequestConfig);
+			
+			// Check if a proxy is configured
+			if(params.getProxyHost()!=null) {
+				HttpHost proxyHost = new HttpHost(params.getProxyHost(), params.getProxyPort());
+				HttpRoutePlanner routePlanner = new DefaultProxyRoutePlanner(proxyHost);
+				clientBuilder.setRoutePlanner(routePlanner);
+				if(params.getProxyUsername()!=null) {
+					CredentialsProvider credentialsPovider = new BasicCredentialsProvider();
+					credentialsPovider.setCredentials(new AuthScope(params.getProxyHost(), params.getPort()), new UsernamePasswordCredentials(params.getProxyUsername(), params.getProxyPassword()));
+					clientBuilder.setDefaultCredentialsProvider(credentialsPovider);
+				}
+			}
+			
+			this.httpClient = clientBuilder.build();
 		} catch (Exception e) {
 			throw new AppException("Can't create connection to API-Manager.", ErrorCode.API_MANAGER_COMMUNICATION);
 		}