【fix】fix the close bug for docker

sermant-plugins/sermant-springboot-registry/springboot-registry-plugin/src/main/java/com/huawei/discovery/declarers/SpringContextDeclarer.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2022-2022 Huawei Technologies Co., Ltd. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.huawei.discovery.declarers;
+
+import com.huawei.discovery.interceptors.SpringCloseEventInterceptor;
+
+import com.huaweicloud.sermant.core.plugin.agent.declarer.InterceptDeclarer;
+import com.huaweicloud.sermant.core.plugin.agent.matcher.ClassMatcher;
+import com.huaweicloud.sermant.core.plugin.agent.matcher.MethodMatcher;
+
+/**
+ * 增强org.springframework.context.support.AbstractApplicationContext, 监听事件发布
+ *
+ * @author zhouss
+ * @since 2022-11-16
+ */
+public class SpringContextDeclarer extends BaseDeclarer {
+    private static final String ENHANCE_CLASS = "org.springframework.context.support.AbstractApplicationContext";
+
+    private static final String INTERCEPT_CLASS = SpringCloseEventInterceptor.class.getCanonicalName();
+
+    private static final String METHOD_NAME = "publishEvent";
+
+    @Override
+    public ClassMatcher getClassMatcher() {
+        return ClassMatcher.nameEquals(ENHANCE_CLASS);
+    }
+
+    @Override
+    public InterceptDeclarer[] getInterceptDeclarers(ClassLoader classLoader) {
+        return new InterceptDeclarer[]{
+            InterceptDeclarer.build(MethodMatcher.nameEquals(METHOD_NAME)
+                    .and(MethodMatcher.paramTypesEqual("java.lang.Object", "org.springframework.core.ResolvableType")),
+                    INTERCEPT_CLASS)
+        };
+    }
+}

sermant-plugins/sermant-springboot-registry/springboot-registry-plugin/src/main/java/com/huawei/discovery/interceptors/SpringCloseEventInterceptor.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright (C) 2022-2022 Huawei Technologies Co., Ltd. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.huawei.discovery.interceptors;
+
+import com.huawei.discovery.service.RegistryService;
+
+import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
+import com.huaweicloud.sermant.core.plugin.agent.interceptor.AbstractInterceptor;
+import com.huaweicloud.sermant.core.plugin.service.PluginServiceManager;
+
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.event.ContextClosedEvent;
+
+/**
+ * Spring关闭事件监听{@link org.springframework.context.event.ContextClosedEvent}
+ *
+ * @author zhouss
+ * @since 2022-11-16
+ */
+public class SpringCloseEventInterceptor extends AbstractInterceptor {
+    private final RegistryService registryService;
+
+    /**
+     * 构造器
+     */
+    public SpringCloseEventInterceptor() {
+        registryService = PluginServiceManager.getPluginService(RegistryService.class);
+    }
+
+    @Override
+    public ExecuteContext before(ExecuteContext context) throws Exception {
+        final Object rawEvent = context.getArguments()[0];
+        if (rawEvent instanceof ContextClosedEvent) {
+            tryShutdown((ContextClosedEvent) rawEvent);
+        }
+        return context;
+    }
+
+    private void tryShutdown(ContextClosedEvent event) {
+        if (event.getSource() instanceof AnnotationConfigApplicationContext) {
+            // 该类型属于刷新事件, 不予以处理
+            return;
+        }
+        registryService.shutdown();
+    }
+
+    @Override
+    public ExecuteContext after(ExecuteContext context) throws Exception {
+        return context;
+    }
+}

sermant-plugins/sermant-springboot-registry/springboot-registry-plugin/src/main/java/com/huawei/discovery/service/RegistryService.java

@@ -33,4 +33,9 @@ public interface RegistryService extends PluginService {
      * @param serviceInstance 实例信息
      */
     void registry(ServiceInstance serviceInstance);
+
+    /**
+     * 关闭服务发现, 从注册中心下线
+     */
+    void shutdown();
 }

sermant-plugins/sermant-springboot-registry/springboot-registry-plugin/src/main/resources/META-INF/services/com.huaweicloud.sermant.core.plugin.agent.declarer.PluginDeclarer

@@ -25,4 +25,5 @@ com.huawei.discovery.declarers.SpringEnvironmentInfoDeclarer
 com.huawei.discovery.declarers.SpringBootDeclarer
 com.huawei.discovery.declarers.httpconnection.HttpUrlConnectionConnectDeclarer
 com.huawei.discovery.declarers.httpconnection.HttpUrlConnectionResponseStreamDeclarer
