Runs - Create

Référence

Service:: Test

API Version:: 7.1-preview.3

Créez une série de tests.

POST https://dev.azure.com/{organization}/{project}/_apis/test/runs?api-version=7.1-preview.3

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path	True	string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.3 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
automated	boolean	true si la série de tests est automatisée, false dans le cas contraire. Par défaut, elle sera false.
build	ShallowReference	Référence abstraite à la build à laquelle elle appartient.
buildDropLocation	string	Emplacement de suppression de la build utilisée pour la série de tests.
buildFlavor	string	Saveur de la build utilisée pour la série de tests. (Par exemple: Release, Debug)
buildPlatform	string	Plateforme de la build utilisée pour la série de tests. (par exemple : x86, amd64)
buildReference	BuildConfiguration	BuildReference de la série de tests.
comment	string	Commentaires entrés par ceux qui analysent l’exécution.
completeDate	string	Date d’heure de fin de l’exécution.
configurationIds	integer[]	ID des configurations de test associées à l’exécution.
controller	string	Nom du contrôleur de test utilisé pour l’exécution automatisée.
customTestFields	CustomTestField[]	Propriétés supplémentaires de l’exécution de test.
dtlAutEnvironment	ShallowReference	Référence abstraite à DtlAutEnvironment.
dtlTestEnvironment	ShallowReference	Référence abstraite à DtlTestEnvironment.
dueDate	string	Date et heure d’échéance de la série de tests.
environmentDetails	DtlEnvironmentDetails	Il s’agit d’une classe temporaire qui fournit les détails de l’environnement de série de tests.
errorMessage	string	Message d’erreur associé à l’exécution.
filter	RunFilter	Filtre utilisé pour la découverte de l’exécution.
iteration	string	Itération dans laquelle créer l’exécution. L’itération racine du projet d’équipe sera par défaut
name	string	Nom de la série de tests.
owner	IdentityRef	Nom d’affichage du propriétaire de l’exécution.
pipelineReference	PipelineReference	Référence du pipeline auquel appartient cette série de tests. PipelineReference.PipelineId doit être égal à RunCreateModel.Build.Id
plan	ShallowReference	Référence abstraite au plan auquel il appartient.
pointIds	integer[]	ID des points de test à utiliser dans l’exécution.
releaseEnvironmentUri	string	URI de l’environnement de mise en production associé à l’exécution.
releaseReference	ReleaseReference	Référence à la mise en production associée à la série de tests.
releaseUri	string	URI de mise en production associée à l’exécution.
runSummary	RunSummaryModel[]	Résumé de l’exécution pour type d’exécution = NoConfigRun.
runTimeout	string	Intervalle de temps jusqu’à l’expiration de l’exécution.
sourceWorkflow	string	SourceWorkFlow(CI/CD) de la série de tests.
startDate	string	Date de début heure de l’exécution.
state	string	État de l’exécution. Type TestRunState États valides - NotStarted, InProgress, Waiting
tags	TestTag[]	Balises à attacher avec la série de tests, un maximum de 5 balises peuvent être ajoutées pour s’exécuter.
testConfigurationsMapping	string	TestConfigurationMapping de la série de tests.
testEnvironmentId	string	ID de l’environnement de test associé à l’exécution.
testSettings	ShallowReference	Référence abstraite à la ressource de paramètres de test.
type	string	Type des valeurs valides run(RunType) : (Unspecified, Normal, Blocking, Web, MtrRunInitiatedFromWeb, RunWithDtlEnv, NoConfigRun)

Réponses

Nom	Type	Description
200 OK	TestRun	opération réussie

Sécurité

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Nom	Description
vso.test_write	Permet de lire, de créer et de mettre à jour des plans de test, des cas, des résultats et d’autres artefacts liés à la gestion des tests.

Exemples

Sample Request

HTTP

POST https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/runs?api-version=7.1-preview.3

{
  "name": "NewTestRun",
  "plan": {
    "id": "1"
  },
  "pointIds": [
    1,
    1
  ]
}

Sample Response

Status code:: 200

