Back to Repositories

Implementing Integration Testing Framework for Apollo Portal Web Endpoints in apolloconfig/apollo

This abstract integration test class establishes the foundation for testing Apollo Portal’s web endpoints. It configures Spring Boot test environment with random port allocation and sets up REST template for HTTP interactions.

Test Coverage Overview

The test suite provides comprehensive coverage for Apollo Portal’s REST endpoints and web functionality.

Handles HTTP request/response testing across Portal endpoints
Supports both successful and error scenarios through DefaultResponseErrorHandler
Enables testing of authorization-skipped configurations
Covers dynamic port allocation for parallel test execution

Implementation Analysis

The implementation utilizes Spring Boot’s test framework with JUnit4 integration.

Key patterns include:

Abstract base class pattern for test reusability
TestRestTemplate configuration for HTTP testing
Dynamic URL construction using injected server port
Profile-based test configuration using ‘test’ profile

Technical Details

SpringJUnit4ClassRunner for test execution
SpringBootTest with RANDOM_PORT configuration
TestRestTemplate for HTTP requests
DefaultResponseErrorHandler for error handling
PostConstruct initialization
Value injection for server port

Best Practices Demonstrated

The test class exemplifies several testing best practices for Spring Boot applications.

Separation of concerns through abstract base class
Environment isolation using test profile
Flexible port management for concurrent testing
Proper initialization sequence using PostConstruct
Clean URL handling through helper methods

apolloconfig/apollo

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


import com.ctrip.framework.apollo.SkipAuthorizationConfiguration;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Value;
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 = {
    PortalApplication.class,
    SkipAuthorizationConfiguration.class
}, webEnvironment = WebEnvironment.RANDOM_PORT)
public abstract class AbstractIntegrationTest {

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

  @PostConstruct
  private void postConstruct() {
    System.setProperty("spring.profiles.active", "test");
    restTemplate.setErrorHandler(new DefaultResponseErrorHandler());
  }

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

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