EntityDisplayTest - Add coverage for VIEW mode

Author: totten

ext/search_kit/tests/phpunit/api/v4/SearchDisplay/EntityDisplayTest.php

@@ -22,7 +22,17 @@ public function setUpHeadless(): CiviEnvBuilder {
       ->apply();
   }
 
-  public function testEntityDisplay() {
+  public static function getDataModes(): array {
+    return [
+      ['table'],
+      ['view'],
+    ];
+  }
+
+  /**
+   * @dataProvider getDataModes
+   */
+  public function testEntityDisplay(string $dataMode) {
     $lastName = uniqid(__FUNCTION__);
 
     $this->saveTestRecords('Contact', [
@@ -51,6 +61,7 @@ public function testEntityDisplay() {
       ->addValue('label', 'MyNewEntity')
       ->addValue('name', 'MyNewEntity')
       ->addValue('settings', [
+        'data_mode' => $dataMode,
         'columns' => [
           [
             'key' => 'id',
@@ -90,22 +101,33 @@ public function testEntityDisplay() {
       ])
       ->execute()->first();
 
+    $expectTypes = ['table' => 'BASE TABLE', 'view' => 'VIEW'];
+    $this->assertEquals($expectTypes[$dataMode], \CRM_Core_BAO_SchemaHandler::getTableType('civicrm_sk_my_new_entity'));
+
     $schema = \CRM_Core_DAO::executeQuery('DESCRIBE civicrm_sk_my_new_entity')->fetchAll();
     $this->assertCount(7, $schema);
     $this->assertEquals('_row', $schema[0]['Field']);
-    $this->assertStringStartsWith('int', $schema[0]['Type']);
-    $this->assertEquals('PRI', $schema[0]['Key']);
+    // $this->assertStringStartsWith('int', $schema[0]['Type']);
+    $this->assertMatchesRegularExpression('/^(int|bigint)/', $schema[0]['Type']);
+    if ($dataMode === 'table') {
+      $this->assertEquals('PRI', $schema[0]['Key']);
+    }
 
-    // created_date and modified_date should be NULLable and have no default/extra
-    $this->assertEmpty($schema[5]['Default']);
-    $this->assertEmpty($schema[5]['Extra']);
-    $this->assertEquals('YES', $schema[5]['Null']);
-    $this->assertEmpty($schema[6]['Default']);
-    $this->assertEmpty($schema[6]['Extra']);
-    $this->assertEquals('YES', $schema[5]['Null']);
+    if ($dataMode === 'table') {
+      // created_date and modified_date should be NULLable and have no default/extra
+      $this->assertEmpty($schema[5]['Default']);
+      $this->assertEmpty($schema[5]['Extra']);
+      $this->assertEquals('YES', $schema[5]['Null']);
+      $this->assertEmpty($schema[6]['Default']);
+      $this->assertEmpty($schema[6]['Extra']);
+      $this->assertEquals('YES', $schema[5]['Null']);
+    }
 
-    $rows = \CRM_Core_DAO::executeQuery('SELECT * FROM civicrm_sk_my_new_entity')->fetchAll();
-    $this->assertCount(0, $rows);
+    if ($dataMode === 'table') {
+      // SQL table is not yet hydrated.
+      $rows = \CRM_Core_DAO::executeQuery('SELECT * FROM civicrm_sk_my_new_entity')->fetchAll();
+      $this->assertCount(0, $rows);
+    }
 
     $getFields = civicrm_api4('SK_MyNewEntity', 'getFields', ['loadOptions' => TRUE])->indexBy('name');
     $this->assertNotEmpty($getFields['prefix_id']['options'][1]);
@@ -160,7 +182,10 @@ public function testEntityDisplay() {
     $this->assertStringContainsString('SK_MyNewEntity', $e->getMessage());
   }
 
-  public function testEntityDisplayWithJoin() {
+  /**
+   * @dataProvider getDataModes
+   */
+  public function testEntityDisplayWithJoin(string $dataMode) {
 
     $lastName = uniqid(__FUNCTION__);
     $contacts = (array) $this->saveTestRecords('Individual', [
@@ -198,6 +223,7 @@ public function testEntityDisplayWithJoin() {
       ->addValue('label', 'MyNewEntityWithJoin')
       ->addValue('name', 'MyNewEntityWithJoin')
       ->addValue('settings', [
+        'data_mode' => $dataMode,
         // Additional column data will be filled in automatically
         // @see SKEntitySubscriber::formatFieldSpec
         'columns' => [
@@ -271,7 +297,10 @@ public function testEntityDisplayWithJoin() {
     $this->assertSame('Event_SK_MyNewEntityWithJoin_Contact_Participant_contact_id_01_event_id', $eventJoin[0]['alias']);
   }
 
-  public function testEntityWithSqlFunctions(): void {
+  /**
+   * @dataProvider getDataModes
+   */
+  public function testEntityWithSqlFunctions(string $dataMode): void {
     $cids = $this->saveTestRecords('Individual', [
       'records' => [
         ['first_name' => 'A', 'last_name' => 'A'],
@@ -324,6 +353,7 @@ public function testEntityWithSqlFunctions(): void {
       'saved_search_id.name' => 'Major_Donors_entity_test',
       'type' => 'entity',
       'settings' => [
+        'data_mode' => $dataMode,
         'sort' => [
           ['YEAR_receive_date', 'ASC'],
         ],
@@ -361,9 +391,9 @@ public function testEntityWithSqlFunctions(): void {
     $schema = \CRM_Core_DAO::executeQuery('DESCRIBE civicrm_sk_major_donors_entity_test_db_entity1')->fetchAll();
     $this->assertCount(6, $schema);
     $this->assertEquals('_row', $schema[0]['Field']);
-    $this->assertStringStartsWith('int', $schema[0]['Type']);
-    $this->assertStringStartsWith('int', $schema[1]['Type']);
-    $this->assertStringStartsWith('int', $schema[2]['Type']);
+    $this->assertMatchesRegularExpression('/^(int|bigint)/', $schema[0]['Type']);
+    $this->assertMatchesRegularExpression('/^(int|bigint)/', $schema[1]['Type']);
+    $this->assertMatchesRegularExpression('/^(int|bigint)/', $schema[2]['Type']);
     $this->assertStringStartsWith('text', $schema[3]['Type']);
     $this->assertStringStartsWith('decimal', $schema[4]['Type']);
     $this->assertStringStartsWith('text', $schema[3]['Type']);