MSTEST0081: "[TestFilterProvider]" powinien odwoływać się do prawidłowego typu filtru testowego

Property Value
Identyfikator reguły MSTEST0081
Tytuł "[TestFilterProvider]" powinien odwoływać się do prawidłowego typu filtru testowego
Kategoria Usage
Poprawka jest przełomowa lub nieprzełomowa Non-breaking
Domyślnie włączone Tak
domyślna ciężkość Warning
wprowadzone w wersji 4.4.0
Czy istnieje poprawka kodu Nie

Przyczyna

[assembly: TestFilterProvider(typeof(MyFilter))] odwołuje się do typu, który nie spełnia wymagań narzucanych przez adapter w czasie wykonywania, lub w zestawie zarejestrowano więcej niż jednego dostawcę filtru testów.

Opis reguły

[assembly: TestFilterProvider(typeof(MyFilter))] przekazuje typ filtru jako Type, więc kompilator akceptuje dowolny typ. Adapter weryfikuje typ tylko wtedy, gdy zmaterializuje filtr, a następnie kończy się niepowodzeniem całego uruchomienia. Ten analizator zgłasza te same problemy na etapie kompilacji, kiedy ich naprawa jest tania. Typ, do którego się odwołano, musi:

  • Nie bądź ogólnikowy.
  • Musi dać się utworzyć jego wystąpienie, więc nie może być typem abstrakcyjnym, statycznym, interfejsem ani typem podobnym do byref.
  • Zaimplementuj ITestFilter.
  • Zadeklaruj publiczny konstruktor bez parametrów (każda struktura już to spełnia).

Dla jednego zestawu testów można zarejestrować co najwyżej jednego dostawcę filtru testów, a przekazanie jawnie określonego typu filtru null również powoduje niepowodzenie. W przypadku platformy docelowej .NET postać generyczna [assembly: TestFilterProvider<MyFilter>] wymusza spełnienie wymagań dotyczących interfejsu i konstruktora za pomocą ograniczeń generycznych, więc nadal mają do niej zastosowanie tylko sprawdzenia typu generycznego oraz sprawdzenie „co najwyżej jednego dostawcy”.

[assembly: TestFilterProvider(typeof(MyFilter))]
public sealed class MyFilter : ITestFilter
{
    public MyFilter(string mode) { } // Violation: no public parameterless constructor
    public TestFilterResult Filter(TestFilterContext context) => TestFilterResult.Run;
}

Jak naprawić naruszenia

Dodaj publiczny konstruktor bezparametrowy lub w inny sposób dostosuj typ tak, aby nie był generyczny, można go było utworzyć, implementował ITestFilter i miał publiczny konstruktor bezparametrowy.

public sealed class MyFilter : ITestFilter
{
    public TestFilterResult Filter(TestFilterContext context) => TestFilterResult.Run;
}

Kiedy pomijać ostrzeżenia

Nie ignoruj ostrzeżeń z tej zasady. Naruszenie powoduje niepowodzenie całego przebiegu testowego w czasie działania, a nie tylko samego filtru.

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

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

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

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

Zobacz także