Add excluded modules configuration (#54)

* Fix for comparing with uncommitted changes

* Add ability to specify a branch to compare changes against

* Add exception test

* Change ordering as specified branch must be before compareFrom configuration

* can now define excluded modules to not be considered in the build process

* add excluded module

* Can now define modules to exclude from build process

* use new exclude functionality

* add test

* Add excluded modules to README.md

Author: jonnycaley

README.md

@@ -70,6 +70,9 @@ affectedModuleDetector {
     logFilename = "output.log"
     logFolder = "${project.rootDir}/output"
     compareFrom = "PreviousCommit" //default is PreviousCommit
+    excludedModules = [
+        "sample-util"
+    ]
 }
 ```
 
@@ -82,6 +85,7 @@ affectedModuleDetector {
     - PreviousCommit: compare against the previous commit
     - ForkCommit: compare against the commit the branch was forked from
     - SpecifiedBranchCommit: specify the branch to compare changes against using the `specifiedBranch` configuration before the `compareFrom` configuration
+ - `excludedModules` : A list of modules that will be excluded from the build process
 
 
 

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

@@ -53,6 +53,11 @@ class AffectedModuleConfiguration {
         field = value
     }
 
+    /**
+     * A set of modules that will not be considered in the build process, even if changes are made in them.
+     */
+    var excludedModules = emptySet<String>()
+
     companion object {
         const val name = "affectedModuleDetector"
     }

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

@@ -362,10 +362,10 @@ class AffectedModuleDetectorImpl constructor(
 
     override fun shouldInclude(project: Project): Boolean {
         return (
-            project.isRoot || (
+            (project.isRoot || (
                 affectedProjects.contains(project) &&
                     isProjectProvided2(project)
-                )
+                )) && !config.excludedModules.contains(project.name)
             ).also {
             logger?.info(
                 "checking whether I should include ${project.path} and my answer is $it"

affectedmoduledetector/src/test/kotlin/com/dropbox/affectedmoduledetector/AffectedModuleDetectorImplTest.kt

@@ -1230,6 +1230,28 @@ class AffectedModuleDetectorImplTest {
         Truth.assertThat(detector.shouldInclude(p5)).isTrue()
     }
 
+    @Test
+    fun `GIVEN module is in excludedModules configuration WHEN shouldInclude THEN excluded module false AND dependent modules true`() {
+        affectedModuleConfiguration = affectedModuleConfiguration.also {
+            it.excludedModules = setOf("p1")
+        }
+        val detector = AffectedModuleDetectorImpl(
+            rootProject = root,
+            logger = logger,
+            ignoreUnknownProjects = false,
+            projectSubset = ProjectSubset.ALL_AFFECTED_PROJECTS,
+            modules = null,
+            injectedGitClient = MockGitClient(
+                changedFiles = listOf(convertToFilePath("p1", "foo.java")),
+                tmpFolder = tmpFolder.root
+            ),
+            config = affectedModuleConfiguration
+        )
+        Truth.assertThat(detector.shouldInclude(p1)).isFalse()
+        Truth.assertThat(detector.shouldInclude(p4)).isTrue()
+        Truth.assertThat(detector.shouldInclude(p5)).isTrue()
+    }
+
     // For both Linux/Windows
     fun convertToFilePath(vararg list: String): String {
         return list.toList().joinToString(File.separator)

sample/build.gradle

@@ -29,6 +29,9 @@ affectedModuleDetector {
     compareFrom = "SpecifiedBranchCommit"
 
     logFolder = "${project.rootDir}"
+    excludedModules = [
+            "sample-util"
+    ]
 }
 
 allprojects {