ENH - updated test web interface, return more details from ft_version, check for local changes in ft_test_run

Author: robertoostenveld

utilities/ft_test_result.m

@@ -54,5 +54,4 @@
 end
 
 options = weboptions('ContentType','json'); % this returns the results as MATLAB structure
-results = webread('http://dashboard.fieldtriptoolbox.org/test', options);
-
+results = webread('http://dashboard.fieldtriptoolbox.org/api', options);

utilities/ft_test_run.m

@@ -65,7 +65,11 @@
   maxmem = str2mem(maxmem);
 end
 
-[ftver, ftpath] = ft_version;
+% get the version and the path
+[revision, ftpath] = ft_version;
+
+% testing a work-in-progress version is not supported
+assert(istrue(ft_version('clean')), 'this requires all local changes to be committed');
 
 %% determine the list of functions to test
 if ~isempty(varargin) && exist(varargin{1}, 'file')
@@ -160,15 +164,16 @@
 
   result = [];
   result.matlabversion    = version('-release');
-  result.fieldtripversion = ftver;
+  result.fieldtripversion = revision;
+  result.branch           = ft_version('branch');
   result.hostname         = gethostname;
   result.user             = getusername;
   result.result           = status;
   result.runtime          = runtime;
   result.functionname     = functionlist{i};
 
   options = weboptions('MediaType','application/json');
-  webwrite('http://dashboard.fieldtriptoolbox.org/test', result, options);
+  webwrite('http://dashboard.fieldtriptoolbox.org/api', result, options);
 end
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

utilities/ft_version.m

@@ -1,4 +1,4 @@
-function [ftver, ftpath] = ft_version
+function [ftver, ftpath] = ft_version(command)
 
 % FT_VERSION returns the version and installation directory of FieldTrip
 %
@@ -19,7 +19,7 @@
 %
 % See also VERSION, VER
 
-% Copyright (C) 2012, Eelke Spaak
+% Copyright (C) 2012-2016, Eelke Spaak
 %
 % This file is part of FieldTrip, see http://www.ru.nl/donders/fieldtrip
 % for the documentation and details.
@@ -42,6 +42,11 @@
 persistent issvn
 persistent isgit
 
+if nargin<1
+  % this is only supported for git
+  command='revision';
+end
+
 ftpath = fileparts(mfilename('fullpath'));
 ftpath = ftpath(1:end-10); % strip away '/utilities' where this function is located
 
@@ -81,20 +86,39 @@
   end
 
 elseif isgit
-  % use git system call to determine latest revision
-  olddir = pwd();
-  cd(ftpath);
-  [status, output] = system(sprintf('git%s rev-parse --short HEAD', ext));
-  cd(olddir);
-  if status > 0
+  % test whether the git executable is available
+  [status, output] = system(sprintf('git%s --version', ext));
+  if status>0
     if ~ispc
       % the command line tools will probably not be available on windows
-      warning('you seem to have an GIT development copy of FieldTrip, yet ''git rev-parse'' does not work as expected');
+      warning('you seem to have an GIT development copy of FieldTrip, yet ''git'' does not work as expected');
     end
     ftver = 'unknown';
+    
   else
-    ftver = strtrim(output); % remove trailing newline character
-  end
+    % use git system call to determine latest revision
+    olddir = pwd();
+    cd(ftpath);
+    switch command
+      case 'branch'
+        [status, output] = system(sprintf('git%s rev-parse --abbrev-ref HEAD', ext));
+        ftver = strtrim(output); % remove trailing newline character
+      case 'revision'
+        [status, output] = system(sprintf('git%s rev-parse --short HEAD', ext));
+        ftver = strtrim(output); % remove trailing newline character
+      case 'clean'
+        [status, output] = system(sprintf('git%s diff --quiet --exit-code', ext));
+        if status
+          ftver = 'no';
+        else
+          ftver = 'yes';
+        end
+      otherwise
+        error('unsupported command "%s"');
+    end
+    cd(olddir);
+    
+  end % if git available
 
 elseif isequal(regexp(ftpath, ['.*' filesep 'fieldtrip-fieldtrip-[[0-9][a-z]]{7}']), 1)
   % this corresponds with being downloaded from the Mathworks file exchange link to github
@@ -114,6 +138,6 @@
 end % if issvn, isgit or otherwise
 
 if nargout==0
-  fprintf('\nThis is FieldTrip, version %s.\n\n', ftver);
-  clear ftver
+  fprintf('\nThis is FieldTrip, %s %s.\n\n', command, ftver);
+  clear ftver ftpath
 end