Processors : TfsTestPlansAndSuitesMigrationProcessor

Ref

Less than 1 minute to read

2025-06-19 13:46:05 +0000

draft

This page is in draft and may include errors or omissions. Please check the discussions for any pending updates and changes to the content or to suggest your own changes.

Rebuilds Suits and plans for Test Cases migrated using the WorkItemMigration

Options

Parameter name	Type	Description	Default Value
Enabled	Boolean	If set to `true` then the processor will run. Set to `false` and the processor will not run.	missing XML code comments
FilterCompleted	Boolean	missing XML code comments	missing XML code comments
MigrationDelay	Int32	??Not sure what this does. Check code.	0
OnlyElementsWithTag	String	The tag name that is present on all elements that must be migrated. If this option isn't present this processor will migrate all.	`String.Empty`
RemoveAllLinks	Boolean	??Not sure what this does. Check code.	false
RemoveInvalidTestSuiteLinks	Boolean	Indicates whether the configuration for node structure transformation should be taken from the common enricher configs. Otherwise the configuration elements below are used	false
SourceName	String	This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.	missing XML code comments
TargetName	String	This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.	missing XML code comments
TestPlanIds	Int32[]	This flag filters all test plans and retains only the specified ones for migration. Pass the test plan IDs as an array. Example: "TestPlanIds": [123, 456, 789] Works optimally when "TestPlanQuery" is set to null.	missing XML code comments
TestPlanQuery	String	Filtering conditions to decide whether to migrate a test plan or not. When provided, this partial query is added after `Select * From TestPlan Where` when selecting test plans. Among filtering options, `AreaPath`, `PlanName` and `PlanState` are known to work. There is unfortunately no documentation regarding the available fields.	`String.Empty`

Examples

sample

This is an example of what your config might look like once configured.


1
2

    There is no sample, but you can check the classic below for a general feel.

defaults

These are the default values for this configuration. If you do not set it in your config the default always applies. You can overide by adding a diferent value in your config.


1
2

    There are no defaults! Check the sample for options!

classic

We have moved to a new config format, and you will need to update your old configs. This entry is a strate seralisation of the object and is here for legacy, and may provide value for debugging issues.


1
2
3
4
5
6
7
8
9
10
11
12
13
14

    {
  "$type": "TfsTestPlansAndSuitesMigrationProcessorOptions",
  "Enabled": false,
  "OnlyElementsWithTag": null,
  "TestPlanQuery": null,
  "RemoveAllLinks": false,
  "MigrationDelay": 0,
  "RemoveInvalidTestSuiteLinks": false,
  "FilterCompleted": false,
  "TestPlanIds": [],
  "SourceName": null,
  "TargetName": null
}

## Additional Samples & Info

To run a full plans and suites you should run the three processors in this order below. TestVariablesMigrationConfig and TestConfigurationsMigrationConfig only need run once.

"Processors": [
    {
      "$type": "TestVariablesMigrationConfig",
      "Enabled": false
    },
    {
      "$type": "TestConfigurationsMigrationConfig",
      "Enabled": true
    },
    {
      "$type": "TestPlansAndSuitesMigrationConfig",
      "Enabled": true,
      "PrefixProjectToNodes": false,
      "OnlyElementsWithTag": null,
      "TestPlanQueryBit": null,
      "RemoveAllLinks": false,
      "MigrationDelay": 0,
      "UseCommonNodeStructureEnricherConfig": false,
      "NodeBasePaths": [],
      "AreaMaps": null,
      "IterationMaps": null,
      "RemoveInvalidTestSuiteLinks": false,
      "FilterCompleted": false
    }
]