fix: change ehCache storage location (#3184)

* fix cache storage location and adding condition on cache controller creation

Signed-off-by: at670475 <[email protected]>

* change condition on cacheconfig

Signed-off-by: at670475 <[email protected]>

* fix license check

Signed-off-by: at670475 <[email protected]>

* make bean matchable by default

Signed-off-by: at670475 <[email protected]>

* fix code smell

Signed-off-by: at670475 <[email protected]>

* remove config

Signed-off-by: at670475 <[email protected]>

* add test

Signed-off-by: at670475 <[email protected]>

* add test

Signed-off-by: at670475 <[email protected]>

* fix test name

Signed-off-by: at670475 <[email protected]>

---------

Signed-off-by: at670475 <[email protected]>

gateway-package/src/main/resources/bin/start.sh

@@ -215,7 +215,7 @@ _BPX_JOBNAME=${ZWE_zowe_job_prefix}${GATEWAY_CODE} java \
     -Dapiml.service.externalUrl="${httpProtocol}://${ZWE_zowe_externalDomains_0}:${ZWE_zowe_externalPort}" \
     -Dapiml.service.apimlId=${ZWE_configs_apimlId:-} \
     -Dapiml.catalog.serviceId=${APIML_GATEWAY_CATALOG_ID:-apicatalog} \
-    -Dapiml.cache.storage.location=${ZWE_zowe_workspaceDirectory}/api-mediation/${ZWE_PARAMETER_HA_INSTANCE:-localhost} \
+    -Dapiml.cache.storage.location=${ZWE_zowe_workspaceDirectory}/api-mediation/${ZWE_haInstance_id:-localhost} \
     -Dapiml.logs.location=${ZWE_zowe_logDirectory} \
     -Dapiml.gateway.timeoutMillis=${ZWE_configs_apiml_gateway_timeoutMillis:-600000} \
     -Dapiml.security.ssl.verifySslCertificatesOfServices=${verifySslCertificatesOfServices:-false} \

gateway-service/src/main/java/org/zowe/apiml/gateway/config/CacheConfig.java

@@ -10,6 +10,7 @@
 
 package org.zowe.apiml.gateway.config;
 
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.cache.CacheManager;
 import org.springframework.cache.annotation.EnableCaching;
 import org.springframework.cache.interceptor.KeyGenerator;
@@ -30,6 +31,7 @@
  */
 @EnableCaching
 @Configuration
+@ConditionalOnProperty(value = "apiml.caching.enabled", havingValue = "true", matchIfMissing = true)
 public class CacheConfig {
 
     public static final String COMPOSITE_KEY_GENERATOR = "compositeKeyGenerator";

gateway-service/src/main/java/org/zowe/apiml/gateway/config/NoOpCacheConfig.java

@@ -0,0 +1,37 @@
+/*
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ */
+
+package org.zowe.apiml.gateway.config;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.cache.CacheManager;
+import org.springframework.cache.annotation.EnableCaching;
+import org.springframework.cache.support.NoOpCacheManager;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.zowe.apiml.util.CacheUtils;
+
+/**
+ * Spring configuration to disable EhCache usage.
+ */
+@EnableCaching
+@Configuration
+@ConditionalOnProperty(value = "apiml.caching.enabled", havingValue = "false")
+public class NoOpCacheConfig {
+    @Bean
+    public CacheManager cacheManager() {
+        return new NoOpCacheManager();
+    }
+
+    @Bean
+    public CacheUtils cacheUtils() {
+        return new CacheUtils();
+    }
+}

gateway-service/src/test/java/org/zowe/apiml/gateway/config/CacheConfigTest.java

@@ -0,0 +1,35 @@
+/*
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ */
+
+package org.zowe.apiml.gateway.config;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.cache.CacheManager;
+import org.springframework.cache.jcache.JCacheCacheManager;
+import org.springframework.test.context.ActiveProfiles;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = CacheConfig.class)
+@ActiveProfiles("test")
+class CacheConfigTest {
+
+    @Autowired
+    private CacheManager cacheManager;
+
+    @Test
+    void testCacheManagerIsRealImplementation() {
+        assertNotNull(cacheManager);
+        assertTrue(cacheManager instanceof JCacheCacheManager);
+    }
+}

gateway-service/src/test/java/org/zowe/apiml/gateway/config/NoOpCacheConfigTest.java

@@ -0,0 +1,34 @@
+/*
+ * This program and the accompanying materials are made available under the terms of the
+ * Eclipse Public License v2.0 which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v20.html
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Copyright Contributors to the Zowe Project.
+ */
+
+package org.zowe.apiml.gateway.config;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.cache.CacheManager;
+import org.springframework.cache.support.NoOpCacheManager;
+import org.springframework.test.context.ActiveProfiles;
+
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.NONE, classes = NoOpCacheConfig.class, properties = "apiml.caching.enabled=false")
+@ActiveProfiles("test")
+class NoOpCacheConfigTest {
+    @Autowired
+    private CacheManager cacheManager;
+
+    @Test
+    void testDisabledCacheManager() {
+        assertNotNull(cacheManager);
+        assertTrue(cacheManager instanceof NoOpCacheManager);
+    }
+}