feat: enable custom test output result file (#1112)

* feat: enable TestOutputXmlFileNameWithoutExtension run setting to setup a custom result file name rather than the name of the assembly to be tested * chore: adjust name to TestOutputXmlFileName --------- Co-authored-by: Marcus Lorentschk <marcus.lorentschk@siemens.com>
nunit · Aug 3, 2023 · b3b5f4a · b3b5f4a
1 parent 76b0d3d
commit b3b5f4a
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 1 deletion.
diff --git a/src/NUnitTestAdapter/AdapterSettings.cs b/src/NUnitTestAdapter/AdapterSettings.cs
@@ -119,6 +119,7 @@ public AdapterSettings(ITestLogger logger)
         public string WorkDirectory { get; private set; }
         public string Where { get; private set; }
         public string TestOutputXml { get; private set; }
+        public string TestOutputXmlFileName { get; private set; }
         public bool UseTestOutputXml => !string.IsNullOrEmpty(TestOutputXml) || OutputXmlFolderMode == OutputXmlFolderMode.UseResultDirectory;
 
         public OutputXmlFolderMode OutputXmlFolderMode { get; private set; } = OutputXmlFolderMode.RelativeToWorkFolder;
@@ -329,6 +330,7 @@ public void Load(string settingsXml)
         private void ParseOutputXml(XmlNode nunitNode)
         {
             TestOutputXml = GetInnerTextWithLog(nunitNode, nameof(TestOutputXml));
+            TestOutputXmlFileName = GetInnerTextWithLog(nunitNode, nameof(TestOutputXmlFileName));
             if (Path.IsPathRooted(TestOutputXml))
             {
                 OutputXmlFolderMode = OutputXmlFolderMode.AsSpecified;

diff --git a/src/NUnitTestAdapter/IAdapterSettings.cs b/src/NUnitTestAdapter/IAdapterSettings.cs
@@ -47,6 +47,7 @@ public interface IAdapterSettings
 
     VsTestCategoryType VsTestCategoryType { get; }
     string TestOutputXml { get; }
+    string TestOutputXmlFileName { get; }
     bool UseTestOutputXml { get; }
     OutputXmlFolderMode OutputXmlFolderMode { get; }
 

diff --git a/src/NUnitTestAdapter/NUnitEngine/NUnitEngineAdapter.cs b/src/NUnitTestAdapter/NUnitEngine/NUnitEngineAdapter.cs
@@ -163,7 +163,7 @@ public void GenerateTestOutput(NUnitResults testResults, string assemblyPath, st
             if (!settings.UseTestOutputXml)
                 return;
 
-            string path = GetXmlFilePath(testOutputXmlFolder, Path.GetFileNameWithoutExtension(assemblyPath), "xml");
+            string path = GetXmlFilePath(testOutputXmlFolder, GetTestOutputFileName(assemblyPath), "xml");
             var resultService = GetService<IResultService>();
 
             // Following null argument should work for nunit3 format. Empty array is OK as well.
@@ -173,6 +173,15 @@ public void GenerateTestOutput(NUnitResults testResults, string assemblyPath, st
             logger.Info($"   Test results written to {path}");
         }
 
+        public string GetTestOutputFileName(string assemblyPath)
+        {
+            if (string.IsNullOrWhiteSpace(settings.TestOutputXmlFileName))
+            {
+                return Path.GetFileNameWithoutExtension(assemblyPath);
+            }
+            return settings.TestOutputXmlFileName;
+        }
+
         public string GetXmlFilePath(string folder, string defaultFileName, string extension)
         {
             if (!settings.NewOutputXmlFileForEachRun)

diff --git a/src/NUnitTestAdapterTests/NUnitEngineTests/NUnitEngineAdapterTests.cs b/src/NUnitTestAdapterTests/NUnitEngineTests/NUnitEngineAdapterTests.cs
@@ -19,6 +19,19 @@ public void TestXmlFileNameGeneration()
             Assert.That(path, Is.EqualTo("c:/assembly.xml"));
         }
 
+        [TestCase("", "myAssemblyFilename")]
+        [TestCase("<TestOutputXmlFileName>whateverFileName</TestOutputXmlFileName>", "whateverFileName")]
+        public void When_setting_up_defined_result_GetTestOutputFileName_returns_defined_filename(string testOutputXmlFileNameWithoutExtensionXmlNode, string expectedFileName)
+        {
+            var logger = Substitute.For<ITestLogger>();
+            var settings = new AdapterSettings(logger);
+            settings.Load($@"<RunSettings><NUnit><WorkDirectory>c:\whatever</WorkDirectory><TestOutputXml>/my/work/dir</TestOutputXml>{testOutputXmlFileNameWithoutExtensionXmlNode}</NUnit></RunSettings>");
+            var sut = new NUnitEngineAdapter();
+            sut.InitializeSettingsAndLogging(settings, logger);
+            string filename = sut.GetTestOutputFileName("c:/myAssemblyFilename.dll");
+            Assert.That(filename, Is.EqualTo(expectedFileName));
+        }
+
         [Test]
         public void TestXmlFileNameGenerationNewOutputXmlFileForEachRun()
         {