From 979fbc2f26e4ca6e54050e769e1c982c00fbf769 Mon Sep 17 00:00:00 2001
From: Lior Noy <lnoy@redhat.com>
Date: Sat, 25 Feb 2023 17:28:39 +0200
Subject: [PATCH] Add OmitSuiteSetupNodes to JunitReportConfig (#1147)

* Add OmitSuiteSetupNodes to JunitReportConfig

This commit adds a new option to the JunitReportConfig that when
enabled prevents the creation of testcase entries for setup nodes
in the JUnit report.

fix #1145

* Add unit test for the OmitSuiteSetupNodes feature

Added a dummy BeforeSuite spec to validate that with the
new OmitSuiteSetupNodes option, the generated JUnit report is
omitting this spec and not displaying it as one of the testcases.

fix #1145
---
 reporters/junit_report.go      |  6 ++++++
 reporters/junit_report_test.go | 18 +++++++++++++++---
 2 files changed, 21 insertions(+), 3 deletions(-)

diff --git a/reporters/junit_report.go b/reporters/junit_report.go
index fb87e24d7..ca98609d0 100644
--- a/reporters/junit_report.go
+++ b/reporters/junit_report.go
@@ -36,6 +36,9 @@ type JunitReportConfig struct {
 
 	// Enable OmitLeafNodeType to prevent the spec leaf node type from appearing in the spec name
 	OmitLeafNodeType bool
+
+	// Enable OmitSuiteSetupNodes to prevent the creation of testcase entries for setup nodes
+	OmitSuiteSetupNodes bool
 }
 
 type JUnitTestSuites struct {
@@ -177,6 +180,9 @@ func GenerateJUnitReportWithConfig(report types.Report, dst string, config Junit
 		},
 	}
 	for _, spec := range report.SpecReports {
+		if config.OmitSuiteSetupNodes && spec.LeafNodeType != types.NodeTypeIt {
+			continue
+		}
 		name := fmt.Sprintf("[%s]", spec.LeafNodeType)
 		if config.OmitLeafNodeType {
 			name = ""
diff --git a/reporters/junit_report_test.go b/reporters/junit_report_test.go
index dee9c2b53..cbbc87bfd 100644
--- a/reporters/junit_report_test.go
+++ b/reporters/junit_report_test.go
@@ -47,6 +47,7 @@ var _ = Describe("JunitReport", func() {
 					F("failure\nmessage", cl1, types.FailureNodeIsLeafNode, FailureNodeLocation(cl0), types.NodeTypeIt, ForwardedPanic("the panic")),
 					SE(types.SpecEventNodeEnd, types.NodeTypeIt, "A", cl0, time.Millisecond*300, TL("some GinkgoWriter\noutput is interspersed\nhere and there\n")),
 				),
+				S(types.NodeTypeBeforeSuite, "A", cl0, types.SpecStatePassed),
 			},
 		}
 	})
@@ -66,7 +67,7 @@ var _ = Describe("JunitReport", func() {
 		})
 
 		It("generates a Junit report and writes it to disk", func() {
-			Ω(generated.Tests).Should(Equal(4))
+			Ω(generated.Tests).Should(Equal(5))
 			Ω(generated.Disabled).Should(Equal(1))
 			Ω(generated.Errors).Should(Equal(1))
 			Ω(generated.Failures).Should(Equal(1))
@@ -79,13 +80,13 @@ var _ = Describe("JunitReport", func() {
 			Ω(suite.Properties.WithName("SuiteSucceeded")).Should(Equal("false"))
 			Ω(suite.Properties.WithName("RandomSeed")).Should(Equal("17"))
 
-			Ω(suite.Tests).Should(Equal(4))
+			Ω(suite.Tests).Should(Equal(5))
 			Ω(suite.Disabled).Should(Equal(1))
 			Ω(suite.Errors).Should(Equal(1))
 			Ω(suite.Failures).Should(Equal(1))
 			Ω(suite.Time).Should(Equal(60.0))
 
-			Ω(suite.TestCases).Should(HaveLen(4))
+			Ω(suite.TestCases).Should(HaveLen(5))
 
 			failingSpec := suite.TestCases[0]
 			Ω(failingSpec.Name).Should(Equal("[It] A B C [dolphin, gorilla, cow, cat, dog]"))
@@ -207,6 +208,16 @@ var _ = Describe("JunitReport", func() {
 				spr("< Exit [It] A - cl0.go:12 @ %s (300ms)", FORMATTED_TIME),
 				"",
 			))
+
+			beforeSuiteSpec := suite.TestCases[4]
+			Ω(beforeSuiteSpec.Name).Should(Equal("[BeforeSuite] A"))
+			Ω(beforeSuiteSpec.Classname).Should(Equal("My Suite"))
+			Ω(beforeSuiteSpec.Status).Should(Equal("passed"))
+			Ω(beforeSuiteSpec.Skipped).Should(BeNil())
+			Ω(beforeSuiteSpec.Error).Should(BeNil())
+			Ω(beforeSuiteSpec.Failure).Should(BeNil())
+			Ω(beforeSuiteSpec.SystemOut).Should(BeEmpty())
+			Ω(beforeSuiteSpec.SystemErr).Should(BeEmpty())
 		})
 	})
 
@@ -221,6 +232,7 @@ var _ = Describe("JunitReport", func() {
 				OmitCapturedStdOutErr:     true,
 				OmitSpecLabels:            true,
 				OmitLeafNodeType:          true,
+				OmitSuiteSetupNodes:       true,
 			})).Should(Succeed())
 			DeferCleanup(os.Remove, fname)