Skip to content

Fix CreateTestReport=false still generating test reports #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mukeshangrakh wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix CreateTestReport=false still generating test reports #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions tests/tExamplesTester.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,43 @@ function nonStringTestFolders(testCase)
expectedError = "examplesTester:NonStringTestFolder";
testCase.verifyError(@()examplesTester(23), expectedError);
end

function verifyNoReportWhenCreateTestReportFalse(testCase)
% Test verifies that no test report folder is created when
% CreateTestReport is set to false

import matlab.unittest.fixtures.TemporaryFolderFixture
testCase.applyFixture(TemporaryFolderFixture);

outputPath = testCase.createTemporaryFolder;

obj = examplesTester("examples", CreateTestReport=false, ...
OutputPath=outputPath);
obj.executeTests();

testReportFolder = fullfile(outputPath, 'test-report');
testCase.verifyEqual(exist(testReportFolder, "dir"), 0, ...
"Test report folder should not be created when CreateTestReport is false");
testCase.verifyTrue(all([obj.TestResults.Passed]), 'All tests did not pass');
end

function verifyNoOutputDirWhenNoReportsNeeded(testCase)
% Test verifies that the output directory is not created when
% CreateTestReport is false and no CodeCoveragePlugin is provided

import matlab.unittest.fixtures.TemporaryFolderFixture
testCase.applyFixture(TemporaryFolderFixture);

outputPath = fullfile(testCase.createTemporaryFolder, 'should-not-exist');

obj = examplesTester("examples", CreateTestReport=false, ...
OutputPath=outputPath);
obj.executeTests();

testCase.verifyEqual(exist(outputPath, "dir"), 0, ...
"Output directory should not be created when no reports are needed");
testCase.verifyTrue(all([obj.TestResults.Passed]), 'All tests did not pass');
end
end

end
82 changes: 44 additions & 38 deletions toolbox/examplesTester.m
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,62 +135,68 @@ function initializeTestRunner(obj)
% Diagnostic record plugin enables logging in the tests
obj.Runner.addPlugin(DiagnosticsRecordingPlugin);

if ~exist(obj.OutputPath, "dir")
mkdir(obj.OutputPath);
% Create output directory if reports are needed
if obj.CreateTestReport || ~isempty(obj.CodeCoveragePlugin)
if ~exist(obj.OutputPath, "dir")
mkdir(obj.OutputPath);
end
end

% Add code coverage plugin
if ~isempty(obj.CodeCoveragePlugin)
obj.Runner.addPlugin(obj.CodeCoveragePlugin)
end

% Add Test Report plugin based on user inputs
testReportFolder = fullfile(obj.OutputPath, 'test-report');
if obj.CreateTestReport
testReportFolder = fullfile(obj.OutputPath, 'test-report');

% Deleting already present reports folder, as overwrite does not work
% for different file formats
% Deleting already present reports folder, as overwrite does not work
% for different file formats

if exist(testReportFolder, "dir")
disp('Deleting already existing test report folder');
rmdir(testReportFolder, 's');
end
switch(obj.TestReportFormat)
case 'html'
testReportPlugin = TestReportPlugin.producingHTML(testReportFolder, ...
'Verbosity',4);
if exist(testReportFolder, "dir")
disp('Deleting already existing test report folder');
rmdir(testReportFolder, 's');
end
switch(obj.TestReportFormat)
case 'html'
testReportPlugin = TestReportPlugin.producingHTML(testReportFolder, ...
'Verbosity',4);

case 'Docx'
% Creating a folder specifically to maintain uniformity in
% different formats of the report. 'html' format creates the
% test-report folder by default, so creating this folder for
% other formats
case 'Docx'
% Creating a folder specifically to maintain uniformity in
% different formats of the report. 'html' format creates the
% test-report folder by default, so creating this folder for
% other formats

mkdir(testReportFolder);
testReportPlugin = TestReportPlugin.producingDOCX(fullfile(testReportFolder, 'TestReport.docx'));
mkdir(testReportFolder);
testReportPlugin = TestReportPlugin.producingDOCX(fullfile(testReportFolder, 'TestReport.docx'));

case 'pdf'
% Creating a folder specifically to maintain uniformity in
% different formats of the report. 'html' format creates the
% test-report folder by default, so creating this folder for
% other formats
case 'pdf'
% Creating a folder specifically to maintain uniformity in
% different formats of the report. 'html' format creates the
% test-report folder by default, so creating this folder for
% other formats

mkdir(testReportFolder);
testReportPlugin = TestReportPlugin.producingPDF(fullfile(testReportFolder, 'TestReport.pdf'));
mkdir(testReportFolder);
testReportPlugin = TestReportPlugin.producingPDF(fullfile(testReportFolder, 'TestReport.pdf'));

case 'xml'
% Creating a folder specifically to maintain uniformity in
% different formats of the report. 'html' format creates the
% test-report folder by default, so creating this folder for
% other formats
case 'xml'
% Creating a folder specifically to maintain uniformity in
% different formats of the report. 'html' format creates the
% test-report folder by default, so creating this folder for
% other formats

mkdir(testReportFolder);
testReportPlugin = XMLPlugin.producingJUnitFormat(fullfile(testReportFolder, 'TestReport.xml'));
mkdir(testReportFolder);
testReportPlugin = XMLPlugin.producingJUnitFormat(fullfile(testReportFolder, 'TestReport.xml'));

otherwise
otherwise

error('TestReportFormat is invalid, It can have only following values as input: "html", "Docx", "pdf", "xml"')
end
error('TestReportFormat is invalid, It can have only following values as input: "html", "Docx", "pdf", "xml"')
end

obj.Runner.addPlugin(testReportPlugin);
obj.Runner.addPlugin(testReportPlugin);
end
end


Expand Down