[test/api] Add tests for getting instrument data from API.

driusan · driusan · commit 9bf373402dae · 2023-06-21T13:24:27.000-04:00
The previous test was "incomplete" (it got the data but didn't do anything to verify it.) This adds real tests for the candidate instrument data endpoint now that Issue aces#8781 was fixed by PR#8796.
diff --git a/modules/instruments/php/dictionaryitem.class.inc b/modules/instruments/php/dictionaryitem.class.inc
@@ -0,0 +1,42 @@
+<?php
+declare(strict_types=1);
+namespace LORIS\instruments;
+
+use \LORIS\Data\Scope;
+use \LORIS\Data\Type;
+use \LORIS\Data\Cardinality;
+
+/**
+ * A DictionaryItem represents a description of a type of data
+ * managed by LORIS. An Instrument DictionaryItem differs slightly
+ * from the parent, in that it also has a fieldname property to
+ * get the name of the field without the "testname_" prefix that
+ * is added to the name in order to ensure that the name is unique
+ * across instruments for the QueryEngine.
+ *
+ * @license http://www.gnu.org/licenses/gpl-3.0.txt GPLv3
+ */
+class DictionaryItem extends \LORIS\Data\Dictionary\DictionaryItem
+{
+    /**
+     * Construct a DictionaryItem with the given parameters
+     *
+     * @param string      $name      The field name of the dictionary item
+     * @param string      $desc      The dictionary item's description
+     * @param Scope       $scope     The scope to which this DictionaryItem
+     *                               applies
+     * @param Type        $t         The data type of this dictionary item
+     * @param Cardinality $c         The data cardinality
+     * @param string      $fieldname The non-prefixed field name
+     */
+    public function __construct(
+        string $name,
+        string $desc,
+        Scope $scope,
+        Type $t,
+        Cardinality $c,
+        public readonly string $fieldname,
+    ) {
+        parent::__construct($name, $desc, $scope, $t, $c);
+    }
+}
diff --git a/php/libraries/LorisFormDictionaryImpl.class.inc b/php/libraries/LorisFormDictionaryImpl.class.inc
@@ -1,5 +1,5 @@
 <?php declare(strict_types=1);
-use \LORIS\Data\Dictionary\DictionaryItem;
+use \LORIS\instruments\DictionaryItem;
 use \LORIS\Data\Dictionary\Category;
 use \LORIS\Data\Scope;
 use \LORIS\Data\Cardinality;
@@ -142,7 +142,8 @@ trait LorisFormDictionaryImpl
                 $label,
                 $scope,
                 $t,
-                $card
+                $card,
+                $element['name'],
             );
         }
         return $items;
diff --git a/php/libraries/NDB_BVL_Instrument.class.inc b/php/libraries/NDB_BVL_Instrument.class.inc
@@ -4,7 +4,7 @@ use \Psr\Http\Server\RequestHandlerInterface;
 use \Psr\Http\Message\ResponseInterface;
 
 use \Loris\StudyEntities\Candidate\CandID;
-use \LORIS\Data\Dictionary\DictionaryItem;
+use \LORIS\instruments\DictionaryItem;
 
 /**
  * Base class for all LORIS behavioural instruments.
@@ -1379,10 +1379,7 @@ abstract class NDB_BVL_Instrument extends NDB_Page
         $dictionary = $this->getDataDictionary();
 
         foreach ($dictionary as $item) {
-            // The Field name to compare to in the data dictionary is
-            // prefixed with the testname
-            $dictionaryFieldName = $this->testName."_".$field;
-            if ($dictionaryFieldName === $item->getName()) {
+            if ($field === $item->fieldname) {
                 return $allValues[$field];
             }
         }
@@ -2086,6 +2083,24 @@ abstract class NDB_BVL_Instrument extends NDB_Page
         return $diff;
     }
 
+
+    /**
+     * Get the default instance data which consists of all field names
+     * in the dictionary and a null value.
+     *
+     * @return array
+     */
+    protected function defaultInstanceData()
+    {
+        $val        = [];
+        $dictionary = $this->getDataDictionary();
+
+        foreach ($dictionary as $item) {
+            $val[$item->fieldname] = null;
+        }
+        return $val;
+    }
+
     /**
      * Gets the data from an instrument out of the database and returns it
      * as an array.
@@ -2106,7 +2121,10 @@ abstract class NDB_BVL_Instrument extends NDB_Page
                 ['CID' => $this->getCommentID()]
             );
 
-            $this->instanceData = json_decode($jsondata ?? '', true) ?? [];
+            $this->instanceData = json_decode(
+                $jsondata ?? '',
+                true
+            ) ?? $this->defaultInstanceData();
         } else {
             $defaults = $db->pselectRow(
                 "SELECT * FROM $this->table WHERE CommentID=:CID",
@@ -2118,7 +2136,7 @@ abstract class NDB_BVL_Instrument extends NDB_Page
             // NDB_BVL_Instrument->getCommentID()
             unset($defaults['CommentID']);
 
-            $this->instanceData = $defaults ?? [];
+            $this->instanceData = $defaults ?? $this->defaultInstanceData();
         }
         return $this->instanceData;
     }
@@ -2202,7 +2220,7 @@ abstract class NDB_BVL_Instrument extends NDB_Page
                     $newinst->instanceData = json_decode(
                         $row['Data'],
                         true,
-                    ) ?? [];
+                    ) ?? $this->defaultInstanceData();
 
                     return $newinst;
                 },
diff --git a/php/libraries/NDB_BVL_Instrument_LINST.class.inc b/php/libraries/NDB_BVL_Instrument_LINST.class.inc
@@ -11,7 +11,7 @@
  * @link     https://www.github.com/aces/Loris-Trunk/
  */
 namespace Loris\Behavioural;
-use \LORIS\Data\Dictionary\DictionaryItem;
+use \LORIS\instruments\DictionaryItem;
 use \LORIS\Data\Scope;
 use \LORIS\Data\Cardinality;
 
@@ -500,6 +500,7 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                                 $scope,
                                 new \LORIS\Data\Types\DateType(),
                                 new Cardinality(Cardinality::SINGLE),
+                                'Date_taken',
                             ),
                         ]
                     );
@@ -514,6 +515,7 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                                         $scope,
                                         new \LORIS\Data\Types\Duration(),
                                         new Cardinality(Cardinality::SINGLE),
+                                        'Candidate_Age',
                                     ),
                                 ]
                             );
@@ -527,6 +529,7 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                                         $scope,
                                         new \LORIS\Data\Types\Duration(),
                                         new Cardinality(Cardinality::SINGLE),
+                                        'Candidate_Age',
                                     ),
                                 ]
                             );
@@ -540,6 +543,7 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                                     $scope,
                                     new \LORIS\Data\Types\Duration(),
                                     new Cardinality(Cardinality::SINGLE),
+                                    'Window_Difference',
                                 ),
                             ]
                         );
@@ -556,6 +560,7 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                                 // array if CommentID is not set.
                                 new StringType(255),
                                 new Cardinality(Cardinality::SINGLE),
+                                'Examiner',
                             ),
                         ]
                     );
@@ -616,6 +621,7 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                         $scope,
                         new StringType(255),
                         new Cardinality(Cardinality::SINGLE),
+                        $pieces[1],
                     );
                     if ($firstFieldOfPage) {
                         $this->_requiredElements[] = $fieldname;
@@ -641,6 +647,7 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                         $scope,
                         new StringType(),
                         new Cardinality(Cardinality::SINGLE),
+                        $pieces[1],
                     );
                     if ($firstFieldOfPage) {
                         $this->_requiredElements[] = $fieldname;
@@ -669,6 +676,7 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                             $scope,
                             new DateType(),
                             new Cardinality(Cardinality::SINGLE),
+                            $pieces[1],
                         );
                         // Set date format
                         $dateFormat = isset($pieces[5]) ? trim($pieces[5]) : "";
@@ -741,6 +749,7 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                             $scope,
                             new IntegerType(),
                             new Cardinality(Cardinality::SINGLE),
+                            $pieces[1],
                         );
                     }
                     if ($firstFieldOfPage) {
@@ -844,6 +853,7 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                         $scope,
                         $t,
                         $cardinality,
+                        $pieces[1],
                     );
                     $this->dictionary[] = $it;
                     $this->LinstQuestions[$pieces[1]] = ['type' => 'select'];
@@ -881,7 +891,8 @@ class NDB_BVL_Instrument_LINST extends \NDB_BVL_Instrument
                             $pieces[2],
                             $scope,
                             new StringType(255),
-                            new Cardinality(Cardinality::SINGLE)
+                            new Cardinality(Cardinality::SINGLE),
+                            $pieces[1],
                         );
                     }
                     break;
diff --git a/raisinbread/test/api/LorisApiInstrumentsTest.php b/raisinbread/test/api/LorisApiInstrumentsTest.php
@@ -89,13 +89,35 @@ public function testGetCandidatesCandidVisitInstrumentsInstrument(): void
         $this->assertNotEmpty($body);
 
         $bodystr = $response->getBody()->getContents();
-        print "body: $bodystr";
+        $this->assertNotEmpty($bodystr);
         $InstrumentsArray = json_decode(
             (string) utf8_encode($bodystr),
             true
         );
