Merge pull request #130 from amosproj/general/ci/init-lint-and-test-w…

…orkflows

ci: init lint and test workflows

.editorconfig

@@ -1,6 +1,11 @@
+root = true
+
 # Apply standard rules to all Kotlin files
 [*.{kt,kts}]
+ktlint_code_style = ktlint_official
 ktlint_standard = enabled
+indent_size = 4
+indent_style = space
 
 # Ignore code in Prototype directory
 [Prototypes/**/*.kt]

.github/workflows/lint.yml

@@ -0,0 +1,15 @@
+name: lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  ktlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      # from the ktlint wiki page https://pinterest.github.io/ktlint/1.0.1/install/cli/
+      - run: curl -sSLO https://github.com/pinterest/ktlint/releases/download/1.0.1/ktlint && chmod a+x ktlint && sudo mv ktlint /usr/local/bin/
+      - run: ktlint

.github/workflows/test.yml

@@ -0,0 +1,53 @@
+name: test
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+jobs:
+  lib1:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./VideoGenerator/example
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+          cache: 'gradle'
+          cache-dependency-path: |
+            ./VideoGenerator/example/*.gradle*
+            ./VideoGenerator/example/**/gradle-wrapper.properties
+      - name: Setup Android SDK
+        uses: android-actions/setup-android@v3
+
+      - name: Give exec permission for ./gradlew
+        run: chmod +x ./gradlew
+      - name: Assemble the apk
+        run: ./gradlew assembleDebug assembleAndroidTest
+      - name: Download test assets
+        run: ./gradlew downloadAndUnzipTestAssets
+      - name: Run Tests
+        run: ./gradlew test
+  lib2:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./DifferenceGenerator
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'adopt'
+          cache: 'gradle'
+          cache-dependency-path: |
+            ./DifferenceGenerator/*.gradle*
+            ./DifferenceGenerator/**/gradle-wrapper.properties
+
+      - name: Download test assets
+        run: ./gradlew downloadAndUnzipTestAssets
+      - name: Run Tests
+        run: ./gradlew test

DifferenceGenerator/build.gradle.kts

@@ -19,7 +19,7 @@ dependencies {
 }
 
 tasks.test {
-    useJUnitPlatform()
+    useJUnitPlatform { excludeTags("benchmark") }
     systemProperty("gapOpenPenalty", System.getProperty("gapOpenPenalty") ?: "-0.5")
     systemProperty("gapExtensionPenalty", System.getProperty("gapExtensionPenalty") ?: "-0.5")
 }

DifferenceGenerator/src/main/kotlin/DifferenceGenerator.kt

@@ -3,6 +3,7 @@ import algorithms.AlignmentElement
 import mask.CompositeMask
 import mask.Mask
 import org.bytedeco.ffmpeg.global.avcodec.AV_CODEC_ID_FFV1
+import org.bytedeco.ffmpeg.global.avutil
 import org.bytedeco.javacv.FFmpegFrameRecorder
 import org.bytedeco.javacv.Frame
 import wrappers.MaskedImageGrabber
@@ -65,6 +66,9 @@ class DifferenceGenerator(
         video1Grabber.mask = mask
         video2Grabber.mask = mask
 
+        // turn off verbose ffmpeg output
+        avutil.av_log_set_level(avutil.AV_LOG_QUIET)
+
         generateDifference()
     }
 

DifferenceGenerator/src/test/kotlin/ReadRuntimeTests.kt

@@ -1,5 +1,6 @@
 import org.bytedeco.javacv.FFmpegFrameGrabber
 import org.bytedeco.javacv.Frame
+import org.junit.jupiter.api.Tag
 import org.junit.jupiter.api.Test
 import wrappers.Resettable2DFrameConverter
 import java.awt.image.DataBufferByte
@@ -11,6 +12,7 @@ import kotlin.system.measureTimeMillis
 
 // maybe an interface for the methods?
 
+@Tag("benchmark")
 internal class ReadRuntimeTests {
     private val resourcesPathPrefix = "src/test/resources/"
     private val video9Frames = resourcesPathPrefix + "9Screenshots.mov"

DifferenceGenerator/src/test/kotlin/WriteRuntimeTests.kt

@@ -1,4 +1,5 @@
 import org.bytedeco.javacv.Frame
+import org.junit.jupiter.api.Tag
 import org.junit.jupiter.api.Test
 import wrappers.Resettable2DFrameConverter
 import java.awt.Color
@@ -7,6 +8,7 @@ import kotlin.system.measureTimeMillis
 
 // maybe an interface for the methods?
 
+@Tag("benchmark")
 internal class WriteRuntimeTests {
     private val runAmount = 50
     private val size = 6000

VideoGenerator/library/build.gradle.kts

@@ -21,6 +21,10 @@ dependencies {
     testImplementation(kotlin("test"))
 }
 
+tasks.test {
+    useJUnitPlatform { excludeTags("benchmark") }
+}
+
 kotlin {
     jvmToolchain(11)
 }

VideoGenerator/library/src/main/kotlin/VideoGeneratorBenchmarkTest.kt

@@ -2,6 +2,7 @@ import org.bytedeco.ffmpeg.global.avcodec
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Tag
 import org.junit.jupiter.api.Test
 import java.io.File
 import java.lang.Exception
@@ -10,6 +11,7 @@ import kotlin.math.log10
 import kotlin.math.pow
 import kotlin.system.measureTimeMillis
 
+@Tag("benchmark")
 class VideoGeneratorBenchmarkTest {
     private lateinit var videoGenerator: VideoGeneratorImpl
     private val videoPath = "src/resources/testOutput.mkv"

VideoGenerator/library/src/main/kotlin/VideoGeneratorImpl.kt

@@ -1,4 +1,5 @@
 import org.bytedeco.ffmpeg.global.avcodec
+import org.bytedeco.ffmpeg.global.avutil
 import org.bytedeco.javacv.FFmpegFrameRecorder
 import org.bytedeco.javacv.Frame
 import java.io.ByteArrayInputStream
@@ -18,6 +19,11 @@ class VideoGeneratorImpl(
     var videoFormat: String = "matroska"
     var codecOptions: Map<String, String> = mapOf("" to "")
 
+    init {
+        // turn off verbose ffmpeg output
+        avutil.av_log_set_level(avutil.AV_LOG_QUIET)
+    }
+
     /**
      * Loads a frame from the given byte array.
      * Note, that this function is specifically using javax.ImageIO and is thus not suitable