Merge pull request #159 from Axway-API-Management-Plus/158-export-original-backend-basepath

Chris Wiechmann · web-flow · commit cc7ab94b2969 · 2021-03-16T08:12:29.000+01:00
Export original backend basepath
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 - Retry request at API access endpoint also for return code 404 (See issue [#157](https://github.com/Axway-API-Management-Plus/apim-cli/issues/157))
+- If the useFEAPIDefinition flag is set, then the exported API specification is updated with the backend API information (host, basePath, schemes). (See issue [#158](https://github.com/Axway-API-Management-Plus/apim-cli/issues/158))
 
 ### Added
 - Exported API-Manager settings now include Null-Values for not set properties (See issue [#150](https://github.com/Axway-API-Management-Plus/apim-cli/issues/150))
diff --git a/misc/documentation/Images.pptx b/misc/documentation/Images.pptx
diff --git a/misc/images/Image-Sources.pptx b/misc/images/Image-Sources.pptx
diff --git a/misc/images/behavior-useFEAPIDefinition.png b/misc/images/behavior-useFEAPIDefinition.png
diff --git a/modules/apim-adapter/src/main/java/com/axway/apim/adapter/apis/APIManagerAPIAdapter.java b/modules/apim-adapter/src/main/java/com/axway/apim/adapter/apis/APIManagerAPIAdapter.java
@@ -485,7 +485,7 @@ private void addClientApplications(API api, APIFilter filter) throws AppExceptio
 		}		
 	}
 	
-	private static void addOriginalAPIDefinitionFromAPIM(API api, APIFilter filter) throws AppException {
+	private void addOriginalAPIDefinitionFromAPIM(API api, APIFilter filter) throws AppException {
 		if(!filter.isIncludeOriginalAPIDefinition()) return;
 		URI uri;
 		APISpecification apiDefinition;
@@ -507,6 +507,7 @@ private static void addOriginalAPIDefinitionFromAPIM(API api, APIFilter filter)
 				origFilename = httpResponse.getHeaders("Content-Disposition")[0].getValue();
 			}
 			apiDefinition = APISpecificationFactory.getAPISpecification(res.getBytes(StandardCharsets.UTF_8), origFilename.substring(origFilename.indexOf("filename=")+9), api.getName(), filter.isFailOnError());
+			addBackendResourcePath(api, apiDefinition, filter.isUseFEAPIDefinition());
 			api.setApiDefinition(apiDefinition);
 		} catch (Exception e) {
 			throw new AppException("Cannot parse API-Definition for API: '" + api.getName() + "' ("+api.getVersion()+") on path: '"+api.getPath()+"'", ErrorCode.CANT_READ_API_DEFINITION_FILE, e);
@@ -518,6 +519,53 @@ private static void addOriginalAPIDefinitionFromAPIM(API api, APIFilter filter)
 		}
 	}
 	
+	private void addBackendResourcePath(API api, APISpecification apiDefinition, boolean exportFEAPIDefinition) throws AppException {
+		URI uri;
+		HttpResponse httpResponse = null;
+		try {
+			uri = new URIBuilder(cmd.getAPIManagerURL()).setPath(cmd.getApiBasepath() + "/apirepo/"+api.getApiId()).build();
+			RestAPICall request = new GETRequest(uri, APIManagerAdapter.hasAdminAccount());
+			httpResponse=request.execute();
+			int statusCode = httpResponse.getStatusLine().getStatusCode();
+			String response = EntityUtils.toString(httpResponse.getEntity());
+			if(statusCode != 200){
+				if((statusCode >= 400 && statusCode<=499) && response.contains("Unknown API")) {
+					LOG.warn("Got unexpected error: 'Unknown API' while trying to read Backend-API ... Try again in 1 second.");
+					Thread.sleep(1000);
+					httpResponse = request.execute();
+					statusCode = httpResponse.getStatusLine().getStatusCode();
+					if(statusCode != 200) {
+						LOG.error("Error reading backend API in order to update API-Specification. Received Status-Code: " +statusCode + ", Response: " + EntityUtils.toString(httpResponse.getEntity()));
+						throw new AppException("Error reading backend API in order to update API-Specification. Received Status-Code: " +statusCode, ErrorCode.CANT_CREATE_BE_API);
+					} else {
+						LOG.info("Successfully retrieved backend API information on second request.");
+						response = EntityUtils.toString(httpResponse.getEntity());
+					}
+				} else {
+					LOG.error("Error reading backend API in order to update API-Specification. Received Status-Code: " +statusCode+ ", Response: '" + response + "'");
+					throw new AppException("Error reading backend API in order to update API-Specification. ", ErrorCode.UNXPECTED_ERROR);
+				}
+			}
+			JsonNode jsonNode = mapper.readTree(response);
+			String resourcePath = jsonNode.get("resourcePath").asText();
+			String basePath = jsonNode.get("basePath").asText();
+			// Only adjust the API-Specification when exporting the FE-API-Spec otherwise we need the originally imported API-Spec
+			if(exportFEAPIDefinition) {
+				apiDefinition.configureBasepath(basePath + resourcePath);
+			}
+			// In any case, we save the backend resource path, as it is necessary for the full backendBasepath in the exported API config. 
+			api.setBackendResourcePath(resourcePath);
+			return;
+		} catch (Exception e) {
+			throw new AppException("Cannot parse Backend-API for API: '" + api.toStringHuman()+"' in order to change API-Specification", ErrorCode.CANT_READ_API_DEFINITION_FILE, e);
+		} finally {
+			try {
+				if(httpResponse!=null) 
+					((CloseableHttpResponse)httpResponse).close();
+			} catch (Exception ignore) {}
+		}
+	}
+	
 	public API createAPIProxy(API api) throws AppException {
 		LOG.debug("Create Front-End API: '"+api.getName()+"' (API-Proxy)");
 		URI uri;
diff --git a/modules/apim-adapter/src/main/java/com/axway/apim/api/API.java b/modules/apim-adapter/src/main/java/com/axway/apim/api/API.java
@@ -168,6 +168,9 @@ public class API implements CustomPropertiesEntity {
 	protected String apiId = null;
 	
 	protected String deprecated = null;
+	
+	@JsonIgnore
+	protected String resourcePath = null;
 
 	@APIPropertyAnnotation(isBreaking = false, copyProp = false, 
 			writableStates = {API.STATE_UNPUBLISHED, API.STATE_PUBLISHED, API.STATE_DEPRECATED})
@@ -502,6 +505,20 @@ public RemoteHost getRemotehost() {
 	public void setRemotehost(RemoteHost remotehost) {
 		this.remoteHost = remotehost;
 	}
+	
+	/**
+	 * @return path of the resource registered for the belonging backend API or null if not set
+	 */
+	public String getResourcePath() {
+		return resourcePath;
+	}
+
+	/**
+	 * @param resourcePath is the path of the resource registered for the belonging backend API
+	 */
+	public void setBackendResourcePath(String resourcePath) {
+		this.resourcePath = resourcePath;
+	}
 
 	/**
 	 * requestForAllOrgs is used to decide if an API should grant access to ALL organizations. 
diff --git a/modules/apim-adapter/src/main/java/com/axway/apim/api/definition/Swagger2xSpecification.java b/modules/apim-adapter/src/main/java/com/axway/apim/api/definition/Swagger2xSpecification.java
@@ -48,12 +48,12 @@ public void configureBasepath(String backendBasepath) throws AppException {
 				
 				
 				if(swagger.get("host")==null) {
-					LOG.debug("Adding new host '"+url.getHost()+port+"' to Swagger-File based on configured backendBasepath: '"+backendBasepath+"'");
+					LOG.debug("Adding new host '"+url.getHost()+port+"' to Swagger-File based on backendBasepath: '"+backendBasepath+"'");
 					backendBasepathAdjusted = true;
 					((ObjectNode)swagger).put("host", url.getHost()+port);
 				} else {
 					if(swagger.get("host").asText().equals(url.getHost()+port)) {
-						LOG.debug("Swagger Host: '"+swagger.get("host").asText()+"' already matches configured backendBasepath: '"+backendBasepath+"'. Nothing to do.");
+						LOG.debug("Swagger Host: '"+swagger.get("host").asText()+"' already matches backendBasepath: '"+backendBasepath+"'. Nothing to do.");
 					} else {
 						LOG.debug("Replacing existing host: '"+swagger.get("host").asText()+"' in Swagger-File to '"+url.getHost()+port+"' based on configured backendBasepath: '"+backendBasepath+"'");
 						backendBasepathAdjusted = true;
@@ -62,12 +62,12 @@ public void configureBasepath(String backendBasepath) throws AppException {
 				}
 				if(url.getPath()!=null && !url.getPath().equals("")) {
 					if(swagger.get("basePath")!=null && swagger.get("basePath").asText().equals(url.getPath())) {
-						LOG.debug("Swagger basePath: '"+swagger.get("basePath").asText()+"' already matches configured backendBasepath: '"+url.getPath()+"'. Nothing to do.");
+						LOG.debug("Swagger basePath: '"+swagger.get("basePath").asText()+"' already matches backendBasepath: '"+url.getPath()+"'. Nothing to do.");
 					} else {
 						if(swagger.get("basePath")!=null) {
 							LOG.debug("Replacing existing basePath: '"+swagger.get("basePath").asText()+"' in Swagger-File to '"+url.getPath()+"' based on configured backendBasepath: '"+backendBasepath+"'");
 						} else {
-							LOG.debug("Setup basePath in Swagger-File to '"+url.getPath()+"' based on configured backendBasepath: '"+backendBasepath+"'");
+							LOG.debug("Setup basePath in Swagger-File to '"+url.getPath()+"' based on backendBasepath: '"+backendBasepath+"'");
 						}
 						backendBasepathAdjusted = true;
 						((ObjectNode)swagger).put("basePath", url.getPath());
@@ -81,13 +81,13 @@ public void configureBasepath(String backendBasepath) throws AppException {
 					((ObjectNode)swagger).set("schemes", newSchemes);
 				} else {
 					if(swagger.get("schemes").size()!=1 || !swagger.get("schemes").get(0).asText().equals(url.getProtocol())) {
-						LOG.debug("Replacing existing protocol(s): '"+swagger.get("schemes")+"' with '"+url.getProtocol()+"' according to configured backendBasePath: '"+backendBasepath+"'.");
+						LOG.debug("Replacing existing protocol(s): '"+swagger.get("schemes")+"' with '"+url.getProtocol()+"' according to backendBasePath: '"+backendBasepath+"'.");
 						backendBasepathAdjusted = true;
 						((ObjectNode)swagger).replace("schemes", newSchemes);
 					}
 				}
 				if(backendBasepathAdjusted) {
-					LOG.info("Used the configured backendBasepath: '"+backendBasepath+"' to adjust the Swagger definition.");
+					LOG.info("Used the backendBasepath: '"+backendBasepath+"' to adjust the API-Specification.");
 				}
 				this.apiSpecificationContent = this.mapper.writeValueAsBytes(swagger);
 			}
diff --git a/modules/apis/src/main/java/com/axway/apim/api/export/ExportAPI.java b/modules/apis/src/main/java/com/axway/apim/api/export/ExportAPI.java
@@ -311,6 +311,18 @@ public String getApiDefinitionImport() {
 	
 
 	public String getBackendBasepath() {
-		return this.getServiceProfiles().get("_default").getBasePath();
+		if(this.actualAPIProxy.getResourcePath()!=null) {
+			// The API Manager composes the actual backend path from the host + path and backend resource path 
+			// specified in the frontend. 
+			// So if the backend was imported with the resourcepath /v2 and the backend is configured with 
+			// https://my.backend.host.com/another/path, the following backend results: https://my.backend.host.com/another/path/v2. 
+			// So, in order for the exported backendBasepath to exactly match the configured backend, it must be 
+			// composed of both properties.
+			// See issue: https://github.com/Axway-API-Management-Plus/apim-cli/issues/158
+			// https://github.com/Axway-API-Management-Plus/apim-cli/blob/develop/misc/images/behavior-useFEAPIDefinition.png
+			return this.getServiceProfiles().get("_default").getBasePath() + this.actualAPIProxy.getResourcePath();
+		} else {
+			return this.getServiceProfiles().get("_default").getBasePath();	
+		}
 	}
 }
diff --git a/modules/apis/src/main/java/com/axway/apim/api/export/impl/JsonAPIExporter.java b/modules/apis/src/main/java/com/axway/apim/api/export/impl/JsonAPIExporter.java
@@ -122,7 +122,7 @@ private void saveAPILocally(ExportAPI exportAPI) throws AppException {
 		if(exportAPI.getCaCerts()!=null && !exportAPI.getCaCerts().isEmpty()) {
 			storeCaCerts(localFolder, exportAPI.getCaCerts());
 		}
-		LOG.info("Successfully exported API into folder: " + localFolder);
+		LOG.info("Successfully exported API into folder: " + localFolder.getAbsolutePath());
 		if(!APIManagerAdapter.hasAdminAccount()) {
 			LOG.warn("Export has been done with an Org-Admin account only. Export is restricted by the following: ");
 			LOG.warn("- No Quotas has been exported for the API");
diff --git a/modules/apis/src/main/java/com/axway/apim/api/export/lib/cli/CLIAPIExportOptions.java b/modules/apis/src/main/java/com/axway/apim/api/export/lib/cli/CLIAPIExportOptions.java
@@ -33,7 +33,8 @@ public Parameters getParams() {
 
 	@Override
 	public void addOptions() {
-		Option option = new Option("useFEAPIDefinition", "If this flag is set, the export API contains the API-Definition (e.g. Swagger) from the FE-API instead of the original imported API.");
+		Option option = new Option("useFEAPIDefinition", "If this flag is set, the exported API contains the API-Specification (e.g. Swagger-File) "
+				+ "from the FE-API instead of the original imported API. But the specification contains the host, basePath and scheme from the backend.");
 		option.setRequired(false);
 		addOption(option);
 	}
diff --git a/modules/apis/src/test/java/com/axway/apim/export/test/ExportTestAction.java b/modules/apis/src/test/java/com/axway/apim/export/test/ExportTestAction.java
@@ -19,6 +19,7 @@ public void doExecute(TestContext context) {
 		
 		boolean useEnvironmentOnly	= false;
 		boolean ignoreAdminAccount	= false;
+		boolean useFEAPIDefinition	= false;
 		String stage				= null;
 		String vhostToExport		= null;
 		
@@ -38,6 +39,9 @@ public void doExecute(TestContext context) {
 		try {
 			ignoreAdminAccount = Boolean.parseBoolean(context.getVariable("ignoreAdminAccount"));
 		} catch (Exception ignore) {};
+		try {
+			useFEAPIDefinition = Boolean.parseBoolean(context.getVariable("useFEAPIDefinition"));
+		} catch (Exception ignore) {};
 		
 		try {
 			vhostToExport = context.getVariable("vhostToExport");
@@ -79,6 +83,9 @@ public void doExecute(TestContext context) {
 			if(ignoreAdminAccount) {
 				args.add("-ignoreAdminAccount");
 			}
+			if(useFEAPIDefinition) {
+				args.add("-useFEAPIDefinition");
+			}
 		}
 		int rc = APIExportApp.exportAPI(args.toArray(new String[args.size()]));
 		if(expectedReturnCode!=rc) {
diff --git a/modules/apis/src/test/java/com/axway/apim/export/test/basic/SimpleAPIExportTestIT.java b/modules/apis/src/test/java/com/axway/apim/export/test/basic/SimpleAPIExportTestIT.java
@@ -7,6 +7,7 @@
 import java.io.FileInputStream;
 import java.io.IOException;
 
+import org.springframework.http.HttpStatus;
 import org.testng.annotations.Optional;
 import org.testng.annotations.Parameters;
 import org.testng.annotations.Test;
@@ -18,8 +19,10 @@
 import com.consol.citrus.context.TestContext;
 import com.consol.citrus.dsl.testng.TestNGCitrusTestRunner;
 import com.consol.citrus.functions.core.RandomNumberFunction;
+import com.consol.citrus.message.MessageType;
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.ObjectNode;
 
 @Test
 public class SimpleAPIExportTestIT extends TestNGCitrusTestRunner {
@@ -52,9 +55,30 @@ public void run(@Optional @CitrusResource TestContext context) throws IOExceptio
 		createVariable(ImportTestAction.API_CONFIG,  "/test/export/files/basic/minimal-config.json");
 		createVariable("expectedReturnCode", "0");
 		swaggerImport.doExecute(context);
+		
+		echo("####### Validate the API has been imported #######");
+		http(builder -> builder.client("apiManager").send().get("/proxies").header("Content-Type", "application/json"));
+
+		http(builder -> builder.client("apiManager").receive().response(HttpStatus.OK).messageType(MessageType.JSON)
+			.validate("$.[?(@.path=='${apiPath}')].name", "${apiName}")
+			.validate("$.[?(@.path=='${apiPath}')].state", "unpublished")
+			.extractFromPayload("$.[?(@.path=='${apiPath}')].id", "apiId"));
+		
+		echo("####### Manually configure the backend to https://yet.another.petstore/another/path --> https://yet.another.petstore/another/path/v2 #######");
+		// Get the API-Proxy object
+		http(builder -> builder.client("apiManager").send().get("/proxies/${apiId}").header("Content-Type", "application/json"));
+		http(builder -> builder.client("apiManager").receive().response(HttpStatus.OK).messageType(MessageType.JSON).extractFromPayload("$", "apiProxy"));
+		// Manually set another backend host and path
+		JsonNode config = mapper.readTree(context.getVariable("apiProxy"));
+		((ObjectNode) config.get("serviceProfiles").get("_default")).put("basePath", "https://yet.another.petstore/another/path");
+		variable("updatedAPIProxy", mapper.writeValueAsString(config));
+		// Update the API-Proxy
+		http(builder -> builder.client("apiManager").send().put("/proxies/${apiId}").header("Content-Type", "application/json")
+				.payload("${updatedAPIProxy}"));
 
-		echo("####### Export the API from the API-Manager #######");
+		echo("####### Export the API from the API-Manager using useFEAPIDefinition #######");
 		createVariable("expectedReturnCode", "0");
+		createVariable("useFEAPIDefinition", "true"); // In this case we simulate to export the FE-API-Definition instead of the backend
 		swaggerExport.doExecute(context);
 		
 		String exportedAPIConfigFile = context.getVariable("exportLocation")+"/"+context.getVariable("exportFolder")+"/api-config.json";
@@ -64,10 +88,10 @@ public void run(@Optional @CitrusResource TestContext context) throws IOExceptio
 		
 		assertEquals(exportedAPIConfig.get("version").asText(), 			"2.0.0");
 		assertEquals(exportedAPIConfig.get("organization").asText(),		"API Development "+context.getVariable("orgNumber"));
-		//assertEquals(exportedAPIConfig.get("backendBasepath").asText(), 	"https://petstore.swagger.io");
 		assertEquals(exportedAPIConfig.get("state").asText(), 				"unpublished");
 		assertEquals(exportedAPIConfig.get("path").asText(), 				context.getVariable("apiPath"));
 		assertEquals(exportedAPIConfig.get("name").asText(), 				context.getVariable("apiName"));
+		assertEquals(exportedAPIConfig.get("backendBasepath").asText(), 	"https://yet.another.petstore/another/path/v2");
 		assertEquals(exportedAPIConfig.get("caCerts").size(), 				4);
 		
 		assertEquals(exportedAPIConfig.get("caCerts").get(0).get("certFile").asText(), 				"swagger.io.crt");
@@ -79,6 +103,15 @@ public void run(@Optional @CitrusResource TestContext context) throws IOExceptio
 		assertTrue(new File(context.getVariable("exportLocation")+"/"+context.getVariable("exportFolder")+"/AmazonRootCA1.crt").exists(), "Certificate AmazonRootCA1.crt is missing");
 		assertTrue(new File(context.getVariable("exportLocation")+"/"+context.getVariable("exportFolder")+"/Amazon.crt").exists(), "Certificate Amazon.crt is missing");
 		
-		assertTrue(new File(context.getVariable("exportLocation")+"/"+context.getVariable("exportFolder")+"/"+context.getVariable("exportAPIName")).exists(), "Exported Swagger-File is missing");
+		File exportedAPISpecFile = new File(context.getVariable("exportLocation")+"/"+context.getVariable("exportFolder")+"/"+context.getVariable("exportAPIName"));
+		assertTrue(exportedAPISpecFile.exists(), "Exported API-Specification is missing");
+		
+		// Read the export Swagger-File
+		JsonNode exportedAPISpec = mapper.readTree(new FileInputStream(exportedAPISpecFile));
+		// Check the original basePath is set (See issue https://github.com/Axway-API-Management-Plus/apim-cli/issues/158)
+		assertEquals(exportedAPISpec.get("basePath").asText(), 			"/v2");
+		assertEquals(exportedAPISpec.get("host").asText(), 				"petstore.swagger.io");
+		assertEquals(exportedAPISpec.get("schemes").get(0).asText(), 	"https");
+		
 	}
 }

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ private void saveAPILocally(ExportAPI exportAPI) throws AppException {`
`122`	`122`	`if(exportAPI.getCaCerts()!=null && !exportAPI.getCaCerts().isEmpty()) {`
`123`	`123`	`storeCaCerts(localFolder, exportAPI.getCaCerts());`
`124`	`124`	`}`
`125`		`- LOG.info("Successfully exported API into folder: " + localFolder);`
	`125`	`+ LOG.info("Successfully exported API into folder: " + localFolder.getAbsolutePath());`
`126`	`126`	`if(!APIManagerAdapter.hasAdminAccount()) {`
`127`	`127`	`LOG.warn("Export has been done with an Org-Admin account only. Export is restricted by the following: ");`
`128`	`128`	`LOG.warn("- No Quotas has been exported for the API");`
Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,8 @@ public Parameters getParams() {`
`33`	`33`
`34`	`34`	`@Override`
`35`	`35`	`public void addOptions() {`
`36`		`- Option option = new Option("useFEAPIDefinition", "If this flag is set, the export API contains the API-Definition (e.g. Swagger) from the FE-API instead of the original imported API.");`
	`36`	`+ Option option = new Option("useFEAPIDefinition", "If this flag is set, the exported API contains the API-Specification (e.g. Swagger-File) "`
	`37`	`+ + "from the FE-API instead of the original imported API. But the specification contains the host, basePath and scheme from the backend.");`
`37`	`38`	`option.setRequired(false);`
`38`	`39`	`addOption(option);`
`39`	`40`	`}`