Chris@0: defaultFormat = 'hal_json';
Chris@0: $this->defaultMimeType = 'application/hal+json';
Chris@0: $this->defaultAuth = ['cookie'];
Chris@0: $this->resourceConfigStorage = $this->container->get('entity_type.manager')->getStorage('rest_resource_config');
Chris@0: // Create a test content type for node testing.
Chris@0: if (in_array('node', static::$modules)) {
Chris@0: $this->drupalCreateContentType(['name' => 'resttest', 'type' => 'resttest']);
Chris@0: }
Chris@0:
Chris@0: $this->cookieFile = $this->publicFilesDirectory . '/cookie.jar';
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Calculates cookies used by guzzle later.
Chris@0: *
Chris@0: * @return \GuzzleHttp\Cookie\CookieJarInterface
Chris@0: * The used CURL options in guzzle.
Chris@0: */
Chris@0: protected function cookies() {
Chris@0: $cookies = [];
Chris@0:
Chris@0: foreach ($this->cookies as $key => $cookie) {
Chris@0: $cookies[$key][] = $cookie['value'];
Chris@0: }
Chris@0:
Chris@0: $request = \Drupal::request();
Chris@0: $cookies = NestedArray::mergeDeep($cookies, $this->extractCookiesFromRequest($request));
Chris@0:
Chris@0: $cookie_jar = new FileCookieJar($this->cookieFile);
Chris@0: foreach ($cookies as $key => $cookie_values) {
Chris@0: foreach ($cookie_values as $cookie_value) {
Chris@0: // setcookie() sets the value of a cookie to be deleted, when its gonna
Chris@0: // be removed.
Chris@0: if ($cookie_value !== 'deleted') {
Chris@0: $cookie_jar->setCookie(new SetCookie(['Name' => $key, 'Value' => $cookie_value, 'Domain' => $request->getHost()]));
Chris@0: }
Chris@0: }
Chris@0: }
Chris@0:
Chris@0: return $cookie_jar;
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Helper function to issue a HTTP request with simpletest's cURL.
Chris@0: *
Chris@0: * @param string|\Drupal\Core\Url $url
Chris@0: * A Url object or system path.
Chris@0: * @param string $method
Chris@0: * HTTP method, one of GET, POST, PUT or DELETE.
Chris@0: * @param string $body
Chris@0: * The body for POST and PUT.
Chris@0: * @param string $mime_type
Chris@0: * The MIME type of the transmitted content.
Chris@0: * @param bool $csrf_token
Chris@0: * If NULL, a CSRF token will be retrieved and used. If FALSE, omit the
Chris@0: * X-CSRF-Token request header (to simulate developer error). Otherwise, the
Chris@0: * passed in value will be used as the value for the X-CSRF-Token request
Chris@0: * header (to simulate developer error, by sending an invalid CSRF token).
Chris@0: *
Chris@0: * @return string
Chris@0: * The content returned from the request.
Chris@0: */
Chris@0: protected function httpRequest($url, $method, $body = NULL, $mime_type = NULL, $csrf_token = NULL) {
Chris@0: if (!isset($mime_type)) {
Chris@0: $mime_type = $this->defaultMimeType;
Chris@0: }
Chris@0: if (!in_array($method, ['GET', 'HEAD', 'OPTIONS', 'TRACE'])) {
Chris@0: // GET the CSRF token first for writing requests.
Chris@0: $requested_token = $this->drupalGet('session/token');
Chris@0: }
Chris@0:
Chris@0: $client = \Drupal::httpClient();
Chris@0: $url = $this->buildUrl($url);
Chris@0:
Chris@0: $options = [
Chris@0: 'http_errors' => FALSE,
Chris@0: 'cookies' => $this->cookies(),
Chris@0: 'curl' => [
Chris@0: CURLOPT_HEADERFUNCTION => [&$this, 'curlHeaderCallback'],
Chris@0: ],
Chris@0: ];
Chris@0: switch ($method) {
Chris@0: case 'GET':
Chris@0: $options += [
Chris@0: 'headers' => [
Chris@0: 'Accept' => $mime_type,
Chris@0: ],
Chris@0: ];
Chris@0: $response = $client->get($url, $options);
Chris@0: break;
Chris@0:
Chris@0: case 'HEAD':
Chris@0: $response = $client->head($url, $options);
Chris@0: break;
Chris@0:
Chris@0: case 'POST':
Chris@0: $options += [
Chris@0: 'headers' => $csrf_token !== FALSE ? [
Chris@0: 'Content-Type' => $mime_type,
Chris@0: 'X-CSRF-Token' => ($csrf_token === NULL ? $requested_token : $csrf_token),
Chris@0: ] : [
Chris@0: 'Content-Type' => $mime_type,
Chris@0: ],
Chris@0: 'body' => $body,
Chris@0: ];
Chris@0: $response = $client->post($url, $options);
Chris@0: break;
Chris@0:
Chris@0: case 'PUT':
Chris@0: $options += [
Chris@0: 'headers' => $csrf_token !== FALSE ? [
Chris@0: 'Content-Type' => $mime_type,
Chris@0: 'X-CSRF-Token' => ($csrf_token === NULL ? $requested_token : $csrf_token),
Chris@0: ] : [
Chris@0: 'Content-Type' => $mime_type,
Chris@0: ],
Chris@0: 'body' => $body,
Chris@0: ];
Chris@0: $response = $client->put($url, $options);
Chris@0: break;
Chris@0:
Chris@0: case 'PATCH':
Chris@0: $options += [
Chris@0: 'headers' => $csrf_token !== FALSE ? [
Chris@0: 'Content-Type' => $mime_type,
Chris@0: 'X-CSRF-Token' => ($csrf_token === NULL ? $requested_token : $csrf_token),
Chris@0: ] : [
Chris@0: 'Content-Type' => $mime_type,
Chris@0: ],
Chris@0: 'body' => $body,
Chris@0: ];
Chris@0: $response = $client->patch($url, $options);
Chris@0: break;
Chris@0:
Chris@0: case 'DELETE':
Chris@0: $options += [
Chris@0: 'headers' => $csrf_token !== FALSE ? [
Chris@0: 'Content-Type' => $mime_type,
Chris@0: 'X-CSRF-Token' => ($csrf_token === NULL ? $requested_token : $csrf_token),
Chris@0: ] : [],
Chris@0: ];
Chris@0: $response = $client->delete($url, $options);
Chris@0: break;
Chris@0: }
Chris@0:
Chris@0: $this->response = $response;
Chris@0: $this->responseBody = (string) $response->getBody();
Chris@0: $this->setRawContent($this->responseBody);
Chris@0:
Chris@0: // Ensure that any changes to variables in the other thread are picked up.
Chris@0: $this->refreshVariables();
Chris@0:
Chris@0: $this->verbose($method . ' request to: ' . $url .
Chris@0: '
Code: ' . $this->response->getStatusCode() .
Chris@0: (isset($options['headers']) ? '
Request headers: ' . nl2br(print_r($options['headers'], TRUE)) : '') .
Chris@0: (isset($options['body']) ? '
Request body: ' . nl2br(print_r($options['body'], TRUE)) : '') .
Chris@0: '
Response headers: ' . nl2br(print_r($response->getHeaders(), TRUE)) .
Chris@0: '
Response body: ' . $this->responseBody);
Chris@0:
Chris@0: return $this->responseBody;
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * {@inheritdoc}
Chris@0: */
Chris@0: protected function assertResponse($code, $message = '', $group = 'Browser') {
Chris@0: if (!isset($this->response)) {
Chris@0: return parent::assertResponse($code, $message, $group);
Chris@0: }
Chris@0: return $this->assertEqual($code, $this->response->getStatusCode(), $message ? $message : "HTTP response expected $code, actual {$this->response->getStatusCode()}", $group);
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * {@inheritdoc}
Chris@0: */
Chris@0: protected function drupalGetHeaders($all_requests = FALSE) {
Chris@0: if (!isset($this->response)) {
Chris@0: return parent::drupalGetHeaders($all_requests);
Chris@0: }
Chris@0: $lowercased_keys = array_map('strtolower', array_keys($this->response->getHeaders()));
Chris@0: return array_map(function (array $header) {
Chris@0: return implode(', ', $header);
Chris@0: }, array_combine($lowercased_keys, array_values($this->response->getHeaders())));
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * {@inheritdoc}
Chris@0: */
Chris@0: protected function drupalGetHeader($name, $all_requests = FALSE) {
Chris@0: if (!isset($this->response)) {
Chris@0: return parent::drupalGetHeader($name, $all_requests);
Chris@0: }
Chris@0: if ($header = $this->response->getHeader($name)) {
Chris@0: return implode(', ', $header);
Chris@0: }
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Creates entity objects based on their types.
Chris@0: *
Chris@0: * @param string $entity_type
Chris@0: * The type of the entity that should be created.
Chris@0: *
Chris@0: * @return \Drupal\Core\Entity\EntityInterface
Chris@0: * The new entity object.
Chris@0: */
Chris@0: protected function entityCreate($entity_type) {
Chris@0: return $this->container->get('entity_type.manager')
Chris@0: ->getStorage($entity_type)
Chris@0: ->create($this->entityValues($entity_type));
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Provides an array of suitable property values for an entity type.
Chris@0: *
Chris@0: * Required properties differ from entity type to entity type, so we keep a
Chris@0: * minimum mapping here.
Chris@0: *
Chris@0: * @param string $entity_type_id
Chris@0: * The ID of the type of entity that should be created.
Chris@0: *
Chris@0: * @return array
Chris@0: * An array of values keyed by property name.
Chris@0: */
Chris@0: protected function entityValues($entity_type_id) {
Chris@0: switch ($entity_type_id) {
Chris@0: case 'entity_test':
Chris@0: return [
Chris@0: 'name' => $this->randomMachineName(),
Chris@0: 'user_id' => 1,
Chris@0: 'field_test_text' => [
Chris@0: 0 => [
Chris@0: 'value' => $this->randomString(),
Chris@0: 'format' => 'plain_text',
Chris@0: ],
Chris@0: ],
Chris@0: ];
Chris@0: case 'config_test':
Chris@0: return [
Chris@0: 'id' => $this->randomMachineName(),
Chris@0: 'label' => 'Test label',
Chris@0: ];
Chris@0: case 'node':
Chris@0: return ['title' => $this->randomString(), 'type' => 'resttest'];
Chris@0: case 'node_type':
Chris@0: return [
Chris@0: 'type' => 'article',
Chris@0: 'name' => $this->randomMachineName(),
Chris@0: ];
Chris@0: case 'user':
Chris@0: return ['name' => $this->randomMachineName()];
Chris@0:
Chris@0: case 'comment':
Chris@0: return [
Chris@0: 'subject' => $this->randomMachineName(),
Chris@0: 'entity_type' => 'node',
Chris@0: 'comment_type' => 'comment',
Chris@0: 'comment_body' => $this->randomString(),
Chris@0: 'entity_id' => 'invalid',
Chris@0: 'field_name' => 'comment',
Chris@0: ];
Chris@0: case 'taxonomy_vocabulary':
Chris@0: return [
Chris@0: 'vid' => 'tags',
Chris@0: 'name' => $this->randomMachineName(),
Chris@0: ];
Chris@0: case 'block':
Chris@0: // Block placements depend on themes, ensure Bartik is installed.
Chris@0: $this->container->get('theme_installer')->install(['bartik']);
Chris@0: return [
Chris@0: 'id' => strtolower($this->randomMachineName(8)),
Chris@0: 'plugin' => 'system_powered_by_block',
Chris@0: 'theme' => 'bartik',
Chris@0: 'region' => 'header',
Chris@0: ];
Chris@0: default:
Chris@0: if ($this->isConfigEntity($entity_type_id)) {
Chris@0: return $this->configEntityValues($entity_type_id);
Chris@0: }
Chris@0: return [];
Chris@0: }
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Enables the REST service interface for a specific entity type.
Chris@0: *
Chris@0: * @param string|false $resource_type
Chris@0: * The resource type that should get REST API enabled or FALSE to disable all
Chris@0: * resource types.
Chris@0: * @param string $method
Chris@0: * The HTTP method to enable, e.g. GET, POST etc.
Chris@0: * @param string|array $format
Chris@0: * (Optional) The serialization format, e.g. hal_json, or a list of formats.
Chris@0: * @param array $auth
Chris@0: * (Optional) The list of valid authentication methods.
Chris@0: */
Chris@0: protected function enableService($resource_type, $method = 'GET', $format = NULL, array $auth = []) {
Chris@0: if ($resource_type) {
Chris@0: // Enable REST API for this entity type.
Chris@0: $resource_config_id = str_replace(':', '.', $resource_type);
Chris@0: // get entity by id
Chris@0: /** @var \Drupal\rest\RestResourceConfigInterface $resource_config */
Chris@0: $resource_config = $this->resourceConfigStorage->load($resource_config_id);
Chris@0: if (!$resource_config) {
Chris@0: $resource_config = $this->resourceConfigStorage->create([
Chris@0: 'id' => $resource_config_id,
Chris@0: 'granularity' => RestResourceConfigInterface::METHOD_GRANULARITY,
Chris@17: 'configuration' => [],
Chris@0: ]);
Chris@0: }
Chris@0: $configuration = $resource_config->get('configuration');
Chris@0:
Chris@0: if (is_array($format)) {
Chris@0: for ($i = 0; $i < count($format); $i++) {
Chris@0: $configuration[$method]['supported_formats'][] = $format[$i];
Chris@0: }
Chris@0: }
Chris@0: else {
Chris@0: if ($format == NULL) {
Chris@0: $format = $this->defaultFormat;
Chris@0: }
Chris@0: $configuration[$method]['supported_formats'][] = $format;
Chris@0: }
Chris@0:
Chris@0: if (!is_array($auth) || empty($auth)) {
Chris@0: $auth = $this->defaultAuth;
Chris@0: }
Chris@0: foreach ($auth as $auth_provider) {
Chris@0: $configuration[$method]['supported_auth'][] = $auth_provider;
Chris@0: }
Chris@0:
Chris@0: $resource_config->set('configuration', $configuration);
Chris@0: $resource_config->save();
Chris@0: }
Chris@0: else {
Chris@0: foreach ($this->resourceConfigStorage->loadMultiple() as $resource_config) {
Chris@0: $resource_config->delete();
Chris@0: }
Chris@0: }
Chris@0: $this->rebuildCache();
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Rebuilds routing caches.
Chris@0: */
Chris@0: protected function rebuildCache() {
Chris@0: $this->container->get('router.builder')->rebuildIfNeeded();
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * {@inheritdoc}
Chris@0: *
Chris@0: * This method is overridden to deal with a cURL quirk: the usage of
Chris@0: * CURLOPT_CUSTOMREQUEST cannot be unset on the cURL handle, so we need to
Chris@0: * override it every time it is omitted.
Chris@0: */
Chris@0: protected function curlExec($curl_options, $redirect = FALSE) {
Chris@0: unset($this->response);
Chris@0:
Chris@0: if (!isset($curl_options[CURLOPT_CUSTOMREQUEST])) {
Chris@0: if (!empty($curl_options[CURLOPT_HTTPGET])) {
Chris@0: $curl_options[CURLOPT_CUSTOMREQUEST] = 'GET';
Chris@0: }
Chris@0: if (!empty($curl_options[CURLOPT_POST])) {
Chris@0: $curl_options[CURLOPT_CUSTOMREQUEST] = 'POST';
Chris@0: }
Chris@0: }
Chris@0: return parent::curlExec($curl_options, $redirect);
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Provides the necessary user permissions for entity operations.
Chris@0: *
Chris@0: * @param string $entity_type_id
Chris@0: * The entity type.
Chris@0: * @param string $operation
Chris@0: * The operation, one of 'view', 'create', 'update' or 'delete'.
Chris@0: *
Chris@0: * @return array
Chris@0: * The set of user permission strings.
Chris@0: */
Chris@0: protected function entityPermissions($entity_type_id, $operation) {
Chris@0: switch ($entity_type_id) {
Chris@0: case 'entity_test':
Chris@0: switch ($operation) {
Chris@0: case 'view':
Chris@0: return ['view test entity'];
Chris@0: case 'create':
Chris@0: case 'update':
Chris@0: case 'delete':
Chris@0: return ['administer entity_test content'];
Chris@0: }
Chris@0: case 'node':
Chris@0: switch ($operation) {
Chris@0: case 'view':
Chris@0: return ['access content'];
Chris@0: case 'create':
Chris@0: return ['create resttest content'];
Chris@0: case 'update':
Chris@0: return ['edit any resttest content'];
Chris@0: case 'delete':
Chris@0: return ['delete any resttest content'];
Chris@0: }
Chris@0:
Chris@0: case 'comment':
Chris@0: switch ($operation) {
Chris@0: case 'view':
Chris@0: return ['access comments'];
Chris@0:
Chris@0: case 'create':
Chris@0: return ['post comments', 'skip comment approval'];
Chris@0:
Chris@0: case 'update':
Chris@0: return ['edit own comments'];
Chris@0:
Chris@0: case 'delete':
Chris@0: return ['administer comments'];
Chris@0: }
Chris@0: break;
Chris@0:
Chris@0: case 'user':
Chris@0: switch ($operation) {
Chris@0: case 'view':
Chris@0: return ['access user profiles'];
Chris@0:
Chris@0: default:
Chris@0: return ['administer users'];
Chris@0: }
Chris@0:
Chris@0: default:
Chris@0: if ($this->isConfigEntity($entity_type_id)) {
Chris@0: $entity_type = \Drupal::entityTypeManager()->getDefinition($entity_type_id);
Chris@0: if ($admin_permission = $entity_type->getAdminPermission()) {
Chris@0: return [$admin_permission];
Chris@0: }
Chris@0: }
Chris@0: }
Chris@0: return [];
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Loads an entity based on the location URL returned in the location header.
Chris@0: *
Chris@0: * @param string $location_url
Chris@0: * The URL returned in the Location header.
Chris@0: *
Chris@0: * @return \Drupal\Core\Entity\Entity|false
Chris@0: * The entity or FALSE if there is no matching entity.
Chris@0: */
Chris@0: protected function loadEntityFromLocationHeader($location_url) {
Chris@0: $url_parts = explode('/', $location_url);
Chris@0: $id = end($url_parts);
Chris@0: return $this->container->get('entity_type.manager')
Chris@0: ->getStorage($this->testEntityType)->load($id);
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Remove node fields that can only be written by an admin user.
Chris@0: *
Chris@0: * @param \Drupal\node\NodeInterface $node
Chris@0: * The node to remove fields where non-administrative users cannot write.
Chris@0: *
Chris@0: * @return \Drupal\node\NodeInterface
Chris@0: * The node with removed fields.
Chris@0: */
Chris@0: protected function removeNodeFieldsForNonAdminUsers(NodeInterface $node) {
Chris@0: $node->set('status', NULL);
Chris@0: $node->set('created', NULL);
Chris@0: $node->set('changed', NULL);
Chris@0: $node->set('promote', NULL);
Chris@0: $node->set('sticky', NULL);
Chris@0: $node->set('revision_timestamp', NULL);
Chris@0: $node->set('revision_log', NULL);
Chris@0: $node->set('uid', NULL);
Chris@0:
Chris@0: return $node;
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Check to see if the HTTP request response body is identical to the expected
Chris@0: * value.
Chris@0: *
Chris@0: * @param $expected
Chris@0: * The first value to check.
Chris@0: * @param $message
Chris@0: * (optional) A message to display with the assertion. Do not translate
Chris@17: * messages: use \Drupal\Component\Render\FormattableMarkup to embed
Chris@0: * variables in the message text, not t(). If left blank, a default message
Chris@0: * will be displayed.
Chris@0: * @param $group
Chris@0: * (optional) The group this message is in, which is displayed in a column
Chris@0: * in test output. Use 'Debug' to indicate this is debugging output. Do not
Chris@0: * translate this string. Defaults to 'Other'; most tests do not override
Chris@0: * this default.
Chris@0: *
Chris@0: * @return bool
Chris@0: * TRUE if the assertion succeeded, FALSE otherwise.
Chris@0: */
Chris@0: protected function assertResponseBody($expected, $message = '', $group = 'REST Response') {
Chris@0: return $this->assertIdentical($expected, $this->responseBody, $message ? $message : strtr('Response body @expected (expected) is equal to @response (actual).', ['@expected' => var_export($expected, TRUE), '@response' => var_export($this->responseBody, TRUE)]), $group);
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Checks if an entity type id is for a Config Entity.
Chris@0: *
Chris@0: * @param string $entity_type_id
Chris@0: * The entity type ID to check.
Chris@0: *
Chris@0: * @return bool
Chris@0: * TRUE if the entity is a Config Entity, FALSE otherwise.
Chris@0: */
Chris@0: protected function isConfigEntity($entity_type_id) {
Chris@0: return \Drupal::entityTypeManager()->getDefinition($entity_type_id) instanceof ConfigEntityType;
Chris@0: }
Chris@0:
Chris@0: /**
Chris@0: * Provides an array of suitable property values for a config entity type.
Chris@0: *
Chris@0: * Config entities have some common keys that need to be created. Required
Chris@0: * properties differ among config entity types, so we keep a minimum mapping
Chris@0: * here.
Chris@0: *
Chris@0: * @param string $entity_type_id
Chris@0: * The ID of the type of entity that should be created.
Chris@0: *
Chris@0: * @return array
Chris@0: * An array of values keyed by property name.
Chris@0: */
Chris@0: protected function configEntityValues($entity_type_id) {
Chris@0: $entity_type = \Drupal::entityTypeManager()->getDefinition($entity_type_id);
Chris@0: $keys = $entity_type->getKeys();
Chris@0: $values = [];
Chris@0: // Fill out known key values that are shared across entity types.
Chris@0: foreach ($keys as $key) {
Chris@0: if ($key === 'id' || $key === 'label') {
Chris@0: $values[$key] = $this->randomMachineName();
Chris@0: }
Chris@0: }
Chris@0: // Add extra values for particular entity types.
Chris@0: switch ($entity_type_id) {
Chris@0: case 'block':
Chris@0: $values['plugin'] = 'system_powered_by_block';
Chris@0: break;
Chris@0: }
Chris@0: return $values;
Chris@0: }
Chris@0:
Chris@0: }