+com.huawei.discovery.declarers.SpringContextDeclarer
 

sermant-plugins/sermant-springboot-registry/springboot-registry-plugin/src/test/java/com/huawei/discovery/interceptors/SpringCloseEventInterceptorTest.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright (C) 2022-2022 Huawei Technologies Co., Ltd. All rights reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.huawei.discovery.interceptors;
+
+import com.huawei.discovery.service.RegistryService;
+
+import com.huaweicloud.sermant.core.plugin.agent.entity.ExecuteContext;
+import com.huaweicloud.sermant.core.plugin.service.PluginServiceManager;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mockito;
+import org.springframework.boot.web.servlet.context.AnnotationConfigServletWebApplicationContext;
+import org.springframework.context.annotation.AnnotationConfigApplicationContext;
+import org.springframework.context.event.ContextClosedEvent;
+
+import java.util.Collections;
+
+/**
+ * 关闭事件测试
+ *
+ * @author zhouss
+ * @since 2022-11-16
+ */
+public class SpringCloseEventInterceptorTest extends BaseTest {
+    private RegistryService registryService;
+
+    @Override
+    @Before
+    public void setUp() {
+        super.setUp();
+        registryService = Mockito.mock(RegistryService.class);
+        pluginServiceManagerMockedStatic.when(() -> PluginServiceManager.getPluginService(RegistryService.class))
+                .thenReturn(registryService);
+    }
+
+    @Test
+    public void before() throws Exception {
+        final SpringCloseEventInterceptor springCloseEventInterceptor = new SpringCloseEventInterceptor();
+        springCloseEventInterceptor.before(buildContext(new Object[]{"test"}));
+        Mockito.verify(registryService, Mockito.times(0)).shutdown();
+        springCloseEventInterceptor.before(buildContext(new Object[]{new ContextClosedEvent(Mockito.mock(
+                AnnotationConfigApplicationContext.class))}));
+        Mockito.verify(registryService, Mockito.times(0)).shutdown();
+        springCloseEventInterceptor.before(buildContext(new Object[]{new ContextClosedEvent(Mockito.mock(
+                AnnotationConfigServletWebApplicationContext.class))}));
+        Mockito.verify(registryService, Mockito.times(1)).shutdown();
+        springCloseEventInterceptor.after(buildContext(new Object[]{"test"}));
+    }
+
+    private ExecuteContext buildContext(Object[] arguments) throws NoSuchMethodException {
+        return ExecuteContext.forMemberMethod(new Object(), String.class.getDeclaredMethod("trim"), arguments,
+                Collections.emptyMap(), Collections.emptyMap());
+    }
+}

sermant-plugins/sermant-springboot-registry/springboot-registry-service/src/main/java/com/huawei/discovery/service/lb/LbServiceImpl.java

@@ -16,17 +16,10 @@
 
 package com.huawei.discovery.service.lb;
 
-import com.huawei.discovery.config.DiscoveryPluginConfig;
 import com.huawei.discovery.entity.ServiceInstance;
 import com.huawei.discovery.service.LbService;
 
-import com.huaweicloud.sermant.core.common.LoggerFactory;
-import com.huaweicloud.sermant.core.plugin.config.PluginConfigManager;
-
-import java.io.IOException;
 import java.util.Optional;
-import java.util.logging.Level;
-import java.util.logging.Logger;
 
 /**
  * 负载均衡服务
@@ -35,22 +28,8 @@
  * @since 2022-09-26
  */
 public class LbServiceImpl implements LbService {
-    private static final Logger LOGGER = LoggerFactory.getLogger();
-
     @Override
     public Optional<ServiceInstance> choose(String serviceName) {
         return DiscoveryManager.INSTANCE.choose(serviceName);
     }
-
-    @Override
-    public void stop() {
-        if (!PluginConfigManager.getPluginConfig(DiscoveryPluginConfig.class).isEnableRegistry()) {
-            return;
-        }
-        try {
-            DiscoveryManager.INSTANCE.stop();
-        } catch (IOException ex) {
-            LOGGER.log(Level.WARNING, "Stop lb service failed!", ex);
-        }
-    }
 }

sermant-plugins/sermant-springboot-registry/springboot-registry-service/src/main/java/com/huawei/discovery/service/registry/RegistryImpl.java

@@ -16,19 +16,75 @@
 
 package com.huawei.discovery.service.registry;
 
+import com.huawei.discovery.config.DiscoveryPluginConfig;
 import com.huawei.discovery.entity.ServiceInstance;
 import com.huawei.discovery.service.RegistryService;
 import com.huawei.discovery.service.lb.DiscoveryManager;
 
