verifyError

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

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

Описание

пример

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

пример

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

пример

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

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

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

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

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

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

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

Ошибочный идентификатор в виде строкового скаляра, вектора символов или meta.class экземпляр.

Если identifier meta.class экземпляр, затем вызванная исключительная ситуация должна быть экземпляром заданного класса или одним из его подклассов.

Пример: "MATLAB:UndefinedFunction"

Пример: ?MException

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

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

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

Пример: @dir

Примеры

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

Используйте verifyError протестировать, если функция правильно реагирует на недопустимые входные параметры.

В файле в вашей текущей папке создайте add5 функция. Функция принимает числовой вход и постепенно увеличивает его пять. Если названо нечисловым входом, функция выдает исключение, заданное "add5:InputMustBeNumeric".

function y = add5(x)
% add5 - Increment input by 5
if ~isa(x,"numeric")
    error("add5:InputMustBeNumeric","Input must be numeric.")
end
y = x + 5;
end

Создайте тест для интерактивного тестирования, и затем проверьте тот add5 выдает заданное исключение, если оно вызвано входом '0'.

testCase = matlab.unittest.TestCase.forInteractiveUse;
verifyError(testCase,@() add5('0'),"add5:InputMustBeNumeric")
Verification passed.

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

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

testCase = matlab.unittest.TestCase.forInteractiveUse;

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

verifyError(testCase,@() error("SOME:error:id","Error!"),"SOME:error:id")
Verification passed.

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

verifyError(testCase,@() error("SOME:error:id","Error!"), ...
    "OTHER:error:id","Error identifiers must match.")
Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Error identifiers must match.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyError failed.
    --> The function threw the wrong exception.
        
        Actual Exception:
            'SOME:error:id'
        Expected Exception:
            'OTHER:error:id'
    --> Actual Error Report:
            Error using
            VerifyErrorTestForSpecifiedExceptionsExample>@()error("SOME:error:id","Error!")
            (line 20)
            Error!
    
    Evaluated Function:
      function_handle with value:
    
        @()error("SOME:error:id","Error!")
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForSpecifiedExceptionsExample.m (TestForSpecifiedExceptionsExample) at 20

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

r = verifyError(testCase,@rand,?MException)
Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyError failed.
    --> The function did not throw any exception.
        
        Expected Exception:
            ?MException
    
    Evaluated Function:
      function_handle with value:
    
        @rand
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestForSpecifiedExceptionsExample.m (TestForSpecifiedExceptionsExample) at 26

r =

    0.8147

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

verifyError(testCase,5,?MException)
Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyError 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\TestForSpecifiedExceptionsExample.m (TestForSpecifiedExceptionsExample) at 30

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

В файле в вашей текущей папке создайте variableNumArguments функция, которая принимает переменное количество вводов и выводов. Если количество выходных параметров больше количества входных параметров, функция выдает исключение. В противном случае это возвращает класс входных параметров.

function varargout = variableNumArguments(varargin)
if nargout > nargin
    error("variableNumArguments:TooManyOutputs", ...
        "Number of outputs must not exceed the number of inputs.")
end
varargout = cell(1,nargout);
for i = 1:nargout
    varargout{i} = class(varargin{i});
end
end

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

testCase = matlab.unittest.TestCase.forInteractiveUse;
[c1,c2] = verifyError(testCase,@() variableNumArguments(1,'2'), ...
    "variableNumArguments:TooManyOutputs")
Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyError failed.
    --> The function did not throw any exception.
        
        Expected Exception:
            'variableNumArguments:TooManyOutputs'
    
    Evaluated Function:
      function_handle with value:
    
        @()variableNumArguments(1,'2')
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestFunctionWithVariableNumberOfInputsAndOutputsExample.m (TestFunctionWithVariableNumberOfInputsAndOutputsExample) at 22

c1 =

    'double'


c2 =

    'char'

Проверьте это если variableNumArguments вызван слишком многими выходными параметрами, это выдает исключение с идентификатором "variableNumArguments:TooManyOutputs".

[c1,c2,c3] = verifyError(testCase,@() variableNumArguments(1,'2'), ...
    "variableNumArguments:TooManyOutputs")
Verification passed.

c1 = 

  missing

    <missing>


c2 = 

  missing

    <missing>


c3 = 

  missing

    <missing>

Советы

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

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

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

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

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

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

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

Введенный в R2013a