Erreur Scopelint : utilisation d'une variable sur la portée de la plage

Dans une fonction de test TestGetUID, le code rencontre une erreur signalée par scopelint, qui met en garde contre en utilisant la variable x de la portée de la plage dans les littéraux de fonction.

Considérez les lignes de code suivantes :

for _, x := range tests {
    t.Run(x.description, func(t *testing.T) {
        client := fake.NewSimpleClientset(x.objs...)
        actual := getUID(client, x.namespace)
        assert.Equal(t, x.expected, actual)
    })
}

L'erreur concerne ces lignes car x est la variable de boucle dans la boucle de plage itérant sur la tranche de tests. Scopelint détecte que x est utilisé dans les littéraux de fonction transmis à t.Run(), ce qui pourrait entraîner des problèmes potentiels si les littéraux de fonction sont invoqués après le retour de t.Run().

Cause et Meilleures pratiques

Le problème survient car le compilateur ne peut pas garantir que les littéraux de fonction créés et transmis à t.Run() ne seront pas appelés après t.Run() se termine. Si les littéraux de fonction étaient appelés après le retour de t.Run(), ils feraient référence à la variable x, qui aurait pu être écrasée par la valeur de l'itération suivante de la boucle.

Go vet émet cet avertissement pour empêcher un tel comportement involontaire, qui peut entraîner des bugs ou même des courses de données si les littéraux de fonction sont exécutés simultanément dans différentes goroutines.

La meilleure pratique recommandée dans de tels cas est de passer le valeur de la variable de boucle au littéral de fonction comme argument ou pour créer une copie de la variable de boucle et faire référence à la copie dans le littéral de fonction. La signature du littéral de fonction ne pouvant pas être modifiée, la solution recommandée est de créer une copie, par exemple :

x2 := x

Après avoir déclaré cette copie, l'identifiant x dans le le littéral de fonction fera référence à la copie locale, pas à la variable de boucle. Bien qu'attribuer le même nom à la copie puisse sembler déroutant, cela indique clairement l'intention d'utiliser une copie.