fix:add junit test in config module. (#288)

Co-authored-by: lepdou <ledouzhang@tencent.com>

CHANGELOG.md

@@ -2,3 +2,4 @@
 ---
 
 - [fix: fix not load application.yml bug & fix guava version conflict bug.](https://github.com/Tencent/spring-cloud-tencent/pull/286)
+- [fix:add junit test in config module.](https://github.com/Tencent/spring-cloud-tencent/pull/288)

changes/changes-1.5.2.md

@@ -1,5 +1,5 @@
 # Change Log
 ---
 
-- [fix:use 1.6.1 version of polaris-java.](https://github.com/Tencent/spring-cloud-tencent/pull/209)
+- [fix:use 1.6.1 version of polaris-java.](https://github.com/Tencent/spring-cloud-tencent/pull/223)
 - [fix:use 1.6.1 version of polaris-java and fix some bug.](https://github.com/Tencent/spring-cloud-tencent/pull/223)

spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/ConditionalOnConnectRemoteServerEnabled.java

@@ -0,0 +1,37 @@
+/*
+ * 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.polaris.config;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+
+/**
+ * Whether to connect to a remote server, suitable for local development mode.
+ *
+ * @author lepdou 2022-06-11
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.TYPE, ElementType.METHOD })
+@ConditionalOnProperty(value = "spring.cloud.polaris.config.connect-remote-server", matchIfMissing = true)
+public @interface ConditionalOnConnectRemoteServerEnabled {
+
+}

spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/MockedConfigKVFile.java

@@ -0,0 +1,170 @@
+/*
+ * 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.polaris.config.adapter;
+
+import java.lang.reflect.Type;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import com.tencent.polaris.configuration.api.core.ConfigFileChangeListener;
+import com.tencent.polaris.configuration.api.core.ConfigKVFile;
+import com.tencent.polaris.configuration.api.core.ConfigKVFileChangeEvent;
+import com.tencent.polaris.configuration.api.core.ConfigKVFileChangeListener;
+
+/**
+ * Mock config kv file for test.
+ *@author lepdou 2022-06-11
+ */
+public class MockedConfigKVFile implements ConfigKVFile {
+
+	private final Map<String, Object> properties;
+	private final List<ConfigKVFileChangeListener> listeners = new ArrayList<>();
+
+	public MockedConfigKVFile(Map<String, Object> properties) {
+		this.properties = properties;
+	}
+
+	@Override
+	public String getProperty(String s, String s1) {
+		return String.valueOf(properties.get(s));
+	}
+
+	@Override
+	public Integer getIntProperty(String s, Integer integer) {
+		return null;
+	}
+
+	@Override
+	public Long getLongProperty(String s, Long aLong) {
+		return null;
+	}
+
+	@Override
+	public Short getShortProperty(String s, Short aShort) {
+		return null;
+	}
+
+	@Override
+	public Float getFloatProperty(String s, Float aFloat) {
+		return null;
+	}
+
+	@Override
+	public Double getDoubleProperty(String s, Double aDouble) {
+		return null;
+	}
+
+	@Override
+	public Byte getByteProperty(String s, Byte aByte) {
+		return null;
+	}
+
+	@Override
+	public Boolean getBooleanProperty(String s, Boolean aBoolean) {
+		return null;
+	}
+
+	@Override
+	public String[] getArrayProperty(String s, String s1, String[] strings) {
+		return new String[0];
+	}
+
+	@Override
+	public <T extends Enum<T>> T getEnumProperty(String s, Class<T> aClass, T t) {
+		return null;
+	}
+
+	@Override
+	public <T> T getJsonProperty(String s, Class<T> aClass, T t) {
+		return null;
+	}
+
+	@Override
+	public <T> T getJsonProperty(String s, Type type, T t) {
+		return null;
+	}
+
+	@Override
+	public Set<String> getPropertyNames() {
+		return properties.keySet();
+	}
+
+	@Override
+	public void addChangeListener(ConfigKVFileChangeListener configKVFileChangeListener) {
+		listeners.add(configKVFileChangeListener);
+	}
+
+	@Override
+	public void removeChangeListener(ConfigKVFileChangeListener configKVFileChangeListener) {
+
+	}
+
+	@Override
+	public String getContent() {
+		return null;
+	}
+
+	@Override
+	public <T> T asJson(Class<T> aClass, T t) {
+		return null;
+	}
+
+	@Override
+	public <T> T asJson(Type type, T t) {
+		return null;
+	}
+
+	@Override
+	public boolean hasContent() {
+		return false;
+	}
+
+	@Override
+	public void addChangeListener(ConfigFileChangeListener configFileChangeListener) {
+
+	}
+
+	@Override
+	public void removeChangeListener(ConfigFileChangeListener configFileChangeListener) {
+
+	}
+
+	public void fireChangeListener(ConfigKVFileChangeEvent event) {
+		for (ConfigKVFileChangeListener listener : listeners) {
+			listener.onChange(event);
+		}
+	}
+
+	@Override
+	public String getNamespace() {
+		return null;
+	}
+
+	@Override
+	public String getFileGroup() {
+		return null;
+	}
+
+	@Override
+	public String getFileName() {
+		return null;
+	}
+}

spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFileLocatorTest.java

@@ -0,0 +1,188 @@
+/*
+ * 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.polaris.config.adapter;
+
+import java.util.HashMap;
+import java.util.LinkedList;
+import java.util.List;
+import java.util.Map;
+
+import com.google.common.collect.Lists;
+import com.tencent.cloud.polaris.config.config.ConfigFileGroup;
+import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
+import com.tencent.cloud.polaris.context.PolarisContextProperties;
+import com.tencent.polaris.configuration.api.core.ConfigFileService;
+import com.tencent.polaris.configuration.api.core.ConfigKVFile;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+import org.springframework.core.env.Environment;
+import org.springframework.core.env.PropertySource;
+
+import static org.mockito.Mockito.when;
+
+/**
+ * test for {@link PolarisConfigFileLocator}
+ *@author lepdou 2022-06-11
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class PolarisConfigFileLocatorTest {
+
+	@Mock
+	private PolarisConfigProperties polarisConfigProperties;
+	@Mock
+	private PolarisContextProperties polarisContextProperties;
+	@Mock
+	private ConfigFileService configFileService;
+	@Mock
+	private PolarisPropertySourceManager polarisPropertySourceManager;
+	@Mock
+	private Environment environment;
+
+	private final String testNamespace = "testNamespace";
+	private final String testServiceName = "testServiceName";
+
+	@Test
+	public void testLoadApplicationPropertiesFile() {
+		PolarisConfigFileLocator locator = new PolarisConfigFileLocator(polarisConfigProperties, polarisContextProperties,
+				configFileService, polarisPropertySourceManager, environment);
+
+		when(polarisContextProperties.getNamespace()).thenReturn(testNamespace);
+		when(polarisContextProperties.getService()).thenReturn(testServiceName);
+
+		// application.properties
+		Map<String, Object> applicationProperties = new HashMap<>();
+		applicationProperties.put("k1", "v1");
+		applicationProperties.put("k2", "v2");
+		applicationProperties.put("k3", "v3");
+		ConfigKVFile propertiesFile = new MockedConfigKVFile(applicationProperties);
+		when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "application.properties"))
+				.thenReturn(propertiesFile);
+
+		Map<String, Object> emptyMap = new HashMap<>();
+		ConfigKVFile emptyConfigFile = new MockedConfigKVFile(emptyMap);
+		when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "application.yml")).thenReturn(emptyConfigFile);
+		when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "bootstrap.properties")).thenReturn(emptyConfigFile);
+		when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "bootstrap.yml")).thenReturn(emptyConfigFile);
+
+		when(polarisConfigProperties.getGroups()).thenReturn(null);
+		when(environment.getActiveProfiles()).thenReturn(new String[] {});
+
+		PropertySource<?> propertySource = locator.locate(environment);
+
+		Assert.assertEquals("v1", propertySource.getProperty("k1"));
+		Assert.assertEquals("v2", propertySource.getProperty("k2"));
+		Assert.assertEquals("v3", propertySource.getProperty("k3"));
+	}
+
+	@Test
+	public void testActiveProfileFilesPriorityBiggerThanDefault() {
+		PolarisConfigFileLocator locator = new PolarisConfigFileLocator(polarisConfigProperties, polarisContextProperties,
+				configFileService, polarisPropertySourceManager, environment);
+
+		when(polarisContextProperties.getNamespace()).thenReturn(testNamespace);
+		when(polarisContextProperties.getService()).thenReturn(testServiceName);
+
+		// application.properties
+		Map<String, Object> applicationProperties = new HashMap<>();
+		applicationProperties.put("k1", "v1");
+		applicationProperties.put("k2", "v2");
+		applicationProperties.put("k3", "v3");
+		ConfigKVFile propertiesFile = new MockedConfigKVFile(applicationProperties);
+		when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "application.properties"))
+				.thenReturn(propertiesFile);
+
+		// application-dev.properties
+		Map<String, Object> devProperties = new HashMap<>();
+		devProperties.put("k1", "v11");
+		ConfigKVFile devFile = new MockedConfigKVFile(devProperties);
+		when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "application-dev.properties"))
+				.thenReturn(devFile);
+
+		Map<String, Object> emptyMap = new HashMap<>();
+		ConfigKVFile emptyConfigFile = new MockedConfigKVFile(emptyMap);
+		when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "application.yml")).thenReturn(emptyConfigFile);
+		when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "application-dev.yml")).thenReturn(emptyConfigFile);
+		when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "bootstrap.properties")).thenReturn(emptyConfigFile);
+		when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "bootstrap-dev.properties")).thenReturn(emptyConfigFile);
+		when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "bootstrap.yml")).thenReturn(emptyConfigFile);
+		when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "bootstrap-dev.yml")).thenReturn(emptyConfigFile);
+
+		when(polarisConfigProperties.getGroups()).thenReturn(null);
+		when(environment.getActiveProfiles()).thenReturn(new String[] {"dev"});
+
+		PropertySource<?> propertySource = locator.locate(environment);
+
+		Assert.assertEquals("v11", propertySource.getProperty("k1"));
+		Assert.assertEquals("v2", propertySource.getProperty("k2"));
+		Assert.assertEquals("v3", propertySource.getProperty("k3"));
+	}
+
+	@Test
+	public void testGetCustomFiles() {
+		PolarisConfigFileLocator locator = new PolarisConfigFileLocator(polarisConfigProperties, polarisContextProperties,
+				configFileService, polarisPropertySourceManager, environment);
+
+		when(polarisContextProperties.getNamespace()).thenReturn(testNamespace);
+		when(polarisContextProperties.getService()).thenReturn(testServiceName);
+
+		Map<String, Object> emptyMap = new HashMap<>();
+		ConfigKVFile emptyConfigFile = new MockedConfigKVFile(emptyMap);
+
+		when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "application.properties")).thenReturn(emptyConfigFile);
+		when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "application.yml")).thenReturn(emptyConfigFile);
+		when(configFileService.getConfigPropertiesFile(testNamespace, testServiceName, "bootstrap.properties")).thenReturn(emptyConfigFile);
+		when(configFileService.getConfigYamlFile(testNamespace, testServiceName, "bootstrap.yml")).thenReturn(emptyConfigFile);
+
+		List<ConfigFileGroup> customFiles = new LinkedList<>();
+		ConfigFileGroup configFileGroup = new ConfigFileGroup();
+		String customGroup = "group1";
+		configFileGroup.setName(customGroup);
+		String customFile1 = "file1.properties";
+		String customFile2 = "file2.properties";
+		configFileGroup.setFiles(Lists.newArrayList(customFile1, customFile2));
+		customFiles.add(configFileGroup);
+
+		when(polarisConfigProperties.getGroups()).thenReturn(customFiles);
+		when(environment.getActiveProfiles()).thenReturn(new String[] {});
+
+		// file1.properties
+		Map<String, Object> file1Map = new HashMap<>();
+		file1Map.put("k1", "v1");
+		file1Map.put("k2", "v2");
+		ConfigKVFile file1 = new MockedConfigKVFile(file1Map);
+		when(configFileService.getConfigPropertiesFile(testNamespace, customGroup, customFile1)).thenReturn(file1);
+
+		// file2.properties
+		Map<String, Object> file2Map = new HashMap<>();
+		file2Map.put("k1", "v11");
+		file2Map.put("k3", "v3");
+		ConfigKVFile file2 = new MockedConfigKVFile(file2Map);
+		when(configFileService.getConfigPropertiesFile(testNamespace, customGroup, customFile2)).thenReturn(file2);
+
+		PropertySource<?> propertySource = locator.locate(environment);
+
+		Assert.assertEquals("v1", propertySource.getProperty("k1"));
+		Assert.assertEquals("v2", propertySource.getProperty("k2"));
+		Assert.assertEquals("v3", propertySource.getProperty("k3"));
+	}
+}

spring-cloud-starter-tencent-polaris-config/src/test/java/com/tencent/cloud/polaris/config/adapter/PolarisPropertiesSourceAutoRefresherTest.java

@@ -0,0 +1,122 @@
+/*
+ * 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.polaris.config.adapter;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import com.google.common.collect.Lists;
+import com.tencent.cloud.polaris.config.config.PolarisConfigProperties;
+import com.tencent.polaris.configuration.api.core.ChangeType;
+import com.tencent.polaris.configuration.api.core.ConfigKVFileChangeEvent;
+import com.tencent.polaris.configuration.api.core.ConfigPropertyChangeInfo;
+import org.junit.Assert;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnitRunner;
+
+import org.springframework.cloud.context.refresh.ContextRefresher;
+
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+
+/**
+ * test for {@link PolarisPropertySourceAutoRefresher}
+ *@author lepdou 2022-06-11
+ */
+@RunWith(MockitoJUnitRunner.class)
+public class PolarisPropertiesSourceAutoRefresherTest {
+
+	@Mock
+	private PolarisConfigProperties polarisConfigProperties;
+	@Mock
+	private PolarisPropertySourceManager polarisPropertySourceManager;
+	@Mock
+	private ContextRefresher contextRefresher;
+
+	private final String testNamespace = "testNamespace";
+	private final String testServiceName = "testServiceName";
+	private final String testFileName = "application.properties";
+
+	@Test
+	public void testConfigFileChanged() {
+		PolarisPropertySourceAutoRefresher refresher = new PolarisPropertySourceAutoRefresher(polarisConfigProperties,
+				polarisPropertySourceManager, contextRefresher);
+
+		when(polarisConfigProperties.isAutoRefresh()).thenReturn(true);
+
+		Map<String, Object> content = new HashMap<>();
+		content.put("k1", "v1");
+		content.put("k2", "v2");
+		content.put("k3", "v3");
+		MockedConfigKVFile file = new MockedConfigKVFile(content);
+		PolarisPropertySource polarisPropertySource = new PolarisPropertySource(testNamespace, testServiceName, testFileName,
+				file, content);
+
+		when(polarisPropertySourceManager.getAllPropertySources()).thenReturn(Lists.newArrayList(polarisPropertySource));
+
+		ConfigPropertyChangeInfo changeInfo = new ConfigPropertyChangeInfo("k1", "v1", "v11", ChangeType.MODIFIED);
+		ConfigPropertyChangeInfo changeInfo2 = new ConfigPropertyChangeInfo("k4", null, "v4", ChangeType.ADDED);
+		ConfigPropertyChangeInfo changeInfo3 = new ConfigPropertyChangeInfo("k2", "v2", null, ChangeType.DELETED);
+		Map<String, ConfigPropertyChangeInfo> changeInfos = new HashMap<>();
+		changeInfos.put("k1", changeInfo);
+		changeInfos.put("k2", changeInfo3);
+		changeInfos.put("k4", changeInfo2);
+
+		ConfigKVFileChangeEvent event = new ConfigKVFileChangeEvent(changeInfos);
+		refresher.onApplicationEvent(null);
+
+		file.fireChangeListener(event);
+
+		Assert.assertEquals("v11", polarisPropertySource.getProperty("k1"));
+		Assert.assertEquals("v3", polarisPropertySource.getProperty("k3"));
+		Assert.assertNull(polarisPropertySource.getProperty("k2"));
+		Assert.assertEquals("v4", polarisPropertySource.getProperty("k4"));
+		verify(contextRefresher).refresh();
+	}
+
+	@Test
+	public void testNewConfigFile() {
+		PolarisPropertySourceAutoRefresher refresher = new PolarisPropertySourceAutoRefresher(polarisConfigProperties,
+				polarisPropertySourceManager, contextRefresher);
+
+		when(polarisConfigProperties.isAutoRefresh()).thenReturn(true);
+
+		Map<String, Object> emptyContent = new HashMap<>();
+		MockedConfigKVFile file = new MockedConfigKVFile(emptyContent);
+		PolarisPropertySource polarisPropertySource = new PolarisPropertySource(testNamespace, testServiceName, testFileName,
+				file, emptyContent);
+
+		when(polarisPropertySourceManager.getAllPropertySources()).thenReturn(Lists.newArrayList(polarisPropertySource));
+
+		ConfigPropertyChangeInfo changeInfo = new ConfigPropertyChangeInfo("k1", null, "v1", ChangeType.ADDED);
+		Map<String, ConfigPropertyChangeInfo> changeInfos = new HashMap<>();
+		changeInfos.put("k1", changeInfo);
+
+		ConfigKVFileChangeEvent event = new ConfigKVFileChangeEvent(changeInfos);
+		refresher.onApplicationEvent(null);
+
+		file.fireChangeListener(event);
+
+		Assert.assertEquals("v1", polarisPropertySource.getProperty("k1"));
+		verify(contextRefresher).refresh();
+	}
+
+}