From b9c288ba3e545af706bb41632e10741d18b239cb Mon Sep 17 00:00:00 2001
From: Alex Pott <alex.a.pott@googlemail.com>
Date: Tue, 23 May 2017 15:37:20 +0100
Subject: [PATCH] Issue #2843767 by arshadcn, Wim Leers, tstoeckler:
 EntityResource: Provide comprehensive test coverage for BaseFieldOverride
 entity + add missing access control handler

---
 .../BaseFieldOverrideAccessControlHandler.php |  23 ++++
 .../Core/Field/Entity/BaseFieldOverride.php   |   3 +-
 .../BaseFieldOverrideHalJsonAnonTest.php      |  30 +++++
 .../BaseFieldOverrideHalJsonBasicAuthTest.php |  35 ++++++
 .../BaseFieldOverrideHalJsonCookieTest.php    |  35 ++++++
 .../BaseFieldOverrideJsonAnonTest.php         |  24 ++++
 .../BaseFieldOverrideJsonBasicAuthTest.php    |  34 ++++++
 .../BaseFieldOverrideJsonCookieTest.php       |  29 +++++
 .../BaseFieldOverrideResourceTestBase.php     | 111 ++++++++++++++++++
 9 files changed, 323 insertions(+), 1 deletion(-)
 create mode 100644 core/lib/Drupal/Core/Field/BaseFieldOverrideAccessControlHandler.php
 create mode 100644 core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonAnonTest.php
 create mode 100644 core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonBasicAuthTest.php
 create mode 100644 core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonCookieTest.php
 create mode 100644 core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonAnonTest.php
 create mode 100644 core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonBasicAuthTest.php
 create mode 100644 core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonCookieTest.php
 create mode 100644 core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideResourceTestBase.php

