How to use Has method of reporters_test Package

1package reporters_test2import (3	"encoding/xml"4	"io/ioutil"5	"os"6	"time"7	. "github.com/onsi/ginkgo"8	"github.com/onsi/ginkgo/config"9	"github.com/onsi/ginkgo/internal/codelocation"10	"github.com/onsi/ginkgo/reporters"11	"github.com/onsi/ginkgo/types"12	. "github.com/onsi/gomega"13)14var _ = Describe("JUnit Reporter", func() {15	var (16		outputFile string17		reporter   *reporters.JUnitReporter18	)19	testSuiteTime := 12456999 * time.Microsecond20	reportedSuiteTime := 12.45621	readOutputFile := func() reporters.JUnitTestSuite {22		bytes, err := ioutil.ReadFile(outputFile)23		Expect(err).ToNot(HaveOccurred())24		var suite reporters.JUnitTestSuite25		err = xml.Unmarshal(bytes, &suite)26		Expect(err).ToNot(HaveOccurred())27		return suite28	}29	BeforeEach(func() {30		f, err := ioutil.TempFile("", "output")31		Expect(err).ToNot(HaveOccurred())32		f.Close()33		outputFile = f.Name()34		reporter = reporters.NewJUnitReporter(outputFile)35		reporter.SpecSuiteWillBegin(config.GinkgoConfigType{}, &types.SuiteSummary{36			SuiteDescription:           "My test suite",37			NumberOfSpecsThatWillBeRun: 1,38		})39	})40	AfterEach(func() {41		os.RemoveAll(outputFile)42	})43	Describe("when configured with ReportPassed, and test has passed", func() {44		BeforeEach(func() {45			beforeSuite := &types.SetupSummary{46				State: types.SpecStatePassed,47			}48			reporter.BeforeSuiteDidRun(beforeSuite)49			afterSuite := &types.SetupSummary{50				State: types.SpecStatePassed,51			}52			reporter.AfterSuiteDidRun(afterSuite)53			// Set the ReportPassed config flag, in order to show captured output when tests have passed.54			reporter.ReporterConfig.ReportPassed = true55			spec := &types.SpecSummary{56				ComponentTexts: []string{"[Top Level]", "A", "B", "C"},57				CapturedOutput: "Test scenario...",58				State:          types.SpecStatePassed,59				RunTime:        5 * time.Second,60			}61			reporter.SpecWillRun(spec)62			reporter.SpecDidComplete(spec)63			reporter.SpecSuiteDidEnd(&types.SuiteSummary{64				NumberOfSpecsThatWillBeRun: 1,65				NumberOfFailedSpecs:        0,66				RunTime:                    testSuiteTime,67			})68		})69		It("should record the test as passing, including detailed output", func() {70			output := readOutputFile()71			Expect(output.Name).To(Equal("My test suite"))72			Expect(output.Tests).To(Equal(1))73			Expect(output.Failures).To(Equal(0))74			Expect(output.Time).To(Equal(reportedSuiteTime))75			Expect(output.Errors).To(Equal(0))76			Expect(output.TestCases).To(HaveLen(1))77			Expect(output.TestCases[0].Name).To(Equal("A B C"))78			Expect(output.TestCases[0].ClassName).To(Equal("My test suite"))79			Expect(output.TestCases[0].FailureMessage).To(BeNil())80			Expect(output.TestCases[0].Skipped).To(BeNil())81			Expect(output.TestCases[0].Time).To(Equal(5.0))82			Expect(output.TestCases[0].PassedMessage.Message).To(ContainSubstring("Test scenario"))83		})84	})85	Describe("when configured with ReportFile <file path>", func() {86		BeforeEach(func() {87			beforeSuite := &types.SetupSummary{88				State: types.SpecStatePassed,89			}90			reporter.BeforeSuiteDidRun(beforeSuite)91			afterSuite := &types.SetupSummary{92				State: types.SpecStatePassed,93			}94			reporter.AfterSuiteDidRun(afterSuite)95			reporter.SpecSuiteWillBegin(config.GinkgoConfigType{}, &types.SuiteSummary{96				SuiteDescription:           "My test suite",97				NumberOfSpecsThatWillBeRun: 1,98			})99			// Set the ReportFile config flag with a new directory and new file path to be created.100			d, err := ioutil.TempDir("", "new-junit-dir")101			Expect(err).ToNot(HaveOccurred())102			f, err := ioutil.TempFile(d, "output")103			Expect(err).ToNot(HaveOccurred())104			f.Close()105			outputFile = f.Name()106			err = os.RemoveAll(d)107			Expect(err).ToNot(HaveOccurred())108			reporter.ReporterConfig.ReportFile = outputFile109			spec := &types.SpecSummary{110				ComponentTexts: []string{"[Top Level]", "A", "B", "C"},111				CapturedOutput: "Test scenario...",112				State:          types.SpecStatePassed,113				RunTime:        5 * time.Second,114			}115			reporter.SpecWillRun(spec)116			reporter.SpecDidComplete(spec)117			reporter.SpecSuiteDidEnd(&types.SuiteSummary{118				NumberOfSpecsThatWillBeRun: 1,119				NumberOfFailedSpecs:        0,120				RunTime:                    testSuiteTime,121			})122		})123		It("should create the report (and parent directories) as specified by ReportFile path", func() {124			output := readOutputFile()125			Expect(output.Name).To(Equal("My test suite"))126			Expect(output.Tests).To(Equal(1))127			Expect(output.Failures).To(Equal(0))128			Expect(output.Time).To(Equal(reportedSuiteTime))129			Expect(output.Errors).To(Equal(0))130			Expect(output.TestCases).To(HaveLen(1))131			Expect(output.TestCases[0].Name).To(Equal("A B C"))132			Expect(output.TestCases[0].ClassName).To(Equal("My test suite"))133			Expect(output.TestCases[0].FailureMessage).To(BeNil())134			Expect(output.TestCases[0].Skipped).To(BeNil())135			Expect(output.TestCases[0].Time).To(Equal(5.0))136		})137	})138	Describe("when the BeforeSuite fails", func() {139		var beforeSuite *types.SetupSummary140		BeforeEach(func() {141			beforeSuite = &types.SetupSummary{142				State:   types.SpecStateFailed,143				RunTime: 3 * time.Second,144				Failure: types.SpecFailure{145					Message:               "failed to setup",146					ComponentCodeLocation: codelocation.New(0),147					Location:              codelocation.New(2),148				},149			}150			reporter.BeforeSuiteDidRun(beforeSuite)151			reporter.SpecSuiteDidEnd(&types.SuiteSummary{152				NumberOfSpecsThatWillBeRun: 1,153				NumberOfFailedSpecs:        1,154				RunTime:                    testSuiteTime,155			})156		})157		It("should record the test as having failed", func() {158			output := readOutputFile()159			Expect(output.Name).To(Equal("My test suite"))160			Expect(output.Tests).To(Equal(1))161			Expect(output.Failures).To(Equal(1))162			Expect(output.Time).To(Equal(reportedSuiteTime))163			Expect(output.Errors).To(Equal(0))164			Expect(output.TestCases[0].Name).To(Equal("BeforeSuite"))165			Expect(output.TestCases[0].Time).To(Equal(3.0))166			Expect(output.TestCases[0].ClassName).To(Equal("My test suite"))167			Expect(output.TestCases[0].FailureMessage.Type).To(Equal("Failure"))168			Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring("failed to setup"))169			Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring(beforeSuite.Failure.ComponentCodeLocation.String()))170			Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring(beforeSuite.Failure.Location.String()))171			Expect(output.TestCases[0].Skipped).To(BeNil())172		})173	})174	Describe("when the AfterSuite fails", func() {175		var afterSuite *types.SetupSummary176		BeforeEach(func() {177			afterSuite = &types.SetupSummary{178				State:   types.SpecStateFailed,179				RunTime: 3 * time.Second,180				Failure: types.SpecFailure{181					Message:               "failed to setup",182					ComponentCodeLocation: codelocation.New(0),183					Location:              codelocation.New(2),184				},185			}186			reporter.AfterSuiteDidRun(afterSuite)187			reporter.SpecSuiteDidEnd(&types.SuiteSummary{188				NumberOfSpecsThatWillBeRun: 1,189				NumberOfFailedSpecs:        1,190				RunTime:                    testSuiteTime,191			})192		})193		It("should record the test as having failed", func() {194			output := readOutputFile()195			Expect(output.Name).To(Equal("My test suite"))196			Expect(output.Tests).To(Equal(1))197			Expect(output.Failures).To(Equal(1))198			Expect(output.Time).To(Equal(reportedSuiteTime))199			Expect(output.Errors).To(Equal(0))200			Expect(output.TestCases[0].Name).To(Equal("AfterSuite"))201			Expect(output.TestCases[0].Time).To(Equal(3.0))202			Expect(output.TestCases[0].ClassName).To(Equal("My test suite"))203			Expect(output.TestCases[0].FailureMessage.Type).To(Equal("Failure"))204			Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring("failed to setup"))205			Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring(afterSuite.Failure.ComponentCodeLocation.String()))206			Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring(afterSuite.Failure.Location.String()))207			Expect(output.TestCases[0].Skipped).To(BeNil())208		})209	})210	specStateCases := []struct {211		state   types.SpecState212		message string213		// Only for SpecStatePanicked.214		forwardedPanic string215	}{216		{types.SpecStateFailed, "Failure", ""},217		{types.SpecStateTimedOut, "Timeout", ""},218		{types.SpecStatePanicked, "Panic", "artifical panic"},219	}220	for _, specStateCase := range specStateCases {221		specStateCase := specStateCase222		Describe("a failing test", func() {223			var spec *types.SpecSummary224			BeforeEach(func() {225				spec = &types.SpecSummary{226					ComponentTexts: []string{"[Top Level]", "A", "B", "C"},227					State:          specStateCase.state,228					RunTime:        5 * time.Second,229					Failure: types.SpecFailure{230						ComponentCodeLocation: codelocation.New(0),231						Location:              codelocation.New(2),232						Message:               "I failed",233						ForwardedPanic:        specStateCase.forwardedPanic,234					},235				}236				reporter.SpecWillRun(spec)237				reporter.SpecDidComplete(spec)238				reporter.SpecSuiteDidEnd(&types.SuiteSummary{239					NumberOfSpecsThatWillBeRun: 1,240					NumberOfFailedSpecs:        1,241					RunTime:                    testSuiteTime,242				})243			})244			It("should record test as failing", func() {245				output := readOutputFile()246				Expect(output.Name).To(Equal("My test suite"))247				Expect(output.Tests).To(Equal(1))248				Expect(output.Failures).To(Equal(1))249				Expect(output.Time).To(Equal(reportedSuiteTime))250				Expect(output.Errors).To(Equal(0))251				Expect(output.TestCases[0].Name).To(Equal("A B C"))252				Expect(output.TestCases[0].ClassName).To(Equal("My test suite"))253				Expect(output.TestCases[0].FailureMessage.Type).To(Equal(specStateCase.message))254				Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring("I failed"))255				Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring(spec.Failure.ComponentCodeLocation.String()))256				Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring(spec.Failure.Location.String()))257				Expect(output.TestCases[0].Skipped).To(BeNil())258				if specStateCase.state == types.SpecStatePanicked {259					Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring("\nPanic: " + specStateCase.forwardedPanic + "\n"))260					Expect(output.TestCases[0].FailureMessage.Message).To(ContainSubstring("\nFull stack:\n" + spec.Failure.Location.FullStackTrace))261				}262			})263		})264	}265	for _, specStateCase := range []types.SpecState{types.SpecStatePending, types.SpecStateSkipped} {266		specStateCase := specStateCase267		Describe("a skipped test", func() {268			var spec *types.SpecSummary269			BeforeEach(func() {270				spec = &types.SpecSummary{271					ComponentTexts: []string{"[Top Level]", "A", "B", "C"},272					State:          specStateCase,273					RunTime:        5 * time.Second,274					Failure: types.SpecFailure{275						Message: "skipped reason",276					},277				}278				reporter.SpecWillRun(spec)279				reporter.SpecDidComplete(spec)280				reporter.SpecSuiteDidEnd(&types.SuiteSummary{281					NumberOfSpecsThatWillBeRun: 1,282					NumberOfFailedSpecs:        0,283					RunTime:                    testSuiteTime,284				})285			})286			It("should record test as failing", func() {287				output := readOutputFile()288				Expect(output.Tests).To(Equal(1))289				Expect(output.Failures).To(Equal(0))290				Expect(output.Time).To(Equal(reportedSuiteTime))291				Expect(output.Errors).To(Equal(0))292				Expect(output.TestCases[0].Name).To(Equal("A B C"))293				Expect(output.TestCases[0].Skipped.Message).To(ContainSubstring("skipped reason"))294			})295		})296	}297})...

1import (2func TestGinkgo(t *testing.T) {3    gomega.RegisterFailHandler(ginkgo.Fail)4    ginkgo.RunSpecsWithCustomReporters(t, "Ginkgo Suite", []ginkgo.Reporter{new(reporters_test)})5}6var _ = ginkgo.Describe("Ginkgo Suite", func() {7    ginkgo.It("Should Pass", func() {8        ginkgo.By("By")9        gomega.Expect(1).To(gomega.Equal(1))10    })11    ginkgo.It("Should Fail", func() {12        ginkgo.By("By")13        gomega.Expect(1).To(gomega.Equal(2))14    })15})16type reporters_test struct{}17func (reporters_test) SpecSuiteWillBegin(config config.GinkgoConfigType, summary *types.SuiteSummary) {18    fmt.Println("SpecSuiteWillBegin")19}20func (reporters_test) BeforeSuiteDidRun(setupSummary *types.SetupSummary) {21    fmt.Println("BeforeSuiteDidRun")22}23func (reporters_test) SpecWillRun(summary *types.SpecSummary) {24    fmt.Println("SpecWillRun")25}26func (reporters_test) SpecDidComplete(summary *types.SpecSummary) {27    fmt.Println("SpecDidComplete")28}29func (reporters_test) AfterSuiteDidRun(setupSummary *types.SetupSummary) {30    fmt.Println("AfterSuiteDidRun")31}32func (reporters_test) SpecSuiteDidEnd(summary *types.SuiteSummary) {33    fmt.Println("SpecSuiteDidEnd")34}35func (reporters_test) Has(suiteSummary *types.SuiteSummary) bool {36    fmt.Printf("Has: %v37}

1import (2func main() {3    r := reporters.NewJUnitReporter("junit.xml")4    if r.Has("junit.xml") {5        fmt.Println("junit.xml found")6    } else {7        fmt.Println("junit.xml not found")8    }9}

1func main() {2    r.Has("foo")3    r.Has("bar")4}5func main() {6    r.Has("foo")7    r.Has("bar")8}9func main() {10    r.Has("foo")11    r.Has("bar")12}13func main() {14    r.Has("foo")15    r.Has("bar")16}17func main() {18    r.Has("foo")19    r.Has("bar")20}21func main() {22    r.Has("foo")23    r.Has("bar")24}25func main() {26    r.Has("foo")27    r.Has("bar")28}29func main() {30    r.Has("foo")31    r.Has("bar")32}33func main() {34    r.Has("foo")35    r.Has("bar")36}37func main() {38    r.Has("foo")39    r.Has("bar")40}41func main() {42    r.Has("foo")43    r.Has("bar")44}45func main() {46    r.Has("foo")47    r.Has("bar")48}49func main() {

1import (2func main() {3	reporters_test := new(reporters_test)4	reporters_test.Has("Hello World")5}6import (7func main() {8	reporters_test := new(reporters_test)9	reporters_test.Has("Hello World")10}11import (12func main() {13	reporters_test := new(reporters_test)14	reporters_test.Has("Hello World")15}16import (17func main() {18	reporters_test := new(reporters_test)19	reporters_test.Has("Hello World")20}21import (22func main() {23	reporters_test := new(reporters_test)24	reporters_test.Has("Hello World")25}26import (27func main() {28	reporters_test := new(reporters_test)29	reporters_test.Has("Hello World")30}31import (

1func main() {2    r := reporters_test{}3    r.Has("test")4}5func main() {6    r := reporters_test{}7    r.Has("test")8}9func main() {10    r := reporters_test{}11    r.Has("test")12}13func main() {14    r := reporters_test{}15    r.Has("test")16}17func main() {18    r := reporters_test{}19    r.Has("test")20}21func main() {22    r := reporters_test{}23    r.Has("test")24}25func main() {26    r := reporters_test{}27    r.Has("test")28}29func main() {30    r := reporters_test{}31    r.Has("test")32}33func main() {34    r := reporters_test{}

1import (2func main() {3    fmt.Println(reporters.HasJUnitOutputFlag())4}5I have tried to import reporters in different ways but none of them worked. I have also tried to use reporters.HasJUnitOutputFlag() in a test file but it didn't work either. I have also tried to use ginkgo.HasJUnitOutputFlag() but it didn't work either. What am I doing wrong?6I have also tried to use reporters.HasJUnitOutputFlag() in a test file but it didn't work either. I have also tried to use ginkgo.HasJUnitOutputFlag() but it didn't work either. What am I doing wrong?