matlab.unittest.qualifications.Assertable class

Пакет: matlab.unittest.qualifications

Квалификация для проверки предусловий теста

Описание

The Assertable класс предоставляет проверку типа «» qualification «» для проверки предусловий теста. Помимо действий, выполненных для отказов, Assertable класс работает так же, как и другие matlab.unittest проверки.

После отказа утверждения Assertable класс выдает AssertionFailedException информировать среду тестирования о отказе. Это наиболее полезно, когда отказ в точке утверждения делает остальную часть текущего метода тестирования недействительной, но не препятствует правильному выполнению других методов тестирования. Часто вы используете утверждения, чтобы убедиться, что предусловия текущего теста не нарушены или что фиксаторы настроены правильно. Убедитесь, что содержание теста Устойчивости к исключениям. Если вы не можете сделать исключение отключения фиксатора безопасным или если вы не можете восстановить его после отказа, используйте вместо этого критические утверждения.

Используйте утверждения, чтобы позволить оставшимся методам тестирования получать покрытие, когда предусловия нарушаются в тесте, и все состояния фиксатора восстанавливаются. Утверждения также снижают уровень шума отказов, не выполняя более поздние верификации, которые не выполняются из-за сбоев предусловия. Однако в случае отказа среда тестирования помечает полное содержимое метода тестирования, который не прошел, как неполное. Поэтому, если отказ не влияет на предусловия теста или вызывает проблемы с настройкой фиксатора или отключением, используйте верификации, которые дают добавленную информацию о том, что был запускаемо полное содержание теста.

Методы

assertClass	Задайте точный класс заданного значения
assertEmpty	Значение assert пусто
assertEqual	Значение assert равно заданному значению
assertError	Функция Assert выдает указанное исключение
assertFail	Создайте безусловный отказ утверждения
assertFalse	Значение assert равно false
assertGreaterThan	Значение assert больше заданного значения
assertGreaterThanOrEqual	Значение assert больше или равно заданному значению
assertInstanceOf	Значение Assert является объектом заданного типа
assertLength	Значение assert имеет указанную длину
assertLessThan	Значение assert меньше заданного значения
assertLessThanOrEqual	Значение assert меньше или равно заданному значению
assertMatches	Строка Assert соответствует указанному регулярному выражению
assertNotEmpty	Значение assert не пустое
assertNotEqual	Значение assert не равно заданному значению
assertNotSameHandle	Значение assert не является указанным образцом.
assertNumElements	Значение assert имеет заданное количество элементов
assertReturnsTrue	Функция Assert возвращает true при оценке
assertSameHandle	Предположим, что два значения являются указателями на один и тот же образец
assertSize	Значение assert имеет заданный размер
assertSubstring	Строка Assert содержит указанную строку
assertThat	Предположим, что значение соответствует заданному ограничению
assertTrue	Значение Assert равно true
assertWarning	Функция Assert выдает указанные предупреждения
assertWarningFree	Функция Assert не выдает предупреждений

События

`AssertionFailed`	Срабатывает после сбоя в утверждении. A `QualificationEventData` объект передается в функции обратного вызова прослушивателя.
`AssertionPassed`	Срабатывает при прохождении проверки. A `QualificationEventData` объект передается в функции обратного вызова прослушивателя.

Копировать семантику

Указатель. Чтобы узнать, как классы handle влияют на операции копирования, см. раздел «Копирование объектов».

Примеры

свернуть все

Тест на предусловия с использованием утверждений

Используйте assertable проверок для тестирования на предусловия. Этот пример создаст тест для записи полинома в MAT-файл.

Создание DocPolynomSaveLoadTest Тест. См. следующую DocPolynomSaveLoadTest тест на последующих шагах в этом примере. Шаги подсвечивают конкретный код в testSaveLoad функция; операторы кода не предназначены для выполнения вне контекста файла определения класса.

Файл определения класса DocPolynomSaveLoadTest

classdef DocPolynomSaveLoadTest < matlab.unittest.TestCase 
    
    methods (TestClassSetup) 
        function addDocPolynomClassToPath(testCase) 
            origPath = path; 
            testCase.addTeardown(@path, origPath); 
            addpath(fullfile(matlabroot, ... 
                'help', 'techdoc', 'matlab_oop', 'examples')); 
        end 
    end 
     
    methods (Test) 
        function testSaveLoad(testCase) 
             
            import matlab.unittest.diagnostics.Diagnostic; 
             
            %% Phase 1: Setup 
            % Create a temporary working folder 
            tempFolder = tempname; 
            [success, message] = mkdir(tempFolder); 
            testCase.assertTrue(success, ... 
                Diagnostic.join('Could not create temporary folder.',... 
                message)); 
            testCase.addTeardown(@() testCase.cleanUpTemporaryFolder(...
                tempFolder)); 
             
            % Change to the temporay folder and register the 
            % teardown, which restores the original folder 
            origFolder = pwd; 
            testCase.addTeardown(@cd, origFolder); 
            cd(tempFolder); 
             
            %% Phase 2: Exercise 
            % Save the instance to a mat file. 
            p = DocPolynom([1, 0, 1]); 
            save('DocPolynomFile', 'p'); 
             
            % Validate Precondition. Save resulted in valid .mat file 
            testCase.assertEqual(exist('DocPolynomFile.mat','file'),... 
                2, Diagnostic.join(...
                'mat file was not saved correctly.',@() dir(pwd))); 
             
            loaded = load('DocPolynomFile'); 
             
             
            %% Phase 3: Verify             
            testCase.verifyEqual(loaded.p, p,...
                'Loaded polynom did not equal original polynom.');
             
             
            %% Phase 4: Teardown 
            % Done inline via calls to addTeardown at the points
            % at which the state was changed. 

             
        end 
    end 
     
    methods(Access=private) 
        function cleanUpTemporaryFolder(testCase,tempFolder)
            % Clean up the temporary folder and fatally assert
            % that it was correctly cleaned up.
             
            import matlab.unittest.diagnostics.Diagnostic; 
             
            [success, message] = rmdir(tempFolder, 's'); 
            testCase.fatalAssertTrue(success, ... 
                Diagnostic.join('Could not remove temporary folder.',... 
                message)); 
        end 
    end 
             
end

Выполнение MATLAB^® команды в «Run DocPolynomSaveLoadTest Test Case», добавить DocPolynomSaveLoadTest.m файл в папку по пути MATLAB.

The testSaveLoad функция состоит из следующих фаз:

Фаза 1: Setup - Создайте и проверьте код предусловия.
Фаза 2: Упражнение - Создание DocPolynom и сохраните его в MAT-файл.
Фаза 3: Проверьте - Протестируйте, что объект успешно сохранен.
Фаза 4: Отключение - Выполните код teardown.

Определите предусловие фазы 1. Для этого теста используйте временную папку для создания DocPolynom объект. Предусловием продолжения этого теста является успешное выполнение следующих команд.

tempFolder = tempname; 
[success, message] = mkdir(tempFolder);

Протестируйте результаты mkdir функция. Используйте assertTrue метод для тестирования mkdir success аргумент для ошибок. Если утверждение происходит, остальная часть testSaveLoad метод тестирования недопустим, и тест помечен Incomplete.

testCase.assertTrue(success, ... 
    Diagnostic.join('Could not create the temporary folder.', ... 
        message))

Если mkdir функция прекращает работать, MATLAB отображает диагностическое сообщение, Could not create the temporary folder, а также содержимое mkdir message аргумент.

Добавьте код фиксатора для отключения. Создание временной папки - это код настройки, который требует соответствующего вызова rmdir функция для восстановления MATLAB в исходном состоянии. Используйте addTeardown метод, чтобы гарантировать выполнение кода отключения, даже когда исключение выдается в середине тестового метода. Это делает тестовую устойчивость к исключениям.

testCase.addTeardown(@() testCase.cleanUpTemporaryFolder(tempFolder))

Поместите код отключения в вспомогательную функцию. Хотя и addTeardown оператор происходит в том же кодовом блоке, что и оператор mkdir оператор настройки, cleanUpTemporaryFolder выполняют код в фазе 4 тестового метода.

В DocPolynomSaveLoadTest тест, вспомогательная функция, cleanUpTemporaryFolder, выполняет rmdir функция.

Определите предусловие для создания допустимого MAT-файла. Предварительное предусловие для проверки того, что DocPolynom объект был правильно сохранен и загружен, что MAT-файл, DocPolynomFile.mat, успешно создан. Следующий код в Phase 2: Exercise блок проверяет это условие. Если утверждение происходит, остальная часть testSaveLoad метод тестирования недопустим, и тест помечен Failed и Incomplete.

 testCase.assertEqual(exist('DocPolynomFile.mat','file'), 2, ... 
     Diagnostic.join('The mat file was not saved correctly.', ...
     @() dir(pwd)))

Если файл не был создан, MATLAB отображает диагностическое сообщение, The mat file was not saved correctly, а также содержимое временной папки.

Выполняйте DocPolynomSaveLoadTest Тест.

tc = DocPolynomSaveLoadTest;
run(tc);

Running DocPolynomSaveLoadTest
.
Done DocPolynomSaveLoadTest
__________

Подробнее о

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

Устойчивость к исключениям

Содержание теста exception safe, когда все фиксатором разрывы выполняются с addTeardown или через соответствующие деструкторы объектов, когда происходит отказ. Это гарантирует, что отказ не влияет на последующую проверку из-за устаревших фиксаторов.

Этот код не является безопасным исключением. После отказа утверждения среда тестирования не закрывает рисунок.

% Not exception safe
f = figure;
testCase.assertEqual(actual, expected);
close(f);

Этот код безопасен, потому что среда тестирования закрывает рисунок во всех случаях.

% Exception safe
f = figure;
testCase.addTeardown(@close, f);
testCase.assertEqual(actual, expected);

Однако срыв фиксатора с помощью addTeardown не гарантирует, что код безопасен для исключений. Этот код показывает отказ в assertEqual.

% Not exception safe
f = figure;
testCase.assertEqual(actual, expected);
testCase.addTeardown(@close, f);

См. также

Темы

Таблица верификаций, утверждений и других квалификаций

Введенный в R2013a

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