Moving Examples Driven Tester to Github.com

Author: mukeshangrakh

.gitattributes

@@ -0,0 +1,26 @@
+*.fig binary
+*.mat binary
+*.mdl binary diff merge=mlAutoMerge
+*.mdlp binary
+*.mex* binary
+*.mlapp binary
+*.mldatx binary
+*.mlproj binary
+*.mlx binary
+*.p binary
+*.sfx binary
+*.sldd binary
+*.slreqx binary merge=mlAutoMerge
+*.slmx binary merge=mlAutoMerge
+*.sltx binary
+*.slxc binary
+*.slx binary merge=mlAutoMerge
+*.slxp binary
+
+## Other common binary file types
+*.docx binary
+*.exe binary
+*.jpg binary
+*.pdf binary
+*.png binary
+*.xlsx binary

.gitignore

@@ -0,0 +1,37 @@
+# Autosave files
+*.asv
+*.m~
+*.autosave
+*.slx.r*
+*.mdl.r*
+
+# Derived content-obscured files
+*.p
+
+# Compiled MEX files
+*.mex*
+
+# Packaged app and toolbox files
+release/**
+*.mlappinstall
+*.mltbx
+
+# Deployable archives
+*.ctf
+
+# Generated helpsearch folders
+helpsearch*/
+
+# Buildtool cache folders
+.buildtool/
+
+# Code generation folders
+slprj/
+sccprj/
+codegen/
+
+# Cache files
+*.slxc
+
+# Cloud based storage dotfile
+.MATLABDriveTag

CONTRIBUTING.MD

