Back to Repositories

Validating RocketMQ Binder Auto-Configuration in Spring Cloud Alibaba

This test suite validates the auto-configuration functionality of RocketMQ binder in Spring Cloud Alibaba, focusing on property configurations and message ordering capabilities. The tests ensure proper initialization of RocketMQ components and verify the correct application of consumer configurations.

Test Coverage Overview

The test suite provides comprehensive coverage of RocketMQ binder auto-configuration functionality.

Validates name server configuration properties
Tests consumer group configurations
Verifies message ordering settings
Checks subscription tag configurations

Implementation Analysis

The testing approach utilizes Spring Boot’s ApplicationContextRunner for configuration validation. The implementation leverages Spring Cloud Alibaba’s test support framework with Docker composition for RocketMQ standalone setup.

Uses @SpringCloudAlibaba annotation for container management
Implements @TestExtend for timeout handling
Employs AssertJ for assertion checks

Technical Details

JUnit Jupiter test framework
Spring Boot Test context framework
Docker compose for RocketMQ standalone instance
ApplicationContextRunner for configuration testing
Custom test support annotations (@SpringCloudAlibaba, @TestExtend)

Best Practices Demonstrated

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

Isolation of test environment using Docker containers
Clear separation of configuration and test logic
Proper use of Spring Boot test utilities
Comprehensive property validation
Structured test organization with setup methods

alibaba/spring-cloud-alibaba

spring-cloud-alibaba-tests/rocketmq-tests/rocketmq-stream-test/src/test/java/com/alibaba/cloud/stream/binder/rocketmq/RocketMQAutoConfigurationTests.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.stream.binder.rocketmq;

import com.alibaba.cloud.stream.binder.rocketmq.autoconfigurate.RocketMQBinderAutoConfiguration;
import com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQBinderConfigurationProperties;
import com.alibaba.cloud.stream.binder.rocketmq.properties.RocketMQExtendedBindingProperties;
import com.alibaba.cloud.testsupport.SpringCloudAlibaba;
import com.alibaba.cloud.testsupport.TestExtend;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.context.annotation.Configuration;

import static com.alibaba.cloud.testsupport.Constant.TIME_OUT;
import static org.assertj.core.api.Assertions.assertThat;
import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.NONE;

@SpringCloudAlibaba(composeFiles = "docker/rocket-compose-test.yml", serviceName = "rocketmq-standalone")
@TestExtend(time = 6 * TIME_OUT)
@SpringBootTest(classes = RocketMQAutoConfigurationTests.TestConfig.class, webEnvironment = NONE, properties = {
		"spring.cloud.stream.rocketmq.binder.name-server=127.0.0.1:9876,127.0.0.1:9877",
		"spring.cloud.stream.bindings.output.destination=TopicOrderTest",
		"spring.cloud.stream.bindings.output.content-type=application/json",

		"spring.cloud.stream.bindings.input1.destination=TopicOrderTest",
		"spring.cloud.stream.bindings.input1.content-type=application/json",
		"spring.cloud.stream.bindings.input1.group=test-group1",
		"spring.cloud.stream.rocketmq.bindings.input1.consumer.push.orderly=true",
		"spring.cloud.stream.bindings.input1.consumer.maxAttempts=1",
		"spring.cloud.stream.bindings.input2.destination=TopicOrderTest",
		"spring.cloud.stream.bindings.input2.content-type=application/json",
		"spring.cloud.stream.bindings.input2.group=test-group2",
		"spring.cloud.stream.rocketmq.bindings.input2.consumer.push.orderly=false",
		"spring.cloud.stream.rocketmq.bindings.input2.consumer.subscription=tag1" })
public class RocketMQAutoConfigurationTests {

	@Autowired
	private RocketMQBinderConfigurationProperties binderConfigurationProperties;
	@Autowired
	private RocketMQExtendedBindingProperties bindingProperties;

	private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
			.withConfiguration(
					AutoConfigurations.of(RocketMQBinderAutoConfiguration.class));

	@BeforeAll
	public static void setUp() {

	}

	@BeforeEach
	public void prepare() {

	}

	@Test
	public void testProperties() {
		this.contextRunner.run(context -> {
			assertThat(binderConfigurationProperties.getNameServer())
					.isEqualTo("127.0.0.1:9876,127.0.0.1:9877");
			assertThat(bindingProperties.getExtendedConsumerProperties("input2")
					.getSubscription()).isEqualTo("tag1");
			assertThat(bindingProperties.getExtendedConsumerProperties("input2").getPush()
					.getOrderly()).isFalse();
			assertThat(bindingProperties.getExtendedConsumerProperties("input1").getPush()
					.getOrderly()).isTrue();
		});
	}

	@Configuration
	@EnableAutoConfiguration
	@ImportAutoConfiguration({RocketMQBinderAutoConfiguration.class })
	public static class TestConfig {

	}
}