Back to Repositories

Validating Nacos Configuration Extensions in Spring Cloud Alibaba

This test suite validates Nacos configuration extension functionality in Spring Cloud Alibaba, focusing on external configuration loading and property management. The tests verify configuration loading, property overrides, and integration with Nacos Config Service.

Test Coverage Overview

The test suite provides comprehensive coverage of Nacos configuration extension capabilities.

Key areas tested include:

External configuration file loading and validation
Configuration property management across different groups
Integration with Nacos Config Service for remote configuration
Configuration refresh and update mechanisms

Implementation Analysis

The testing approach utilizes Spring Boot Test framework with JUnit Jupiter for validation of Nacos configuration features.

Notable patterns include:

Docker-based test environment setup using compose files
Mock configuration data generation
Asynchronous configuration updates and verification
Property comparison between local and remote services

Technical Details

Testing infrastructure includes:

Spring Boot Test framework for context loading
JUnit Jupiter test runner
Docker composition for Nacos server instance
NacosConfigProperties for configuration management
ConfigService for remote configuration operations

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Proper test isolation using Docker containers
Comprehensive configuration validation
Clear separation of test setup and execution
Proper resource cleanup and management
Effective use of assertions for validation

alibaba/spring-cloud-alibaba

spring-cloud-alibaba-tests/nacos-tests/nacos-config-test/src/test/java/com/alibaba/cloud/tests/nacos/config/NacosConfigurationExtConfigTests.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.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.NacosConfigEndpointAutoConfiguration;
import com.alibaba.cloud.testsupport.SpringCloudAlibaba;
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.springframework.boot.test.context.SpringBootTest.WebEnvironment.NONE;

@SpringCloudAlibaba(composeFiles = "docker/nacos-compose-test.yml", serviceName = "nacos-standalone")
@TestExtend(time = 4 * TIME_OUT)
@SpringBootTest(classes = NacosConfigurationExtConfigTests.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 NacosConfigurationExtConfigTests {

	/**
	 * 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;

	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());

	}

	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");
	}

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

	}
}