support isle actuator (#1257)

Co-authored-by: 致节 <hzj266771@antgroup.com>

sofa-boot-project/sofa-boot-actuator-autoconfigure/src/main/java/com/alipay/sofa/boot/actuator/autoconfigure/isle/IsleEndpointAutoConfiguration.java

@@ -0,0 +1,48 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.alipay.sofa.boot.actuator.autoconfigure.isle;
+
+import com.alipay.sofa.boot.actuator.isle.IsleEndpoint;
+import com.alipay.sofa.boot.autoconfigure.isle.SofaModuleAutoConfiguration;
+import com.alipay.sofa.boot.autoconfigure.isle.SofaModuleAvailableCondition;
+import com.alipay.sofa.boot.isle.ApplicationRuntimeModel;
+import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnAvailableEndpoint;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Conditional;
+
+/**
+ *  * {@link EnableAutoConfiguration Auto-configuration} for {@link IsleEndpoint}.
+ *
+ * @author huzijie
+ * @version IsleEndpointAutoConfiguration.java, v 0.1 2023年10月10日 3:51 PM huzijie Exp $
+ */
+@AutoConfiguration(after = SofaModuleAutoConfiguration.class)
+@Conditional(SofaModuleAvailableCondition.class)
+@ConditionalOnBean(ApplicationRuntimeModel.class)
+@ConditionalOnAvailableEndpoint(endpoint = IsleEndpoint.class)
+public class IsleEndpointAutoConfiguration {
+
+    @Bean
+    @ConditionalOnMissingBean
+    public IsleEndpoint isleEndPoint(ApplicationRuntimeModel applicationRuntimeModel) {
+        return new IsleEndpoint(applicationRuntimeModel);
+    }
+}

sofa-boot-project/sofa-boot-actuator-autoconfigure/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

@@ -6,4 +6,5 @@ com.alipay.sofa.boot.actuator.autoconfigure.health.ReadinessEndpointAutoConfigur
 com.alipay.sofa.boot.actuator.autoconfigure.health.ReadinessRuntimeAutoConfiguration
 com.alipay.sofa.boot.actuator.autoconfigure.health.ManualReadinessCallbackEndpointAutoConfiguration
 com.alipay.sofa.boot.actuator.autoconfigure.startup.StartupEndPointAutoConfiguration
-com.alipay.sofa.boot.actuator.autoconfigure.rpc.RpcActuatorAutoConfiguration
+com.alipay.sofa.boot.actuator.autoconfigure.rpc.RpcActuatorAutoConfiguration
+com.alipay.sofa.boot.actuator.autoconfigure.isle.IsleEndpointAutoConfiguration

sofa-boot-project/sofa-boot-actuator-autoconfigure/src/test/java/com/alipay/sofa/boot/actuator/autoconfigure/isle/IsleEndpointAutoConfigurationTests.java

@@ -0,0 +1,71 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.alipay.sofa.boot.actuator.autoconfigure.isle;
+
+import com.alipay.sofa.boot.actuator.isle.IsleEndpoint;
+import com.alipay.sofa.boot.autoconfigure.isle.SofaModuleAutoConfiguration;
+import com.alipay.sofa.boot.isle.ApplicationRuntimeModel;
+import org.junit.jupiter.api.Test;
+import org.springframework.boot.autoconfigure.AutoConfigurations;
+import org.springframework.boot.test.context.FilteredClassLoader;
+import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Tests for {@link IsleEndpointAutoConfiguration}.
+ *
+ * @author huzijie
+ * @version IsleEndpointAutoConfigurationTests.java, v 0.1 2023年10月10日 3:54 PM huzijie Exp $
+ */
+public class IsleEndpointAutoConfigurationTests {
+
+    private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
+                                                             .withConfiguration(AutoConfigurations
+                                                                 .of(IsleEndpointAutoConfiguration.class,
+                                                                     SofaModuleAutoConfiguration.class));
+
+    @Test
+    void runShouldHaveEndpointBean() {
+        this.contextRunner.withPropertyValues("management.endpoints.web.exposure.include=isle")
+                .run((context) -> assertThat(context).hasSingleBean(IsleEndpoint.class));
+    }
+
+    @Test
+    void runWhenNotExposedShouldNotHaveEndpointBean() {
+        this.contextRunner.run((context) -> assertThat(context).doesNotHaveBean(IsleEndpoint.class));
+    }
+
+    @Test
+    void runWhenNotExposedShouldNotHaveIsleClass() {
+        this.contextRunner.withClassLoader(new FilteredClassLoader(ApplicationRuntimeModel.class))
+                .run((context) -> assertThat(context).doesNotHaveBean(IsleEndpoint.class));
+    }
+
+    @Test
+    void runWhenNotExposedShouldUseDisableProperty() {
+        this.contextRunner.withPropertyValues("sofa.boot.isle.enabled=false")
+                .run((context) -> assertThat(context).doesNotHaveBean(IsleEndpoint.class));
+    }
+
+    @Test
+    void runWhenEnabledPropertyIsFalseShouldNotHaveEndpointBean() {
+        this.contextRunner.withPropertyValues("management.endpoint.isle.enabled:false")
+                .withPropertyValues("management.endpoints.web.exposure.include=*")
+                .run((context) -> assertThat(context).doesNotHaveBean(IsleEndpoint.class));
+    }
+}

sofa-boot-project/sofa-boot-actuator/src/main/java/com/alipay/sofa/boot/actuator/isle/IsleEndpoint.java

@@ -0,0 +1,184 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.alipay.sofa.boot.actuator.isle;
+
+import com.alipay.sofa.boot.isle.ApplicationRuntimeModel;
+import com.alipay.sofa.boot.isle.deployment.DeploymentDescriptor;
+import org.springframework.boot.actuate.endpoint.OperationResponseBody;
+import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
+import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
+import org.springframework.context.ApplicationContext;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+/**
+ * {@link Endpoint @Endpoint} to expose details of modules registered in {@link com.alipay.sofa.boot.isle.ApplicationRuntimeModel}.
+ *
+ * @author huzijie
+ * @version IsleEndpoint.java, v 0.1 2023年10月10日 2:59 PM huzijie Exp $
+ */
+@Endpoint(id = "isle")
+public class IsleEndpoint {
+
+    private final ApplicationRuntimeModel applicationRuntimeModel;
+
+    public IsleEndpoint(ApplicationRuntimeModel applicationRuntimeModel) {
+        this.applicationRuntimeModel = applicationRuntimeModel;
+    }
+
+    @ReadOperation
+    public IsleDescriptor modules() {
+        // already installed modules
+        List<ModuleDisplayInfo> installedModuleList = convertModuleDisplayInfoList(applicationRuntimeModel
+            .getInstalled());
+
+        List<ModuleDisplayInfo> failedModuleList = convertModuleDisplayInfoList(applicationRuntimeModel
+            .getFailed());
+
+        List<ModuleDisplayInfo> inactiveModuleList = convertModuleDisplayInfoList(applicationRuntimeModel
+            .getAllInactiveDeployments());
+
+        return new IsleDescriptor(installedModuleList, failedModuleList, inactiveModuleList);
+    }
+
+    private List<ModuleDisplayInfo> convertModuleDisplayInfoList(List<DeploymentDescriptor> deploymentDescriptors) {
+        return deploymentDescriptors.stream().map(this::createBaseModuleInfo).collect(Collectors.toList());
+    }
+
+    private ModuleDisplayInfo createBaseModuleInfo(DeploymentDescriptor dd) {
+        ModuleDisplayInfo moduleDisplayInfo = new ModuleDisplayInfo();
+        moduleDisplayInfo.setName(dd.getModuleName());
+        moduleDisplayInfo.setResourceName(dd.getName());
+        moduleDisplayInfo.setSpringParent(dd.getSpringParent());
+        moduleDisplayInfo.setRequireModules(dd.getRequiredModules());
+
+        ApplicationContext applicationContext = dd.getApplicationContext();
+        if (applicationContext != null) {
+            moduleDisplayInfo.setInstallSpringXmls(dd.getInstalledSpringXml());
+            moduleDisplayInfo.setElapsedTime(dd.getElapsedTime());
+            moduleDisplayInfo.setStartupTime(dd.getStartTime());
+        }
+        return moduleDisplayInfo;
+    }
+
+    public static final class IsleDescriptor implements OperationResponseBody {
+
+        /** 刷新成功的模块 **/
+        private final List<ModuleDisplayInfo> installedModuleList;
+
+        /** 创建失败的模块 **/
+        private final List<ModuleDisplayInfo> failedModuleList;
+
+        /** 未激活的模块 **/
+
+        private final List<ModuleDisplayInfo> inactiveModuleList;
+
+        public IsleDescriptor(List<ModuleDisplayInfo> installedModuleList,
+                              List<ModuleDisplayInfo> failedModuleList,
+                              List<ModuleDisplayInfo> inactiveModuleList) {
+            this.installedModuleList = installedModuleList;
+            this.failedModuleList = failedModuleList;
+            this.inactiveModuleList = inactiveModuleList;
+        }
+
+        public List<ModuleDisplayInfo> getInstalledModuleList() {
+            return installedModuleList;
+        }
+
+        public List<ModuleDisplayInfo> getFailedModuleList() {
+            return failedModuleList;
+        }
+
+        public List<ModuleDisplayInfo> getInactiveModuleList() {
+            return inactiveModuleList;
+        }
+    }
+
+    public static final class ModuleDisplayInfo {
+
+        private String       name;
+
+        private String       springParent;
+
+        private List<String> requireModules;
+
+        private String       resourceName;
+
+        private long         startupTime;
+
+        private long         elapsedTime;
+
+        private List<String> installSpringXmls;
+
+        public String getName() {
+            return name;
+        }
+
+        public void setName(String name) {
+            this.name = name;
+        }
+
+        public String getSpringParent() {
+            return springParent;
+        }
+
+        public void setSpringParent(String springParent) {
+            this.springParent = springParent;
+        }
+
+        public List<String> getRequireModules() {
+            return requireModules;
+        }
+
+        public void setRequireModules(List<String> requireModules) {
+            this.requireModules = requireModules;
+        }
+
+        public String getResourceName() {
+            return resourceName;
+        }
+
+        public void setResourceName(String resourceName) {
+            this.resourceName = resourceName;
+        }
+
+        public List<String> getInstallSpringXmls() {
+            return installSpringXmls;
+        }
+
+        public void setInstallSpringXmls(List<String> installSpringXmls) {
+            this.installSpringXmls = installSpringXmls;
+        }
+
+        public long getStartupTime() {
+            return startupTime;
+        }
+
+        public void setStartupTime(long startupTime) {
+            this.startupTime = startupTime;
+        }
+
+        public long getElapsedTime() {
+            return elapsedTime;
+        }
+
+        public void setElapsedTime(long elapsedTime) {
+            this.elapsedTime = elapsedTime;
+        }
+    }
+}