Mpep bind server test (#209)

* Started expServer tests

* Added more tests; bug fix for older versions

* Removed validation functions for old MATLAB versions; added documentation

* More coverage, documentation

* Draws text to screen during calibration #128

* Fix for #4

* Added structAssign test; rewardId tests

* Typo fix in structAssign_test

* Finished tests for expServer

* #156

* Returned listener delete to cleanup

* Stricter tolerance in AlyxPanel_test; bug fix for rounding negative numbers

* Update alyx-matlab submodule

* Minor changes to documentation

* Update CHANGELOG.md

* Added tests for tl.bindMpepServer and pnet spy

* Fixture path fix

* Moved audioDevices default to devices mock

* Assertion added #204

Author: k1o0

+hw/Timeline.m

@@ -71,13 +71,13 @@
         DaqVendor = 'ni'
         % Device ID can be found with daq.getDevices()
         DaqIds = 'Dev1'
-        % rate at which daq aquires data in Hz, see Rate
+        % Rate at which daq aquires data in Hz, see Rate
         DaqSampleRate = 1000
-        % determines the number of data samples to be processed each time,
+        % Determines the number of data samples to be processed each time,
         % see Timeline.process(), constructor and
         % NotifyWhenDataAvailableExceeds
         DaqSamplesPerNotify
-        % array of output classes, defining any signals you desire to be
+        % Array of output classes, defining any signals you desire to be
         % sent from the daq. See Also HW.TLOUTPUT, HW.TLOUTPUTCLOCK
         Outputs = hw.TLOutputChrono
         % All configured inputs. 
@@ -87,25 +87,25 @@
             'measurement', 'Voltage',...
             'terminalConfig', 'SingleEnded',...
             'axesScale', 1) % multiplicative vertical scaling for when live plotting the input
-        % array of inputs to record while tl is running
+        % Array of inputs to record while tl is running
         UseInputs = {'chrono'}
-        % currently pauses for at least 2 secs as 'hack' before stopping
+        % Currently pauses for at least 2 secs as 'hack' before stopping
         % main DAQ session to allow
         StopDelay = 2
-        % expected experiment time so data structure is initialised to
+        % Expected experiment time so data structure is initialised to
         % sensible size (in secs)
         MaxExpectedDuration = 2*60*60
