StandardProfileTest.php 16.9 KB
Newer Older
1
<?php
2

3 4
/**
 * @file
5
 * Contains \Drupal\rdf\Tests\StandardProfileTest.
6 7 8 9
 */

namespace Drupal\rdf\Tests;

10
use Drupal\Core\Url;
11 12
use Drupal\image\Entity\ImageStyle;
use Drupal\node\Entity\NodeType;
13
use Drupal\node\NodeInterface;
14 15 16
use Drupal\simpletest\WebTestBase;

/**
17 18 19
 * Tests the RDF mappings and RDFa markup of the standard profile.
 *
 * @group rdf
20 21 22
 */
class StandardProfileTest extends WebTestBase {

23 24 25 26 27 28 29
  /**
   * The profile used during tests.
   *
   * This purposefully uses the standard profile.
   *
   * @var string
   */
30 31
  public $profile = 'standard';

32 33 34
  /**
   * @var string
   */
35
  protected $baseUri;
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106

  /**
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * @var \Drupal\user\UserInterface
   */
  protected $webUser;

  /**
   * @var \Drupal\taxonomy\TermInterface
   */
  protected $term;

  /**
   * @var \Drupal\file\FileInterface
   */
  protected $image;

  /**
   * @var \Drupal\node\NodeInterface
   */
  protected $article;

  /**
   * @var \Drupal\comment\CommentInterface
   */
  protected $articleComment;

  /**
   * @var \Drupal\node\NodeInterface
   */
  protected $page;

  /**
   * @var string
   */
  protected $imageUri;

  /**
   * @var string
   */
  protected $termUri;

  /**
   * @var string
   */
  protected $articleUri;

  /**
   * @var string
   */
  protected $pageUri;

  /**
   * @var string
   */
  protected $authorUri;

  /**
   * @var string
   */
  protected $articleCommentUri;

  /**
   * @var string
   */
  protected $commenterUri;

107
  protected function setUp() {
108 109
    parent::setUp();

110
    $this->baseUri = \Drupal::url('<front>', [], ['absolute' => TRUE]);
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129

    // Create two test users.
    $this->adminUser = $this->drupalCreateUser(array(
      'administer content types',
      'administer comments',
      'access comments',
      'access content',
    ));
    $this->webUser = $this->drupalCreateUser(array(
      'access comments',
      'post comments',
      'skip comment approval',
      'access content',
    ));

    $this->drupalLogin($this->adminUser);

    // Create term.
    $this->term = entity_create('taxonomy_term', array(
130 131
      'name' => $this->randomMachineName(),
      'description' => $this->randomMachineName(),
132 133 134 135 136
      'vid' => 'tags',
    ));
    $this->term->save();

    // Create image.
137
    file_unmanaged_copy(\Drupal::root() . '/core/misc/druplicon.png', 'public://example.jpg');
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
    $this->image = entity_create('file', array('uri' => 'public://example.jpg'));
    $this->image->save();

    // Create article.
    $article_settings = array(
      'type' => 'article',
      'promote' => NODE_PROMOTED,
      'field_image' => array(
        array(
          'target_id' => $this->image->id(),
        ),
      ),
      'field_tags' => array(
        array(
          'target_id' => $this->term->id(),
        ),
      ),
    );
    $this->article = $this->drupalCreateNode($article_settings);
    // Create second article to test teaser list.
    $this->drupalCreateNode(array('type' => 'article', 'promote' => NODE_PROMOTED,));

    // Create article comment.
161
    $this->articleComment = $this->saveComment($this->article->id(), $this->webUser->id(), NULL, 0);
162 163 164 165 166 167

    // Create page.
    $this->page = $this->drupalCreateNode(array('type' => 'page'));

    // Set URIs.
    // Image.
168
    $image_file = $this->article->get('field_image')->entity;
169
    $this->imageUri = ImageStyle::load('large')->buildUrl($image_file->getFileUri());
170
    // Term.
171
    $this->termUri = $this->term->url('canonical', array('absolute' => TRUE));
172
    // Article.
173
    $this->articleUri = $this->article->url('canonical', array('absolute' => TRUE));
174
    // Page.
175
    $this->pageUri = $this->page->url('canonical', array('absolute' => TRUE));
176
    // Author.
177
    $this->authorUri = $this->adminUser->url('canonical', array('absolute' => TRUE));
178
    // Comment.
179
    $this->articleCommentUri = $this->articleComment->url('canonical', array('absolute' => TRUE));
180
    // Commenter.
181
    $this->commenterUri = $this->webUser->url('canonical', array('absolute' => TRUE));
182 183 184 185 186

    $this->drupalLogout();
  }

