Back to Repositories

Validating Nacos Configuration Management in Spring Cloud Alibaba

This comprehensive test suite validates the Nacos configuration functionality in Spring Cloud Alibaba, focusing on configuration loading, refresh mechanisms, and endpoint operations. The tests ensure proper integration between Spring Cloud and Nacos Config Service while verifying configuration properties handling and automatic refresh capabilities.

Test Coverage Overview

The test suite provides extensive coverage of Nacos configuration management functionality:

Configuration loading and property verification
Extension config handling and validation
Shared configuration management
Config service integration testing
Endpoint functionality verification

Implementation Analysis

The testing approach utilizes Spring Boot Test framework with JUnit Jupiter for comprehensive configuration testing. It implements mock configurations, service initialization, and verification patterns specific to Nacos integration. The tests leverage @SpringBootTest for context loading and @TestExtend for timeout management.

Key patterns include config publishing, retrieval validation, and property assertion checks.

Technical Details

Testing tools and configuration:

JUnit Jupiter test framework
Spring Boot Test infrastructure
Nacos Config Factory and Service
Custom TestExtend annotation for timeout handling
Mock configuration data with YAML format
Automated property verification mechanisms

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Proper test isolation and setup
Comprehensive configuration verification
Clear test organization with @BeforeEach and @Test annotations
Thorough assertion coverage
Effective use of Spring Boot test configurations
Proper exception handling and timeout management

alibaba/spring-cloud-alibaba

