Back to Repositories

Testing Nacos Registration Customization in Spring Cloud Alibaba

This test suite validates the customization capabilities of Nacos service registration in Spring Cloud Alibaba. It focuses on testing the NacosRegistrationCustomizer interface implementation and metadata modification functionality.

Test Coverage Overview

The test suite provides comprehensive coverage of Nacos registration customization functionality.

Key areas tested include:

Service registration metadata customization
Auto-configuration integration
NacosFactory initialization
Registration property handling

Edge cases cover proper initialization and cleanup of mocked Nacos services.

Implementation Analysis

The testing approach utilizes Spring Boot test infrastructure with MockedStatic for Nacos service simulation.

Key patterns include:

Static mocking of NacosFactory
Custom configuration class implementation
Autowired component testing
Property-based configuration testing

Technical Details

Testing tools and configuration:

JUnit Jupiter for test execution
Mockito for service mocking
SpringBootTest with random port configuration
AutoConfiguration imports for Nacos discovery
Custom TestConfig class for registration customization

Best Practices Demonstrated

The test implementation showcases several testing best practices for Spring Cloud services.

Notable practices include:

Proper test isolation using mocked services
Clean resource management with @AfterAll
Configuration separation using test-specific config class
Explicit assertion validation

alibaba/spring-cloud-alibaba

spring-cloud-alibaba-starters/spring-cloud-starter-alibaba-nacos-discovery/src/test/java/com/alibaba/cloud/nacos/registry/NacosRegistrationCustomizerTest.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.nacos.registry;

import java.util.Map;
import java.util.Properties;

import com.alibaba.cloud.nacos.discovery.NacosDiscoveryClientConfiguration;
import com.alibaba.nacos.api.NacosFactory;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;
import org.mockito.Mockito;

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.cloud.client.serviceregistry.AutoServiceRegistrationConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import static org.mockito.ArgumentMatchers.any;
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;

/**
 * @author L.cm
 */
@SpringBootTest(classes = NacosRegistrationCustomizerTest.TestConfig.class,
		properties = { "spring.application.name=myTestService1",
				"spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848" },
		webEnvironment = RANDOM_PORT)
public class NacosRegistrationCustomizerTest {

	@Autowired
	private NacosAutoServiceRegistration nacosAutoServiceRegistration;

	private static MockedStatic<NacosFactory> nacosFactoryMockedStatic;
	static {
		nacosFactoryMockedStatic = Mockito.mockStatic(NacosFactory.class);
		nacosFactoryMockedStatic.when(() -> NacosFactory.createNamingService((Properties) any()))
				.thenReturn(new MockNamingService());
	}
	@AfterAll
	public static void finished() {
		if (nacosFactoryMockedStatic != null) {
			nacosFactoryMockedStatic.close();
		}
	}


	@Test
	public void contextLoads() throws Exception {
		NacosRegistration registration = nacosAutoServiceRegistration.getRegistration();
		Map<String, String> metadata = registration.getMetadata();
		Assertions.assertEquals("test1", metadata.get("test1"));
	}

	@Configuration
	@EnableAutoConfiguration
	@ImportAutoConfiguration({ AutoServiceRegistrationConfiguration.class,
			NacosDiscoveryClientConfiguration.class,
			NacosServiceRegistryAutoConfiguration.class })
	public static class TestConfig {

		@Bean
		public NacosRegistrationCustomizer nacosRegistrationCustomizer() {
			return registration -> {
				Map<String, String> metadata = registration.getMetadata();
				metadata.put("test1", "test1");
			};
		}

	}

}