Merge pull request #307 from cultuurnet/III-3558-improve-file-get-con…

…tents-return-value III-3558 Improve `file_get_contents` return value
cultuurnet · Aug 22, 2024 · 04fb563 · 04fb563
2 parents 2ff9630 + d2933b5
commit 04fb563
Show file tree

Hide file tree

Showing 20 changed files with 69 additions and 31 deletions.
diff --git a/app/RoutingServiceProvider.php b/app/RoutingServiceProvider.php
@@ -6,6 +6,7 @@
 
 use CultureFeed;
 use CultureFeed_DefaultOAuthClient;
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Http\Authentication\Auth0\Auth0TokenGenerator;
 use CultuurNet\UDB3\Search\Http\Authentication\Auth0\Auth0MetadataGenerator;
 use CultuurNet\UDB3\Search\Http\Authentication\AuthenticateRequest;
@@ -63,7 +64,7 @@ function (): Router {
                         new InMemoryDefaultQueryRepository(
                             file_exists(__DIR__ . '/../default_queries.php') ? require __DIR__ . '/../default_queries.php' : []
                         ),
-                        file_get_contents('file://' . __DIR__ . '/../' . $pemFile)
+                        FileReader::read('file://' . __DIR__ . '/../' . $pemFile)
                     );
 
                     $logger = LoggerFactory::create($this->leagueContainer, LoggerName::forWeb());

diff --git a/src/ElasticSearch/Operations/AbstractMappingOperation.php b/src/ElasticSearch/Operations/AbstractMappingOperation.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\Operations;
 
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Json;
 
 abstract class AbstractMappingOperation extends AbstractElasticSearchOperation
@@ -15,7 +16,7 @@ protected function updateMapping(string $indexName, string $documentType, string
                 'index' => $indexName,
                 'type' => $documentType,
                 'body' => Json::decodeAssociatively(
-                    file_get_contents($mappingFilePath)
+                    FileReader::read($mappingFilePath)
                 ),
             ]
         );

diff --git a/src/ElasticSearch/Operations/CreateAutocompleteAnalyzer.php b/src/ElasticSearch/Operations/CreateAutocompleteAnalyzer.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\Operations;
 
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Json;
 
 final class CreateAutocompleteAnalyzer extends AbstractElasticSearchOperation
@@ -14,7 +15,7 @@ public function run(): void
             [
                 'name' => 'autocomplete_analyzer',
                 'body' => Json::decodeAssociatively(
-                    file_get_contents(__DIR__ . '/json/analyzer_autocomplete.json')
+                    FileReader::read(__DIR__ . '/json/analyzer_autocomplete.json')
                 ),
             ]
         );

diff --git a/src/ElasticSearch/Operations/CreateLowerCaseExactMatchAnalyzer.php b/src/ElasticSearch/Operations/CreateLowerCaseExactMatchAnalyzer.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\Operations;
 
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Json;
 
 final class CreateLowerCaseExactMatchAnalyzer extends AbstractElasticSearchOperation
@@ -14,7 +15,7 @@ public function run(): void
             [
                 'name' => 'lowercase_exact_match_analyzer',
                 'body' => Json::decodeAssociatively(
-                    file_get_contents(__DIR__ . '/json/analyzer_lowercase_exact_match.json')
+                    FileReader::read(__DIR__ . '/json/analyzer_lowercase_exact_match.json')
                 ),
             ]
         );

diff --git a/src/ElasticSearch/Operations/CreateLowerCaseStandardAnalyzer.php b/src/ElasticSearch/Operations/CreateLowerCaseStandardAnalyzer.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\Operations;
 
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Json;
 
 final class CreateLowerCaseStandardAnalyzer extends AbstractElasticSearchOperation
@@ -14,7 +15,7 @@ public function run(): void
             [
                 'name' => 'lowercase_standard_analyzer',
                 'body' => Json::decodeAssociatively(
-                    file_get_contents(__DIR__ . '/json/analyzer_lowercase_standard.json')
+                    FileReader::read(__DIR__ . '/json/analyzer_lowercase_standard.json')
                 ),
             ]
         );

diff --git a/src/FileReader.php b/src/FileReader.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace CultuurNet\UDB3\Search;
+
+final class FileReader
+{
+    public static function read(string $filepath): string
+    {
+        $content = file_get_contents($filepath);
+
+        if ($content === false) {
+            throw new \RuntimeException('Failed to read file ' . $filepath);
+        }
+
+        return $content;
+    }
+}
diff --git a/src/Http/Authentication/Token/ManagementTokenFileRepository.php b/src/Http/Authentication/Token/ManagementTokenFileRepository.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\Http\Authentication\Token;
 
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Json;
 use DateTimeImmutable;
 
