Back to Repositories

Testing Release History Repository Implementation in Apollo Config

This test suite validates the ReleaseHistoryRepository functionality in Apollo, focusing on release history retention and pagination capabilities. It ensures proper handling of release history records and their retrieval based on various parameters.

Test Coverage Overview

The test suite provides comprehensive coverage of release history management functionality:

Pagination and ordering of release history records
Release history retention mechanisms
Record retrieval with specific filtering criteria
Boundary testing for empty and populated states

Implementation Analysis

The testing approach utilizes Spring’s test context framework with SQL scripts for test data setup and cleanup. The implementation follows a systematic pattern of testing pagination behavior and release history retention logic using precise assertions and controlled test data.

Technical Details

JUnit test framework with Spring test context
SQL scripts for test data management
Spring Data JPA for repository operations
PageRequest for pagination handling
Integration test setup with AbstractIntegrationTest base class

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Proper test data cleanup using @Sql annotations
Clear test method naming conventions
Comprehensive assertion checks
Isolation of test scenarios
Effective use of Spring testing utilities

apolloconfig/apollo

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

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

import com.ctrip.framework.apollo.biz.AbstractIntegrationTest;
import com.ctrip.framework.apollo.biz.entity.ReleaseHistory;
import java.util.List;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.test.context.jdbc.Sql;
import org.springframework.test.context.jdbc.Sql.ExecutionPhase;

/**
 * @author kl (http://kailing.pub)
 * @since 2023/3/23
 */
public class ReleaseHistoryRepositoryTest extends AbstractIntegrationTest {

  @Autowired
  private ReleaseHistoryRepository releaseHistoryRepository;

  @Test
  @Sql(scripts = "/sql/release-history-test.sql", executionPhase = ExecutionPhase.BEFORE_TEST_METHOD)
  @Sql(scripts = "/sql/clean.sql", executionPhase = ExecutionPhase.AFTER_TEST_METHOD)
  public void testFindReleaseHistoryRetentionMaxId() {
    Page<ReleaseHistory> releaseHistoryPage = releaseHistoryRepository.findByAppIdAndClusterNameAndNamespaceNameAndBranchNameOrderByIdDesc(APP_ID, CLUSTER_NAME, NAMESPACE_NAME, BRANCH_NAME, PageRequest.of(1, 1));
    assertEquals(5, releaseHistoryPage.getContent().get(0).getId());

    releaseHistoryPage = releaseHistoryRepository.findByAppIdAndClusterNameAndNamespaceNameAndBranchNameOrderByIdDesc(APP_ID, CLUSTER_NAME, NAMESPACE_NAME, BRANCH_NAME, PageRequest.of(2, 1));
    assertEquals(4, releaseHistoryPage.getContent().get(0).getId());

    releaseHistoryPage = releaseHistoryRepository.findByAppIdAndClusterNameAndNamespaceNameAndBranchNameOrderByIdDesc(APP_ID, CLUSTER_NAME, NAMESPACE_NAME, BRANCH_NAME, PageRequest.of(5, 1));
    assertEquals(1, releaseHistoryPage.getContent().get(0).getId());

    releaseHistoryRepository.deleteAll();
    releaseHistoryPage = releaseHistoryRepository.findByAppIdAndClusterNameAndNamespaceNameAndBranchNameOrderByIdDesc(APP_ID, CLUSTER_NAME, NAMESPACE_NAME, BRANCH_NAME, PageRequest.of(1, 1));
    assertTrue(releaseHistoryPage.isEmpty());
  }

  @Test
  @Sql(scripts = "/sql/release-history-test.sql", executionPhase = ExecutionPhase.BEFORE_TEST_METHOD)
  @Sql(scripts = "/sql/clean.sql", executionPhase = ExecutionPhase.AFTER_TEST_METHOD)
  public void testFindFirst100ByAppIdAndClusterNameAndNamespaceNameAndBranchNameAndIdLessThanEqualOrderByIdAsc() {

    int releaseHistoryRetentionSize = 2;
    Page<ReleaseHistory> releaseHistoryPage = releaseHistoryRepository.findByAppIdAndClusterNameAndNamespaceNameAndBranchNameOrderByIdDesc(APP_ID, CLUSTER_NAME, NAMESPACE_NAME, BRANCH_NAME, PageRequest.of(releaseHistoryRetentionSize, 1));
    long releaseMaxId = releaseHistoryPage.getContent().get(0).getId();
    List<ReleaseHistory> releaseHistories = releaseHistoryRepository.findFirst100ByAppIdAndClusterNameAndNamespaceNameAndBranchNameAndIdLessThanEqualOrderByIdAsc(
        APP_ID, CLUSTER_NAME, NAMESPACE_NAME, BRANCH_NAME, releaseMaxId);
    assertEquals(4, releaseHistories.size());

    releaseHistoryRetentionSize = 1;
    releaseHistoryPage = releaseHistoryRepository.findByAppIdAndClusterNameAndNamespaceNameAndBranchNameOrderByIdDesc(APP_ID, CLUSTER_NAME, NAMESPACE_NAME, BRANCH_NAME, PageRequest.of(releaseHistoryRetentionSize, 1));
    releaseMaxId = releaseHistoryPage.getContent().get(0).getId();
    releaseHistories = releaseHistoryRepository.findFirst100ByAppIdAndClusterNameAndNamespaceNameAndBranchNameAndIdLessThanEqualOrderByIdAsc(
        APP_ID, CLUSTER_NAME, NAMESPACE_NAME, BRANCH_NAME, releaseMaxId);
    assertEquals(5, releaseHistories.size());
  }
}