Product Documentation

Start-EnvTestTask

Apr 15, 2014

Starts a new test task.

Syntax

Start-EnvTestTask -TestId <String> [-TargetIdType <String>] [-TargetId <String>] [-CultureName <String>] [-IgnoreRelatedObjects] [-RunAsynchronously] [-ExcludeNotRunTests] [-AdminAddress <String>] [<CommonParameters>]

Start-EnvTestTask -TestSuiteId <String> [-TargetIdType <String>] [-TargetId <String>] [-CultureName <String>] [-IgnoreRelatedObjects] [-RunAsynchronously] [-ExcludeNotRunTests] [-AdminAddress <String>] [<CommonParameters>]

Start-EnvTestTask -InputObject <PSObject[]> [-CultureName <String>] [-IgnoreRelatedObjects] [-RunAsynchronously] [-ExcludeNotRunTests] [-AdminAddress <String>] [<CommonParameters>]

Detailed Description

Starts a new test task based on a set of criteria provided via parameters or piped input and either waits for the tests to run or returns immediately depending on how it is called. When running a test suite and providing a target object for that suite, the service will discover related objects by default, but this behavior may be disabled if desired.

Parameters

-TestId<String>

Test identifiers. If specified, do not specify -TestSuiteId.

Required? true
Default Value Empty
Accept Pipeline Input? false

-TestSuiteId<String>

Test suite identifiers. If specified, do not specify -TestId.

Required? true
Default Value Empty
Accept Pipeline Input? false

-InputObject<PSObject[]>

One or more test targets defining the task, see Input Types for details about what kind of objects are permissible. Any valid object passed to this parameter may also be piped into this cmdlet.

Required? true
Default Value Empty
Accept Pipeline Input? true (ByValue)

-TargetIdType<String>

Describes the type of corresponding object passed with -TargetId

Required? false
Default Value Empty
Accept Pipeline Input? false

-TargetId<String>

The Ids that object tests or tests suites will target. By default, other components are queried for objects related to these.

Required? false
Default Value Empty
Accept Pipeline Input? false

-CultureName<String>

The culture name in which to produce results. The culture name is in standard language/region-code format; for example "en-US".

Required? false
Default Value The current user interface culture
Accept Pipeline Input? false

-IgnoreRelatedObjects<SwitchParameter>

Do not ask other components for objects related to a specified target.

Required? false
Default Value False
Accept Pipeline Input? false

-RunAsynchronously<SwitchParameter>

Do not wait for the test run to complete, return immediately.

Required? false
Default Value False
Accept Pipeline Input? false

-ExcludeNotRunTests<SwitchParameter>

If set, tests that are not run because no object matching their requirements is found are NOT included in test counts and results.

Required? false
Default Value False (include Not Run tests)
Accept Pipeline Input? false

-AdminAddress<String>

Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.

Required? false
Default Value Localhost. Once a value is provided by any cmdlet, this value becomes the default.
Accept Pipeline Input? false

Input Type

Citrix.EnvTest.Sdk.EnvTestDiscoveryTargetDefinition A single EnvTestDiscoveryTargetDefinition can be specified to target one test or test suite. Citrix.EnvTest.Sdk.EnvTestDiscoveryTargetDefinition[] An array of EnvTestDiscoveryTargetDefinition(s) can be specified to target any combination of tests and/or test suites. PSCustomObject A single PSCustomObject with properties matching the required EnvTestDiscoveryTargetDefinition properties can be specified to target one test or test suite. PSCustomObject[] An array of PSCustomObject(s) with properties matching the required EnvTestDiscoveryTargetDefinition properties can be specified to target any combination of tests and/or test suites.

Return Values

Ctrix.EnvTest.Sdk.EnvTestTask

The newly started task.

Examples

-------------------------- EXAMPLE 1 --------------------------

$singleSimpleTestTask = Start-EnvTestTask -TestId Monitor_RegisteredWithConfigurationService

Create and start a task with a single test and no target object.

-------------------------- EXAMPLE 2 --------------------------

$singleSimpleTestTaskInSpanish = Start-EnvTestTask -TestId Monitor_RegisteredWithConfigurationService -CultureName es-ES

Create and start a task with a single test and no target object, with localized properties translated into Spanish.

-------------------------- EXAMPLE 3 --------------------------

$singleSimpleTestSuiteTask = Start-EnvTestTask -TestSuiteId Infrastructure

Create and start a task with a single test suite and no target object.

-------------------------- EXAMPLE 4 --------------------------

$singleTestSuiteTask = Start-EnvTestTask -TestSuiteId Catalog -TargetIdType Catalog -TargetId $(Get-BrokerCatalog).Uuid

Create and start a task with a single test suite and a catalog target object.

-------------------------- EXAMPLE 5 --------------------------

$singleTestSuiteTask = Start-EnvTestTask -TestSuiteId Catalog -TargetIdType Catalog -TargetId $(Get-BrokerCatalog).Uuid -RunAsynchronously

Create and start a task with a single test suite and a catalog target object, and return immediately not waiting for the tests to complete.

-------------------------- EXAMPLE 6 --------------------------

$adAccountPool = Get-AcctIdentityPool 
          $singleTestTaskWithNoObjectDiscovery = StartEnvTestTask -IgnoreRelatedObjects -TestId ADIdentity_IdentityPool_ValidatePoolIsUnlocked -TargetIdType IdentityPool -TargetId $adAccountPool.IdentityPoolUid

Create and start a task with a single test, a target object for that test, and no object discovery based on that target.

-------------------------- EXAMPLE 7 --------------------------

$singleSimpleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Infrastructure 
          $singleTestSuiteTaskTarget = New-EnvTestDiscoveryTargetDefinition -TestSuiteId Catalog -TargetIdType Catalog -TargetId $(Get-BrokerCatalog).Uuid 
          $inputObjects = @($singleSimpleTestSuiteTaskTarget, $singleTestSuiteTaskTarget) 
          Start-EnvTestTask -InputObject $inputObjects

Create two different discovery target definitions, put them in an array, then start a task based on both via -InputObject.