Make output format more consistent

Author: Heliozoa

crates/plugins/java/src/java_plugin.rs

@@ -4,6 +4,7 @@ use crate::{
     error::JavaError, CompileResult, JvmWrapper, TestCase, TestCaseStatus, TestMethod, TestRun,
 };
 use j4rs::InvocationArg;
+use serde::{Deserialize, Serialize};
 use std::{
     collections::HashMap,
     convert::TryFrom,
@@ -13,8 +14,8 @@ use std::{
 };
 use tmc_langs_framework::{
     nom::{bytes, character, combinator, error::VerboseError, sequence, IResult},
-    ExerciseDesc, Language, LanguagePlugin, RunResult, RunStatus, StyleValidationResult, TestDesc,
-    TestResult, TmcCommand,
+    ExerciseDesc, Language, LanguagePlugin, RunResult, RunStatus, StyleValidationError,
+    StyleValidationResult, StyleValidationStrategy, TestDesc, TestResult, TmcCommand,
 };
 use tmc_langs_util::{deserialize, file_util, parse_util};
 use walkdir::WalkDir;
@@ -254,12 +255,12 @@ pub(crate) trait JavaPlugin: LanguagePlugin {
                 &[InvocationArg::from(file), InvocationArg::from(locale)],
             )?;
             let result = jvm.invoke(&checkstyle_runner, "run", InvocationArg::empty())?;
-            let result: StyleValidationResult = jvm.to_rust(result)?;
+            let result: JavaStyleValidationResult = jvm.to_rust(result)?;
             Ok(result)
         })?;
 
         log::debug!("Validation result: {:?}", result);
-        Ok(result)
+        Ok(result.into())
     }
 
     /// Parses @Points("1.1") point annotations.
@@ -291,6 +292,67 @@ pub(crate) trait JavaPlugin: LanguagePlugin {
     }
 }
 