@@ -0,0 +1,25 @@
+# Contributing
+
+>_If you believe you have discovered a security vulnerability, please **do not** open an issue or make a pull request.  Follow the instructions in the [SECURITY.MD](SECURITY.MD) file in this repository._
+
+Thank you for your interest in contributing to a MathWorks repository!  We encourage contributions large and small to this repository.  
+
+**Contributions do not have to be code!** If you see a way to explain things more clearly or a great example of how to use something, please contribute it (or a link to your content).  We welcome issues even if you don't code the solution.  We also welcome pull requests to resolve issues that we haven't gotten to yet!
+
+## How to contribute
+
+* **Open an issue:** Start by [creating an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) in the repository that you're interested in.  That will start a conversation with the maintainer.  When you are creating a bug report, please include as many details as possible.  Please remember that other people do not have your background or understanding of the issue; make sure you are clear and complete in your description.
+* **Work in your own public fork:** If you choose to make a contribution, you should [fork the repository](https://docs.github.com/en/get-started/quickstart/fork-a-repo).  This creates an editable copy on GitHub where you can write, test, and refine your changes.  We suggest that you keep your changes small and focused on the issue you submitted.
+* **Sign a Contributor License Agreement (CLA):** We require that all outside contributors sign a [CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement) before we can accept your contribution.  When you create a pull request (see below), we'll reach out to you if you do not already have one on file.  Essentially, the CLA gives us permission to publish your contribution as part of the repository.
+* **Make a pull request:** "[Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)" is a confusing term, but it means exactly what it says:  You're requesting that the maintainers of the repository pull your changes in.  If you don't have a CLA on file, we'll reach out to you.  Your contribution will be reviewed, and we may ask you to revise your pull request based on our feedback.  Once everyone is satisfied, we'll merge your pull request into the repository.
+
+## Guidelines
+
+We don't have best practices for writing MATLAB code, but we do have some recommendations:
+
+* You should not have any warnings or errors in the [code analyzer report](http://www.mathworks.com/help/matlab/matlab_prog/matlab-code-analyzer-report.html)
+* [Loren Shure's blog](https://blogs.mathworks.com/loren) has [great advice on improving your MATLAB code](https://blogs.mathworks.com/loren/category/best-practice/)
+* Examples should be written as [live scripts](https://www.mathworks.com/help/matlab/matlab_prog/what-is-a-live-script-or-function.html) and then [exported as HTML](https://www.mathworks.com/help/matlab/matlab_prog/share-live-scripts.html).
+* We adhere to the [CommonMark](https://commonmark.org/) specification where it does not conflict with GitHub rendering.  If you edit your Markdown in Visual Studio Code or a similar editor, it uses [markdownlint](https://github.com/DavidAnson/markdownlint) to highlight issues in your Markdown.
+
+**Again, thanks for contributing, and we look forward to your issues and pull requests!**

ExamplesDrivenTester.prj

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<MATLABProject xmlns="http://www.mathworks.com/MATLABProjectFile" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.0"/>

README.md

@@ -0,0 +1,79 @@
+# Examples Driven Tester
+
+[![View <File Exchange Title> on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/####-file-exchange-title) 
+  
+Examples driven tester is a tool for users which uses MATLAB&reg; scripts which are already present in toolbox to provide a preliminary "smoke test" of the toolbox functionality. It runs MATLAB scripts via the [MATLAB Function-Based unit test](https://www.mathworks.com/help/matlab/function-based-unit-tests.html) framework and generates a test and code coverage report. This tool is intended for preliminary qualification or Smoke testing of toolboxes. It is recommended to add unit tests for exhaustive functional testing of your code. 
+
+  
+### MathWorks Products [https://www.mathworks.com](https://www.mathworks.com)  
+* MATLAB R2019b or newer 
+
+## Installation 
+
+  * Launch MATLAB and download Examples driven tester from Add-On Explorer in MATLAB
+  * Examples driven tester will be downloaded and should be ready to use!
+  
+## Usage
+  
+```matlab
+  
+  obj = examplesTester(testFiles);
+  obj = examplesTester(testFiles, Name, Value)
+  
+```
+
+`testFiles` - Can have 2 possible values:
+
+ 1. An array of folders containing  M files
+ 2. A path to json file which contains list of folders containing M files
+
+### Name Value pairs
+
+* **CreateTestReport**           - Should test report be generated. ***Possible values:**[true], false*
+* **TestReportFormat**           - Format of test report. ***Possible values:** "pdf", "docx" , ["html”], “xml”*
+* **OutputPath**                 - Directory where reports will be generated.  Default is pwd.
+* **CodeCoveragePlugin**         - [MATLAB Code Coverage plugin](https://www.mathworks.com/help/matlab/ref/matlab.unittest.plugins.codecoverageplugin-class.html).
+
+***Note:** Values enclosed in square braces are default values.*
+
+### Basic workflows
+
+Run MATLAB scripts from specified folders, for e.g. "doc" and "examples" and generate a test report
+
+```matlab
+obj = examplesTester(["examples", "doc"]);
+obj.executesTests;
+```
+
+Run MATLAB scripts from specified folders, for e.g. "doc" and "examples" but do not generate a test report
+
+```matlab
+obj = examplesTester(["examples", "doc"], CreateTestReport = false);
+obj.executesTests;
+```
+
+Run MATLAB scripts from specified folders, for e.g. "doc" and "examples" and generate a test report in PDF format.
+
+```matlab
+obj = examplesTester(["examples", "doc"], TestReportFormat = "PDF");
+obj.executesTests;
+```
+
+Run MATLAB scripts from specified folders, for e.g. "doc" and "examples" and generate a code coverage report for code placed in "code" folder.
+
+```matlab
+reportFormat = matlab.unittest.plugins.codecoverage.CoverageReport('coverage-report');
+covPlugin = matlab.unittest.plugins.CodeCoveragePlugin.forFolder("code", "Producing", reportFormat);
+obj = examplesTester(["examples", "doc"], CodeCoveragePlugin = covPlugin);
+obj.executesTests;
+```
+
+## License
+
+The license is available in the [LICENSE.txt](license.txt) file within this repository
+
+## Community Support
+
+[MATLAB Central](https://www.mathworks.com/matlabcentral)
+
+*Copyright 2023 The MathWorks, Inc.*

SECURITY.md

@@ -0,0 +1,6 @@
+# Reporting Security Vulnerabilities 
+
+If you believe you have discovered a security vulnerability, please report it to 
+[[email protected]](mailto:[email protected]). Please see 
+[MathWorks Vulnerability Disclosure Policy for Security Researchers](https://www.mathworks.com/company/aboutus/policies_statements/vulnerability-disclosure-policy.html) 
+for additional information.  

buildfile.m

@@ -0,0 +1,31 @@
+function plan = buildfile
+import matlab.buildtool.tasks.CodeIssuesTask
+import matlab.buildtool.tasks.TestTask
+
+% Create a plan from task functions
+plan = buildplan(localfunctions);
+
+% Add a task to identify code issues
+plan("check") = CodeIssuesTask;
+
+plan("test") = TestTask('./tests');
+
+plan.DefaultTasks = "test";
+
+end
+
+function releaseTask(~)
+releaseFolderName = "release";
+% Create toolbox options
+opts = matlab.addons.toolbox.ToolboxOptions("toolboxPackaging.prj");
+
+mltbxFileName = strrep(opts.ToolboxName," ","_") + ".mltbx";
+opts.OutputFile = fullfile(releaseFolderName,mltbxFileName);
+
+if ~exist(releaseFolderName,"dir")
+    mkdir(releaseFolderName)
+end
+
+% Package the toolbox
+matlab.addons.toolbox.packageToolbox(opts);
+end

license.txt

@@ -0,0 +1,27 @@
+Copyright (c) 2022, The MathWorks, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in
+      the documentation and/or other materials provided with the distribution
+    * Neither the name of the The MathWorks, Inc. nor the names
+      of its contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGE.