class PageContextTest in Acquia Lift Connector 8

PageContextTest Test.

@coversDefaultClass Drupal\acquia_lift\Service\Context\PageContext @group acquia_lift

Hierarchy

class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
- class \Drupal\Tests\acquia_lift\Service\Context\PageContextTest uses SettingsDataTrait

Expanded class hierarchy of PageContextTest

File

tests/src/Unit/Service/Context/PageContextTest.php, line 22: Contains \Drupal\Tests\acquia_lift\Service\Context\PageContextTest.

Namespace

Drupal\Tests\acquia_lift\Service\Context

View source

class PageContextTest extends UnitTestCase {
  use SettingsDataTrait;

  /**
   * @var \Drupal\Core\Config\ConfigFactoryInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  private $configFactory;

  /**
   * @var \Drupal\Core\Config\ImmutableConfig|\PHPUnit_Framework_MockObject_MockObject
   */
  private $settings;

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  private $entityTypeManager;

  /**
   * Taxonomy term storage.
   *
   * @var \Drupal\taxonomy\TermStorageInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  private $taxonomyTermStorage;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $this->configFactory = $this
      ->getMock('Drupal\\Core\\Config\\ConfigFactoryInterface');
    $this->settings = $this
      ->getMockBuilder('Drupal\\Core\\Config\\ImmutableConfig')
      ->disableOriginalConstructor()
      ->getMock();
    $this->entityTypeManager = $this
      ->getMock('Drupal\\Core\\Entity\\EntityTypeManagerInterface');
    $this->taxonomyTermStorage = $this
      ->getMock('Drupal\\taxonomy\\TermStorageInterface');
    $this->configFactory
      ->expects($this
      ->once())
      ->method('get')
      ->with('acquia_lift.settings')
      ->willReturn($this->settings);
    $this->settings
      ->expects($this
      ->at(0))
      ->method('get')
      ->with('field_mappings')
      ->willReturn($this
      ->getValidFieldMappingsSettings());
    $this->settings
      ->expects($this
      ->at(1))
      ->method('get')
      ->with('thumbnail')
      ->willReturn($this
      ->getValidThumbnailSettings());
    $this->entityTypeManager
      ->expects($this
      ->once())
      ->method('getStorage')
      ->with('taxonomy_term')
      ->willReturn($this->taxonomyTermStorage);
  }

  /**
   * Tests the getAll() method().
   *
   * @covers ::getAll
   */
  public function testGetAll() {
    $page_context = new PageContext($this->configFactory, $this->entityTypeManager);
    $all_page_context = $page_context
      ->getAll();
    $expected_page_context = [
      'content_title' => 'Untitled',
      'content_type' => 'page',
      'page_type' => 'content page',
      'content_section' => '',
      'content_keywords' => '',
      'post_id' => '',
      'published_date' => '',
      'thumbnail_url' => '',
      'persona' => '',
      'engagement_score' => 1,
      'author' => '',
      'evalSegments' => TRUE,
      'trackingId' => '',
    ];
    $this
      ->assertEquals($expected_page_context, $all_page_context);
  }

  /**
   * Tests the getAll() method, with setByNode().
   *
   * @covers ::getAll
   * @covers ::setByNode
   */
  public function testGetAllWithSetByNode() {
    $node = $this
      ->getNode();
    $this
      ->testGetAllWithSetByNodeSetUpThumbnailUrl($node);
    $this
      ->testGetAllWithSetByNodeSetUpFields();
    $page_context = new PageContext($this->configFactory, $this->entityTypeManager);
    $page_context
      ->setByNode($node);
    $all_page_context = $page_context
      ->getAll();
    $expected_page_context = [
      'content_title' => 'My Title',
      'content_type' => 'article',
      'page_type' => 'node page',
      'content_section' => 'Tracked Content Term Name 1',
      'content_keywords' => 'Tracked Keyword Term Name 1,Tracked Keyword Term Name 2',
      'post_id' => 90210,
      'published_date' => 'a_published_time',
      'thumbnail_url' => 'file_create_url:a_style_decorated_file_uri',
      'persona' => '',
      'engagement_score' => 1,
      'author' => 'a_username',
      'evalSegments' => TRUE,
      'trackingId' => '',
    ];
    $this
      ->assertEquals($expected_page_context, $all_page_context);
  }

