core

Documentation

Overview

Ginkgo is usually dot-imported via:

import . "github.com/onsi/ginkgo/v2"

however some parts of the DSL may conflict with existing symbols in the user's code.

To mitigate this without losing the brevity of dot-importing Ginkgo the various packages in the dsl directory provide pieces of the Ginkgo DSL that can be dot-imported separately.

This "core" package pulls in the core Ginkgo DSL - most test suites will only need to import this package.

Index

• Constants
• Variables
• type FullGinkgoTInterface
• type GinkgoTBWrapper
• type GinkgoTInterface
• type GinkgoTestingT
• type GinkgoWriterInterface
• type SpecContext

Constants

const GINKGO_VERSION = ginkgo.GINKGO_VERSION

Variables

var AbortSuite = ginkgo.AbortSuite

var AfterAll = ginkgo.AfterAll

var AfterEach = ginkgo.AfterEach

var AfterSuite = ginkgo.AfterSuite

var AttachProgressReporter = ginkgo.AttachProgressReporter

var BeforeAll = ginkgo.BeforeAll

var BeforeEach = ginkgo.BeforeEach

var BeforeSuite = ginkgo.BeforeSuite

var By = ginkgo.By

var Context, FContext, PContext, XContext = Describe, FDescribe, PDescribe, XDescribe

var DeferCleanup = ginkgo.DeferCleanup

var Describe = ginkgo.Describe

var FDescribe = ginkgo.FDescribe

var FIt = ginkgo.FIt

var Fail = ginkgo.Fail

var GinkgoConfiguration = ginkgo.GinkgoConfiguration

var GinkgoHelper = ginkgo.GinkgoHelper

var GinkgoLabelFilter = ginkgo.GinkgoLabelFilter

var GinkgoLogr = ginkgo.GinkgoLogr

var GinkgoParallelProcess = ginkgo.GinkgoParallelProcess

var GinkgoRandomSeed = ginkgo.GinkgoRandomSeed

var GinkgoRecover = ginkgo.GinkgoRecover

var GinkgoT = ginkgo.GinkgoT

var GinkgoTB = ginkgo.GinkgoTB

var GinkgoWriter = ginkgo.GinkgoWriter

var It = ginkgo.It

var JustAfterEach = ginkgo.JustAfterEach

var JustBeforeEach = ginkgo.JustBeforeEach

var PDescribe = ginkgo.PDescribe

var PIt = ginkgo.PIt

var PauseOutputInterception = ginkgo.PauseOutputInterception

var PreviewSpecs = ginkgo.PreviewSpecs

var ResumeOutputInterception = ginkgo.ResumeOutputInterception

var RunSpecs = ginkgo.RunSpecs

var Skip = ginkgo.Skip

var Specify, FSpecify, PSpecify, XSpecify = It, FIt, PIt, XIt

var SynchronizedAfterSuite = ginkgo.SynchronizedAfterSuite

var SynchronizedBeforeSuite = ginkgo.SynchronizedBeforeSuite

var When, FWhen, PWhen, XWhen = Describe, FDescribe, PDescribe, XDescribe

var XDescribe = PDescribe

var XIt = PIt

Types

type FullGinkgoTInterface

type FullGinkgoTInterface = ginkgo.FullGinkgoTInterface

type GinkgoTBWrapper

type GinkgoTBWrapper = ginkgo.GinkgoTBWrapper

type GinkgoTInterface

type GinkgoTInterface = ginkgo.GinkgoTInterface

type GinkgoTestingT

type GinkgoTestingT = ginkgo.GinkgoTestingT

type GinkgoWriterInterface

type GinkgoWriterInterface = ginkgo.GinkgoWriterInterface

type SpecContext

type SpecContext = ginkgo.SpecContext