Merge branch 'yaml-testcases' into 'master'

feat(SDK): YAML testcases

See merge request codingame/game-engine!230

Author: Julien Poulton

playground/core-concepts/core-4-configuration.md

@@ -239,7 +239,7 @@ Optionally, you can tranlate your popups in French using `welcome_fr.html` files
 
 You will need to create test case files to run your **Solo** game.
 
-Your test cases must be named `test<number>.json` and placed in the `config` directory. Their `<number>` determine the order they will be listed in the CodinGame IDE. Here is an example:
+Your test cases must be named `test<number>.json` or `test<number>.yaml` and placed in the `config` directory. Their `<number>` determine the order they will be listed in the CodinGame IDE. Here is an example:
 
 `test1.json`
 ```json
@@ -253,6 +253,22 @@ Your test cases must be named `test<number>.json` and placed in the `config` dir
 	"isValidator": "false"
 }
 ```
+
+or the YAML equivalent:
+
+`test1.yaml`
+```yaml
+title:
+  2: One path
+  1: Un seul chemin
+testIn: |-
+  .o...
+  .ooo.
+  ...o.
+isTest: 'true'
+isValidator: 'false'
+```
+
 - **title:**
     - **2:** English title, this parameter is mandatory.
     - **1:** French title, optional.

runner/pom.xml

@@ -1,4 +1,5 @@
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 	<modelVersion>4.0.0</modelVersion>
 
@@ -45,6 +46,11 @@
 			<artifactId>commons-lang3</artifactId>
 			<version>3.5</version>
 		</dependency>
+		<dependency>
+			<groupId>org.yaml</groupId>
+			<artifactId>snakeyaml</artifactId>
+			<version>1.24</version>
+		</dependency>
 	</dependencies>
 
 </project>

runner/src/main/java/com/codingame/gameengine/runner/ConfigHelper.java

@@ -67,7 +67,7 @@ public void setLeaguesDetected(boolean leaguesDetected) {
         }
     }
 
-    class TestCase {
+    public static class TestCase {
         private Map<Integer, String> title;
         private String testIn;
         private Boolean isTest;
@@ -451,10 +451,10 @@ public GameConfig findConfig(Path rootDir) throws IOException {
             for (String leagueKey : questionsConfig.keySet()) {
                 QuestionConfig questionConfig = questionsConfig.get(leagueKey);
                 questionConfig.merge(defaultConfig);
-                questionConfig.configDetected = isPresentConfigIni(gameConfig, questionConfig);
+                questionConfig.configDetected = isPresentConfigIni(questionConfig);
             }
         } else {
-            defaultConfig.configDetected = isPresentConfigIni(gameConfig, defaultConfig);
+            defaultConfig.configDetected = isPresentConfigIni(defaultConfig);
         }
 
         MutableInt soloQuestions = new MutableInt();
@@ -500,7 +500,7 @@ public GameConfig findConfig(Path rootDir) throws IOException {
         return gameConfig;
     }
 
-    private boolean isPresentConfigIni(GameConfig gameConfig, QuestionConfig questionConfig) {
+    private boolean isPresentConfigIni(QuestionConfig questionConfig) {
         return questionConfig.minPlayers != null || questionConfig.maxPlayers != null;
     }
 }

runner/src/main/java/com/codingame/gameengine/runner/SoloGameRunner.java

@@ -3,14 +3,16 @@
 import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
-import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
 import org.apache.commons.io.FileUtils;
+import org.apache.commons.io.FilenameUtils;
+import org.yaml.snakeyaml.Yaml;
 
-import com.google.gson.JsonObject;
-import com.google.gson.JsonParser;
+import com.codingame.gameengine.runner.ConfigHelper.TestCase;
+import com.google.gson.Gson;
+import com.google.gson.JsonSyntaxException;
 
 /**
  * The class to use to run local games and display the replay in a webpage on a temporary local server.
@@ -27,18 +29,33 @@ public SoloGameRunner() {
     }
 
     private List<String> getLinesFromTestCaseFile(File file) {
-        List<String> lines = new ArrayList<>();
+        TestCase testCase;
         try {
-            JsonObject testCaseJson = new JsonParser().parse(FileUtils.readFileToString(file, StandardCharsets.UTF_8)).getAsJsonObject();
-            lines.addAll(Arrays.asList(testCaseJson.get("testIn").getAsString().split("\\n")));
+            testCase = parseTestCaseFile(file);
         } catch (IOException e) {
-            throw new RuntimeException("Cannot read file", e);
-        } catch (NullPointerException e) {
-            throw new RuntimeException("Cannot find \"testIn\" property");
+            throw new RuntimeException("Cannot read file " + file.getName(), e);
         } catch (Exception e) {
-            throw new RuntimeException("Cannot parse file", e);
+            throw new RuntimeException("Cannot parse file " + file.getName(), e);
+        }
+
+        if (testCase.getTestIn() == null) {
+            throw new RuntimeException("Cannot find \"testIn\" property");
+        }
+
+        return Arrays.asList(testCase.getTestIn().split("\\n"));
+    }
+
+    private TestCase parseTestCaseFile(File file) throws JsonSyntaxException, IOException {
+        String extension = FilenameUtils.getExtension(file.getName());
+
+        switch (extension.toLowerCase()) {
+        case "yaml":
+        case "yml":
+            return new Yaml().loadAs(FileUtils.readFileToString(file, StandardCharsets.UTF_8), TestCase.class);
+        case "json":
+        default:
+            return new Gson().fromJson(FileUtils.readFileToString(file, StandardCharsets.UTF_8), TestCase.class);
         }
-        return lines;
     }
 
     /**
@@ -47,7 +64,7 @@ private List<String> getLinesFromTestCaseFile(File file) {
      * The file path must be relative considering the root directory is <b>config</b>.
      * 
      * @param testCaseFileName
-     *            the test case file path
+     *            the test case file path (JSON or YAML)
      */
     public void setTestCase(String testCaseFileName) {
         setTestCase(new File(System.getProperty("user.dir")).toPath().resolve("config/" + testCaseFileName).toFile());
@@ -57,7 +74,7 @@ public void setTestCase(String testCaseFileName) {
      * Sets a test case file which <b>testIn</b> value will be sent to the Game Manager as a test case input.
      * 
      * @param testCaseFile
-     *            the test case file
+     *            the test case file (JSON or YAML)
      */
     public void setTestCase(File testCaseFile) {
         if (testCaseFile == null) {
@@ -66,10 +83,10 @@ public void setTestCase(File testCaseFile) {
         if (!testCaseFile.isFile()) {
             throw new RuntimeException("Given test case is not a file " + testCaseFile.getAbsolutePath());
         }
-        
+
         setTestCaseInput(getLinesFromTestCaseFile(testCaseFile));
     }
-    
+
     /**
      * Sets a list of <code>String</code> as a test case input that will be sent to the Game Manager.
      * 
@@ -79,7 +96,7 @@ public void setTestCase(File testCaseFile) {
     public void setTestCaseInput(List<String> testCaseInput) {
         this.testCaseInput = testCaseInput;
     }
-    
+
     /**
      * Sets a <code>String</code> as a test case input that will be sent to the Game Manager.
      * <p>