org.testcontainers.utility.AuditLogger Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of testcontainers Show documentation
Isolated container management for Java code testing
There is a newer version: 1.20.1
// Generated by delombok at Sun Aug 05 21:14:34 UTC 2018
package org.testcontainers.utility;

import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.github.dockerjava.api.command.DockerCmd;
import org.apache.commons.lang.StringUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.slf4j.MDC;
import java.util.List;
import static com.google.common.base.Strings.nullToEmpty;

/**
 * Logger for tracking potentially destructive actions, intended for usage in a shared Docker environment where
 * traceability is needed. This class uses SLF4J, logging at TRACE level and capturing common fields as MDC fields.
 * 
 * Users should configure their test logging to apply appropriate filters/storage so that these logs are
 * captured appropriately.
 */
public final class AuditLogger {
    @java.lang.SuppressWarnings("all")
    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(AuditLogger.class);
    private static final ObjectMapper objectMapper = new ObjectMapper();
    public static final String MDC_PREFIX = AuditLogger.class.getCanonicalName();

    public static void doLog(@NotNull String action, @Nullable String image, @Nullable String containerId, @NotNull DockerCmd cmd) {
        doLog(action, image, containerId, cmd, null);
    }

    public static void doLog(@NotNull String action, @Nullable String image, @Nullable String containerId, @NotNull DockerCmd cmd, @Nullable Exception e) {
        if (!log.isTraceEnabled()) {
            return;
        }
        MDC.put(MDC_PREFIX + ".Action", nullToEmpty(action));
        MDC.put(MDC_PREFIX + ".Image", nullToEmpty(image));
        MDC.put(MDC_PREFIX + ".ContainerId", nullToEmpty(containerId));
        try {
            MDC.put(MDC_PREFIX + ".Command", objectMapper.writeValueAsString(cmd));
        } catch (JsonProcessingException ignored) {
        }
        if (e != null) {
            MDC.put(MDC_PREFIX + ".Exception", e.getLocalizedMessage());
            log.trace("{} action with image: {}, containerId: {}", action, image, containerId, e);
        } else {
            log.trace("{} action with image: {}, containerId: {}", action, image, containerId);
        }
        MDC.remove(MDC_PREFIX + ".Action");
        MDC.remove(MDC_PREFIX + ".Image");
        MDC.remove(MDC_PREFIX + ".ContainerId");
        MDC.remove(MDC_PREFIX + ".Command");
        MDC.remove(MDC_PREFIX + ".Exception");
    }

    public static void doComposeLog(@NotNull String[] commandParts, @Nullable List env) {
        if (!log.isTraceEnabled()) {
            return;
        }
        MDC.put(MDC_PREFIX + ".Action", "COMPOSE");
        if (env != null) {
            MDC.put(MDC_PREFIX + ".Compose.Env", env.toString());
        }
        final String command = StringUtils.join(commandParts, ' ');
        MDC.put(MDC_PREFIX + ".Compose.Command", command);
        log.trace("COMPOSE action with command: {}, env: {}", command, env);
        MDC.remove(MDC_PREFIX + ".Action");
        MDC.remove(MDC_PREFIX + ".Compose.Command");
        MDC.remove(MDC_PREFIX + ".Compose.Env");
    }

    @java.lang.SuppressWarnings("all")
    private AuditLogger() {
        throw new java.lang.UnsupportedOperationException("This is a utility class and cannot be instantiated");
    }
}