Back to Repositories

Implementing Abstract Controller Testing Framework in Apollo Config

This abstract controller test class establishes the foundational testing infrastructure for Apollo’s OpenAPI controllers. It provides a standardized Spring Boot test environment with REST template configuration and port management for HTTP-based integration tests.

Test Coverage Overview

The test suite provides comprehensive coverage for REST-based controller testing in Apollo’s OpenAPI.

Key areas covered include:

HTTP message conversion handling
Dynamic port allocation for test environments
URL path resolution for test endpoints
Error handling configuration

Implementation Analysis

The testing approach utilizes Spring Boot’s test framework with JUnit4 integration. It implements a base abstract class pattern that centralizes common test infrastructure configuration.

Notable implementation features:

SpringJUnit4ClassRunner for test execution
Random port allocation for isolated testing
Configurable REST template with custom error handling
Automated message converter configuration

Technical Details

Testing tools and configuration:

Spring Boot Test framework
TestRestTemplate for HTTP requests
HttpMessageConverters for request/response handling
DefaultResponseErrorHandler for error management
@PostConstruct initialization
@Value injection for server port

Best Practices Demonstrated

The test implementation showcases several testing best practices for Spring Boot applications.

Notable practices include:

Separation of concerns through abstract base class
Automated test environment configuration
Isolated test execution with random ports
Centralized HTTP client configuration
Flexible URL generation for test cases

apolloconfig/apollo

apollo-portal/src/test/java/com/ctrip/framework/apollo/openapi/v1/controller/AbstractControllerTest.java

            
/*
 * Copyright 2024 Apollo 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
 *
 * http://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.ctrip.framework.apollo.openapi.v1.controller;

import javax.annotation.PostConstruct;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.http.HttpMessageConverters;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.web.client.TestRestTemplate;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.web.client.DefaultResponseErrorHandler;
import org.springframework.web.client.RestTemplate;

/**
 * Created by kezhenxu at 2019/1/8 18:19.
 *
 * @author kezhenxu ([email protected])
 */
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
public abstract class AbstractControllerTest {
  @Autowired
  private HttpMessageConverters httpMessageConverters;

  protected RestTemplate restTemplate = (new TestRestTemplate()).getRestTemplate();

  @PostConstruct
  protected void postConstruct() {
    restTemplate.setErrorHandler(new DefaultResponseErrorHandler());
    restTemplate.setMessageConverters(httpMessageConverters.getConverters());
  }

  @Value("${local.server.port}")
  protected int port;

  protected String url(String path) {
    return "http://localhost:" + port + path;
  }
}