Język

MSTEST0005: Właściwość kontekstu testowego powinna mieć prawidłowy układ

Właściwość Wartość
Identyfikator reguły MSTEST0005
Tytuł Właściwość kontekstu testu powinna mieć prawidłowy układ
Kategoria Użycie
Poprawka powodująca zmiany niekompatybilne lub niepowodująca takich zmian Niedzielący
Domyślnie włączone Tak
Domyślny poziom ważności Ostrzeżenie
Wprowadzone w wersji 3.2.0
czy istnieje poprawka kodu Tak

Przyczyna

Właściwość TestContext jest statyczna, nie kwalifikuje się do automatycznego wstrzyknięcia lub nie jest przypisywana za pośrednictwem obsługiwanego konstruktora.

Opis reguły

W przypadku automatycznego wstrzykiwania właściwości narzędzie MSTest lokalizuje właściwość TestContext według nazwy i przypisuje ją po uruchomieniu konstruktora klasy testowej, przed inicjalizacją każdego testu. Wymagania dotyczące właściwości wynikają z tego przypisania:

Requirement Powód
Użyj właściwości, a nie pola. Automatyczne wstrzykiwanie MSTest lokalizuje właściwość. Nie przypisuje pola o tej samej nazwie.
Nadaj właściwości nazwę TestContext, z zachowaniem dokładnie tej wielkości liter. Wyszukiwanie w czasie wykonywania używa tej nazwy z uwzględnieniem wielkości liter, zamiast wyszukiwać dowolny element członkowski, którego typem jest TestContext.
Zadeklaruj publiczną, czytelną właściwość typu TestContext. Narzędzie MSTest wyszukuje właściwość publiczną i dostarcza obiekt TestContext. [DiscoverInternals] nie łagodzi tego wymagania dotyczącego wstrzykiwania właściwości.
Użyj właściwości wystąpienia, a nie właściwości statycznej. Każde wykonanie testu otrzymuje własny kontekst. Właściwość statyczna współużytkuje jeden kontekst między testami, również uruchamianymi współbieżnie.
Dodaj setter; może być prywatny. Narzędzie MSTest musi przypisać kontekst po utworzeniu. Właściwość tylko do odczytu nie może mieć automatycznie wstrzykniętej wartości.

Począwszy od MSTest 3.6, klasa testowa może zamiast tego odbierać TestContext za pomocą konstruktora. Jeśli przypiszesz ten parametr do pola lub właściwości samodzielnie, do tego przypisania nie mają zastosowania wymagania dotyczące automatycznego wstrzykiwania właściwości. Wstrzykiwanie przez konstruktor umożliwia również użycie pola readonly lub właściwości tylko do odczytu. Zobacz Uzyskiwanie dostępu do obiektu TestContext.

Jak naprawić naruszenia

Upewnij się, że właściwość TestContext jest zgodna z wymaganym układem opisanym powyżej.

Kiedy pomijać ostrzeżenia

Nie wyciszaj ostrzeżenia generowanego przez tę regułę. Zignorowanie tej reguły spowoduje, że składnik TestContext nie zostanie wstrzyknięty przez MSTest, co doprowadzi do NullReferenceException lub niespójnego stanu podczas korzystania z właściwości.

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

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

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

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