feat:support fault injection. (#629)

Author: SkyeBeFreeman

polaris-common/polaris-config-default/src/main/resources/conf/default-config.yml

@@ -331,6 +331,10 @@ consumer:
     chain:
     # 开启了服务预热插件，可以支持多个动态权重调整插件同时生效
 #      - warmup
+  # 故障注入相关配置
+  fault:
+    # 是否开启故障注入
+    enable: true
 # 被调方配置
 provider:
   # Switch of registration

polaris-common/polaris-config/src/main/java/com/tencent/polaris/api/config/consumer/ConsumerConfig.java

@@ -93,4 +93,11 @@ public interface ConsumerConfig extends Verifier {
     Map<String, ? extends DiscoveryConfig> getDiscoveryConfigMap();
 
     WeightAdjustConfig getWeightAdjust();
+
+    /**
+     * consumer.fault前缀开头的所有配置
+     *
+     * @return
+     */
+    FaultConfig getFault();
 }

polaris-common/polaris-config/src/main/java/com/tencent/polaris/api/config/consumer/FaultConfig.java

@@ -0,0 +1,36 @@
+/*
+ * Tencent is pleased to support the open source community by making polaris-java available.
+ *
+ * Copyright (C) 2021 Tencent. All rights reserved.
+ *
+ * Licensed under the BSD 3-Clause License (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://opensource.org/licenses/BSD-3-Clause
+ *
+ * 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.tencent.polaris.api.config.consumer;
+
+import com.tencent.polaris.api.config.verify.Verifier;
+
+/**
+ * 故障注入配置
+ *
+ * @author Haotian Zhang
+ */
+public interface FaultConfig extends Verifier {
+
+    /**
+     * 是否启用故障注入
+     * consumer.fault.enable
+     *
+     * @return 启用鉴权
+     */
+    boolean isEnable();
+}

polaris-common/polaris-config/src/main/java/com/tencent/polaris/factory/config/consumer/ConsumerConfigImpl.java

@@ -20,6 +20,7 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.tencent.polaris.api.config.consumer.ConsumerConfig;
+import com.tencent.polaris.api.config.consumer.FaultConfig;
 import com.tencent.polaris.api.config.consumer.WeightAdjustConfig;
 import com.tencent.polaris.api.utils.CollectionUtils;
 import com.tencent.polaris.factory.util.ConfigUtils;
@@ -67,6 +68,9 @@ public class ConsumerConfigImpl implements ConsumerConfig {
     @JsonProperty
     private WeightAdjustConfigImpl weightAdjust;
 
+    @JsonProperty
+    private FaultConfigImpl fault;
+
     @Override
     public LocalCacheConfigImpl getLocalCache() {
         return localCache;
@@ -132,6 +136,11 @@ public WeightAdjustConfig getWeightAdjust() {
         return weightAdjust;
     }
 
+    @Override
+    public FaultConfig getFault() {
+        return fault;
+    }
+
     @Override
     public void verify() {
         ConfigUtils.validateNull(localCache, "localCache");
@@ -140,6 +149,7 @@ public void verify() {
         ConfigUtils.validateNull(circuitBreaker, "circuitBreaker");
         ConfigUtils.validateNull(outlierDetection, "outlierDetection");
         ConfigUtils.validateNull(weightAdjust, "weightAdjust");
+        ConfigUtils.validateNull(fault, "fault");
 
         localCache.verify();
         serviceRouter.verify();
@@ -149,6 +159,7 @@ public void verify() {
         subscribe.verify();
         zeroProtection.verify();
         weightAdjust.verify();
+        fault.verify();
         if (CollectionUtils.isNotEmpty(discoveries)) {
             for (DiscoveryConfigImpl discoveryConfig : discoveries) {
                 discoveryConfig.verify();
@@ -183,6 +194,9 @@ public void setDefault(Object defaultObject) {
         if (null == weightAdjust) {
             weightAdjust = new WeightAdjustConfigImpl();
         }
+        if (null == fault) {
+            fault = new FaultConfigImpl();
+        }
         if (null != defaultObject) {
             ConsumerConfig consumerConfig = (ConsumerConfig) defaultObject;
             localCache.setDefault(consumerConfig.getLocalCache());
@@ -193,6 +207,7 @@ public void setDefault(Object defaultObject) {
             subscribe.setDefault(consumerConfig.getSubscribe());
             zeroProtection.setDefault(consumerConfig.getZeroProtection());
             weightAdjust.setDefault(consumerConfig.getWeightAdjust());
+            fault.setDefault(consumerConfig.getFault());
             if (CollectionUtils.isNotEmpty(discoveries)) {
                 for (DiscoveryConfigImpl discoveryConfig : discoveries) {
                     discoveryConfig.setDefault(consumerConfig.getDiscoveries().get(0));
@@ -204,14 +219,19 @@ public void setDefault(Object defaultObject) {
     }
 
     @Override
-    @SuppressWarnings("checkstyle:all")
     public String toString() {
         return "ConsumerConfigImpl{" +
                 "localCache=" + localCache +
                 ", serviceRouter=" + serviceRouter +
                 ", loadbalancer=" + loadbalancer +
                 ", circuitBreaker=" + circuitBreaker +
                 ", outlierDetection=" + outlierDetection +
+                ", subscribe=" + subscribe +
+                ", zeroProtection=" + zeroProtection +
+                ", discoveries=" + discoveries +
+                ", discoveryConfigMap=" + discoveryConfigMap +
+                ", weightAdjust=" + weightAdjust +
+                ", fault=" + fault +
                 '}';
     }
 }

polaris-common/polaris-config/src/main/java/com/tencent/polaris/factory/config/consumer/FaultConfigImpl.java

@@ -0,0 +1,57 @@
+/*
+ * Tencent is pleased to support the open source community by making polaris-java available.
+ *
+ * Copyright (C) 2021 Tencent. All rights reserved.
+ *
+ * Licensed under the BSD 3-Clause License (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://opensource.org/licenses/BSD-3-Clause
+ *
+ * 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.tencent.polaris.factory.config.consumer;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.tencent.polaris.api.config.consumer.FaultConfig;
+import com.tencent.polaris.factory.util.ConfigUtils;
+
+/**
+ * Implementation of {@link FaultConfig}.
+ *
+ * @author Haotian Zhang
+ */
+public class FaultConfigImpl implements FaultConfig {
+
+    @JsonProperty
+    private Boolean enable;
+
+    @Override
+    public boolean isEnable() {
+        return enable;
+    }
+
+    public void setEnable(Boolean enable) {
+        this.enable = enable;
+    }
+
+    @Override
+    public void verify() {
+        ConfigUtils.validateNull(enable, "consumer.fault.enable");
+    }
+
+    @Override
+    public void setDefault(Object defaultObject) {
+        if (null != defaultObject) {
+            FaultConfig faultConfig = (FaultConfig) defaultObject;
+            if (null == enable) {
+                setEnable(faultConfig.isEnable());
+            }
+        }
+    }
+}

polaris-common/polaris-model/src/main/java/com/tencent/polaris/api/exception/ErrorCode.java

@@ -130,6 +130,11 @@ public enum ErrorCode {
      */
     CLIENT_CIRCUIT_BREAKING(1020),
 
+    /**
+     * client resource has been fault injected
+     */
+    CLIENT_FAULT_INJECTED(1021),
+
     /**
      * 内部错误：连续错误
      */

polaris-common/polaris-model/src/main/java/com/tencent/polaris/api/pojo/ServiceEventKey.java

@@ -53,6 +53,7 @@ public enum EventType {
         LOSSLESS,
         BLOCK_ALLOW_RULE,
         TRAFFIC_MIRRORING,
+        FAULT_INJECTION,
     }
 
     private final ServiceKey serviceKey;

polaris-common/polaris-model/src/main/java/com/tencent/polaris/api/utils/ClassUtils.java

@@ -42,7 +42,7 @@ public static boolean isClassPresent(String className) {
         } catch (ClassNotFoundException e) {
             return false;
         } catch (Throwable throwable) {
-            LOG.warn("Failed to check class present", throwable);
+            LOG.warn("Failed to check class {} present", className, throwable);
             return false;
         }
     }

polaris-factory/pom.xml

@@ -51,6 +51,11 @@
             <artifactId>polaris-auth-factory</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.tencent.polaris</groupId>
+            <artifactId>polaris-fault-factory</artifactId>
+            <version>${project.version}</version>
+        </dependency>
 
         <!--测试依赖插件-->
         <dependency>

polaris-fault/polaris-fault-api/pom.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+    <parent>
+        <artifactId>polaris-fault</artifactId>
+        <groupId>com.tencent.polaris</groupId>
+        <version>${revision}</version>
+        <relativePath>../pom.xml</relativePath>
+    </parent>
+    <modelVersion>4.0.0</modelVersion>
+
+    <artifactId>polaris-fault-api</artifactId>
+    <name>Polaris Fault API</name>
+    <description>Polaris Fault API JAR</description>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.tencent.polaris</groupId>
+            <artifactId>polaris-plugin-api</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>com.tencent.polaris</groupId>
+            <artifactId>polaris-client</artifactId>
+            <version>${project.version}</version>
+        </dependency>
+    </dependencies>
+</project>