MSTEST0009: metoda TestCleanup powinna mieć prawidłowy układ

Właściwość Wartość
Identyfikator reguły MSTEST0009
Tytuł Metoda TestCleanup powinna mieć prawidłowy układ
Kategoria Użycie
Poprawka powodująca niezgodność lub niezgodność Nierozdzielający
Domyślnie włączone Tak
Domyślny poziom ważności Ostrzeżenie
Wprowadzone w wersji 3.3.0
czy istnieje poprawka kodu Tak

Przyczyna

Metoda oznaczona elementem [TestCleanup] powinna mieć prawidłowy układ.

Opis reguły

Narzędzie MSTest wywołuje [TestCleanup] wystąpienie klasy testowej po metodzie testowej. Funkcja callback zwalnia lub przywraca stan testu:

Requirement Powód
Metoda jest public. Metody publiczne stanowią kontrakt wykrywania cyklu życia MSTest. [DiscoverInternals] zezwala na wewnętrzną klasę deklarującą, a nie wewnętrzną metodę cyklu życia.
Metoda nie jest static. Oczyszczanie wymaga dostępu do pól instancji i TestContext testu, który właśnie został uruchomiony.
Metoda jest zwykła i nie abstractjest . Narzędzie MSTest wymaga treści metody, którą można wywołać, a nie specjalnej składowej z regułami wywołania zdefiniowanymi w języku.
Metoda nie jest generyczna. Wywołania zwrotne cyklu życia nie otrzymują argumentów danych testowych, na podstawie których biblioteka MSTest może wywnioskować argumenty typu metody.
Metoda nie ma parametrów. Narzędzie MSTest wywołuje tę funkcję wywołania zwrotnego bez argumentów. Użyj wystąpienia TestContext dla informacji dla każdego testu.
Zwracany typ to void, Tasklub ValueTask. Wartość zwracana, którą można awaitować, umożliwia narzędziu MSTest zakończenie czyszczenia asynchronicznego przed kontynuowaniem pozostałych kroków cyklu życia.
Metoda nie jest async void. Bez wyniku, na który można oczekiwać, oczyszczanie może przetrwać cykl życia testu, a późniejsze wyjątki nie mogą być niezawodnie rejestrowane jako błędy oczyszczania.

Typ deklarujący dostarcza fiksturę testową, która jest właścicielem tych wywołań zwrotnych:

  • Użyj atrybutu class, aby narzędzie MSTest mogło skojarzyć wywołania zwrotne z hierarchią klas testowych.
  • Użyj klasy public lub klasy internal z elementem [assembly: DiscoverInternals], aby spełnić kontrakt wykrywania typów MSTest.
  • Dla tych fikstur należy użyć klasy niestacjonarnej. Metody testowe wymagają wystąpienia klasy testowej, nawet jeśli wywołanie zwrotne cyklu życia na poziomie klasy jest statyczne.
  • Oznacz zapieczętowaną klasę za pomocą [TestClass] lub atrybutu pochodnego. Klasa sealed nie może dostarczyć odziedziczonych wywołań zwrotnych do innej klasy testowej, dlatego musi identyfikować się jako kontener testowy.

Jak naprawić naruszenia

Upewnij się, że metoda jest zgodna z układem opisanym powyżej.

Kiedy pomijać ostrzeżenia

Nie wyłączaj ostrzeżenia z tej reguły. Jeśli zignorujesz tę regułę, oflagowane wystąpienia zostaną pominięte lub spowodują błąd środowiska uruchomieniowego.

Pomijanie ostrzeżenia

Jeśli chcesz po prostu pominąć pojedyncze naruszenie, dodaj dyrektywy preprocesora do pliku źródłowego, aby wyłączyć, a następnie ponownie włączyć regułę.

#pragma warning disable MSTEST0009
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0009

Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji .

[*.{cs,vb}]
dotnet_diagnostic.MSTEST0009.severity = none

Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia analizy kodu.