{
  "id": 31,
  "name": "NewTestRun",
  "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Runs/31",
  "isAutomated": false,
  "iteration": "Fabrikam-Fiber-TFVC\\Release 1\\Sprint 1",
  "owner": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "project": {
    "id": "eb6e4656-77fc-42a1-9181-4c6d8e9da5d1",
    "name": "Fabrikam-Fiber-TFVC",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/Fabrikam-Fiber-TFVC"
  },
  "startedDate": "2014-05-28T16:39:00.44Z",
  "state": "InProgress",
  "plan": {
    "id": "1",
    "name": "sprint1",
    "url": "https://dev.azure.com/fabrikam/fabrikam-fiber-tfvc/_apis/test/Plans/1"
  },
  "postProcessState": "Complete",
  "totalTests": 2,
  "incompleteTests": 2,
  "createdDate": "2014-05-28T16:39:00.4Z",
  "lastUpdatedDate": "2014-05-28T16:39:00.44Z",
  "lastUpdatedBy": {
    "id": "8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "displayName": "Chuck Reinhart",
    "uniqueName": "fabrikamfiber3@hotmail.com",
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d",
    "imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=8c8c7d32-6b1b-47f4-b2e9-30b477b5ab3d"
  },
  "revision": 2
}

Définitions

Nom	Description
BuildConfiguration	Détails de buildConfiguration.
CustomTestField	Informations de champ personnalisées. Clé autorisée : paires valeur - ( AttemptId: int value, IsTestResultFlaky: bool)
DtlEnvironmentDetails	Il s’agit d’une classe temporaire qui fournit les détails de l’environnement de série de tests.
IdentityRef
JobReference	Travail dans le pipeline. Cela est lié à la matrice dans YAML.
PhaseReference	Phase dans le pipeline
PipelineReference	Informations de référence sur le pipeline
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
ReleaseReference	Référence à une mise en production.
ResultMetadata	ResultMetadata pour le résultat/nombre donné.
RunCreateModel	Détails de la création de la série de tests.
RunFilter	Cette classe est utilisée pour fournir les filtres utilisés pour la découverte
RunStatistic	Statistiques de séries de tests par résultat.
RunSummaryModel	Résumé de l’exécution pour chaque type de test de sortie.
ShallowReference	Référence abstraite à une autre ressource. Cette classe est utilisée pour fournir aux contrats de données de build un moyen uniforme de référencer d’autres ressources de manière à faciliter la traversée des liens.
StageReference	Étape dans le pipeline
TestEnvironment	Détail de l’environnement de test.
TestOutcome
TestResolutionState	Détails de l’état de résolution de test.
TestRun	Détails de la série de tests.
TestRunSubstate	Types de sous-états pour la série de tests.
TestTag	Balise attachée à une exécution ou à un résultat.

BuildConfiguration

Détails de buildConfiguration.

Nom	Type	Description
branchName	string	Nom de la branche pour laquelle la build est générée.
buildDefinitionId	integer	BuildDefinitionId pour build.
buildSystem	string	Système de génération.
creationDate	string	Date de création de la build.
flavor	string	Version de build (par exemple Build/Release).
id	integer	BuildConfiguration Id.
number	string	Numéro de build.
platform	string	BuildConfiguration Platform.
project	ShallowReference	Projet associé à cette BuildConfiguration.
repositoryGuid	string	GUID de dépôt pour la build.
repositoryType	string	Type de dépôt (par exemple, TFSGit).
sourceVersion	string	La version source(/la première validation) de la build a été déclenchée.
targetBranchName	string	BranchName cible.
uri	string	URI de build.

CustomTestField

Informations de champ personnalisées. Clé autorisée : paires valeur - ( AttemptId: int value, IsTestResultFlaky: bool)

Nom	Type	Description
fieldName	string	le nom du champ ;
value	object	Valeur de champ.

DtlEnvironmentDetails

Il s’agit d’une classe temporaire qui fournit les détails de l’environnement de série de tests.

Nom	Type	Description
csmContent	string
csmParameters	string
subscriptionName	string

IdentityRef

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
descriptor	string	Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations.
directoryAlias	string	Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « self » du dictionnaire IdentityRef « _links »
displayName	string	Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string	Déprécié : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive	boolean	Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity	boolean	Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Déprécié : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName	string	Déconseillé : utilisez à la place Domain+PrincipalName
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

JobReference

Travail dans le pipeline. Cela est lié à la matrice dans YAML.

Nom	Type	Description
attempt	integer	Numéro de tentative du travail
jobName	string	La matrice dans YAML génère des copies d’un travail avec différentes entrées dans la matrice. JobName est le nom de ces entrées. La longueur maximale prise en charge pour le nom est de 256 caractères.

