NewmanSettings Class

Summary

Settings to control the Cake.Newman.NewmanRunner.
Assembly
Cake.Newman.dll
Namespace
Cake.Newman
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["NewmanSettings"] class Type type-node

Syntax

public class NewmanSettings : ToolSettings

Constructors

Name Summary
NewmanSettings()

Properties

Name Value Summary
DataFile FilePath
An environment file path.
DisableStrictSSL bool
Disables SSL verification checks and allows self-signed SSL certificates.
EnvironmentFile FilePath
An environment file path.
ExitOnFirstFailure bool
Specify whether or not to stop a collection run on encountering the first error.
ExportCollectionPath FilePath
The path to the file where Newman will output the final collection file before completing a run.
ExportEnvironmentPath FilePath
The path to the file where Newman will output the final environment variables file before completing a run.
ExportGlobalsPath FilePath
The path to the file where Newman will output the final global variables file before completing a run.
Folder string
Run requests within a particular folder in a collection.
GlobalVariablesFile FilePath
File path for global variables.
IgnoreRedirects bool
Prevents newman from automatically following 3XX redirect responses.
IterationCount int
Specify iteration count.
Reporters Dictionary<string, IReporterSettings>
Reporters (and any reporter-specific options) for test results
RequestDelay int
Specify the extent of delay between requests (in milliseconds).
RequestTimeout int
The time (in milliseconds) to wait for requests to return a response.
ScriptTimeout int
The time (in milliseconds) to wait for script to execute.

Methods

Name Value Summary
Build(ProcessArgumentBuilder) void
Builds the complete arguments for invoking newman

Extension Methods

Name Value Summary
DisableStrictSSL() NewmanSettings
Disables SSL verification checks and allows self-signed SSL certificates.
Requires the Cake.Newman addin
Dump<NewmanSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
ExitOnFirstFailure() NewmanSettings
Specify whether or not to stop a collection run on encountering the first error.
Requires the Cake.Newman addin
ExportCollectionTo(FilePath) NewmanSettings
Specify the file where Newman will output the final collection file before completing a run.
Requires the Cake.Newman addin
ExportEnvironmentTo(FilePath) NewmanSettings
Specify the file where Newman will output the final environment variables file before completing a run.
Requires the Cake.Newman addin
ExportGlobalsTo(FilePath) NewmanSettings
Specify the file where Newman will output the final global variables file before completing a run.
Requires the Cake.Newman addin
IgnoreRedirects() NewmanSettings
Prevents newman from automatically following 3XX redirect responses.
Requires the Cake.Newman addin
Insecure() NewmanSettings
Disables SSL verification checks and allows self-signed SSL certificates.
Requires the Cake.Newman addin
IsIn<NewmanSettings>(NewmanSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<NewmanSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<NewmanSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
RunOnlyFolder(string) NewmanSettings
Run requests within only the specified folder in a collection.
Requires the Cake.Newman addin
SetIterationCount(int) NewmanSettings
Sets the iteration count.
Requires the Cake.Newman addin
SetRequestDelay(int) NewmanSettings
Specify the extent of delay between requests (in milliseconds).
Requires the Cake.Newman addin
SetRequestTimeout(int) NewmanSettings
Sets the time to wait for request responses.
Requires the Cake.Newman addin
SetScriptTimeout(int) NewmanSettings
Sets the time to wait for script to complete.
Requires the Cake.Newman addin
ThrowIfNull<NewmanSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<NewmanSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin
UseCLIReporter(Action<CLIReporterSettings>) NewmanSettings
Adds the CLI reporter to this run, using the specifid settings.
Requires the Cake.Newman addin
UseCLIReporter() NewmanSettings
Adds the CLI reporter to this run.
Requires the Cake.Newman addin
UseHtmlReporter(Action<HtmlReporterSettings>) NewmanSettings
Adds the HTML reporter to this run, using the specified settings.
Requires the Cake.Newman addin
UseHtmlReporter() NewmanSettings
Adds the HTML reporter to this run.
Requires the Cake.Newman addin
UseJsonReporter(FilePath) NewmanSettings
Adds the JSON reporter to this run, exporting results to the specified file.
Requires the Cake.Newman addin
UseJsonReporter() NewmanSettings
Adds the JSON reporter to this run.
Requires the Cake.Newman addin
UseJUnitReporter(FilePath) NewmanSettings
Adds the JUnit/XML reporter to this run, exporting results to the specified file.
Requires the Cake.Newman addin
UseJUnitReporter() NewmanSettings
Adds the JUnit/XML reporter to this run.
Requires the Cake.Newman addin
WithData(FilePath) NewmanSettings
Specify the file path for an data file to use for the current execution.
Requires the Cake.Newman addin
WithEnvironment(FilePath) NewmanSettings
Specify the file path for an environmentsfiel to use for the current execution.
Requires the Cake.Newman addin
WithGlobals(FilePath) NewmanSettings
Specify the file path for global variables for the current execution.
Requires the Cake.Newman addin