Notatka
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
| Właściwość | Wartość |
|---|---|
| Identyfikator reguły | MSTEST0011 |
| Tytuł | Metoda ClassCleanup powinna mieć prawidłowy układ |
| Kategoria | Sposób użycia |
| Poprawka krytyczna lub niekrytyczna | Niedzielą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 [ClassCleanup] powinna mieć prawidłowy układ.
Opis reguły
MSTest wywołuje [ClassCleanup], aby zwolnić zasoby udostępnione przez klasę testową, a nie zasoby należące do jednego wystąpienia klasy testowej:
| Requirement | Powód |
|---|---|
Metoda jest public. |
Metody publiczne stanowią kontrakt odnajdywania cyklu życia MSTest.
[DiscoverInternals] zezwala na wewnętrzną klasę deklarującą, a nie wewnętrzną metodę cyklu życia. |
Metoda jest static. |
Oczyszczanie klasy należy do współużytkowanego cyklu życia klasy i nie może zależeć od określonego wystąpienia testowego. |
Metoda jest zwykła i nie jest abstract ani generyczna. |
Biblioteka MSTest wymaga treści metody, którą może wywołać bez specjalnych reguł wywołania lub argumentów typu metody. |
Metoda nie ma parametrów lub jednego parametru TestContext w programie MSTest 3.8 lub nowszym. |
Narzędzie MSTest może wywołać czyszczenie bez argumentów lub podać kontekst czyszczenia klasy. Nie dostarcza on argumentów o dowolnej wartości ani wiersza danych testu. |
Zwracany typ to void, Task lub ValueTask, a metoda nie jest async void. |
Narzędzie MSTest musi czekać na czyszczenie asynchroniczne i śledzić jego błędy, zamiast pozostawiać zwalnianie zasobów nieobserwowanej operacji. |
Abstrakcyjna lub generyczna klasa deklarująca określa InheritanceBehavior.BeforeEachDerivedClass. |
Ustawienie dziedziczenia kojarzy czyszczenie klasy bazowej z konkretnymi klasami pochodnymi, które używają jej zasobów. |
Klasa deklarująca sealed nie określa wartości InheritanceBehavior.BeforeEachDerivedClass. |
Klasa hermetyzowana nie może mieć klas pochodnych, więc nie ma do czego zastosować tego ustawienia dziedziczenia. |
Typ deklarujący dostarcza fixturę testową, która jest właścicielem tych wywołań zwrotnych:
- Użyj
class, aby narzędzie MSTest mogło skojarzyć wywołania zwrotne z hierarchią klas testowych. - Użyj klasy
publiclub klasyinternalz[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 klasę zapieczętowaną za pomocą
[TestClass]lub atrybutu pochodnego. Klasa sealed nie może przekazywać dziedziczonych callbacków 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 MSTEST0011
// The code that's violating the rule is on this line.
#pragma warning restore MSTEST0011
Aby wyłączyć regułę dla pliku, folderu lub projektu, ustaw jego ważność na none w pliku konfiguracji .
[*.{cs,vb}]
dotnet_diagnostic.MSTEST0011.severity = none
Aby uzyskać więcej informacji, zobacz Jak pominąć ostrzeżenia analizy kodu.