C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeReTesting.Utilities.EnvironmentSettings Class Reference

Retrieve settings from environment variables if they exist, or the project settings file otherwise. More...

Static Public Member Functions

static void Reload ()
 Read all settings and environment variables again and re-assign all properties.
 

Properties

static string API_URL [get]
 The URL against which server tests are run.
 
static int COLLECTION_REQUEST_TIMEOUT [get]
 Amount of time to wait for requests on collection endpoints to complete (in milliseconds).
 
static int DATA_UPLOAD_TIMEOUT [get]
 Amount of time to wait for data upload requests to complete (in milliseconds).
 
static int DELETE_TIMEOUT [get]
 Amount of time to wait for DELETE to complete (in milliseconds).
 
static bool ENABLE_REQUEST_DEBUG_LOGGING [get]
 Controls whenther AnalyzeRe.Client.API.DebugLogging is enabled.
 
static bool ENFORCE_CLEANUP_AFTER_RUN [get]
 Indicates whether the server should be wiped clean after every unit test is run.
 
static bool ENFORCE_CLEANUP_BEFORE_RUN [get]
 Indicates whether the server should be wiped clean before every unit test is run.
 
static bool EXECUTING_IN_PARALLEL [get]
 If true, tests are being run in parallel, so certain assumptions about the state of the server after running a test cannot be made.
 
static bool FAIL_ON_EXPIRED_SKIP [get]
 If true, expired SkipUntils will raise an exception saying they are expired. If false, expired SkipUntils will run the test normally.
 
static string HTTPS_PASSWORD [get]
 The password for the HTTPS server authentication.
 
static string HTTPS_USER [get]
 The username for the HTTPS server authentication.
 
static int OPTIMIZATION_TIMEOUTS [get]
 Amount of time to wait for optimization engine requests to complete (in milliseconds).
 
static int POLLING_INTERVAL [get]
 Frequency with which to poll the server for updates during tests (in milliseconds).
 
static bool RANDOMIZED_TESTS_ENABLED [get]
 If false, tests that involve random generation of resources (which can be unstable) will be skipped.
 
static int REQUEST_TIMEOUT [get]
 Amount of time to wait for requests to complete (in milliseconds).
 
static bool RESOURCE_DELETE_SUPPORTED [get]
 Indicates whether the server currently supports the DELETE method on resources.
 
static bool ROOT_DELETE_SUPPORTED [get]
 Indicates whether the server currently supports the DELETE method on the server root to wipe out all resources.
 
static bool RUN_OFFLINE [get]
 Controls whether tests that normally require a connection to the server should be allowed to try to run offline anyways.
 
static int SIMULATION_TIMEOUT [get]
 Amount of time to wait for simulations to complete (in milliseconds).
 
static bool SKIPS_ENABLED [get]
 If true, SkipUntils can be used to skip tests. If false, SkipUntils will be ignored and all tests will be run.
 
static bool VALIDATE_SERVER_CERTIFICATE [get]
 Indicates whether the SSL/TLS certificate for the HTTPS server should be validated.
 

Detailed Description

Retrieve settings from environment variables if they exist, or the project settings file otherwise.

Definition at line 7 of file EnvironmentSettings.cs.

Member Function Documentation

◆ Reload()

static void AnalyzeReTesting.Utilities.EnvironmentSettings.Reload ( )
inlinestatic

Read all settings and environment variables again and re-assign all properties.

Definition at line 96 of file EnvironmentSettings.cs.

Property Documentation

◆ API_URL

string AnalyzeReTesting.Utilities.EnvironmentSettings.API_URL
staticget

The URL against which server tests are run.

Definition at line 12 of file EnvironmentSettings.cs.

◆ COLLECTION_REQUEST_TIMEOUT

int AnalyzeReTesting.Utilities.EnvironmentSettings.COLLECTION_REQUEST_TIMEOUT
staticget

Amount of time to wait for requests on collection endpoints to complete (in milliseconds).

Definition at line 46 of file EnvironmentSettings.cs.

◆ DATA_UPLOAD_TIMEOUT

int AnalyzeReTesting.Utilities.EnvironmentSettings.DATA_UPLOAD_TIMEOUT
staticget

Amount of time to wait for data upload requests to complete (in milliseconds).

Definition at line 49 of file EnvironmentSettings.cs.

◆ DELETE_TIMEOUT

int AnalyzeReTesting.Utilities.EnvironmentSettings.DELETE_TIMEOUT
staticget

Amount of time to wait for DELETE to complete (in milliseconds).

Definition at line 58 of file EnvironmentSettings.cs.

◆ ENABLE_REQUEST_DEBUG_LOGGING

bool AnalyzeReTesting.Utilities.EnvironmentSettings.ENABLE_REQUEST_DEBUG_LOGGING
staticget

Controls whenther AnalyzeRe.Client.API.DebugLogging is enabled.

Definition at line 79 of file EnvironmentSettings.cs.

