Add JUnitXmlWriter

nowsprinting · May 6, 2024 · 7018845 · 7018845
1 parent 35ec1c6
commit 7018845
Show file tree

Hide file tree

Showing 17 changed files with 317 additions and 0 deletions.
diff --git a/Editor/JUnitXmlWriter.cs b/Editor/JUnitXmlWriter.cs
@@ -0,0 +1,41 @@
+// Copyright (c) 2023-2024 Koji Hasegawa.
+// This software is released under the MIT License.
+
+using System.IO;
+using System.Xml;
+using System.Xml.XPath;
+using System.Xml.Xsl;
+using UnityEditor.TestTools.TestRunner.Api;
+
+namespace TestHelper.Editor
+{
+    public static class JUnitXmlWriter
+    {
+        private const string XsltPath = "Packages/com.nowsprinting.test-helper/Editor/nunit3-junit/nunit3-junit.xslt";
+        // Note: This XSLT file is copied from https://github.com/nunit/nunit-transforms/tree/master/nunit3-junit
+
+        public static void WriteTo(ITestResultAdaptor result, string path)
+        {
+            // Input
+            var nunit3XmlStream = new MemoryStream();
+            var nunit3Writer = XmlWriter.Create(nunit3XmlStream);
+            result.ToXml().WriteTo(nunit3Writer);
+            var nunit3Xml = new XPathDocument(nunit3XmlStream);
+
+            // Create output directory if it does not exist.
+            var directory = Path.GetDirectoryName(path);
+            if (directory != null && !Directory.Exists(directory))
+            {
+                Directory.CreateDirectory(directory);
+            }
+
+            // Output (JUnit XML)
+            var writer = XmlWriter.Create(path);
+
+            // Execute the transformation.
+            var transformer = new XslCompiledTransform();
+            transformer.Load(XsltPath);
+            transformer.Transform(nunit3Xml, writer);
+        }
+    }
+}
diff --git a/Editor/JUnitXmlWriter.cs.meta b/Editor/JUnitXmlWriter.cs.meta
diff --git a/Editor/TestRunnerCallbacksImpl.cs b/Editor/TestRunnerCallbacksImpl.cs
@@ -0,0 +1,41 @@
+// Copyright (c) 2023-2024 Koji Hasegawa.
+// This software is released under the MIT License.
+
+using TestHelper.RuntimeInternals;
+using UnityEditor;
+using UnityEditor.TestTools.TestRunner.Api;
+using UnityEngine;
+
+namespace TestHelper.Editor
+{
+    public class TestRunnerCallbacksImpl : ICallbacks
+    {
+        [InitializeOnLoadMethod]
+        private static void SetupCallbacks()
+        {
+            var api = ScriptableObject.CreateInstance<TestRunnerApi>();
+            api.RegisterCallbacks(new TestRunnerCallbacksImpl());
+        }
+
+        public void RunStarted(ITestAdaptor testsToRun)
+        {
+        }
+
+        public void RunFinished(ITestResultAdaptor result)
+        {
+            var path = CommandLineArgs.GetJUnitResultsPath();
+            if (path != null)
+            {
+                JUnitXmlWriter.WriteTo(result, path);
+            }
+        }
+
+        public void TestStarted(ITestAdaptor test)
+        {
+        }
+
+        public void TestFinished(ITestResultAdaptor result)
+        {
+        }
+    }
+}
diff --git a/Editor/TestRunnerCallbacksImpl.cs.meta b/Editor/TestRunnerCallbacksImpl.cs.meta
diff --git a/Makefile b/Makefile
@@ -65,6 +65,7 @@ $(TEST_FILTER) \
 $(ASSEMBLY_NAMES) \
 -testPlatform $(TEST_PLATFORM) \
 -testResults $(LOG_DIR)/test_$(TEST_PLATFORM)_results.xml \
+-testHelperJUnitResults $(LOG_DIR)/test_$(TEST_PLATFORM)_junit_results.xml \
 -testHelperScreenshotDirectory $(LOG_DIR)/Screenshots
 endef
 

