io.micronaut.management.endpoint.env.EnvironmentEndpoint Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2017-2020 original authors
 *
 * 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
 *
 * https://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.micronaut.management.endpoint.env;

import io.micronaut.context.env.Environment;
import io.micronaut.context.env.PropertySource;
import io.micronaut.core.annotation.Nullable;
import io.micronaut.management.endpoint.annotation.Endpoint;
import io.micronaut.management.endpoint.annotation.Read;
import io.micronaut.management.endpoint.annotation.Selector;
import jakarta.inject.Inject;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Comparator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

/**
 * {@link Endpoint} that displays information about the environment and its property sources.
 *
 * @author Álvaro Sánchez-Mariscal
 * @since 1.2.0
 */
@Endpoint(
    id = EnvironmentEndpoint.NAME,
    defaultEnabled = false
)
public class EnvironmentEndpoint {

    /**
     * Endpoint name.
     */
    public static final String NAME = "env";
    private static final String ACTIVE_ENVIRONMENTS_KEY = "activeEnvironments";
    private static final String PACKAGES_KEY = "packages";
    private static final String PROPERTY_SOURCES_KEY = "propertySources";
    /**
     * Default keys to be displayed.
     */
    private static final List DEFAULT_ACTIVE_SECTIONS = List.of(EnvironmentEndpoint.ACTIVE_ENVIRONMENTS_KEY,
        EnvironmentEndpoint.PACKAGES_KEY, EnvironmentEndpoint.PROPERTY_SOURCES_KEY);
    private static final String MASK_VALUE = "*****";
    private final Environment environment;
    private final EnvironmentEndpointFilter environmentFilter;
    private List activeKeys = DEFAULT_ACTIVE_SECTIONS;

    /**
     * @param environment The {@link Environment}
     */
    public EnvironmentEndpoint(Environment environment) {
        this(environment, null);
    }

    /**
     * @param environment The {@link Environment}
     * @param environmentFilter The registered {@link EnvironmentEndpointFilter} bean if one is registered
     */
    @Inject
    public EnvironmentEndpoint(Environment environment,
                               @Nullable EnvironmentEndpointFilter environmentFilter) {
        this.environment = environment;
        this.environmentFilter = environmentFilter;
    }

    /**
     * Gets the keys to be displayed by the environment endpoint.
     * Defaults to ["activeEnvironments", "packages", "propertySources"] if not configured.
     * Configurable via {@code endpoints.env.active-keys}.
     *
     * @return The list of active sections.
     */
    public List getActiveKeys() {
        return activeKeys;
    }

    /**
     * Sets the sections to be displayed by the environment endpoint.
     * Example: {@code endpoints.env.active-keys=activeEnvironments,packages}
     *
     * @param activeKeys The list of sections. If an empty list is provided, no sections will be displayed.
     */
    public void setActiveKeys(List activeKeys) {
        this.activeKeys = activeKeys;
    }

    /**
     * @return The environment information as a map with the following keys: activeEnvironments, packages and
     * propertySources.
     */
    @Read
    public Map getEnvironmentInfo() {
        EnvironmentFilterSpecification filter = createFilterSpecification();
        Map result = new LinkedHashMap<>();
        List activeKeys = getActiveKeys();

        if (activeKeys.contains(ACTIVE_ENVIRONMENTS_KEY)) {
            result.put(ACTIVE_ENVIRONMENTS_KEY, environment.getActiveNames());
        }
        if (activeKeys.contains(PACKAGES_KEY)) {
            result.put(PACKAGES_KEY, environment.getPackages());
        }

        if (activeKeys.contains(PROPERTY_SOURCES_KEY)) {
            Collection> propertySources = new ArrayList<>();
            environment.getPropertySources()
                .stream()
                .sorted(Comparator.comparing(PropertySource::getOrder))
                .map(ps -> buildPropertySourceInfo(ps, filter))
                .forEach(propertySources::add);
            result.put(PROPERTY_SOURCES_KEY, propertySources);
        }
        return result;
    }

    /**
     * @param propertySourceName The {@link PropertySource} name
     * @return a map with all the properties defined in the property source if it exists; null otherwise.
     */
    @Read
    public Map getProperties(@Selector String propertySourceName) {
        EnvironmentFilterSpecification filter = createFilterSpecification();

        return environment.getPropertySources()
            .stream()
            .filter(ps -> ps.getName().equals(propertySourceName))
            .findFirst()
            .map(ps -> buildPropertySourceInfo(ps, filter))
            .orElse(null);
    }

    private EnvironmentFilterSpecification createFilterSpecification() {
        EnvironmentFilterSpecification filter = new EnvironmentFilterSpecification();
        if (environmentFilter != null) {
            environmentFilter.specifyFiltering(filter);
        }
        return filter;
    }

    private Map getAllProperties(PropertySource propertySource, EnvironmentFilterSpecification filter) {
        Map properties = new LinkedHashMap<>();
        propertySource.forEach(k -> {
            EnvironmentFilterSpecification.FilterResult test = filter.test(k);
            if (test != EnvironmentFilterSpecification.FilterResult.HIDE) {
                properties.put(k, test == EnvironmentFilterSpecification.FilterResult.MASK ? MASK_VALUE : propertySource.get(k));
            }
        });
        return properties;
    }

    private Map buildPropertySourceInfo(PropertySource propertySource, EnvironmentFilterSpecification filter) {
        Map propertySourceInfo = new LinkedHashMap<>();
        propertySourceInfo.put("name", propertySource.getName());
        propertySourceInfo.put("order", propertySource.getOrder());
        propertySourceInfo.put("convention", propertySource.getConvention().name());
        propertySourceInfo.put("properties", getAllProperties(propertySource, filter));
        return propertySourceInfo;
    }
}