PhaseReference

Phase dans le pipeline

Nom	Type	Description
attempt	integer	Numéro de tentative de la phase
phaseName	string	Nom de la phase. La longueur maximale prise en charge pour le nom est de 256 caractères.

PipelineReference

Informations de référence sur le pipeline

Nom	Type	Description
jobReference	JobReference	Référence du travail
phaseReference	PhaseReference	Référence de la phase.
pipelineId	integer	Référence du pipeline avec lequel ce pipeline instance est lié.
stageReference	StageReference	Référence de la phase.

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

ReleaseReference

Référence à une mise en production.

Nom	Type	Description
attempt	integer	Nombre de tentatives de mise en production.
creationDate	string	Date de création de la mise en production (UTC).
definitionId	integer	ID de définition de mise en production.
environmentCreationDate	string	Date de création de l’environnement (UTC).
environmentDefinitionId	integer	ID de définition de l’environnement de mise en production.
environmentDefinitionName	string	Nom de la définition de l’environnement de mise en production.
environmentId	integer	ID d’environnement de mise en production.
environmentName	string	Nom de l’environnement de mise en production.
id	integer	ID de mise en production.
name	string	Nom de la version.

ResultMetadata

ResultMetadata pour le résultat/nombre donné.

Nom	Type	Description
flaky	string	Métadonnées floues
rerun	string	Réexécuter les métadonnées

RunCreateModel

Détails de la création de la série de tests.

Nom	Type	Description
automated	boolean	true si la série de tests est automatisée, false dans le cas contraire. Par défaut, elle sera false.
build	ShallowReference	Référence abstraite à la build à laquelle elle appartient.
buildDropLocation	string	Emplacement de suppression de la build utilisée pour la série de tests.
buildFlavor	string	Saveur de la build utilisée pour la série de tests. (Par exemple: Release, Debug)
buildPlatform	string	Plateforme de la build utilisée pour la série de tests. (par exemple : x86, amd64)
buildReference	BuildConfiguration	BuildReference de la série de tests.
comment	string	Commentaires entrés par ceux qui analysent l’exécution.
completeDate	string	Date d’heure de fin de l’exécution.
configurationIds	integer[]	ID des configurations de test associées à l’exécution.
controller	string	Nom du contrôleur de test utilisé pour l’exécution automatisée.
customTestFields	CustomTestField[]	Propriétés supplémentaires de l’exécution de test.
dtlAutEnvironment	ShallowReference	Référence abstraite à DtlAutEnvironment.
dtlTestEnvironment	ShallowReference	Référence abstraite à DtlTestEnvironment.
dueDate	string	Date et heure d’échéance de la série de tests.
environmentDetails	DtlEnvironmentDetails	Il s’agit d’une classe temporaire qui fournit les détails de l’environnement de série de tests.
errorMessage	string	Message d’erreur associé à l’exécution.
filter	RunFilter	Filtre utilisé pour la découverte de l’exécution.
iteration	string	Itération dans laquelle créer l’exécution. L’itération racine du projet d’équipe sera par défaut
name	string	Nom de la série de tests.
owner	IdentityRef	Nom d’affichage du propriétaire de l’exécution.
pipelineReference	PipelineReference	Référence du pipeline auquel appartient cette série de tests. PipelineReference.PipelineId doit être égal à RunCreateModel.Build.Id
plan	ShallowReference	Référence abstraite au plan auquel il appartient.
pointIds	integer[]	ID des points de test à utiliser dans l’exécution.
releaseEnvironmentUri	string	URI de l’environnement de mise en production associé à l’exécution.
releaseReference	ReleaseReference	Référence à la mise en production associée à la série de tests.
releaseUri	string	URI de mise en production associée à l’exécution.
runSummary	RunSummaryModel[]	Résumé de l’exécution pour type d’exécution = NoConfigRun.
runTimeout	string	Intervalle de temps jusqu’à l’expiration de l’exécution.
sourceWorkflow	string	SourceWorkFlow(CI/CD) de la série de tests.
startDate	string	Date de début heure de l’exécution.
state	string	État de l’exécution. Type TestRunState États valides - NotStarted, InProgress, Waiting
tags	TestTag[]	Balises à attacher avec la série de tests, un maximum de 5 balises peuvent être ajoutées pour s’exécuter.
testConfigurationsMapping	string	TestConfigurationMapping de la série de tests.
testEnvironmentId	string	ID de l’environnement de test associé à l’exécution.
testSettings	ShallowReference	Référence abstraite à la ressource de paramètres de test.
type	string	Type des valeurs valides run(RunType) : (Unspecified, Normal, Blocking, Web, MtrRunInitiatedFromWeb, RunWithDtlEnv, NoConfigRun)