diff --git a/RuntimeInternals/CommandLineArgs.cs b/RuntimeInternals/CommandLineArgs.cs
@@ -54,5 +54,24 @@ public static string GetScreenshotDirectory(string[] args = null)
                 return Path.Combine(Application.persistentDataPath, "TestHelper", "Screenshots");
             }
         }
+
+        /// <summary>
+        /// JUnit XML report save path.
+        /// </summary>
+        /// <returns></returns>
+        public static string GetJUnitResultsPath(string[] args = null)
+        {
+            const string JUnitResultsKey = "-testHelperJUnitResults";
+
+            try
+            {
+                args = args ?? Environment.GetCommandLineArgs();
+                return DictionaryFromCommandLineArgs(args)[JUnitResultsKey];
+            }
+            catch (KeyNotFoundException)
+            {
+                return null;
+            }
+        }
     }
 }
diff --git a/Tests/Editor/JUnitXmlWriterTest.cs b/Tests/Editor/JUnitXmlWriterTest.cs
@@ -0,0 +1,46 @@
+// Copyright (c) 2023-2024 Koji Hasegawa.
+// This software is released under the MIT License.
+
+using System.IO;
+using NUnit.Framework;
+using TestHelper.Editor.TestDoubles;
+
+namespace TestHelper.Editor
+{
+    [TestFixture]
+    public class JUnitXmlWriterTest
+    {
+        private const string TestResourcesPath = "Packages/com.nowsprinting.test-helper/Tests/Editor/TestResources";
+        private const string TestOutputDirectoryPath = "Logs/JUnitXmlWriterTest";
+        // Note: relative path from the project root directory.
+
+        [Test, Order(0)]
+        public void WriteTo_DirectoryDoesNotExist_CreateDirectoryAndWriteToFile()
+        {
+            if (Directory.Exists(TestOutputDirectoryPath))
+            {
+                Directory.Delete(TestOutputDirectoryPath, true);
+            }
+
+            var nunitXmlPath = Path.Combine(TestResourcesPath, "nunit3.xml");
+            var result = new FakeTestResultAdaptor(nunitXmlPath);
+            var path = Path.Combine(TestOutputDirectoryPath, TestContext.CurrentContext.Test.Name + ".xml");
+            JUnitXmlWriter.WriteTo(result, path);
+
+            Assert.That(path, Does.Exist);
+        }
+
+        [Test]
+        public void WriteTo_WriteToFile()
+        {
+            var nunitXmlPath = Path.Combine(TestResourcesPath, "nunit3.xml");
+            var result = new FakeTestResultAdaptor(nunitXmlPath);
+            var path = Path.Combine(TestOutputDirectoryPath, TestContext.CurrentContext.Test.Name + ".xml");
+            JUnitXmlWriter.WriteTo(result, path);
+
+            var actual = File.ReadAllText(path);
+            var expected = File.ReadAllText(Path.Combine(TestResourcesPath, "junit.xml"));
+            Assert.That(actual, Is.EqualTo(expected));
+        }
+    }
+}
diff --git a/Tests/Editor/JUnitXmlWriterTest.cs.meta b/Tests/Editor/JUnitXmlWriterTest.cs.meta
diff --git a/Tests/Editor/TestDoubles.meta b/Tests/Editor/TestDoubles.meta
diff --git a/Tests/Editor/TestDoubles/FakeTestResultAdaptor.cs b/Tests/Editor/TestDoubles/FakeTestResultAdaptor.cs
@@ -0,0 +1,54 @@
+// Copyright (c) 2023-2024 Koji Hasegawa.
+// This software is released under the MIT License.
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using NUnit.Framework.Interfaces;
+using UnityEditor.TestTools.TestRunner.Api;
+using TestStatus = UnityEditor.TestTools.TestRunner.Api.TestStatus;
+
+namespace TestHelper.Editor.TestDoubles
+{
+    /// <summary>
+    /// Implemented only <c>ToXml</c> method.
+    /// </summary>
+    public class FakeTestResultAdaptor : ITestResultAdaptor
+    {
+        private readonly string _path;
+
+        /// <summary>
+        /// Constructor.
+        /// </summary>
+        /// <param name="path">NUnit3 XML file path used in <c>ToXml</c> method.</param>
+        public FakeTestResultAdaptor(string path)
+        {
+            _path = path;
+        }
+
+        public TNode ToXml()
+        {
+            var xmlText = File.ReadAllText(_path);
+            return TNode.FromXml(xmlText);
+        }
+
+        public ITestAdaptor Test { get { throw new NotImplementedException(); } }
+        public string Name { get { throw new NotImplementedException(); } }
+        public string FullName { get { throw new NotImplementedException(); } }
+        public string ResultState { get { throw new NotImplementedException(); } }
+        public TestStatus TestStatus { get { throw new NotImplementedException(); } }
+        public double Duration { get { throw new NotImplementedException(); } }
+        public DateTime StartTime { get { throw new NotImplementedException(); } }
+        public DateTime EndTime { get { throw new NotImplementedException(); } }
+        public string Message { get { throw new NotImplementedException(); } }
+        public string StackTrace { get { throw new NotImplementedException(); } }
+        public int AssertCount { get { throw new NotImplementedException(); } }
+        public int FailCount { get { throw new NotImplementedException(); } }
+        public int PassCount { get { throw new NotImplementedException(); } }
+        public int SkipCount { get { throw new NotImplementedException(); } }
+        public int InconclusiveCount { get { throw new NotImplementedException(); } }
+        public bool HasChildren { get { throw new NotImplementedException(); } }
+        public IEnumerable<ITestResultAdaptor> Children { get { throw new NotImplementedException(); } }
+        public string Output { get { throw new NotImplementedException(); } }
+    }
+}
diff --git a/Tests/Editor/TestDoubles/FakeTestResultAdaptor.cs.meta b/Tests/Editor/TestDoubles/FakeTestResultAdaptor.cs.meta
diff --git a/Tests/Editor/TestResources.meta b/Tests/Editor/TestResources.meta
diff --git a/Tests/Editor/TestResources/junit.xml b/Tests/Editor/TestResources/junit.xml
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?><testsuites tests="3" failures="0" disabled="0" time="0.2538825"><testsuite tests="1" time="0.092622" errors="0" failures="0" skipped="0" timestamp="2024-05-03 10:09:28Z" name="UnityProject~.TestHelper.Editor."><testcase name="Attach_CreateNewSceneWithCameraAndLight" assertions="0" time="0.036802" status="Passed" classname="TestHelper.Editor.CreateSceneAttributeTest"><system-out>[Code Coverage] Code Coverage results for visited sequence points were saved in /github/workspace/CodeCoverage/UnityProject~-opencov/EditMode/TestCoverageResults_0001.xml
+</system-out></testcase></testsuite><testsuite tests="1" time="0.089184" errors="0" failures="0" skipped="0" timestamp="2024-05-03 10:09:28Z" name="UnityProject~.TestHelper.Editor."><testcase name="Attach_LoadedSceneNotInBuild" assertions="0" time="0.053176" status="Passed" classname="TestHelper.Editor.LoadSceneAttributeTest"><system-out>[Code Coverage] Code Coverage results for visited sequence points were saved in /github/workspace/CodeCoverage/UnityProject~-opencov/EditMode/TestCoverageResults_0002.xml
+</system-out></testcase></testsuite><testsuite tests="1" time="0.055223" errors="0" failures="0" skipped="0" timestamp="2024-05-03 10:09:28Z" name="UnityProject~.TestHelper.Editor."><testcase name="GetScenesUsingInTest_AttachedToMethod_ReturnScenesSpecifiedByAttribute" assertions="0" time="0.014506" status="Passed" classname="TestHelper.Editor.TemporaryBuildScenesUsingInTestTest"><system-out>[Code Coverage] Code Coverage results for visited sequence points were saved in /github/workspace/CodeCoverage/UnityProject~-opencov/EditMode/TestCoverageResults_0003.xml
+[Code Coverage] Code Coverage Report was generated in /github/workspace/CodeCoverage/Report
+Included Assemblies: TestHelper,TestHelper.RuntimeInternals,TestHelper.Editor,
+Excluded Assemblies: *.Tests
+Included Paths: &lt;Not specified&gt;
+Excluded Paths: &lt;Not specified&gt;
+Saving results to: /github/workspace/artifacts/editmode-results.xml
+</system-out></testcase></testsuite></testsuites>
diff --git a/Tests/Editor/TestResources/junit.xml.meta b/Tests/Editor/TestResources/junit.xml.meta
diff --git a/Tests/Editor/TestResources/nunit3.xml b/Tests/Editor/TestResources/nunit3.xml
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="utf-8"?>
+<test-run id="2" testcasecount="3" result="Passed" total="3" passed="3" failed="0" inconclusive="0" skipped="0" asserts="0" engine-version="3.5.0.0" clr-version="4.0.30319.42000" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.2538825">
+  <test-suite type="TestSuite" id="1000" name="UnityProject~" fullname="UnityProject~" runstate="Runnable" testcasecount="3" result="Passed" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.253883" total="3" passed="3" failed="0" inconclusive="0" skipped="0" asserts="0">
+    <properties>
+      <property name="platform" value="EditMode" />
+    </properties>
+    <test-suite type="Assembly" id="1009" name="TestHelper.Editor.Tests.dll" fullname="/github/workspace/UnityProject~/Library/ScriptAssemblies/TestHelper.Editor.Tests.dll" runstate="Runnable" testcasecount="3" result="Passed" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.246003" total="3" passed="3" failed="0" inconclusive="0" skipped="0" asserts="0">
+      <properties>
+        <property name="_PID" value="3301" />
+        <property name="_APPDOMAIN" value="Unity Child Domain" />
+        <property name="platform" value="EditMode" />
+        <property name="EditorOnly" value="True" />
+      </properties>
+      <test-suite type="TestSuite" id="1010" name="TestHelper" fullname="TestHelper" runstate="Runnable" testcasecount="3" result="Passed" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.245391" total="3" passed="3" failed="0" inconclusive="0" skipped="0" asserts="0">
+        <properties />
+        <test-suite type="TestSuite" id="1011" name="Editor" fullname="TestHelper.Editor" runstate="Runnable" testcasecount="3" result="Passed" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.241916" total="3" passed="3" failed="0" inconclusive="0" skipped="0" asserts="0">
+          <properties />
+          <test-suite type="TestFixture" id="1003" name="CreateSceneAttributeTest" fullname="TestHelper.Editor.CreateSceneAttributeTest" classname="TestHelper.Editor.CreateSceneAttributeTest" runstate="Runnable" testcasecount="1" result="Passed" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.092622" total="1" passed="1" failed="0" inconclusive="0" skipped="0" asserts="0">
+            <properties />
+            <test-case id="1004" name="Attach_CreateNewSceneWithCameraAndLight" fullname="TestHelper.Editor.CreateSceneAttributeTest.Attach_CreateNewSceneWithCameraAndLight" methodname="Attach_CreateNewSceneWithCameraAndLight" classname="TestHelper.Editor.CreateSceneAttributeTest" runstate="Runnable" seed="1087926775" result="Passed" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.036802" asserts="0">
+              <properties>
+                <property name="retryIteration" value="0" />
+                <property name="repeatIteration" value="0" />
+              </properties>
+              <output><![CDATA[[Code Coverage] Code Coverage results for visited sequence points were saved in /github/workspace/CodeCoverage/UnityProject~-opencov/EditMode/TestCoverageResults_0001.xml
+]]></output>
+            </test-case>
+          </test-suite>
+          <test-suite type="TestFixture" id="1005" name="LoadSceneAttributeTest" fullname="TestHelper.Editor.LoadSceneAttributeTest" classname="TestHelper.Editor.LoadSceneAttributeTest" runstate="Runnable" testcasecount="1" result="Passed" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.089184" total="1" passed="1" failed="0" inconclusive="0" skipped="0" asserts="0">
+            <properties />
+            <test-case id="1006" name="Attach_LoadedSceneNotInBuild" fullname="TestHelper.Editor.LoadSceneAttributeTest.Attach_LoadedSceneNotInBuild" methodname="Attach_LoadedSceneNotInBuild" classname="TestHelper.Editor.LoadSceneAttributeTest" runstate="Runnable" seed="818183097" result="Passed" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.053176" asserts="0">
+              <properties>
+                <property name="retryIteration" value="0" />
+                <property name="repeatIteration" value="0" />
+              </properties>
+              <output><![CDATA[[Code Coverage] Code Coverage results for visited sequence points were saved in /github/workspace/CodeCoverage/UnityProject~-opencov/EditMode/TestCoverageResults_0002.xml
+]]></output>
+            </test-case>
+          </test-suite>
+          <test-suite type="TestFixture" id="1007" name="TemporaryBuildScenesUsingInTestTest" fullname="TestHelper.Editor.TemporaryBuildScenesUsingInTestTest" classname="TestHelper.Editor.TemporaryBuildScenesUsingInTestTest" runstate="Runnable" testcasecount="1" result="Passed" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.055223" total="1" passed="1" failed="0" inconclusive="0" skipped="0" asserts="0">
+            <properties />
+            <test-case id="1008" name="GetScenesUsingInTest_AttachedToMethod_ReturnScenesSpecifiedByAttribute" fullname="TestHelper.Editor.TemporaryBuildScenesUsingInTestTest.GetScenesUsingInTest_AttachedToMethod_ReturnScenesSpecifiedByAttribute" methodname="GetScenesUsingInTest_AttachedToMethod_ReturnScenesSpecifiedByAttribute" classname="TestHelper.Editor.TemporaryBuildScenesUsingInTestTest" runstate="Runnable" seed="1243330322" result="Passed" start-time="2024-05-03 10:09:28Z" end-time="2024-05-03 10:09:28Z" duration="0.014506" asserts="0">
+              <properties>
+                <property name="retryIteration" value="0" />
+                <property name="repeatIteration" value="0" />
+              </properties>
+              <output><![CDATA[[Code Coverage] Code Coverage results for visited sequence points were saved in /github/workspace/CodeCoverage/UnityProject~-opencov/EditMode/TestCoverageResults_0003.xml
+[Code Coverage] Code Coverage Report was generated in /github/workspace/CodeCoverage/Report
+Included Assemblies: TestHelper,TestHelper.RuntimeInternals,TestHelper.Editor,
+Excluded Assemblies: *.Tests
+Included Paths: <Not specified>
+Excluded Paths: <Not specified>
+Saving results to: /github/workspace/artifacts/editmode-results.xml
+]]></output>
+            </test-case>
+          </test-suite>
+        </test-suite>
+      </test-suite>
+    </test-suite>
+  </test-suite>
+</test-run>
diff --git a/Tests/Editor/TestResources/nunit3.xml.meta b/Tests/Editor/TestResources/nunit3.xml.meta
diff --git a/Tests/RuntimeInternals/CommandLineArgsTest.cs b/Tests/RuntimeInternals/CommandLineArgsTest.cs
@@ -39,5 +39,19 @@ public void GetScreenshotDirectory_WithoutArgument_GotDefaultDirectory()
             var actual = CommandLineArgs.GetScreenshotDirectory(Array.Empty<string>());
             Assert.That(actual, Is.EqualTo(Path.Combine(Application.persistentDataPath, "TestHelper", "Screenshots")));
         }
+
+        [Test]
+        public void GetJUnitResultsPath_WithArgument_GotSpecifiedPath()
+        {
+            var actual = CommandLineArgs.GetJUnitResultsPath(new[] { "-testHelperJUnitResults", "Test" });
+            Assert.That(actual, Is.EqualTo("Test"));
+        }
+
+        [Test]
+        public void GetJUnitResultsPath_WithoutArgument_ReturnsNull()
+        {
+            var actual = CommandLineArgs.GetJUnitResultsPath(Array.Empty<string>());
+            Assert.That(actual, Is.Null);
+        }
     }
 }