TestPlansAndSuitesMigrationContext

Ref

  

Less than 1 minute to read

  

2024-09-06 09:35:04 +0100

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	missng XML code comments	missng XML code comments
FilterCompleted	Boolean	missng XML code comments	missng 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	Remove Invalid Links, see https://github.com/nkdAgility/azure-devops-migration-tools/issues/178	missng 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`

Example

A basic sample for TestPlansAndSuitesMigrationContext configuration.

{
  "$type": "TestPlansAndSuitesMigrationConfig",
  "Enabled": false,
  "OnlyElementsWithTag": null,
  "TestPlanQuery": null,
  "RemoveAllLinks": false,
  "MigrationDelay": 0,
  "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'"