Back to Repositories

Testing ElasticSearch DAO Base Operations in Conductor-OSS

This test suite establishes a base framework for testing ElasticSearch integration in the Conductor workflow engine. It provides essential setup and teardown functionality for ElasticSearch client connections and index management, enabling consistent test environments for derived test classes.

Test Coverage Overview

The test suite provides comprehensive coverage of ElasticSearch client lifecycle management and index operations.

Client connection setup and configuration testing
Index cleanup and management verification
Transport client configuration validation
Error handling for index operations

Implementation Analysis

The testing approach implements a base test class pattern using JUnit framework features for consistent test initialization and cleanup. It leverages Spring’s RetryTemplate for robust ElasticSearch operations and implements proper resource management through @Before, @After, and @AfterClass annotations.

The implementation focuses on containerized testing using TestContainers for ElasticSearch instance management.

Technical Details

Testing tools and configuration:

JUnit test framework for lifecycle management
TestContainers for ElasticSearch containerization
TransportClient for ES6 connectivity
Spring RetryTemplate for operation resilience
Custom properties configuration for test environment

Best Practices Demonstrated

The test suite exemplifies several testing best practices for distributed systems testing.

Proper resource cleanup after test execution
Containerized test environment for isolation
Abstract base class pattern for test reusability
Comprehensive error handling and recovery
Clear separation of setup and teardown responsibilities

conductor-oss/conductor

es6-persistence/src/test/java/com/netflix/conductor/es6/dao/index/ElasticSearchDaoBaseTest.java

            
/*
 * Copyright 2022 Conductor Authors.
 * <p>
 * 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
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * 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.netflix.conductor.es6.dao.index;

import java.net.InetAddress;
import java.util.concurrent.ExecutionException;

import org.elasticsearch.action.admin.indices.delete.DeleteIndexRequest;
import org.elasticsearch.client.transport.TransportClient;
import org.elasticsearch.cluster.metadata.IndexMetaData;
import org.elasticsearch.common.collect.ImmutableOpenMap;
import org.elasticsearch.common.settings.Settings;
import org.elasticsearch.common.transport.TransportAddress;
import org.elasticsearch.transport.client.PreBuiltTransportClient;
import org.junit.After;
import org.junit.AfterClass;
import org.junit.Before;
import org.springframework.retry.support.RetryTemplate;

abstract class ElasticSearchDaoBaseTest extends ElasticSearchTest {

    protected TransportClient elasticSearchClient;
    protected ElasticSearchDAOV6 indexDAO;

    @Before
    public void setup() throws Exception {
        int mappedPort = container.getMappedPort(9300);
        properties.setUrl("tcp://localhost:" + mappedPort);

        Settings settings =
                Settings.builder().put("client.transport.ignore_cluster_name", true).build();

        elasticSearchClient =
                new PreBuiltTransportClient(settings)
                        .addTransportAddress(
                                new TransportAddress(
                                        InetAddress.getByName("localhost"), mappedPort));

        indexDAO =
                new ElasticSearchDAOV6(
                        elasticSearchClient, new RetryTemplate(), properties, objectMapper);
        indexDAO.setup();
    }

    @AfterClass
    public static void closeClient() {
        container.stop();
    }

    @After
    public void tearDown() {
        deleteAllIndices();

        if (elasticSearchClient != null) {
            elasticSearchClient.close();
        }
    }

    private void deleteAllIndices() {
        ImmutableOpenMap<String, IndexMetaData> indices =
                elasticSearchClient
                        .admin()
                        .cluster()
                        .prepareState()
                        .get()
                        .getState()
                        .getMetaData()
                        .getIndices();
        indices.forEach(
                cursor -> {
                    try {
                        elasticSearchClient
                                .admin()
                                .indices()
                                .delete(new DeleteIndexRequest(cursor.value.getIndex().getName()))
                                .get();
                    } catch (InterruptedException | ExecutionException e) {
                        throw new RuntimeException(e);
                    }
                });
    }
}