Tests .NET

À l'heure actuelle, la solution CI Visibility n'est pas disponible pour le site que vous avez sélectionné ().

Compatibilité

Versions .NET prises en charge :

  • .NET Core 2.1+ et 3.0+
  • .NET 5.0+

Frameworks de test pris en charge :

  • xUnit 2.2+
  • NUnit 3.0+
  • MsTest V2 14+

Prérequis

Installez l’Agent Datadog pour recueillir des données de test.

Installer le traceur .NET

Pour installer ou modifier la commande dd-trace sur l’ensemble de la machine, exécutez :

dotnet tool update -g dd-trace

Instrumenter des tests

Pour instrumenter votre collection de tests, ajoutez le préfixe dd-trace à la commande de votre test, en spécifiant le nom du service ou de la bibliothèque testé(e) avec le paramètre --dd-service ainsi que l’environnement dans lequel sont exécutés les tests (par exemple, local lorsque les tests sont exécutés sur la machine d’un développeur ou ci lorsqu’ils sont exécutés sur un fournisseur de CI) avec le paramètre --dd-env. Exemple :

dd-trace --dd-service=my-dotnet-app --dd-env=ci -- dotnet test

Tous les tests sont automatiquement instrumentés.

Paramètres de configuration

Vous pouvez modifier la configuration CLI par défaut à l’aide d’arguments de ligne de commande ou de variables d’environnement. Pour consulter la liste complète des paramètres de configuration, exécutez :

dd-trace --help

La liste suivante répertorie les valeurs par défaut des principaux paramètres de configuration :

--dd-service
Nom du service ou de la bibliothèque testé(e).
Variable d’environnement : DD_SERVICE
Valeur par défaut : le nom du référentiel
Exemple : my-dotnet-app
--dd-env
Nom de l’environnement dans lequel sont exécutés les tests.
Variable d’environnement : DD_ENV
Valeur par défaut : none
Exemples : local, ci
--agent-url
URL de l’Agent Datadog pour la collecte de traces, au format http://hostname:port.
Variable d’environnement : DD_TRACE_AGENT_URL
Valeur par défaut : http://localhost:8126

Vous pouvez également utiliser toutes les autres options de configuration du traceur Datadog.

Recueillir les métadonnées Git

Datadog tire profit des données Git pour vous présenter les résultats de vos tests et les regrouper par référentiel, branche et commit. Les métadonnées Git sont automatiquement recueillies par l’instrumentation de test, à partir des variables d’environnement du fournisseur de CI et du dossier local .git dans le chemin du projet, le cas échéant.

Si vous exécutez des tests dans des fournisseurs CI non pris en charge, ou sans dossier .git, vous pouvez configurer manuellement les données Git à l’aide de variables d’environnement. Ces dernières sont prioritaires et remplacent les informations détectées automatiquement. Configurez les variables d’environnement suivantes pour obtenir des données Git.

DD_GIT_REPOSITORY_URL
URL du référentiel dans lequel le code est stocké. Les URL HTTP et SSH sont prises en charge.
Exemple : git@github.com:MyCompany/MyApp.git, https://github.com/MyCompany/MyApp.git
DD_GIT_BRANCH
Branche Git testée. Ne renseignez pas cette variable si vous fournissez à la place des informations sur les tags.
Exemple : develop
DD_GIT_TAG
Tag Git testé (le cas échéant). Ne renseignez pas cette variable si vous fournissez à la place des informations sur la branche.
Exemple : 1.0.1
DD_GIT_COMMIT_SHA
Hash entier du commit.
Exemple : a18ebf361cc831f5535e58ec4fae04ffd98d8152
DD_GIT_COMMIT_MESSAGE
Message du commit.
Exemple : Set release number
DD_GIT_COMMIT_AUTHOR_NAME
Nom de l’auteur du commit.
Exemple : John Smith
DD_GIT_COMMIT_AUTHOR_EMAIL
E-mail de l’auteur du commit.
Exemple : john@example.com
DD_GIT_COMMIT_AUTHOR_DATE
Date de l’auteur du commit, au format ISO 8601.
Exemple : 2021-03-12T16:00:28Z
DD_GIT_COMMIT_COMMITTER_NAME
Nom du responsable du commit.
Exemple : Jane Smith
DD_GIT_COMMIT_COMMITTER_EMAIL
E-mail du responsable du commit.
Exemple : jane@example.com
DD_GIT_COMMIT_COMMITTER_DATE
Date du responsable du commit, au format ISO 8601.
Exemple : 2021-03-12T16:00:28Z

Instrumentation personnalisée

Remarque : la configuration d'instrumentation personnalisée varie selon la version de `dd-trace`. Pour profiter de l'instrumentation personnalisée, les versions des packages NuGet de `dd-trace` et de `Datadog.Trace` doivent être identiques.

Pour utiliser l’instrumentation personnalisée dans votre application .NET, procédez comme suit :

  1. Exécutez dd-trace --version pour obtenir la version de l’outil.
  2. Ajoutez le package NuGet Datadog.Trace à votre application, en prenant soin de bien choisir la version correspondant à celle de dd-trace.
  3. Dans le code de votre application, accédez au traceur global via la propriété Datadog.Trace.Tracer.Instance pour créer de nouvelles spans.

Pour découvrir comment ajouter des spans et des tags pour l’instrumentation personnalisée, consultez la documentation relative à l’instrumentation personnalisée .NET.

Pour aller plus loin