Back to Repositories

Testing Nacos DataSource Factory Implementation in Spring Cloud Alibaba

This test suite validates the functionality of NacosDataSourceFactoryBean in Spring Cloud Alibaba’s Sentinel implementation. It ensures proper configuration and behavior of Nacos data source integration with Sentinel for dynamic rule changes and property management.

Test Coverage Overview

The test suite provides comprehensive coverage of NacosDataSourceFactoryBean configuration scenarios.

Key areas tested include:

Server address configuration validation
Property management for Nacos integration
Factory bean initialization and object creation
Data source connection verification

Implementation Analysis

The testing approach utilizes JUnit 5 with Mockito for dependency isolation. Tests employ spy and mock objects to validate factory bean behavior without requiring a live Nacos server.

Implementation features:

Spy objects for partial mocking of factory beans
Mock converters for data transformation testing
Assertion-based verification using AssertJ

Technical Details

Testing tools and configuration:

JUnit Jupiter for test execution
Mockito framework for mocking
AssertJ for fluent assertions
SentinelConverter for data conversion
NacosDataSource configuration parameters

Best Practices Demonstrated

The test implementation showcases several testing best practices in Spring Cloud applications.

Notable practices include:

Isolation of external dependencies
Comprehensive property verification
Clear test method naming
Proper mock object management
Structured test organization

alibaba/spring-cloud-alibaba

spring-cloud-alibaba-starters/spring-cloud-alibaba-sentinel-datasource/src/test/java/com/alibaba/cloud/sentinel/datasource/NacosDataSourceFactoryBeanTests.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.sentinel.datasource;

import com.alibaba.cloud.sentinel.datasource.converter.SentinelConverter;
import com.alibaba.cloud.sentinel.datasource.factorybean.NacosDataSourceFactoryBean;
import com.alibaba.csp.sentinel.datasource.Converter;
import com.alibaba.csp.sentinel.datasource.nacos.NacosDataSource;
import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThat;
import static org.mockito.Mockito.doReturn;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.spy;
import static org.mockito.Mockito.when;

/**
 * @author <a href="mailto:[email protected]">Jim</a>
 */
public class NacosDataSourceFactoryBeanTests {

	private String dataId = "sentinel";

	private String groupId = "DEFAULT_GROUP";

	private String serverAddr = "127.0.0.1:8848";

	private String contextPath = "/my-nacos";

	private String accessKey = "ak";

	private String secretKey = "sk";

	private String endpoint = "endpoint";

	private String namespace = "namespace";

	@Test
	public void testNacosFactoryBeanServerAddr() throws Exception {
		NacosDataSourceFactoryBean factoryBean = spy(new NacosDataSourceFactoryBean());

		Converter converter = mock(SentinelConverter.class);

		factoryBean.setDataId(dataId);
		factoryBean.setGroupId(groupId);
		factoryBean.setServerAddr(serverAddr);
		factoryBean.setContextPath(contextPath);
		factoryBean.setConverter(converter);

		NacosDataSource nacosDataSource = mock(NacosDataSource.class);

		doReturn(nacosDataSource).when(factoryBean).getObject();
		when(nacosDataSource.readSource()).thenReturn("{}");

		assertThat(factoryBean.getObject()).isEqualTo(nacosDataSource);
		assertThat(factoryBean.getObject().readSource()).isEqualTo("{}");
		assertThat(factoryBean.getConverter()).isEqualTo(converter);
		assertThat(factoryBean.getDataId()).isEqualTo(dataId);
		assertThat(factoryBean.getGroupId()).isEqualTo(groupId);
		assertThat(factoryBean.getServerAddr()).isEqualTo(serverAddr);
		assertThat(factoryBean.getContextPath()).isEqualTo(contextPath);
	}

	@Test
	public void testNacosFactoryBeanProperties() throws Exception {
		NacosDataSourceFactoryBean factoryBean = spy(new NacosDataSourceFactoryBean());

		Converter converter = mock(SentinelConverter.class);

		factoryBean.setDataId(dataId);
		factoryBean.setGroupId(groupId);
		factoryBean.setAccessKey(accessKey);
		factoryBean.setSecretKey(secretKey);
		factoryBean.setEndpoint(endpoint);
		factoryBean.setNamespace(namespace);
		factoryBean.setConverter(converter);

		NacosDataSource nacosDataSource = mock(NacosDataSource.class);

		doReturn(nacosDataSource).when(factoryBean).getObject();
		when(nacosDataSource.readSource()).thenReturn("{}");

		assertThat(factoryBean.getObject()).isEqualTo(nacosDataSource);
		assertThat(factoryBean.getObject().readSource()).isEqualTo("{}");
		assertThat(factoryBean.getConverter()).isEqualTo(converter);
		assertThat(factoryBean.getDataId()).isEqualTo(dataId);
		assertThat(factoryBean.getGroupId()).isEqualTo(groupId);
		assertThat(factoryBean.getNamespace()).isEqualTo(namespace);
		assertThat(factoryBean.getEndpoint()).isEqualTo(endpoint);
		assertThat(factoryBean.getAccessKey()).isEqualTo(accessKey);
		assertThat(factoryBean.getSecretKey()).isEqualTo(secretKey);
	}

}