verifyWarning

Класс: matlab.unittest.qualifications.Verifiable
Пакет: matlab.unittest.qualifications

Проверьте, что функция выдает заданное предупреждение

расширьте все на странице

Синтаксис

verifyWarning(testCase,actual,identifier)
verifyWarning(testCase,actual,identifier,diagnostic)
[output1,...,outputN] = verifyWarning(___)

Описание

пример

verifyWarning(testCase,actual,identifier) проверяет тот actual указатель на функцию, который выдает предупреждение, заданное identifier.

пример

verifyWarning(testCase,actual,identifier,diagnostic) также сопоставляет диагностическую информацию в diagnostic с проверкой.

пример

[output1,...,outputN] = verifyWarning(___) также возвращает любые выходные параметры, произведенные, когда указатель на функцию вызывается. Можно использовать любую из комбинаций входных аргументов в предыдущих синтаксисах.

Входные параметры

развернуть все

Объект теста в виде экземпляра matlab.unittest.qualifications.Verifiable класс. Поскольку matlab.unittest.TestCase класс разделяет на подклассы matlab.unittest.qualifications.Verifiable и наследовал его методы, testCase обычно matlab.unittest.TestCase экземпляр.

Значение, чтобы протестировать в виде значения любого типа данных. Несмотря на то, что можно ввести значение любого типа данных, тест перестал работать если actual не указатель на функцию.

Пример: @() myFunction(1,2)

Пример: @() mkdir("myFolder")

Предупреждая идентификатор в виде вектора символов, массива ячеек из символьных векторов или массива строк.

Пример: "MATLAB:MKDIR:DirectoryExists"

Пример: ["MyComponent:FirstID" "MyComponent:SecondID"]

Диагностическая информация, чтобы отобразиться, когда передачи проверки или сбои в виде массива строк, символьного массива, указателя на функцию или массива matlab.unittest.diagnostics.Diagnostic объекты.

В зависимости от настройки исполнителя тестов среда тестирования может отобразить диагностику когда передачи проверки или сбои. По умолчанию среда отображает диагностику только, когда проверка перестала работать. Можно заменить поведение по умолчанию путем настройки исполнителя тестов. Например, используйте DiagnosticsOutputPlugin экземпляр, чтобы отобразить и провальную и передающую диагностику события.

Пример: "My Custom Diagnostic"

Пример: @dir

Примеры

развернуть все

Скрипт Open Live Script

Проверьте что mkdir функция выдает заданное предупреждение, если она используется, чтобы создать папку, которая уже существует.

Этот пример принимает, что ваша текущая папка имеет подпапку под названием myFolder. Создайте подпапку, если она не существует.

if ~isfolder("myFolder")
    mkdir myFolder
end

При попытке создать myFolder снова, mkdir выдает предупреждение. Возвратите идентификатор предупреждения.

mkdir myFolder
Warning: Directory already exists.

[~,identifier] = lastwarn
identifier = 
'MATLAB:MKDIR:DirectoryExists'

Теперь создайте тест для интерактивного тестирования. Проверьте это если mkdir называется, чтобы создать существующую папку, она предупреждает, и предупреждение имеет идентификатор "MATLAB:MKDIR:DirectoryExists".

testCase = matlab.unittest.TestCase.forInteractiveUse;
verifyWarning(testCase,@() mkdir("myFolder"),"MATLAB:MKDIR:DirectoryExists")
Verification passed.
Открыть скрипт

Протестируйте, если фактическое значение является указателем на функцию, который выдает заданное предупреждение.

Создайте контрольный пример для интерактивного тестирования.

testCase = matlab.unittest.TestCase.forInteractiveUse;

Проверьте что warning функция выдает предупреждение с ожидаемым идентификатором.

verifyWarning(testCase,@() warning("SOME:warning:id","Warning!"), ...
    "SOME:warning:id")

Verification passed.

Повторите тест с "OTHER:warning:id" как ожидаемый идентификатор предупреждения. Тестовые сбои.

verifyWarning(testCase,@() warning("SOME:warning:id","Warning!"), ...
    "OTHER:warning:id","Warning identifiers must match.")

Warning: Warning! 
Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Warning identifiers must match.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyWarning failed.
    --> The function handle did not issue the expected warning(s).
        
        Actual Warning(s):
            --> 'SOME:warning:id'
        Expected Warning(s):
            --> 'OTHER:warning:id'
    
    Evaluated Function:
      function_handle with value:
    
        @()warning("SOME:warning:id","Warning!")
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForSpecifiedWarningsExample.m (TestForSpecifiedWarningsExample) at 21

Протестируйте rand функция, и также исследует выход функции. Тест перестал работать потому что rand не выдает предупреждений.

r = verifyWarning(testCase,@rand,"SOME:warning:id")

Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyWarning failed.
    --> The function handle did not issue any warnings.
        
        Expected Warning(s):
            --> 'SOME:warning:id'
    
    Evaluated Function:
      function_handle with value:
    
        @rand
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForSpecifiedWarningsExample.m (TestForSpecifiedWarningsExample) at 27

r =

    0.8147

Проверьте, что тест перестал работать, если фактическое значение не является указателем на функцию.

verifyWarning(testCase,5,"SOME:warning:id")

Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyWarning failed.
    --> The value must be an instance of the expected type.
        
        Actual Class:
            double
        Expected Type:
            function_handle
    
    Actual Value:
         5
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForSpecifiedWarningsExample.m (TestForSpecifiedWarningsExample) at 31

Советы

  • verifyWarning удобный метод. Например, verifyWarning(testCase,actual,identifier) функционально эквивалентно следующему коду.

    import matlab.unittest.constraints.IssuesWarnings
testCase.verifyThat(actual,IssuesWarnings(cellstr(identifier)))

    Больше функциональности доступно при использовании IssuesWarnings ограничение непосредственно через verifyThat.

  • Используйте проверку типа "verification" для создания и записи сбоев без выдачи исключения. Поскольку проверки не выдают исключения, все тесты выполняются до своего завершения, даже когда имеют место сбои в проверке. Как правило, проверки типа "verification" являются основой для модульного теста, поскольку они обычно не требуют раннего выхода из тестирования. Используйте другие типы проверки для выявления нарушений предварительных обязательных условий или неправильной настройки теста:

    • Используйте проверку типа "assumption", чтобы убедиться, что тестовая среда соответствует предварительным обязательным условиям, которые не приводят к ошибке тестирования. Нарушение условий приводит к фильтрации тестов, а среда тестирования помечает тесты как незавершенныеДля получения дополнительной информации см. matlab.unittest.qualifications. Assumable.

    • Используйте проверки типа утверждения, когда условие отказа будет делать недействительным остаток от текущего содержания теста, но не предотвратит соответствующее выполнение последующих тестов. Отказ в точке утверждения представляет текущий тест как Failed и IncompleteДля получения дополнительной информации см. matlab.unittest.qualifications. Assertable.

    • Используйте проверку типа "fatal assertion", чтобы прервать сеанс тестирования после сбоя. Эти проверки полезны, когда отказ является так основным, что продолжение тестирования не целесообразно. Проверки критического утверждения также полезны, когда отключение фиксатора не восстанавливает среду, правильно указывают, и прерывающий тестирование, и запуск новой сессии предпочтителен. Для получения дополнительной информации см. matlab.unittest.qualifications. FatalAssertable.

Смотрите также

| | | | |

Темы

Введенный в R2013a

Документация MATLAB

Поддержка

Для просмотра документации необходимо авторизоваться на сайте