function DbLogResourceTest::testWatchdog

Same name and namespace in other branches
  1. 9 core/modules/hal/tests/src/Functional/dblog/DbLogResourceTest.php \Drupal\Tests\hal\Functional\dblog\DbLogResourceTest::testWatchdog()
  2. 8.9.x core/modules/dblog/tests/src/Functional/DbLogResourceTest.php \Drupal\Tests\dblog\Functional\DbLogResourceTest::testWatchdog()
  3. 10 core/modules/dblog/tests/src/Functional/DbLogResourceTest.php \Drupal\Tests\dblog\Functional\DbLogResourceTest::testWatchdog()

Writes a log messages and retrieves it via the REST API.

File

core/modules/dblog/tests/src/Functional/DbLogResourceTest.php, line 63

Class

DbLogResourceTest
Tests the watchdog database log resource.

Namespace

Drupal\Tests\dblog\Functional

Code

public function testWatchdog() : void {
    // Write a log message to the DB.
    $this->container
        ->get('logger.channel.rest')
        ->notice('Test message');
    // Get the ID of the written message.
    $id = Database::getConnection()->select('watchdog', 'w')
        ->fields('w', [
        'wid',
    ])
        ->condition('type', 'rest')
        ->orderBy('wid', 'DESC')
        ->range(0, 1)
        ->execute()
        ->fetchField();
    $this->initAuthentication();
    $url = Url::fromRoute('rest.dblog.GET', [
        'id' => $id,
        '_format' => static::$format,
    ]);
    $request_options = $this->getAuthenticationRequestOptions('GET');
    $response = $this->request('GET', $url, $request_options);
    $this->assertResourceErrorResponse(403, "The 'restful get dblog' permission is required.", $response, [
        '4xx-response',
        'http_response',
    ], [
        'user.permissions',
    ]);
    // Create a user account that has the required permissions to read
    // the watchdog resource via the REST API.
    $this->setUpAuthorization('GET');
    $response = $this->request('GET', $url, $request_options);
    $this->assertResourceResponse(200, FALSE, $response, [
        'config:rest.resource.dblog',
        'http_response',
    ], [
        'user.permissions',
    ], FALSE, 'MISS');
    $log = Json::decode((string) $response->getBody());
    $this->assertEquals($id, $log['wid'], 'Log ID is correct.');
    $this->assertEquals('rest', $log['type'], 'Type of log message is correct.');
    $this->assertEquals('Test message', $log['message'], 'Log message text is correct.');
    // Request an unknown log entry.
    $url->setRouteParameter('id', 9999);
    $response = $this->request('GET', $url, $request_options);
    $this->assertResourceErrorResponse(404, "Log entry with ID '9999' was not found", $response);
    // Make a bad request (a true malformed request would never be a route
    // match).
    $url->setRouteParameter('id', 0);
    $response = $this->request('GET', $url, $request_options);
    $this->assertResourceErrorResponse(400, 'No log entry ID was provided', $response);
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.