com.opentable.kafka.builders.MockKafkaBuilderFactoryBean Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of otj-kafka Show documentation
Kafka integrations component
There is a newer version: 5.2.12
/*
 * 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.opentable.kafka.builders;

import java.util.Optional;

import com.codahale.metrics.MetricRegistry;

import org.springframework.core.env.ConfigurableEnvironment;

import com.opentable.service.ServiceInfo;
/**
 * Use if you absolutely positively don't have a Spring Environment for your tests.
 * Generally this means a problem in your tests, but this can be handy
 *
 * Methods below need "ConfigurableEnvironment" - If you import spring-tests, you may use MockEnvironment
 */
public class MockKafkaBuilderFactoryBean extends KafkaBuilderFactoryBean {
    /**
     * Most complex but general constructor
     * @param environmentProvider Use SettableEnvironmentProvider for mocks. It's part of otj-kafka main package
     * @param env Use MockEnvironment for Mocks, it's part of spring-tests
     * @param serviceInfo Mock this
     * @param metricRegistry Most of the time pass, Optional.empty()
     */
    @SuppressWarnings("OptionalUsedAsFieldOrParameterType")
    public MockKafkaBuilderFactoryBean(final EnvironmentProvider environmentProvider, final ConfigurableEnvironment env, final Optional serviceInfo, final Optional metricRegistry) {
        super(environmentProvider, env, serviceInfo, metricRegistry);
    }

    /**
     * Return with  MockEnvironment injected, and no Metrics
     * @param environment Use MockEnvironment from spring-tests
     * @param environmentProvider Use SettableEnvironmentProvider for mocks. It's part of otj-kafka main package
     * @param serviceInfo Mock this - it's just a lambda
     * @return your bean
     */
    public static MockKafkaBuilderFactoryBean mock(final ConfigurableEnvironment environment, final EnvironmentProvider environmentProvider, ServiceInfo serviceInfo) {
        return new MockKafkaBuilderFactoryBean(environmentProvider, environment, Optional.ofNullable(serviceInfo), Optional.empty());
    }

    /**
     * If you are ok with all fake values, no metrics etc, this is the quick and dirty way
     *  @param environment Use MockEnvironment from spring-tests
     * @return your bean
     */
    public static MockKafkaBuilderFactoryBean mock(ConfigurableEnvironment environment) {
        return mock(environment, new SettableEnvironmentProvider("mock-service",
                "mock-host", 1,"mock-env", null), () -> "nock-service");
    }
}