notification/src/test/java/org/apache/atlas/hook/AtlasTopicCreatorTest.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 kafka.utils.ZkUtils;
import org.apache.commons.configuration.Configuration;
import org.testng.annotations.Test;

import java.util.HashMap;
import java.util.Map;

import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.times;
import static org.mockito.Mockito.verify;
import static org.mockito.Mockito.when;
import static org.testng.Assert.assertFalse;
import static org.testng.Assert.assertTrue;

public class AtlasTopicCreatorTest {

    @Test
    public void shouldNotCreateAtlasTopicIfNotConfiguredToDoSo() {

        Configuration configuration = mock(Configuration.class);
        when(configuration.getBoolean(AtlasTopicCreator.ATLAS_NOTIFICATION_CREATE_TOPICS_KEY, true)).
                thenReturn(false);
        when(configuration.getString("atlas.authentication.method.kerberos")).thenReturn("false");
        final boolean[] topicExistsCalled = new boolean[] {false};
        AtlasTopicCreator atlasTopicCreator = new AtlasTopicCreator() {
            @Override
            protected boolean ifTopicExists(String topicName, ZkUtils zkUtils) {
                topicExistsCalled[0] = true;
                return false;
            }
        };
        atlasTopicCreator.createAtlasTopic(configuration, "ATLAS_HOOK");
        assertFalse(topicExistsCalled[0]);
    }

    @Test
    public void shouldNotCreateTopicIfItAlreadyExists() {
        Configuration configuration = mock(Configuration.class);
        when(configuration.getBoolean(AtlasTopicCreator.ATLAS_NOTIFICATION_CREATE_TOPICS_KEY, true)).
                thenReturn(true);
        when(configuration.getString("atlas.authentication.method.kerberos")).thenReturn("false");
        final ZkUtils zookeeperUtils = mock(ZkUtils.class);
        final boolean[] topicExistsCalled = new boolean[]{false};
        final boolean[] createTopicCalled = new boolean[]{false};

        AtlasTopicCreator atlasTopicCreator = new AtlasTopicCreator() {
            @Override
            protected boolean ifTopicExists(String topicName, ZkUtils zkUtils) {
                topicExistsCalled[0] = true;
                return true;
            }

            @Override
            protected ZkUtils createZkUtils(Configuration atlasProperties) {
                return zookeeperUtils;
            }

            @Override
            protected void createTopic(Configuration atlasProperties, String topicName, ZkUtils zkUtils) {
                createTopicCalled[0] = true;
            }
        };
        atlasTopicCreator.createAtlasTopic(configuration, "ATLAS_HOOK");
        assertTrue(topicExistsCalled[0]);
        assertFalse(createTopicCalled[0]);
    }

    @Test
    public void shouldCreateTopicIfItDoesNotExist() {
        Configuration configuration = mock(Configuration.class);
        when(configuration.getBoolean(AtlasTopicCreator.ATLAS_NOTIFICATION_CREATE_TOPICS_KEY, true)).
                thenReturn(true);
        when(configuration.getString("atlas.authentication.method.kerberos")).thenReturn("false");
        final ZkUtils zookeeperUtils = mock(ZkUtils.class);

        final boolean[] createdTopic = new boolean[]{false};

        AtlasTopicCreator atlasTopicCreator = new AtlasTopicCreator() {
            @Override
            protected boolean ifTopicExists(String topicName, ZkUtils zkUtils) {
                return false;
            }

            @Override
            protected ZkUtils createZkUtils(Configuration atlasProperties) {
                return zookeeperUtils;
            }

            @Override
            protected void createTopic(Configuration atlasProperties, String topicName, ZkUtils zkUtils) {
                createdTopic[0] = true;
            }
        };
        atlasTopicCreator.createAtlasTopic(configuration, "ATLAS_HOOK");
        assertTrue(createdTopic[0]);
    }

    @Test
    public void shouldNotFailIfExceptionOccursDuringCreatingTopic() {
        Configuration configuration = mock(Configuration.class);
        when(configuration.getBoolean(AtlasTopicCreator.ATLAS_NOTIFICATION_CREATE_TOPICS_KEY, true)).
                thenReturn(true);
        when(configuration.getString("atlas.authentication.method.kerberos")).thenReturn("false");
        final ZkUtils zookeeperUtils = mock(ZkUtils.class);
        final boolean[] createTopicCalled = new boolean[]{false};

        AtlasTopicCreator atlasTopicCreator = new AtlasTopicCreator() {
            @Override
            protected boolean ifTopicExists(String topicName, ZkUtils zkUtils) {
                return false;
            }

            @Override
            protected ZkUtils createZkUtils(Configuration atlasProperties) {
                return zookeeperUtils;
            }

            @Override
            protected void createTopic(Configuration atlasProperties, String topicName, ZkUtils zkUtils) {
                createTopicCalled[0] = true;
                throw new RuntimeException("Simulating failure during creating topic");
            }
        };
        atlasTopicCreator.createAtlasTopic(configuration, "ATLAS_HOOK");
        assertTrue(createTopicCalled[0]);
    }

