Merge pull request #223 from os2display/feature/fix-tests

Fixed broken tests

Author: tuj

CHANGELOG.md

@@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 
+- [#223](https://github.com/os2display/display-api-service/pull/223)
+  - Added explicit fixtures to avoid false negatives in the test suite
 - [#219](https://github.com/os2display/display-api-service/pull/219)
   - Fixed psalm, test, coding standards and updated api spec.
 

fixtures/feed.yaml

@@ -16,3 +16,10 @@ App\Entity\Tenant\Feed:
     id: '<ulid($createdAt)>'
     configuration:
       feeds: [12345]
+  feed_relations_checksum_test:
+    feedSource: '@feed_source_relations_checksum_test'
+    slide: '@slide_relations_checksum_test'
+    tenant: '@tenant_xyz'
+    createdAt (unique): '<dateTimeBetween("-2 years", "-2 days")>'
+    modifiedAt: '<dateTimeBetween($createdAt, "-1 days")>'
+    id: '<ulid($createdAt)>'

fixtures/feed_source.yaml

@@ -21,3 +21,6 @@ App\Entity\Tenant\FeedSource:
       token: '1234567890'
     supportedFeedOutputType: 'instagram'
     tenant: '@tenant_abc'
+  feed_source_relations_checksum_test (extends feed):
+    title: 'feed_source_relations_checksum_test'
+    tenant: '@tenant_xyz'

fixtures/playlist.yaml

@@ -64,3 +64,14 @@ App\Entity\Tenant\Playlist:
     tenants:
       - '@tenant_xyz'
     tenant: '@tenant_def'
+
+  playlist_relations_checksum_test (extends playlist):
+      title: 'playlist_relations_checksum_test'
+      isCampaign: true
+      playlistSlides:
+        - '@playlist_slide_relations_checksum_test'
+      tenant: '@tenant_xyz'
+
+  playlist_screen_test_update (extends playlist):
+      title: 'playlist_screen_test_update'
+      tenant: '@tenant_xyz'

fixtures/playlist_screen_region.yaml

@@ -11,23 +11,23 @@ App\Entity\Tenant\PlaylistScreenRegion:
     id: '<ulid($createdAt)>'
 
   playlist_screen_region_abc_1 (extends playlist_screen_region):
-    playlist: '@playlist_abc_*'
+    playlist: '@playlist_abc_1'
     screen: '@screen_abc_1'
     tenant: '@tenant_abc'
   playlist_screen_region_abc_2 (extends playlist_screen_region):
-    playlist: '@playlist_abc_*'
+    playlist: '@playlist_abc_2'
     screen: '@screen_abc_2'
     tenant: '@tenant_abc'
   playlist_screen_region_abc_3 (extends playlist_screen_region):
-    playlist: '@playlist_abc_*'
+    playlist: '@playlist_abc_3'
     screen: '@screen_abc_3'
     tenant: '@tenant_abc'
   playlist_screen_region_abc_4 (extends playlist_screen_region):
-    playlist: '@playlist_abc_*'
+    playlist: '@playlist_abc_4'
     screen: '@screen_abc_4'
     tenant: '@tenant_abc'
   playlist_screen_region_abc_5 (extends playlist_screen_region):
-    playlist: '@playlist_abc_*'
+    playlist: '@playlist_abc_5'
     screen: '@screen_abc_5'
     tenant: '@tenant_abc'
 
@@ -51,3 +51,8 @@ App\Entity\Tenant\PlaylistScreenRegion:
     playlist: '@playlist_xyz_*'
     screen: '@screen_xyz_5'
     tenant: '@tenant_xyz'
+  playlist_screen_region_screen_update (extends playlist_screen_region):
+    playlist: '@playlist_screen_test_update'
+    screen: '@screen_test_update'
+    tenant: '@tenant_xyz'
+    region: '@screen_layout_region_full'

fixtures/playlist_slide.yaml

@@ -30,3 +30,7 @@ App\Entity\Tenant\PlaylistSlide:
     playlist: '@playlist_def_shared_with_abc'
     slide: '@slide_def_shared_to_abc'
     tenant: '@tenant_def'
+  playlist_slide_relations_checksum_test (extends playlist_slide):
+    playlist: '@playlist_relations_checksum_test'
+    slide: '@slide_relations_checksum_test'
+    tenant: '@tenant_xyz'

fixtures/screen.yaml

@@ -35,3 +35,12 @@ App\Entity\Tenant\Screen:
     title: 'screen_xyz_<current()>'
     screenLayout: "@screen_layout_id_full"
     tenant: "@tenant_xyz"
+  screen_relations_checksum_test (extends screen):
+    title: 'screen_relations_checksum_test'
+    screenCampaigns: ['@screen_campaign_relations_checksum_test']
+    screenLayout: "@screen_layout_id_full"
+    tenant: "@tenant_xyz"
+  screen_test_update (extends screen):
+    title: 'screen_test_update'
+    screenLayout: "@screen_layout_id_full"
+    tenant: "@tenant_xyz"

fixtures/screen_campaign.yaml

@@ -17,3 +17,7 @@ App\Entity\Tenant\ScreenCampaign:
     screen: '@screen_xyz_*'
     campaign: '@playlist_xyz_*'
     tenant: '@tenant_xyz'
+  screen_campaign_relations_checksum_test (extends screen_campaign):
+    screen: '@screen_relations_checksum_test'
+    campaign: '@playlist_relations_checksum_test'
+    tenant: '@tenant_xyz'

fixtures/slide.yaml

@@ -34,3 +34,6 @@ App\Entity\Tenant\Slide:
     content:
       maxEntries: 6
     tenant: '@tenant_abc'
+  slide_relations_checksum_test (extends slide):
+    title: 'slide_relations_checksum_test'
+    tenant: '@tenant_xyz'

tests/Api/ScreensTest.php

@@ -152,8 +152,12 @@ public function testCreateScreen(): void
             'orientation' => 'vertical',
             'inScreenGroups' => '/v2/screens/'.$response->toArray()['id'].'/screen-groups',
             'enableColorSchemeChange' => true,
-            'regions' => ['/v2/screens/'.$response->toArray()['id'].'/regions/'.$regionUlidLeft.'/playlists', '/v2/screens/'.$response->toArray()['id'].'/regions/'.$regionUlidRight.'/playlists'],
         ]);