◆ ENFORCE_CLEANUP_AFTER_RUN

bool AnalyzeReTesting.Utilities.EnvironmentSettings.ENFORCE_CLEANUP_AFTER_RUN
staticget

Indicates whether the server should be wiped clean after every unit test is run.

Definition at line 38 of file EnvironmentSettings.cs.

◆ ENFORCE_CLEANUP_BEFORE_RUN

bool AnalyzeReTesting.Utilities.EnvironmentSettings.ENFORCE_CLEANUP_BEFORE_RUN
staticget

Indicates whether the server should be wiped clean before every unit test is run.

Definition at line 35 of file EnvironmentSettings.cs.

◆ EXECUTING_IN_PARALLEL

bool AnalyzeReTesting.Utilities.EnvironmentSettings.EXECUTING_IN_PARALLEL
staticget

If true, tests are being run in parallel, so certain assumptions about the state of the server after running a test cannot be made.

Definition at line 83 of file EnvironmentSettings.cs.

◆ FAIL_ON_EXPIRED_SKIP

bool AnalyzeReTesting.Utilities.EnvironmentSettings.FAIL_ON_EXPIRED_SKIP
staticget

If true, expired SkipUntils will raise an exception saying they are expired. If false, expired SkipUntils will run the test normally.

Definition at line 71 of file EnvironmentSettings.cs.

◆ HTTPS_PASSWORD

string AnalyzeReTesting.Utilities.EnvironmentSettings.HTTPS_PASSWORD
staticget

The password for the HTTPS server authentication.

Definition at line 19 of file EnvironmentSettings.cs.

◆ HTTPS_USER

string AnalyzeReTesting.Utilities.EnvironmentSettings.HTTPS_USER
staticget

The username for the HTTPS server authentication.

Definition at line 16 of file EnvironmentSettings.cs.

◆ OPTIMIZATION_TIMEOUTS

int AnalyzeReTesting.Utilities.EnvironmentSettings.OPTIMIZATION_TIMEOUTS
staticget

Amount of time to wait for optimization engine requests to complete (in milliseconds).

Definition at line 52 of file EnvironmentSettings.cs.

◆ POLLING_INTERVAL

int AnalyzeReTesting.Utilities.EnvironmentSettings.POLLING_INTERVAL
staticget

Frequency with which to poll the server for updates during tests (in milliseconds).

Definition at line 61 of file EnvironmentSettings.cs.

◆ RANDOMIZED_TESTS_ENABLED

bool AnalyzeReTesting.Utilities.EnvironmentSettings.RANDOMIZED_TESTS_ENABLED
staticget

If false, tests that involve random generation of resources (which can be unstable) will be skipped.

Definition at line 75 of file EnvironmentSettings.cs.

◆ REQUEST_TIMEOUT

int AnalyzeReTesting.Utilities.EnvironmentSettings.REQUEST_TIMEOUT
staticget

Amount of time to wait for requests to complete (in milliseconds).

Definition at line 43 of file EnvironmentSettings.cs.

◆ RESOURCE_DELETE_SUPPORTED

bool AnalyzeReTesting.Utilities.EnvironmentSettings.RESOURCE_DELETE_SUPPORTED
staticget

Indicates whether the server currently supports the DELETE method on resources.

Definition at line 32 of file EnvironmentSettings.cs.

◆ ROOT_DELETE_SUPPORTED

bool AnalyzeReTesting.Utilities.EnvironmentSettings.ROOT_DELETE_SUPPORTED
staticget

Indicates whether the server currently supports the DELETE method on the server root to wipe out all resources.

Definition at line 29 of file EnvironmentSettings.cs.

◆ RUN_OFFLINE

bool AnalyzeReTesting.Utilities.EnvironmentSettings.RUN_OFFLINE
staticget

Controls whether tests that normally require a connection to the server should be allowed to try to run offline anyways.

Definition at line 87 of file EnvironmentSettings.cs.

◆ SIMULATION_TIMEOUT

int AnalyzeReTesting.Utilities.EnvironmentSettings.SIMULATION_TIMEOUT
staticget

Amount of time to wait for simulations to complete (in milliseconds).

Definition at line 55 of file EnvironmentSettings.cs.

◆ SKIPS_ENABLED

bool AnalyzeReTesting.Utilities.EnvironmentSettings.SKIPS_ENABLED
staticget

If true, SkipUntils can be used to skip tests. If false, SkipUntils will be ignored and all tests will be run.

Definition at line 67 of file EnvironmentSettings.cs.

◆ VALIDATE_SERVER_CERTIFICATE

bool AnalyzeReTesting.Utilities.EnvironmentSettings.VALIDATE_SERVER_CERTIFICATE
staticget

Indicates whether the SSL/TLS certificate for the HTTPS server should be validated.

Definition at line 22 of file EnvironmentSettings.cs.


The documentation for this class was generated from the following file: