matlab.unittest.qualifications.Assertable class

Пакет: matlab.unittest.qualifications

Проверка, чтобы подтвердить предусловия теста

Описание

Assertable класс обеспечивает проверку, чтобы подтвердить предусловия теста. Кроме действий, выполняемых для отказов, Assertable класс работает то же самое другим matlab.unittest проверки.

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

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

Методы

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

События

`AssertionFailed`	Инициированный на провальное утверждение. `QualificationEventData` объект передается функциям обратного вызова прослушивателя.
`AssertionPassed`	Инициированный на передающее утверждение. `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^® в “Запущенном Тесте DocPolynomSaveLoadTest”, добавляют DocPolynomSaveLoadTest.m файл к папке на вашем пути MATLAB.

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

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

Предусловие фазы Define 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);

Темы

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

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