update doc and CI

Author: Remi-Gau

.travis.yml

@@ -39,7 +39,7 @@ before_script:
   # Add to src functions to path
   - octave $OCTFLAGS --eval "addpath(genpath(fullfile(pwd, 'src'))); savepath ();"
   # Change current directory
-  - cd manualTests
+  - cd tests/manualTests
 
 jobs:
   include:

src/templates/test_templateTest.m

@@ -23,7 +23,9 @@ function test_templateTestBasic()
     % expectedOuput = X;
 
     % assertEqual(actualOupout, expectedOuput)
-
+    % assertTrue( );
+    % assertFalse( );
+    
     %% clean up (delete temporary files that were created)
 
 end

tests/README.md

@@ -6,23 +6,38 @@
 -   Install [MOcov for matlab and octave](https://github.com/MOcov/MOcov) to get
     the code coverage
 
--   Make sure you are in the `tests` directory.
+-   Make sure the following folders and sub-folders are in the Octave / MATLAB
+    path:
 
--   Run `moxunit_runtests` or `moxunit_runtests -verbose` to run the tests.
+    -   `src`
+    -   `lib`
+    -   `tests/utils`
+
+-   Run `moxunit_runtests tests` or `moxunit_runtests tests -verbose` to run the
+    tests.
 
 This should tell you which tests pass or fail.
 
-## code coverage
+## Adding more tests
+
+You can use the function template to write more tests.
+
+It is in the [`src/templates` folder](../src/templates)
+
+<!-- ## code coverage
+
+A lot of what follows does not really work locally because of needing to add the right
+folders to the path to get an accurate coverage.
 
 The following command would give more info and will give you HTML output in a
 `coverage_html` folder showing you which lines of code is or is not checked by
 your test suite.
 
 ```matlab
-success = moxunit_runtests(pwd, ... % the path where the tests are
+success = moxunit_runtests('tests', ... % the path where the tests are
     '-verbose', ...
     '-with_coverage', ...
-    '-cover', fullfile(pwd, '..'), ... % the path of the code whose coverage we want to estimate
+    '-cover', fullfile(pwd, 'src'), ... % the path of the code whose coverage we want to estimate
     '-cover_xml_file','coverage.xml', ...
     '-cover_html_dir','coverage_html');
 ```
@@ -38,9 +53,9 @@ some tests.
 
 ```matlab
 coverage = mocov( ...
-    '-expression', 'moxunit_runtests()', ...
+    '-expression', "moxunit_runtests('test')", ...
     '-verbose', ...
-    '-cover', fullfile(pwd, '..'), ...
+    '-cover', fullfile(pwd, 'src'), ...
     '-cover_exclude', '*jsonread.m', ...
     '-cover_exclude', '*json*code.m', ...
     '-cover_exclude', '*Contents.m', ...
@@ -54,50 +69,4 @@ coverage = mocov( ...
     '-cover_exclude', '*test_*', ...
     '-cover_xml_file','coverage.xml', ...
     '-cover_html_dir','coverage_html')
-```
-
-## Adding more tests
-
-You can use the following function template to write more tests.
-
-```matlab
-function test_suite = test_functionToTest()
-    % This top function is necessary for mox unit to run tests.
-    % DO NOT CHANGE IT except to adapt the name of the function.
-    try % assignment of 'localfunctions' is necessary in Matlab >= 2016
-        test_functions = localfunctions(); %#ok<*NASGU>
-    catch % no problem; early Matlab versions can use initTestSuite fine
-    end
-    initTestSuite;
-end
-
-function test_functionToTestBasic()
-
-    %% set up
-
-
-    %% data to test against
-
-
-    %% test
-    % assertTrue( );
-    % assertFalse( );
-    % assertEqual( );
-
-end
-
-function test_functionToTestUseCase1()
-
-    %% set up
-
-
-    %% data to test against
-
-
-    %% test
-    % assertTrue( );
-    % assertFalse( );
-    % assertEqual( );
-
-end
-```
+``` -->