matlab.unittest.fixtures. Класс PathFixture

Пакет: matlab.unittest.fixtures

Фиксатор для добавления папки к пути MATLAB

Описание

Класс PathFixture обеспечивает фиксатор для добавления папки к пути MATLAB®. Когда среда тестирования настраивает фиксатор, она добавляет заданную папку в путь. Когда среда тестирования разъединяет фиксатор, она восстанавливает путь MATLAB к своему предыдущему состоянию.

Конструкция

matlab.unittest.fixtures.PathFixture(folder) создает фиксатор для добавления папки к пути MATLAB. Когда среда тестирования настраивает фиксатор, она добавляет folder в путь. Когда это разъединяет фиксатор, это восстанавливает путь MATLAB к своему предыдущему состоянию.

matlab.unittest.fixtures.PathFixture(folder,Name,Value) создает фиксатор с дополнительными опциями, заданными одним или несколькими аргументами пары Name,Value. Например, matlab.unittest.fixtures.PathFixture('myFolder','IncludingSubfolders',true) создает фиксатор, который добавляет myFolder и любую из его подпапок к пути.

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

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

Папка, чтобы добавить к пути MATLAB, заданному как вектор символов. Если folder не существует, MATLAB выдает ошибку.

Аргументы в виде пар имя-значение

Укажите необязательные аргументы в виде пар ""имя, значение"", разделенных запятыми. Имя (Name) — это имя аргумента, а значение (Value) — соответствующее значение. Name должен появиться в кавычках. Вы можете задать несколько аргументов в виде пар имен и значений в любом порядке, например: Name1, Value1, ..., NameN, ValueN.

Установка, чтобы включать подпапки folder на пути, заданном как false или true (logical 0 или 1). Это значение является ложным по умолчанию. Если вы задаете его как верный, среда тестирования включает подпапки folder на пути. Пакет, класс и частные папки не добавляются к пути, даже когда этим свойством является true.

Местоположение где на пути, чтобы добавить папку, заданную как 'begin' или 'end'. Значением по умолчанию является 'begin', который добавляет folder в начинающийся (верхняя часть) пути.

Если вы используете эту опцию с IncludingSubfolders, фиксатор добавляет папку и ее подпапки к верхней части или нижней части пути как один блок с folder на верхней части.

Свойства

Folder

Папка, чтобы добавить к пути MATLAB, заданному как вектор символов во входном параметре folder.

IncludeSubfolders

Индикатор, чтобы включать подпапки folder на пути, заданном как false или true (logical 0 или 1). Это свойство доступно только для чтения. Это является ложным по умолчанию, но можно задать его как верный во время конструкции.

Position

Индикатор где на пути, чтобы добавить папку, заданную как 'begin' или 'end'. Это свойство доступно только для чтения. Это - 'begin' по умолчанию, но можно задать его как 'end' во время конструкции.

Примеры

свернуть все

Создайте следующее определение класса addPathFixtureTest на своем пути MATLAB. Этот пример принимает, что подпапка, helperFiles, существует в вашей рабочей папке. Если это не делает, задает addFolder, чтобы быть папкой, которая существует в вашей текущей папке.

classdef addPathFixtureTest < matlab.unittest.TestCase
    methods(Test)
        function test1(testCase)
            import matlab.unittest.fixtures.PathFixture
            
            addFolder = 'helperFiles';
            f = testCase.applyFixture(PathFixture(addFolder));
            disp(['Added to path: ' f.Folder])
        end
    end
end

В командной строке, запущенной тест.

run(addPathFixtureTest);
Running addPathFixtureTest
Added to path: H:\Documents\doc_examples\helperFiles
.
Done addPathFixtureTest
__________

После того, как тесты закончили запускаться, среда удаляет папку из пути.

Создайте следующее определение класса sharedAddPathFixtureTest на своем пути MATLAB. Этот пример принимает, что подпапка, helperFiles, существует в вашей рабочей папке.

classdef (SharedTestFixtures={ ...
        matlab.unittest.fixtures.PathFixture('helperFiles')}) ...
        sharedAddPathFixtureTest < matlab.unittest.TestCase
    methods(Test)
        function test1(testCase)
            f = testCase.getSharedTestFixtures;
            disp(['Added to path: ' f.Folder])
        end
    end
end

В командной строке, запущенной тест.

run(sharedAddPathFixtureTest);
Setting up PathFixture
Done setting up PathFixture: Added 'H:\Documents\doc_examples\helperFiles' to the path.
__________

Running sharedAddPathFixtureTest
Added to path: H:\Documents\doc_examples\helperFiles
.
Done sharedAddPathFixtureTest
__________

Tearing down PathFixture
Done tearing down PathFixture: Restored the path to its original state.
__________

После того, как тесты закончили запускаться, среда удаляет папку из пути.

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