  /**
187
   * Tests that data is exposed correctly when using standard profile.
188 189 190 191 192 193
   *
   * Because tests using standard profile take a very long time to run, and
   * because there is no manipulation of config or data within the test, simply
   * run all the tests from within this function.
   */
  public function testRdfaOutput() {
194 195 196 197 198
    $this->doFrontPageRdfaTests();
    $this->doArticleRdfaTests();
    $this->doPageRdfaTests();
    $this->doUserRdfaTests();
    $this->doTermRdfaTests();
199 200 201
  }

  /**
202
   * Tests that data is exposed in the front page teasers.
203
   */
204
  protected function doFrontPageRdfaTests() {
205
    // Feed the HTML into the parser.
206
    $graph = $this->getRdfGraph(Url::fromRoute('<front>'));
207 208 209 210 211 212 213

    // Ensure that both articles are listed.
    $this->assertEqual(2, count($graph->allOfType('http://schema.org/Article')), 'Two articles found on front page.');

    // Test interaction count.
    $expected_value = array(
      'type' => 'literal',
214
      'value' => 'UserComments:1',
215 216 217 218 219 220
      'lang' => 'en',
    );
    $this->assertTrue($graph->hasProperty($this->articleUri, 'http://schema.org/interactionCount', $expected_value), "Teaser comment count was found (schema:interactionCount).");

    // Test the properties that are common between pages and articles and are
    // displayed in full and teaser mode.
221
    $this->assertRdfaCommonNodeProperties($graph, $this->article, "Teaser");
222
    // Test properties that are displayed in both teaser and full mode.
223
    $this->assertRdfaArticleProperties($graph, "Teaser");
224 225

    // @todo Once the image points to the original instead of the processed
226
    //   image, move this to testArticleProperties().
227
    $image_file = $this->article->get('field_image')->entity;
228
    $image_uri = ImageStyle::load('medium')->buildUrl($image_file->getFileUri());
229 230 231 232 233 234 235 236
    $expected_value = array(
      'type' => 'uri',
      'value' => $image_uri,
    );
    $this->assertTrue($graph->hasProperty($this->articleUri, 'http://schema.org/image', $expected_value), "Teaser image was found (schema:image).");
  }

  /**
237
   * Tests that article data is exposed using RDFa.
238 239 240 241 242
   *
   * Two fields are not tested for output here. Changed date is not displayed
   * on the page, so there is no test for output in node view. Comment count is
   * displayed in teaser view, so it is tested in the front article tests.
   */
243
  protected function doArticleRdfaTests() {
244
    // Feed the HTML into the parser.
245
    $graph = $this->getRdfGraph($this->article->urlInfo());
246 247 248 249 250

    // Type.
    $this->assertEqual($graph->type($this->articleUri), 'schema:Article', 'Article type was found (schema:Article).');

    // Test the properties that are common between pages and articles.
251
    $this->assertRdfaCommonNodeProperties($graph, $this->article, "Article");
252
    // Test properties that are displayed in both teaser and full mode.
253
    $this->assertRdfaArticleProperties($graph, "Article");
254
    // Test the comment properties displayed on articles.
255
    $this->assertRdfaNodeCommentProperties($graph);
256 257

    // @todo Once the image points to the original instead of the processed
258
    //   image, move this to testArticleProperties().
259 260 261 262 263 264 265 266
    $expected_value = array(
      'type' => 'uri',
      'value' => $this->imageUri,
    );
    $this->assertTrue($graph->hasProperty($this->articleUri, 'http://schema.org/image', $expected_value), "Article image was found (schema:image).");
  }

  /**
267
   * Tests that page data is exposed using RDFa.
268 269 270 271 272
   *
   * Two fields are not tested for output here. Changed date is not displayed
   * on the page, so there is no test for output in node view. Comment count is
   * displayed in teaser view, so it is tested in the front page tests.
   */
273
  protected function doPageRdfaTests() {
274 275 276
    // The standard profile hides the created date on pages. Revert display to
    // true for testing.
    // @todo Clean-up standard profile defaults.
277
    $node_type = NodeType::load('page');
278
    $node_type->setDisplaySubmitted(TRUE);
279 280
    $node_type->save();

281
    // Feed the HTML into the parser.
282
    $graph = $this->getRdfGraph($this->page->urlInfo());
283 284 285 286 287

    // Type.
    $this->assertEqual($graph->type($this->pageUri), 'schema:WebPage', 'Page type was found (schema:WebPage).');

    // Test the properties that are common between pages and articles.
288
    $this->assertRdfaCommonNodeProperties($graph, $this->page, "Page");
289 290 291
  }

  /**
292
   * Tests that user data is exposed on user page.
293
   */
294
  protected function doUserRdfaTests() {
295
    $this->drupalLogin($this->rootUser);
296 297

    // Feed the HTML into the parser.
298
    $graph = $this->getRdfGraph($this->adminUser->urlInfo());
299 300 301 302 303 304 305

    // User type.
    $this->assertEqual($graph->type($this->authorUri), 'schema:Person', "User type was found (schema:Person) on user page.");

    // User name.
    $expected_value = array(
      'type' => 'literal',
306
      'value' => $this->adminUser->label(),
307 308 309 310 311 312 313
    );
    $this->assertTrue($graph->hasProperty($this->authorUri, 'http://schema.org/name', $expected_value), "User name was found (schema:name) on user page.");

    $this->drupalLogout();
  }

  /**
314
   * Tests that term data is exposed on term page.
315
   */
316
  protected function doTermRdfaTests() {
317
    // Feed the HTML into the parser.
318
    $graph = $this->getRdfGraph($this->term->urlInfo());
319 320 321 322 323 324 325

    // Term type.
    $this->assertEqual($graph->type($this->termUri), 'schema:Thing', "Term type was found (schema:Thing) on term page.");

    // Term name.
    $expected_value = array(
      'type' => 'literal',
326
      'value' => $this->term->getName(),
327 328 329 330 331
      'lang' => 'en',
    );
    $this->assertTrue($graph->hasProperty($this->termUri, 'http://schema.org/name', $expected_value), "Term name was found (schema:name) on term page.");

    // @todo Add test for term description once it is a field:
332
    //   https://www.drupal.org/node/569434.
333 334 335
  }

  /**
336
   * Tests output for properties held in common between articles and pages.
337 338 339
   *
   * @param \EasyRdf_Graph $graph
   *   The EasyRDF graph object.
340
   * @param \Drupal\node\NodeInterface $node
341 342 343 344
   *   The node being displayed.
   * @param string $message_prefix
   *   The word to use in the test assertion message.
   */
345
  protected function assertRdfaCommonNodeProperties($graph, NodeInterface $node, $message_prefix) {
346
    $uri = $node->url('canonical', array('absolute' => TRUE));
347

348 349 350
    // Title.
    $expected_value = array(
      'type' => 'literal',
351
      'value' => $node->get('title')->value,
352 353 354 355
      'lang' => 'en',
    );
    $this->assertTrue($graph->hasProperty($uri, 'http://schema.org/name', $expected_value), "$message_prefix title was found (schema:name).");

356 357 358
    // Created date.
    $expected_value = array(
      'type' => 'literal',
359
      'value' => format_date($node->get('created')->value, 'custom', 'c', 'UTC'),
360 361 362 363 364 365 366
      'lang' => 'en',
    );
    $this->assertTrue($graph->hasProperty($uri, 'http://schema.org/dateCreated', $expected_value), "$message_prefix created date was found (schema:dateCreated) in teaser.");

    // Body.
    $expected_value = array(
      'type' => 'literal',
367
      'value' => $node->get('body')->value,
368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
      'lang' => 'en',
    );
    $this->assertTrue($graph->hasProperty($uri, 'http://schema.org/text', $expected_value), "$message_prefix body was found (schema:text) in teaser.");

    // Author.
    $expected_value = array(
      'type' => 'uri',
      'value' => $this->authorUri,
    );
    $this->assertTrue($graph->hasProperty($uri, 'http://schema.org/author', $expected_value), "$message_prefix author was found (schema:author) in teaser.");

    // Author type.
    $this->assertEqual($graph->type($this->authorUri), 'schema:Person', "$message_prefix author type was found (schema:Person).");

    // Author name.
    $expected_value = array(
      'type' => 'literal',
385
      'value' => $this->adminUser->label(),
386 387 388 389 390
    );
    $this->assertTrue($graph->hasProperty($this->authorUri, 'http://schema.org/name', $expected_value), "$message_prefix author name was found (schema:name).");
  }

  /**
391
   * Tests output for article properties displayed in both view modes.
392 393 394 395 396 397
   *
   * @param \EasyRdf_Graph $graph
   *   The EasyRDF graph object.
   * @param string $message_prefix
   *   The word to use in the test assertion message.
   */
398
  protected function assertRdfaArticleProperties($graph, $message_prefix) {
399 400 401 402 403 404 405 406
    // Tags.
    $expected_value = array(
      'type' => 'uri',
      'value' => $this->termUri,
    );
    $this->assertTrue($graph->hasProperty($this->articleUri, 'http://schema.org/about', $expected_value), "$message_prefix tag was found (schema:about).");

    // Tag type.
407
    // @todo Enable with https://www.drupal.org/node/2072791.
408
    //$this->assertEqual($graph->type($this->termUri), 'schema:Thing', 'Tag type was found (schema:Thing).');
409 410 411 412

    // Tag name.
    $expected_value = array(
      'type' => 'literal',
413
      'value' => $this->term->getName(),
414 415
      'lang' => 'en',
    );
416
    // @todo Enable with https://www.drupal.org/node/2072791.
417
    //$this->assertTrue($graph->hasProperty($this->termUri, 'http://schema.org/name', $expected_value), "$message_prefix name was found (schema:name).");
418 419 420
  }