    @Test
    public void shouldCreateMultipleTopics() {
        Configuration configuration = mock(Configuration.class);
        when(configuration.getBoolean(AtlasTopicCreator.ATLAS_NOTIFICATION_CREATE_TOPICS_KEY, true)).
                thenReturn(true);
        when(configuration.getString("atlas.authentication.method.kerberos")).thenReturn("false");
        final ZkUtils zookeeperUtils = mock(ZkUtils.class);

        final Map<String, Boolean> createdTopics = new HashMap<>();
        createdTopics.put("ATLAS_HOOK", false);
        createdTopics.put("ATLAS_ENTITIES", false);

        AtlasTopicCreator atlasTopicCreator = new AtlasTopicCreator() {

            @Override
            protected boolean ifTopicExists(String topicName, ZkUtils zkUtils) {
                return false;
            }

            @Override
            protected ZkUtils createZkUtils(Configuration atlasProperties) {
                return zookeeperUtils;
            }

            @Override
            protected void createTopic(Configuration atlasProperties, String topicName, ZkUtils zkUtils) {
                createdTopics.put(topicName, true);
            }
        };
        atlasTopicCreator.createAtlasTopic(configuration, "ATLAS_HOOK", "ATLAS_ENTITIES");
        assertTrue(createdTopics.get("ATLAS_HOOK"));
        assertTrue(createdTopics.get("ATLAS_ENTITIES"));
    }

    @Test
    public void shouldCreateTopicEvenIfEarlierOneFails() {
        Configuration configuration = mock(Configuration.class);
        when(configuration.getBoolean(AtlasTopicCreator.ATLAS_NOTIFICATION_CREATE_TOPICS_KEY, true)).
                thenReturn(true);
        when(configuration.getString("atlas.authentication.method.kerberos")).thenReturn("false");
        final ZkUtils zookeeperUtils = mock(ZkUtils.class);

        final Map<String, Boolean> createdTopics = new HashMap<>();
        createdTopics.put("ATLAS_ENTITIES", false);

        AtlasTopicCreator atlasTopicCreator = new AtlasTopicCreator() {

            @Override
            protected boolean ifTopicExists(String topicName, ZkUtils zkUtils) {
                return false;
            }

            @Override
            protected ZkUtils createZkUtils(Configuration atlasProperties) {
                return zookeeperUtils;
            }

            @Override
            protected void createTopic(Configuration atlasProperties, String topicName, ZkUtils zkUtils) {
                if (topicName.equals("ATLAS_HOOK")) {
                    throw new RuntimeException("Simulating failure when creating ATLAS_HOOK topic");
                } else {
                    createdTopics.put(topicName, true);
                }
            }
        };
        atlasTopicCreator.createAtlasTopic(configuration, "ATLAS_HOOK", "ATLAS_ENTITIES");
        assertTrue(createdTopics.get("ATLAS_ENTITIES"));
    }

    @Test
    public void shouldCloseResources() {
        Configuration configuration = mock(Configuration.class);
        when(configuration.getBoolean(AtlasTopicCreator.ATLAS_NOTIFICATION_CREATE_TOPICS_KEY, true)).
                thenReturn(true);
        when(configuration.getString("atlas.authentication.method.kerberos")).thenReturn("false");
        final ZkUtils zookeeperUtils = mock(ZkUtils.class);

        AtlasTopicCreator atlasTopicCreator = new AtlasTopicCreator() {
            @Override
            protected boolean ifTopicExists(String topicName, ZkUtils zkUtils) {
                return false;
            }

            @Override
            protected ZkUtils createZkUtils(Configuration atlasProperties) {
                return zookeeperUtils;
            }

            @Override
            protected void createTopic(Configuration atlasProperties, String topicName, ZkUtils zkUtils) {
            }
        };
        atlasTopicCreator.createAtlasTopic(configuration, "ATLAS_HOOK", "ATLAS_ENTITIES");

        verify(zookeeperUtils, times(1)).close();
    }

    @Test
    public void shouldNotProcessTopicCreationIfSecurityFails() {
        Configuration configuration = mock(Configuration.class);
        when(configuration.getBoolean(AtlasTopicCreator.ATLAS_NOTIFICATION_CREATE_TOPICS_KEY, true)).
                thenReturn(true);
        final ZkUtils zookeeperUtils = mock(ZkUtils.class);
        final Map<String, Boolean> createdTopics = new HashMap<>();
        createdTopics.put("ATLAS_HOOK", false);
        createdTopics.put("ATLAS_ENTITIES", false);

        AtlasTopicCreator atlasTopicCreator = new AtlasTopicCreator() {
            @Override
            protected boolean ifTopicExists(String topicName, ZkUtils zkUtils) {
                return false;
            }

            @Override
            protected ZkUtils createZkUtils(Configuration atlasProperties) {
                return zookeeperUtils;
            }

            @Override
            protected void createTopic(Configuration atlasProperties, String topicName, ZkUtils zkUtils) {
                createdTopics.put(topicName, true);
            }

            @Override
            protected boolean handleSecurity(Configuration atlasProperties) {
                return false;
            }
        };
        atlasTopicCreator.createAtlasTopic(configuration, "ATLAS_HOOK", "ATLAS_ENTITIES");
        assertFalse(createdTopics.get("ATLAS_HOOK"));
        assertFalse(createdTopics.get("ATLAS_ENTITIES"));
    }
}