Fail build on missing or empty config

To enforce the usage of AccessTransformers when requested, the build
will now fail if the requested AccessTransformers config file is not
defined, cannot be found, or is empty.

This validation will happen after project evaluation rather than at
artifact transformation, because exceptions thrown by artifact
transforms are consumed and don't fail the build.

Also, added `AccessTransformerContainer#setLogLevel` to allow for
viewing the output stream of AccessTransformers using a different log
level.

Author: Jonathing

.github/workflows/publish.yml

@@ -5,6 +5,7 @@ on:
     branches: [ 'master' ]
     paths-ignore:
       - 'at-gradle/**'
+      - 'at-gradle-demo/**'
       - '.github/workflows/**'
       - 'docs/**'
       - 'README.md'

at-gradle-demo/build.gradle

@@ -6,6 +6,7 @@ plugins {
 java.toolchain.languageVersion = JavaLanguageVersion.of(17)
 
 accessTransformers.register {
+    logLevel = LogLevel.LIFECYCLE
     config = project.file('accesstransformer.cfg')
 }
 

at-gradle-demo/settings.gradle

@@ -11,7 +11,7 @@ pluginManagement {
 
 plugins {
     id 'org.gradle.toolchains.foojay-resolver-convention' version '1.0.0'
-    id 'net.minecraftforge.gradleutils' version '3.2.5'
+    id 'net.minecraftforge.gradleutils' version '3.2.6'
 }
 
 rootProject.name = 'at-gradle-demo'

at-gradle/settings.gradle

@@ -4,7 +4,7 @@ plugins {
     // NOTE: We need to load this into the classpath before GradleUtils for the service to load correctly
     id 'io.freefair.javadoc-links' version '8.14' apply false // https://plugins.gradle.org/plugin/io.freefair.javadoc-links
 
-    id 'net.minecraftforge.gradleutils' version '3.2.5' // https://plugins.gradle.org/plugin/net.minecraftforge.gradleutils
+    id 'net.minecraftforge.gradleutils' version '3.2.6' // https://plugins.gradle.org/plugin/net.minecraftforge.gradleutils
 }
 
 rootProject.name = 'at-gradle'
@@ -35,7 +35,7 @@ dependencyResolutionManagement {
         library 'gradle', 'name.remal.gradle-api', 'gradle-api'  versionRef 'gradle'
 
         // GradleUtils Shared Base
-        library 'gradleutils-shared', 'net.minecraftforge', 'gradleutils-shared' version '3.2.5'
+        library 'gradleutils-shared', 'net.minecraftforge', 'gradleutils-shared' version '3.2.6'
 
         // Utils
         library 'utils-hash', 'net.minecraftforge', 'hash-utils' version '0.1.9'

at-gradle/src/main/java/net/minecraftforge/accesstransformers/gradle/AccessTransformersContainer.java

@@ -16,6 +16,7 @@
 import org.gradle.api.attributes.Attribute;
 import org.gradle.api.file.FileCollection;
 import org.gradle.api.file.RegularFile;
+import org.gradle.api.logging.LogLevel;
 import org.gradle.api.provider.Provider;
 import org.gradle.api.provider.ProviderConvertible;
 import org.gradle.jvm.toolchain.JavaLauncher;
@@ -152,6 +153,49 @@ default Provider<?> dep(ProviderConvertible<?> dependencyNotation) {
     /// When initially registering an AccessTransformers container, the consumer must define key information regarding
     /// how AccessTransformers will be used. This interface is used to define that information.
     sealed interface Options permits AccessTransformersContainerInternal.Options {
+        /// Sets the AccessTransformer configuration to use.
+        ///
+        /// If the given provider does not provide a [file][File] or [regular file][RegularFile], the result will be
+        /// resolved using [org.gradle.api.Project#file(Object)], similarly to [#setConfig(Object)].
+        ///
+        /// @param configFile The configuration file to use
+        void setConfig(Provider<?> configFile);
+
+        /// Sets the AccessTransformer configuration to use.
+        ///
+        /// @param configFile The configuration file to use
+        void setConfig(RegularFile configFile);
+
+        /// Sets the AccessTransformer configuration to use.
+        ///
+        /// @param configFile The configuration file to use
+        void setConfig(File configFile);
+
+        /// Sets the AccessTransformer configuration to use.
+        ///
+        /// The given object is resolved using [org.gradle.api.Project#file(Object)].
+        ///
+        /// @param configFile The configuration file to use
+        void setConfig(Object configFile);
+
+        /// Sets the log level to pipe the output of AccessTransformers to.
+        ///
+        /// @param level The log level to use
+        /// @apiNote This is [experimental][ApiStatus.Experimental] due to the fact that AccessTransformers treats both
+        /// [System#out] and [System#err] equally, while preferring to use the latter. This will be addressed in a
+        /// future version of AccessTransformers.
+        @ApiStatus.Experimental
+        void setLogLevel(LogLevel level);
+
+        /// Sets the log level to pipe the output of AccessTransformers to.
+        ///
+        /// @param level The log level to use
+        /// @apiNote This is [experimental][ApiStatus.Experimental] due to the fact that AccessTransformers treats both
+        /// [System#out] and [System#err] equally, while preferring to use the latter. This will be addressed in a
+        /// future version of AccessTransformers.
+        @ApiStatus.Experimental
+        void setLogLevel(Provider<? extends LogLevel> level);
+
         /// Sets the configuration to use as the classpath for AccessTransformers.
         ///
         /// @param files The file collection to use
@@ -338,30 +382,5 @@ default void setClasspath(ProviderConvertible<?> dependencyNotation) {
         default void setArgs(String... args) {
             this.setArgs(Arrays.asList(args));
         }
-
-        /// Sets the AccessTransformer configuration to use.
-        ///
-        /// If the given provider does not provide a [file][File] or [regular file][RegularFile], the result will be
-        /// resolved using [org.gradle.api.Project#file(Object)], similarly to [#setConfig(Object)].
-        ///
-        /// @param configFile The configuration file to use
-        void setConfig(Provider<?> configFile);
-
-        /// Sets the AccessTransformer configuration to use.
-        ///
-        /// @param configFile The configuration file to use
-        void setConfig(RegularFile configFile);
-
-        /// Sets the AccessTransformer configuration to use.
-        ///
-        /// @param configFile The configuration file to use
-        void setConfig(File configFile);
-
-        /// Sets the AccessTransformer configuration to use.
-        ///
-        /// The given object is resolved using [org.gradle.api.Project#file(Object)].
-        ///
-        /// @param configFile The configuration file to use
-        void setConfig(Object configFile);
     }
 }

at-gradle/src/main/java/net/minecraftforge/accesstransformers/gradle/AccessTransformersContainerImpl.java

@@ -25,6 +25,7 @@
 import org.gradle.api.file.FileSystemLocation;
 import org.gradle.api.file.RegularFile;
 import org.gradle.api.file.RegularFileProperty;
+import org.gradle.api.logging.LogLevel;
 import org.gradle.api.model.ObjectFactory;
 import org.gradle.api.provider.ListProperty;
 import org.gradle.api.provider.Property;
@@ -34,6 +35,8 @@
 
 import javax.inject.Inject;
 import java.io.File;
+import java.io.FileNotFoundException;
+import java.io.IOException;
 import java.io.Serial;
 import java.util.ArrayList;
 import java.util.Objects;
@@ -67,6 +70,8 @@ public AccessTransformersContainerImpl(
     }
 
     private void finish(Project project) {
+        this.validateATFile(this.attribute, this.options.config);
+
         project.dependencies(Closures.<DependencyHandler>consumer(this, dependencies -> {
             dependencies.attributesSchema(attributesSchema -> {
                 if (attributesSchema.hasAttribute(this.attribute))
@@ -82,11 +87,12 @@ private void finish(Project project) {
 
             dependencies.registerTransform(ArtifactAccessTransformer.class, spec -> {
                 spec.parameters(parameters -> {
+                    parameters.getConfig().set(this.options.config);
+                    parameters.getLogLevel().set(this.options.logLevel);
                     parameters.getClasspath().setFrom(this.options.classpath);
                     parameters.getMainClass().set(this.options.mainClass);
                     parameters.getJavaLauncher().set(this.options.javaLauncher);
                     parameters.getArgs().set(this.options.args);
-                    parameters.getConfig().set(this.options.config);
 
                     parameters.getCachesDir().convention(this.plugin.localCaches());
                 });
@@ -97,6 +103,31 @@ private void finish(Project project) {
         }));
     }
 
+    private void validateATFile(Attribute<Boolean> attribute, RegularFileProperty atFileProperty) {
+        // check that consumer has defined the config
+        RegularFile atFileSource;
+        try {
+            atFileSource = atFileProperty.get();
+        } catch (IllegalStateException e) {
+            throw this.problems.accessTransformerConfigNotDefined(new RuntimeException("Failed to resolve config file property", e), attribute);
+        }
+
+        // check that the file exists
+        File atFile = atFileSource.getAsFile();
+        if (!atFile.exists())
+            throw this.problems.accessTransformerConfigMissing(new RuntimeException(new FileNotFoundException("Config file does not exist at " + atFile)), attribute, atFile);
+
+        // check that the file can be read and isn't empty
+        String atFileContents;
+        try {
+            atFileContents = this.getProviders().fileContents(atFileSource).getAsText().get();
+        } catch (Throwable e) {
+            throw this.problems.accessTransformerConfigUnreadable(new RuntimeException(new IOException("Failed to read config file at " + atFile, e)), attribute, atFile);
+        }
+        if (atFileContents.isBlank())
+            throw this.problems.accessTransformerConfigEmpty(new IllegalStateException("Config file must not be blank at " + atFile), attribute, atFile);
+    }
+
     private void setAttributes(AttributeContainer attributes, boolean value) {
         attributes.attribute(ArtifactTypeDefinition.ARTIFACT_TYPE_ATTRIBUTE, ArtifactTypeDefinition.JAR_TYPE)
                   .attribute(this.attribute, value);
@@ -168,11 +199,12 @@ private static class MappedExternalModuleDependencyBundle extends ArrayList<Mini
     static abstract class OptionsImpl implements AccessTransformersContainerInternal.Options {
         private final Project project;
 
+        private final Property<LogLevel> logLevel = this.getObjects().property(LogLevel.class);
+        private final RegularFileProperty config = this.getObjects().fileProperty();
         private FileCollection classpath;
-        private final Property<String> mainClass;
-        private final Property<String> javaLauncher;
-        private final ListProperty<String> args;
-        private final RegularFileProperty config;
+        private final Property<String> mainClass = this.getObjects().property(String.class)/*.convention(Tools.ACCESSTRANSFORMERS.getMainClass())*/;
+        private final Property<String> javaLauncher = this.getObjects().property(String.class);
+        private final ListProperty<String> args = this.getObjects().listProperty(String.class);
 
         protected abstract @Inject ObjectFactory getObjects();
         protected abstract @Inject ProviderFactory getProviders();
@@ -183,11 +215,53 @@ public OptionsImpl(Project project) {
 
             var plugin = project.getPlugins().getPlugin(AccessTransformersPlugin.class);
 
+            this.logLevel.convention(LogLevel.INFO);
             this.classpath = this.getObjects().fileCollection().from(plugin.getTool(Tools.ACCESSTRANSFORMERS));
-            this.mainClass = this.getObjects().property(String.class)/*.convention(Tools.ACCESSTRANSFORMERS.getMainClass())*/;
-            this.javaLauncher = this.getObjects().property(String.class).convention(Util.launcherFor(project, Tools.ACCESSTRANSFORMERS.getJavaVersion()).map(Util.LAUNCHER_EXECUTABLE));
-            this.args = this.getObjects().listProperty(String.class).convention(Constants.AT_DEFAULT_ARGS);
-            this.config = this.getObjects().fileProperty();
+            //this.mainClass.convention(Tools.ACCESSTRANSFORMERS.getMainClass());
+            this.javaLauncher.convention(Util.launcherFor(project, Tools.ACCESSTRANSFORMERS.getJavaVersion()).map(Util.LAUNCHER_EXECUTABLE));
+            this.args.convention(Constants.AT_DEFAULT_ARGS);
+        }
+
+        @Override
+        public void setLogLevel(Provider<? extends LogLevel> level) {
+            this.logLevel.set(level);
+        }
+
+        @Override
+        public void setLogLevel(LogLevel level) {
+            this.logLevel.set(level);
+        }
+
+        @Override
+        public void setConfig(Provider<?> configFile) {
+            this.config.fileProvider(this.getProviders().provider(() -> {
+                Object value = configFile.getOrNull();
+                if (value == null)
+                    return null;
+                else if (value instanceof FileSystemLocation)
+                    value = ((FileSystemLocation) value).getAsFile();
+
+                // if Project#file becomes inaccessible, use ProjectLayout#files
+                return this.project.file(value, PathValidation.FILE);
+            }));
+        }
+
+        @Override
+        public void setConfig(RegularFile configFile) {
+            this.config.set(configFile);
+        }
+
+        @Override
+        public void setConfig(File configFile) {
+            this.config.set(configFile);
+        }
+
+        @Override
+        public void setConfig(Object configFile) {
+            this.config.fileProvider(this.getProviders().provider(
+                // if Project#file becomes inaccessible, use ProjectLayout#files
+                () -> this.project.file(configFile, PathValidation.FILE)
+            ));
         }
 
         @Override
@@ -237,37 +311,5 @@ public void setArgs(Iterable<String> args) {
         public void setArgs(Provider<? extends Iterable<String>> args) {
             this.args.set(args);
         }
-
-        @Override
-        public void setConfig(Provider<?> configFile) {
-            this.config.fileProvider(this.getProviders().provider(() -> {
-                Object value = configFile.getOrNull();
-                if (value == null)
-                    return null;
-                else if (value instanceof FileSystemLocation)
-                    value = ((FileSystemLocation) value).getAsFile();
-
-                // if Project#file becomes inaccessible, use ProjectLayout#files
-                return this.project.file(value, PathValidation.FILE);
-            }));
-        }
-
-        @Override
-        public void setConfig(RegularFile configFile) {
-            this.config.set(configFile);
-        }
-
-        @Override
-        public void setConfig(File configFile) {
-            this.config.set(configFile);
-        }
-
-        @Override
-        public void setConfig(Object configFile) {
-            this.config.fileProvider(this.getProviders().provider(
-                // if Project#file becomes inaccessible, use ProjectLayout#files
-                () -> this.project.file(configFile, PathValidation.FILE)
-            ));
-        }
     }
 }

at-gradle/src/main/java/net/minecraftforge/accesstransformers/gradle/AccessTransformersPlugin.java

@@ -21,8 +21,6 @@ abstract class AccessTransformersPlugin extends EnhancedPlugin<Project> {
     static final String NAME = "accesstransformers";
     static final String DISPLAY_NAME = "AccessTransformers Gradle";
 
-    static final Logger LOGGER = Logging.getLogger(AccessTransformersPlugin.class);
-
     @Inject
     public AccessTransformersPlugin() {
         super(NAME, DISPLAY_NAME);

at-gradle/src/main/java/net/minecraftforge/accesstransformers/gradle/AccessTransformersProblems.java

@@ -6,6 +6,7 @@
 
 import net.minecraftforge.gradleutils.shared.EnhancedProblems;
 import org.gradle.api.artifacts.Dependency;
+import org.gradle.api.attributes.Attribute;
 import org.gradle.api.problems.Severity;
 
 import javax.inject.Inject;
@@ -35,6 +36,53 @@ void reportIllegalTargetDependency(Dependency dependency) {
             .solution(HELP_MESSAGE));
     }
 
+    RuntimeException accessTransformerConfigNotDefined(Exception e, Attribute<Boolean> attribute) {
+        return this.getReporter().throwing(e, this.id("access-transformer-config-not-defined", "Access transformer config not defined"), spec -> spec
+            .details("""
+                The access transformer cannot transform the input artifact without a configuration file.
+                Attribute: %s""".formatted(attribute))
+            .severity(Severity.ERROR)
+            .solution("Ensure you have defined your configuration file.")
+            .solution("Do not use AccessTransformers if you do not need to.")
+            .solution(HELP_MESSAGE));
+    }
+
+    RuntimeException accessTransformerConfigMissing(Exception e, Attribute<Boolean> attribute, File atFile) {
+        return this.getReporter().throwing(e, this.id("access-transformer-config-missing", "Access transformer config file not found"), spec -> spec
+            .details("""
+                The access transformer cannot transform the input artifact because the configuration file could not be found.
+                Attribute: %s
+                AccessTransformer Config: %s""".formatted(attribute, atFile))
+            .severity(Severity.ERROR)
+            .solution("Ensure your AccessTransformers configuration file exists.")
+            .solution("Do not use AccessTransformers if you do not need to.")
+            .solution(HELP_MESSAGE));
+    }
+
+    RuntimeException accessTransformerConfigUnreadable(Throwable e, Attribute<Boolean> attribute, File atFile) {
+        return this.getReporter().throwing(e, this.id("access-transformer-config-unreadable", "Access transformer config file not read"), spec -> spec
+            .details("""
+                The access transformer cannot transform the input artifact because the configuration file could not be read.
+                This may be due to insufficient file permissions or a corrupted file.
+                Attribute: %s
+                AccessTransformer Config: %s""".formatted(attribute, atFile))
+            .severity(Severity.ERROR)
+            .solution("Ensure you (and/or Gradle) have proper read/write permissions to the AccessTransformer config file.")
+            .solution(HELP_MESSAGE));
+    }
+
+    RuntimeException accessTransformerConfigEmpty(Exception e, Attribute<Boolean> attribute, File atFile) {
+        return this.getReporter().throwing(e, this.id("access-transformer-config-empty", "Access transformer config missing or empty"), spec -> spec
+            .details("""
+                The access transformer cannot transform the input artifact because the configuration file is empty or blank.
+                Attribute: %s
+                AccessTransformer Config: %s""".formatted(attribute, atFile))
+            .severity(Severity.ERROR)
+            .solution("Ensure your AccessTransformers configuration file contains definitions to be used.")
+            .solution("Do not use AccessTransformers if you do not need to.")
+            .solution(HELP_MESSAGE));
+    }
+
     void reportAccessTransformerCannotValidateOutput(Exception e, File inJar, File atFile, File outJar, File logFile) {
         this.getLogger().warn("WARNING: Access transformer completed, but failed to validate the output. Output jar: {}", outJar.getAbsolutePath());
         this.getReporter().report(this.id("access-transformer-output-validation-failed", "Failed to validate the access transformed output"), spec -> spec