|
| 1 | +import java.io.File |
| 2 | +import java.util.Locale |
| 3 | + |
| 4 | +import org.gradle.api.Project |
| 5 | +import org.gradle.api.plugins.ExtensionAware |
| 6 | +import org.gradle.kotlin.dsl.getByType |
| 7 | +import org.gradle.kotlin.dsl.register |
| 8 | +import org.itsallcode.openfasttrace.api.core.ItemStatus |
| 9 | +import org.itsallcode.openfasttrace.gradle.config.TagPathConfiguration |
| 10 | +import org.itsallcode.openfasttrace.gradle.config.TracingConfig |
| 11 | +import org.itsallcode.openfasttrace.gradle.task.CollectTask |
| 12 | +import org.itsallcode.openfasttrace.gradle.task.TraceTask |
| 13 | +import org.itsallcode.openfasttrace.gradle.task.config.SerializableTagPathConfig |
| 14 | + |
| 15 | +val taskGroupName = "trace" |
| 16 | +val requirementConfigName = "oftRequirementConfig" |
| 17 | + |
| 18 | +allprojects { |
| 19 | + val tracingConfig = extensions.create("requirementTracing", TracingConfig::class.java, project) |
| 20 | + (tracingConfig as ExtensionAware).extensions.create("tags", TagPathConfiguration::class.java, project) |
| 21 | +} |
| 22 | + |
| 23 | +gradle.projectsEvaluated { |
| 24 | + val collectTask = tasks.register<CollectTask>("collectRequirements") { |
| 25 | + group = taskGroupName |
| 26 | + description = "Collect requirements and generate specobject file" |
| 27 | + inputDirectories.set(getAllInputDirectories(rootProject.allprojects)) |
| 28 | + outputFile.set(rootProject.layout.buildDirectory.file("reports/requirements.xml")) |
| 29 | + pathConfig.set(getPathConfig(rootProject.allprojects)) |
| 30 | + } |
| 31 | + |
| 32 | + tasks.register<TraceTask>("traceRequirements") { |
| 33 | + group = taskGroupName |
| 34 | + description = "Trace requirements and generate tracing report" |
| 35 | + dependsOn(collectTask) |
| 36 | + |
| 37 | + val tracingConfig = rootProject.getTracingConfig() |
| 38 | + failBuild.set(tracingConfig.failBuild) |
| 39 | + requirementsFile.set(collectTask.flatMap { task -> task.outputFile }) |
| 40 | + |
| 41 | + if (tracingConfig.reportFile.isPresent) { |
| 42 | + outputFile.set(tracingConfig.reportFile) |
| 43 | + } else { |
| 44 | + val extension = if (tracingConfig.reportFormat.get() == "html") "html" else "txt" |
| 45 | + outputFile.set(rootProject.layout.buildDirectory.file("reports/tracing.$extension")) |
| 46 | + } |
| 47 | + |
| 48 | + reportVerbosity.set(tracingConfig.reportVerbosity) |
| 49 | + reportFormat.set(tracingConfig.reportFormat) |
| 50 | + importedRequirements.set(getImportedRequirements(rootProject.allprojects)) |
| 51 | + filteredArtifactTypes.set(tracingConfig.filteredArtifactTypes) |
| 52 | + filteredTags.set(tracingConfig.filteredTags) |
| 53 | + filterAcceptsItemsWithoutTag.set(tracingConfig.filterAcceptsItemsWithoutTag) |
| 54 | + filterWantedStatuses.set(getWantedStatuses(tracingConfig)) |
| 55 | + detailsSectionDisplay.set(tracingConfig.detailsSectionDisplay) |
| 56 | + } |
| 57 | +} |
| 58 | + |
| 59 | +fun Project.getTracingConfig(): TracingConfig = extensions.getByType() |
| 60 | + |
| 61 | +fun getAllInputDirectories(allProjects: Set<Project>): Set<File> = allProjects |
| 62 | + .flatMap { project -> project.getTracingConfig().inputDirectories.files } |
| 63 | + .toSet() |
| 64 | + |
| 65 | +fun getImportedRequirements(allProjects: Set<Project>): Set<File> = allProjects |
| 66 | + .flatMap(::getImportedRequirements) |
| 67 | + .toSet() |
| 68 | + |
| 69 | +fun getImportedRequirements(project: Project): Set<File> { |
| 70 | + val importedRequirements = project.getTracingConfig().importedRequirements.orNull.orEmpty() |
| 71 | + if (importedRequirements.isEmpty()) { |
| 72 | + return emptySet() |
| 73 | + } |
| 74 | + |
| 75 | + val configuration = project.configurations.findByName(requirementConfigName) |
| 76 | + ?: project.configurations.create(requirementConfigName) |
| 77 | + |
| 78 | + importedRequirements.forEach { dependency -> |
| 79 | + project.dependencies.add(requirementConfigName, dependency) |
| 80 | + } |
| 81 | + |
| 82 | + return configuration.files |
| 83 | +} |
| 84 | + |
| 85 | +fun getPathConfig(allProjects: Set<Project>): List<SerializableTagPathConfig> = allProjects |
| 86 | + .mapNotNull(::getTagPathConfig) |
| 87 | + |
| 88 | +fun getTagPathConfig(project: Project): SerializableTagPathConfig? { |
| 89 | + val tagPathConfig = project.getTracingConfig().tagPathConfig |
| 90 | + if (tagPathConfig.pathConfig.isEmpty()) { |
| 91 | + return null |
| 92 | + } |
| 93 | + return SerializableTagPathConfig(tagPathConfig) |
| 94 | +} |
| 95 | + |
| 96 | +fun getWantedStatuses(tracingConfig: TracingConfig): Set<ItemStatus> = |
| 97 | + tracingConfig.filterWantedStatuses.getOrElse(emptySet()).map(::convertStatus).toSet() |
| 98 | + |
| 99 | +fun convertStatus(value: String): ItemStatus = try { |
| 100 | + ItemStatus.valueOf(value.uppercase(Locale.ROOT)) |
| 101 | +} catch (exception: IllegalArgumentException) { |
| 102 | + val validStatuses = ItemStatus.values().joinToString(", ") { status -> status.name } |
| 103 | + throw IllegalArgumentException( |
| 104 | + "Invalid status '$value'. Valid statuses are: $validStatuses", |
| 105 | + exception, |
| 106 | + ) |
| 107 | +} |
0 commit comments