TestCluster

1. Documentation
2. API reference
3. Microsoft.Orleans.TestingHost
4. TestCluster

class

Namespace: Orleans.TestingHost

NuGetSourceMarkdown

A host class for local testing with Orleans using in-process silos. Runs a Primary and optionally secondary silos in separate app domains, and client in the main app domain. Additional silos can also be started in-process on demand if required for particular test cases.

public class TestCluster : IAsyncDisposable, IDisposable

Remarks

Make sure that your test project references your test grains and test grain interfaces projects, and has CopyLocal=True set on those references [which should be the default].

Constructors

• TestCluster(TestClusterOptions, IReadOnlyList<IConfigurationSource>, ITestClusterPortAllocator) Configures the test cluster plus client in-process.

Properties

• Client The client.
• ConfigurationSources Gets the configuration sources.
• CreateSiloAsync Delegate used to create and start an individual silo.
• GrainFactory GrainFactory to use in the tests
• Options Options used to configure the test cluster.
• PortAllocator The port allocator.
• Primary Primary silo handle, if applicable.
• SecondarySilos List of handles to the secondary silos.
• ServiceProvider Client-side System.IServiceProvider to use in the tests.
• Silos Collection of all known silos.

Methods

• DeactivateAsync(GrainId) Deactivates the current activation of the specified grain and waits for deactivation to complete.
• DeactivateAsync(IAddressable) Deactivates the current activation of the specified grain and waits for deactivation to complete.
• DefaultCreateSiloAsync(string, IConfiguration) Default value for TestCluster, which creates a new silo handle.
• Deploy Deploys the cluster using the specified configuration and starts the client in-process. It will start the number of silos defined in TestClusterOptions.
• DeployAsync Deploys the cluster using the specified configuration and starts the client in-process.
• DisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
• DisposeAsync Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.
• GetActiveSilos Get the list of current active silos.
• GetLivenessStabilizationTime(ClusterMembershipOptions, bool) Get the timeout value to use to wait for the silo liveness sub-system to detect and act on any recent cluster membership changes.
• GetLog Gets the log.
• GetSiloForAddress(SiloAddress) Find the silo handle for the specified silo address.
• GetSiloServiceProvider(SiloAddress) Returns the System.IServiceProvider associated with the given silo.
• InitializeClientAsync Initialize the grain client. This should be already done by TestCluster or TestCluster
• KillClientAsync Performs a hard kill on client. Client will not cleanup resources.
• KillSiloAsync(SiloHandle) Do an immediate Kill of the specified silo.
• MigrateAsync(GrainId, SiloAddress?) Migrates the current activation of the specified grain to a different silo and waits for migration to complete. If targetSilo is specified, a placement hint is set to guide migration to that silo.
• MigrateAsync(IAddressable, SiloAddress?) Migrates the current activation of the specified grain to a different silo and waits for migration to complete. If targetSilo is specified, a placement hint is set to guide migration to that silo.
• RestartSiloAsync(SiloHandle) Do a Stop or Kill of the specified silo, followed by a restart.
• RestartStoppedSecondarySiloAsync(string) Restart a previously stopped.
• StartAdditionalSilo(bool) Start an additional silo, so that it joins the existing cluster.
• StartAdditionalSiloAsync(bool) Start an additional silo, so that it joins the existing cluster.
• StartAdditionalSilosAsync(int, bool) Start a number of additional silo, so that they join the existing cluster.
• StartSiloAsync(int, TestClusterOptions, IReadOnlyList<IConfigurationSource>, bool) Starts a new silo.
• StartSiloAsync(TestCluster, int, TestClusterOptions, IReadOnlyList<IConfigurationSource>, bool) Start a new silo in the target cluster
• StopAllSilos Stop all current silos.
• StopAllSilosAsync Stop all current silos.
• StopClusterClientAsync Stop cluster client as an asynchronous operation.
• StopPrimarySiloAsync Stops the default Primary silo.
• StopSecondarySilosAsync Stop any additional silos, not including the default Primary silo.
• StopSiloAsync(SiloHandle) Do a semi-graceful Stop of the specified silo.
• TryGetGrainContext(GrainId, IGrainContext?) Attempts to find the IGrainContext for the grain with the specified grainId by searching all silos in the cluster.
• WaitForClusterManifestToStabilizeAsync(bool) Wait for active silos to observe cluster manifest updates for all active silos.
• WaitForDeactivationAsync(GrainId) Gets a System.Threading.Tasks.Task that completes when the current activation of the specified grain finishes deactivating. If the grain is not currently activated, returns System.Threading.Tasks.Task.CompletedTask.
• WaitForDeactivationAsync(IAddressable) Gets a System.Threading.Tasks.Task that completes when the current activation of the specified grain finishes deactivating. If the grain is not currently activated, returns System.Threading.Tasks.Task.CompletedTask.
• WaitForLivenessToStabilizeAsync(bool) Wait for the silo liveness sub-system to detect and act on any recent cluster membership changes.