ProjectUnitTest.php in Coder 8.3.x

Namespace

DrupalPractice\Test\ProjectDetection

File

tests/DrupalPractice/ProjectDetection/ProjectUnitTest.php

<?php

namespace DrupalPractice\Test\ProjectDetection;

use Drupal\Test\PhpunitCompatibilityTestCase;
use DrupalPractice\Project;

/**
 * Tests that project and version detection works.
 */
class ProjectUnitTest extends PhpunitCompatibilityTestCase {

  /**
   * The mocked file object for testing.
   *
   * @var \PHP_CodeSniffer\Files\File|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $phpcsFile;

  /**
   * {@inheritdoc}
   *
   * @return void
   */
  protected function compatibleSetUp() {
    $this->phpcsFile = $this
      ->getMockBuilder('\\PHP_CodeSniffer\\Files\\File')
      ->disableOriginalConstructor()
      ->getMock();
  }

  //end compatibleSetUp()

  /**
   * Tests the extending classes Sniff class.
   *
   * @return void
   */
  public function testInfoFileDetection() {
    $this->phpcsFile
      ->expects($this
      ->any())
      ->method('getFilename')
      ->will($this
      ->returnValue(__DIR__ . '/drupal6/test.php'));
    $this
      ->assertEquals(Project::getInfoFile($this->phpcsFile), __DIR__ . '/drupal6/testmodule.info');
  }

  //end testInfoFileDetection()

  /**
   * Tests the extending classes Sniff class.
   *
   * @return void
   */
  public function testInfoFileNestedDetection() {
    $this->phpcsFile
      ->expects($this
      ->any())
      ->method('getFilename')
      ->will($this
      ->returnValue(__DIR__ . '/drupal6/nested/test.php'));
    $this
      ->assertEquals(Project::getInfoFile($this->phpcsFile), __DIR__ . '/drupal6/testmodule.info');
  }

  //end testInfoFileNestedDetection()

  /**
   * Tests the extending classes Sniff class.
   *
   * @param string $filename    Name of the file that will be checked.
   * @param string $coreVersion Expected core version for the file.
   *
   * @dataProvider coreVersionProvider
   *
   * @return void
   */
  public function testCoreVersion($filename, $coreVersion) {
    $this->phpcsFile
      ->expects($this
      ->any())
      ->method('getFilename')
      ->will($this
      ->returnValue($filename));
    $this
      ->assertEquals(Project::getCoreVersion($this->phpcsFile), $coreVersion);
  }

  //end testCoreVersion()

  /**
   * Data provider for testCoreVersion().
   *
   * @return array<int, array<int, string|int>>
   */
  public function coreVersionProvider() : array {
    return [
      [
        __DIR__ . '/drupal6/nested/test.php',
        6,
      ],
      [
        __DIR__ . '/drupal7/test.php',
        7,
      ],
      [
        __DIR__ . '/drupal8/test.php',
        8,
      ],
      [
        'invalid',
        8,
      ],
      [
        __DIR__ . '/directory.info/test.php',
        8,
      ],
    ];
  }

  //end coreVersionProvider()

  /**
   * Tests the extending classes Sniff class.
   *
   * @param string $filename    Name of the file that will be checked.
   * @param string $projectname Expected project name for the file.
   *
   * @dataProvider projectNameDetectionProvider
   *
   * @return void
   */
  public function testProjectNameDetection($filename, $projectname) {
    $this->phpcsFile
      ->expects($this
      ->any())
      ->method('getFilename')
      ->will($this
      ->returnValue($filename));
    $this
      ->assertEquals(Project::getName($this->phpcsFile), $projectname);
  }

  //end testProjectNameDetection()

  /**
   * Data provider for testProjectNameDetection().
   *
   * @return array<int, array<int, string|false>>
   *   An array of test cases, each test case an array with two elements:
   *   - The filename to check.
   *   - The expected project name.
   */
  public function projectNameDetectionProvider() : array {
    return [
      [
        __DIR__ . '/drupal6/testmodule.info',
        'testmodule',
      ],
      [
        __DIR__ . '/drupal6/nested/test.php',
        'testmodule',
      ],
      [
        __DIR__ . '/drupal7/testmodule.info',
        'testmodule',
      ],
      [
        __DIR__ . '/drupal8/testmodule.info.yml',
        'testmodule',
      ],
      [
        __DIR__ . '/drupal8/testtheme/testtheme.info.yml',
        'testtheme',
      ],
      [
        __DIR__ . '/drupal8/testtheme/testtheme.theme',
        'testtheme',
      ],
      [
        'invalid',
        false,
      ],
    ];
  }

}

//end class

Classes

Name	Description
ProjectUnitTest	Tests that project and version detection works.