Initialize subprojects and command-line interface

build.gradle.kts

@@ -3,67 +3,15 @@ import org.cqfn.save.buildutils.configureDiktat
 import org.cqfn.save.buildutils.createDetektTask
 import org.cqfn.save.buildutils.createDiktatTask
 import org.cqfn.save.buildutils.installGitHooks
-import org.gradle.nativeplatform.platform.internal.DefaultNativePlatform.getCurrentOperatingSystem
-import org.jetbrains.kotlin.gradle.targets.jvm.tasks.KotlinJvmTest
 
 plugins {
-    kotlin("multiplatform") version Versions.kotlin
-    kotlin("plugin.serialization") version Versions.kotlin
+    kotlin("multiplatform") version Versions.kotlin apply false
+    id("com.github.ben-manes.versions") version "0.38.0"
+    id("com.cdsap.talaiot.plugin.base") version "1.4.2"
 }
 
 version = "0.1.0-SNAPSHOT"
 
-repositories {
-    mavenCentral()
-    maven(url = "https://kotlin.bintray.com/kotlinx/")
-}
-
-kotlin {
-    jvm()
-    val os = getCurrentOperatingSystem()
-    val saveTarget = when {
-        os.isMacOsX -> macosX64("save")
-        os.isLinux -> linuxX64("save")
-        os.isWindows -> mingwX64("save")
-        else -> throw GradleException("Host OS is not supported in Kotlin/Native.")
-    }
-
-    saveTarget.apply {
-        binaries {
-            executable {
-                entryPoint = "org.cqfn"
-            }
-        }
-    }
-
-    sourceSets {
-        val saveMain by getting {
-            dependencies {
-                implementation("com.squareup.okio:okio-multiplatform:3.0.0-alpha.1")
-                implementation( "org.jetbrains.kotlinx:kotlinx-serialization-core:1.0.1")
-                implementation("org.jetbrains.kotlinx:kotlinx-datetime:0.1.1")
-            }
-        }
-        val saveTest by getting
-
-        val jvmMain by getting {
-            dependsOn(saveMain)
-        }
-
-        val jvmTest by getting {
-            dependsOn(saveTest)
-            dependencies {
-                implementation(kotlin("test-junit5"))
-                implementation("org.junit.jupiter:junit-jupiter-engine:5.0.0")
-            }
-        }
-    }
-}
-
-tasks.withType<KotlinJvmTest> {
-    useJUnitPlatform()
-}
-
 allprojects {
     repositories {
         mavenCentral()
@@ -73,4 +21,10 @@ allprojects {
 }
 createDiktatTask()
 createDetektTask()
-installGitHooks()
+installGitHooks()
+
+talaiot {
+    publishers {
+        timelinePublisher = true
+    }
+}

buildSrc/src/main/kotlin/Versions.kt

@@ -1,3 +1,4 @@
 object Versions {
     val kotlin = "1.4.31"
+    val junit = "5.7.1"
 }

save-cli/build.gradle.kts

@@ -0,0 +1,57 @@
+import org.jetbrains.kotlin.gradle.targets.jvm.tasks.KotlinJvmTest
+import org.gradle.nativeplatform.platform.internal.DefaultNativePlatform.getCurrentOperatingSystem
+
+plugins {
+    kotlin("multiplatform")
+}
+
+repositories {
+    mavenCentral()
+    maven(url = "https://kotlin.bintray.com/kotlinx/")
+}
+
+kotlin {
+    jvm()
+    val os = getCurrentOperatingSystem()
+    val saveTarget = when {
+        os.isMacOsX -> macosX64("save")
+        os.isLinux -> linuxX64("save")
+        os.isWindows -> mingwX64("save")
+        else -> throw GradleException("Host OS is not supported in Kotlin/Native.")
+    }
+
+    configure(listOf(saveTarget)) {
+        binaries {
+            executable {
+                entryPoint = "org.cqfn.save.cli.main"
+            }
+        }
+    }
+
+    sourceSets {
+        all {
+            languageSettings.useExperimentalAnnotation("kotlin.RequiresOptIn")
+            languageSettings.useExperimentalAnnotation("okio.ExperimentalFileSystem")
+        }
+        val commonMain by getting {
+            dependencies {
+                implementation(project(":save-core"))
+                implementation("org.jetbrains.kotlinx:kotlinx-cli:0.3.2")
+            }
+        }
+        val commonTest by getting
+
+        val jvmMain by getting
+
+        val jvmTest by getting {
+            dependencies {
+                implementation(kotlin("test-junit5"))
+                implementation("org.junit.jupiter:junit-jupiter-engine:${Versions.junit}")
+            }
+        }
+    }
+}
+
+tasks.withType<KotlinJvmTest> {
+    useJUnitPlatform()
+}

save-cli/src/commonMain/kotlin/org/cqfn/save/cli/Config.kt

@@ -0,0 +1,60 @@
+/**
+ * Utilities to work with SAVE config in CLI mode
+ */
+
+package org.cqfn.save.cli
+
+import org.cqfn.save.core.config.ReportType
+import org.cqfn.save.core.config.SaveConfig
+
+import okio.Path.Companion.toPath
+
+import kotlinx.cli.ArgParser
+import kotlinx.cli.ArgType
+import kotlinx.cli.default
+
+/**
+ * @param args CLI args
+ * @return an instance of [SaveConfig]
+ */
+fun createConfigFromArgs(args: Array<String>): SaveConfig {
+    val parser = ArgParser("save")
+
+    val config by parser.option(
+        ArgType.String,
+        shortName = "c",
+        description = "Path to the root save config file",
+    ).default("save.toml")
+
+    val debug by parser.option(
+        ArgType.Boolean,
+        shortName = "d",
+        description = "Turn on debug logging"
+    ).default(false)
+
+    val quiet by parser.option(
+        ArgType.Boolean,
+        shortName = "q",
+        description = "Do not log anything"
+    ).default(false)
+
+    val reportType by parser.option(
+        ArgType.Choice<ReportType>(),
+        shortName = "r",
+    ).default(ReportType.JSON)
+
+    val baseline by parser.option(
+        ArgType.String,
+        shortName = "b",
+        description = "Path to the file with baseline data",
+    )
+
+    parser.parse(args)
+    return SaveConfig(
+        configPath = config.toPath(),
+        debug = debug,
+        quiet = quiet,
+        reportType = reportType,
+        baselinePath = baseline?.toPath()
+    )
+}

save-cli/src/commonMain/kotlin/org/cqfn/save/cli/SaveCliRunner.kt

@@ -0,0 +1,14 @@
+/**
+ * Main entry point for SAVE CLI execution
+ */
+
+package org.cqfn.save.cli
+
+import org.cqfn.save.core.Save
+
+fun main(args: Array<String>) {
+    val save = Save(
+        createConfigFromArgs(args)
+    )
+    save.performAnalysis()
+}

save-core/build.gradle.kts

@@ -0,0 +1,51 @@
+import org.jetbrains.kotlin.gradle.targets.jvm.tasks.KotlinJvmTest
+import org.gradle.nativeplatform.platform.internal.DefaultNativePlatform.getCurrentOperatingSystem
+
+plugins {
+    kotlin("multiplatform")
+}
+
+repositories {
+    mavenCentral()
+    maven(url = "https://kotlin.bintray.com/kotlinx/")
+}
+
+kotlin {
+    jvm()
+    val os = getCurrentOperatingSystem()
+    val saveTarget = when {
+        os.isMacOsX -> macosX64("save")
+        os.isLinux -> linuxX64("save")
+        os.isWindows -> mingwX64("save")
+        else -> throw GradleException("Host OS is not supported in Kotlin/Native.")
+    }
+
+    configure(listOf(saveTarget)) {
+    }
+
+    sourceSets {
+        all {
+            languageSettings.useExperimentalAnnotation("kotlin.RequiresOptIn")
+            languageSettings.useExperimentalAnnotation("okio.ExperimentalFileSystem")
+        }
+        val commonMain by getting {
+            dependencies {
+                api("com.squareup.okio:okio-multiplatform:3.0.0-alpha.1")
+            }
+        }
+        val commonTest by getting
+
+        val jvmMain by getting
+
+        val jvmTest by getting {
+            dependencies {
+                implementation(kotlin("test-junit5"))
+                implementation("org.junit.jupiter:junit-jupiter-engine:${Versions.junit}")
+            }
+        }
+    }
+}
+
+tasks.withType<KotlinJvmTest> {
+    useJUnitPlatform()
+}

save-core/src/commonMain/kotlin/org/cqfn/save/core/Save.kt

@@ -0,0 +1,30 @@
+package org.cqfn.save.core
+
+import org.cqfn.save.core.config.SaveConfig
+import org.cqfn.save.core.plugin.Plugin
+
+import okio.FileSystem
+
+/**
+ * @property saveConfig an instance of [SaveConfig]
+ */
+@Suppress("INLINE_CLASS_CAN_BE_USED")  // todo: remove when there are >1 constructor parameters
+class Save(
+    private val saveConfig: SaveConfig
+) {
+    /**
+     * Main entrypoint for SAVE framework. Discovers plugins and calls their execution.
+     */
+    fun performAnalysis() {
+        // get all toml configs in file system
+        val fs = FileSystem.SYSTEM
+        val configFileLines: List<String> = fs.read(saveConfig.configPath) {
+            generateSequence { readUtf8Line() }.toList()
+        }
+
+        val plugins: List<Plugin> = emptyList()  // todo: discover plugins
+        plugins.forEach {
+            it.execute(configFileLines)
+        }
+    }
+}

save-core/src/commonMain/kotlin/org/cqfn/save/core/config/ReportType.kt

@@ -0,0 +1,8 @@
+package org.cqfn.save.core.config
+
+/**
+ * Possible types of output formats.
+ */
+enum class ReportType {
+    JSON, PLAIN, TOML, XML
+}

save-core/src/commonMain/kotlin/org/cqfn/save/core/config/SaveConfig.kt

@@ -0,0 +1,22 @@
+package org.cqfn.save.core.config
+
+import okio.ExperimentalFileSystem
+import okio.Path
+
+/**
+ * Configuration properties of save application, retrieved either from peoperties file
+ * or from CLI args.
+ * @property configPath path to the configuration file
+ * @property debug
+ * @property quiet
+ * @property reportType type of generated report with execution results
+ * @property baselinePath path to the file with baseline data
+ */
+@OptIn(ExperimentalFileSystem::class)
+data class SaveConfig(
+    val configPath: Path,
+    val debug: Boolean,
+    val quiet: Boolean,
+    val reportType: ReportType,
+    val baselinePath: Path?,
+)

save-core/src/commonMain/kotlin/org/cqfn/save/core/config/TestSuiteConfig.kt

@@ -0,0 +1,11 @@
+package org.cqfn.save.core.config
+
+/**
+ * Configuration for a test suite, that is read from test suite configuration file (toml config)
+ * @property suiteName name of test suite
+ * @property description dsecription of test suite
+ */
+data class TestSuiteConfig(
+    val suiteName: String,
+    val description: String,
+)

save-core/src/commonMain/kotlin/org/cqfn/save/core/plugin/Plugin.kt

@@ -0,0 +1,11 @@
+package org.cqfn.save.core.plugin
+
+/**
+ * Plugin that can be injected into SAVE during execution. Plugins accept contents of configuration file and then perform some work.
+ */
+interface Plugin {
+    /**
+     * @param configFileLines contents of configuration file
+     */
+    fun execute(configFileLines: List<String>)
+}

save-plugins/build.gradle.kts

@@ -0,0 +1,6 @@
+plugins {
+}
+
+repositories {
+    mavenCentral()
+}

settings.gradle.kts

@@ -1,2 +1,4 @@
-
 rootProject.name = "save"
+include("save-core")
+include("save-cli")
+include("save-plugins")