base setup for generating database documentation

.build/build.gradle.kts

@@ -1,4 +1,5 @@
 import documentation.generateComponentDiagramsFromJson
+import documentation.generateDatabasesOverviewDocumentFromJson
 import documentation.generateDiagramsFromPlantUml
 import documentation.generateEndpointOverviewDocumentFromJson
 import documentation.generateEventsOverviewDocumentFromJson
@@ -11,6 +12,7 @@ tasks.register("generateFiles") {
     val rootFolder = project.rootDir.parentFile
     doLast {
         generateComponentDiagramsFromJson(srcFolder, rootFolder)
+        generateDatabasesOverviewDocumentFromJson(srcFolder, rootFolder)
         generateDiagramsFromPlantUml(srcFolder, rootFolder)
         generateEndpointOverviewDocumentFromJson(srcFolder, rootFolder)
         generateEventsOverviewDocumentFromJson(srcFolder, rootFolder)

.build/buildSrc/src/main/kotlin/documentation/generators/asciidoc/DatabasesOverviewGenerator.kt

@@ -0,0 +1,25 @@
+package documentation.generators.asciidoc
+
+import documentation.model.Application
+import documentation.model.Distance.OWNED
+import documentation.model.componentName
+
+class DatabasesOverviewGenerator(applications: List<Application>) {
+
+    private val ourApplicationsWithDatabases = applications
+        .filter { it.distanceFromUs == OWNED }
+        .filter { it.databases.isNotEmpty() }
+        .sortedBy { componentName(it.id) }
+
+    fun asciiDocSource(): String =
+        buildString {
+            appendLine(":toc: left")
+            appendLine(":toclevels: 2")
+            appendLine()
+            appendLine("= Databases")
+            appendLine()
+            ourApplicationsWithDatabases
+                .forEach { application ->
+                }
+        }
+}

.build/buildSrc/src/main/kotlin/documentation/model/model.kt

@@ -27,6 +27,7 @@ data class Application(
     val dependents: List<Dependent> = emptyList(),
     val dependencies: List<Dependency> = emptyList(),
     val events: List<Event> = emptyList(),
+    val databases: List<Database> = emptyList(),
     val messaging: Messaging = Messaging(),
 ) : Component
 
@@ -84,3 +85,26 @@ data class Messaging(
         val routingKeyPattern: String,
     )
 }
+
+data class Database(
+    val id: String,
+    val name: String,
+    val type: String,
+    val description: String?,
+    val tables: List<Table> = emptyList(),
+) {
+    data class Table(
+        val name: String,
+        val description: String?,
+        val columns: List<Column> = emptyList(),
+    )
+
+    data class Column(
+        val name: String,
+        val dataType: String,
+        val defaultValue: String?,
+        val nullable: Boolean,
+        val description: String?,
+        val partOfPrimaryKey: Boolean,
+    )
+}

.build/buildSrc/src/main/kotlin/documentation/tasks.kt

@@ -1,5 +1,6 @@
 package documentation
 
+import documentation.generators.asciidoc.DatabasesOverviewGenerator
 import documentation.generators.asciidoc.EndpointsOverviewGenerator
 import documentation.generators.asciidoc.EventsOverviewGenerator
 import documentation.generators.plantuml.ApplicationContextDiagramGenerator
@@ -227,6 +228,21 @@ fun generateEventsOverviewDocumentFromJson(srcFolder: File, rootFolder: File) {
     createOrReplaceFile(targetFile, source)
 }
 
+// DATABASES
+
+fun generateDatabasesOverviewDocumentFromJson(srcFolder: File, rootFolder: File) {
+    val sourcesFolder = File(srcFolder, "json/components")
+    val targetFolder = File(rootFolder, "documents")
+    val targetFile = File(targetFolder, "databases.adoc")
+
+    val applications = loadApplications(sourcesFolder)
+
+    val generator = DatabasesOverviewGenerator(applications)
+    val source = generator.asciiDocSource()
+
+    createOrReplaceFile(targetFile, source)
+}
+
 // COMMON
 
 fun lineTypes(block: (LineType, String) -> Unit) {

.build/buildSrc/src/main/kotlin/documentation/tasks/combine-parts.kt

@@ -6,6 +6,7 @@ import com.fasterxml.jackson.databind.SerializationFeature
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import com.fasterxml.jackson.module.kotlin.readValue
 import documentation.model.Application
+import documentation.model.Database
 import documentation.model.Dependency
 import documentation.model.Dependent
 import documentation.model.Event
@@ -28,6 +29,7 @@ fun generateComponentDescription(sourceFolder: File, targetFolder: File, applica
             dependents = loadDependents(sourceFolder),
             dependencies = loadDependencies(sourceFolder),
             events = loadEvents(sourceFolder),
+            databases = loadDatabases(sourceFolder),
             messaging = Messaging(
                 publishedMessages = loadPublishedMessages(sourceFolder),
                 consumedQueues = loadConsumedQueues(sourceFolder),
@@ -103,6 +105,14 @@ fun loadConsumedQueues(sourceFolder: File): List<ConsumedQueue> {
     return emptyList()
 }
 
+fun loadDatabases(sourceFolder: File): List<Database> =
+    listJsonFilesInFolder(File(sourceFolder, "databases"))
+        .map { file -> loadDatabase(file) }
+
+private fun loadDatabase(file: File): Database {
+    return objectMapper.readValue<Database>(file)
+}
+
 private fun listJsonFilesInFolder(folder: File): List<File> =
     if (folder.isDirectory) {
         folder.listFiles()!!