io.streamthoughts.jikkou.kafka.validation.TopicNameRegexValidation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jikkou-provider-kafka Show documentation
Integration between Apache Kafka and Jikkou
The newest version!
/*
 * SPDX-License-Identifier: Apache-2.0
 * Copyright (c) The original authors
 *
 * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
 */
package io.streamthoughts.jikkou.kafka.validation;

import io.streamthoughts.jikkou.core.annotation.Example;
import io.streamthoughts.jikkou.core.annotation.Title;
import io.streamthoughts.jikkou.core.config.ConfigProperty;
import io.streamthoughts.jikkou.core.config.Configuration;
import io.streamthoughts.jikkou.core.exceptions.ConfigException;
import io.streamthoughts.jikkou.core.exceptions.ValidationException;
import io.streamthoughts.jikkou.core.extension.ExtensionContext;
import io.streamthoughts.jikkou.core.validation.ValidationError;
import io.streamthoughts.jikkou.core.validation.ValidationResult;
import io.streamthoughts.jikkou.kafka.models.V1KafkaTopic;
import java.util.Optional;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.jetbrains.annotations.NotNull;

@Title("TopicNameRegexValidation allows validating that topic names match a defined regex.")
@Example(
        title = "Validate topic names match with one of the defined visibility prefixes.",
        full = true,
        code = {"""
                validations:
                - name: "topicMustHaveValidName"
                  type: "io.streamthoughts.jikkou.kafka.validation.TopicNameRegexValidation"
                  priority: 100
                  config:
                    topicNameRegex: "[a-zA-Z0-9\\\\._\\\\-]+"
                """
        }
)
public class TopicNameRegexValidation extends TopicValidation {

    public static final ConfigProperty VALIDATION_TOPIC_NAME_REGEX_CONFIG = ConfigProperty
            .ofString("topicNameRegex");

    private Pattern pattern;

    /**
     * Empty constructor used by {@link Configuration}.
     */
    public TopicNameRegexValidation() {}

    /**
     * {@inheritDoc}
     */
    @Override
    public void init(@NotNull final ExtensionContext context) {
        super.init(context);
        final Optional regex = VALIDATION_TOPIC_NAME_REGEX_CONFIG.getOptional(context.appConfiguration());
        pattern = regex
                .map(pattern -> {
                    if (pattern.isEmpty()) {
                        throw new ConfigException(
                                String.format("The '%s' configuration property is set with an empty regexp",
                                        VALIDATION_TOPIC_NAME_REGEX_CONFIG.key()
                                )
                        );
                    }
                    return pattern;
                })
                .map(this::compile)
                .orElseThrow(() -> new ConfigException(
                        String.format("The '%s' configuration property is required for %s",
                                VALIDATION_TOPIC_NAME_REGEX_CONFIG.key(),
                                TopicNameRegexValidation.class.getSimpleName()
                        )
                ));

    }

    private Pattern compile(final String regex) {
        try {
            return Pattern.compile(regex);
        } catch (PatternSyntaxException e) {
            throw new ConfigException(
                    String.format("The '%s' configuration property is set with an invalid regexp '%s'",
                            VALIDATION_TOPIC_NAME_REGEX_CONFIG.key(),
                            regex
                    )
            );
        }
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public ValidationResult validate(final @NotNull V1KafkaTopic resource) throws ValidationException {
        if (!pattern.matcher(resource.getMetadata().getName()).matches()) {
            String error = String.format(
                    "Name for topic '%s' does not match the configured regex: %s",
                    resource.getMetadata().getName(),
                    pattern
            );
            return ValidationResult.failure(new ValidationError(getName(), resource, error));
        }
        return ValidationResult.success();
    }
}