Back to Repositories

Testing Sentinel RestTemplate Integration in Spring Cloud Alibaba

A comprehensive test suite for validating the Sentinel integration with Spring RestTemplate, focusing on error handling, fallback mechanisms, and URL cleaning functionality. The tests verify proper configuration and behavior of Sentinel’s circuit breaking capabilities in a Spring Cloud environment.

Test Coverage Overview

This test suite provides extensive coverage of Sentinel’s RestTemplate integration functionality:

Fallback method and class configuration validation
Block handler implementation verification
URL cleaner functionality testing
Bean creation exception scenarios
Normal operation validation with various configurations

Implementation Analysis

The testing approach employs Spring’s AnnotationConfigApplicationContext to validate bean creation and configuration:

Multiple test configurations (TestConfig1-14) to cover different scenarios
Verification of proper exception handling through @Test(expected=…) annotations
Validation of SentinelRestTemplate annotation processing

Technical Details

Key technical components include:

JUnit test framework integration
Spring ApplicationContext configuration
SentinelBeanPostProcessor for RestTemplate customization
Custom exception utilities for handling blocks and fallbacks
URL cleaning utility implementation

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Comprehensive edge case coverage
Clear test method naming conventions
Proper separation of test configurations
Thorough validation of error scenarios
Modular test organization with distinct configuration classes

alibaba/spring-cloud-alibaba

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

import com.alibaba.cloud.sentinel.annotation.SentinelRestTemplate;
import com.alibaba.cloud.sentinel.custom.SentinelBeanPostProcessor;
import com.alibaba.cloud.sentinel.rest.SentinelClientHttpResponse;
import com.alibaba.csp.sentinel.slots.block.BlockException;
import org.junit.Test;

import org.springframework.beans.factory.BeanCreationException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.HttpRequest;
import org.springframework.http.client.ClientHttpRequestExecution;
import org.springframework.web.client.RestTemplate;

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

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

	@Test(expected = BeanCreationException.class)
	public void testFbkMethod() {
		new AnnotationConfigApplicationContext(TestConfig1.class);
	}

	@Test(expected = BeanCreationException.class)
	public void testFbkClass() {
		new AnnotationConfigApplicationContext(TestConfig2.class);
	}

	@Test(expected = BeanCreationException.class)
	public void testblkMethod() {
		new AnnotationConfigApplicationContext(TestConfig3.class);
	}

	@Test(expected = BeanCreationException.class)
	public void testblkClass() {
		new AnnotationConfigApplicationContext(TestConfig4.class);
	}

	@Test
	public void testNormal() {
		AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(
				TestConfig5.class);
		assertThat(context.getBeansOfType(RestTemplate.class).size()).isEqualTo(1);
	}

	@Test(expected = BeanCreationException.class)
	public void testBlkMethodExists() {
		new AnnotationConfigApplicationContext(TestConfig6.class);
	}

	@Test(expected = BeanCreationException.class)
	public void testFbkMethodExists() {
		new AnnotationConfigApplicationContext(TestConfig7.class);
	}

	@Test(expected = BeanCreationException.class)
	public void testBlkReturnValue() {
		new AnnotationConfigApplicationContext(TestConfig8.class);
	}

	@Test(expected = BeanCreationException.class)
	public void testFbkReturnValue() {
		new AnnotationConfigApplicationContext(TestConfig9.class);
	}

	@Test
	public void testNormalWithoutParam() {
		new AnnotationConfigApplicationContext(TestConfig10.class);
	}

	@Test(expected = BeanCreationException.class)
	public void testUrlClnMethod() {
		new AnnotationConfigApplicationContext(TestConfig11.class);
	}

	@Test(expected = BeanCreationException.class)
	public void testUrlClnClass() {
		new AnnotationConfigApplicationContext(TestConfig12.class);
	}

	@Test(expected = BeanCreationException.class)
	public void testUrlClnMethodExists() {
		new AnnotationConfigApplicationContext(TestConfig13.class);
	}

	@Test(expected = BeanCreationException.class)
	public void testUrlClnReturnValue() {
		new AnnotationConfigApplicationContext(TestConfig14.class);
	}

	@Configuration
	public static class TestConfig1 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(fallback = "fbk")
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig2 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(fallbackClass = ExceptionUtil.class)
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig3 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(blockHandler = "blk")
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig4 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(blockHandlerClass = ExceptionUtil.class)
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig5 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(
				blockHandlerClass = SentinelRestTemplateTests.ExceptionUtil.class,
				blockHandler = "handleException",
				fallbackClass = SentinelRestTemplateTests.ExceptionUtil.class,
				fallback = "fallbackException",
				urlCleanerClass = SentinelRestTemplateTests.UrlCleanUtil.class,
				urlCleaner = "clean")
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig6 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(
				blockHandlerClass = SentinelRestTemplateTests.ExceptionUtil.class,
				blockHandler = "handleException1")
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig7 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(
				fallbackClass = SentinelRestTemplateTests.ExceptionUtil.class,
				fallback = "fallbackException1")
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig8 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(
				blockHandlerClass = SentinelRestTemplateTests.ExceptionUtil.class,
				blockHandler = "handleException2")
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig9 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(
				fallbackClass = SentinelRestTemplateTests.ExceptionUtil.class,
				fallback = "fallbackException2")
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig10 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

		@Bean
		@SentinelRestTemplate
		RestTemplate restTemplate2() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig11 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(urlCleaner = "cln")
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig12 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(urlCleanerClass = UrlCleanUtil.class)
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig13 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(
				urlCleanerClass = SentinelRestTemplateTests.UrlCleanUtil.class,
				urlCleaner = "clean1")
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	@Configuration
	public static class TestConfig14 {

		@Bean
		SentinelBeanPostProcessor sentinelBeanPostProcessor(
				ApplicationContext applicationContext) {
			return new SentinelBeanPostProcessor(applicationContext);
		}

		@Bean
		@SentinelRestTemplate(
				urlCleanerClass = SentinelRestTemplateTests.UrlCleanUtil.class,
				urlCleaner = "clean2")
		RestTemplate restTemplate() {
			return new RestTemplate();
		}

	}

	public static class ExceptionUtil {

		public static SentinelClientHttpResponse handleException(HttpRequest request,
				byte[] body, ClientHttpRequestExecution execution, BlockException ex) {
			System.out.println("Oops: " + ex.getClass().getCanonicalName());
			return new SentinelClientHttpResponse("Oops");
		}

		public static void handleException2(HttpRequest request, byte[] body,
				ClientHttpRequestExecution execution, BlockException ex) {
			System.out.println("Oops: " + ex.getClass().getCanonicalName());
		}

		public static SentinelClientHttpResponse fallbackException(HttpRequest request,
				byte[] body, ClientHttpRequestExecution execution, BlockException ex) {
			System.out.println("Oops: " + ex.getClass().getCanonicalName());
			return new SentinelClientHttpResponse("Oops fallback");
		}

		public static void fallbackException2(HttpRequest request, byte[] body,
				ClientHttpRequestExecution execution, BlockException ex) {
			System.out.println("Oops: " + ex.getClass().getCanonicalName());
		}

	}

	public static class UrlCleanUtil {

		public static String clean(String url) {
			return url;
		}

		public static void clean2(String url) {
		}

	}

}