dev.lajoscseppento.ruthless.plugin.logging.RuthlessLoggingPlugin Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ruthless-plugin Show documentation

Ruthless conventions for Gradle projects to keep them DRY

There is a newer version: 0.8.0

package dev.lajoscseppento.ruthless.plugin.logging;

import dev.lajoscseppento.gradle.plugin.common.property.BooleanSystemProperty;
import dev.lajoscseppento.ruthless.plugin.logging.impl.LogRecordingService;
import java.util.Map;
import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap;
import lombok.NonNull;
import org.gradle.api.Plugin;
import org.gradle.api.initialization.Settings;
import org.gradle.api.invocation.Gradle;

/**
 * The Ruthless Logging Plugin applies logging conventions to the Gradle build:
 *
 * 
 *   {@link LogRecordingService}: records the build output to file
 * 
 *
 * The plugin can be disabled via the 
 * ruthless.logging.plugin.enabled=false system property.
 */
public class RuthlessLoggingPlugin implements Plugin {

  private static final BooleanSystemProperty enabled =
      new BooleanSystemProperty("ruthless.logging.plugin.enabled", true);

  // See https://github.com/LajosCseppento/ruthless/issues/43
  private static final Map settingsById = new ConcurrentHashMap<>();

  private RuthlessLogger logger;
  private Settings settings;
  private Gradle gradle;

  @Override
  public void apply(Settings settings) {
    this.settings = settings;
    gradle = settings.getGradle();
    logger = RuthlessLogger.create(getClass());

    if (enabled.get()) {
      configureFileLogging();
    } else {
      logger.info("Ruthless logging disabled");
    }
  }

  private void configureFileLogging() {
    logger.info("Configuring file logging");

    UUID id = UUID.randomUUID();
    settingsById.put(id, settings);

    gradle
        .getSharedServices()
        .registerIfAbsent(
            "ruthless-logging",
            LogRecordingService.class,
            spec -> spec.getParameters().getId().set(id))
        .get();
  }

  public static Settings findSettingsById(@NonNull UUID id) {
    return settingsById.get(id);
  }
}