+import com.huaweicloud.sermant.core.common.LoggerFactory;
+import com.huaweicloud.sermant.core.plugin.config.PluginConfigManager;
+import com.huaweicloud.sermant.core.service.ServiceManager;
+import com.huaweicloud.sermant.core.service.heartbeat.api.HeartbeatService;
+
+import java.io.IOException;
+import java.util.Collections;
+import java.util.concurrent.atomic.AtomicBoolean;
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
 /**
  * 注册
  *
  * @author zhouss
  * @since 2022-09-27
  */
 public class RegistryImpl implements RegistryService {
+    private static final Logger LOGGER = LoggerFactory.getLogger();
+
+    private final AtomicBoolean isShutdown = new AtomicBoolean();
+
+    private HeartbeatService heartbeatService;
+
+    @Override
+    public void start() {
+        try {
+            heartbeatService = ServiceManager.getService(HeartbeatService.class);
+        } catch (IllegalArgumentException ex) {
+            // ignored 不存在心跳服务
+        }
+    }
+
     @Override
     public void registry(ServiceInstance serviceInstance) {
         DiscoveryManager.INSTANCE.registry(serviceInstance);
     }
+
+    @Override
+    public void shutdown() {
+        if (!PluginConfigManager.getPluginConfig(DiscoveryPluginConfig.class).isEnableRegistry()) {
+            return;
+        }
+        if (isShutdown.compareAndSet(false, true)) {
+            try {
+                DiscoveryManager.INSTANCE.stop();
+            } catch (IOException ex) {
+                LOGGER.log(Level.WARNING, "Stop lb service failed!", ex);
+            } finally {
+                addStatusForHeartbeat();
+            }
+        }
+    }
+
+    private void addStatusForHeartbeat() {
+        if (heartbeatService == null) {
+            LOGGER.warning("Heartbeat service is not init when add stop status for heartbeat!");
+            return;
+        }
+        heartbeatService.setExtInfo(() -> Collections.singletonMap("status", "stopped"));
+    }
+
+    @Override
+    public void stop() {
+        shutdown();
+    }
 }

sermant-plugins/sermant-springboot-registry/springboot-registry-service/src/test/java/com/huawei/discovery/service/lb/LbServiceImplTest.java

@@ -26,7 +26,6 @@
 import com.huaweicloud.sermant.core.plugin.service.PluginServiceManager;
 import com.huaweicloud.sermant.core.utils.ReflectUtils;
 
-import org.apache.curator.framework.state.ConnectionState;
 import org.junit.Assert;
 import org.junit.Test;
 import org.mockito.Mock;
@@ -37,7 +36,6 @@
 import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.atomic.AtomicBoolean;
-import java.util.concurrent.atomic.AtomicReference;
 
 /**
  * 负载均衡测试
@@ -80,7 +78,7 @@ private List<ServiceInstance> mockInstances() {
         try {
             Mockito.when(zkService34.getInstances(serviceName)).thenReturn(serviceInstances);
         } catch (com.huawei.discovery.service.ex.QueryInstanceException e) {
-            e.printStackTrace();
+            // ignored
         }
         return serviceInstances;
     }
@@ -97,10 +95,4 @@ public void choose() {
         Assert.assertTrue(choose.isPresent());
         Assert.assertTrue(serviceInstances.contains(choose.get()));
     }
-
-    @Test
-    public void stop() {
-        lbService.stop();
-        Mockito.verify(zkService34, Mockito.times(1)).unRegistry();
-    }
 }

sermant-plugins/sermant-springboot-registry/springboot-registry-service/src/test/java/com/huawei/discovery/service/registry/RegistryImplTest.java

@@ -17,6 +17,7 @@
 package com.huawei.discovery.service.registry;
 
 import com.huawei.discovery.entity.ServiceInstance;
+import com.huawei.discovery.service.RegistryService;
 import com.huawei.discovery.service.lb.DiscoveryManager;
 import com.huawei.discovery.service.lb.discovery.zk.ZkService34;
 import com.huawei.discovery.service.lb.rule.BaseTest;
@@ -75,4 +76,12 @@ public void registry() {
         DiscoveryManager.INSTANCE.registry(serviceInstance);
         Mockito.verify(zkService34, Mockito.times(1)).registry(serviceInstance);
     }
+
+    @Test
+    public void registryLifeTest() {
+        final RegistryService registry = new RegistryImpl();
+        registry.start();
+        registry.stop();
+        Mockito.verify(zkService34, Mockito.times(1)).unRegistry();
+    }
 }