Back to Repositories

Validating Nacos Auto-Service Registration Management in Spring Cloud Alibaba

This test suite validates the auto-service registration functionality for Nacos Discovery in Spring Cloud Alibaba, specifically focusing on management port configuration and metadata handling. It ensures proper integration between Spring Boot’s management endpoints and Nacos service discovery.

Test Coverage Overview

The test suite provides comprehensive coverage of Nacos auto-service registration with management port configuration.

Key areas tested include:

Management port configuration (8888)
Management context path setup (/test-context-path)
Service metadata validation
Integration with Spring Boot’s auto-configuration
Proper initialization of NacosRegistration components

Implementation Analysis

The testing approach utilizes Spring Boot’s test framework with a specific focus on auto-configuration validation. The implementation leverages Mockito for NacosFactory mocking, ensuring isolated testing of the registration process.

Technical patterns include:

Static mocking of NacosFactory
Property-based configuration testing
Component autowiring verification
Metadata assertion checks

Technical Details

Testing tools and configuration:

JUnit Jupiter for test execution
Mockito for service mocking
SpringBootTest with RANDOM_PORT configuration
AssertJ for assertions
Custom TestConfig with auto-configuration imports
Mock NamingService implementation

Best Practices Demonstrated

The test suite exemplifies several testing best practices in Spring Cloud microservices testing.

Notable practices include:

Proper test isolation through mocking
Comprehensive configuration testing
Clear test method organization
Proper resource cleanup in @AfterAll
Explicit verification of auto-configuration behavior
Thorough metadata validation

alibaba/spring-cloud-alibaba

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

import com.alibaba.cloud.nacos.NacosDiscoveryProperties;
import com.alibaba.cloud.nacos.discovery.NacosDiscoveryClientConfiguration;
import com.alibaba.nacos.api.NacosFactory;
import org.junit.jupiter.api.AfterAll;
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.Configuration;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.ArgumentMatchers.any;
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT;

/**
 * @author xiaojing
 */

@SpringBootTest(
		classes = NacosAutoServiceRegistrationManagementPortTests.TestConfig.class,
		properties = { "spring.application.name=myTestService1",
				"management.server.port=8888",
				"management.server.servlet.context-path=/test-context-path",
				"spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848",
				"spring.cloud.nacos.discovery.port=8888" },
		webEnvironment = RANDOM_PORT)
public class NacosAutoServiceRegistrationManagementPortTests {

	@Autowired
	private NacosRegistration registration;

	@Autowired
	private NacosAutoServiceRegistration nacosAutoServiceRegistration;

	@Autowired
	private NacosDiscoveryProperties properties;

	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 {
		assertThat(registration).isNotNull();
		assertThat(properties).isNotNull();
		assertThat(nacosAutoServiceRegistration).isNotNull();

		checkoutNacosDiscoveryManagementData();
	}

	private void checkoutNacosDiscoveryManagementData() {
		assertThat(properties.getMetadata().get(NacosRegistration.MANAGEMENT_PORT))
				.isEqualTo("8888");
		assertThat(
				properties.getMetadata().get(NacosRegistration.MANAGEMENT_CONTEXT_PATH))
						.isEqualTo("/test-context-path");
	}

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

	}

}