@@ -22,7 +23,7 @@ public function get(): ?Token
             return null;
         }
 
-        $tokenAsArray = Json::decodeAssociatively(file_get_contents($this->fullFilePath));
+        $tokenAsArray = Json::decodeAssociatively(FileReader::read($this->fullFilePath));
 
         return new Token(
             $tokenAsArray['token'],

diff --git a/tests/AMQP/DomainMessageJSONDeserializerTest.php b/tests/AMQP/DomainMessageJSONDeserializerTest.php
@@ -5,6 +5,7 @@
 namespace CultuurNet\UDB3\Search\AMQP;
 
 use Broadway\Serializer\Serializable;
+use CultuurNet\UDB3\Search\FileReader;
 use InvalidArgumentException;
 use Broadway\Domain\DateTime;
 use Broadway\Domain\DomainMessage;
@@ -46,7 +47,7 @@ public function it_throws_an_error_if_payloadclass_does_not_implement_Serializab
      */
     public function it_can_deserialize_a_domain_message(): void
     {
-        $jsonData = file_get_contents(__DIR__ . '/Dummies/domain-message-dummy-event.json');
+        $jsonData = FileReader::read(__DIR__ . '/Dummies/domain-message-dummy-event.json');
 
         $expectedDomainMessage = new DomainMessage(
             'message-id-123',

diff --git a/tests/ElasticSearch/JsonDocument/EventTransformerTest.php b/tests/ElasticSearch/JsonDocument/EventTransformerTest.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\JsonDocument;
 
+use CultuurNet\UDB3\Search\FileReader;
 use DateTimeInterface;
 use Cake\Chronos\Chronos;
 use CultuurNet\UDB3\Search\ElasticSearch\PathEndIdUrlParser;
@@ -537,12 +538,12 @@ public function it_transforms_completeness(): void
 
     private function transformAndAssert(string $givenFilePath, string $expectedFilePath, array $expectedLogs = []): void
     {
-        $original = Json::decodeAssociatively(file_get_contents($givenFilePath));
+        $original = Json::decodeAssociatively(FileReader::read($givenFilePath));
 
         // Compare the expected and actual JSON as objects, not arrays. Some Elasticsearch fields expect an empty object
         // specifically instead of an empty array in some scenario's. But if we decode to arrays, empty JSON objects
         // become empty arrays in PHP.
-        $expected = Json::decode(file_get_contents($expectedFilePath));
+        $expected = Json::decode(FileReader::read($expectedFilePath));
         $actual = Json::decode(
             Json::encode(
                 $this->transformer->transform($original, [])

diff --git a/tests/ElasticSearch/JsonDocument/OrganizerTransformerTest.php b/tests/ElasticSearch/JsonDocument/OrganizerTransformerTest.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\JsonDocument;
 
+use CultuurNet\UDB3\Search\FileReader;
 use DateTimeInterface;
 use Cake\Chronos\Chronos;
 use CultuurNet\UDB3\Search\ElasticSearch\PathEndIdUrlParser;
@@ -151,7 +152,7 @@ public function it_indexes_educational_descriptions(): void
     public function it_should_log_warnings_if_an_address_translation_is_incomplete(): void
     {
         $original = Json::decodeAssociatively(
-            file_get_contents(__DIR__ . '/data/organizer/original_with_incomplete_translated_address.json')
+            FileReader::read(__DIR__ . '/data/organizer/original_with_incomplete_translated_address.json')
         );
 
         $expectedLogs = [
@@ -199,12 +200,12 @@ public function it_handles_completeness(): void
 
     private function transformAndAssert(string $givenFilePath, string $expectedFilePath, array $expectedLogs = []): void
     {
-        $original = Json::decodeAssociatively(file_get_contents($givenFilePath));
+        $original = Json::decodeAssociatively(FileReader::read($givenFilePath));
 
         // Compare the expected and actual JSON as objects, not arrays. Some Elasticsearch fields expect an empty object
         // specifically instead of an empty array in some scenario's. But if we decode to arrays, empty JSON objects
         // become empty arrays in PHP.
-        $expected = Json::decode(file_get_contents($expectedFilePath));
+        $expected = Json::decode(FileReader::read($expectedFilePath));
         $actual = Json::decode(
             Json::encode(
                 $this->transformer->transform($original, [])

diff --git a/tests/ElasticSearch/JsonDocument/PlaceTransformerTest.php b/tests/ElasticSearch/JsonDocument/PlaceTransformerTest.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\JsonDocument;
 
+use CultuurNet\UDB3\Search\FileReader;
 use DateTimeInterface;
 use Cake\Chronos\Chronos;
 use CultuurNet\UDB3\Search\ElasticSearch\PathEndIdUrlParser;
@@ -99,7 +100,7 @@ public function it_logs_missing_required_fields(): void
      */
     public function it_should_log_a_warning_if_address_is_not_found_in_the_main_language(): void
     {
-        $original = file_get_contents(__DIR__ . '/data/place/original-without-address-in-main-language.json');
+        $original = FileReader::read(__DIR__ . '/data/place/original-without-address-in-main-language.json');
 
         $expectedLogs = [
             ['warning', "Missing expected field 'address.nl'.", []],
@@ -115,7 +116,7 @@ public function it_should_log_a_warning_if_address_is_not_found_in_the_main_lang
      */
     public function it_should_log_warnings_if_an_address_translation_is_incomplete(): void
     {
-        $original = file_get_contents(__DIR__ . '/data/place/original-with-incomplete-address-translation.json');
+        $original = FileReader::read(__DIR__ . '/data/place/original-with-incomplete-address-translation.json');
 
         $expectedLogs = [
             ['warning', "Missing expected field 'address.fr.addressCountry'.", []],
@@ -311,12 +312,12 @@ public function it_transforms_completeness(): void
 
     private function transformAndAssert(string $givenFilePath, string $expectedFilePath, array $expectedLogs = []): void
     {
-        $original = Json::decodeAssociatively(file_get_contents($givenFilePath));
+        $original = Json::decodeAssociatively(FileReader::read($givenFilePath));
 
         // Compare the expected and actual JSON as objects, not arrays. Some Elasticsearch fields expect an empty object
         // specifically instead of an empty array in some scenario's. But if we decode to arrays, empty JSON objects
         // become empty arrays in PHP.
-        $expected = Json::decode(file_get_contents($expectedFilePath));
+        $expected = Json::decode(FileReader::read($expectedFilePath));
         $actual = Json::decode(
             Json::encode(
                 $this->transformer->transform($original, [])

diff --git a/tests/ElasticSearch/Operations/AbstractReindexUDB3CoreTest.php b/tests/ElasticSearch/Operations/AbstractReindexUDB3CoreTest.php
@@ -7,6 +7,7 @@
 use Broadway\Domain\DomainEventStream;
 use Broadway\EventHandling\EventBus;
 use CultuurNet\UDB3\Search\Event\EventProjectedToJSONLD;
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Json;
 use CultuurNet\UDB3\Search\Organizer\OrganizerProjectedToJSONLD;
 use CultuurNet\UDB3\Search\Place\PlaceProjectedToJSONLD;
@@ -411,7 +412,7 @@ function (DomainEventStream $stream) use (&$actualEvents): void {
 
     private function getJsonDocumentAsElasticSearchResults(string $filePath): array
     {
-        $contents = file_get_contents($filePath);
+        $contents = FileReader::read($filePath);
         return Json::decodeAssociatively($contents);
     }
 }
diff --git a/tests/ElasticSearch/Operations/IndexRegionsTest.php b/tests/ElasticSearch/Operations/IndexRegionsTest.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\Operations;
 
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Json;
 use Elasticsearch\Client;
 use Psr\Log\LoggerInterface;
@@ -41,7 +42,7 @@ public function it_indexes_all_files_located_in_the_given_path_or_subdirectories
                         'id' => 'gem-antwerpen',
                         'type' => 'region',
                         'body' => Json::decodeAssociatively(
-                            file_get_contents(__DIR__ . '/data/regions/municipalities/gem-antwerpen.json')
+                            FileReader::read(__DIR__ . '/data/regions/municipalities/gem-antwerpen.json')
                         ),
                     ],
                 ],
@@ -51,7 +52,7 @@ public function it_indexes_all_files_located_in_the_given_path_or_subdirectories
                         'id' => 'gem-leuven',
                         'type' => 'region',
                         'body' => Json::decodeAssociatively(
-                            file_get_contents(__DIR__ . '/data/regions/municipalities/gem-leuven.json')
+                            FileReader::read(__DIR__ . '/data/regions/municipalities/gem-leuven.json')
                         ),
                     ],
                 ],
@@ -61,7 +62,7 @@ public function it_indexes_all_files_located_in_the_given_path_or_subdirectories
                         'id' => 'prov-vlaams-brabant',
                         'type' => 'region',
                         'body' => Json::decodeAssociatively(
-                            file_get_contents(__DIR__ . '/data/regions/provinces/prov-vlaams-brabant.json')
+                            FileReader::read(__DIR__ . '/data/regions/provinces/prov-vlaams-brabant.json')
                         ),
                     ],
                 ]

diff --git a/tests/ElasticSearch/Operations/UpdateEventMappingTest.php b/tests/ElasticSearch/Operations/UpdateEventMappingTest.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\Operations;
 
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Json;
 use Elasticsearch\Client;
 use Psr\Log\LoggerInterface;
@@ -23,7 +24,7 @@ protected function getDocumentType(): string
     protected function getExpectedMappingBody(): array
     {
         return Json::decodeAssociatively(
-            file_get_contents(__DIR__ . '/../../../src/ElasticSearch/Operations/json/mapping_event.json')
+            FileReader::read(__DIR__ . '/../../../src/ElasticSearch/Operations/json/mapping_event.json')
         );
     }
 

diff --git a/tests/ElasticSearch/Operations/UpdateOrganizerMappingTest.php b/tests/ElasticSearch/Operations/UpdateOrganizerMappingTest.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\Operations;
 
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Json;
 use Elasticsearch\Client;
 use Psr\Log\LoggerInterface;
@@ -23,7 +24,7 @@ protected function getDocumentType(): string
     protected function getExpectedMappingBody(): array
     {
         return Json::decodeAssociatively(
-            file_get_contents(__DIR__ . '/../../../src/ElasticSearch/Operations/json/mapping_organizer.json')
+            FileReader::read(__DIR__ . '/../../../src/ElasticSearch/Operations/json/mapping_organizer.json')
         );
     }
 

diff --git a/tests/ElasticSearch/Operations/UpdatePlaceMappingTest.php b/tests/ElasticSearch/Operations/UpdatePlaceMappingTest.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\Operations;
 
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Json;
 use Elasticsearch\Client;
 use Psr\Log\LoggerInterface;
@@ -23,7 +24,7 @@ protected function getDocumentType(): string
     protected function getExpectedMappingBody(): array
     {
         return Json::decodeAssociatively(
-            file_get_contents(__DIR__ . '/../../../src/ElasticSearch/Operations/json/mapping_place.json')
+            FileReader::read(__DIR__ . '/../../../src/ElasticSearch/Operations/json/mapping_place.json')
         );
     }
 

diff --git a/tests/ElasticSearch/Region/GeoShapeQueryRegionServiceTest.php b/tests/ElasticSearch/Region/GeoShapeQueryRegionServiceTest.php
@@ -4,6 +4,7 @@
 
 namespace CultuurNet\UDB3\Search\ElasticSearch\Region;
 
+use CultuurNet\UDB3\Search\FileReader;
 use RuntimeException;
 use CultuurNet\UDB3\Search\Json;
 use CultuurNet\UDB3\Search\Region\RegionId;
@@ -97,8 +98,8 @@ public function it_uses_a_percolate_query_and_returns_all_region_ids_of_the_matc
                 ]
             )
             ->willReturnOnConsecutiveCalls(
-                Json::decodeAssociatively(file_get_contents(__DIR__ . '/data/regions_1.json')),
-                Json::decodeAssociatively(file_get_contents(__DIR__ . '/data/regions_2.json'))
+                Json::decodeAssociatively(FileReader::read(__DIR__ . '/data/regions_1.json')),
+                Json::decodeAssociatively(FileReader::read(__DIR__ . '/data/regions_2.json'))
             );
 
         $expectedRegionIds = [
@@ -141,7 +142,7 @@ public function it_throws_an_exception_if_it_gets_an_invalid_response_from_elast
     {
         $this->client->expects($this->once())
             ->method('search')
-            ->willReturn(Json::decodeAssociatively(file_get_contents(__DIR__ . '/data/regions_invalid.json')));
+            ->willReturn(Json::decodeAssociatively(FileReader::read(__DIR__ . '/data/regions_invalid.json')));
 
         $this->expectException(RuntimeException::class);
 

diff --git a/tests/Http/Authentication/AuthenticateRequestTest.php b/tests/Http/Authentication/AuthenticateRequestTest.php
@@ -6,6 +6,7 @@
 
 use Crell\ApiProblem\ApiProblem;
 use CultureFeed_Consumer;
+use CultuurNet\UDB3\Search\FileReader;
 use CultuurNet\UDB3\Search\Http\Authentication\ApiProblems\BlockedApiKey;
 use CultuurNet\UDB3\Search\Http\Authentication\ApiProblems\InvalidApiKey;
 use CultuurNet\UDB3\Search\Http\Authentication\ApiProblems\InvalidToken;
@@ -66,7 +67,7 @@ protected function setUp(): void
 
         $this->cultureFeed = $this->createMock(ICultureFeed::class);
 
-        $this->pemFile = file_get_contents(__DIR__ . '/samples/public.pem');
+        $this->pemFile = FileReader::read(__DIR__ . '/samples/public.pem');
 
         $managementToken = new Token(
             'my_auth0_token',