notification/src/test/java/org/apache/atlas/hook/AtlasHookTest.java

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.atlas.hook;

import org.apache.atlas.notification.NotificationException;
import org.apache.atlas.notification.NotificationInterface;
import org.apache.atlas.notification.hook.HookNotification;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import static org.mockito.Mockito.doThrow;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.verifyZeroInteractions;


public class AtlasHookTest {

    @Mock
    private NotificationInterface notificationInterface;

    @Mock
    private FailedMessagesLogger failedMessagesLogger;

    @BeforeMethod
    public void setup() {
        MockitoAnnotations.initMocks(this);
    }

    @Test (timeOut = 10000)
    public void testNotifyEntitiesDoesNotHangOnException() throws Exception {
        List<HookNotification.HookNotificationMessage> hookNotificationMessages = new ArrayList<>();
        doThrow(new NotificationException(new Exception())).when(notificationInterface)
                .send(NotificationInterface.NotificationType.HOOK, hookNotificationMessages);
        AtlasHook.notifyEntitiesInternal(hookNotificationMessages, 0, notificationInterface, false,
                failedMessagesLogger);
        // if we've reached here, the method finished OK.
    }

    @Test
    public void testNotifyEntitiesRetriesOnException() throws NotificationException {
        List<HookNotification.HookNotificationMessage> hookNotificationMessages =
                new ArrayList<HookNotification.HookNotificationMessage>() {{
                    add(new HookNotification.EntityCreateRequest("user"));
                }
            };
        doThrow(new NotificationException(new Exception())).when(notificationInterface)
                .send(NotificationInterface.NotificationType.HOOK, hookNotificationMessages);
        AtlasHook.notifyEntitiesInternal(hookNotificationMessages, 2, notificationInterface, false,
                failedMessagesLogger);

        verify(notificationInterface, times(2)).
                send(NotificationInterface.NotificationType.HOOK, hookNotificationMessages);
    }

    @Test
    public void testFailedMessageIsLoggedIfRequired() throws NotificationException {
        List<HookNotification.HookNotificationMessage> hookNotificationMessages =
                new ArrayList<HookNotification.HookNotificationMessage>() {{
                    add(new HookNotification.EntityCreateRequest("user"));
                }
            };
        doThrow(new NotificationException(new Exception(), Arrays.asList("test message")))
                .when(notificationInterface)
                .send(NotificationInterface.NotificationType.HOOK, hookNotificationMessages);
        AtlasHook.notifyEntitiesInternal(hookNotificationMessages, 2, notificationInterface, true,
                failedMessagesLogger);

        verify(failedMessagesLogger, times(1)).log("test message");
    }

    @Test
    public void testFailedMessageIsNotLoggedIfNotRequired() throws NotificationException {
        List<HookNotification.HookNotificationMessage> hookNotificationMessages = new ArrayList<>();
        doThrow(new NotificationException(new Exception(), Arrays.asList("test message")))
                .when(notificationInterface)
                .send(NotificationInterface.NotificationType.HOOK, hookNotificationMessages);
        AtlasHook.notifyEntitiesInternal(hookNotificationMessages, 2, notificationInterface, false,
                failedMessagesLogger);

        verifyZeroInteractions(failedMessagesLogger);
    }

    @Test
    public void testAllFailedMessagesAreLogged() throws NotificationException {
        List<HookNotification.HookNotificationMessage> hookNotificationMessages =
                new ArrayList<HookNotification.HookNotificationMessage>() {{
                    add(new HookNotification.EntityCreateRequest("user"));
                }
            };
        doThrow(new NotificationException(new Exception(), Arrays.asList("test message1", "test message2")))
                .when(notificationInterface)
                .send(NotificationInterface.NotificationType.HOOK, hookNotificationMessages);
        AtlasHook.notifyEntitiesInternal(hookNotificationMessages, 2, notificationInterface, true,
                failedMessagesLogger);

        verify(failedMessagesLogger, times(1)).log("test message1");
        verify(failedMessagesLogger, times(1)).log("test message2");
    }

    @Test
    public void testFailedMessageIsNotLoggedIfNotANotificationException() throws Exception {
        List<HookNotification.HookNotificationMessage> hookNotificationMessages = new ArrayList<>();
        doThrow(new RuntimeException("test message")).when(notificationInterface)
                .send(NotificationInterface.NotificationType.HOOK, hookNotificationMessages);
        AtlasHook.notifyEntitiesInternal(hookNotificationMessages, 2, notificationInterface, true,
                failedMessagesLogger);

        verifyZeroInteractions(failedMessagesLogger);
    }
}