From df79539508195ee1b26b26ac19da447dad2ed2eb Mon Sep 17 00:00:00 2001 From: wulingxiao <1251605638@qqcom> Date: Thu, 3 Nov 2022 17:12:59 +0800 Subject: [PATCH] feature:support inject environment variable during test running. --- spring-cloud-tencent-commons/pom.xml | 6 ++ .../metadata/StaticMetadataManagerTest.java | 13 +++- .../common/support/EnvironmentVariable.java | 48 +++++++++++++ .../EnvironmentVariableInjectedRunner.java | 71 +++++++++++++++++++ .../common/support/EnvironmentVariables.java | 34 +++++++++ spring-cloud-tencent-dependencies/pom.xml | 8 +++ 6 files changed, 179 insertions(+), 1 deletion(-) create mode 100644 spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariable.java create mode 100644 spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariableInjectedRunner.java create mode 100644 spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariables.java diff --git a/spring-cloud-tencent-commons/pom.xml b/spring-cloud-tencent-commons/pom.xml index 6cf993ed3..956a004c7 100644 --- a/spring-cloud-tencent-commons/pom.xml +++ b/spring-cloud-tencent-commons/pom.xml @@ -99,6 +99,12 @@ spring-boot-actuator-autoconfigure true + + + com.github.stefanbirkner + system-rules + true + diff --git a/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/metadata/StaticMetadataManagerTest.java b/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/metadata/StaticMetadataManagerTest.java index 64aa20bcb..3f363696c 100644 --- a/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/metadata/StaticMetadataManagerTest.java +++ b/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/metadata/StaticMetadataManagerTest.java @@ -23,9 +23,13 @@ import java.util.HashMap; import java.util.HashSet; import java.util.Map; import java.util.Set; +import java.util.concurrent.locks.Lock; import com.tencent.cloud.common.metadata.config.MetadataLocalProperties; import com.tencent.cloud.common.spi.InstanceMetadataProvider; +import com.tencent.cloud.common.support.EnvironmentVariable; +import com.tencent.cloud.common.support.EnvironmentVariableInjectedRunner; +import com.tencent.cloud.common.support.EnvironmentVariables; import org.junit.Assert; import org.junit.Test; import org.junit.runner.RunWith; @@ -42,7 +46,14 @@ import static org.mockito.Mockito.when; * * @author lepdou 2022-06-27 */ -@RunWith(MockitoJUnitRunner.class) +@RunWith(EnvironmentVariableInjectedRunner.class) +@EnvironmentVariables( + value = { + @EnvironmentVariable(name = "SCT_METADATA_CONTENT_TRANSITIVE", value = "tkey1,tkey2,tkey3"), + @EnvironmentVariable(name = "SCT_METADATA_CONTENT_DISPOSABLE", value = "dkey1,dkey2,dkey3"), + @EnvironmentVariable(name = "SCT_METADATA_CONTENT_KEY", value = "key") + } +) public class StaticMetadataManagerTest { @Mock diff --git a/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariable.java b/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariable.java new file mode 100644 index 000000000..20f5057f3 --- /dev/null +++ b/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariable.java @@ -0,0 +1,48 @@ +/* + * Tencent is pleased to support the open source community by making Spring Cloud Tencent available. + * + * Copyright (C) 2019 THL A29 Limited, a Tencent company. 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.cloud.common.support; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Repeatable; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * @author lingxiao.wlx + */ +@Repeatable(EnvironmentVariables.class) +@Retention(RetentionPolicy.RUNTIME) +@Target({ElementType.TYPE}) +public @interface EnvironmentVariable { + + /** + * EnvironmentVariable name. + * + * @return EnvironmentVariable name + */ + String name(); + + /** + * EnvironmentVariable value. + * + * @return EnvironmentVariable value. + */ + String value(); +} diff --git a/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariableInjectedRunner.java b/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariableInjectedRunner.java new file mode 100644 index 000000000..21cb78614 --- /dev/null +++ b/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariableInjectedRunner.java @@ -0,0 +1,71 @@ +/* + * Tencent is pleased to support the open source community by making Spring Cloud Tencent available. + * + * Copyright (C) 2019 THL A29 Limited, a Tencent company. 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.cloud.common.support; + +import java.util.Arrays; +import java.util.Objects; + +import org.junit.Rule; +import org.junit.runners.model.InitializationError; +import org.springframework.core.annotation.AnnotationUtils; +import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; + +/** + * Enhance {@link SpringJUnit4ClassRunner} to support inject environment variable during test running. + *

+ * typical usage idiom for this class would be: + * 

 {@code
+ * @RunWith(EnvironmentVariableInjectedRunner.class)
+ * @EnvironmentVariable(name = "name",value = "value")
+ * public class Test {
+ * }
+ * }
+ * + * @author lingxiao.wlx + * @see EnvironmentVariable + * @see EnvironmentVariables + */ +public class EnvironmentVariableInjectedRunner extends SpringJUnit4ClassRunner { + + @Rule + private final org.junit.contrib.java.lang.system.EnvironmentVariables injectedEnvironmentVariables + = new org.junit.contrib.java.lang.system.EnvironmentVariables(); + + public EnvironmentVariableInjectedRunner(Class clazz) throws InitializationError { + super(clazz); + EnvironmentVariable environmentVariable = AnnotationUtils.findAnnotation(clazz, EnvironmentVariable.class); + if (!Objects.isNull(environmentVariable)) { + injectEnvironmentVariable(environmentVariable); + } + EnvironmentVariables environmentVariables = AnnotationUtils.findAnnotation(clazz, EnvironmentVariables.class); + if (!Objects.isNull(environmentVariables)) { + injectEnvironmentVariables(environmentVariables); + } + } + + private void injectEnvironmentVariables(EnvironmentVariables environmentVariables) { + Arrays.stream(environmentVariables.value()).forEach( + this::injectEnvironmentVariable + ); + } + + private void injectEnvironmentVariable(EnvironmentVariable environmentVariable) { + injectedEnvironmentVariables.set(environmentVariable.name(), environmentVariable.value()); + } +} diff --git a/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariables.java b/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariables.java new file mode 100644 index 000000000..416f151ec --- /dev/null +++ b/spring-cloud-tencent-commons/src/test/java/com/tencent/cloud/common/support/EnvironmentVariables.java @@ -0,0 +1,34 @@ +/* + * Tencent is pleased to support the open source community by making Spring Cloud Tencent available. + * + * Copyright (C) 2019 THL A29 Limited, a Tencent company. 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.cloud.common.support; + +import java.lang.annotation.ElementType; +import java.lang.annotation.Retention; +import java.lang.annotation.RetentionPolicy; +import java.lang.annotation.Target; + +/** + * @author lingxiao.wlx + */ +@Retention(RetentionPolicy.RUNTIME) +@Target(ElementType.TYPE) +public @interface EnvironmentVariables { + + EnvironmentVariable[] value(); +} diff --git a/spring-cloud-tencent-dependencies/pom.xml b/spring-cloud-tencent-dependencies/pom.xml index 8126a44b3..6cef9e7fc 100644 --- a/spring-cloud-tencent-dependencies/pom.xml +++ b/spring-cloud-tencent-dependencies/pom.xml @@ -80,6 +80,7 @@ 1.12.10 3.16.1 1.69 + 1.16.1 3.2.0 @@ -248,6 +249,13 @@ ${mocktio.version} test + + + com.github.stefanbirkner + system-rules + ${system-rules.version} + test +