RunFilter

Cette classe est utilisée pour fournir les filtres utilisés pour la découverte

Nom	Type	Description
sourceFilter	string	filtre pour les sources de cas de test (conteneurs de test)
testCaseFilter	string	filtre pour les cas de test

RunStatistic

Statistiques de séries de tests par résultat.

Nom	Type	Description
count	integer	Nombre de résultats de test pour le résultat donné.
outcome	string	Résultat du test
resolutionState	TestResolutionState	État de résolution de la série de tests.
resultMetadata	ResultMetadata	ResultMetadata pour le résultat/nombre donné.
state	string	État de la série de tests

RunSummaryModel

Résumé de l’exécution pour chaque type de test de sortie.

Nom	Type	Description
duration	integer	Temps total pris en millisecondes.
resultCount	integer	Nombre de résultats pour test de résultatOutcome
testOutcome	TestOutcome	Le résumé est basé sur le résultat

ShallowReference

Référence abstraite à une autre ressource. Cette classe est utilisée pour fournir aux contrats de données de build un moyen uniforme de référencer d’autres ressources de manière à faciliter la traversée des liens.

Nom	Type	Description
id	string	ID de la ressource
name	string	Nom de la ressource liée (nom de la définition, nom du contrôleur, etc.)
url	string	Lien HTTP complet vers la ressource

StageReference

Étape dans le pipeline

Nom	Type	Description
attempt	integer	Numéro de tentative d’étape
stageName	string	Nom de la phase. La longueur maximale prise en charge pour le nom est de 256 caractères.

TestEnvironment

Détail de l’environnement de test.

Nom	Type	Description
environmentId	string	ID d’environnement de test.
environmentName	string	Nom de l’environnement de test.

TestOutcome

Nom	Type	Description
aborted	string	Le test a été abandonné. Cela n’a pas été provoqué par un geste de l’utilisateur, mais plutôt par une décision-cadre.
blocked	string	Le test avait la chance d’être exécuté, mais ne l’était pas, car ITestElement.IsRunnable == false.
error	string	Une erreur système s’est produite pendant que nous essayions d’exécuter un test.
failed	string	Le test a été exécuté, mais il y a eu des problèmes. Les problèmes peuvent impliquer des exceptions ou des assertions ayant échoué.
inProgress	string	Le test est en cours d’exécution. Ajout de ceci pour les graphiques TCM
inconclusive	string	Le test est terminé, mais nous ne pouvons pas dire s’il a réussi ou échoué. Peut être utilisé pour les tests abandonnés...
none	string	Le test n’est pas terminé ou le type de test ne signale pas de réussite/échec.
notApplicable	string	Le test n’est pas applicable pour l’exécution.
notExecuted	string	Le test n’a pas été exécuté. Cela a été dû à un mouvement de l’utilisateur , par exemple, le bouton d’arrêt de l’utilisateur.
notImpacted	string	Le test n’est pas impacté. Ajout de fot TIA.
passed	string	Le test a été exécuté avec tous les problèmes.
paused	string	Le test est suspendu.
timeout	string	Le test a expiré
unspecified	string	Utilisé uniquement lors d’une mise à jour pour conserver la valeur existante.
warning	string	À utiliser par les résultats de niveau d’exécution. Il ne s’agit pas d’un échec.

TestResolutionState

Détails de l’état de résolution de test.

Nom	Type	Description
id	integer	ID d’état de résolution de test.
name	string	Nom de l’état de résolution de test.
project	ShallowReference	Référence abstraite à une autre ressource. Cette classe est utilisée pour fournir aux contrats de données de build un moyen uniforme de référencer d’autres ressources d’une manière qui permet de parcourir facilement les liens.

TestRun

Détails de la série de tests.

