class TestHttp in Migrate Plus 8.4

Test class to mock an HTTP request.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate_plus\DataFetcherPluginBase implements DataFetcherPluginInterface
      • class \Drupal\migrate_plus\Plugin\migrate_plus\data_fetcher\Http implements ContainerFactoryPluginInterface
        • class \Drupal\Tests\migrate_plus\Unit\data_fetcher\TestHttp

File

tests/src/Unit/data_fetcher/HttpTest.php, line 176

PHPUnit tests for the Migrate Plus Http 'data fetcher' plugin.

Namespace

Drupal\Tests\migrate_plus\Unit\data_fetcher

class TestHttp extends Http {

  /**
   * Mocked authenticator plugin.
   *
   * @var \PHPUnit_Framework_MockObject_MockObject
   */
  public $authenticator = NULL;

  /**
   * Mock the HttpClient, so we can control the request/response(s) etc.
   *
   * @param array $responses
   *   An array of responses (arrays), with each consisting of properties,
   *   ordered: response code, content-type and  response body.
   * @param \PHPUnit_Framework_MockObject_MockObject $authenticator
   *   Mocked authenticator plugin.
   */
  public function mockHttpClient(array $responses, \PHPUnit_Framework_MockObject_MockObject $authenticator = NULL) {

    // Set mocked authentication plugin to be used for the request auth plugin.
    $this->authenticator = $authenticator;
    $handler_responses = [];
    foreach ($responses as $response) {
      $handler_responses[] = new Response($response[0], [
        'Content-Type' => $response[1],
      ], $response[2]);
    }
    $mock = new MockHandler($handler_responses);
    $handler = HandlerStack::create($mock);
    $this->httpClient = new Client([
      'handler' => $handler,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {

    // Skip calling the Http() constructor (that sets the httpClient instance
    // variable via \Drupal which we don't want to do), but keep the call to its
    // parent class constructor. @see https://bugs.php.net/bug.php?id=42016
    DataFetcherPluginBase::__construct($configuration, $plugin_id, $plugin_definition);

    // This is what the parent class is doing, that we need to override.
    $this->httpClient = NULL;
  }

  /**
   * Override the parent::getAuthenticationPlugin()
   *
   * So we can mock the authentication plugin.
   *
   * @return \PHPUnit_Framework_MockObject_MockObject
   *   A mocked authentication plugin.
   */
  public function getAuthenticationPlugin() {
    if (!isset($this->authenticationPlugin)) {
      $this->authenticationPlugin = $this->authenticator;
    }
    return $this->authenticationPlugin;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DataFetcherPluginBase::create	public static	function
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
Http::$authenticationPlugin	protected	property	The data retrieval client.
Http::$headers	protected	property	The request headers.
Http::$httpClient	protected	property	The HTTP client.
Http::getRequestHeaders	public	function	Get the currently set request headers. Overrides DataFetcherPluginInterface::getRequestHeaders
Http::getResponse	public	function	Return Http Response object for a given url. Overrides DataFetcherPluginInterface::getResponse
Http::getResponseContent	public	function	Return content. Overrides DataFetcherPluginInterface::getResponseContent
Http::setRequestHeaders	public	function	Set the client headers. Overrides DataFetcherPluginInterface::setRequestHeaders
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TestHttp::$authenticator	public	property	Mocked authenticator plugin.
TestHttp::getAuthenticationPlugin	public	function	Override the parent::getAuthenticationPlugin() Overrides Http::getAuthenticationPlugin
TestHttp::mockHttpClient	public	function	Mock the HttpClient, so we can control the request/response(s) etc.
TestHttp::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides Http::__construct