Back to Repositories

Testing Cluster Controller Operations in Apollo Config

This test suite validates the ClusterController functionality in Apollo’s admin service, focusing on cluster management operations including creation, deletion, and validation. The tests ensure proper handling of default clusters and input validation for cluster operations.

Test Coverage Overview

The test suite provides comprehensive coverage of cluster management operations.

Tests default cluster deletion restrictions
Validates successful cluster deletion flows
Verifies input validation for cluster creation
Covers error handling for invalid cluster names

Implementation Analysis

The tests utilize a combination of Mockito and JUnit frameworks to implement robust verification scenarios.

The testing approach employs mock objects for ClusterService to isolate the controller layer, while using Spring’s RestTemplate for integration-style tests of the API endpoints.

Uses @Mock and @InjectMocks for dependency injection
Implements both unit and integration test patterns
Validates both positive and negative test cases

Technical Details

JUnit 4 testing framework
Mockito for service mocking
Spring Test framework integration
RestTemplate for HTTP endpoint testing
Custom AbstractControllerTest base class
InputValidator for request validation

Best Practices Demonstrated

The test suite exemplifies several testing best practices in Java enterprise applications.

Proper separation of concerns between unit and integration tests
Comprehensive error case coverage
Effective use of mocking to isolate test scope
Clear test method naming conventions
Validation of both API contracts and business rules

apolloconfig/apollo

apollo-adminservice/src/test/java/com/ctrip/framework/apollo/adminservice/controller/ClusterControllerTest.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.biz.entity.Cluster;
import com.ctrip.framework.apollo.biz.service.ClusterService;
import com.ctrip.framework.apollo.common.dto.ClusterDTO;
import com.ctrip.framework.apollo.common.exception.BadRequestException;
import com.ctrip.framework.apollo.common.utils.InputValidator;
import com.ctrip.framework.apollo.core.ConfigConsts;
import org.junit.Assert;
import org.junit.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.HttpClientErrorException;

import static org.hamcrest.Matchers.containsString;
import static org.mockito.Mockito.*;

public class ClusterControllerTest extends AbstractControllerTest {

  @InjectMocks
  private ClusterController clusterController;

  @Mock
  private ClusterService clusterService;

  @Test(expected = BadRequestException.class)
  public void testDeleteDefaultFail() {
    Cluster cluster = new Cluster();
    cluster.setName(ConfigConsts.CLUSTER_NAME_DEFAULT);
    when(clusterService.findOne(any(String.class), any(String.class))).thenReturn(cluster);
    clusterController.delete("1", "2", "d");
  }

  @Test
  public void testDeleteSuccess() {
    Cluster cluster = new Cluster();
    when(clusterService.findOne(any(String.class), any(String.class))).thenReturn(cluster);
    clusterController.delete("1", "2", "d");
    verify(clusterService, times(1)).findOne("1", "2");
  }

  @Test
  public void shouldFailWhenRequestBodyInvalid() {
    ClusterDTO cluster = new ClusterDTO();
    cluster.setAppId("valid");
    cluster.setName("notBlank");
    ResponseEntity<ClusterDTO> response =
        restTemplate.postForEntity(url("/apps/{appId}/clusters"), cluster, ClusterDTO.class, cluster.getAppId());
    ClusterDTO createdCluster = response.getBody();
    Assert.assertNotNull(createdCluster);
    Assert.assertEquals(cluster.getAppId(), createdCluster.getAppId());
    Assert.assertEquals(cluster.getName(), createdCluster.getName());

    cluster.setName("invalid app name");
    try {
      restTemplate.postForEntity(url("/apps/{appId}/clusters"), cluster, ClusterDTO.class, cluster.getAppId());
      Assert.fail("Should throw");
    } catch (HttpClientErrorException e) {
      Assert.assertThat(new String(e.getResponseBodyAsByteArray()), containsString(InputValidator.INVALID_CLUSTER_NAMESPACE_MESSAGE));
    }
  }
}