Back to Repositories

Testing Database Message Sender Implementation in Apollo Config

This test suite validates the DatabaseMessageSender component in Apollo’s messaging system, focusing on message handling and database interactions. It ensures reliable message persistence and proper error handling for Apollo’s configuration release notifications.

Test Coverage Overview

The test suite provides comprehensive coverage of the DatabaseMessageSender functionality.

Key areas tested include:

Successful message sending and persistence
Handling of unsupported message topics
Error handling during message persistence
Message content validation

Integration points with ReleaseMessageRepository are thoroughly verified through mock interactions.

Implementation Analysis

The testing approach utilizes JUnit and Mockito frameworks to isolate the DatabaseMessageSender component.

Key implementation patterns include:

Mock repository injection using @Mock annotation
ArgumentCaptor usage for message validation
Exception handling verification
Topic-based message routing validation

Technical Details

Testing infrastructure includes:

JUnit 4 test framework
Mockito mocking framework
AbstractUnitTest base class integration
ArgumentCaptor for parameter verification
Mock ReleaseMessageRepository for database interaction simulation

Best Practices Demonstrated

The test suite exemplifies several testing best practices:

Proper test isolation through mocking
Comprehensive error case coverage
Clear test method naming conventions
Efficient setup using @Before annotation
Specific assertion checks for message content
Verification of both positive and negative scenarios

apolloconfig/apollo

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

import com.ctrip.framework.apollo.biz.AbstractUnitTest;
import com.ctrip.framework.apollo.biz.entity.ReleaseMessage;
import com.ctrip.framework.apollo.biz.repository.ReleaseMessageRepository;
import org.junit.Before;
import org.junit.Test;
import org.mockito.ArgumentCaptor;
import org.mockito.Mock;

import static org.junit.Assert.assertEquals;
import static org.mockito.Mockito.*;

/**
 * @author Jason Song([email protected])
 */
public class DatabaseMessageSenderTest extends AbstractUnitTest{
  private DatabaseMessageSender messageSender;
  @Mock
  private ReleaseMessageRepository releaseMessageRepository;

  @Before
  public void setUp() throws Exception {
    messageSender = new DatabaseMessageSender(releaseMessageRepository);
  }

  @Test
  public void testSendMessage() throws Exception {
    String someMessage = "some-message";
    long someId = 1;
    ReleaseMessage someReleaseMessage = mock(ReleaseMessage.class);
    when(someReleaseMessage.getId()).thenReturn(someId);
    when(releaseMessageRepository.save(any(ReleaseMessage.class))).thenReturn(someReleaseMessage);

    ArgumentCaptor<ReleaseMessage> captor = ArgumentCaptor.forClass(ReleaseMessage.class);

    messageSender.sendMessage(someMessage, Topics.APOLLO_RELEASE_TOPIC);

    verify(releaseMessageRepository, times(1)).save(captor.capture());
    assertEquals(someMessage, captor.getValue().getMessage());
  }

  @Test
  public void testSendUnsupportedMessage() throws Exception {
    String someMessage = "some-message";
    String someUnsupportedTopic = "some-invalid-topic";

    messageSender.sendMessage(someMessage, someUnsupportedTopic);

    verify(releaseMessageRepository, never()).save(any(ReleaseMessage.class));
  }

  @Test(expected = RuntimeException.class)
  public void testSendMessageFailed() throws Exception {
    String someMessage = "some-message";
    when(releaseMessageRepository.save(any(ReleaseMessage.class))).thenThrow(new RuntimeException());

    messageSender.sendMessage(someMessage, Topics.APOLLO_RELEASE_TOPIC);
  }
}