+/// Determines how style errors are handled.
+#[derive(Debug, Deserialize, Serialize, PartialEq, Eq)]
+#[serde(rename_all = "UPPERCASE")]
+pub enum JavaStyleValidationStrategy {
+    Fail,
+    Warn,
+    Disabled,
+}
+
+impl From<JavaStyleValidationStrategy> for StyleValidationStrategy {
+    fn from(value: JavaStyleValidationStrategy) -> Self {
+        match value {
+            JavaStyleValidationStrategy::Fail => Self::Fail,
+            JavaStyleValidationStrategy::Warn => Self::Warn,
+            JavaStyleValidationStrategy::Disabled => Self::Disabled,
+        }
+    }
+}
+
+/// A style validation error.
+#[derive(Debug, Deserialize, Serialize, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
+pub struct JavaStyleValidationError {
+    pub column: u32,
+    pub line: u32,
+    pub message: String,
+    pub source_name: String,
+}
+
+impl From<JavaStyleValidationError> for StyleValidationError {
+    fn from(value: JavaStyleValidationError) -> Self {
+        Self {
+            column: value.column,
+            line: value.line,
+            message: value.message,
+            source_name: value.source_name,
+        }
+    }
+}
+
+/// The result of a style check.
+#[derive(Debug, Deserialize, Serialize, PartialEq, Eq)]
+#[serde(rename_all = "camelCase")]
+pub struct JavaStyleValidationResult {
+    pub strategy: JavaStyleValidationStrategy,
+    pub validation_errors: Option<HashMap<PathBuf, Vec<JavaStyleValidationError>>>,
+}
+
+impl From<JavaStyleValidationResult> for StyleValidationResult {
+    fn from(value: JavaStyleValidationResult) -> Self {
+        Self {
+            strategy: value.strategy.into(),
+            validation_errors: value.validation_errors.map(|hm| {
+                hm.into_iter()
+                    .map(|(k, v)| (k, v.into_iter().map(Into::into).collect()))
+                    .collect()
+            }),
+        }
+    }
+}
+
 #[cfg(test)]
 #[allow(clippy::unwrap_used)]
 mod test {

crates/tmc-langs-cli/tests/snapshots/integration__checkstyle@csharp__failing-exercise.snap

@@ -1,7 +1,7 @@
 ---
 source: crates/tmc-langs-cli/tests/integration.rs
 expression: output
-input_file: crates/tmc-langs-cli/tests/sample_exercises/csharp/failing-exercise
+input_file: sample_exercises/csharp/failing-exercise
 ---
 output-kind: output-data
 status: finished
@@ -11,5 +11,4 @@ data:
   output-data-kind: validation
   output-data:
     strategy: DISABLED
-    validationErrors: ~
-
+    validation_errors: ~

crates/tmc-langs-cli/tests/snapshots/integration__checkstyle@csharp__non-compiling-exercise.snap

@@ -1,7 +1,7 @@
 ---
 source: crates/tmc-langs-cli/tests/integration.rs
 expression: output
-input_file: crates/tmc-langs-cli/tests/sample_exercises/csharp/non-compiling-exercise
+input_file: sample_exercises/csharp/non-compiling-exercise
 ---
 output-kind: output-data
 status: finished
@@ -11,5 +11,4 @@ data:
   output-data-kind: validation
   output-data:
     strategy: DISABLED
-    validationErrors: ~
-
+    validation_errors: ~

crates/tmc-langs-cli/tests/snapshots/integration__checkstyle@csharp__partially-passing.snap

@@ -1,7 +1,7 @@
 ---
 source: crates/tmc-langs-cli/tests/integration.rs
 expression: output
-input_file: crates/tmc-langs-cli/tests/sample_exercises/csharp/partially-passing
+input_file: sample_exercises/csharp/partially-passing
 ---
 output-kind: output-data
 status: finished
@@ -11,5 +11,4 @@ data:
   output-data-kind: validation
   output-data:
     strategy: DISABLED
-    validationErrors: ~
-
+    validation_errors: ~

crates/tmc-langs-cli/tests/snapshots/integration__checkstyle@csharp__passing-exercise.snap

@@ -1,7 +1,7 @@
 ---
 source: crates/tmc-langs-cli/tests/integration.rs
 expression: output
-input_file: crates/tmc-langs-cli/tests/sample_exercises/csharp/passing-exercise
+input_file: sample_exercises/csharp/passing-exercise
 ---
 output-kind: output-data
 status: finished
@@ -11,5 +11,4 @@ data:
   output-data-kind: validation
   output-data:
     strategy: DISABLED
-    validationErrors: ~
-
+    validation_errors: ~

crates/tmc-langs-cli/tests/snapshots/integration__checkstyle@java__ant-exercise.snap

@@ -1,7 +1,7 @@
 ---
 source: crates/tmc-langs-cli/tests/integration.rs
 expression: output
-input_file: crates/tmc-langs-cli/tests/sample_exercises/java/ant-exercise
+input_file: sample_exercises/java/ant-exercise
 ---
 output-kind: output-data
 status: finished
@@ -11,10 +11,9 @@ data:
   output-data-kind: validation
   output-data:
     strategy: FAIL
-    validationErrors:
+    validation_errors:
       Arith.java:
         - column: 0
           line: 7
           message: Indentation incorrect. Expected 4, but was 8.
-          sourceName: com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
+          source_name: com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck

crates/tmc-langs-cli/tests/snapshots/integration__checkstyle@java__maven-exercise.snap

@@ -1,7 +1,7 @@
 ---
 source: crates/tmc-langs-cli/tests/integration.rs
 expression: output
-input_file: crates/tmc-langs-cli/tests/sample_exercises/java/maven-exercise
+input_file: sample_exercises/java/maven-exercise
 ---
 output-kind: output-data
 status: finished
@@ -11,10 +11,9 @@ data:
   output-data-kind: validation
   output-data:
     strategy: FAIL
-    validationErrors:
+    validation_errors:
       fi/helsinki/cs/maventest/App.java:
         - column: 0
           line: 4
           message: Indentation incorrect. Expected 4, but was 8.
-          sourceName: com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck
-
+          source_name: com.puppycrawl.tools.checkstyle.checks.indentation.IndentationCheck

crates/tmc-langs-framework/src/domain.rs

@@ -141,7 +141,6 @@ pub enum StyleValidationStrategy {
 /// A style validation error.
 #[derive(Debug, Deserialize, Serialize, PartialEq, Eq, JsonSchema)]
 #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
-#[serde(rename_all = "camelCase")]
 pub struct StyleValidationError {
     pub column: u32,
     pub line: u32,
@@ -152,7 +151,6 @@ pub struct StyleValidationError {
 /// The result of a style check.
 #[derive(Debug, Deserialize, Serialize, PartialEq, Eq, JsonSchema)]
 #[cfg_attr(feature = "ts-rs", derive(ts_rs::TS))]
-#[serde(rename_all = "camelCase")]
 pub struct StyleValidationResult {
     pub strategy: StyleValidationStrategy,
     pub validation_errors: Option<HashMap<PathBuf, Vec<StyleValidationError>>>,