Back to Repositories

Implementing Spring Boot Integration Testing Framework in Apollo Config

This abstract integration test class establishes the foundational testing infrastructure for Apollo’s business layer. It provides a standardized test environment with Spring Boot configuration and transaction management for comprehensive integration testing.

Test Coverage Overview

The test suite provides comprehensive integration testing coverage for Apollo’s business components.

Focuses on transaction management and rollback functionality
Tests application configuration across different environments
Covers namespace and cluster management scenarios
Validates cross-component integration points

Implementation Analysis

The implementation utilizes Spring’s testing framework with JUnit4 integration.

Uses SpringJUnit4ClassRunner for test execution
Implements automatic transaction rollback for test isolation
Configures random port allocation for web environment testing
Defines constant test parameters for consistent testing scenarios

Technical Details

Key technical components include:

Spring Boot Test framework with WebEnvironment.RANDOM_PORT
@Transactional annotation for database operation management
@Rollback for automatic test data cleanup
BizTestConfiguration class for test-specific Spring configuration
Predefined constants for APP_ID, CLUSTER_NAME, NAMESPACE_NAME, and BRANCH_NAME

Best Practices Demonstrated

The test class exemplifies several testing best practices:

Abstract base class pattern for reusable test configuration
Clean test isolation through transaction management
Consistent test data handling with predefined constants
Proper separation of concerns between test configuration and test cases
Integration with Spring Boot’s testing infrastructure

apolloconfig/apollo

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

import org.junit.runner.RunWith;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.test.annotation.Rollback;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.transaction.annotation.Transactional;

@RunWith(SpringJUnit4ClassRunner.class)
@Rollback
@Transactional
@SpringBootTest(
    classes = BizTestConfiguration.class,
    webEnvironment = WebEnvironment.RANDOM_PORT
)
public abstract class AbstractIntegrationTest {

  protected static final String APP_ID = "kl-app";
  protected static final String CLUSTER_NAME = "default";
  protected static final String NAMESPACE_NAME = "application";
  protected static final String BRANCH_NAME = "default";

}