modulePath returns incorrect path for nested-module structures

[arecmetafora]

If you define your project in such a way you have more than one layer of modules, whenever you run tests for a specific class it will start a gradle task on the topmost parent module in the hierarchy.

For instance, imagine we have the following project structure:

• myProject root
  • model
  • domain
  • presentation
    • feature1
    • feature2
    • featureN

Running any contextual testing action for a feature class will trigger a gradle task for the whole presentation module.
That can be problematic for projects with dozen of other sibling modules.

Executing tasks: [verifyPaparazziDebug, --tests, com.company.presentation.feature1.myClass] in project /Users/alex/git/myProject/presentation

The problem seems to be caused by the Path.modulePath extension, which probably assumes there will be only one layer of modules.

paparazzi-plugin/src/main/kotlin/com/getyourguide/paparazzi/Utils.kt

Lines 63 to 70 in c062d36

	internal fun Project.modulePath(file: VirtualFile): String? {
	return modules.asSequence().map { it.getModuleDir() }.firstOrNull { file.path.startsWith(it) }
	?: basePath?.let { projectPath ->
	val relativePath = FileUtil.getRelativePath(projectPath, file.path, File.separatorChar)
	val moduleName = relativePath?.split(File.separator)?.firstOrNull()
	if (moduleName != null) projectPath + File.separator + moduleName else null
	}
	}

[arecmetafora]

I checked the getModuleDir result for my project and it returned strange module paths under .idea folder, like:

/Users/USER/MyProject/.idea/modules/presentation/feature1

An easy workaround would be removing the ".idea/modules" from the module's path.
In additional to that, because we have nested modules, we need to get the path that is closer to the file. This can be solved by ordering the paths by size and choosing the first match with the biggest size.

The following implementation works and address both issues mentioned above:

internal fun Project.modulePath(file: VirtualFile): String? {
    return modules.asSequence().map {  it.getModuleDir().replace(".idea/modules/", "") }
            .sortedByDescending { it.length }
            .firstOrNull { file.path.startsWith(it) }
        ?: basePath?.let { projectPath ->
            val relativePath = FileUtil.getRelativePath(projectPath, file.path, File.separatorChar)
            val moduleName = relativePath?.split(File.separator)?.firstOrNull()
            if (moduleName != null) projectPath + File.separator + moduleName else null
        }
}