Back to Repositories

Validating Nacos Config Endpoints and Health Indicators in Spring Cloud Alibaba

This test suite validates the functionality of Nacos Config endpoints and health indicators in Spring Cloud Alibaba. It ensures proper configuration loading, health checking, and refresh history tracking for Nacos configuration services.

Test Coverage Overview

The test suite provides comprehensive coverage of Nacos Config endpoint functionality.

Key areas tested include:

Configuration properties loading and validation
Health indicator status checking
Refresh history tracking
Endpoint response structure verification

Integration points cover Spring Boot Actuator health checks and Nacos Config service interactions.

Implementation Analysis

The testing approach utilizes Spring Boot Test framework with mocked Nacos Config service instances.

Key patterns include:

Mock service responses using Mockito
Reflection-based service injection
Automated context loading verification
Builder pattern for health status checking

Technical Details

Testing tools and configuration:

JUnit Jupiter for test execution
Mockito for service mocking
AssertJ for assertions
Spring Boot Test for context management
ReflectionTestUtils for dependency injection

Configuration includes specified Nacos server address and file extensions.

Best Practices Demonstrated

The test suite exemplifies high-quality testing practices through structured test organization and comprehensive validation.

Notable practices include:

Proper test isolation
Mock service initialization
Explicit property configuration
Separate verification methods
Clear test case organization

alibaba/spring-cloud-alibaba

spring-cloud-alibaba-starters/spring-alibaba-nacos-config/src/test/java/com.alibaba.cloud.nacos/endpoint/NacosConfigEndpointTests.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.endpoint;

import java.util.Map;

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.refresh.NacosRefreshHistory;
import com.alibaba.nacos.client.config.NacosConfigService;
import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.mockito.Mockito;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.actuate.health.Health.Builder;
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 org.springframework.test.util.ReflectionTestUtils;

import static org.assertj.core.api.Assertions.assertThat;

/**
 *
 * @author xiaojing
 * @author freeman
 */
@SpringBootTest(classes = NacosConfigEndpointTests.TestConfig.class, webEnvironment = SpringBootTest.WebEnvironment.NONE, properties = {
		"spring.application.name=test-name",
		"spring.nacos.config.server-addr=127.0.0.1:8848",
		"spring.nacos.config.file-extension=properties",
		"spring.cloud.bootstrap.enabled=true" })
public class NacosConfigEndpointTests {

	@Autowired
	private NacosConfigProperties properties;

	@Autowired
	private NacosRefreshHistory refreshHistory;

	static {

		try {
			NacosConfigService mockedNacosConfigService = Mockito
					.mock(NacosConfigService.class);
			Mockito.when(mockedNacosConfigService.getServerStatus()).thenReturn("UP");
			ReflectionTestUtils.setField(NacosConfigManager.class, "service",
					mockedNacosConfigService);
		}
		catch (Exception ignore) {
			ignore.printStackTrace();
		}
	}
	@Test
	public void contextLoads() throws Exception {

		checkoutEndpoint();
		checkoutAcmHealthIndicator();

	}

	private void checkoutAcmHealthIndicator() {
		try {
			Builder builder = new Builder();

			NacosConfigHealthIndicator healthIndicator = new NacosConfigHealthIndicator(
					properties.configServiceInstance());
			healthIndicator.doHealthCheck(builder);

			Builder builder1 = new Builder();
			builder1.up();

			Assertions.assertThat(builder.build()).isEqualTo(builder1.build());
		}
		catch (Exception ignore) {

		}

	}

	private void checkoutEndpoint() throws Exception {
		NacosConfigEndpoint endpoint = new NacosConfigEndpoint(properties,
				refreshHistory);
		Map<String, Object> map = endpoint.invoke();

		assertThat(properties).isEqualTo(map.get("NacosConfigProperties"));
		assertThat(refreshHistory.getRecords()).isEqualTo(map.get("RefreshHistory"));
	}

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

	}

}