feat: Service ID prefix replacer (#2229)

* Change service prefix and add unit tests

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Add more tests and fix codesmell

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Add integration test and gh action

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Fix env variable name

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Attempt

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Fix test scope

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Attempt

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Testing

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Fix the hostname service to reach

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* attempt

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* attempt

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* more attempt

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* revert and attempt

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Use env variable

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* revert

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Fix unit tests

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Add default value

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Increase timeout

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Change to faster test

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Revert

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Reset timeout to 5 minute

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Add unit tests

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Add more tests

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Refactoring

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Fix code smell

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* add env variable to be mapped correctly on zowe config

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Add more tests

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Create test tag

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Add tests

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* code refactor

Signed-off-by: achmelo <a.chmelo@gmail.com>

* Fix tests

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Comment the new config

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Change the property name

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Update cancel method to use the new service prefix

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

* Fix debug message

Signed-off-by: at670475 <andrea.tabone@broadcom.com>

Co-authored-by: achmelo <a.chmelo@gmail.com>

Author: taban03

.github/workflows/containers.yml

@@ -1062,3 +1062,47 @@ jobs:
                     path: api-catalog-ui/frontend/cypress/screenshots
             -   uses: ./.github/actions/teardown
 
+    CITestsServicePrefixReplacer:
+        needs: PublishJibContainers
+        container: ubuntu:latest
+        runs-on: ubuntu-latest
+        timeout-minutes: 15
+
+        services:
+            api-catalog-services:
+                image: ghcr.io/balhar-jakub/api-catalog-services:${{ github.event.pull_request.number || 'latest' }}
+                volumes:
+                    - /api-defs:/api-defs
+            discoverable-client:
+                image: ghcr.io/balhar-jakub/discoverable-client:${{ github.event.pull_request.number || 'latest' }}
+            discovery-service:
+                image: ghcr.io/balhar-jakub/discovery-service:${{ github.event.pull_request.number || 'latest' }}
+                volumes:
+                    - /api-defs:/api-defs
+                env:
+                    APIML_DISCOVERY_SERVICEIDPREFIXREPLACER: "discoverable,sample"
+            gateway-service:
+                image: ghcr.io/balhar-jakub/gateway-service:${{ github.event.pull_request.number || 'latest' }}
+            mock-services:
+                image: ghcr.io/balhar-jakub/mock-services:${{ github.event.pull_request.number || 'latest' }}
+        steps:
+            -   uses: actions/checkout@v2
+                with:
+                    ref: ${{ github.head_ref }}
+
+            -   uses: ./.github/actions/setup
+
+            -   name: Run Service ID Prefix Replacer Tests
+                run: >
+                    ./gradlew :integration-tests:runIdPrefixReplacerTests --info -Denvironment.config=-docker -Denvironment.offPlatform=true
+                    -Partifactory_user=${{ secrets.ARTIFACTORY_USERNAME }} -Partifactory_password=${{ secrets.ARTIFACTORY_PASSWORD }}
+
+            -   name: Store results
+                uses: actions/upload-artifact@v2
+                if: always()
+                with:
+                    name: CITestsServicePrefixReplacer-${{ env.JOB_ID }}
+                    path: |
+                        integration-tests/build/reports/**
+
+            -   uses: ./.github/actions/teardown

build.gradle

@@ -146,6 +146,11 @@ task runRegistrationTests(dependsOn: [":integration-tests:runRegistrationTests"]
     group "Integration tests"
 }
 
+task runIdPrefixReplacerTests(dependsOn: [":integration-tests:runIdPrefixReplacerTests"]) {
+    description "Run Integration Test verifying the service ID prefix replacer mechanism"
+    group "Integration tests"
+}
+
 task runMainFrameTests(dependsOn: ":integration-tests:runMainFrameTests") {
     description "Run only tests related to the MainFrame"
     group "Integration tests"

config/zowe-api-dev/run-wrapper.sh

@@ -71,6 +71,7 @@ export ZWE_CACHING_SERVICE_PORT=$((basePort+4))
 export ZWE_DISCOVERY_SERVICES_LIST=https://$ZOWE_EXPLORER_HOST:$DISCOVERY_PORT/eureka/
 export ZWEAD_EXTERNAL_STATIC_DEF_DIRECTORIES=$dir/apidef
 export APIML_STATIC_DEF=$ZWEAD_EXTERNAL_STATIC_DEF_DIRECTORIES
+#export ZWE_configs_apiml_discovery_serviceIdPrefixReplacer=
 echo "*******************  ENVIRONMENT  *******************"
 echo "Working directory "$dir
 echo "JAVA_HOME "$JAVA_HOME

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

@@ -38,6 +38,7 @@
 # - ZWE_haInstance_hostname
 # - ZWE_zowe_certificate_keystore_type - The default keystore type to use for SSL certificates
 # - ZWE_zowe_verifyCertificates - if we accept only verified certificates
+# - ZWE_configs_apiml_discovery_serviceIdPrefixReplacer - The service ID prefix replacer to be V2 conformant
 if [ ${LAUNCH_COMPONENT} ]
 then
     JAR_FILE="${LAUNCH_COMPONENT}/discovery-service-lite.jar"
@@ -136,6 +137,7 @@ _BPX_JOBNAME=${ZWE_zowe_job_prefix}${DISCOVERY_CODE} java -Xms32m -Xmx256m ${QUI
     -Dapiml.service.hostname=${ZWE_haInstance_hostname:-localhost} \
     -Dapiml.service.port=${ZWE_configs_port:-7553} \
     -Dapiml.discovery.staticApiDefinitionsDirectories=${ZWE_STATIC_DEFINITIONS_DIR} \
+    -Dapiml.discovery.serviceIdPrefixReplacer=${ZWE_configs_apiml_discovery_serviceIdPrefixReplacer} \
     -Dapiml.security.ssl.verifySslCertificatesOfServices=${verifySslCertificatesOfServices:-false} \
     -Dapiml.security.ssl.nonStrictVerifySslCertificatesOfServices=${nonStrictVerifySslCertificatesOfServices:-false} \
     -Dserver.ssl.enabled=${ZWE_components_gateway_server_ssl_enabled:-true} \

discovery-package/src/main/resources/manifest.yaml

@@ -29,5 +29,10 @@ apimlServices:
   static:
     - file: zosmf-static-definition.yaml.template
 configs:
+    # server.prefix.replacer is used to replace service ID prefix non-conformant with v2.
+    # Define ZWE_configs_apiml_discovery_serviceIdPrefixReplacer in the Zowe config if you want to use it
+#  apiml:
+#    discovery:
+#        serviceIdPrefixReplacer: ""
   port: 7553
   debug: false

discovery-service/src/main/java/org/zowe/apiml/discovery/ApimlInstanceRegistry.java

@@ -16,9 +16,11 @@
 import com.netflix.eureka.registry.AbstractInstanceRegistry;
 import com.netflix.eureka.registry.PeerAwareInstanceRegistryImpl;
 import com.netflix.eureka.resources.ServerCodecs;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.cloud.netflix.eureka.server.InstanceRegistry;
 import org.springframework.cloud.netflix.eureka.server.InstanceRegistryProperties;
 import org.springframework.context.ApplicationContext;
+import org.zowe.apiml.discovery.config.EurekaConfig;
 
 import java.lang.invoke.MethodHandle;
 import java.lang.invoke.MethodHandles;
@@ -37,6 +39,7 @@
  * #2659 Race condition with registration events in Eureka server
  * https://github.com/spring-cloud/spring-cloud-netflix/issues/2659
  */
+@Slf4j
 public class ApimlInstanceRegistry extends InstanceRegistry {
 
     private static final String EXCEPTION_MESSAGE = "Implementation of InstanceRegistry changed, please verify fix of order sending events";
@@ -49,21 +52,25 @@ public class ApimlInstanceRegistry extends InstanceRegistry {
     private MethodHandle register3ArgsMethodHandle;
     private MethodHandle cancelMethodHandle;
 
-    private ApplicationContext appCntx;
+    private final ApplicationContext appCntx;
+    private final EurekaConfig.Tuple tuple;
 
     public ApimlInstanceRegistry(
         EurekaServerConfig serverConfig,
         EurekaClientConfig clientConfig,
         ServerCodecs serverCodecs,
         EurekaClient eurekaClient,
         InstanceRegistryProperties instanceRegistryProperties,
-        ApplicationContext appCntx
+        ApplicationContext appCntx,
+        EurekaConfig.Tuple tuple
     ) {
+
         super(serverConfig, clientConfig, serverCodecs, eurekaClient,
             instanceRegistryProperties.getExpectedNumberOfClientsSendingRenews(),
             instanceRegistryProperties.getDefaultOpenForTrafficCount()
         );
         this.appCntx = appCntx;
+        this.tuple = tuple;
         init();
     }
 
@@ -143,6 +150,7 @@ protected int resolveInstanceLeaseDurationRewritten(final InstanceInfo info) {
 
     @Override
     public void register(InstanceInfo info, int leaseDuration, boolean isReplication) {
+            info = changeServiceId(info);
         try {
             register3ArgsMethodHandle.invokeWithArguments(this, info, leaseDuration, isReplication);
             handleRegistrationMethod.invokeWithArguments(this, info, leaseDuration, isReplication);
@@ -156,7 +164,8 @@ public void register(InstanceInfo info, int leaseDuration, boolean isReplication
     }
 
     @Override
-    public void register(final InstanceInfo info, final boolean isReplication) {
+    public void register(InstanceInfo info, final boolean isReplication) {
+            info = changeServiceId(info);
         try {
             register2ArgsMethodHandle.invokeWithArguments(this, info, isReplication);
             handleRegistrationMethod.invokeWithArguments(this, info, resolveInstanceLeaseDurationRewritten(info), isReplication);
@@ -172,8 +181,9 @@ public void register(final InstanceInfo info, final boolean isReplication) {
     @Override
     public boolean cancel(String appName, String serverId, boolean isReplication) {
         try {
-            final boolean out = (boolean) cancelMethodHandle.invokeWithArguments(this, appName, serverId, isReplication);
-            handleCancelationMethod.invokeWithArguments(this, appName, serverId, isReplication);
+            String[] updatedValues = replaceValues(appName, serverId);
+            final boolean out = (boolean) cancelMethodHandle.invokeWithArguments(this, updatedValues[0], updatedValues[1], isReplication);
+            handleCancelationMethod.invokeWithArguments(this, updatedValues[0], updatedValues[1], isReplication);
             return out;
         } catch (ClassCastException | WrongMethodTypeException e) {
             throw new IllegalArgumentException(EXCEPTION_MESSAGE, e);
@@ -184,10 +194,53 @@ public boolean cancel(String appName, String serverId, boolean isReplication) {
         }
     }
 
+    @Override
+    public boolean renew(String appName, String serverId, boolean isReplication) {
+        String[] updatedValues = replaceValues(appName, serverId);
+        return super.renew(updatedValues[0], updatedValues[1], isReplication);
+    }
+
     @Override
     public boolean statusUpdate(String appName, String instanceId, InstanceInfo.InstanceStatus newStatus, String lastDirtyTimestamp, boolean isReplication) {
-        boolean isUpdated = super.statusUpdate(appName, instanceId, newStatus, lastDirtyTimestamp, isReplication);
+        String[] updatedValues = replaceValues(appName,instanceId);
+        boolean isUpdated = super.statusUpdate(updatedValues[0], updatedValues[1], newStatus, lastDirtyTimestamp, isReplication);
         this.appCntx.publishEvent(new EurekaStatusUpdateEvent(this, appName, instanceId));
         return isUpdated;
     }
+
+    private String[] replaceValues(String appName, String instanceId) {
+        if (tuple.isValid()) {
+            String servicePrefix = tuple.getOldPrefix();
+            String targetValue = tuple.getNewPrefix();
+            appName = appName.replace(servicePrefix.toUpperCase(), targetValue.toUpperCase());
+            instanceId = instanceId.replace(servicePrefix, targetValue);
+        }
+        return new String[]{appName,instanceId};
+    }
+
+    /**
+     * Change the service ID prefix according to the mapper before the service registers to Eureka.
+     * @param info the instance info
+     * @return instance info with the modified service ID
+     */
+    protected InstanceInfo changeServiceId(final InstanceInfo info) {
+        if (tuple.isValid()) {
+            String servicePrefix = tuple.getOldPrefix();
+            String instanceId = info.getInstanceId();
+            if (instanceId.contains(servicePrefix)) {
+                String appName = info.getAppName();
+                String[] updatedValues = replaceValues(appName,instanceId);
+                log.debug("The instance ID of {} service has been changed to {}.", info.getAppName(), updatedValues[1]);
+                return new InstanceInfo.Builder(info)
+                    .setInstanceId(updatedValues[1])
+                    .setAppGroupName(updatedValues[0])
+                    .setAppName(updatedValues[0])
+                    .setVIPAddress(updatedValues[0])
+                    .build();
+            }
+            return info;
+        }
+        return info;
+    }
+
 }

discovery-service/src/main/java/org/zowe/apiml/discovery/config/EurekaConfig.java

@@ -9,6 +9,8 @@
  */
 package org.zowe.apiml.discovery.config;
 
+import org.apache.commons.lang3.StringUtils;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.ApplicationContext;
 import org.zowe.apiml.discovery.ApimlInstanceRegistry;
 import com.netflix.discovery.EurekaClient;
@@ -26,6 +28,9 @@
 @Configuration
 public class EurekaConfig {
 
+    @Value("${apiml.discovery.serviceIdPrefixReplacer:#{null}}")
+    private String tuple;
+
     @Bean
     @Primary
     public ApimlInstanceRegistry getApimlInstanceRegistry(
@@ -37,7 +42,47 @@ public ApimlInstanceRegistry getApimlInstanceRegistry(
         ApplicationContext appCntx)
     {
         eurekaClient.getApplications(); // force initialization
-        return new ApimlInstanceRegistry(serverConfig, clientConfig, serverCodecs, eurekaClient, instanceRegistryProperties,appCntx);
+        return new ApimlInstanceRegistry(serverConfig, clientConfig, serverCodecs, eurekaClient, instanceRegistryProperties,appCntx, new Tuple(tuple));
+    }
+
+    public static class Tuple {
+
+        boolean valid;
+        String oldPrefix;
+        String newPrefix;
+
+        public Tuple(String tuple) {
+            if (isValidTuple(tuple)) {
+                String[] prefixes = tuple.split(",");
+                this.oldPrefix = prefixes[0];
+                this.newPrefix = prefixes[1];
+                this.valid = true;
+            }
+        }
+
+        public boolean isValid() {
+            return valid;
+        }
+
+        public String getOldPrefix() {
+            return oldPrefix;
+        }
+
+        public String getNewPrefix() {
+            return newPrefix;
+        }
+
+        public static boolean isValidTuple(String tuple) {
+            if (StringUtils.isNotEmpty(tuple)) {
+                String[] replacer = tuple.split(",");
+                return replacer.length > 1 &&
+                    StringUtils.isNotEmpty(replacer[0]) &&
+                    StringUtils.isNotEmpty(replacer[1]) &&
+                    !replacer[0].equals(replacer[1]);
+            }
+            return false;
+        }
+
     }
 
 }