-        % default data type for the acquired data array (i.e.
+        % Default data type for the acquired data array (i.e.
         % Data.rawDAQData)
         AquiredDataType = 'double'
         % If true, timeline is started by default (otherwise can be toggled
         % with the t key in expServer)
         UseTimeline matlab.lang.OnOffSwitchState = 'off'
-        % if true the data are plotted as the data are aquired
+        % If true the data are plotted as the data are aquired
         LivePlot matlab.lang.OnOffSwitchState = 'off'
-        % figure position in normalized units, default is full screen
+        % Figure position in normalized units, default is full screen
         FigureScale = [0 0 1 1]
-        % if true the data buffer is written to disk as they're aquired NB:
+        % If true the data buffer is written to disk as they're aquired NB:
         % in the future this will happen by default
         WriteBufferToDisk matlab.lang.OnOffSwitchState = 'off'
     end
@@ -120,17 +120,17 @@
     end
 
     properties (Transient, Access = protected)
-        % holds the listener for 'DataAvailable', see DataAvailable and
+        % Holds the listener for 'DataAvailable', see DataAvailable and
         % Timeline.process()
         Listener
-        % the last timestamp returned from the daq during the DataAvailable
+        % The last timestamp returned from the daq during the DataAvailable
         % event.  Used to check sampling continuity, see tl.process()
         LastTimestamp
-        % the expRef string.  See tl.start()
+        % The expRef string.  See tl.start()
         Ref
-        % a struct contraining the Alyx token, user and url for ile
-        % registration.  See tl.start()
-        AlyxInstance
+        % An Alyx object instance used for file registration.  See
+        % tl.start()
+        AlyxInstance Alyx
         % A structure containing timeline data
         Data
         % A figure handle for plotting the aquired data as it's processed

CHANGELOG.md

@@ -24,6 +24,7 @@ Starting after Rigbox 2.2.0, this file contains a curated, chronologically order
 - better organization of expServer `f32a0fe` 2019-10-02
 - bug fix for rounding negative numbers in AlyxPanel `31641f1` 2019-10-17
 - stricter and more accurate tolerance in AlyxPanel_test `31641f1` 2019-10-17
+- added tests for dat.mpepMessageParse and tl.bindMpepServer `bd15b95` 2019-10-21
 - HOTFIX to error when plotting supressed in Window calibrate `7d6b601` 2019-11-15
 
 ## [2.3.0](https://github.com/cortex-lab/Rigbox/releases/tag/v2.3.0)

cb-tools/burgbox/+io/WSCommunicator.m

@@ -24,7 +24,7 @@
 
   properties (Transient)
     WebSocket
-    EventMode = false
+    EventMode = 'off'
   end
 
   properties (Access = private, Transient)

cortexlab/+tl/bindMpepServer.m

@@ -86,8 +86,10 @@ function processMpep(listener, msg)
         tls.AlyxInstance = ai;
       case 'expstart'
         % create a file path & experiment ref based on experiment info
-        try
-          % start Timeline
+        try % start Timeline
+          assert(~tlObj.IsRunning, ...
+            'Rigbox:tl:bindMpepServer:timelineAlreadyRunning', ...
+            'Timeline already started')
           tlObj.start(info.expRef, tls.AlyxInstance);
           % re-record the UDP event in Timeline since it wasn't started
           % when we tried earlier. Treat it as having arrived at time zero.
@@ -173,4 +175,3 @@ function log(varargin)
   end
 
 end
-

tests/cortexlab/bindMpepServer_test.m

@@ -0,0 +1,175 @@
+classdef (SharedTestFixtures={ % add 'fixtures' folder as test fixture
+    matlab.unittest.fixtures.PathFixture(['..' filesep 'fixtures']),...
+    matlab.unittest.fixtures.PathFixture(['..' filesep 'fixtures' filesep 'util'])})...
+    bindMpepServer_test < matlab.unittest.TestCase & matlab.mock.TestCase
+  
+  properties (SetAccess = protected)
+    % Timeline mock object
+    Timeline
+    % Timeline behaviour object
+    Behaviour
+    % An experiment reference for the test
+    Ref
+    % Default ports used by bindMpepServer
+    Ports = [9999, 1001]
+  end
+  
+  methods (TestClassSetup)
+    function setTestFlag(testCase)
+      % SETTESTFLAG Set test flag
+      %  Sets global INTEST flag to true and adds teardown.  Also creates a
+      %  dummy expRef for tests.
+      %
+      % TODO Make into shared fixture
+      
+      % Set INTEST flag
+      assert(endsWith(which('dat.paths'),...
+        fullfile('tests', 'fixtures', '+dat', 'paths.m')));
+      setTestFlag(true)
+      testCase.addTeardown(@setTestFlag, false)
+      % Set test expRef
+      testCase.Ref = dat.constructExpRef('test', now, 1);
+    end
+  end
+  
+  methods (TestMethodSetup)
+    function setMockRig(testCase)
+      % SETMOCKRIG Inject mock rig with shadowed hw.devices
+      %   1. Create mock timeline
+      %   2. Set the mock rig object to be returned on calls to hw.devices
+      %   3. Add teardowns
+      % 
+      % See also mockRig, KbQueueCheck
+      
+      % Create fresh Timeline mock
+      [testCase.Timeline, testCase.Behaviour] = createMock(testCase, ...
+        'AddedProperties', properties(hw.Timeline)', ...
+        'AddedMethods', methods(hw.Timeline)');
+
+      % Inject our mock via calls to hw.devices
+      rig.timeline = testCase.Timeline;
+      hw.devices('testRig', false, rig);
+      
+      % Clear mock histories just to be safe
+      testCase.addTeardown(@testCase.clearMockHistory, testCase.Timeline);
+      testCase.addTeardown(@clear, 'KbQueueCheck', 'pnet', 'devices')
+    end
+  end
+  
+  methods (Test)
+    function test_bindMpepListener(testCase)
+      % Test binding of sockets and returning of tls object
+      % NB Actually calls bindMpepServer
+      port = randi(10000);
+      [T, tls] = evalc(['tl.bindMpepServer(', num2str(port), ')']);
+      % Check log
+      testCase.verifyMatches(T, 'Bound UDP sockets', ...
+        'failed to log socket bind')
+      % Check returned fields
+      expected = {'close'; 'process'; 'listen'; 'AlyxInstance'; 'tlObj'};
+      testCase.verifyEqual(fieldnames(tls), expected, ...
+        'Unexpected structure returned')
+      % Check funciton handles
+      actual = structfun(@(f)isa(f, 'function_handle'), tls);
+      testCase.verifyEqual(actual, [true(3,1); false(2,1)])
+      % Check Alyx instance and Timeline objects set
+      testCase.verifyTrue(isa(tls.AlyxInstance, 'Alyx'), ...
+        'Failed to create Alyx instance')
+      testCase.verifyTrue(isequal(tls.tlObj, testCase.Timeline), ...
+        'Failed to set Timeline')
+      % Check socket opened on correct port
+      history = pnet('gethistory');
+      testCase.verifyEqual(history{1}, {'udpsocket', port}, ...
+        'Failed to open socket on specified port')
+    end
+    
+    function test_close(testCase)
+      % Test the close callback
+      tls = tl.bindMpepServer; %#ok<NASGU> % Return tls object
+      ports = testCase.Ports; % Default ports opened
+      arrayfun(@(s) pnet('setoutput', s, 'close', []), ports); % Set output
+      T = evalc('tls.close()'); % Callback
+      % Check log
+      testCase.verifyMatches(T, 'Unbinding', 'failed to log close')
+      % Check close called on each socket
+      history = pnet('gethistory'); % Get pnet call history
+      correct = cellfun(@(a) strcmp(a{2}, 'close'), history(end-1:end));
+      testCase.verifyTrue(all(correct), 'Failed to close sockets')
+    end
+    
+    function test_process(testCase)
+      % Test process callback
+      import matlab.unittest.constraints.IsOfClass
+      import matlab.mock.constraints.Occurred
+      [subject, series, seq] = dat.parseExpRef(testCase.Ref);
+      
+      tls = tl.bindMpepServer; % Return tls object
+      ports = testCase.Ports; % Default ports opened
+      arrayfun(@(s) pnet('setoutput', s, 'readpacket', 1000), ports); % Set output
+      pnet('setoutput', ports(2), 'gethost', {randi(99,1,4), 88}); % Set output
+      
+      % Set messages
+      % Stringify Alyx instance
+      ai = Alyx.parseAlyxInstance(testCase.Ref, Alyx('user',''));
+      % Function for constructing message strings
+      str = @(cmd) sprintf('%s %s %s %d %s', cmd, subject, ...
+        datestr(series, 'yyyymmdd'), seq, iff(strcmp(cmd,'alyx'),ai,''));
+      % Set behaviour for IsRunning method to pass IsRunning assert
+      testCase.assignOutputsWhen(get(testCase.Behaviour.IsRunning), false)
+      % Commands
+      cmd = {'alyx', 'expstart', 'expend', 'expinterupt'};
+      % Set output for 'read'
+      pnet('setoutput', ports(2), 'read', sequence(mapToCell(str, cmd)));
+      % Trigger reads
+      arrayfun(@(~) tls.process(), 1:length(cmd))
+      
+      % Test Timeline interactions
+      timeline = testCase.Behaviour;
+      testCase.verifyThat([...
+        get(timeline.IsRunning), ...
+        timeline.start(testCase.Ref, IsOfClass(?Alyx)), ... % expstart
+        withAnyInputs(timeline.record), ... % "
+        withAnyInputs(timeline.stop), ... % expstop 
+        withAnyInputs(timeline.stop)], ... % expinterupt
+        Occurred('RespectingOrder', false))
+      
+      % Retrieve mock history for Timeline
+      history = testCase.getMockHistory(testCase.Timeline);
+      % Find inputs to start method
+      f = @(method) @(a) strcmp(a.Name, method);
+      actual = fun.filter(f('start'), history).Inputs{end};
+      % Check AlyxInstance updated with the one we passed in above
+      testCase.verifyEqual(actual.User, 'user', 'Failed to update AlyxInstance')
+      
+      % Get pnet history
+      history = pnet('gethistory');
+      % Calls to write should equal the number of messages read
+      writeCalls = cellfun(@(C) strcmp(C{2}, 'write'), history);
+      testCase.verifyEqual(sum(writeCalls), length(cmd), 'Failed echo messages')
+      
+      % Test process fails
+      testCase.throwExceptionWhen(withAnyInputs(timeline.start), ...
+        MException('Timeline:error', 'Error during experiment.'));
+      % Clear pnet history
+      pnet('clearhistory');
+      % Set output for 'read'
+      pnet('setoutput', ports(2), 'read', str('expstart'));
+      % Trigger pnet read; use evalc to supress output
+      evalc('tls.process()');
+      % Set Timeline as already running and check for error
+      testCase.assignOutputsWhen(get(testCase.Behaviour.IsRunning), true)
+      evalc('tls.process()');
+      
+      % Check message not echoed after error
+      history = pnet('gethistory');
+      % Calls to write should equal the number of messages read
+      writeCalls = cellfun(@(C) strcmp(C{2}, 'write'), history);
+      testCase.verifyFalse(any(writeCalls), 'Unexpected message echo')
+    end
+    
+    function test_listen(testCase)
+      % TODO Add test for listen function of bindMpepServer
+    end
+  end
+  
+end

tests/cortexlab/mpepMessageParse_test.m

@@ -0,0 +1,71 @@
+% mpepMessageParse test
+% preconditions
+subject = 'M20140123_CB';
+series = num2str(randi(10000));
+seq = randi(100);
+ref = dat.constructExpRef(subject, series, seq);
+
+block = '5';
+stim = '1';
+duration = '36000';
+msg = @(cmd) sprintf('%s %s %s %d %s %s %s', ...
+  cmd, subject, series, seq, block, stim, duration);
+
+%% Test 1: infosave
+cmd = sprintf('infosave %s_%s_%d', subject, series, seq);
+info = dat.mpepMessageParse(cmd);
+
+assert(strcmp(info.instruction, 'infosave'))
+assert(strcmp(info.subject, subject))
+assert(strcmp(info.series, series))
+assert(strcmp(info.exp, num2str(seq)))
+assert(strcmp(info.expRef, ref))
+
+%% Test 2: hello
+info = dat.mpepMessageParse(msg('hello'));
+assert(strcmp(info.instruction, 'hello'))
+assert(isempty(info.expRef))
+
+%% Test 3: full mpep instruction
+info = dat.mpepMessageParse(msg('expstart'));
+
+assert(strcmp(info.instruction, 'expstart'))
+assert(strcmp(info.subject, subject))
+assert(strcmp(info.series, series))
+assert(strcmp(info.exp, num2str(seq)))
+assert(strcmp(info.expRef, ref))
+assert(strcmp(info.block, block))
+assert(strcmp(info.stim, stim))
+assert(strcmp(info.duration, duration))
+
+%% Test 4: series to datestr
+series = datestr(now, 'yyyymmdd');
+cmd = sprintf('expinterrupt %s %s %d', subject, series, seq);
+info = dat.mpepMessageParse(cmd);
+
+assert(strcmp(info.series, datestr(now, 'yyyy-mm-dd')))
+assert(strcmp(info.expRef, dat.constructExpRef(subject, now, seq)))
+
+%% Test 5: empty sequence
+cmd = sprintf('expend %s %s', subject, series);
+ex.message = '';
+try
+  dat.mpepMessageParse(cmd);
+catch ex
+end
+assert(contains(ex.message, 'not valid'))
+
+%% Test 6: Alyx serialization
+% Test compatibility with parseAlyxInstance
+
+token = char(randsample([48:57 65:89 97:122], 36, true)); % Generate token
+ai = Alyx.parseAlyxInstance(ref, Alyx('user', token)); % Stringify instance
+cmd = sprintf('alyx %s %s %d %s', subject, series, seq, ai); % Make message
+
+info = dat.mpepMessageParse(cmd);
+
+assert(strcmp(info.instruction, 'alyx'))
+assert(strcmp(info.subject, subject))
+assert(strcmp(info.series, series))
+assert(strcmp(info.exp, num2str(seq)))
+

tests/expServer_test.m

@@ -66,8 +66,8 @@ function setupMock(testCase)
       % See also MOCKRIG, GIT.UPDATE
 
       % Set INTEST flag to true
-      testCase.setTestFlag(true)
-      testCase.addTeardown(@testCase.setTestFlag, false)
+      setTestFlag(true)
+      testCase.addTeardown(@setTestFlag, false)
 
       % Make sure git update not triggered
       root = getOr(dat.paths, 'rigbox'); % Rigbox root directory
@@ -923,12 +923,4 @@ function test_run_fail(testCase)
     end
   end
 
-  methods (Static)
-    function setTestFlag(TF)
-      % SETTESTFLAG Set global INTEST flag
-      %   Allows setting of test flag via callback function
-      global INTEST
-      INTEST = TF;
-    end
-  end
 end

tests/fixtures/+hw/devices.m

@@ -22,7 +22,12 @@
 if isempty(mockRig)
   mockRig = struct(...
     'name', name, ...
-    'clock', hw.ptb.Clock);
+    'clock', hw.ptb.Clock, ...
+    'audioDevices', struct(...
+        'DeviceName', 'default',...
+        'DeviceIndex', -1,...
+        'DefaultSampleRate', 44100,...
+        'NrOutputChannels', 2));
 end
 
 % Set mock