  /**
   * Tests the getAll() method, with setPageContextTitle().
   *
   * @covers ::getAll
   * @covers ::setPageContextTitle
   */
  public function testGetAllWithSetPageContextTitle() {
    $page_context = new PageContext($this->configFactory, $this->entityTypeManager);

    // Test set markup title.
    $title = [
      '#markup' => '<div><a>My Page Title</a></div>',
      '#allowed_tags' => [
        'a',
      ],
    ];
    $page_context
      ->setPageContextTitle($title);
    $all_page_context = $page_context
      ->getAll();
    $expected_page_context = [
      'content_title' => '<a>My Page Title</a>',
      'content_type' => 'page',
      'page_type' => 'content page',
      'content_section' => '',
      'content_keywords' => '',
      'post_id' => '',
      'published_date' => '',
      'thumbnail_url' => '',
      'persona' => '',
      'engagement_score' => 1,
      'author' => '',
      'evalSegments' => TRUE,
      'trackingId' => '',
    ];
    $this
      ->assertEquals($expected_page_context, $all_page_context);

    // Test set string title.
    $title = 'My Page Title';
    $page_context
      ->setPageContextTitle($title);
    $all_page_context = $page_context
      ->getAll();
    $expected_page_context = [
      'content_title' => 'My Page Title',
      'content_type' => 'page',
      'page_type' => 'content page',
      'content_section' => '',
      'content_keywords' => '',
      'post_id' => '',
      'published_date' => '',
      'thumbnail_url' => '',
      'persona' => '',
      'engagement_score' => 1,
      'author' => '',
      'evalSegments' => TRUE,
      'trackingId' => '',
    ];
    $this
      ->assertEquals($expected_page_context, $all_page_context);

    // Test set NULL title.
    $page_context
      ->setPageContextTitle(NULL);
    $all_page_context = $page_context
      ->getAll();
    $expected_page_context = [
      'content_title' => '',
      'content_type' => 'page',
      'page_type' => 'content page',
      'content_section' => '',
      'content_keywords' => '',
      'post_id' => '',
      'published_date' => '',
      'thumbnail_url' => '',
      'persona' => '',
      'engagement_score' => 1,
      'author' => '',
      'evalSegments' => TRUE,
      'trackingId' => '',
    ];
    $this
      ->assertEquals($expected_page_context, $all_page_context);
  }

  /**
   * testGetAllWithSetByNode(), sub routine "set up thumbnail url".
   *
   * @param $node Node
   */
  private function testGetAllWithSetByNodeSetUpThumbnailUrl($node) {
    $field_media = $this
      ->getMockBuilder('Drupal\\Core\\Entity\\ContentEntityInterface')
      ->disableOriginalConstructor()
      ->getMock();
    $field_image = $this
      ->getMockBuilder('Drupal\\Core\\Entity\\ContentEntityInterface')
      ->disableOriginalConstructor()
      ->getMock();
    $media_entity = $this
      ->getMock('Drupal\\Core\\Entity\\EntityInterface');
    $image_entity = $this
      ->getMock('Drupal\\file\\FileInterface');
    $node->field_media = $field_media;
    $node->field_media->entity = $media_entity;
    $node->field_media->entity->field_image = $field_image;
    $node->field_media->entity->field_image->entity = $image_entity;
    $entity_manager = $this
      ->getMock('Drupal\\Core\\Entity\\EntityManagerInterface');
    $entity_storage = $this
      ->getMock('Drupal\\Core\\Entity\\EntityStorageInterface');
    $container = $this
      ->getMock('Drupal\\Core\\DependencyInjection\\Container');
    $image_style = $this
      ->getMockBuilder('Drupal\\image\\Entity\\ImageStyle')
      ->disableOriginalConstructor()
      ->getMock();
    \Drupal::setContainer($container);
    $container
      ->expects($this
      ->any())
      ->method('get')
      ->with('entity.manager')
      ->willReturn($entity_manager);
    $entity_manager
      ->expects($this
      ->once())
      ->method('getEntityTypeFromClass')
      ->with('Drupal\\image\\Entity\\ImageStyle')
      ->willReturn($image_entity);
    $image_entity
      ->expects($this
      ->once())
      ->method('bundle')
      ->willReturn('file');
    $image_entity
      ->expects($this
      ->once())
      ->method('getFileUri')
      ->willReturn('a_file_uri');
    $entity_manager
      ->expects($this
      ->once())
      ->method('getStorage')
      ->with($image_entity)
      ->willReturn($entity_storage);
    $entity_storage
      ->expects($this
      ->once())
      ->method('load')
      ->with('medium')
      ->willReturn($image_style);
    $image_style
      ->expects($this
      ->once())
      ->method('buildUrl')
      ->with('a_file_uri')
      ->willReturn('a_style_decorated_file_uri');
  }

  /**
   * testGetAllWithSetByNode(), sub routine "setup fields".
   */
  private function testGetAllWithSetByNodeSetUpFields() {
    $tracked_content_term_1 = $this
      ->getTerm('Tracked Content Term Name 1', 'tracked_content_vocabulary');
    $tracked_keyword_term_1 = $this
      ->getTerm('Tracked Keyword Term Name 1', 'tracked_keyword_vocabulary');
    $tracked_keyword_term_2 = $this
      ->getTerm('Tracked Keyword Term Name 2', 'tracked_keyword_vocabulary');
    $discarded_term_1 = $this
      ->getTerm('Untracked Term Name', 'untracked_vocabulary_id');
    $terms = [
      90210 => [
        $tracked_content_term_1,
        $tracked_keyword_term_1,
        $tracked_keyword_term_2,
        $discarded_term_1,
      ],
    ];
    $this->taxonomyTermStorage
      ->expects($this
      ->once())
      ->method('getNodeTerms')
      ->with([
      90210,
    ])
      ->willReturn($terms);
  }

