test: Importer tests

JeremyMeissner · JeremyMeissner · commit 9a5e556b0c34 · 2022-04-05T10:15:10.000+02:00
diff --git a/FreeFrame.sln b/FreeFrame.sln
@@ -3,7 +3,9 @@ Microsoft Visual Studio Solution File, Format Version 12.00
 # Visual Studio Version 17
 VisualStudioVersion = 17.1.32228.430
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FreeFrame", "FreeFrame\FreeFrame.csproj", "{0B6F5913-5F9E-43E6-9C2B-6458771C0B64}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "FreeFrame", "FreeFrame\FreeFrame.csproj", "{0B6F5913-5F9E-43E6-9C2B-6458771C0B64}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FreeFrameTests", "FreeFrameTests\FreeFrameTests.csproj", "{C9665752-3F93-4FA8-8F2C-BF701D932E8A}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -15,6 +17,10 @@ Global
 		{0B6F5913-5F9E-43E6-9C2B-6458771C0B64}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{0B6F5913-5F9E-43E6-9C2B-6458771C0B64}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{0B6F5913-5F9E-43E6-9C2B-6458771C0B64}.Release|Any CPU.Build.0 = Release|Any CPU
+		{C9665752-3F93-4FA8-8F2C-BF701D932E8A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{C9665752-3F93-4FA8-8F2C-BF701D932E8A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{C9665752-3F93-4FA8-8F2C-BF701D932E8A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{C9665752-3F93-4FA8-8F2C-BF701D932E8A}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/FreeFrame/Components/Importer.cs b/FreeFrame/Components/Importer.cs
@@ -8,7 +8,7 @@
 
 namespace FreeFrame.Components
 {
-    static class Importer
+    public static class Importer
     {
         static public void Import()
         {
@@ -17,32 +17,50 @@ static public void Import()
             //{
             //}
         }
-        static public List<Shape> Import(string filename)
+        static public List<Shape> ImportFromStream(Stream pStream)
         {
-            if (!File.Exists(filename))
-                throw new ArgumentException($"'{nameof(filename)}' file cannot be found.", nameof(filename)); //TODO: replace by a simple alert window
-
             List<Shape> shapes = new List<Shape>();
 
-            using (XmlReader reader = XmlReader.Create(filename))
+            using (XmlReader reader = XmlReader.Create(pStream))
             {
-                while(reader.Read())
+                while (reader.Read())
                 {
                     if (reader.HasAttributes)
                     {
                         Console.WriteLine("Attributes of <" + reader.Name + ">");
                         switch (reader.Name)
                         {
+                            case "xml":
+                            case "svg":
+                            case "rect":
+                            case "path":
+                                break;
                             case "circle":
                                 shapes.Add(new SVGCircle(reader));
                                 break;
                             default:
+                                // TODO: show all the elemnt are not valid, be careful
                                 break;
                         }
                     }
                 }
             }
             return (shapes);
         }
+        static public List<Shape> ImportFromFile(string pFilename)
+        {
+            if (!File.Exists(pFilename))
+                throw new ArgumentException($"'{nameof(pFilename)}' file cannot be found.", nameof(pFilename)); //TODO: replace by a simple alert window
+
+            byte[] byteArray = Encoding.UTF8.GetBytes(File.ReadAllText(pFilename));
+
+            return ImportFromStream(new MemoryStream(byteArray));
+        }
+        static public List<Shape> ImportFromString(string pString)
+        {
+            byte[] byteArray = Encoding.UTF8.GetBytes(pString);
+
+            return ImportFromStream(new MemoryStream(byteArray));
+        }
     }
 }
diff --git a/FreeFrame/Components/Shapes/SVGCircle.cs b/FreeFrame/Components/Shapes/SVGCircle.cs
@@ -6,7 +6,7 @@
 
 namespace FreeFrame.Components.Shapes
 {
-    class SVGCircle : Shape
+    public class SVGCircle : Shape
     {
         #region Geometry properties
         private float _cx;
diff --git a/FreeFrame/Components/Shapes/SVGPath.cs b/FreeFrame/Components/Shapes/SVGPath.cs
@@ -5,7 +5,7 @@
 
 namespace FreeFrame.Components.Shapes
 {
-    class SVGPath : Shape
+    public class SVGPath : Shape
     {
         // https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths
         // https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d
diff --git a/FreeFrame/Components/Shapes/SVGPolygon.cs b/FreeFrame/Components/Shapes/SVGPolygon.cs
@@ -4,7 +4,7 @@
 
 namespace FreeFrame.Components.Shapes
 {
-    class SVGPolygon : Shape
+    public class SVGPolygon : Shape
     {
         #region Geometry properties
         List<float> points = new List<float>();
diff --git a/FreeFrame/Components/Shapes/SVGRectangle.cs b/FreeFrame/Components/Shapes/SVGRectangle.cs
@@ -5,7 +5,7 @@
 
 namespace FreeFrame.Components.Shapes
 {
-    class SVGRectangle : Shape
+    public class SVGRectangle : Shape
     {
         #region Geometry properties
         private float _x;
diff --git a/FreeFrame/Components/Shapes/Shape.cs b/FreeFrame/Components/Shapes/Shape.cs
@@ -5,7 +5,7 @@
 
 namespace FreeFrame.Components.Shapes
 {
-    abstract class Shape
+    public abstract class Shape
     {
         public Shape()
         {
diff --git a/FreeFrame/FreeFrame.csproj b/FreeFrame/FreeFrame.csproj
@@ -11,4 +11,8 @@
     <PackageReference Include="OpenTK" Version="4.7.1" />
   </ItemGroup>
 
+  <ItemGroup>
+    <Folder Include="Tests\" />
+  </ItemGroup>
+
 </Project>
diff --git a/FreeFrame/Program.cs b/FreeFrame/Program.cs
@@ -9,7 +9,7 @@ class Program
     {
         static void Main()
         {
-            List<Shape> shapes = Importer.Import("test.svg");
+            List<Shape> shapes = Importer.ImportFromFile("test.svg");
 
             shapes.ForEach(shape => Console.WriteLine(shape));
         }
diff --git a/FreeFrameTests/FreeFrameTests.csproj b/FreeFrameTests/FreeFrameTests.csproj
@@ -0,0 +1,21 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net6.0</TargetFramework>
+    <Nullable>enable</Nullable>
+
+    <IsPackable>false</IsPackable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.11.0" />
+    <PackageReference Include="MSTest.TestAdapter" Version="2.2.7" />
+    <PackageReference Include="MSTest.TestFramework" Version="2.2.7" />
+    <PackageReference Include="coverlet.collector" Version="3.1.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\FreeFrame\FreeFrame.csproj" />
+  </ItemGroup>
+
+</Project>
diff --git a/FreeFrameTests/ImporterTests.cs b/FreeFrameTests/ImporterTests.cs
@@ -0,0 +1,48 @@
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using FreeFrame;
+using FreeFrame.Components;
+using System.Collections.Generic;
+using FreeFrame.Components.Shapes;
+using System;
+
+namespace FreeFrameTests
+{
+    [TestClass]
+    public class ImporterTests
+    {
+        [TestMethod]
+        public void ImportFromStream_Test_OneElement()
+        {
+            // Arrange
+            string svgString = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
+                "<svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" width=\"1000\" height=\"1000\">" +
+                "<circle cx=\"600\" cy=\"200\" r=\"100\" fill=\"red\" stroke=\"blue\" stroke-width=\"10\"  />" +
+                "<rect width=\"100\" height=\"50\" fill=\"green\" />" +
+                "<path d=\"M 20 0 C 0 100, 200 100, 180 0\" stroke=\"black\" fill=\"transparent\"/>" +
+                "</svg>";
+            List<Shape> result = Importer.ImportFromString(svgString);
+
+            // Assert
+            Assert.AreEqual(result.Count, 1);
+            Assert.AreEqual(((SVGCircle)result[0]).ToString(), "cx: 600, cy: 200, r: 100");
+        }
+        [TestMethod]
+        public void ImportFromStream_Test_MutlipleElements()
+        {
+            // Arrange
+            string svgString = "<?xml version=\"1.0\" encoding=\"utf-8\"?>" +
+                "<svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" width=\"1000\" height=\"1000\">" +
+                "<circle cx=\"600\" cy=\"200\" r=\"100\" fill=\"red\" stroke=\"blue\" stroke-width=\"10\"/>" +
+                "<rect width=\"100\" height=\"50\" fill=\"green\" />" +
+                "<path d=\"M 20 0 C 0 100, 200 100, 180 0\" stroke=\"black\" fill=\"transparent\"/>" +
+                "</svg>";
+            List<Shape> result = Importer.ImportFromString(svgString);
+
+            // Assert
+            Assert.AreEqual(result.Count, 3);
+            Assert.AreEqual(((SVGCircle)result[0]).ToString(), "cx: 600, cy: 200, r: 100");
+            Assert.AreEqual(((SVGRectangle)result[1]).ToString(), "width: 100, height: 50");
+            Assert.AreEqual(((SVGPath)result[2]).ToString(), "M: 20 0, C: 0 100, 200 100, 180 0");
+        }
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`
`9`	`9`	`namespace FreeFrame.Components`
`10`	`10`	`{`
`11`		`- static class Importer`
	`11`	`+ public static class Importer`
`12`	`12`	`{`
`13`	`13`	`static public void Import()`
`14`	`14`	`{`
`@@ -17,32 +17,50 @@ static public void Import()`
`17`	`17`	`//{`
`18`	`18`	`//}`
`19`	`19`	`}`
`20`		`- static public List<Shape> Import(string filename)`
	`20`	`+ static public List<Shape> ImportFromStream(Stream pStream)`
`21`	`21`	`{`
`22`		`- if (!File.Exists(filename))`
`23`		`- throw new ArgumentException($"'{nameof(filename)}' file cannot be found.", nameof(filename)); //TODO: replace by a simple alert window`
`24`		`-`
`25`	`22`	`List<Shape> shapes = new List<Shape>();`
`26`	`23`
`27`		`- using (XmlReader reader = XmlReader.Create(filename))`
	`24`	`+ using (XmlReader reader = XmlReader.Create(pStream))`
`28`	`25`	`{`
`29`		`- while(reader.Read())`
	`26`	`+ while (reader.Read())`
`30`	`27`	`{`
`31`	`28`	`if (reader.HasAttributes)`
`32`	`29`	`{`
`33`	`30`	`Console.WriteLine("Attributes of <" + reader.Name + ">");`
`34`	`31`	`switch (reader.Name)`
`35`	`32`	`{`
	`33`	`+ case "xml":`
	`34`	`+ case "svg":`
	`35`	`+ case "rect":`
	`36`	`+ case "path":`
	`37`	`+ break;`
`36`	`38`	`case "circle":`
`37`	`39`	`shapes.Add(new SVGCircle(reader));`
`38`	`40`	`break;`
`39`	`41`	`default:`
	`42`	`+ // TODO: show all the elemnt are not valid, be careful`
`40`	`43`	`break;`
`41`	`44`	`}`
`42`	`45`	`}`
`43`	`46`	`}`
`44`	`47`	`}`
`45`	`48`	`return (shapes);`
`46`	`49`	`}`
	`50`	`+ static public List<Shape> ImportFromFile(string pFilename)`
	`51`	`+ {`
	`52`	`+ if (!File.Exists(pFilename))`
	`53`	`+ throw new ArgumentException($"'{nameof(pFilename)}' file cannot be found.", nameof(pFilename)); //TODO: replace by a simple alert window`
	`54`	`+`
	`55`	`+ byte[] byteArray = Encoding.UTF8.GetBytes(File.ReadAllText(pFilename));`
	`56`	`+`
	`57`	`+ return ImportFromStream(new MemoryStream(byteArray));`
	`58`	`+ }`
	`59`	`+ static public List<Shape> ImportFromString(string pString)`
	`60`	`+ {`
	`61`	`+ byte[] byteArray = Encoding.UTF8.GetBytes(pString);`
	`62`	`+`
	`63`	`+ return ImportFromStream(new MemoryStream(byteArray));`
	`64`	`+ }`
`47`	`65`	`}`
`48`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`namespace FreeFrame.Components.Shapes`
`8`	`8`	`{`
`9`		`- class SVGCircle : Shape`
	`9`	`+ public class SVGCircle : Shape`
`10`	`10`	`{`
`11`	`11`	`#region Geometry properties`
`12`	`12`	`private float _cx;`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`namespace FreeFrame.Components.Shapes`
`7`	`7`	`{`
`8`		`- class SVGPath : Shape`
	`8`	`+ public class SVGPath : Shape`
`9`	`9`	`{`
`10`	`10`	`// https://developer.mozilla.org/en-US/docs/Web/SVG/Tutorial/Paths`
`11`	`11`	`// https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute/d`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace FreeFrame.Components.Shapes`
`6`	`6`	`{`
`7`		`- class SVGPolygon : Shape`
	`7`	`+ public class SVGPolygon : Shape`
`8`	`8`	`{`
`9`	`9`	`#region Geometry properties`
`10`	`10`	`List<float> points = new List<float>();`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`namespace FreeFrame.Components.Shapes`
`7`	`7`	`{`
`8`		`- class SVGRectangle : Shape`
	`8`	`+ public class SVGRectangle : Shape`
`9`	`9`	`{`
`10`	`10`	`#region Geometry properties`
`11`	`11`	`private float _x;`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`namespace FreeFrame.Components.Shapes`
`7`	`7`	`{`
`8`		`- abstract class Shape`
	`8`	`+ public abstract class Shape`
`9`	`9`	`{`
`10`	`10`	`public Shape()`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ class Program`
`9`	`9`	`{`
`10`	`10`	`static void Main()`
`11`	`11`	`{`
`12`		`- List<Shape> shapes = Importer.Import("test.svg");`
	`12`	`+ List<Shape> shapes = Importer.ImportFromFile("test.svg");`
`13`	`13`
`14`	`14`	`shapes.ForEach(shape => Console.WriteLine(shape));`
`15`	`15`	`}`