Back to Repositories

Validating Nacos Service Registration IP Configuration in Spring Cloud Alibaba

This test suite validates the IP address configuration and auto-registration functionality in Nacos Discovery for Spring Cloud Alibaba. It ensures proper service registration with custom IP addresses and verifies the integration between Spring Cloud and Nacos service discovery components.

Test Coverage Overview

The test suite provides comprehensive coverage of Nacos service registration IP configuration.

Key areas tested include:

Service registration with custom IP address
Auto-registration initialization
NacosDiscoveryProperties configuration validation
Integration with Spring Cloud’s auto-registration mechanism

Implementation Analysis

The testing approach utilizes Spring Boot test framework with MockedStatic for Nacos factory isolation. The tests leverage Spring’s dependency injection and configuration management to validate service registration behavior.

Key patterns include:

Mock NamingService implementation
Property-based configuration testing
Component autowiring verification
Assertion-based validation

Technical Details

Testing tools and configuration:

JUnit Jupiter for test execution
Mockito for static method mocking
AssertJ for assertions
Spring Boot Test for context management
Random port configuration for web environment
Custom TestConfig with auto-configuration imports

Best Practices Demonstrated

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

Notable practices include:

Proper test isolation using mocks
Clear test configuration separation
Comprehensive component validation
Effective use of Spring Boot test annotations
Clean teardown with @AfterAll

alibaba/spring-cloud-alibaba

spring-cloud-alibaba-starters/spring-cloud-starter-alibaba-nacos-discovery/src/test/java/com/alibaba/cloud/nacos/registry/NacosAutoServiceRegistrationIpTests.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 = NacosAutoServiceRegistrationIpTests.TestConfig.class,
		properties = { "spring.application.name=myTestService1",
				"spring.cloud.nacos.discovery.server-addr=127.0.0.1:8848",
				"spring.cloud.nacos.discovery.ip=123.123.123.123" },
		webEnvironment = RANDOM_PORT)
public class NacosAutoServiceRegistrationIpTests {

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

		checkoutNacosDiscoveryServiceIP();
	}

	private void checkoutNacosDiscoveryServiceIP() {
		assertThat(registration.getHost()).isEqualTo("123.123.123.123");
	}

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

	}

}