  /**
421
   * Tests output for comment properties on nodes in full page view mode.
422 423 424 425
   *
   * @param \EasyRdf_Graph $graph
   *   The EasyRDF graph object.
   */
426
  protected function assertRdfaNodeCommentProperties($graph) {
427 428 429 430 431 432 433
    // Relationship between node and comment.
    $expected_value = array(
      'type' => 'uri',
      'value' => $this->articleCommentUri,
    );
    $this->assertTrue($graph->hasProperty($this->articleUri, 'http://schema.org/comment', $expected_value), 'Relationship between node and comment found (schema:comment).');

434 435 436 437 438 439
    // Comment type.
    $this->assertEqual($graph->type($this->articleCommentUri), 'schema:Comment', 'Comment type was found (schema:Comment).');

    // Comment title.
    $expected_value = array(
      'type' => 'literal',
440
      'value' => $this->articleComment->get('subject')->value,
441 442 443 444 445 446 447
      'lang' => 'en',
    );
    $this->assertTrue($graph->hasProperty($this->articleCommentUri, 'http://schema.org/name', $expected_value), 'Article comment title was found (schema:name).');

    // Comment created date.
    $expected_value = array(
      'type' => 'literal',
448
      'value' => format_date($this->articleComment->get('created')->value, 'custom', 'c', 'UTC'),
449 450 451 452 453
      'lang' => 'en',
    );
    $this->assertTrue($graph->hasProperty($this->articleCommentUri, 'http://schema.org/dateCreated', $expected_value), 'Article comment created date was found (schema:dateCreated).');

    // Comment body.
454
    $text = $this->articleComment->get('comment_body')->value;
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
    $expected_value = array(
      'type' => 'literal',
      // There is an extra carriage return in the when parsing comments as
      // output by Bartik, so it must be added to the expected value.
      'value' => "$text
",
      'lang' => 'en',
    );
    $this->assertTrue($graph->hasProperty($this->articleCommentUri, 'http://schema.org/text', $expected_value), 'Article comment body was found (schema:text).');

    // Comment uid.
    $expected_value = array(
      'type' => 'uri',
      'value' => $this->commenterUri,
    );
    $this->assertTrue($graph->hasProperty($this->articleCommentUri, 'http://schema.org/author', $expected_value), 'Article comment author was found (schema:author).');

    // Comment author type.
    $this->assertEqual($graph->type($this->commenterUri), 'schema:Person', 'Comment author type was found (schema:Person).');

    // Comment author name.
    $expected_value = array(
      'type' => 'literal',
478
      'value' => $this->webUser->getUsername(),
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
    );
    $this->assertTrue($graph->hasProperty($this->commenterUri, 'http://schema.org/name', $expected_value), 'Comment author name was found (schema:name).');
  }

  /**
   * Creates a comment entity.
   *
   * @param int $nid
   *   Node id which will hold the comment.
   * @param int $uid
   *   User id of the author of the comment. Can be NULL if $contact provided.
   * @param mixed $contact
   *   Set to NULL for no contact info, TRUE to ignore success checking, and
   *   array of values to set contact info.
   * @param int $pid
   *   Comment id of the parent comment in a thread.
   *
496
   * @return \Drupal\comment\Entity\Comment
497 498
   *   The saved comment.
   */
499
  protected function saveComment($nid, $uid, $contact = NULL, $pid = 0) {
500
    $values = array(
501 502 503
      'entity_id' => $nid,
      'entity_type' => 'node',
      'field_name' => 'comment',
504 505
      'uid' => $uid,
      'pid' => $pid,
506 507
      'subject' => $this->randomMachineName(),
      'comment_body' => $this->randomMachineName(),
508 509 510 511 512 513 514 515 516 517 518 519 520 521
      'status' => 1,
    );
    if ($contact) {
      $values += $contact;
    }

    $comment = entity_create('comment', $values);
    $comment->save();
    return $comment;
  }

  /**
   * Get the EasyRdf_Graph object for a page.
   *
522 523
   * @param \Drupal\Core\Url $url
   *   The URL object for the page.
524 525 526 527
   *
   * @return \EasyRdf_Graph
   *   The RDF graph object.
   */
528
  protected function getRdfGraph(Url $url) {
529 530
    $parser = new \EasyRdf_Parser_Rdfa();
    $graph = new \EasyRdf_Graph();
531
    $parser->parse($graph, $this->drupalGet($url), 'rdfa', $this->baseUri);
532 533 534
    return $graph;
  }
}