Fix livescripts add livescript test

code/+openminds/toolboxdir.m

@@ -0,0 +1,9 @@
+function folderPath = toolboxdir()
+% Root folder for the openMINDS_MATLAB toolbox
+%
+%    S = openminds.toolboxdir() returns a character vector that is the absolute
+%       path to the root of the toolbox folder
+
+    folderPath = fileparts(fileparts(mfilename('fullpath')));
+    assert(isfolder(folderPath), 'Toolbox folder does not exist') % Should not happen
+end

dev/+utility/createContentsHeader.m

@@ -43,4 +43,3 @@
         copyRightLine, ...
         separatorLine}, newline);
 end
-

dev/+utility/getVersionFromContents.m

@@ -21,4 +21,4 @@
         error('BUILDTOOLS:Version:VersionNotFound', ...
               'No version was detected in the Contents file for this toolbox.')
     end
-end
+end

dev/+utility/updateContentsHeader.m

@@ -19,4 +19,4 @@ function updateContentsHeader(toolboxFolder, contentsHeader)
 
     fprintf('Updated %s\n', contentsFilePath)
     disp(strjoin(contentsStrLines, newline))
-end
+end

dev/tasks/createTestedWithBadgeforToolbox.m

@@ -33,7 +33,7 @@ function createTestedWithBadgeforToolbox(versionNumber, rootDir)
            && sum([testResults.testsuite.failuresAttribute]) == 0 ...
            && sum([testResults.testsuite.skippedAttribute]) == 0
             if releasesTestedWith ~= ""
-                % Insert the seperator between released after the first one
+                % Insert the separator between released after the first one
                 releasesTestedWith = releasesTestedWith + " | ";
             end
             releasesTestedWith = releasesTestedWith + releaseName;

dev/tests/unitTests/TutorialTest.m

@@ -0,0 +1,51 @@
+classdef TutorialTest <  matlab.unittest.TestCase
+% TutorialTest - Unit test for testing the openMINDS tutorials.
+
+    properties
+        RootDirectory = openminds.internal.rootpath();
+    end
+
+    properties (TestParameter)
+        % TutorialFile - A cell array where each cell is the name of a
+        % tutorial file. testTutorial will run on each file individually
+        tutorialFile = listTutorialFiles();
+    end
+
+    properties (Constant)
+        SkippedTutorials = {};
+    end
+
+    methods (TestClassSetup)
+        function setupClass(testCase) %#ok<*MANU>
+            openminds.startup("latest")
+        end
+    end
+
+    methods (TestClassTeardown)
+        function tearDownClass(testCase)
+            % Pass. No class teardown routines needed
+        end
+    end
+
+    methods (TestMethodSetup)
+        function setupMethod(testCase)
+            % Pass. No method setup routines needed
+        end
+    end
+
+    methods (Test)
+        function testTutorial(testCase, tutorialFile)
+            run(tutorialFile)
+        end
+    end
+end
+
+function tutorialFilePaths = listTutorialFiles()
+% listTutorialFiles - List names of all tutorial files (exclude skipped files)
+    rootPath = openminds.internal.rootpath();
+    L = dir(fullfile(rootPath, 'livescripts', '*.mlx'));
+    tutorialNames = setdiff({L.name}, TutorialTest.SkippedTutorials);
+
+    tutorialFilePaths = fullfile(rootPath, 'livescripts', tutorialNames);
+    tutorialFilePaths{end+1} = fullfile(rootPath, 'gettingStarted.mlx');
+end

docs/exportTutorials.m

@@ -6,6 +6,7 @@ function exportTutorials()
     openmindsDocsPath = strrep(openmindsCodePath, 'code', 'docs');
 
     L = dir(fullfile(openmindsCodePath, 'livescripts', '*.mlx'));
+    L = cat(1, L, dir(fullfile(openmindsCodePath, 'gettingStarted.mlx')));
 
     for i = 1:numel(L)
         sourcePath = fullfile(L(i).folder, L(i).name);

docs/tutorials/crewMemberCollection.md

@@ -7,8 +7,7 @@ In this example we will create a metadata collection for the crew members of the
 We start by importing a csv file with crew member information:
 
 ```matlab
-currentPath = fileparts(matlab.desktop.editor.getActiveFilename);
-filePath = fullfile(currentPath, "data", "spacecraft_crew_members.csv");
+filePath = fullfile(openminds.toolboxdir(), "livescripts", "data", "spacecraft_crew_members.csv");
 crewMembers = readtable(filePath, "TextType", "String")
 ```
 | |givenName|familyName|alternateName|email|memberOf|
@@ -29,9 +28,9 @@ With these assumptions we will create:
 -  a unique set of <samp>Consortium</samp> instances based on the name given in the <samp>memberOf</samp> column 
 -  a <samp>ContactInformation</samp> instance based on the <samp>email</samp> column 
 -  a <samp>Person</samp> instance for each table row with: 
-    - the <samp>givenName</samp>, <samp>familyName</samp>, and <samp>alternateName</samp> (if available) 
-    - a link to the respective  <samp>ContactInformation</samp> instance 
-    - a person-specific embedded <samp>Affiliation</samp> instance that links to the respective <samp>Consortium</samp> instance 
+-      the <samp>givenName</samp>, <samp>familyName</samp>, and <samp>alternateName</samp> (if available) 
+-      a link to the respective  <samp>ContactInformation</samp> instance 
+-      a person-specific embedded <samp>Affiliation</samp> instance that links to the respective <samp>Consortium</samp> instance 
 
 We start by creating an empty metadata collection for storing metadata instances.