Supported ExpectedWarningsFormat.PLAIN

save-common/src/commonMain/kotlin/com/saveourtool/save/core/config/WarningFormats.kt

@@ -18,6 +18,7 @@ enum class ActualWarningsFormat {
  */
 enum class ExpectedWarningsFormat {
  IN_PLACE,
+ PLAIN,
  SARIF,
  ;
 }

save-common/src/commonMain/kotlin/com/saveourtool/save/core/files/FileUtils.kt

@@ -230,6 +230,19 @@ fun FileSystem.findAncestorDirContainingFile(path: Path, fileName: String): Path
  }
 }
 
+/**
+ * Find a file in any of parent directories and return this file
+ *
+ * @param path path for which ancestors should be checked
+ * @param fileName a name of the file that will be searched for
+ * @return a path to a file with name [fileName] or null
+ */
+fun FileSystem.findFileInAncestorDir(path: Path, fileName: String): Path? = findAncestorDirContainingFile(
+ path, fileName
+)?.let {
+ it / fileName
+}
+
 /**
  * @return current working directory
  */

save-common/src/commonMain/kotlin/com/saveourtool/save/core/utils/SarifFileUtils.kt

@@ -4,7 +4,7 @@
 
 package com.saveourtool.save.core.utils
 
-import com.saveourtool.save.core.files.findAncestorDirContainingFile
+import com.saveourtool.save.core.files.findFileInAncestorDir
 import com.saveourtool.save.core.files.fs
 import com.saveourtool.save.core.files.parents
 import com.saveourtool.save.core.plugin.PluginException
@@ -51,11 +51,9 @@ fun FileSystem.topmostTestDirectory(path: Path): Path = path.parents().last { pa
  * @return path to sarif
  * @throws PluginException in case of absence of sarif file
  */
-fun calculatePathToSarifFile(sarifFileName: String, anchorTestFilePath: Path): Path = fs.findAncestorDirContainingFile(
+fun calculatePathToSarifFile(sarifFileName: String, anchorTestFilePath: Path): Path = fs.findFileInAncestorDir(
  anchorTestFilePath, sarifFileName
-)?.let {
- it / sarifFileName
-} ?: throw PluginException(
+) ?: throw PluginException(
  "Could not find SARIF file with expected warnings/fixes for file $anchorTestFilePath. " +
- "Please check if correct `FarningsFormat`/`FixFormat` is set (should be SARIF) and if the file is present and called `$sarifFileName`."
+ "Please check if correct `WarningsFormat`/`FixFormat` is set (should be SARIF) and if the file is present and called `$sarifFileName`."
 )

save-plugins/warn-plugin/src/commonMain/kotlin/com/saveourtool/save/plugin/warn/WarnPlugin.kt

@@ -4,6 +4,7 @@
 import com.saveourtool.save.core.config.ExpectedWarningsFormat
 import com.saveourtool.save.core.config.TestConfig
 import com.saveourtool.save.core.files.createFile
+import com.saveourtool.save.core.files.findFileInAncestorDir
 import com.saveourtool.save.core.files.getWorkingDirectory
 import com.saveourtool.save.core.files.readLines
 import com.saveourtool.save.core.logging.describe
@@ -13,6 +14,7 @@
 import com.saveourtool.save.core.plugin.ExtraFlagsExtractor
 import com.saveourtool.save.core.plugin.GeneralConfig
 import com.saveourtool.save.core.plugin.Plugin
+import com.saveourtool.save.core.plugin.PluginException
 import com.saveourtool.save.core.result.DebugInfo
 import com.saveourtool.save.core.result.Fail
 import com.saveourtool.save.core.result.TestResult
@@ -265,23 +267,51 @@
  originalPaths: List<Path>,
  copyPaths: List<Path>,
  workingDirectory: Path,
- ): WarningMap = if (warnPluginConfig.expectedWarningsFormat == ExpectedWarningsFormat.SARIF) {
- val warningsFromSarif = try {
- collectWarningsFromSarif(warnPluginConfig, originalPaths, fs, workingDirectory)
- } catch (e: Exception) {
- throw SarifParsingException("We failed to parse sarif. Check the your tool generation of sarif report, cause: ${e.message}", e.cause)
- }
- copyPaths.associate { copyPath ->
- copyPath.name to warningsFromSarif.filter { it.fileName == copyPath.name }
+ ): WarningMap = when {
+ warnPluginConfig.expectedWarningsFileName != null -> {
+ val expectedWarningsFileName: String = warnPluginConfig.expectedWarningsFileName
+ when (warnPluginConfig.expectedWarningsFormat) {
+ ExpectedWarningsFormat.IN_PLACE, null ->
+ throw IllegalArgumentException("<expectedWarningsFileName> cannot be provided for expectedWarningsFormat=${ExpectedWarningsFormat.IN_PLACE}")
+ ExpectedWarningsFormat.PLAIN -> {
+ val anchorTestFilePath = originalPaths.first()
+ val plainFile = fs.findFileInAncestorDir(anchorTestFilePath, expectedWarningsFileName) ?: throw PluginException(
+ "Could not find PLAIN file with expected warnings/fixes for file $anchorTestFilePath. " +
+ "Please check if correct `WarningsFormat`/`FixFormat` is set (should be PLAIN) and if the file is present and called `$expectedWarningsFileName`."
+ )
+ val warningsFromPlain = plainFile.collectExpectedWarningsWithLineNumbers(
+ warnPluginConfig,
+ generalConfig
+ )
+ copyPaths.associate { copyPath ->
+ copyPath.name to warningsFromPlain.filter { it.fileName == copyPath.name }
+ }
+ }
+ ExpectedWarningsFormat.SARIF -> {
+ val warningsFromSarif = try {
+ collectWarningsFromSarif(expectedWarningsFileName, originalPaths, fs, workingDirectory)
+ } catch (e: Exception) {
+ throw SarifParsingException("We failed to parse sarif. Check the your tool generation of sarif report, cause: ${e.message}", e.cause)
+ }
+ copyPaths.associate { copyPath ->
+ copyPath.name to warningsFromSarif.filter { it.fileName == copyPath.name }
+ }
+ }
+ }
+
  }
- } else {
- copyPaths.associate { copyPath ->
- val warningsForCurrentPath =
+ else -> {
+ require(warnPluginConfig.expectedWarningsFormat != ExpectedWarningsFormat.SARIF) {
+ "<expectedWarningsFileName> should be provided for expectedWarningsFormat=${ExpectedWarningsFormat.SARIF}"
+ }
+ copyPaths.associate { copyPath ->
+ val warningsForCurrentPath =
  copyPath.collectExpectedWarningsWithLineNumbers(
  warnPluginConfig,
  generalConfig
  )
- copyPath.name to warningsForCurrentPath
+ copyPath.name to warningsForCurrentPath
+ }
  }
  }
 

save-plugins/warn-plugin/src/commonMain/kotlin/com/saveourtool/save/plugin/warn/utils/WarningsExtraction.kt

@@ -18,7 +18,6 @@ import io.github.detekt.sarif4k.SarifSchema210
 import okio.FileSystem
 import okio.Path
 
-import kotlinx.serialization.decodeFromString
 import kotlinx.serialization.json.Json
 
 /**
@@ -97,21 +96,19 @@ internal fun collectionSingleWarnings(
  .sortedBy { warn -> warn.message }
 
 /**
- * @param warnPluginConfig
+ * @param sarifFileName
  * @param originalPaths
  * @param fs
  * @param workingDirectory initial working directory, when SAVE started
  * @return a list of warnings extracted from SARIF file for test [file]
  * @throws PluginException
  */
 internal fun collectWarningsFromSarif(
- warnPluginConfig: WarnPluginConfig,
+ sarifFileName: String,
  originalPaths: List<Path>,
  fs: FileSystem,
  workingDirectory: Path,
 ): List<Warning> {
- val sarifFileName = warnPluginConfig.expectedWarningsFileName!!
-
  // Since we have one .sarif file for all tests, just take the first of them as anchor for calculation of paths
  val anchorTestFilePath = originalPaths.first()
  val sarif = calculatePathToSarifFile(