Merge pull request #104 from CollaboraOnline/timing-error-in-tests

Timing error in tests

Author: donquixote

Diff for: tests/src/Kernel/Controller/WopiControllerTest.php

@@ -71,11 +71,11 @@ public function testWopiGetFileInfo(): void {
     ];
 
     $request = $this->createRequest();
-    $this->assertJsonResponseOk($expected_response_data, $request);
+    $this->assertSame($expected_response_data, $this->assertJsonResponseOk($request));
 
     $request = $this->createRequest(write: TRUE);
     $expected_response_data['UserCanWrite'] = TRUE;
-    $this->assertJsonResponseOk($expected_response_data, $request);
+    $this->assertSame($expected_response_data, $this->assertJsonResponseOk($request));
 
     // Create a user picture, and attach it to the user.
     $user_picture_file = $this->createUserPicture($this->user);
@@ -89,7 +89,7 @@ public function testWopiGetFileInfo(): void {
     $expected_response_data['UserExtraInfo']['avatar'] = 'http://localhost/' . $user_picture_realpath;
 
     $request = $this->createRequest();
-    $this->assertJsonResponseOk($expected_response_data, $request);
+    $this->assertSame($expected_response_data, $this->assertJsonResponseOk($request));
   }
 
   /**
@@ -216,17 +216,21 @@ protected function doTestWopiPutFile(
     $request->headers->add($request_headers);
 
     $request_time = \Drupal::time()->getRequestTime();
-    $this->assertJsonResponseOk(
-      [
-        'LastModifiedTime' => DateTimeHelper::format($request_time),
-      ],
-      $request,
-    );
+    $response_data = $this->assertJsonResponseOk($request);
 
     $media = Media::load($this->media->id());
     $file = $this->loadCurrentMediaFile();
 
+    $this->assertSame([
+      'LastModifiedTime' => DateTimeHelper::format($file->getChangedTime()),
+    ], $response_data);
+
     // File entity and content are updated.
+    // The changed timestamp in $file is filled from TestTime->getRequestTime(),
+    // which should always produce the same result during one request/process,
+    // but does not, due to a bug in datetime_testing.
+    // See https://www.drupal.org/project/datetime_testing/issues/3513073
+    $this->assertLessThanOrEqual(1, abs($request_time - $file->getChangedTime()));
     $this->assertSame($request_time, $file->getChangedTime());
     $actual_file_content = file_get_contents($file->getFileUri());
     $this->assertSame($new_file_content, $actual_file_content);
@@ -326,12 +330,11 @@ public function testWopiPutFileConflict(): void {
     $wopi_changed_time = \DateTimeImmutable::createFromFormat('U', (string) ($this->file->getChangedTime() + 1000));
     $request->headers->set('x-cool-wopi-timestamp', $wopi_changed_time->format(\DateTimeInterface::ATOM));
 
-    $this->assertJsonResponse(
-      Response::HTTP_CONFLICT,
+    $this->assertSame(
       [
         'COOLStatusCode' => 1010,
       ],
-      $request,
+      $this->assertJsonResponse(Response::HTTP_CONFLICT, $request),
     );
     $this->assertLogMessage(
       RfcLogLevel::ERROR,

Diff for: tests/src/Kernel/Controller/WopiControllerTestBase.php

@@ -208,30 +208,32 @@ protected function createAccessToken(?int $fid = NULL, ?int $uid = NULL, bool $w
   /**
    * Asserts a successful json response given a request.
    *
-   * @param array $expected_data
-   *   The expected response JSON data.
    * @param \Symfony\Component\HttpFoundation\Request $request
    *   The request to perform.
    * @param string $message
    *   Message to distinguish this from other assertions.
+   *
+   * @return array
+   *   Response data, parsed from json.
    */
-  protected function assertJsonResponseOk(array $expected_data, Request $request, string $message = ''): void {
-    $this->assertJsonResponse(Response::HTTP_OK, $expected_data, $request, $message);
+  protected function assertJsonResponseOk(Request $request, string $message = ''): array {
+    return $this->assertJsonResponse(Response::HTTP_OK, $request, $message);
   }
 
   /**
    * Asserts a json response given a request.
    *
    * @param int $expected_code
    *   The expected response status code.
-   * @param array $expected_data
-   *   The expected response JSON data.
    * @param \Symfony\Component\HttpFoundation\Request $request
    *   The request to perform.
    * @param string $message
    *   Message to distinguish this from other assertions.
+   *
+   * @return array
+   *   The response data, parsed from json.
    */
-  protected function assertJsonResponse(int $expected_code, array $expected_data, Request $request, string $message = ''): void {
+  protected function assertJsonResponse(int $expected_code, Request $request, string $message = ''): array {
     $response = $this->handleRequest($request);
     $content = $response->getContent();
     $this->assertIsString($content);
@@ -240,7 +242,7 @@ protected function assertJsonResponse(int $expected_code, array $expected_data,
     $this->assertEquals('application/json', $response->headers->get('Content-Type'), $extended_message);
     $data = Json::decode($content);
     $this->assertNotNull($data, $extended_message);
-    $this->assertSame($expected_data, $data, $message);
+    return $data;
   }
 
   /**