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

Author: Chris Wiechmann

CHANGELOG.md

@@ -5,10 +5,19 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Fixed
+- Custom-Properties missing in API-Export (See issue [#13](https://github.com/Axway-API-Management-Plus/apim-cli/issues/13))
 
-## [0.0.9] 2020-04-08
+## [1.0.0] 2020-06-15
 ### Added
-- Initial version
-- Refactored Swagger-Promote to support modularized approach
-- Migrated API-Import & Export to a dedicated module
-- Added new module to manage applications
+- Initial version of the APIM-CLI
+- Swagger-Promote completely refactored
+- Migrated API-Import & Export to dedicated modules
+- New modules to manage applications (Import and Export)
+- Get APIs and Applications (Filtered, different formats)
+- Delete APIs (Front and Backend)
+- Publish APIs
+- Introduced API-Management programming interface
+
+### Fixed
+- Cannot set Oauth authentication Profile using its name (See issue [#2](https://github.com/Axway-API-Management-Plus/apim-cli/issues/2))

README.md

@@ -23,11 +23,24 @@ Available commands and options:
 apim app - Manage your applications
 apim api - Manage your APIs
 ```
-To get a list of commands for each group call for instance `apim app`:
+To get for instance a `wide` list of APIs on the stage: `prod` execute the following command:
+```
+apim api get -s prod -wide
+```
+```
+....
++--------------------------------------+-----------------+----------------+---------+---------------------+-------------+-------------+----------+----------------------+
+| API-Id                               | Path            | Name           | Version | V-Host              | State       | Security    | Policies | Organization         |
++--------------------------------------+-----------------+----------------+---------+---------------------+-------------+-------------+----------+----------------------+
+| 518b15c9-350c-47d8-9ad6-16ce02ef9dfe | /vhost-test-950 | VHost Test 950 |   1.0.0 | api123.customer.com | unpublished | passThrough | None     | API Development 5538 |
+| 39b7b2aa-7df8-44e0-b399-4e9d59dbad6d | /vhost-test-411 | VHost Test 411 |   1.0.0 | api123.customer.com |   published | passThrough | None     | API Development 5916 |
++--------------------------------------+-----------------+----------------+---------+---------------------+-------------+-------------+----------+----------------------+
+......
+```
 
-For an up-to-date list of the supported groups and commands, see the [documentation](https://github.com/Axway-API-Management-Plus/apim-cli/wiki#supported-commands).
+To get a list of commands for each group call for instance `apim app`
 
-The CLI is flexible and more commands will be added. You can find a list of available commands in the .
+The CLI is flexible and more commands will be added. For an up-to-date list of the supported groups and commands, see the [documentation](https://github.com/Axway-API-Management-Plus/apim-cli/wiki#supported-commands).
 
 ## Quality assurance process
 By using this CLI to control your Axway API management infrastructure it becomes a key component of your CI/CD process. Product quality is therefore very important so that you can be confident this CLI is doing what it's supposed to do.  
@@ -38,11 +51,11 @@ The automated End-2-End test suite contains of __113__ different scenarios, whic
 
 | Version       | Branch               | Status | Comment | 
 | :---          | :---                 | :---:  | :--- |
-| 7.6.2 SP4     | develop  | [![Build Status](https://travis-ci.org/Axway-API-Management-Plus/apim-cli.svg?branch=develop)](https://travis-ci.org/Axway-API-Management-Plus/apim-cli/branches)||
-| 7.7.0 SP2     | test-with-7.7-SP2  | [![Build Status](https://travis-ci.org/Axway-API-Management-Plus/apim-cli.svg?branch=test-with-7.7-SP2)](https://travis-ci.org/Axway-API-Management-Plus/apim-cli/branches)||
-| 7.7-20200130    | test-with-7.7-20200130  | [![Build Status](https://travis-ci.org/Axway-API-Management-Plus/apim-cli.svg?branch=test-with-7.7-20200130)](https://travis-ci.org/Axway-API-Management-Plus/apim-cli/branches)|The release has been tested, but during automated testing, some of the quota tests are flaky.|
-| 7.7-20200331    | test-with-7.7-20200331  | [![Build Status](https://travis-ci.org/Axway-API-Management-Plus/apim-cli.svg?branch=test-with-7.7-20200331)](https://travis-ci.org/Axway-API-Management-Plus/apim-cli/branches)|The release has been tested, but during automated testing, some of the quota tests are flaky.|
-| 7.7-2020053ß    | test-with-7.7-20200530  | [![Build Status](https://travis-ci.org/Axway-API-Management-Plus/apim-cli.svg?branch=test-with-7.7-20200530)](https://travis-ci.org/Axway-API-Management-Plus/apim-cli/branches)|The release has been tested, but during automated testing, some of the quota tests are flaky.|
+| 7.6.2 SP4     | develop  | [![Build Status](https://img.shields.io/travis/Axway-API-Management-Plus/apim-cli/develop)](https://travis-ci.org/Axway-API-Management-Plus/apim-cli/branches)||
+| 7.7.0 SP2     | test-with-7.7-SP2  | [![Build Status](https://img.shields.io/travis/Axway-API-Management-Plus/apim-cli/test-with-7.7-SP2)](https://travis-ci.org/Axway-API-Management-Plus/apim-cli/branches)||
+| 7.7-20200130    | test-with-7.7-20200130  | [![Build Status](https://img.shields.io/travis/Axway-API-Management-Plus/apim-cli/test-with-7.7-20200130)](https://travis-ci.org/Axway-API-Management-Plus/apim-cli/branches)||
+| 7.7-20200331    | test-with-7.7-20200331  | [![Build Status](https://img.shields.io/travis/Axway-API-Management-Plus/apim-cli/test-with-7.7-20200331)](https://travis-ci.org/Axway-API-Management-Plus/apim-cli/branches)||
+| 7.7-20200530    | test-with-7.7-20200530  | [![Build Status](https://img.shields.io/travis/Axway-API-Management-Plus/apim-cli/test-with-7.7-20200530)](https://travis-ci.org/Axway-API-Management-Plus/apim-cli/branches)||
 
 Version 7.5.3 is NOT supported. Version 7.6.2 SP3 is required.  
 

distribution/pom.xml

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

modules/api-export/pom.xml

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

modules/api-export/src/main/java/com/axway/apim/api/export/impl/APIResultHandler.java

@@ -7,11 +7,13 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import com.axway.apim.adapter.APIManagerAdapter;
+import com.axway.apim.adapter.APIManagerAdapter.CUSTOM_PROP_TYPE;
 import com.axway.apim.adapter.apis.APIFilter;
 import com.axway.apim.adapter.apis.APIFilter.Builder;
+import com.axway.apim.adapter.apis.APIFilter.Builder.APIType;
 import com.axway.apim.adapter.apis.APIFilter.METHOD_TRANSLATION;
 import com.axway.apim.adapter.apis.APIFilter.POLICY_TRANSLATION;
-import com.axway.apim.adapter.apis.APIFilter.Builder.APIType;
 import com.axway.apim.api.API;
 import com.axway.apim.api.export.lib.APIExportParams;
 import com.axway.apim.lib.errorHandling.AppException;
@@ -75,6 +77,7 @@ protected Builder getBaseAPIFilterBuilder() {
 				.hasId(params.getValue("id"))
 				.hasName(params.getValue("name"))
 				.hasState(params.getValue("state"))
+				.includeCustomProperties(APIManagerAdapter.getAllConfiguredCustomProperties(CUSTOM_PROP_TYPE.api))
 				.translateMethods(METHOD_TRANSLATION.AS_NAME)
 				.translatePolicies(POLICY_TRANSLATION.TO_NAME);
 		return builder;

modules/api-export/src/main/java/com/axway/apim/api/export/impl/ConsoleAPIExporter.java

@@ -78,7 +78,7 @@ private void printUltra(List<API> apis) {
 				new Column().header("Policies").dataAlign(HorizontalAlign.LEFT).maxColumnWidth(30).with(api -> getUsedPolicies(api)),
 				new Column().header("Organization").dataAlign(HorizontalAlign.LEFT).with(api -> api.getOrganization().getName()),
 				new Column().header("Orgs").with(api -> getOrgCount(api)),
-				new Column().header("Apps").with(api -> Integer.toString(api.getApplications().size())),
+				new Column().header("Apps").with(api -> getAppCount(api)),
 				new Column().header("Quotas").with(api -> Boolean.toString(hasQuota(api))),
 				new Column().header("Tags").dataAlign(HorizontalAlign.LEFT).maxColumnWidth(30).with(api -> getTags(api))
 				)));
@@ -138,13 +138,19 @@ private String getTags(API api) {
 
 	private String getOrgCount(API api) {
 		try {
+			if(api.getClientOrganizations()==null) return "N/A";
 			return Integer.toString(api.getClientOrganizations().size());
 		} catch (AppException e) {
 			LOG.error("Error getting API client organization");
 			return "Err";
 		}
 	}
 
+	private String getAppCount(API api) {
+		if(api.getApplications()==null) return "N/A";
+		return Integer.toString(api.getApplications().size());
+	}
+	
 	private String getUsedPolicies(API api) {
 		List<String> policies = new ArrayList<String>();
 		Iterator<OutboundProfile> it;

modules/api-export/src/test/java/com/axway/apim/export/test/basic/CompleteAPIExportTestIT.java

@@ -8,6 +8,7 @@
 import java.io.FileNotFoundException;
 import java.io.IOException;
 import java.util.List;
+import java.util.Map;
 
 import org.testng.annotations.Optional;
 import org.testng.annotations.Parameters;
@@ -127,6 +128,10 @@ private void exportAPI(TestContext context, boolean ignoreAdminAccount) throws F
 			APIQuota exportedSystemQuota = mapper.convertValue(exportedAPIConfig.get("systemQuota"), new TypeReference<APIQuota>(){});
 			assertEquals(importedSystemQuota, exportedSystemQuota, "systemQuota are not equal.");
 		}
+		
+		Map<String, String> importedCustomProperties = mapper.convertValue(importedAPIConfig.get("customProperties"), new TypeReference<Map<String, String>>(){});
+		Map<String, String> exportedCustomProperties = mapper.convertValue(exportedAPIConfig.get("customProperties"), new TypeReference<Map<String, String>>(){});
+		assertEquals(importedCustomProperties, exportedCustomProperties, "CustomProperties are not equal.");
 
 		assertEquals(exportedAPIConfig.get("caCerts").size(), 				4);
 

modules/api-export/src/test/java/com/axway/apim/export/test/impl/ConsoleAPIExportTest.java

@@ -0,0 +1,61 @@
+package com.axway.apim.export.test.impl;
+
+import java.io.IOException;
+import java.util.List;
+
+import org.apache.commons.cli.ParseException;
+import org.testng.annotations.BeforeClass;
+import org.testng.annotations.Test;
+
+import com.axway.apim.adapter.apis.APIManagerMockBase;
+import com.axway.apim.api.API;
+import com.axway.apim.api.export.impl.ConsoleAPIExporter;
+import com.axway.apim.api.export.lib.APIExportGetCLIOptions;
+import com.axway.apim.api.export.lib.APIExportParams;
+import com.axway.apim.lib.errorHandling.AppException;
+import com.fasterxml.jackson.core.JsonParseException;
+import com.fasterxml.jackson.core.type.TypeReference;
+import com.fasterxml.jackson.databind.JsonMappingException;
+import com.fasterxml.jackson.databind.MapperFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+
+public class ConsoleAPIExportTest extends APIManagerMockBase {
+	
+	private static final String TEST_PACKAGE = "test/export/files/apiLists/";
+	
+	ObjectMapper mapper = new ObjectMapper();
+	
+	
+	@BeforeClass
+	public void setTest() throws AppException, IOException {
+		setupMockData();
+		mapper.disable(MapperFeature.USE_ANNOTATIONS);
+	}
+	
+	@Test
+	public void runStandardConsoleAPIExport() throws JsonParseException, JsonMappingException, IOException, AppException, ParseException  {
+		List<API> apis = mapper.readValue(this.getClass().getClassLoader().getResourceAsStream(TEST_PACKAGE + "three-apis-no-clientOrgs-and-clientApps.json"), new TypeReference<List<API>>(){});
+		
+		APIExportParams cmdParams = new APIExportParams(new APIExportGetCLIOptions(new String[] {}));
+		ConsoleAPIExporter consoleExp = new ConsoleAPIExporter(cmdParams);
+		consoleExp.execute(apis);
+	}
+	
+	@Test
+	public void runWideConsoleAPIExport() throws JsonParseException, JsonMappingException, IOException, AppException, ParseException  {
+		List<API> apis = mapper.readValue(this.getClass().getClassLoader().getResourceAsStream(TEST_PACKAGE + "three-apis-no-clientOrgs-and-clientApps.json"), new TypeReference<List<API>>(){});
+		
+		APIExportParams cmdParams = new APIExportParams(new APIExportGetCLIOptions(new String[] {"-wide"}));
+		ConsoleAPIExporter consoleExp = new ConsoleAPIExporter(cmdParams);
+		consoleExp.execute(apis);
+	}
+	
+	@Test
+	public void runUltraConsoleAPIExport() throws JsonParseException, JsonMappingException, IOException, AppException, ParseException  {
+		List<API> apis = mapper.readValue(this.getClass().getClassLoader().getResourceAsStream(TEST_PACKAGE + "three-apis-no-clientOrgs-and-clientApps.json"), new TypeReference<List<API>>(){});
+		
+		APIExportParams cmdParams = new APIExportParams(new APIExportGetCLIOptions(new String[] {"-ultra"}));
+		ConsoleAPIExporter consoleExp = new ConsoleAPIExporter(cmdParams);
+		consoleExp.execute(apis);
+	}
+}