C# Client Library
A C# Client Library for the AnalyzeRe REST API
Loading...
Searching...
No Matches
AnalyzeReTesting.Base.BaseServerTestSuite Class Referenceabstract

Create a test class that takes care of setting the server URL and cleaning up after each unit test. More...

Public Member Functions

void BaseTest_Cleanup ()
 
void BaseTest_Initialize ()
 

Static Public Member Functions

static void ApplyConfiguredCredentials ()
 Apply the current configured API_URL and API_AuthenticationToken credentials to the static API.
 
static void CheckConnection ()
 Set the Client API Server URL to the configured API_URL.
 
static void TestSuiteCleanup ()
 Actions to run once when the C# Unit Tests finish. Note: This method will not automatically be inherited and run by tests suites in different assemblies that import this library. You will need to create your own method with the [AssemblyCleanup] attribute that calls this method.
 
static void TestSuiteInitialize (TestContext context)
 Actions to run once when the C# Unit Tests initialize. Note: This method will not automatically be inherited and run by tests suites in different assemblies that import this library. You will need to create your own method with the [AssemblyInitialize] attribute that calls this method.
 

Static Public Attributes

static Reflection Reflection
 Shared instance of a class for generating random resources.
 
static Samples Samples
 Shared instance of a class for generating reusable sample resources.
 

Protected Member Functions

 BaseServerTestSuite (bool? CleanBeforeEveryTest=null, bool? CleanAfterEveryTest=null)
 BaseServerAPITest Constructor. MSTest runs this constructor for each test.
 
void AddCommonTestCleanupAction (Action action)
 
void AddCommonTestInitializeAction (Action action)
 

Static Protected Member Functions

static void BaseClass_Cleanup (Action action)
 
static void BaseClass_Initialize (TestContext context, Action action)
 

Properties

static IAccessToken API_AuthenticationToken [get, set]
 Set the AuthenticationToken to supply to the server before every test (if applicable).
 
static string API_URL [get, set]
 Location of the REST API being tested against. This can be set using the API_URL environment variable. Default is https://localhost:8000/.
 
bool DeletingResourcesBetweenTests [get]
 Determines based on the EnvironmentSettings whether injected resources (such as Samples) are being deleted between each test.
 
TestContext TestContext [get, set]
 

Detailed Description

Create a test class that takes care of setting the server URL and cleaning up after each unit test.

Definition at line 23 of file BaseServerAPITestSuite.cs.

Inheritance diagram for AnalyzeReTesting.Base.BaseServerTestSuite:
AnalyzeReTesting.Base.BaseClientTestSuite AnalyzeReTesting.Base.BaseTestSuite AnalyzeReTesting.Base.BaseAbstractResourceTestSuite< T > AnalyzeReTesting.Base.BaseResourceTestSuite< T > AnalyzeReTesting.Tests.AnalyzeReAPI.TestSuite_API_Utilities AnalyzeReTesting.Tests.AnalyzeReAPI.TestSuite_REST_Methods AnalyzeReTesting.Tests.AnalyzeReAPI.TestSuite_Serializers AnalyzeReTesting.Tests.AnalyzeReAPI.Test_API_BugReports AnalyzeReTesting.Tests.Model.DataTypes.TestSuite_References AnalyzeReTesting.Tests.Model.DataTypes.TestSuite_SimulationOptions AnalyzeReTesting.Tests.Utilities.Meta_TestSuite_Utilities_Server

Constructor & Destructor Documentation

◆ BaseServerTestSuite()

AnalyzeReTesting.Base.BaseServerTestSuite.BaseServerTestSuite ( bool?  CleanBeforeEveryTest = null,
bool?  CleanAfterEveryTest = null 
)
inlineprotected

BaseServerAPITest Constructor. MSTest runs this constructor for each test.

Parameters
CleanBeforeEveryTestOptionally allows the derived class to control cleanup behaviour in spite of the global default.
CleanAfterEveryTestOptionally allows the derived class to control cleanup behaviour in spite of the global default.

Definition at line 179 of file BaseServerAPITestSuite.cs.

Member Function Documentation

◆ AddCommonTestCleanupAction()

void AnalyzeReTesting.Base.BaseTestSuite.AddCommonTestCleanupAction ( Action  action)
inlineprotectedinherited

