Back to Repositories

Validating Service Registry Auto-Configuration Behavior in Apollo Config

This test suite validates the Apollo service registry auto-configuration behavior when the database discovery feature is not enabled. It ensures that the absence of this feature does not interfere with the normal startup of configservice or adminservice components.

Test Coverage Overview

The test coverage focuses on verifying the non-existence of service registry-related beans when the feature is disabled. Key areas tested include:

Service registry repository and service components
Database service registry implementations
Application runners and listeners for registry management
Discovery client components

Implementation Analysis

The testing approach uses Spring Boot’s testing framework to validate bean initialization behavior. It employs a negative testing pattern to ensure certain beans are not present in the application context when the feature is disabled.

The implementation uses Spring’s ApplicationContext for bean verification and JUnit assertions to confirm the expected NoSuchBeanDefinitionException is thrown.

Technical Details

Testing tools and configuration include:

JUnit Jupiter for test execution
Spring Boot Test framework for context loading
ContextConfiguration annotation for specific configuration classes
ApplicationContext for bean presence verification
Assertions for exception validation

Best Practices Demonstrated

The test demonstrates several quality testing practices:

Clear separation of concerns in test organization
Proper use of Spring Boot test annotations
Systematic verification of multiple related components
Effective use of helper methods to reduce code duplication
Comprehensive validation of feature disablement

apolloconfig/apollo

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

import com.ctrip.framework.apollo.biz.registry.DatabaseDiscoveryClient;
import com.ctrip.framework.apollo.biz.registry.DatabaseServiceRegistry;
import com.ctrip.framework.apollo.biz.registry.configuration.support.ApolloServiceRegistryClearApplicationRunner;
import com.ctrip.framework.apollo.biz.registry.configuration.support.ApolloServiceRegistryDeregisterApplicationListener;
import com.ctrip.framework.apollo.biz.registry.configuration.support.ApolloServiceRegistryHeartbeatApplicationRunner;
import com.ctrip.framework.apollo.biz.repository.ServiceRegistryRepository;
import com.ctrip.framework.apollo.biz.service.ServiceRegistryService;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.context.ApplicationContext;
import org.springframework.test.context.ContextConfiguration;

/**
 * ensure that this feature, i.e. database discovery won't cause configservice or adminservice
 * startup fail when it doesn't enable.
 */
@SpringBootTest
@ContextConfiguration(classes = {
    ApolloServiceRegistryAutoConfiguration.class,
    ApolloServiceDiscoveryAutoConfiguration.class
})
class ApolloServiceRegistryAutoConfigurationNotEnabledTest {

  @Autowired
  private ApplicationContext context;


  private void assertNoSuchBean(Class<?> requiredType) {
    Assertions.assertThrows(
        NoSuchBeanDefinitionException.class,
        () -> context.getBean(requiredType)
    );
  }

  @Test
  void ensureNoSuchBeans() {
    assertNoSuchBean(ServiceRegistryRepository.class);
    assertNoSuchBean(ServiceRegistryService.class);
    assertNoSuchBean(DatabaseServiceRegistry.class);
    assertNoSuchBean(ApolloServiceRegistryHeartbeatApplicationRunner.class);
    assertNoSuchBean(ApolloServiceRegistryDeregisterApplicationListener.class);

    assertNoSuchBean(DatabaseDiscoveryClient.class);
    assertNoSuchBean(ApolloServiceRegistryClearApplicationRunner.class);
  }
}