diff --git a/core/lib/Drupal/Core/Field/BaseFieldOverrideAccessControlHandler.php b/core/lib/Drupal/Core/Field/BaseFieldOverrideAccessControlHandler.php
new file mode 100644
index 000000000000..a1e734b46842
--- /dev/null
+++ b/core/lib/Drupal/Core/Field/BaseFieldOverrideAccessControlHandler.php
@@ -0,0 +1,23 @@
+<?php
+
+namespace Drupal\Core\Field;
+
+use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Entity\EntityAccessControlHandler;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Session\AccountInterface;
+
+/**
+ * Provides en entity access control handler for base field override entity.
+ */
+class BaseFieldOverrideAccessControlHandler extends EntityAccessControlHandler {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function checkAccess(EntityInterface $entity, $operation, AccountInterface $account) {
+    $access = parent::checkAccess($entity, $operation, $account);
+    return $access->orIf(AccessResult::allowedIfHasPermission($account, 'administer ' . $entity->getTargetEntityTypeId() . ' fields'));
+  }
+
+}
diff --git a/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php b/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php
index c2d0cb5ddbad..f20f3a503be9 100644
--- a/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php
+++ b/core/lib/Drupal/Core/Field/Entity/BaseFieldOverride.php
@@ -16,7 +16,8 @@ use Drupal\Core\Field\FieldException;
  *   id = "base_field_override",
  *   label = @Translation("Base field override"),
  *   handlers = {
- *     "storage" = "Drupal\Core\Field\BaseFieldOverrideStorage"
+ *     "storage" = "Drupal\Core\Field\BaseFieldOverrideStorage",
+ *     "access" = "Drupal\Core\Field\BaseFieldOverrideAccessControlHandler",
  *   },
  *   config_prefix = "base_field_override",
  *   entity_keys = {
diff --git a/core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonAnonTest.php b/core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonAnonTest.php
new file mode 100644
index 000000000000..552437a40162
--- /dev/null
+++ b/core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonAnonTest.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace Drupal\Tests\hal\Functional\EntityResource\BaseFieldOverride;
+
+use Drupal\Tests\rest\Functional\AnonResourceTestTrait;
+use Drupal\Tests\rest\Functional\EntityResource\BaseFieldOverride\BaseFieldOverrideResourceTestBase;
+
+/**
+ * @group hal
+ */
+class BaseFieldOverrideHalJsonAnonTest extends BaseFieldOverrideResourceTestBase {
+
+  use AnonResourceTestTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = ['hal'];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $format = 'hal_json';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $mimeType = 'application/hal+json';
+
+}
diff --git a/core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonBasicAuthTest.php b/core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonBasicAuthTest.php
new file mode 100644
index 000000000000..ba2249e52c99
--- /dev/null
+++ b/core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonBasicAuthTest.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace Drupal\Tests\hal\Functional\EntityResource\BaseFieldOverride;
+
+use Drupal\Tests\rest\Functional\BasicAuthResourceTestTrait;
+use Drupal\Tests\rest\Functional\EntityResource\BaseFieldOverride\BaseFieldOverrideResourceTestBase;
+
+/**
+ * @group hal
+ */
+class BaseFieldOverrideHalJsonBasicAuthTest extends BaseFieldOverrideResourceTestBase {
+
+  use BasicAuthResourceTestTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = ['hal', 'basic_auth'];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $format = 'hal_json';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $mimeType = 'application/hal+json';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $auth = 'basic_auth';
+
+}
diff --git a/core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonCookieTest.php b/core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonCookieTest.php
new file mode 100644
index 000000000000..b05f15332b5d
--- /dev/null
+++ b/core/modules/hal/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideHalJsonCookieTest.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace Drupal\Tests\hal\Functional\EntityResource\BaseFieldOverride;
+
+use Drupal\Tests\rest\Functional\CookieResourceTestTrait;
+use Drupal\Tests\rest\Functional\EntityResource\BaseFieldOverride\BaseFieldOverrideResourceTestBase;
+
+/**
+ * @group hal
+ */
+class BaseFieldOverrideHalJsonCookieTest extends BaseFieldOverrideResourceTestBase {
+
+  use CookieResourceTestTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = ['hal'];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $format = 'hal_json';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $mimeType = 'application/hal+json';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $auth = 'cookie';
+
+}
diff --git a/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonAnonTest.php b/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonAnonTest.php
new file mode 100644
index 000000000000..e16284d00c27
--- /dev/null
+++ b/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonAnonTest.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace Drupal\Tests\rest\Functional\EntityResource\BaseFieldOverride;
+
+use Drupal\Tests\rest\Functional\AnonResourceTestTrait;
+
+/**
+ * @group rest
+ */
+class BaseFieldOverrideJsonAnonTest extends BaseFieldOverrideResourceTestBase {
+
+  use AnonResourceTestTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $format = 'json';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $mimeType = 'application/json';
+
+}
diff --git a/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonBasicAuthTest.php b/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonBasicAuthTest.php
new file mode 100644
index 000000000000..010fa8db1145
--- /dev/null
+++ b/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonBasicAuthTest.php
@@ -0,0 +1,34 @@
+<?php
+
+namespace Drupal\Tests\rest\Functional\EntityResource\BaseFieldOverride;
+
+use Drupal\Tests\rest\Functional\BasicAuthResourceTestTrait;
+
+/**
+ * @group rest
+ */
+class BaseFieldOverrideJsonBasicAuthTest extends BaseFieldOverrideResourceTestBase {
+
+  use BasicAuthResourceTestTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = ['basic_auth'];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $format = 'json';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $mimeType = 'application/json';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $auth = 'basic_auth';
+
+}
diff --git a/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonCookieTest.php b/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonCookieTest.php
new file mode 100644
index 000000000000..dd4f8ec7b37b
--- /dev/null
+++ b/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideJsonCookieTest.php
@@ -0,0 +1,29 @@
+<?php
+
+namespace Drupal\Tests\rest\Functional\EntityResource\BaseFieldOverride;
+
+use Drupal\Tests\rest\Functional\CookieResourceTestTrait;
+
+/**
+ * @group rest
+ */
+class BaseFieldOverrideJsonCookieTest extends BaseFieldOverrideResourceTestBase {
+
+  use CookieResourceTestTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $format = 'json';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $mimeType = 'application/json';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $auth = 'cookie';
+
+}
diff --git a/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideResourceTestBase.php b/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideResourceTestBase.php
new file mode 100644
index 000000000000..1f4b03a2cfa1
--- /dev/null
+++ b/core/modules/rest/tests/src/Functional/EntityResource/BaseFieldOverride/BaseFieldOverrideResourceTestBase.php
@@ -0,0 +1,111 @@
+<?php
+
+namespace Drupal\Tests\rest\Functional\EntityResource\BaseFieldOverride;
+
+use Drupal\Core\Field\Entity\BaseFieldOverride;
+use Drupal\node\Entity\NodeType;
+use Drupal\Tests\rest\Functional\EntityResource\EntityResourceTestBase;
+
+abstract class BaseFieldOverrideResourceTestBase extends EntityResourceTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = ['field', 'node'];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $entityTypeId = 'base_field_override';
+
+  /**
+   * @var \Drupal\Core\Field\Entity\BaseFieldOverride
+   */
+  protected $entity;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUpAuthorization($method) {
+    $this->grantPermissionsToTestedRole(['administer node fields']);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function createEntity() {
+    $camelids = NodeType::create([
+      'name' => 'Camelids',
+      'type' => 'camelids',
+    ]);
+    $camelids->save();
+
+    $entity = BaseFieldOverride::create([
+      'field_name' => 'promote',
+      'entity_type' => 'node',
+      'bundle' => 'camelids',
+    ]);
+    $entity->save();
+
+    return $entity;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getExpectedNormalizedEntity() {
+    return [
+      'bundle' => 'camelids',
+      'default_value' => [],
+      'default_value_callback' => '',
+      'dependencies' => [
+        'config' => [
+          'node.type.camelids',
+        ],
+      ],
+      'description' => '',
+      'entity_type' => 'node',
+      'field_name' => 'promote',
+      'field_type' => 'boolean',
+      'id' => 'node.camelids.promote',
+      'label' => NULL,
+      'langcode' => 'en',
+      'required' => FALSE,
+      'settings' => [
+        'on_label' => 'On',
+        'off_label' => 'Off',
+      ],
+      'status' => TRUE,
+      'translatable' => TRUE,
+      'uuid' => $this->entity->uuid(),
+    ];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getNormalizedPostEntity() {
+    // @todo Update in https://www.drupal.org/node/2300677.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getExpectedCacheContexts() {
+    return [
+      'user.permissions',
+    ];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function getExpectedUnauthorizedAccessMessage($method) {
+    if ($this->config('rest.settings')->get('bc_entity_resource_permissions')) {
+      return parent::getExpectedUnauthorizedAccessMessage($method);
+    }
+
+    return "The 'administer node fields' permission is required.";
+  }
+
+}