  /**
   * Get Term.
   *
   * @param string $name
   * @param string $vocabulary_id
   *
   * @return Drupal\taxonomy\TermInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  private function getTerm($name = 'Term Name', $vocabulary_id = 'untracked_vocabulary_id') {
    $term = $this
      ->getMock('Drupal\\taxonomy\\TermInterface');
    $term
      ->expects($this
      ->once())
      ->method('getVocabularyId')
      ->willReturn($vocabulary_id);
    $term
      ->expects($this
      ->once())
      ->method('getName')
      ->willReturn($name);
    return $term;
  }

  /**
   * Get Node.
   *
   * @param integer $id
   *
   * @return Drupal\node\NodeInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  private function getNode($id = 90210) {
    $user = $this
      ->getUser();
    $field_country = $this
      ->getMock('Drupal\\Core\\Field\\BaseFieldDefinition');
    $field_tags = $this
      ->getMock('Drupal\\Core\\Field\\BaseFieldDefinition');
    $node = $this
      ->getMock('Drupal\\node\\NodeInterface');
    $field_country_handler_settings = [
      'target_bundles' => [
        'tracked_content_vocabulary',
      ],
    ];
    $field_tags_handler_settings = [
      'target_bundles' => [
        'tracked_keyword_vocabulary',
      ],
    ];
    $node
      ->expects($this
      ->exactly(2))
      ->method('getType')
      ->willReturn('article');
    $node
      ->expects($this
      ->once())
      ->method('getTitle')
      ->willReturn('My Title');
    $node
      ->expects($this
      ->once())
      ->method('getCreatedTime')
      ->willReturn('a_published_time');
    $node
      ->expects($this
      ->any())
      ->method('id')
      ->willReturn($id);
    $node
      ->expects($this
      ->once())
      ->method('getOwner')
      ->willReturn($user);
    $field_country
      ->expects($this
      ->once())
      ->method('getSetting')
      ->with('handler_settings')
      ->willReturn($field_country_handler_settings);
    $field_tags
      ->expects($this
      ->once())
      ->method('getSetting')
      ->with('handler_settings')
      ->willReturn($field_tags_handler_settings);
    $node->field_country = $field_country;
    $node->field_tags = $field_tags;
    return $node;
  }

  /**
   * Get User.
   *
   * @param string $username
   *
   * @return Drupal\user\UserInterface|\PHPUnit_Framework_MockObject_MockObject
   */
  private function getUser($username = 'a_username') {
    $user = $this
      ->getMock('Drupal\\user\\UserInterface');
    $user
      ->expects($this
      ->once())
      ->method('getUsername')
      ->willReturn($username);
    return $user;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PageContextTest::$configFactory	private	property
PageContextTest::$entityTypeManager	private	property
PageContextTest::$settings	private	property
PageContextTest::$taxonomyTermStorage	private	property	Taxonomy term storage.
PageContextTest::getNode	private	function	Get Node.
PageContextTest::getTerm	private	function	Get Term.
PageContextTest::getUser	private	function	Get User.
PageContextTest::setUp	public	function	Overrides UnitTestCase::setUp
PageContextTest::testGetAll	public	function	Tests the getAll() method().
PageContextTest::testGetAllWithSetByNode	public	function	Tests the getAll() method, with setByNode().
PageContextTest::testGetAllWithSetByNodeSetUpFields	private	function	testGetAllWithSetByNode(), sub routine "setup fields".
PageContextTest::testGetAllWithSetByNodeSetUpThumbnailUrl	private	function	testGetAllWithSetByNode(), sub routine "set up thumbnail url".
PageContextTest::testGetAllWithSetPageContextTitle	public	function	Tests the getAll() method, with setPageContextTitle().
PhpunitCompatibilityTrait::getMock Deprecated	public	function	Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated	public	function	Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
SettingsDataTrait::getValidCredentialSettings	private	function	Get a valid credential settings array.
SettingsDataTrait::getValidFieldMappingsSettings	private	function	Get a valid field mappings settings array.
SettingsDataTrait::getValidFrontEndCredentialSettings	private	function	Get a valid front end credential settings.
SettingsDataTrait::getValidIdentitySettings	private	function	Get a valid identity settings array.
SettingsDataTrait::getValidThumbnailSettings	private	function	Get a valid thumbnail settings array.
SettingsDataTrait::getValidVisibilitySettings	private	function	Get a valid visibility settings array.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated	protected	function	Mocks a block with a block plugin.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.

You are here

class PageContextTest in Acquia Lift Connector 8

Hierarchy

File

Namespace

Members

API Navigation