io.streamthoughts.kafka.specs.validations.TopicConfigKeysValidation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jikkou Show documentation

A command-line tool to help you automate the management of the configurations that live on your Apache Kafka clusters.

There is a newer version: 0.30.0

/*
 * Copyright 2021 StreamThoughts.
 *
 * 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 io.streamthoughts.kafka.specs.validations;

import io.streamthoughts.kafka.specs.config.JikkouConfig;
import io.streamthoughts.kafka.specs.error.ConfigException;
import io.streamthoughts.kafka.specs.model.V1TopicObject;
import io.vavr.collection.Array;
import io.vavr.collection.List;
import io.vavr.control.Option;
import io.vavr.control.Try;
import org.apache.kafka.common.config.TopicConfig;
import org.jetbrains.annotations.NotNull;

import java.util.Map;

/**
 * A {@link TopicValidation} implementation to verify that all config-keys for a topic are valid.
 *
 * @see TopicConfig
 */
public class TopicConfigKeysValidation extends TopicValidation {

    /**
     * {@inheritDoc}
     */
    @Override
    public void configure(@NotNull final JikkouConfig config) throws ConfigException {
        super.configure(config);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void validateTopic(final @NotNull V1TopicObject topic) throws ValidationException {

        final Array definedStaticConfigKeys = Array
                .of(TopicConfig.class.getDeclaredFields())
                .flatMap(f -> f.trySetAccessible() ? Try.of(() -> f.get(null).toString()).toOption() : Option.none());

        final Map topicConfigs = topic.configs().toMap();
        final List errors = List
                .ofAll(topicConfigs.entrySet())
                .flatMap(e -> definedStaticConfigKeys.contains(e.getKey()) ?
                        Option.none() :
                        Option.of(newValidationError(topic.name(), e.getKey()))
                );

        if (!errors.isEmpty()) {
            throw new ValidationException(errors.toJavaList());
        }
    }

    @NotNull
    private ValidationException newValidationError(final @NotNull String topicName,
                                                   final @NotNull String configKey) {
        var message = String.format("Config key '%s' for topic '%s' is not valid", configKey, topicName);
        return new ValidationException(message, this);
    }
}