-        $this->markTestIncomplete("Test body not validated");
-        // $this->assertNotEmpty($InstrumentsArray['Data']);
+        $this->assertArrayHasKey(
+            'Candidate',
+            $InstrumentsArray['Meta']
+        );
+        $this->assertArrayHasKey(
+            'Visit',
+            $InstrumentsArray['Meta']
+        );
+        $this->assertArrayHasKey(
+            'Instrument',
+            $InstrumentsArray['Meta']
+        );
+        $this->assertArrayHasKey(
+            'DDE',
+            $InstrumentsArray['Meta']
+        );
+
+        $this->assertSame($InstrumentsArray['Meta']['DDE'], false);
+        $this->assertSame($InstrumentsArray['Meta']['Candidate'], $this->candidTest);
+        $this->assertSame($InstrumentsArray['Meta']['Visit'], $this->visitTest);
+        $this->assertSame($InstrumentsArray['Meta']['Instrument'], $this->instrumentTest);
+
+        $this->assertArrayHasKey('Data', $InstrumentsArray);
+        $this->assertNotEmpty($InstrumentsArray['Data']);
     }
 
     /**
diff --git a/raisinbread/test/api/LorisApiInstruments_v0_0_3_Test.php b/raisinbread/test/api/LorisApiInstruments_v0_0_3_Test.php
@@ -87,15 +87,44 @@ public function testGetCandidatesCandidVisitInstrumentsInstrument(): void
         // Verify the endpoint has a body
         $body = $response->getBody();
         $this->assertNotEmpty($body);
+        $bodystr = $response->getBody()->getContents();
+        $this->assertNotEmpty($bodystr);
 
         $InstrumentsArray = json_decode(
             (string) utf8_encode(
-                $response->getBody()->getContents()
+                $bodystr,
             ),
             true
         );
-        $this->markTestIncomplete('Instrument body not validated');
-        // $this->assertNotEmpty($InstrumentsArray[$this->instrumentTest]);
+
+        $InstrumentsArray = json_decode(
+            (string) utf8_encode($bodystr),
+            true
+        );
+        $this->assertArrayHasKey(
+            'Candidate',
+            $InstrumentsArray['Meta']
+        );
+        $this->assertArrayHasKey(
+            'Visit',
+            $InstrumentsArray['Meta']
+        );
+        $this->assertArrayHasKey(
+            'Instrument',
+            $InstrumentsArray['Meta']
+        );
+        $this->assertArrayHasKey(
+            'DDE',
+            $InstrumentsArray['Meta']
+        );
+
+        $this->assertSame($InstrumentsArray['Meta']['DDE'], false);
+        $this->assertSame($InstrumentsArray['Meta']['Candidate'], $this->candidTest);
+        $this->assertSame($InstrumentsArray['Meta']['Visit'], $this->visitTest);
+        $this->assertSame($InstrumentsArray['Meta']['Instrument'], $this->instrumentTest);
+
+        $this->assertArrayHasKey($this->instrumentTest, $InstrumentsArray);
+        $this->assertNotEmpty($InstrumentsArray[$this->instrumentTest]);
     }
 
     /**
diff --git a/test/unittests/NDB_BVL_Instrument_LINST_ToJSON_Test.php b/test/unittests/NDB_BVL_Instrument_LINST_ToJSON_Test.php
@@ -3,6 +3,7 @@
 set_include_path(get_include_path().":" .  __DIR__  . "/../../php/libraries:");
 
 require_once __DIR__ . '/../../vendor/autoload.php';
+require_once __DIR__ . '/../../modules/instruments/php/dictionaryitem.class.inc';
 require_once __DIR__ . '/../../php/libraries/NDB_BVL_Instrument_LINST.class.inc';
 require_once 'Smarty_hook.class.inc';
 require_once 'NDB_Config.class.inc';
diff --git a/test/unittests/NDB_BVL_Instrument_Test.php b/test/unittests/NDB_BVL_Instrument_Test.php
@@ -14,6 +14,7 @@
 set_include_path(get_include_path().":" .  __DIR__  . "/../../php/libraries:");
 use PHPUnit\Framework\TestCase;
 require_once __DIR__ . '/../../vendor/autoload.php';
+require_once __DIR__ . '/../../modules/instruments/dictionaryitem.class.inc';
 require_once __DIR__ . '/../../php/libraries/NDB_BVL_Instrument.class.inc';
 require_once 'Smarty_hook.class.inc';
 require_once 'NDB_Config.class.inc';
@@ -119,13 +120,19 @@ function setUp(): void
         $this->quickForm = new \LorisForm();
 
         $dictionaryItem = $this->getMockBuilder(
-            \LORIS\Data\Dictionary\DictionaryItem::class
+            \LORIS\instruments\DictionaryItem::class
         )
             ->disableOriginalConstructor()
             ->getMock();
         $dictionaryItem->method('getName')
             ->willReturn('Test_Date_taken');
-        '@phan-var \LORIS\Data\Dictionary\DictionaryItem $dictionaryItem';
+        '@phan-var \LORIS\instruments\DictionaryItem $dictionaryItem';
+
+        // Use reflection to modify fieldname, since the constructor
+        // was disabled and it's a readonly property.
+        $ref = new \ReflectionProperty(get_class($dictionaryItem), 'fieldname');
+        $ref->setAccessible(true);
+        $ref->setValue($dictionaryItem, 'Date_taken');
 
         $instrument = $this->getMockBuilder(\NDB_BVL_Instrument::class)
             ->disableOriginalConstructor()