Definition at line 80 of file BaseTestSuite.cs.

◆ AddCommonTestInitializeAction()

void AnalyzeReTesting.Base.BaseTestSuite.AddCommonTestInitializeAction ( Action  action)
inlineprotectedinherited

Definition at line 75 of file BaseTestSuite.cs.

◆ ApplyConfiguredCredentials()

static void AnalyzeReTesting.Base.BaseServerTestSuite.ApplyConfiguredCredentials ( )
inlinestatic

Apply the current configured API_URL and API_AuthenticationToken credentials to the static API.

Definition at line 226 of file BaseServerAPITestSuite.cs.

◆ BaseClass_Cleanup()

static void AnalyzeReTesting.Base.BaseTestSuite.BaseClass_Cleanup ( Action  action)
inlinestaticprotectedinherited

Definition at line 66 of file BaseTestSuite.cs.

◆ BaseClass_Initialize()

static void AnalyzeReTesting.Base.BaseTestSuite.BaseClass_Initialize ( TestContext  context,
Action  action 
)
inlinestaticprotectedinherited

Definition at line 56 of file BaseTestSuite.cs.

◆ BaseTest_Cleanup()

void AnalyzeReTesting.Base.BaseTestSuite.BaseTest_Cleanup ( )
inlineinherited

Definition at line 46 of file BaseTestSuite.cs.

◆ BaseTest_Initialize()

void AnalyzeReTesting.Base.BaseTestSuite.BaseTest_Initialize ( )
inlineinherited

Definition at line 35 of file BaseTestSuite.cs.

◆ CheckConnection()

static void AnalyzeReTesting.Base.BaseServerTestSuite.CheckConnection ( )
inlinestatic

Set the Client API Server URL to the configured API_URL.

Definition at line 235 of file BaseServerAPITestSuite.cs.

◆ TestSuiteCleanup()

static void AnalyzeReTesting.Base.BaseServerTestSuite.TestSuiteCleanup ( )
inlinestatic

Actions to run once when the C# Unit Tests finish. Note: This method will not automatically be inherited and run by tests suites in different assemblies that import this library. You will need to create your own method with the [AssemblyCleanup] attribute that calls this method.

Definition at line 163 of file BaseServerAPITestSuite.cs.

◆ TestSuiteInitialize()

static void AnalyzeReTesting.Base.BaseServerTestSuite.TestSuiteInitialize ( TestContext  context)
inlinestatic

Actions to run once when the C# Unit Tests initialize. Note: This method will not automatically be inherited and run by tests suites in different assemblies that import this library. You will need to create your own method with the [AssemblyInitialize] attribute that calls this method.

Definition at line 84 of file BaseServerAPITestSuite.cs.

Member Data Documentation

◆ Reflection

Reflection AnalyzeReTesting.Base.BaseClientTestSuite.Reflection
staticinherited

Shared instance of a class for generating random resources.

Definition at line 18 of file BaseClientTestSuite.cs.

◆ Samples

Samples AnalyzeReTesting.Base.BaseClientTestSuite.Samples
staticinherited

Shared instance of a class for generating reusable sample resources.

Definition at line 15 of file BaseClientTestSuite.cs.

Property Documentation

◆ API_AuthenticationToken

IAccessToken AnalyzeReTesting.Base.BaseServerTestSuite.API_AuthenticationToken
staticgetset

Set the AuthenticationToken to supply to the server before every test (if applicable).

Definition at line 32 of file BaseServerAPITestSuite.cs.

◆ API_URL

string AnalyzeReTesting.Base.BaseServerTestSuite.API_URL
staticgetset

Location of the REST API being tested against. This can be set using the API_URL environment variable. Default is https://localhost:8000/.

Definition at line 28 of file BaseServerAPITestSuite.cs.

◆ DeletingResourcesBetweenTests

bool AnalyzeReTesting.Base.BaseServerTestSuite.DeletingResourcesBetweenTests
get

Determines based on the EnvironmentSettings whether injected resources (such as Samples) are being deleted between each test.

Definition at line 46 of file BaseServerAPITestSuite.cs.

◆ TestContext

TestContext AnalyzeReTesting.Base.BaseTestSuite.TestContext
getsetinherited

Definition at line 20 of file BaseTestSuite.cs.


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