How to use AddReportEntry method of ginkgo Package

...31		By("每个It 运行之后 ，先运行JustAfterEaches  ，后运行 AfterEach")32		By("This can be useful if you need to collect diagnostic information")33		// https://onsi.github.io/ginkgo/#attaching-data-to-reports34		if CurrentSpecReport().Failed() {35			// AddReportEntry(name string, args ...interface{})36			AddReportEntry("data-dump", []int{1, 2, 3})37		}38	})39	AfterEach(func() {40		By("clean up code here")41	})42	// 依据测试场景，可用 Context来归类 It43	Context("With more than 300 pages", func() {44		// 针对 本 Context 中的 it 的配置初始化，其他的 Context 可以有自己的 BeforeEach45		// 如果嵌套定义了多层的JustAfterEaches 和 AfterEach, from the outer-most to the inner-most46		BeforeEach(func() {47			keyB = "context_1_wrong_value_test"48			err := os.Setenv("WEIGHT_UNITS", "smoots")49			Expect(err).NotTo(HaveOccurred())50			// 我们可以使用 DeferCleanup  来替代 AfterEach ， 这样，在恢复初始值 时，代码 更加简洁51			//  You can also pass a function that returns a single value. DeferCleanup interprets this value as an error and fails the spec if the error is non-nil52			// 如果 DeferCleanup 和 AfterEach 都存在，那么 AfterEach 先于  DeferCleanup 运行53			originalWeightUnits := os.Getenv("WEIGHT_UNITS")54			DeferCleanup(func() {55				err := os.Setenv("WEIGHT_UNITS", originalWeightUnits)56				Expect(err).NotTo(HaveOccurred())57			})58		})59		// ---------- 日志输出60		It("test output", func() {61			//  ginkgo -v  或者  ginkgo  --always-emit-ginkgo-writer  就会显示如下打印62			// https://onsi.github.io/ginkgo/#logging-output63			GinkgoWriter.Println("run test label filter , ")64			GinkgoWriter.Printf("byby , keyA=%v , keyB=%v \n", keyA, keyB)65			// https://onsi.github.io/ginkgo/#attaching-data-to-reports66			// AddReportEntry generates and adds a new ReportEntry to the current spec's SpecReport67			// 能追加到 测试报告的 本specs中 ， ginkgo --json-report ./a.json68			// 我们也可以控制打印格式 If the value implements fmt.Stringer or types.ColorableStringer then value.String() or value.ColorableString() (which takes precedence) is used to generate the representation, otherwise Ginkgo uses fmt.Sprintf("%#v", value)69			AddReportEntry("Report_testwelan", []string{"anyDataStruct"})70			// 当 测试失败  或者 使用 (ginkgo -v 或者  ginkgo  --always-emit-ginkgo-writer )  时，这些信息 才会被打印出来71			// The string passed to By is emitted via the GinkgoWriter. If a test succeeds you won't see any output beyond Ginkgo's green dot. If a test fails, however, you will see each step printed out up to the step immediately preceding the failure. Running with ginkgo -v always emits all steps.72			// 这种输出 也会 写入到 测试报告中 By also adds a ReportEntry to the running spec73			By("Running sleep command which is longer than timeout for context")74			By("report the runtime of callback function ", func() {75				time.Sleep(1 * time.Second)76			})77		})78		It("test skip", func() {79			if 1 ==1 {80				Skip("Special condition wasn't met.")81			}82		})83		// https://onsi.github.io/ginkgo/#mental-model-how-ginkgo-handles-failure...

...54			assert.Equal(GinkgoT(), 7, info.OutputArgIndex)55			assert.Equal(GinkgoT(), 6, info.FlagIndexMap["-o"])56			assert.Equal(GinkgoT(), 8, info.FlagIndexMap["-c"])57		}58		AddReportEntry(experiment.Name, experiment)59	})60	Specify("changing the action opt", func() {61		experiment := gmeasure.NewExperiment("changing the action opt")62		for i := 0; i < 1000; i++ {63			os.Args = strings.Split(`gcc -Werror -g -O2 -MD -W -Wall -o src/test.o -c src/test.c`, " ")64			info := NewArgParserFromOS(ctx)65			info.Parse()66			assert.Equal(GinkgoT(), Compile, info.ActionOpt())67			experiment.MeasureDuration("Set action opt", func() {68				info.SetActionOpt(GenAssembly)69			}, gmeasure.Precision(time.Microsecond))70			assert.Equal(GinkgoT(), GenAssembly, info.ActionOpt())71			experiment.MeasureDuration("Set action opt", func() {72				info.SetActionOpt(Preprocess)73			}, gmeasure.Precision(time.Microsecond))74			assert.Equal(GinkgoT(), Preprocess, info.ActionOpt())75		}76		AddReportEntry(experiment.Name, experiment)77	})78	Specify("Substituting preprocessor options", func() {79		experiment := gmeasure.NewExperiment("Substituting preprocessor options")80		for i := 0; i < 1000; i++ {81			oldArgs := os.Args82			defer func() {83				os.Args = oldArgs84			}()85			os.Args = strings.Split(`gcc -Werror -g -O2 -MD -W -Wall -o src/test.o -c src/test.c`, " ")86			info := NewArgParserFromOS(ctx)87			info.Parse()88			experiment.MeasureDuration("Configure Preprocessor Options", func() {89				info.ConfigurePreprocessorOptions()90			}, gmeasure.Precision(time.Microsecond))91			assert.Equal(GinkgoT(), os.Args[1:],92				info.Args,93			)94			os.Args = strings.Split(`gcc -Werror -g -O2 -MD -Wp,-X -Wp,-Y -Wp,-MD,path -o src/test.o -c src/test.c`, " ")95			info = NewArgParserFromOS(ctx)96			info.Parse()97			experiment.MeasureDuration("Configure Preprocessor Options", func() {98				info.ConfigurePreprocessorOptions()99			}, gmeasure.Precision(time.Microsecond))100			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -X -Y -MD -MF path -o src/test.o -c src/test.c`, " "),101				info.Args,102			)103			os.Args = strings.Split(`gcc -Werror -g -O2 -MD -Wp,-X -Wp,-Y,-YY -Wp,-MD,path,-Z,-ZZ -o src/test.o -c src/test.c`, " ")104			info = NewArgParserFromOS(ctx)105			info.Parse()106			experiment.MeasureDuration("Configure Preprocessor Options", func() {107				info.ConfigurePreprocessorOptions()108			}, gmeasure.Precision(time.Microsecond))109			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -X -Y -YY -MD -MF path -Z -ZZ -o src/test.o -c src/test.c`, " "),110				info.Args,111			)112			os.Args = strings.Split(`gcc -Werror -g -O2 -MD -Wp,-X -Wp,-Y,-YY -Wp,-MD,path,-MMD,path2 -o src/test.o -c src/test.c`, " ")113			info = NewArgParserFromOS(ctx)114			info.Parse()115			experiment.MeasureDuration("Configure Preprocessor Options", func() {116				info.ConfigurePreprocessorOptions()117			}, gmeasure.Precision(time.Microsecond))118			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -X -Y -YY -MD -MF path -MMD -MF path2 -o src/test.o -c src/test.c`, " "),119				info.Args,120			)121		}122		AddReportEntry(experiment.Name, experiment)123	})124	Specify("Replacing output paths", func() {125		experiment := gmeasure.NewExperiment("Replacing output paths")126		for i := 0; i < 1000; i++ {127			oldArgs := os.Args128			defer func() {129				os.Args = oldArgs130			}()131			os.Args = strings.Split(`gcc -Werror -g -O2 -MD -W -Wall -o src/test.o -c src/test.c`, " ")132			info := NewArgParserFromOS(ctx)133			info.Parse()134			experiment.MeasureDuration("Replace output path", func() {135				info.ReplaceOutputPath("-")136			}, gmeasure.Precision(time.Microsecond))137			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -W -Wall -o - -c src/test.c`, " "),138				info.Args,139			)140			experiment.MeasureDuration("Replace output path", func() {141				info.ReplaceOutputPath("-")142			}, gmeasure.Precision(time.Microsecond))143			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -W -Wall -o - -c src/test.c`, " "),144				info.Args,145			)146			experiment.MeasureDuration("Replace output path", func() {147				info.ReplaceOutputPath("src/test.o")148			}, gmeasure.Precision(time.Microsecond))149			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -W -Wall -o src/test.o -c src/test.c`, " "),150				info.Args,151			)152			experiment.MeasureDuration("Replace output path", func() {153				info.ReplaceOutputPath("src/test.o")154			}, gmeasure.Precision(time.Microsecond))155			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -W -Wall -o src/test.o -c src/test.c`, " "),156				info.Args,157			)158		}159		AddReportEntry(experiment.Name, experiment)160	})161	Specify("Replacing input paths", func() {162		experiment := gmeasure.NewExperiment("Replacing input paths")163		for i := 0; i < 1000; i++ {164			oldArgs := os.Args165			defer func() {166				os.Args = oldArgs167			}()168			os.Args = strings.Split(`gcc -Werror -g -O2 -MD -W -Wall -o src/test.o -c src/test.c`, " ")169			info := NewArgParserFromOS(ctx)170			info.Parse()171			experiment.MeasureDuration("Replace input path", func() {172				info.ReplaceInputPath("src2/test.c")173			}, gmeasure.Precision(time.Microsecond))174			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -W -Wall -o src/test.o -c src2/test.c -ffile-prefix-map=src2=src`, " "),175				info.Args,176			)177			experiment.MeasureDuration("Replace input path", func() {178				info.ReplaceInputPath("/test.c")179			}, gmeasure.Precision(time.Microsecond))180			// this wouldn't be a valid use of ReplaceInputPath but it shouldn't break181			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -W -Wall -o src/test.o -c /test.c -ffile-prefix-map=src2=src -ffile-prefix-map=/=src2`, " "),182				info.Args,183			)184			experiment.MeasureDuration("Replace input path", func() {185				info.ReplaceInputPath("test.c")186			}, gmeasure.Precision(time.Microsecond))187			// this wouldn't be a valid use of ReplaceInputPath but it shouldn't break188			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -W -Wall -o src/test.o -c test.c -ffile-prefix-map=src2=src -ffile-prefix-map=/=src2 -ffile-prefix-map=.=/`, " "),189				info.Args,190			)191			experiment.MeasureDuration("Replace input path", func() {192				info.ReplaceInputPath("src/test.c")193			}, gmeasure.Precision(time.Microsecond))194			// this wouldn't be a valid use of ReplaceInputPath but it shouldn't break195			assert.Equal(GinkgoT(), strings.Split(`-Werror -g -O2 -MD -W -Wall -o src/test.o -c src/test.c -ffile-prefix-map=src2=src -ffile-prefix-map=/=src2 -ffile-prefix-map=.=/ -ffile-prefix-map=src=.`, " "),196				info.Args,197			)198		}199		AddReportEntry(experiment.Name, experiment)200	})201	Specify("Removing local-only arguments", func() {202		experiment := gmeasure.NewExperiment("Removing local-only arguments")203		for i := 0; i < 1000; i++ {204			oldArgs := os.Args205			defer func() {206				os.Args = oldArgs207			}()208			os.Args = strings.Split(`gcc -Wp,a,b -MD -L test -Ltest -l test -ltest -Da=b -I. -I test -D a=b -o src/test.o -c src/test.c`, " ")209			info := NewArgParserFromOS(ctx)210			info.Parse()211			experiment.MeasureDuration("Remove local arguments", func() {212				info.RemoveLocalArgs()213			}, gmeasure.Precision(time.Microsecond))214			assert.Equal(GinkgoT(), strings.Split(`-o src/test.o -c src/test.c`, " "),215				info.Args,216			)217		}218		AddReportEntry(experiment.Name, experiment)219	})220	Specify("Prepending the language flag", func() {221		experiment := gmeasure.NewExperiment("Prepending the language flag")222		for i := 0; i < 1000; i++ {223			oldArgs := os.Args224			defer func() {225				os.Args = oldArgs226			}()227			os.Args = strings.Split(`gcc -o src/test.o -c src/test.c`, " ")228			info := NewArgParserFromOS(ctx)229			info.Parse()230			experiment.MeasureDuration("Prepend language flag", func() {231				info.ReplaceInputPath("/path/to/test.c")232			}, gmeasure.Precision(time.Microsecond))233			assert.Equal(GinkgoT(), strings.Split(`-o src/test.o -c /path/to/test.c -ffile-prefix-map=/path/to=src`, " "),234				info.Args,235			)236			os.Args = strings.Split(`gcc -o src/test.o -c src/test.cpp`, " ")237			info = NewArgParserFromOS(ctx)238			info.Parse()239			experiment.MeasureDuration("Prepend language flag", func() {240				info.ReplaceInputPath("relative/path/test.cpp")241			}, gmeasure.Precision(time.Microsecond))242			assert.Equal(GinkgoT(), strings.Split(`-o src/test.o -c relative/path/test.cpp -ffile-prefix-map=relative/path=src`, " "),243				info.Args,244			)245		}246		AddReportEntry(experiment.Name, experiment)247	})248	It("should standardize arguments where necessary", func() {249		os.Args = strings.Split(`gcc -o/path/to/test.o -c src/test.cpp`, " ")250		info := NewArgParserFromOS(ctx)251		info.Parse()252		assert.Equal(GinkgoT(), strings.Split(`-o /path/to/test.o -c src/test.cpp`, " "),253			info.Args,254		)255	})256})257//go:embed testdata258var testdata embed.FS259var _ = Describe("Test Data", func() {260	Context("Test cases should allow running remotely", func() {...

