Issue #3043010 by Pancho: Split AdminIdTest to TemplateUploadTest and...

Issue #3043010 by Pancho: Split AdminIdTest to TemplateUploadTest and FillPdfOverviewFormTest preserving history (3)

tests/src/Functional/TemplateUploadTest.php

+<?php
+
+namespace Drupal\Tests\fillpdf\Functional;
+
+use Drupal\field\Tests\EntityReference\EntityReferenceTestTrait;
+use Drupal\file\Entity\File;
+use Drupal\fillpdf\Entity\FillPdfForm;
+use Drupal\simpletest\ContentTypeCreationTrait;
+use Drupal\user\Entity\Role;
+use Drupal\Tests\BrowserTestBase;
+use Drupal\Tests\TestFileCreationTrait;
+use Drupal\Tests\fillpdf\Traits\TestFillPdfTrait;
+
+/**
+ * Ensure Edit links for PDFs at /admin/structure/fillpdf function correctly.
+ *
+ * @group fillpdf
+ */
+class AdminIdTest extends BrowserTestBase {
+
+  use ContentTypeCreationTrait;
+  use EntityReferenceTestTrait;
+  use TestFileCreationTrait;
+  use TestFillPdfTrait;
+
+  static public $modules = ['fillpdf_test'];
+  protected $profile = 'minimal';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    $this->configureBackend();
+    $this->initializeUser();
+  }
+
+  /**
+   * Tests the overview form's PDF file upload functionality.
+   */
+  public function testOverviewFormUpload() {
+    $this->drupalGet('admin/structure/fillpdf');
+
+    // Check if the 'accept' attribute is correctly set.
+    $this->assertSession()->elementAttributeContains('css', '#edit-upload-pdf', 'accept', 'application/pdf');
+
+    // Without a PDF file being supplied, no FillPdfForm should be created.
+    $this->uploadTestPdf(NULL);
+    $this->assertSession()->pageTextNotContains('New FillPDF form has been created.');
+
+    // With a .txt file being supplied, validation should set an error.
+    $files = $this->getTestFiles('text');
+    $file = reset($files);
+    $this->drupalPostForm(NULL, ['files[upload_pdf]' => $file->uri], 'Upload');
+    $this->assertSession()->statusCodeEquals(200);
+    $this->assertSession()->pageTextNotContains('New FillPDF form has been created.');
+    $this->assertSession()->pageTextContains('Only PDF files are supported, and they must end in .pdf.');
+
+    // With a PDF file being supplied, a new FillPdfForm should be created.
+    $this->uploadTestPdf('fillpdf_test_v3.pdf');
+    $this->assertSession()->pageTextContains('New FillPDF form has been created.');
+  }
+
+  /**
+   * Tests the overview form's operation links.
+   */
+  public function testOverviewFormLinks() {
+    $this->uploadTestPdf('fillpdf_test_v3.pdf');
+
+    // Set the administrative title and check if it has been successfully set.
+    $admin_title = 'Example form';
+    $this->drupalPostForm(NULL, ['admin_title[0][value]' => $admin_title], 'Save');
+    $this->assertSession()->pageTextContains("FillPDF Form $admin_title has been updated.");
+    $this->assertSession()->fieldValueEquals('edit-admin-title-0-value', $admin_title);
+
+    // Go back to the overview page.
+    $this->drupalGet('admin/structure/fillpdf');
+
+    // Check if the administrative title appears in the view.
+    $this->assertSession()->pageTextContains($admin_title);
+
+    // Check hook_entity_operation_alter(). Only the altered link should exist.
+    $this->assertSession()->linkExistsExact('Import configuration test');
+    $this->assertSession()->linkNotExistsExact('Import configuration');
+
+    // Check hook_entity_operation(). Both links should exist.
+    $this->assertSession()->linkExistsExact('Export configuration test');
+    $this->assertSession()->linkExistsExact('Export configuration');
+  }
+
+  /**
+   * Tests the FillPdfForm entity's edit form.
+   */
+  public function testFillPdfFormForm() {
+    $this->uploadTestPdf('fillpdf_test_v3.pdf');
+
+    $latest_fid = $this->getLatestFillPdfForm();
+    $latest_fillpdf_form = FillPdfForm::load($latest_fid);
+    $max_fid_after = $latest_fillpdf_form->fid->value;
+    $this->drupalGet('admin/structure/fillpdf/' . $max_fid_after);
+    $this->assertSession()->statusCodeEquals(200);
+
+    // Check if the 'accept' attribute is correctly set.
+    $this->assertSession()->elementAttributeContains('css', '#edit-upload-pdf', 'accept', 'application/pdf');
+
+    // When trying to upload a .txt file, validation should set an error.
+    $files = $this->getTestFiles('text');
+    $file = reset($files);
+    $this->drupalPostForm(NULL, ['files[upload_pdf]' => $file->uri], 'Save');
+    $this->assertSession()->statusCodeEquals(200);
+    $this->assertSession()->pageTextContains('Only PDF files are supported, and they must end in .pdf.');
+  }
+
+  /**
+   * Tests proper registration of managed_files.
+   */
+  public function testFillPdfFileUsage() {
+    $this->uploadTestPdf('fillpdf_test_v3.pdf');
+
+    // Set the administrative title and check if it has been successfully set.
+    $admin_title = 'Example form';
+    $this->drupalPostForm(NULL, ['admin_title[0][value]' => $admin_title], 'Save');
+    $this->assertSession()->pageTextContains("FillPDF Form $admin_title has been updated.");
+    $this->assertSession()->fieldValueEquals('edit-admin-title-0-value', $admin_title);
+
+    // Grant additional permission to the logged in user.
+    $existing_user_roles = $this->loggedInUser->getRoles(TRUE);
+    $role_to_modify = Role::load(end($existing_user_roles));
+    $this->grantPermissions($role_to_modify, ['access files overview']);
+
+    // Check if the uploaded test PDF file is properly registered as a permanent
+    // managed_file.
+    $fillpdf_form = FillPdfForm::load($this->getLatestFillPdfForm());
+    $file_id = $fillpdf_form->get('file')->first()->getValue()['target_id'];
+    $this->drupalPostForm('admin/content/files', ['edit-filename' => 'fillpdf_test_v3.pdf'], 'Filter');
+    $this->assertSession()->elementsCount('css', 'table td.views-field.views-field-filename', 1);
+    $this->assertSession()->pageTextContains('Permanent');
+    // @todo Past 8.6.x, use File::load($file_id)->createFileUrl() directly.
+    // See https://www.drupal.org/project/fillpdf/issues/3023341.
+    $file_uri = File::load($file_id)->getFileUri();
+    $this->assertSession()->linkByHrefExists(file_create_url($file_uri));
+
+    // Now go check the File usage screen and see if the FillPdfForm is listed
+    // with its canonical link.
+    $this->drupalGet("admin/content/files/usage/$file_id");
+    $this->assertSession()->statusCodeEquals(200);
+    $this->assertSession()->linkByHrefExists($fillpdf_form->toUrl()->toString());
+  }
+
+  /**
+   * Tests an entity reference to a FillPdfForm.
+   */
+  public function testEntityReference() {
+    // Create new FillPdfForm.
+    $this->uploadTestPdf('fillpdf_test_v3.pdf');
+    $fid = $this->getLatestFillPdfForm();
+
+    // Set the administrative title.
+    $admin_title = 'Example form';
+    $this->drupalPostForm("admin/structure/fillpdf/{$fid}", ['admin_title[0][value]' => $admin_title], 'Save');
+    $this->assertSession()->statusCodeEquals(200);
+
+    // Create host content type.
+    $bundle = $this->createContentType();
+    $bundle_id = $bundle->id();
+
+    // Create an entity reference to our FillPdfForm.
+    $this->createEntityReferenceField('node', $bundle_id, 'field_fillpdf_form', 'FillPDF form', 'fillpdf_form');
+    $this->container->get('entity_type.manager')
+      ->getStorage('entity_form_display')
+      ->load("node.{$bundle_id}.default")
+      ->setComponent('field_fillpdf_form', [
+        'type' => 'options_select',
+      ])->save();
+    $this->container->get('entity_type.manager')
+      ->getStorage('entity_view_display')
+      ->load("node.{$bundle_id}.default")
+      ->setComponent('field_fillpdf_form', [
+        'type' => 'entity_reference_label',
+        'settings' => ['link' => TRUE],
+      ])->save();
+
+    // Grant additional permission to the logged in user.
+    $existing_user_roles = $this->loggedInUser->getRoles(TRUE);
+    $role_to_modify = Role::load(end($existing_user_roles));
+    $this->grantPermissions($role_to_modify, ["create $bundle_id content"]);
+
+    // On a new node, check if the select contains an option with the
+    // administrative title we have set.
+    $this->drupalGet("/node/add/{$bundle_id}");
+    $this->assertSession()->statusCodeEquals(200);
+    $this->assertSession()->optionExists('edit-field-fillpdf-form', $admin_title);
+
+    // Select our FillPdfForm reference, save and see the label is rendered as
+    // canonical link.
+    $edit = [
+      'title[0][value]' => 'Test node',
+      'field_fillpdf_form' => $fid,
+    ];
+    $this->drupalPostForm(NULL, $edit, 'Save');
+    $fillpdf_form = FillPdfForm::load($fid);
+    $this->assertSession()->linkByHrefExists($fillpdf_form->toUrl()->toString());
+
+  }
+
+}