generateDomainClassesCheck: analogous to scalafmtCheck: safety net for PRs (#239)

* upgrade

* documentation text updates

* generateDomainClassesCheck: analogous to `scalafmtCheck`

Additional fixes:
* fix FileUtils.deleteRecursively
* generateDomainClasses now deletes it's target directory - for real
this time

* readme

* fix tests: allow to 'not delete' the codegen target dir...

...now that 'deleteRecursively' works :)

* run scalafmt to avoid build warnings...

Author: mpollmeier

.github/workflows/pr.yml

@@ -2,9 +2,9 @@ name: pr
 on: pull_request
 jobs:
   pr:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 1
       - uses: olafurpg/setup-scala@v10

.github/workflows/release.yml

@@ -6,9 +6,9 @@ on:
 jobs:
   release:
     concurrency: release
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
       - uses: olafurpg/setup-scala@v10

README.md

@@ -2,7 +2,16 @@
 
 # overflowdb-codegen
 
-## Configuration overview: TODO
+## generateDomainClasses
+Freshly generates the domain classes to the configured location. If both the schema as well as the dependency tree (which includes the codegen plugin) are unchanged, it will not run. This is to avoid long build times due to unnecessary regeneration and recompilation for consecutive `sbt compile` runs. 
+
+Note: the regular `sbt clean` does not touch/delete/handle the codegen-generated sources. This is on purpose, since the idea is to have the generated domain classes committed to the repository. 
+
+## generateDomainClassesCheck
+Fails if domain classes are not generated with the latest versions. Analogous to `scalafmtCheck`, i.e. run this on PRs.
+
+## Example repositories / builds
+* TODO
 
 ## Disable temporarily
 You can temporarily disable the codegen in your build by setting the environment variable `ODB_CODEGEN_DISABLE=true`. That's useful e.g. if you made some manual changes to the generated files that would otherwise be overridden by the codegen. 

codegen/src/main/scala/overflowdb/codegen/CodeGen.scala

@@ -31,7 +31,11 @@ class CodeGen(schema: Schema) {
     this
   }
 
-  def run(outputDir: java.io.File): Seq[java.io.File] = {
+  def run(outputDir: java.io.File, deleteExistingFiles: Boolean = true): Seq[java.io.File] = {
+    println(s"writing domain classes to $outputDir")
+    if (deleteExistingFiles && outputDir.exists)
+      deleteRecursively(outputDir)
+
     warnForDuplicatePropertyDefinitions()
     val _outputDir = outputDir.toScala
     val results =
@@ -1938,6 +1942,13 @@ class CodeGen(schema: Schema) {
                      |$src
                      |""".stripMargin)
   }
+
+  private def deleteRecursively(file: java.io.File): Unit = {
+    if (file.isDirectory)
+      file.listFiles.foreach(deleteRecursively)
+    if (file.exists)
+      file.delete()
+  }
 }
 
 object CodeGen {

codegen/src/main/scala/overflowdb/codegen/Formatter.scala

@@ -13,6 +13,7 @@ object Formatter {
       |""".stripMargin
 
   def run(sourceFiles: Seq[File], scalafmtConfig: Option[File]): Unit = {
+    println(s"invoking scalafmt on ${sourceFiles.size} files")
     val configFile: File = scalafmtConfig.getOrElse(
       Files
         .createTempFile("overflowdb-scalafmt", ".conf")

integration-tests/schemas/build.sbt

@@ -14,12 +14,11 @@ generateDomainClasses := Def.taskDyn {
 
   if (outputRoot.exists && lastSchemaMd5 == Some(currentSchemaMd5)) {
     Def.task {
-      // inputs did not change, don't regenerate
+      streams.value.log.info("no need to run codegen, inputs did not change")
       FileUtils.listFilesRecursively(outputRoot)
     }
   } else {
     Def.task {
-      FileUtils.deleteRecursively(outputRoot)
       val invoked = (Compile/runMain).toTask(s" CodegenForAllSchemas").value
       lastSchemaMd5(currentSchemaMd5)
       FileUtils.listFilesRecursively(outputRoot)

integration-tests/schemas/src/main/scala/CodegenForAllSchemas.scala

@@ -10,6 +10,8 @@ object CodegenForAllSchemas {
       else "scala-2.13"
 
     val outputDir = new File(s"integration-tests/schemas/target/$scalaVersion/odb-codegen")
+    println(s"running CodegenForAllSchemas; deleting outputDir first: $outputDir")
+    deleteRecursively(outputDir)
 
     Seq(
       new TestSchema01,
@@ -21,7 +23,7 @@ object CodegenForAllSchemas {
       new TestSchema05,
       new TestSchema06,
     ).foreach { schema =>
-      new CodeGen(schema.instance).disableScalafmt.run(outputDir)
+      new CodeGen(schema.instance).run(outputDir, deleteExistingFiles = false)
     }
   }
 
@@ -33,4 +35,11 @@ object CodegenForAllSchemas {
     case u: java.net.URLClassLoader => u.getURLs() ++ classpathUrls(cl.getParent)
     case _ => Array.empty
   }
+
+  private def deleteRecursively(file: File): Unit = {
+    if (file.isDirectory)
+      file.listFiles.foreach(deleteRecursively)
+    if (file.exists && !file.delete())
+      throw new java.io.IOException(s"Unable to delete ${file.getAbsolutePath}")
+  }
 }

project/FileUtils.scala

@@ -1,7 +1,7 @@
 import java.io.File
 import java.nio.file.Files
 import java.security.{DigestInputStream, MessageDigest}
-import scala.collection.JavaConverters._
+import scala.jdk.CollectionConverters.*
 
 object FileUtils {
 
@@ -11,24 +11,13 @@ object FileUtils {
     }
   }
 
-  def deleteRecursively(root: File): Unit = {
-    if (root.exists) {
-      Files.walk(root.toPath).iterator.asScala.map(_.toFile).collect {
-        case file if (file.isDirectory) => deleteRecursively(file)
-        case file => file.delete()
-      }
-    }
-  }
-
   def md5(roots: File*): String = {
     val md = MessageDigest.getInstance("MD5")
     roots.foreach { root =>
       Files.walk(root.toPath).filter(!_.toFile.isDirectory).forEach { path =>
         val dis = new DigestInputStream(Files.newInputStream(path), md)
-        // fully consume the inputstream
-        while (dis.available > 0) {
-          dis.read
-        }
+        // fully consume the InputStream
+        while (dis.available > 0) dis.read
         dis.close
       }
     }

project/build.properties

@@ -1 +1 @@
-sbt.version=1.9.2
+sbt.version=1.9.3

sbt-overflowdb/src/main/scala/overflowdb/codegen/sbt/FileUtils.scala

@@ -13,13 +13,11 @@ object FileUtils {
     }
   }
 
-  def deleteRecursively(root: File): Unit = {
-    if (root.exists) {
-      Files.walk(root.toPath).iterator.asScala.map(_.toFile).collect {
-        case file if (file.isDirectory) => deleteRecursively(file)
-        case file => file.delete()
-      }
-    }
+  def deleteRecursively(file: File): Unit = {
+    if (file.isDirectory)
+      file.listFiles.foreach(deleteRecursively)
+    if (file.exists)
+      file.delete()
   }
 
   def md5(roots: File*): String = {