...

Source file src/github.com/onsi/ginkgo/v2/config/deprecated.go

Documentation: github.com/onsi/ginkgo/v2/config

     1  package config
     2  
     3  // GinkgoConfigType has been deprecated and its equivalent now lives in
     4  // the types package.  You can no longer access Ginkgo configuration from the config
     5  // package.  Instead use the DSL's GinkgoConfiguration() function to get copies of the
     6  // current configuration
     7  //
     8  // GinkgoConfigType is still here so custom V1 reporters do not result in a compilation error
     9  // It will be removed in a future minor release of Ginkgo
    10  type GinkgoConfigType = DeprecatedGinkgoConfigType
    11  type DeprecatedGinkgoConfigType struct {
    12  	RandomSeed         int64
    13  	RandomizeAllSpecs  bool
    14  	RegexScansFilePath bool
    15  	FocusStrings       []string
    16  	SkipStrings        []string
    17  	SkipMeasurements   bool
    18  	FailOnPending      bool
    19  	FailFast           bool
    20  	FlakeAttempts      int
    21  	EmitSpecProgress   bool
    22  	DryRun             bool
    23  	DebugParallel      bool
    24  
    25  	ParallelNode  int
    26  	ParallelTotal int
    27  	SyncHost      string
    28  	StreamHost    string
    29  }
    30  
    31  // DefaultReporterConfigType has been deprecated and its equivalent now lives in
    32  // the types package.  You can no longer access Ginkgo configuration from the config
    33  // package.  Instead use the DSL's GinkgoConfiguration() function to get copies of the
    34  // current configuration
    35  //
    36  // DefaultReporterConfigType is still here so custom V1 reporters do not result in a compilation error
    37  // It will be removed in a future minor release of Ginkgo
    38  type DefaultReporterConfigType = DeprecatedDefaultReporterConfigType
    39  type DeprecatedDefaultReporterConfigType struct {
    40  	NoColor           bool
    41  	SlowSpecThreshold float64
    42  	NoisyPendings     bool
    43  	NoisySkippings    bool
    44  	Succinct          bool
    45  	Verbose           bool
    46  	FullTrace         bool
    47  	ReportPassed      bool
    48  	ReportFile        string
    49  }
    50  
    51  // Sadly there is no way to gracefully deprecate access to these global config variables.
    52  // Users who need access to Ginkgo's configuration should use the DSL's GinkgoConfiguration() method
    53  // These new unwieldy type names exist to give users a hint when they try to compile and the compilation fails
    54  type GinkgoConfigIsNoLongerAccessibleFromTheConfigPackageUseTheDSLsGinkgoConfigurationFunctionInstead struct{}
    55  
    56  // Sadly there is no way to gracefully deprecate access to these global config variables.
    57  // Users who need access to Ginkgo's configuration should use the DSL's GinkgoConfiguration() method
    58  // These new unwieldy type names exist to give users a hint when they try to compile and the compilation fails
    59  var GinkgoConfig = GinkgoConfigIsNoLongerAccessibleFromTheConfigPackageUseTheDSLsGinkgoConfigurationFunctionInstead{}
    60  
    61  // Sadly there is no way to gracefully deprecate access to these global config variables.
    62  // Users who need access to Ginkgo's configuration should use the DSL's GinkgoConfiguration() method
    63  // These new unwieldy type names exist to give users a hint when they try to compile and the compilation fails
    64  type DefaultReporterConfigIsNoLongerAccessibleFromTheConfigPackageUseTheDSLsGinkgoConfigurationFunctionInstead struct{}
    65  
    66  // Sadly there is no way to gracefully deprecate access to these global config variables.
    67  // Users who need access to Ginkgo's configuration should use the DSL's GinkgoConfiguration() method
    68  // These new unwieldy type names exist to give users a hint when they try to compile and the compilation fails
    69  var DefaultReporterConfig = DefaultReporterConfigIsNoLongerAccessibleFromTheConfigPackageUseTheDSLsGinkgoConfigurationFunctionInstead{}
    70  

View as plain text