+
+        $regions = $response->toArray()['regions'];
+        $this->assertTrue(in_array('/v2/screens/'.$response->toArray()['id'].'/regions/'.$regionUlidLeft.'/playlists', $regions));
+        $this->assertTrue(in_array('/v2/screens/'.$response->toArray()['id'].'/regions/'.$regionUlidRight.'/playlists', $regions));
+
         $this->assertMatchesRegularExpression('@^/v\d/\w+/([A-Za-z0-9]{26})$@', $response->toArray()['@id']);
 
         $this->assertMatchesResourceItemJsonSchema(Screen::class);
@@ -183,18 +187,18 @@ public function testCreateInvalidScreen(): void
 
     public function testUpdateScreen(): void
     {
+        $client = $this->getAuthenticatedClient('ROLE_ADMIN');
+
         $playlistScreenRegionRepository = $this->entityManager->getRepository(PlaylistScreenRegion::class);
         $playlistScreenRegionCountBefore = $playlistScreenRegionRepository->count([]);
 
-        $playlistIri = $this->findIriBy(Playlist::class, ['title' => 'playlist_abc_3']);
+        $playlistIri = $this->findIriBy(Playlist::class, ['title' => 'playlist_screen_test_update']);
         $playlistUlid = $this->iriHelperUtils->getUlidFromIRI($playlistIri);
         $regionIri = $this->findIriBy(ScreenLayoutRegions::class, ['title' => 'full']);
         $regionUlid = $this->iriHelperUtils->getUlidFromIRI($regionIri);
+        $screenIri = $this->findIriBy(Screen::class, ['title' => 'screen_test_update']);
 
-        $client = $this->getAuthenticatedClient('ROLE_ADMIN');
-        $iri = $this->findIriBy(Screen::class, ['title' => 'screen_abc_3']);
-
-        $response = $client->request('PUT', $iri, [
+        $client->request('PUT', $screenIri, [
             'json' => [
                 'title' => 'Updated title',
                 'regions' => [['playlists' => [['id' => $playlistUlid, 'weight' => 0]], 'regionId' => $regionUlid]],
@@ -207,14 +211,16 @@ public function testUpdateScreen(): void
         $this->assertResponseIsSuccessful();
         $this->assertJsonContains([
             '@type' => 'Screen',
-            '@id' => $iri,
+            '@id' => $screenIri,
             'title' => 'Updated title',
-            'regions' => ['/v2/screens/'.$response->toArray()['id'].'/regions/'.$regionUlid.'/playlists'],
+            'regions' => [$screenIri.'/regions/'.$regionUlid.'/playlists'],
         ]);
         $playlistScreenRegionCountAfter = $playlistScreenRegionRepository->count([]);
         $this->assertEquals($playlistScreenRegionCountBefore, $playlistScreenRegionCountAfter, 'PlaylistScreenRegion count should not change');
 
-        $response = $client->request('PUT', $iri, [
+        // Test that PUT without regions property will not change playlist screen regions.
+
+        $client->request('PUT', $screenIri, [
             'json' => [
                 'title' => 'Updated title 2',
             ],
@@ -225,11 +231,31 @@ public function testUpdateScreen(): void
 
         $this->assertResponseIsSuccessful();
         $this->assertJsonContains([
-            '@id' => $iri,
+            '@id' => $screenIri,
             'title' => 'Updated title 2',
         ]);
         $playlistScreenRegionCountAfter = $playlistScreenRegionRepository->count([]);
         $this->assertEquals($playlistScreenRegionCountBefore, $playlistScreenRegionCountAfter, 'PlaylistScreenRegion count should not change');
+
+        // Test that region can be cleared.
+
+        $client->request('PUT', $screenIri, [
+            'json' => [
+                'title' => 'Updated title 3',
+                'regions' => [['playlists' => [], 'regionId' => $regionUlid]],
+            ],
+            'headers' => [
+                'Content-Type' => 'application/ld+json',
+            ],
+        ]);
+
+        $this->assertResponseIsSuccessful();
+        $this->assertJsonContains([
+            '@id' => $screenIri,
+            'title' => 'Updated title 3',
+        ]);
+        $playlistScreenRegionCountAfter = $playlistScreenRegionRepository->count([]);
+        $this->assertEquals($playlistScreenRegionCountBefore - 1, $playlistScreenRegionCountAfter, 'PlaylistScreenRegion count should go 1 down');
     }
 
     public function testDeleteScreen(): void

tests/EventListener/RelationsChecksumListenerTest.php

@@ -50,18 +50,18 @@ public function testVersion(): void
     public function testRelationsChecksumPropagation(): void
     {
         /** @var Tenant\Screen $screen */
-        $screen = $this->em->getRepository(Tenant\Screen::class)->findOneBy(['title' => 'screen_abc_1']);
+        $screen = $this->em->getRepository(Tenant\Screen::class)->findOneBy(['title' => 'screen_relations_checksum_test']);
         $screenChecksums = $screen->getRelationsChecksum();
 
-        /** @var Tenant\ScreenGroupCampaign $campaign */
-        $campaign = $screen->getScreenCampaigns()->first();
-        $campaignChecksums = $campaign->getRelationsChecksum();
+        /** @var Tenant\ScreenCampaign $screenCampaign */
+        $screenCampaign = $screen->getScreenCampaigns()->first();
+        $screenCampaignChecksums = $screenCampaign->getRelationsChecksum();
 
-        $playlist = $campaign->getCampaign();
+        $playlist = $screenCampaign->getCampaign();
         $playlistChecksums = $playlist->getRelationsChecksum();
 
         /** @var Tenant\Slide $slide */
-        $slide = $this->em->getRepository(Tenant\Slide::class)->findOneBy(['title' => 'slide_abc_1']);
+        $slide = $playlist->getPlaylistSlides()->first()->getSlide();
         $slideChecksums = $slide->getRelationsChecksum();
 
         $feed = $slide->getFeed();
@@ -83,9 +83,9 @@ public function testRelationsChecksumPropagation(): void
         $this->assertNotEquals($playlistChecksums['slides'], $playlist->getRelationsChecksum()['slides']);
         $this->assertFalse($playlist->isChanged());
 
-        $this->em->refresh($campaign);
-        $this->assertNotEquals($campaignChecksums['campaign'], $campaign->getRelationsChecksum()['campaign']);
-        $this->assertFalse($campaign->isChanged());
+        $this->em->refresh($screenCampaign);
+        $this->assertNotEquals($screenCampaignChecksums['campaign'], $screenCampaign->getRelationsChecksum()['campaign']);
+        $this->assertFalse($screenCampaign->isChanged());
 
         $this->em->refresh($screen);
         $this->assertNotEquals($screenChecksums['campaigns'], $screen->getRelationsChecksum()['campaigns']);