...14type SpecReport = ginkgo.SpecReport15type ReportEntryVisibility = ginkgo.ReportEntryVisibility16const ReportEntryVisibilityAlways, ReportEntryVisibilityFailureOrVerbose, ReportEntryVisibilityNever = ginkgo.ReportEntryVisibilityAlways, ginkgo.ReportEntryVisibilityFailureOrVerbose, ginkgo.ReportEntryVisibilityNever17var CurrentSpecReport = ginkgo.CurrentSpecReport18var AddReportEntry = ginkgo.AddReportEntry19var ReportBeforeEach = ginkgo.ReportBeforeEach20var ReportAfterEach = ginkgo.ReportAfterEach21var ReportAfterSuite = ginkgo.ReportAfterSuite...

1import (2func main() {3	gomega.RegisterFailHandler(ginkgo.Fail)4	ginkgo.RunSpecs(t, "AddReportEntry Suite")5}6import (7var (8var _ = ginkgo.BeforeSuite(func() {9	pathToTestApp, err = gexec.Build("testapp")10	gomega.Expect(err).NotTo(gomega.HaveOccurred())11})12var _ = ginkgo.AfterSuite(func() {13	gexec.CleanupBuildArtifacts()14})15var _ = ginkgo.Describe("AddReportEntry", func() {16	ginkgo.It("should add a report entry", func() {17		ginkgo.By("adding a report entry")18		ginkgo.AddReportEntry("myKey", "myValue")19		gomega.Expect(fmt.Sprintf("%s", ginkgo.CurrentGinkgoTestDescription().ReportEntries)).To(gomega.Equal("map[myKey:myValue]"))20	})21})22import (23func TestAddReportEntry(t *testing.T) {24	gomega.RegisterFailHandler(ginkgo.Fail)25	ginkgo.RunSpecs(t, "AddReportEntry Suite")26}27var _ = ginkgo.Describe("AddReportEntry", func() {28	ginkgo.It("should add a report entry", func() {29		ginkgo.By("adding a report entry")30		ginkgo.AddReportEntry("myKey", "myValue")31		gomega.Expect(fmt.Sprintf("%s", ginkgo.CurrentGinkgoTestDescription().ReportEntries)).To(gomega.Equal("map[myKey:myValue]"))32	})33})

1ginkgo.AddReportEntry("My Report Entry", "My Report Entry Value")2ginkgo.AddReportEntry("My Report Entry 2", "My Report Entry Value 2")3ginkgo.AddReportEntry("My Report Entry 3", "My Report Entry Value 3")4ginkgo.AddReportEntry("My Report Entry 4", "My Report Entry Value 4")5ginkgo.AddReportEntry("My Report Entry 5", "My Report Entry Value 5")6ginkgo.AddReportEntry("My Report Entry 6", "My Report Entry Value 6")7ginkgo.AddReportEntry("My Report Entry 7", "My Report Entry Value 7")8ginkgo.AddReportEntry("My Report Entry 8", "My Report Entry Value 8")9ginkgo.AddReportEntry("My Report Entry 9", "My Report Entry Value 9")10ginkgo.AddReportEntry("My Report Entry 10", "My Report Entry Value 10")11ginkgo.AddReportEntry("My Report Entry 11", "My Report Entry Value 11")12ginkgo.AddReportEntry("My Report Entry 12", "My Report Entry Value 12")

1func TestABC(t *testing.T) {2ginkgo.RunSpecs(t, "ABC Suite")3}4func TestXYZ(t *testing.T) {5ginkgo.RunSpecs(t, "XYZ Suite")6}