Back to Repositories

Testing Admin Service Controller Infrastructure in Apollo Config

This abstract controller test class establishes the foundation for testing Apollo’s admin service REST endpoints. It provides a comprehensive test harness with configured REST templates and URL helpers for testing various API endpoints in the Apollo configuration system.

Test Coverage Overview

The test suite provides extensive coverage for Apollo’s admin service REST endpoints, focusing on namespace, application, cluster, and item operations.

Tests HTTP endpoint accessibility and responses
Covers URL path construction for different API endpoints
Validates REST template configuration and error handling
Ensures proper message converter setup

Implementation Analysis

The implementation utilizes Spring Boot’s testing framework with JUnit4 integration. It employs a base abstract class pattern to provide common testing infrastructure across all controller tests.

Key technical aspects include:

SpringBootTest configuration with random port assignment
TestRestTemplate setup with custom error handling
HTTP message converter configuration
URL helper methods for endpoint testing

Technical Details

Testing tools and configuration:

Spring Boot Test framework
JUnit4 with SpringJUnit4ClassRunner
TestRestTemplate for HTTP requests
HttpMessageConverters for request/response handling
Dynamic port allocation for test isolation
Custom DefaultResponseErrorHandler implementation

Best Practices Demonstrated

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

Separation of concerns through abstract base class
Proper test isolation using random ports
Centralized test configuration management
Reusable helper methods for URL construction
Structured setup of REST testing infrastructure
Clean error handling configuration

apolloconfig/apollo

apollo-adminservice/src/test/java/com/ctrip/framework/apollo/adminservice/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.adminservice.controller;

import com.ctrip.framework.apollo.AdminServiceTestConfiguration;

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.context.SpringBootTest.WebEnvironment;
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;

import javax.annotation.PostConstruct;

@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = AdminServiceTestConfiguration.class, webEnvironment = WebEnvironment.RANDOM_PORT)
public abstract class AbstractControllerTest {

  @Autowired
  private HttpMessageConverters httpMessageConverters;

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

  @PostConstruct
  private 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;
  }

  protected String namespaceBaseUrl() {
    return url("/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName:.+}");
  }

  protected String appBaseUrl() {
    return url("/apps/{appId}");
  }

  protected String clusterBaseUrl() {
    return url("/apps/{appId}/clusters/{clusterName}");
  }

  protected String itemBaseUrl(){
    return url("/apps/{appId}/clusters/{clusterName}/namespaces/{namespaceName}/items");
  }
}