Move the creation of dynamic task in the afterEvaluate() listener for

compatibility with Gradle 5 and Gradle 6. #85

Author: Horcrux7

src/com/inet/gradle/setup/dmg/Dmg.java

@@ -28,6 +28,8 @@
 import com.inet.gradle.setup.SetupBuilder;
 import com.inet.gradle.setup.abstracts.AbstractUnixSetupTask;
 import com.inet.gradle.setup.abstracts.LocalizedResource;
+import com.inet.gradle.setup.abstracts.Service;
+import com.inet.gradle.setup.util.GradleUtils;
 
 import groovy.lang.Closure;
 
@@ -54,6 +56,8 @@ public class Dmg extends AbstractUnixSetupTask {
 
     private List<PreferencesLink>          preferencesLink = new ArrayList<>();
 
+    final List<OSXApplicationBuilder>      appBuilders = new ArrayList<>();
+
     private List<String>                   jreIncludes = Arrays.asList( new String[] {
         "bin/java",
         "lib/",
@@ -80,6 +84,19 @@ public class Dmg extends AbstractUnixSetupTask {
      */
     public Dmg() {
         super( "dmg" );
+        getProject().afterEvaluate( (project) -> {
+            // if the "dmg" task should be executed then create some possible extra tasks on the end of the configuration phase
+            boolean isExecute = GradleUtils.isTaskExecute( Dmg.this, project );
+            if( isExecute ) {
+                SetupBuilder setup = getSetupBuilder();
+                for( Service service : setup.getServices() ) {
+                    ProjectInternal projInternal = (ProjectInternal)project;
+                    OSXApplicationBuilder builder = new OSXApplicationBuilder( Dmg.this, setup, projInternal.getFileResolver() );
+                    builder.configSubTasks( service );
+                    appBuilders.add( builder );
+                }
+            }
+        });
     }
 
     /**

src/com/inet/gradle/setup/dmg/DmgBuilder.java

@@ -83,10 +83,10 @@ public void build() throws RuntimeException {
             }
 
             // Build all services
-            for( Service service : setup.getServices() ) {
-                new OSXApplicationBuilder( task, setup, fileResolver ).buildService( service );
+            for( OSXApplicationBuilder builder : task.appBuilders ) {
+                builder.buildService();
                 if ( firstExecutableName == null ) {
-                    firstExecutableName = service.getDisplayName();
+                    firstExecutableName = builder.getService().getDisplayName();
                 }
             }
 

src/com/inet/gradle/setup/dmg/OSXApplicationBuilder.java

@@ -16,6 +16,10 @@
  */
 public class OSXApplicationBuilder extends AbstractOSXApplicationBuilder<Dmg, SetupBuilder> {
 
+    private Service service;
+
+    private OSXPrefPaneCreator prefPaneCreator;
+
     /**
      * Setup this builder.
      *
@@ -27,14 +31,32 @@ protected OSXApplicationBuilder( Dmg task, SetupBuilder setup, FileResolver file
         super( task, setup, fileResolver );
     }
 
+    /**
+     * Create sub tasks for a service,this must be called in project.afterEvaluate().
+     * 
+     * @param service the service
+     */
+    void configSubTasks( Service service ) {
+        this.service = service;
+        this.prefPaneCreator = new OSXPrefPaneCreator( task, getSetupBuilder(), fileResolver, service );
+    }
+
+    /**
+     * Get the service for which this builder was created or null if it only an application.
+     * 
+     * @return the service
+     */
+    Service getService() {
+        return service;
+    }
+
     /**
      * Create Application from service provided. Also create the preference panel
      * and put it into the application. Will also create the installer wrapper package of this application
      *
-     * @param service the service
      * @throws Throwable error.
      */
-    void buildService( Service service ) throws Throwable {
+    void buildService() throws Throwable {
 
         // We need the executable. It has a different meaning than on other systems.
         if( service.getExecutable() == null || service.getExecutable().isEmpty() ) {
@@ -45,7 +67,7 @@ void buildService( Service service ) throws Throwable {
         prepareApplication( service, false );
         finishApplication();
         copyBundleFiles( service );
-        new OSXPrefPaneCreator( task, getSetupBuilder(), fileResolver ).create( service );
+        prefPaneCreator.create();
 
         // codesigning will be done on the final package.
         // codeSignApplication( service );

src/com/inet/gradle/setup/dmg/OSXPrefPaneCreator.java

@@ -8,6 +8,7 @@
 import java.util.Arrays;
 import java.util.HashMap;
 
+import org.gradle.api.DefaultTask;
 import org.gradle.api.GradleException;
 import org.gradle.api.Project;
 import org.gradle.api.artifacts.Configuration;
@@ -27,10 +28,40 @@ public class OSXPrefPaneCreator extends AbstractOSXApplicationBuilder<Dmg, Setup
 
     private Project project;
 
-    protected OSXPrefPaneCreator( Dmg task, SetupBuilder setup, FileResolver fileResolver ) {
+    private Service service;
+
+    private String displayName;
+
+    private String internalName;
+    
+    private File prefPaneSource;
+
+    protected OSXPrefPaneCreator( Dmg task, SetupBuilder setup, FileResolver fileResolver, Service service ) {
         super( task, setup, fileResolver );
         buildDir = task.getTemporaryDir();
         project = task.getProject();
+        this.service = service;
+
+        displayName = service.getDisplayName();
+        internalName = displayName.replaceAll( "[^A-Za-z0-9]", "" );
+
+        // Create a task and run it before, this must be called in project.afterEvaluate()
+        GradleBuild gradleBuild = project.getTasks().create("OSXPrefPaneBuildTask-"+internalName, GradleBuild.class);
+        gradleBuild.setDescription( "Run the xcodebuild task for the prefpane." );
+        gradleBuild.setTasks( Arrays.asList( "clean", "xcodebuild" ) );
+        task.dependsOn( gradleBuild );
+
+        DefaultTask gradleBuildInit = project.getTasks().create("OSXPrefPaneBuildTask-Init-"+internalName, DefaultTask.class);
+        gradleBuildInit.doFirst( (t) -> {
+            try {
+                prefPaneSource = unpackAndPatchPrefPaneSource( internalName );
+            } catch( Exception ex ) {
+                ex.printStackTrace();
+                throw new RuntimeException( ex );
+            }
+            gradleBuild.setBuildFile( new File( prefPaneSource, "build.gradle" ) );
+        } );
+        gradleBuild.dependsOn( gradleBuildInit );
     }
 
     /**
@@ -42,18 +73,7 @@ protected OSXPrefPaneCreator( Dmg task, SetupBuilder setup, FileResolver fileRes
      * @return the file to the created pref pane.
      * @throws Exception if any error occur
      */
-    void create( Service service ) throws Exception {
-
-        String displayName = service.getDisplayName();
-        String internalName = displayName.replaceAll( "[^A-Za-z0-9]", "" );
-        File prefPaneSource = unpackAndPatchPrefPaneSource( internalName );
-
-        GradleBuild gradleBuild = project.getTasks().create("OSXPrefPaneBuildTask", GradleBuild.class);
-        gradleBuild.setDescription( "Run the xcodebuild task for the prefpane." );
-        gradleBuild.setBuildFile( new File( prefPaneSource, "build.gradle" ) );
-        gradleBuild.setTasks( Arrays.asList( "clean", "xcodebuild" ) );
-        gradleBuild.execute();
-
+    void create() throws Exception {
         File prefPaneBinary = new File( prefPaneSource, "build/sym/Release/" + internalName + ".prefPane" );
 
         if( !prefPaneBinary.exists() ) {
@@ -169,7 +189,7 @@ private File unpackAndPatchPrefPaneSource( String internalName ) throws Exceptio
         }
 
         // Prepare output directory
-        File outputDir = new File( buildDir, configName );
+        File outputDir = new File( buildDir, internalName );
         outputDir.mkdirs();
 
         URL dirURL = OSXPrefPaneCreator.class.getClassLoader().getResource( "com/inet/gradle/setup/dmg/preferences/build.gradle" );

src/com/inet/gradle/setup/util/GradleUtils.java

@@ -0,0 +1,90 @@
+/*
+ * Copyright 2019 i-net software
+ *
+ * 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
+ *
+ * http://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 com.inet.gradle.setup.util;
+
+import java.util.List;
+import java.util.Objects;
+import java.util.Set;
+
+import org.gradle.api.Project;
+import org.gradle.api.Task;
+import org.gradle.api.tasks.TaskContainer;
+
+public abstract class GradleUtils {
+
+    /**
+     * Checked if the given task will be executed because set in command line or depends on other executed task.
+     * 
+     * @param task the task to check
+     * @param project the current project
+     * @return true, if the task will be executed
+     */
+    public static boolean isTaskExecute( Task task, Project project ) {
+        String name = task.getName();
+        List<String> startTasks = project.getGradle().getStartParameter().getTaskNames();
+        TaskContainer tasks = project.getTasks();
+        for( String startTaskName : startTasks ) {
+            if( Objects.equals( name, startTaskName ) ) {
+                // direct call of the task in the command line
+                return true;
+            }
+            try {
+                Task startTask = tasks.getByName( startTaskName );
+                if( isTaskExecute( task, name, startTask, tasks ) ) {
+                    return true;
+                }
+            } catch( Throwable th ) {
+                // can occur if there is a circle in the dependsOn
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * Checked if the given task will be executed because set in command line or depends on other executed task.
+     * 
+     * @param task the task to check
+     * @param name the name to check
+     * @param startTask a task that will be executed
+     * @param tasks all tasks
+     * @return true, if the task will be executed
+     */
+    private static boolean isTaskExecute( Task task, String name, Task startTask, TaskContainer tasks ) {
+        if( startTask == null ) {
+            return false;
+        }
+        Set<Object> dependsOn = startTask.getDependsOn(); // can contain a task name, a task or other objects
+        for( Object depObject : dependsOn ) {
+            if( Objects.equals( name, depObject ) ) {
+                return true;
+            }
+            if( Objects.equals( task, depObject ) ) {
+                return true;
+            }
+            Task depTask = null;
+            if( depObject instanceof String ) {
+                depTask = tasks.getByName( (String)depObject );
+            } else if( depObject instanceof Task ) {
+                depTask = (Task)depObject;
+            }
+            if( isTaskExecute( task, name, depTask, tasks ) ) {
+                return true;
+            }
+        }
+        return false;
+    }
+}