Nom	Type	Description
build	ShallowReference	Build associée à cette série de tests.
buildConfiguration	BuildConfiguration	Détails de configuration de build associés à cette série de tests.
comment	string	Commentaires entrés par ceux qui analysent l’exécution.
completedDate	string	Date d’exécution de l’exécution.
controller	string	Contrôleur d’exécution de test.
createdDate	string	Exécution de test CreatedDate.
customFields	CustomTestField[]	Liste des champs personnalisés pour TestRun.
dropLocation	string	Supprimer l’emplacement de l’exécution de test.
dtlAutEnvironment	ShallowReference	Référence abstraite à une autre ressource. Cette classe est utilisée pour fournir aux contrats de données de build un moyen uniforme de référencer d’autres ressources de manière à faciliter la traversée des liens.
dtlEnvironment	ShallowReference	Référence abstraite à une autre ressource. Cette classe est utilisée pour fournir aux contrats de données de build un moyen uniforme de référencer d’autres ressources de manière à faciliter la traversée des liens.
dtlEnvironmentCreationDetails	DtlEnvironmentDetails	Il s’agit d’une classe temporaire qui fournit les détails de l’environnement de série de tests.
dueDate	string	Date et heure d’échéance de la série de tests.
errorMessage	string	Message d’erreur associé à l’exécution.
filter	RunFilter	Cette classe est utilisée pour fournir les filtres utilisés pour la découverte
id	integer	ID de la série de tests.
incompleteTests	integer	Nombre de tests incomplets.
isAutomated	boolean	true si la série de tests est automatisée, false dans le cas contraire.
iteration	string	Itération à laquelle appartient l’exécution.
lastUpdatedBy	IdentityRef	ID de base d’équipe de la dernière mise à jour de la série de tests.
lastUpdatedDate	string	Date et heure de la dernière mise à jour
name	string	Nom de la série de tests.
notApplicableTests	integer	Nombre de tests non applicables.
owner	IdentityRef	ID Team Foundation du propriétaire des exécutions.
passedTests	integer	Nombre de tests réussis dans l’exécution
phase	string	Phase/État pour le testRun.
pipelineReference	PipelineReference	Référence du pipeline auquel appartient cette série de tests.
plan	ShallowReference	Plan de test associé à cette série de tests.
postProcessState	string	Post-processus.
project	ShallowReference	Projet associé à cette exécution.
release	ReleaseReference	Référence de mise en production pour la série de tests.
releaseEnvironmentUri	string	URI d’environnement de mise en production pour TestRun.
releaseUri	string	URI de mise en production pour TestRun.
revision	integer
runStatistics	RunStatistic[]	ExécuterSummary par résultat.
startedDate	string	Date de début heure de l’exécution.
state	string	État de l’exécution. Type TestRunState États valides - Non spécifié, NotStarted, InProgress, Completed, Waiting, Aborted, NeedsInvestigation
substate	TestRunSubstate	Sous-état TestRun.
tags	TestTag[]	Balises jointes à cette série de tests.
testEnvironment	TestEnvironment	Environnement de test associé à l’exécution.
testMessageLogId	integer
testSettings	ShallowReference	Référence abstraite à une autre ressource. Cette classe est utilisée pour fournir aux contrats de données de build un moyen uniforme de référencer d’autres ressources d’une manière qui permet de parcourir facilement les liens.
totalTests	integer	Nombre total de tests dans l’exécution
unanalyzedTests	integer	Nombre de tests ayant échoué dans l’exécution.
url	string	URL de la série de tests
webAccessUrl	string	URL d’accès web pour TestRun.

TestRunSubstate

Types de sous-états pour la série de tests.

Nom	Type	Description
abortedBySystem	string	État d’exécution lorsqu’il est abandonné par le système.
analyzed	string	État d’exécution après analyse.
canceledByUser	string	État d’exécution lors de la création d’un environnement.
cancellationInProgress	string	État d’exécution lorsque l’annulation est en cours.
creatingEnvironment	string	État d’exécution lors de la création d’un environnement.
none	string	Exécutez avec noState.
pendingAnalysis	string	État d’exécution pendant l’analyse en attente.
runningTests	string	État d’exécution lors de l’exécution de tests.
timedOut	string	État d’exécution lorsque l’exécution a timedOut.

TestTag

Balise attachée à une exécution ou à un résultat.

Nom	Type	Description
name	string	Nom de la balise, valeur alphanumérique inférieure à 30 caractères

Partager via