MSTEST0008: Metoda TestInitialize powinna mieć prawidłowy układ

Właściwość Wartość
Identyfikator reguły MSTEST0008
Tytuł Metoda TestInitialize powinna mieć prawidłowy układ
Kategoria Użycie
Poprawka wprowadzająca zmiany niekompatybilne lub niewprowadzająca takich zmian Niełamią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 [TestInitialize] powinna mieć prawidłowy układ.

Opis reguły

Narzędzie MSTest wywołuje [TestInitialize] na wystąpieniu klasy testowej, zanim wywoła metodę testową. Funkcja callback przygotowuje stan tego testu:

Requirement Powód
Metoda to 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. Inicjowanie wymaga dostępu do tych samych pól wystąpienia i TestContext co metoda testowa.
Metoda jest zwykła i nie jest abstract. Narzędzie MSTest wymaga ciała metody, które 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 mogłaby wywnioskować argumenty typu metody.
Metoda nie ma parametrów. Narzędzie MSTest wywołuje tę funkcję wywołania zwrotnego bez argumentów. Użyj TestContext instancji, aby uzyskać informacje dla każdego testu.
Zwracany typ to void, Tasklub ValueTask. Wartość zwracana, którą można awaitować, umożliwia narzędziu MSTest ukończenie konfiguracji asynchronicznej przed rozpoczęciem testu.
Metoda nie jest async void. Bez oczekiwanego wyniku konfiguracja może być kontynuowana po rozpoczęciu testu, a późniejsze wyjątki nie mogą być niezawodnie rejestrowane jako błędy inicjowania.

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

  • Użyj znacznika class, aby narzędzie MSTest mogło skojarzyć wywołania zwrotne z hierarchią klas testowych.
  • Użyj klasy public lub klasy internal z [assembly: DiscoverInternals], aby spełnić kontrakt odnajdywania typów MSTest.
  • Dla tych fixtur należy użyć klasy niestatycznej. Metody testowe wymagają instancji 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 zostać oznaczona jako kontener testowy.

Jak naprawić naruszenia

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

Kiedy pomijać ostrzeżenia

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

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 MSTEST0008
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0008

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

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

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