spring-cloud-alibaba-tests/nacos-tests/nacos-config-test/src/test/java/com/alibaba/cloud/tests/nacos/config/NacosConfigurationTests.java

            
/*
 * Copyright 2013-2023 the original author or authors.
 *
 * 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
 *
 *      https://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.alibaba.cloud.tests.nacos.config;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Properties;

import com.alibaba.cloud.nacos.NacosConfigAutoConfiguration;
import com.alibaba.cloud.nacos.NacosConfigBootstrapConfiguration;
import com.alibaba.cloud.nacos.NacosConfigManager;
import com.alibaba.cloud.nacos.NacosConfigProperties;
import com.alibaba.cloud.nacos.endpoint.NacosConfigEndpoint;
import com.alibaba.cloud.nacos.endpoint.NacosConfigEndpointAutoConfiguration;
import com.alibaba.cloud.nacos.refresh.NacosRefreshHistory;
import com.alibaba.cloud.testsupport.TestExtend;
import com.alibaba.nacos.api.PropertyKeyConst;
import com.alibaba.nacos.api.config.ConfigFactory;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.exception.NacosException;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Disabled;
import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.annotation.Configuration;

import static com.alibaba.cloud.testsupport.Constant.TIME_OUT;
import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.NONE;

//@SpringCloudAlibaba(composeFiles = "docker/nacos-compose-test.yml", serviceName = "nacos-standalone")
@TestExtend(time = 4 * TIME_OUT)
@SpringBootTest(classes = NacosConfigurationTests.TestConfig.class, webEnvironment = NONE, properties = {
		"spring.application.name=myTestService1",
		"spring.profiles.active=dev,test",
		"spring.cloud.nacos.config.server-addr=127.0.0.1:8848",
		"spring.cloud.nacos.config.username=nacos",
		"spring.cloud.nacos.config.password=nacos",
		"spring.cloud.nacos.config.encode=utf-8",
		"spring.cloud.nacos.config.timeout=1000",
		"spring.cloud.nacos.config.file-extension=properties",
		"spring.cloud.nacos.config.extension-configs[0].data-id=ext-config-common01.properties",
		"spring.cloud.nacos.config.extension-configs[1].data-id=ext-config-common02.properties",
		"spring.cloud.nacos.config.extension-configs[1].group=GLOBAL_GROUP",
		"spring.cloud.nacos.config.shared-dataids=common1.properties,common2.properties",
		"spring.cloud.bootstrap.enabled=true"})
@Disabled("Does not work with the new nacos config load process")
public class NacosConfigurationTests {

	/**
	 * nacos upload conf file.
	 */
	public static final String YAML_CONTENT = "configdata:\n" + "  user:\n"
			+ "    age: 22\n" + "    name: freeman1123\n" + "    map:\n"
			+ "      hobbies:\n" + "        - art\n" + "        - programming\n"
			+ "        - movie\n" + "      intro: Hello, I'm freeman\n"
			+ "      extra: yo~\n" + "    users:\n" + "      - name: dad\n"
			+ "        age: 20\n" + "      - name: mom\n" + "        age: 18";

	@Autowired
	private NacosConfigProperties nacosConfigProperties;

	@Autowired
	private NacosRefreshHistory refreshHistory;

	private ConfigService remoteService;

	private NacosConfigManager nacosConfigManager;

	@BeforeAll
	public static void setUp() {

	}

	public static List<NacosConfigProperties.Config> mockExtConfigs() {
		List<NacosConfigProperties.Config> mockConfig = new ArrayList<>();
		NacosConfigProperties.Config config1 = new NacosConfigProperties.Config();
		config1.setDataId("ext-config-common01.properties");
		config1.setGroup("DEFAULT_GROUP");
		config1.setRefresh(false);
		NacosConfigProperties.Config config2 = new NacosConfigProperties.Config();
		config2.setDataId("ext-config-common02.properties");
		config2.setGroup("GLOBAL_GROUP");
		config2.setRefresh(false);
		mockConfig.add(config1);
		mockConfig.add(config2);
		return mockConfig;
	}

	@BeforeEach
	public void prepare() throws NacosException {
		Properties nacosSettings = new Properties();
		String serverAddress = "127.0.0.1:8848";
		nacosSettings.put(PropertyKeyConst.SERVER_ADDR, serverAddress);
		nacosSettings.put(PropertyKeyConst.USERNAME, "nacos");
		nacosSettings.put(PropertyKeyConst.PASSWORD, "nacos");

		remoteService = ConfigFactory.createConfigService(nacosSettings);
		nacosConfigManager = new NacosConfigManager(nacosConfigProperties);
	}

	@Test
	public void contextLoads() throws NacosException, InterruptedException {
		ConfigService localService = nacosConfigManager.getConfigService();
		updateConfig();
		Thread.sleep(2000L);
		String localContent = fetchConfig(localService, "nacos-config-refresh.yml",
				"DEFAULT_GROUP", TIME_OUT);
		String remoteContent = fetchConfig(remoteService, "nacos-config-refresh.yml",
				"DEFAULT_GROUP", TIME_OUT);
		Assertions.assertEquals(localContent, remoteContent);
		List<NacosConfigProperties.Config> mockConfig = mockExtConfigs();
		List<NacosConfigProperties.Config> extConfig = nacosConfigProperties
				.getExtensionConfigs();
		Assertions.assertArrayEquals(extConfig.toArray(), mockConfig.toArray());

		assertThat(nacosConfigProperties.getServerAddr()).isEqualTo("127.0.0.1:8848");
		assertThat(nacosConfigProperties.getFileExtension()).isEqualTo("properties");
		assertThat(nacosConfigProperties.getTimeout()).isEqualTo(1000);
		assertThat(nacosConfigProperties.getEncode()).isEqualTo("utf-8");
		assertThat(nacosConfigProperties.getUsername()).isEqualTo("nacos");
		assertThat(nacosConfigProperties.getSharedConfigs() != null);
		assertThat(nacosConfigProperties.getSharedConfigs()).contains(
				new NacosConfigProperties.Config("common1.properties"),
				new NacosConfigProperties.Config("common2.properties"));

		checkoutEndpoint();

	}

	private String fetchConfig(ConfigService configService, String dataId, String group, long timeoutMs) throws NacosException {
		return configService.getConfig(dataId, group, timeoutMs);
	}

	private void updateConfig() throws NacosException {
		remoteService.publishConfig("nacos-config-refresh.yml", "DEFAULT_GROUP",
				YAML_CONTENT, "yaml");
	}

	private void checkoutEndpoint() throws NacosException {
		NacosConfigEndpoint nacosConfigEndpoint = new NacosConfigEndpoint(nacosConfigProperties,
				refreshHistory);
		Map<String, Object> map = nacosConfigEndpoint.invoke();
		assertThat(nacosConfigProperties).isEqualTo(map.get("NacosConfigProperties"));
		assertThat(refreshHistory.getRecords()).isEqualTo(map.get("RefreshHistory"));
	}

	@Configuration
	@EnableAutoConfiguration
	@ImportAutoConfiguration({NacosConfigEndpointAutoConfiguration.class,
			NacosConfigAutoConfiguration.class, NacosConfigBootstrapConfiguration.class})
	public static class TestConfig {

	}
}