Merge pull request #16 from Software-Engineering-DHBW/TestsWithRefactoring

some more test and also try catch in SaveSystem

Author: EvilBunny333

LearningForDummies/Assets/Editor/Tests/Test.cs

@@ -3,6 +3,7 @@
 using NUnit.Framework;
 using UnityEngine;
 using UnityEngine.TestTools;
+using SaveData;
 
 public class Test
 {
@@ -18,6 +19,7 @@ public void loadRawReturnsNull(string catalogueName)
         SaveSystem saveSystem = new SaveSystem();
         var answer = saveSystem.loadTextRawFromJson(catalogueName);
         Assert.AreEqual(answer, null);
+        //should be null for cataloguenames that are not in the app
     }
     [Test]
     [TestCase("Test")]
@@ -30,13 +32,47 @@ public void loadPlayerProfileReturnsNull(string profileName)
         SaveSystem saveSystem = new SaveSystem();
         var answer = saveSystem.loadPlayerProfileFromJson(profileName);
         Assert.AreEqual(answer, null);
+        //should be null when the app is shipped because there is no profile
     }
+
     [Test]
     public void loadCatalougesReturnsNull()
     {
         SaveSystem saveSystem = new SaveSystem();
         var answer = saveSystem.loadQuestionCataloguesFromJson();
+        //Assert.IsInstanceOf<List<QuestionCatalogue>>(answer);
         Assert.AreEqual(answer, null);
+        //should be null if there are no catalogues
+        //should be of type List<QuestionCatalogues> if something is found in the foulder
+    }
+
+    [Test]
+    [TestCase("Name", "Data")]
+    public void saveRawReturnsOK(string name, string data)
+    {
+        SaveSystem saveSystem = new SaveSystem();
+        SaveSystem.StatusCodes answer = saveSystem.saveRawJsonTextToJson(name, data);
+        Assert.AreEqual(answer, SaveSystem.StatusCodes.OK);
+        //should be ok
+    }
+
+    [Test]
+    public void saveCatalogueReturnsOK()
+    {
+        QuestionCatalogue catalogue = new QuestionCatalogue();
+        SaveSystem saveSystem = new SaveSystem();
+        SaveSystem.StatusCodes answer = saveSystem.saveQuestionCatalogueToJson(catalogue);
+        Assert.AreEqual(answer, SaveSystem.StatusCodes.OK);
+        //should be ok
+    }
+
+    [Test]
+    public void saveProfileReturnsOK()
+    {
+        PlayerProfile player = new PlayerProfile();
+        SaveSystem saveSystem = new SaveSystem();
+        SaveSystem.StatusCodes answer = saveSystem.savePlayerProfileToJson(player);
+        Assert.AreEqual(answer, SaveSystem.StatusCodes.OK);
+        //should be ok
     }
-    
 }

LearningForDummies/Assets/Scripts/SaveSystem.cs

@@ -11,6 +11,7 @@ public class SaveSystem : MonoBehaviour
 
     string filePath;
     string playerProfilePath;
+    public enum StatusCodes{OK,Error};
 
 
     private void Awake()
@@ -35,32 +36,51 @@ private void Awake()
 
     }
 
-    public void saveRawJsonTextToJson(string catalogueName, string data)
+    public StatusCodes saveRawJsonTextToJson(string catalogueName, string data)
     {
+        try{
         string filename = "/" + catalogueName + ".qcat";
         string content = data;
         System.IO.File.WriteAllText(Application.persistentDataPath + filename, content);
         Debug.Log("Speicherung erfolgt als... " + filename);
+        return StatusCodes.OK;
+        }
+        catch{
+            return StatusCodes.Error;
+        }
     }
 
-    public void saveQuestionCatalogueToJson(QuestionCatalogue _questionCatalogue)
+    public StatusCodes saveQuestionCatalogueToJson(QuestionCatalogue _questionCatalogue)
     {
+        try{
         string fileName = "/" + _questionCatalogue.fileName + ".qcat";
         string content = JsonUtility.ToJson(_questionCatalogue);
         System.IO.File.WriteAllText(Application.persistentDataPath + fileName, content);
         Debug.Log("QuestionCatalogue has been successfully saved to the FileSystem");
+        return StatusCodes.OK;
+        }
+        catch{
+            return StatusCodes.Error;
+        }
     }
 
-    public void savePlayerProfileToJson(PlayerProfile _playerProfile)
+    public StatusCodes savePlayerProfileToJson(PlayerProfile _playerProfile)
     {
+        try{
         string fileName = "/" + _playerProfile.fileName + ".pp";
         string content = JsonUtility.ToJson(_playerProfile);
         System.IO.File.WriteAllText(Application.persistentDataPath + fileName, content);
         Debug.Log("PlayerProfile has been successfully saved to the FileSystem");
+        return StatusCodes.OK;
+        }
+        catch{
+            return StatusCodes.Error;
+        }
     }
 
     public string loadTextRawFromJson(string catalogueName)
     {
+        try{
         string extension = "*.qcat"; // The "*" ist really important. It is a placeholder for the rest of the File
         string[] Files = Directory.GetFiles(Application.persistentDataPath, extension);
         foreach (string file in Files)
@@ -80,6 +100,10 @@ public string loadTextRawFromJson(string catalogueName)
         }
         Debug.Log("----------\nOPERATION FAILED\n----------");
         return null;
+        }
+        catch{
+            return StatusCodes.Error.ToString();
+        }
     }
 
     public List<QuestionCatalogue> loadQuestionCataloguesFromJson()
@@ -91,21 +115,31 @@ public List<QuestionCatalogue> loadQuestionCataloguesFromJson()
         {
             Debug.Log("The following file has been found: " + Path.GetFileName(file));
             string DataFromJson = File.ReadAllText(file);
+            try{
             QuestionCatalogue questionCatalogue = JsonUtility.FromJson<QuestionCatalogue>(DataFromJson);
             allCatalogues.Add(questionCatalogue);
             Debug.Log("A catalogue has been added to the List.");
+            }
+            catch{
+                Debug.Log("The file format was invalid.");
+            }
         }
         if (Files.Length == 0)
         {
             Debug.Log("No files with the extension " + extension + " have been found.");
             return null;
         }
+        else if(allCatalogues.Count == 0){
+            Debug.Log("A file was found but not compatible.");
+            return null;
+        }
         Debug.Log("The List of found QuestionCatalogues contains " + allCatalogues.Count + " QuestionCatalogues.");
         return allCatalogues;
     }
 
     public PlayerProfile loadPlayerProfileFromJson(string fileName)
     {
+        try{
         string extension = "*.pp"; // The "*" ist really important. It is a placeholder for the rest of the File
         string[] Files = Directory.GetFiles(Application.persistentDataPath, extension);
         foreach (string file in Files)
@@ -127,6 +161,10 @@ public PlayerProfile loadPlayerProfileFromJson(string fileName)
         }
         Debug.Log("----------\nOPERATION FAILED\n----------");
         return null;
+        }
+        catch{
+            return null;
+        }
     }