Add a way to register ConfigurationObject globally (#1183)

* Cleanup closeQuietly, Remove unused methods in IoUtil

Author: leonard84

docs/extensions.adoc

@@ -720,9 +720,11 @@ type. Spock will then automatically create exactly one instance of the configura
 settings from the configuration file to it (before the `start()` methods of global extensions are called) and inject
 that instance into the extension class instances.
 
-A configuration object cannot be used exclusively in an annotation driven local extension, but it has to be used in at
-least one global extension to properly get initialized and populated with the settings from the configuration file. But
-if the configuration object is used in a global extension, you can also use it just fine in an annotation driven local
+If a configuration object should be used exclusively in an annotation driven local extension you must register it in
+`META-INF/services/spock.config.ConfigurationObject`.
+This is similar to a global extension, put the fully-qualified class name of the annotated class on a new line in the file.
+This will cause the configuration object to properly get initialized and populated with the settings from the configuration file.
+However, if the configuration object is used in a global extension, you can also use it just fine in an annotation driven local
 extension. If the configuration object is only used in an annotation driven local extension, you will get an exception
 when then configuration object is to be injected into the extension and you will also get an error when the
 configuration file is evaluated and it contains the section, as the configuration object is not properly registered yet.

docs/release_notes.adoc

@@ -3,6 +3,8 @@ include::include.adoc[]
 
 == 2.0-M4 (tbd)
 
+- Add a way to register `ConfigurationObject` globally without the need for a Global Extension
+
 == 2.0-M3 (2020-06-11)
 
 === Breaking Changes

spock-core/src/main/groovy/spock/util/EmbeddedSpecRunner.groovy

@@ -45,6 +45,7 @@ class EmbeddedSpecRunner {
 
   Closure configurationScript = null
   List<Class> extensionClasses = []
+  List<Class> configClasses = []
   boolean inheritParentExtensions = true
 
   void configurationScript(Closure configurationScript) {
@@ -85,7 +86,7 @@ class EmbeddedSpecRunner {
     }
   }
 
-  SummarizedEngineExecutionResults runClasses(List classes) {
+  SummarizedEngineExecutionResults runClasses(List<Class<?>> classes) {
     withNewContext {
       doRunRequest(classes.findAll { !Modifier.isAbstract(it.modifiers) }.collect {selectClass(it)})
     }
@@ -125,8 +126,8 @@ class EmbeddedSpecRunner {
     def newSpockUserHome = new File(context.spockUserHome, "EmbeddedSpecRunner")
     def script = configurationScript ?
         new ConfigurationScriptLoader(newSpockUserHome).loadClosureBasedScript(configurationScript) : null
-    RunContext.withNewContext(newContextName, newSpockUserHome, script,
-        extensionClasses, inheritParentExtensions, block as IThrowableFunction)
+    (T)RunContext.withNewContext(newContextName, newSpockUserHome, script,
+        extensionClasses, configClasses, inheritParentExtensions, block as IThrowableFunction)
   }
 
   private SummarizedEngineExecutionResults doRunRequest(List<DiscoverySelector> selectors) {

spock-core/src/main/java/org/spockframework/runtime/ExtensionClassesLoader.java

@@ -15,7 +15,7 @@
 package org.spockframework.runtime;
 
 import org.spockframework.runtime.extension.*;
-import org.spockframework.util.IoUtil;
+import spock.config.ConfigurationObject;
 
 import java.io.*;
 import java.net.URL;
@@ -26,11 +26,16 @@
  */
 public class ExtensionClassesLoader {
   public static final String EXTENSION_DESCRIPTOR_PATH = "META-INF/services/" + IGlobalExtension.class.getName();
+  public static final String CONFIG_DESCRIPTOR_PATH = "META-INF/services/" + ConfigurationObject.class.getName();
 
-  public List<Class<?>> loadClassesFromDefaultLocation() {
+  public List<Class<?>> loadExtensionClassesFromDefaultLocation() {
     return loadClasses(EXTENSION_DESCRIPTOR_PATH);
   }
 
+  public List<Class<?>> loadConfigClassesFromDefaultLocation() {
+    return loadClasses(CONFIG_DESCRIPTOR_PATH);
+  }
+
   public List<Class<?>> loadClasses(String descriptorPath) {
     Map<String, URL> discoveredClasses = new HashMap<>();
     List<Class<?>> extClasses = new ArrayList<>();
@@ -57,10 +62,7 @@ private List<URL> locateDescriptors(String descriptorPath) {
   }
 
   private List<String> readDescriptor(URL url) {
-    BufferedReader reader = null;
-
-    try {
-      reader = new BufferedReader(new InputStreamReader(url.openStream()));
+    try(BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream()))) {
       List<String> lines = new ArrayList<>();
       String line = reader.readLine();
       while (line != null) {
@@ -72,8 +74,6 @@ private List<String> readDescriptor(URL url) {
       return lines;
     } catch (IOException e) {
       throw new ExtensionException("Failed to read extension descriptor '%s'", e).withArgs(url);
-    } finally {
-      IoUtil.closeQuietly(reader);
     }
   }
 

spock-core/src/main/java/org/spockframework/runtime/GlobalExtensionRegistry.java

@@ -23,6 +23,8 @@
 import java.lang.reflect.Field;
 import java.util.*;
 
+import org.jetbrains.annotations.NotNull;
+
 /**
  * Maintains a registry of global Spock extensions and their configuration objects,
  * which can be used to configure other extensions.
@@ -36,19 +38,20 @@ public class GlobalExtensionRegistry implements IExtensionRegistry, IConfigurati
 
   private final List<IGlobalExtension> globalExtensions = new ArrayList<>();
 
-  GlobalExtensionRegistry(List<Class<?>> globalExtensionClasses, List<?> initialConfigurations) {
+  GlobalExtensionRegistry(List<Class<?>> globalExtensionClasses, List<Class<?>> initialConfigurations) {
     this.globalExtensionClasses = globalExtensionClasses;
     initializeConfigurations(initialConfigurations);
   }
 
-  private void initializeConfigurations(List<?> initialConfigurations) {
-    for (Object configuration : initialConfigurations) {
-      ConfigurationObject annotation = configuration.getClass().getAnnotation(ConfigurationObject.class);
+  private void initializeConfigurations(List<Class<?>> initialConfigurations) {
+    for (Class<?> configuration : initialConfigurations) {
+      ConfigurationObject annotation = configuration.getAnnotation(ConfigurationObject.class);
       if (annotation == null) {
-        throw new InternalSpockError("Not a @ConfigurationObject: %s").withArgs(configuration.getClass());
+        throw new InternalSpockError("Not a @ConfigurationObject: %s").withArgs(configuration);
       }
-      configurationsByType.put(configuration.getClass(), configuration);
-      configurationsByName.put(annotation.value(), configuration);
+      Object instance = createConfiguration(configuration);
+      configurationsByType.put(configuration, instance);
+      configurationsByName.put(annotation.value(), instance);
     }
   }
 
@@ -85,7 +88,7 @@ private void verifyGlobalExtension(Class<?> clazz) {
 
   private IGlobalExtension instantiateGlobalExtension(Class<?> clazz) {
     try {
-      return (IGlobalExtension) clazz.newInstance();
+      return (IGlobalExtension) clazz.getDeclaredConstructor().newInstance();
     } catch (Exception e) {
       throw new ExtensionException("Failed to instantiate extension '%s'", e).withArgs(clazz.getName());
     }
@@ -139,12 +142,19 @@ private Object createConfiguration(Class<?> type, Object extension) {
           .withArgs(extension.getClass(), type);
     }
 
+    return createConfiguration(type);
+  }
+
+  @NotNull
+  private Object createConfiguration(Class<?> type) {
     try {
-      return type.newInstance();
+      return type.getDeclaredConstructor().newInstance();
     } catch (InstantiationException e) {
-      throw new ExtensionException("Cannot instantiate configuration class %s").withArgs(type);
-    } catch (IllegalAccessException e) {
-      throw new ExtensionException("Configuration class '%s' has no public no-arg constructor").withArgs(type);
+      throw new ExtensionException("Cannot instantiate configuration class %s", e).withArgs(type);
+    } catch (IllegalAccessException | NoSuchMethodException e) {
+      throw new ExtensionException("Configuration class '%s' has no public no-arg constructor", e).withArgs(type);
+    } catch (Exception e) {
+      throw new ExtensionException("Failed to instantiate configuration '%s'", e).withArgs(type.getName());
     }
   }
 }

spock-core/src/main/java/org/spockframework/runtime/RunContext.java

@@ -33,17 +33,21 @@ public class RunContext implements EngineExecutionContext {
   private final File spockUserHome;
   private final DelegatingScript configurationScript;
   private final List<Class<?>> globalExtensionClasses;
+  private final List<Class<?>> globalConfigClasses;
   private final GlobalExtensionRegistry globalExtensionRegistry;
 
   private final IObjectRenderer<Object> diffedObjectRenderer = createDiffedObjectRenderer();
 
   private RunContext(String name, File spockUserHome,
-      @Nullable DelegatingScript configurationScript, List<Class<?>> globalExtensionClasses) {
+                     @Nullable DelegatingScript configurationScript,
+                     List<Class<?>> globalExtensionClasses,
+                     List<Class<?>> globalConfigClasses) {
     this.name = name;
     this.spockUserHome = spockUserHome;
     this.configurationScript = configurationScript;
     this.globalExtensionClasses = globalExtensionClasses;
-    globalExtensionRegistry = new GlobalExtensionRegistry(globalExtensionClasses, Collections.singletonList(new RunnerConfiguration()));
+    this.globalConfigClasses = globalConfigClasses;
+    globalExtensionRegistry = new GlobalExtensionRegistry(globalExtensionClasses, globalConfigClasses);
   }
 
   private void start() {
@@ -76,7 +80,7 @@ public ExtensionRunner createExtensionRunner(SpecInfo spec) {
 
   public PlatformParameterizedSpecRunner createSpecRunner(SpecInfo spec) {
     return new PlatformParameterizedSpecRunner(
-        new MasterRunSupervisor(spec, createStackTraceFilter(spec), diffedObjectRenderer));
+      new MasterRunSupervisor(spec, createStackTraceFilter(spec), diffedObjectRenderer));
   }
 
   @Nullable
@@ -122,13 +126,19 @@ private IObjectRenderer<Object> createDiffedObjectRenderer() {
   }
 
   public static <T, U extends Throwable> T withNewContext(String name, File spockUserHome,
-      @Nullable DelegatingScript configurationScript,
-      List<Class<?>> extensionClasses, boolean inheritParentExtensions,
-      IThrowableFunction<RunContext, T, U> command) throws U {
+                                                          @Nullable DelegatingScript configurationScript,
+                                                          List<Class<?>> extensionClasses,
+                                                          List<Class<?>> configClasses,
+                                                          boolean inheritParentExtensions,
+                                                          IThrowableFunction<RunContext, T, U> command) throws U {
     List<Class<?>> allExtensionClasses = new ArrayList<>(extensionClasses);
-    if (inheritParentExtensions) allExtensionClasses.addAll(getCurrentExtensions());
+    List<Class<?>> allConfigClasses = new ArrayList<>(configClasses);
+    if (inheritParentExtensions) {
+      allExtensionClasses.addAll(getCurrentExtensions());
+      allConfigClasses.addAll(getCurrentConfigs());
+    }
 
-    RunContext context = new RunContext(name, spockUserHome, configurationScript, allExtensionClasses);
+    RunContext context = new RunContext(name, spockUserHome, configurationScript, allExtensionClasses, allConfigClasses);
     Deque<RunContext> contextStack = contextStacks.get();
     contextStack.addFirst(context);
     try {
@@ -148,12 +158,8 @@ public static RunContext get() {
       contextStack.addFirst(context);
       final RunContext bottomContext = context;
       try {
-        Runtime.getRuntime().addShutdownHook(new Thread("org.spockframework.runtime.RunContext.stop()") {
-          @Override
-          public void run() {
-            bottomContext.stop();
-          }
-        });
+        Runtime.getRuntime().addShutdownHook(
+          new Thread(bottomContext::stop, "org.spockframework.runtime.RunContext.stop()"));
       } catch (AccessControlException ignored) {
         // GAE doesn't support creating a new thread
       }
@@ -168,6 +174,12 @@ private static List<Class<?>> getCurrentExtensions() {
     return context.globalExtensionClasses;
   }
 
+  private static List<Class<?>> getCurrentConfigs() {
+    RunContext context = contextStacks.get().peek();
+    if (context == null) return Collections.emptyList();
+    return context.globalConfigClasses;
+  }
+
   // This context will stay around until the thread dies.
   // It would be more accurate to remove the context once the test run
   // has finished, but the JUnit Runner SPI doesn't provide an adequate hook.
@@ -176,7 +188,9 @@ private static List<Class<?>> getCurrentExtensions() {
   static RunContext createBottomContext() {
     File spockUserHome = SpockUserHomeUtil.getSpockUserHome();
     DelegatingScript script = new ConfigurationScriptLoader(spockUserHome).loadAutoDetectedScript();
-    List<Class<?>> classes = new ExtensionClassesLoader().loadClassesFromDefaultLocation();
-    return new RunContext("default", spockUserHome, script, classes);
+    ExtensionClassesLoader extensionClassesLoader = new ExtensionClassesLoader();
+    List<Class<?>> classes = extensionClassesLoader.loadExtensionClassesFromDefaultLocation();
+    List<Class<?>> configs = extensionClassesLoader.loadConfigClassesFromDefaultLocation();
+    return new RunContext("default", spockUserHome, script, classes, configs);
   }
 }

spock-core/src/main/java/org/spockframework/runtime/SpecRunHistory.java

@@ -36,28 +36,24 @@ public String getSpecName() {
   }
 
   public void loadFromDisk() throws IOException {
-    ObjectInputStream in = new ObjectInputStream(new FileInputStream(getDataFile()));
-    try {
+
+    try(ObjectInputStream in = new ObjectInputStream(new FileInputStream(getDataFile()))) {
       data = (Data) in.readObject();
     } catch (ClassNotFoundException e) {
       // in JDK 1.5, there is no IOException constructor that takes a cause
       IOException io = new IOException("deserialization error");
       io.initCause(e);
       throw io;
-    } finally {
-      IoUtil.closeQuietly(in);
     }
   }
 
   public void saveToDisk() throws IOException {
     File file = getDataFile();
     IoUtil.createDirectory(file.getParentFile());
 
-    ObjectOutputStream out = new ObjectOutputStream(new FileOutputStream(file));
-    try {
+
+    try(ObjectOutputStream out = new ObjectOutputStream(new FileOutputStream(file))) {
       out.writeObject(data);
-    } finally {
-      IoUtil.closeQuietly(out);
     }
   }