SocialApiTestBase.php in Social API 3.x

Namespace

Drupal\Tests\social_api\Functional

File

tests/src/Functional/SocialApiTestBase.php

<?php

namespace Drupal\Tests\social_api\Functional;

use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\Tests\BrowserTestBase;

/**
 * Defines a base class for testing Social Auth implementers.
 */
abstract class SocialApiTestBase extends BrowserTestBase {
  use StringTranslationTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'social_api',
  ];

  /**
   * The installation profile to use with this test.
   *
   * @var string
   */
  protected $profile = 'minimal';

  /**
   * A test user with no permissions.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $noPermsUser;

  /**
   * A test user with corresponding permissions.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * The permissions for the admin user.
   *
   * @var array
   */
  protected $adminUserPermissions;

  /**
   * The module machine name that is being tested.
   *
   * @var string
   */
  protected $module;

  /**
   * The default theme.
   *
   * @var string
   */
  protected $defaultTheme = 'stark';

  /**
   * The machine name of the provider the module works with.
   *
   * @var null|string
   */
  protected $provider = NULL;

  /**
   * The module type (social_auth, social_post).
   *
   * @var string
   */
  protected $moduleType;

  /**
   * Settings fields to test.
   *
   * @var array
   */
  protected $fields = [];

  /**
   * The settings to be saved.
   *
   * @var array
   */
  protected $edit;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Create a non-administrative user.
    $this->noPermsUser = $this
      ->drupalCreateUser();

    // Create an administrative user.
    $this->adminUser = $this
      ->drupalCreateUser($this->adminUserPermissions);
  }

  /**
   * Check that module is available in integration list.
   */
  public function checkIsAvailableInIntegrationList() {
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('/admin/config/social-api/' . $this->moduleType);

    // Assert that module is enabled in integrations list.
    $this
      ->assertSession()
      ->pageTextContains($this->module);
  }

  /**
   * Test for configuration page.
   *
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   * @throws \Behat\Mink\Exception\ExpectationException
   */
  public function checkPermissionForSettingsPage() {
    $assert = $this
      ->assertSession();

    // Verifies that permissions are applied to the defined paths.
    $forbidden_paths = [
      '/admin/config/social-api/' . $this->moduleType . '/' . $this->provider,
    ];

    // Checks each of the paths to make sure we don't have access. At this point
    // we haven't logged in any users, so the client is anonymous.
    foreach ($forbidden_paths as $path) {
      $this
        ->drupalGet($path);
      $assert
        ->statusCodeEquals(403);
    }

    // Logs in user with no permissions.
    $this
      ->drupalLogin($this->noPermsUser);

    // Should be the same result for forbidden paths, since the user needs
    // special permissions for these paths.
    foreach ($forbidden_paths as $path) {
      $this
        ->drupalGet($path);
      $assert
        ->statusCodeEquals(403);
    }

    // Logs in user with permissions.
    $this
      ->drupalLogin($this->adminUser);

    // Forbidden paths aren't forbidden any more.
    foreach ($forbidden_paths as $unforbidden) {
      $this
        ->drupalGet($unforbidden);
      $assert
        ->statusCodeEquals(200);
    }

    // Now that we have the admin user logged in, check the menu links.
    $this
      ->drupalGet('/admin/config/social-api/' . $this->moduleType . '/' . $this->provider);
    foreach ($this->fields as $field) {
      $assert
        ->fieldExists($field);
    }
  }

  /**
   * Tests module settings form submission.
   */
  public function checkSettingsFormSubmission() {
    $this
      ->drupalLogin($this->adminUser);
    $path = 'admin/config/social-api/' . $this->moduleType . '/' . $this->provider;
    $this
      ->drupalPostForm($path, $this->edit, $this
      ->t('Save configuration'));
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');
  }

}

Classes

Name	Description
SocialApiTestBase	Defines a base class for testing Social Auth implementers.