Merge pull request #130 from Evleaps/feature/easy_way_for_custom_command

Feature: New approach for creating custom command for impact analysis

Author: joshafeinberg

README.md

@@ -94,6 +94,13 @@ affectedModuleDetector {
     ]
     includeUncommitted = true
     top = "HEAD"
+    customTasks = [
+        new AffectedModuleConfiguration.CustomTask(
+            "runDetektByImpact",
+            "detekt",
+            "Run static analysis tool without auto-correction by Impact analysis"
+        )
+    ]
 }
 ```
 
@@ -109,15 +116,14 @@ affectedModuleDetector {
  - `excludedModules`: A list of modules that will be excluded from the build process
  - `includeUncommitted`: If uncommitted files should be considered affected
  - `top`: The top of the git log to use. Must be used in combination with configuration `includeUncommitted = false`
-
-
+ - `customTasks`: set of [CustomTask](https://github.com/dropbox/AffectedModuleDetector/blob/main/affectedmoduledetector/src/main/kotlin/com/dropbox/affectedmoduledetector/AffectedModuleConfiguration.kt)
 
  By default, the Detector will look for `assembleAndroidDebugTest`, `connectedAndroidDebugTest`, and `testDebug`.  Modules can specify a configuration block to specify which variant tests to run:
  ```groovy
  affectedTestConfiguration {
-    assembleAndroidTestTask = "assembleAndroidReleaseTest"
-    runAndroidTestTask = "connectedAndroidReleaseTest"
-    jvmTestTask = "testRelease"
+      assembleAndroidTestTask = "assembleAndroidReleaseTest"
+      runAndroidTestTask = "connectedAndroidReleaseTest"
+      jvmTestTask = "testRelease"
 }
 ```
 
@@ -167,13 +173,39 @@ To run this on the sample app:
 ```
 
 2. Try running the following command:
-
 ```
  ./gradlew runAffectedUnitTests -Paffected_module_detector.enable
 ```
 
 You should see zero tests run. Make a change within one of the modules and commit it. Rerunning the command should execute tests in that module and its dependent modules.
 
+## Custom tasks 
+
+If you want to add a custom gradle command to execute with impact analysis 
+you must declare [AffectedModuleConfiguration.CustomTask](https://github.com/dropbox/AffectedModuleDetector/blob/main/affectedmoduledetector/src/main/kotlin/com/dropbox/affectedmoduledetector/AffectedModuleConfiguration.kt) 
+which is implementing [AffectedModuleTaskType]() in the configuration in `build.gradle` of your project:
+
+```groovy
+// ... 
+
+affectedModuleDetector {
+     // ...
+     customTasks = [
+           new AffectedModuleConfiguration.CustomTask(
+                   "runDetektByImpact", 
+                   "detekt",
+                   "Run static analysis tool without auto-correction by Impact analysis"
+           )
+     ]
+     // ...
+}
+```
+
+**NOTE:** Please, test all your custom commands.
+If your custom task doesn't work correctly after testing, might be your task quite complex 
+and for correct working must using more gradle's api. 
+Hence, you must create `buildSrc` module and write custom plugin manually like [AffectedModuleDetectorPlugin](https://github.com/dropbox/AffectedModuleDetector/blob/main/affectedmoduledetector/src/main/kotlin/com/dropbox/affectedmoduledetector/AffectedModuleDetectorPlugin.kt)
+
 ## Notes
 
 Special thanks to the AndroidX for originally developing this project at https://android.googlesource.com/platform/frameworks/support/+/androidx-main/buildSrc/src/main/kotlin/androidx/build/dependencyTracker

affectedmoduledetector/src/main/kotlin/com/dropbox/affectedmoduledetector/AffectedModuleConfiguration.kt

@@ -3,6 +3,46 @@ package com.dropbox.affectedmoduledetector
 import java.io.File
 
 class AffectedModuleConfiguration {
+
+    /**
+     * Implementation of [AffectedModuleTaskType] for easy adding of custom gradle task to
+     * AffectedModuleDetector. You can declare a new instance of it in build.gradle.
+     *
+     * @see AffectedModuleTaskType - interface
+     * @see customTasks - configuration field
+     */
+    data class CustomTask(
+        override val commandByImpact: String,
+        override val originalGradleCommand: String,
+        override val taskDescription: String
+    ) : AffectedModuleTaskType
+
+    /**
+     * If you want to add a custom task for impact analysis you must set the list
+     * of [AffectedModuleTaskType] implementations.
+     *
+     * Example:
+     * `build.gradle
+     *
+     *  affectedModuleDetector {
+     *       ...
+     *       customTasks = [ // <- list of custom gradle invokes
+     *           new AffectedModuleConfiguration.CustomTask(
+     *                "runSomeCustomTaskByImpact",
+     *                "someTaskForExample",
+     *                "Task description."
+     *            )
+     *       ]
+     *       ...
+     *  }
+     * `
+     *
+     * @see AffectedModuleTaskType - interface
+     * @see CustomTask - Implementation class
+     * @see AffectedModuleDetectorPlugin - gradle plugin
+     */
+    var customTasks = emptySet<AffectedModuleConfiguration.CustomTask>()
+
     /**
      * Folder to place the log in
      */
@@ -75,6 +115,7 @@ class AffectedModuleConfiguration {
         }
 
     companion object {
+
         const val name = "affectedModuleDetector"
     }
 }