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

Author: Chris Wiechmann

CHANGELOG.md

@@ -6,7 +6,27 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 ### Added
+- Search for APIs based on configured tags (See issue [#82](https://github.com/Axway-API-Management-Plus/apim-cli/issues/82))
+- Error handling improved if custom properties configuration is invalid (Switch or Select without configured options)
+- Added support to import application scopes (See PR [#77](https://github.com/Axway-API-Management-Plus/apim-cli/pull/77))
+- Leverage "com.axway.apimanager.api.model.disable.confidential.fields" option (See PR [#71](https://github.com/Axway-API-Management-Plus/apim-cli/pull/71))
+
+### Fixed
+- Changing an APIs fails due to a ClassCastException (See issue [#85](https://github.com/Axway-API-Management-Plus/apim-cli/issues/85))
+- NullPointerException when retrieving APIs on console with mode ultra (See issue [#80](https://github.com/Axway-API-Management-Plus/apim-cli/issues/80))
+- Quota- and Tag-Information always shown as false in console view, even if configured for an API (See issue [#81](https://github.com/Axway-API-Management-Plus/apim-cli/issues/81))
+- Handling of ExtClient configuration fixed when importing applications (See PR [#78](https://github.com/Axway-API-Management-Plus/apim-cli/pull/78))
+- Error when updating an organization (See issue [#73](https://github.com/Axway-API-Management-Plus/apim-cli/issues/73))
+- NPE when updating backendBasepath in a Swagger not having a host configured (See issue [#72](https://github.com/Axway-API-Management-Plus/apim-cli/issues/72))
+
+### Changed
+- Internal parameter handling refactore to make it easier to integrate the CLI into other Java-Programs (See PR [#83](https://github.com/Axway-API-Management-Plus/apim-cli/pull/83))
+
+## [1.2.2] 2020-09-09
+### Added
 - Added new CSV-Export for applications (See issue [#70](https://github.com/Axway-API-Management-Plus/apim-cli/issues/70))
+- Toggle ignoreCache added to the usage (See issue [#52](https://github.com/Axway-API-Management-Plus/apim-cli/issues/52))
+- Added new forceUpdate flag to force re-creation (See issue [#56](https://github.com/Axway-API-Management-Plus/apim-cli/issues/56))
 
 ### Fixed
 - apim.sh now starts the CLI in the current directory (See issue [#60](https://github.com/Axway-API-Management-Plus/apim-cli/issues/60))
@@ -20,8 +40,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - apim.sh & apim.bat script now support path with blanks. Thanks to [@cbrowet-axway](https://github.com/cbrowet-axway)  
 - Handling NPE for Application credential search (See issue [#57](https://github.com/Axway-API-Management-Plus/apim-cli/issues/57))
 - If FE-Security is a Custom-Policy, the name of the Custom-Policy is now exported (See issue [#61](https://github.com/Axway-API-Management-Plus/apim-cli/issues/61))
-- Toggle ignoreCache added to the usage (See issue [#52](https://github.com/Axway-API-Management-Plus/apim-cli/issues/52))
-- Added new forceUpdate flag to force re-creation (See issue [#56](https://github.com/Axway-API-Management-Plus/apim-cli/issues/56))
 
 ## [1.2.1] 2020-07-22
 ### Fixed

README.md

@@ -51,7 +51,7 @@ The automated End-2-End test suite contains of __116__ different scenarios, whic
 
 | Version       | Branch               | Status | Comment | 
 | :---          | :---                 | :---:  | :--- |
-| 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.6.2 SP5     | 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)||

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

@@ -47,7 +47,7 @@
 import com.axway.apim.api.model.Image;
 import com.axway.apim.api.model.User;
 import com.axway.apim.api.model.apps.ClientApplication;
-import com.axway.apim.lib.CommandParameters;
+import com.axway.apim.lib.CoreParameters;
 import com.axway.apim.lib.DoNothingCacheManager;
 import com.axway.apim.lib.errorHandling.AppException;
 import com.axway.apim.lib.errorHandling.ErrorCode;
@@ -103,7 +103,7 @@ public static enum CUSTOM_PROP_TYPE {
 		application
 	}
 
-	private CommandParameters cmd;
+	private CoreParameters cmd;
 
 	private static CacheManager cacheManager;
 
@@ -134,7 +134,7 @@ public static synchronized APIManagerAdapter getInstance() throws AppException {
 		if (APIManagerAdapter.instance == null) {
 			APIManagerAdapter.instance = new APIManagerAdapter();
 			if(!TestIndicator.getInstance().isTestRunning()) {
-				LOG.info("Successfully connected to API-Manager (" + getApiManagerVersion() + ") on: " + CommandParameters.getInstance().getAPIManagerURL());
+				LOG.info("Successfully connected to API-Manager (" + getApiManagerVersion() + ") on: " + CoreParameters.getInstance().getAPIManagerURL());
 			} else {
 				APIManagerAdapter.apiManagerVersion = "7.7.0";
 				LOG.info("Successfully connected to MOCKED API-Manager (" + getApiManagerVersion() + ")");
@@ -161,7 +161,7 @@ public static synchronized void deleteInstance() throws AppException {
 
 	private APIManagerAdapter() throws AppException {
 		super();
-		this.cmd = CommandParameters.getInstance();
+		this.cmd = CoreParameters.getInstance();
 		this.configAdapter = new APIManagerConfigAdapter();
 		this.apiAdapter = new APIManagerAPIAdapter();
 		this.methodAdapter = new APIManagerAPIMethodAdapter();
@@ -183,7 +183,7 @@ private APIManagerAdapter() throws AppException {
 
 	public void loginToAPIManager(boolean useAdminClient) throws AppException {
 		URI uri;
-		if(cmd.ignoreAdminAccount() && useAdminClient) return;
+		if(cmd.isIgnoreAdminAccount() && useAdminClient) return;
 		if(hasAdminAccount && useAdminClient) return; // Already logged in with an Admin-Account.
 		HttpResponse httpResponse = null;
 		try {
@@ -268,8 +268,8 @@ public void logoutFromAPIManager(boolean orgAdmin) throws AppException {
 	}
 
 	private String[] getAdminUsernamePassword() throws AppException {
-		if(CommandParameters.getInstance().getAdminUsername()==null) return null;
-		String[] usernamePassword =  {CommandParameters.getInstance().getAdminUsername(), CommandParameters.getInstance().getAdminPassword()};
+		if(CoreParameters.getInstance().getAdminUsername()==null) return null;
+		String[] usernamePassword =  {CoreParameters.getInstance().getAdminUsername(), CoreParameters.getInstance().getAdminPassword()};
 		return usernamePassword;
 	}
 
@@ -278,7 +278,7 @@ public static User getCurrentUser(boolean useAdminClient) throws AppException {
 		HttpResponse response = null;
 		JsonNode jsonResponse = null;
 		try {
-			uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION+"/currentuser").build();
+			uri = new URIBuilder(CoreParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION+"/currentuser").build();
 		    GETRequest currentUserRequest = new GETRequest(uri, useAdminClient);
 		    response = currentUserRequest.execute();
 		    getCsrfToken(response, useAdminClient); // Starting from 7.6.2 SP3 the CSRF token is returned on CurrentUser request
@@ -321,7 +321,7 @@ private static CacheManager getCacheManager() {
 				APIManagerAdapter.cacheManager.init();
 			return APIManagerAdapter.cacheManager;
 		}
-		if(CommandParameters.getInstance().ignoreCache()) {
+		if(CoreParameters.getInstance().isIgnoreCache()) {
 			APIManagerAdapter.cacheManager = new DoNothingCacheManager();
 		} else {
 			URL myUrl = APIManagerAdapter.class.getResource("/cacheConfig.xml");
@@ -335,7 +335,7 @@ private static CacheManager getCacheManager() {
 	public static <K, V> Cache<K, V> getCache(CacheType cacheType, Class<K> key, Class<V> value) {
 		getCacheManager();
 		Cache<K, V> cache = APIManagerAdapter.cacheManager.getCache(cacheType.name(), key, value);
-		if(CommandParameters.getInstance().clearCaches()!=null && CommandParameters.getInstance().clearCaches().contains(cacheType)) {
+		if(CoreParameters.getInstance().clearCaches()!=null && CoreParameters.getInstance().clearCaches().contains(cacheType)) {
 			cache.clear();
 			LOG.info("Cache: " + cacheType.name() + " successfully cleared.");
 		}
@@ -447,7 +447,7 @@ public ClientApplication getAppIdForCredential(String credential, String type) t
 			String response = null;
 			URI uri;
 			try {
-				uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/applications/"+app.getId()+"/"+type+"").build();
+				uri = new URIBuilder(CoreParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/applications/"+app.getId()+"/"+type+"").build();
 				LOG.debug("Loading credentials of type: '" + type + "' for application: '" + app.getName() + "' from API-Manager.");
 				RestAPICall getRequest = new GETRequest(uri, true);
 				httpResponse = getRequest.execute();
@@ -555,7 +555,7 @@ public static JsonNode getCustomPropertiesConfig() throws AppException {
 		URI uri;
 		HttpEntity httpResponse = null;
 		try {
-			uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath("/vordel/apiportal/app/app.config").build();
+			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");
@@ -604,7 +604,7 @@ public static JsonNode getCertInfo(InputStream certFile, CaCert cert) throws App
 		URI uri;
 		HttpResponse httpResponse = null;
 		try {
-			uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/certinfo/").build();
+			uri = new URIBuilder(CoreParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/certinfo/").build();
 
 			HttpEntity entity = MultipartEntityBuilder.create()
 					.addBinaryBody("file", IOUtils.toByteArray(certFile), ContentType.create("application/x-x509-ca-cert"), cert.getCertFile())
@@ -643,7 +643,7 @@ public static JsonNode getFileData(byte[] certificate, String filename) throws A
 		URI uri;
 		HttpResponse httpResponse = null;
 		try {
-			uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/filedata/").build();
+			uri = new URIBuilder(CoreParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/filedata/").build();
 
 			HttpEntity entity = MultipartEntityBuilder.create()
 					.addBinaryBody("file", certificate, ContentType.create("application/x-pkcs12"), filename)

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

@@ -8,7 +8,7 @@
 import org.slf4j.LoggerFactory;
 
 import com.axway.apim.api.API;
-import com.axway.apim.lib.CommandParameters;
+import com.axway.apim.lib.CoreParameters;
 import com.axway.apim.lib.errorHandling.AppException;
 import com.axway.apim.lib.errorHandling.ErrorCode;
 import com.axway.apim.lib.errorHandling.ErrorState;
@@ -68,7 +68,7 @@ public void update(API apiToUpdate, String desiredState) throws AppException {
 	}
 
 	public void update(API apiToUpdate, String desiredState, String vhost) throws AppException {
-		if(CommandParameters.getInstance().isForce()) {
+		if(CoreParameters.getInstance().isForce()) {
 			update(apiToUpdate, desiredState, vhost, true);
 		} else {
 			update(apiToUpdate, desiredState, vhost, false);

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

@@ -69,6 +69,8 @@ public static enum FILTER_OP {
 
 	private String policyName;
 
+	private String tag;
+	
 	private Map<String, String> customProperties;
 
 	private boolean deprecated;
@@ -169,6 +171,14 @@ public void setPolicyName(String policyName) {
 	public String getPolicyName() {
 		return policyName;
 	}
+	
+	public void setTag(String tag) {
+		this.tag = tag;
+	}
+
+	public String getTag() {
+		return tag;
+	}
 
 	public String getApiType() {
 		if(loadBackendAPI) {
@@ -424,7 +434,7 @@ public String toString() {
 
 
 	public boolean filter(API api) throws AppException {
-		if(this.getApiPath()==null && this.getVhost()==null && this.getQueryStringVersion()==null && this.getPolicyName()==null && this.getBackendBasepath()==null) { // Nothing given to filter out.
+		if(this.getApiPath()==null && this.getVhost()==null && this.getQueryStringVersion()==null && this.getPolicyName()==null && this.getBackendBasepath()==null && this.getTag()==null) { // Nothing given to filter out.
 			return true;
 		}
 		// Before 7.7, we have to filter out APIs manually!
@@ -482,7 +492,7 @@ public boolean filter(API api) throws AppException {
 			}
 			if(!requestedPolicyUsed) return false;
 		}
-		if(this.getBackendBasepath()!=null) {			
+		if(this.getBackendBasepath()!=null) {
 			Pattern pattern = Pattern.compile(this.getBackendBasepath().replace("*", ".*"));
 			Matcher matcher = pattern.matcher(api.getServiceProfiles().get("_default").getBasePath());
 			if(!matcher.matches()) {
@@ -493,6 +503,41 @@ public boolean filter(API api) throws AppException {
 			if(this.getVhost()!=null && !this.getVhost().equals(api.getVhost()))  return false;
 			if(this.getQueryStringVersion()!=null && !this.getQueryStringVersion().equals(api.getApiRoutingKey()))  return false;
 		}
+		if(this.getTag()!=null) {
+			// Simple filter format tag: "tagValue*"
+			String tagGroupFilter = this.getTag();
+			String tagValueFilter = this.getTag();
+			if(this.getTag().contains("=")) { // Group specific format: "tagGroup=tagValue*"
+				tagGroupFilter = this.getTag().split("=")[0];
+				tagValueFilter = this.getTag().split("=")[1];
+			} 
+			Pattern groupPattern = Pattern.compile(tagGroupFilter.toLowerCase().replace("*", ".*"));
+			Pattern valuePattern = Pattern.compile(tagValueFilter.toLowerCase().replace("*", ".*"));
+			Iterator<String> it = api.getTags().keySet().iterator();
+			boolean match = false;
+			while(it.hasNext()) {
+				String tagGroup = it.next();
+				Matcher matcher = groupPattern.matcher(tagGroup.toLowerCase());
+				if(!matcher.matches()) {
+					// Search for specific group - No match - Ignore this group
+					if(getTag().contains("=")) break;
+				} else {
+					// Filter match on the group
+					if(!getTag().contains("=")) match = true;
+				}
+				String[] tagValues = api.getTags().get(tagGroup);
+				for(String tagValue : tagValues) {
+					matcher = valuePattern.matcher(tagValue.toLowerCase());
+					if(matcher.matches()) {
+						match=true;
+						break;
+					}
+				}
+				if(match) break;
+			}
+			// If none of the tags match, filter out this API
+			if(!match) return false;
+		}
 		return true;
 	}
 
@@ -520,6 +565,7 @@ public static enum APIType {
 		String name;
 		String vhost;
 		String policyName;
+		String tag;
 		String apiPath;
 		String queryStringVersion;
 		String state;
@@ -587,6 +633,7 @@ public APIFilter build() {
 			apiFilter.setVhost(this.vhost);
 			apiFilter.setName(this.name);
 			apiFilter.setPolicyName(this.policyName);
+			apiFilter.setTag(this.tag);
 			apiFilter.setFilters(this.filters);
 			apiFilter.setId(this.id);
 			apiFilter.setApiId(apiId);
@@ -665,6 +712,11 @@ public Builder hasPolicyName(String policyName) {
 			return this;
 		}
 
+		public Builder hasTag(String tag) {
+			this.tag = tag;
+			return this;
+		}
+		
 		public Builder isDeprecated(boolean deprecated) {
 			this.deprecated = deprecated;
 			return this;

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

@@ -22,7 +22,7 @@
 import com.axway.apim.api.model.APIAccess;
 import com.axway.apim.api.model.Organization;
 import com.axway.apim.api.model.AbstractEntity;
-import com.axway.apim.lib.CommandParameters;
+import com.axway.apim.lib.CoreParameters;
 import com.axway.apim.lib.errorHandling.AppException;
 import com.axway.apim.lib.errorHandling.ErrorCode;
 import com.axway.apim.lib.utils.rest.DELRequest;
@@ -76,7 +76,7 @@ private void readAPIAccessFromAPIManager(Type type, String id) throws AppExcepti
 		URI uri;
 		HttpResponse httpResponse = null;
 		try {
-			uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/"+type+"/"+id+"/apis").build();
+			uri = new URIBuilder(CoreParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION + "/"+type+"/"+id+"/apis").build();
 			RestAPICall getRequest = new GETRequest(uri, APIManagerAdapter.hasAdminAccount());
 			httpResponse = getRequest.execute();
 			response = EntityUtils.toString(httpResponse.getEntity());
@@ -178,7 +178,7 @@ public APIAccess createAPIAccess(APIAccess apiAccess, AbstractEntity parentEntit
 		URI uri;
 		HttpResponse httpResponse = null;
 		try {
-			uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION+"/"+type+"/"+parentEntity.getId()+"/apis").build();
+			uri = new URIBuilder(CoreParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION+"/"+type+"/"+parentEntity.getId()+"/apis").build();
 			mapper.setSerializationInclusion(Include.NON_NULL);
 			FilterProvider filter = new SimpleFilterProvider().setDefaultFilter(
 					SimpleBeanPropertyFilter.serializeAllExcept(new String[] {"apiName"}));
@@ -233,7 +233,7 @@ public void deleteAPIAccess(APIAccess apiAccess, AbstractEntity parentEntity, Ty
 		URI uri;
 		HttpResponse httpResponse = null;
 		try {
-			uri = new URIBuilder(CommandParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION+"/"+type+"/"+parentEntity.getId()+"/apis/"+apiAccess.getId()).build();
+			uri = new URIBuilder(CoreParameters.getInstance().getAPIManagerURL()).setPath(RestAPICall.API_VERSION+"/"+type+"/"+parentEntity.getId()+"/apis/"+apiAccess.getId()).build();
 			// Use an admin account for this request
 			RestAPICall request = new DELRequest(uri, APIManagerAdapter.hasAdminAccount());
 			request.setContentType("application/json");