Azure DevOps Migration Tools

v14.3.4

Azure DevOps Migration Tools

Overview

TestPlansAndSuitesMigrationContext

Ref

  

Less than 1 minute to read

  

2023-11-29 05:34:35 -0600

Rebuilds Suits and plans for Test Cases migrated using the WorkItemMigration

Options

Parameter name Type Description Default Value
AreaMaps Dictionary See documentation for [NodeStructure](/docs/Reference/v1/Processors/WorkItemMigrationConfig.md)
Enabled Boolean missng XML code comments missng XML code comments
FilterCompleted Boolean missng XML code comments missng XML code comments
IterationMaps Dictionary See documentation for [NodeStructure](/docs/Reference/v1/Processors/WorkItemMigrationConfig.md)
MigrationDelay Int32 ??Not sure what this does. Check code. 0
NodeBasePaths String[] See documentation for [NodeStructure](/docs/Reference/v1/Processors/WorkItemMigrationConfig.md) []
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`
PrefixProjectToNodes Boolean Prefix the nodes with the new project name. false
RemoveAllLinks Boolean ??Not sure what this does. Check code. false
RemoveInvalidTestSuiteLinks Boolean Remove Invalid Links, see https://github.com/nkdAgility/azure-devops-migration-tools/issues/178 missng XML code comments
TestPlanQueryBit 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`
UseCommonNodeStructureEnricherConfig 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

Example

A basic sample for TestPlansAndSuitesMigrationContext configuration.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
  "$type": "TestPlansAndSuitesMigrationConfig",
  "Enabled": false,
  "PrefixProjectToNodes": false,
  "OnlyElementsWithTag": null,
  "TestPlanQueryBit": null,
  "RemoveAllLinks": false,
  "MigrationDelay": 0,
  "UseCommonNodeStructureEnricherConfig": false,
  "NodeBasePaths": null,
  "AreaMaps": null,
  "IterationMaps": null,
  "RemoveInvalidTestSuiteLinks": false,
  "FilterCompleted": false
}

Additional Samples & Info

To run a full plans and suits 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
    }
]

Known working TestPlanQueryBit filter fields names

AreaPath, PlanName and PlanState

"TestPlanQueryBit": "PlanName = 'ABC'"