Swift Academy · Leçon

Tester et déboguer des macros

Écrire des tests unitaires pour les expansions de macros avec assertMacroExpansion.

Leçon 4 sur 413 étapes

Tester et déboguer des macros est une leçon Swift Academy gratuite sur CoddyKit. Ceci est la leçon 4 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Swift Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Swift Academy comprend 4 leçons au total.

Pourquoi tester les macros ?

Les macros génèrent du code à la compilation. Les tests unitaires vérifient le code source généré avant sa mise en production.

// The swift-syntax package ships SwiftSyntaxMacrosTestSupport
// with assertMacroExpansion for testing macro output

assertMacroExpansion

assertMacroExpansion reçoit le code source d’entrée et le code source développé attendu, puis vérifie qu’ils correspondent.

import SwiftSyntaxMacrosTestSupport
import XCTest

final class StringifyMacroTests: XCTestCase {
  func testStringify() throws {
    assertMacroExpansion(
      "#stringify(1 + 2)",
      expandedSource: "(1 + 2, \"1 + 2\")",
      macros: ["stringify": StringifyMacro.self]
    )
  }
}

Tester les macros attachées

Fournissez la structure ou la classe décorée en entrée, ainsi que le code source entièrement développé comme sortie attendue.

assertMacroExpansion(
  "@AddID struct User { var name: String }",
  expandedSource: """
  struct User {
    var name: String
    var id = UUID()
  }
  """,
  macros: ["AddID": AddIDMacro.self]
)

Tester l’émission de diagnostics

Vérifiez que votre macro émet le diagnostic approprié (avertissement ou erreur) lorsqu’elle est mal utilisée.

assertMacroExpansion(
  "@AddID class Foo {}",
  expandedSource: "class Foo {}",
  diagnostics: [
    DiagnosticSpec(message: "@AddID can only be applied to structs", line: 1, column: 1)
  ],
  macros: ["AddID": AddIDMacro.self]
)

Développer des macros dans Xcode

Dans Xcode, cliquez avec le bouton droit sur un appel de macro et sélectionnez Développer la macro pour inspecter le code généré directement dans le fichier.

// Before expansion:
let (v, s) = #stringify(1 + 2)
// After:
let (v, s) = (1 + 2, "1 + 2")

Déboguer avec print dans les macros

Utilisez context.diagnose ou print vers la sortie d’erreur pour déboguer la logique des macros pendant le développement.

// In macro implementation:
print("[StringifyMacro] expanding: \(node.description)", to: &standardError)

Points d’arrêt dans les tests de macros

Comme les macros s’exécutent dans le même processus pendant les tests, vous pouvez définir des points d’arrêt Xcode dans leurs implémentations pendant l’exécution des tests.

// Set a breakpoint in StringifyMacro.expansion()
// Run the test target — breakpoints are hit

Inspection de l’arbre syntaxique

Utilisez .debugDescription de SwiftSyntax pour afficher l’arbre syntaxique complet d’un nœud d’entrée à des fins de débogage.

print(node.debugDescription)
// Prints the full SyntaxTree hierarchy

Tester plusieurs variantes d’arguments

Écrivez un test pour chaque forme d’argument distincte afin de vous assurer que tous les chemins d’exécution de la macro sont parcourus.

func testNoArgument() {
  assertMacroExpansion(
    "#stringify()",
    expandedSource: "#stringify()",
    diagnostics: [DiagnosticSpec(message: "Need an argument", line: 1, column: 1)],
    macros: ["stringify": StringifyMacro.self]
  )
}

Tests d’intégration

Ajoutez une cible d’application de test qui utilise réellement la macro. Vérifiez la compilation et le comportement à l’exécution.

// In test app:
let (val, src) = #stringify(Date.now)
XCTAssertEqual(src, "Date.now")

CI pour les tests de macros

Exécutez les tests de macros en CI comme pour tout autre paquet Swift : swift test dans le répertoire du paquet.

// CI command:
swift test --package-path MyMacros

Vérification rapide

Quelle fonction vérifie qu’une macro se développe en code source attendu dans un test unitaire ?

Récapitulatif de la leçon

Testez les macros avec assertMacroExpansion pour vérifier la sortie correcte et avec DiagnosticSpec pour les cas d’erreur. Déboguez-les avec l’aperçu de l’expansion dans Xcode et des points d’arrêt dans le même processus pendant l’exécution des tests. Exécutez-les avec swift test en CI.

Gratuit pour commencer

Apprends Swift avec un tuteur IA — gratuit

Écris et exécute du vrai code dans ton navigateur, obtiens de l'aide instantanée d'un tuteur IA disponible 24h/24, et reprends là où tu t'es arrêté sur le web ou dans l'app.

Cours
122
Leçons
409

Questions Fréquemment Posées

La leçon « Tester et déboguer des macros » est-elle gratuite ?

Oui — le texte complet de « Tester et déboguer des macros » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Swift Academy, passe à CoddyKit PRO. Le cours Swift Academy comprend 4 leçons au total.

Qu'est-ce que j'apprendrai dans « Tester et déboguer des macros » ?

Écrire des tests unitaires pour les expansions de macros avec assertMacroExpansion. Tu pratiques Swift Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.

Dois-je avoir de l'expérience pour commencer Swift Academy ?

Aucune expérience préalable n'est requise. Swift Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 4 sur 4.

Combien de temps prend la leçon « Tester et déboguer des macros » ?

La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.

Peux-tu écrire et exécuter du code dans cette leçon Swift Academy ?

Oui. Chaque leçon Swift Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.

Toutes les leçons de ce cours

  1. Rôles des macros : autonomes ou attachées
  2. Écrire une macro d’expression autonome
  3. Macros attachées aux membres pour réduire le code répétitif
  4. Tester et déboguer des macros
← Retour à Swift Academy