Merge pull request #32 from humanmade/phpcs-tests

Add tests for our phpcs sniffs

Author: rmccue

.travis.yml

@@ -1,24 +1,10 @@
 language: php
 php:
-  - '5.6'
-  - '7.0'
   - '7.1'
-  - hhvm
 
 install:
   - composer install
   - npm install
 
-before_script:
-  - if [[ ! -d /tmp/phpcs ]]; then git clone -b 2.8.1 https://github.com/squizlabs/PHP_CodeSniffer.git /tmp/phpcs; fi
-  - cd /tmp/phpcs && composer install
-  - /tmp/phpcs/scripts/phpcs --config-set installed_paths $TRAVIS_BUILD_DIR
-
 script:
-  - /tmp/phpcs/vendor/bin/phpunit --filter HM
-
-cache:
-  directories:
-    - $HOME/.composer/cache/files
-    - $HOME/.npm
-    - /tmp/phpcs
+  - phpunit

HM/Tests/Classes/OnlyClassInFileUnitTest.fail.class

@@ -0,0 +1,15 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+class Bar {
+	public function test() {
+		echo 'bar';
+	}
+}
+
+class Foo {
+	public function test() {
+		echo 'foo';
+	}
+}

HM/Tests/Classes/OnlyClassInFileUnitTest.fail.function

@@ -0,0 +1,13 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+function foo() {
+	echo 'foo';
+}
+
+class Bar {
+	public function test() {
+		echo 'bar';
+	}
+}

HM/Tests/Classes/OnlyClassInFileUnitTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace HM\Tests\Classes;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class OnlyClassInFileUnitTest extends AbstractSniffUnitTest {
+
+	/**
+	 * Returns the lines where errors should occur.
+	 *
+	 * @return array <int line number> => <int number of errors>
+	 */
+	public function getErrorList() {
+		return [];
+	}
+
+	/**
+	 * Returns the lines where warnings should occur.
+	 *
+	 * @return array <int line number> => <int number of warnings>
+	 */
+	public function getWarningList() {
+		$file = func_get_arg( 0 );
+		list( $_, $type, $variant ) = explode( '.', $file, 3 );
+		if ( $type !== 'fail' ) {
+			return [];
+		}
+
+		return [
+			1 => 1,
+		];
+	}
+
+}

HM/Tests/Classes/OnlyClassInFileUnitTest.success.const

@@ -0,0 +1,11 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+const FOO = 'foo';
+
+class Bar {
+	public function test() {
+		echo 'bar';
+	}
+}

HM/Tests/Files/ClassFileNameUnitTest.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace HM\Tests\Files;
+
+use DirectoryIterator;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class ClassFileNameUnitTest extends AbstractSniffUnitTest {
+	/**
+	 * Get files to test against.
+	 *
+	 * Overridden from base to use the directory instead.
+	 */
+	protected function getTestFiles( $test_base_dir ) {
+		$test_base_dir = rtrim( $test_base_dir, '.' );
+		$test_files = [];
+
+		$di = new DirectoryIterator( $test_base_dir );
+
+		foreach ( $di as $file ) {
+			if ( $file->isDot() ) {
+				continue;
+			}
+
+			$test_files[] = $file->getPathname();
+		}
+
+		// Put them in order.
+		sort( $test_files );
+
+		return $test_files;
+	}
+
+	/**
+	 * Returns the lines where errors should occur.
+	 *
+	 * @return array <int line number> => <int number of errors>
+	 */
+	public function getErrorList() {
+		$file = func_get_arg( 0 );
+		$pass = [
+			'class-test.php',
+			'class-two-parts.php',
+		];
+		if ( in_array( $file, $pass, true ) ) {
+			return [];
+		}
+		return [
+			5 => 1,
+		];
+	}
+
+	/**
+	 * Returns the lines where warnings should occur.
+	 *
+	 * @return array <int line number> => <int number of warnings>
+	 */
+	public function getWarningList() {
+		return [];
+	}
+
+}

HM/Tests/Files/ClassFileNameUnitTest/class-Foo.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+class Foo {}

HM/Tests/Files/ClassFileNameUnitTest/class-bar.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+class Test {}

HM/Tests/Files/ClassFileNameUnitTest/class-test.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+class Test {}

HM/Tests/Files/ClassFileNameUnitTest/class-two-parts.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+class Two_Parts {}

HM/Tests/Files/ClassFileNameUnitTest/class-two_parts.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+class Two_Parts {}

HM/Tests/Files/ClassFileNameUnitTest/class-twoparts.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+class Two_Parts {}

HM/Tests/Files/ClassFileNameUnitTest/test.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+class Test {}

HM/Tests/Files/FunctionFileNameUnitTest.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace HM\Tests\Files;
+
+use DirectoryIterator;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class FunctionFileNameUnitTest extends AbstractSniffUnitTest {
+	/**
+	 * Get files to test against.
+	 *
+	 * Overridden from base to use the directory instead.
+	 */
+	protected function getTestFiles( $test_base_dir ) {
+		$test_base_dir = rtrim( $test_base_dir, '.' );
+		$test_files = [];
+
+		$di = new DirectoryIterator( $test_base_dir );
+
+		foreach ( $di as $file ) {
+			if ( $file->isDot() ) {
+				continue;
+			}
+
+			$test_files[] = $file->getPathname();
+		}
+
+		// Put them in order.
+		sort( $test_files );
+
+		return $test_files;
+	}
+
+	/**
+	 * Returns the lines where errors should occur.
+	 *
+	 * @return array <int line number> => <int number of errors>
+	 */
+	public function getErrorList() {
+		$file = func_get_arg( 0 );
+		$pass = [
+			'namespace.php',
+		];
+		if ( in_array( $file, $pass, true ) ) {
+			return [];
+		}
+		return [
+			5 => 1,
+		];
+	}
+
+	/**
+	 * Returns the lines where warnings should occur.
+	 *
+	 * @return array <int line number> => <int number of warnings>
+	 */
+	public function getWarningList() {
+		return [];
+	}
+
+}

HM/Tests/Files/FunctionFileNameUnitTest/namespace.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+function foo() {}

HM/Tests/Files/FunctionFileNameUnitTest/not-namespace.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+function foo() {}

HM/Tests/Files/NamespaceDirectoryNameUnitTest.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace HM\Tests\Files;
+
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class NamespaceDirectoryNameUnitTest extends AbstractSniffUnitTest {
+	/**
+	 * Get files to test against.
+	 *
+	 * Overridden from base to use the directory instead.
+	 */
+	protected function getTestFiles( $test_base_dir ) {
+		$test_base_dir = rtrim( $test_base_dir, '.' );
+		$test_files = [];
+
+		$di = new RecursiveIteratorIterator(
+			new RecursiveDirectoryIterator( $test_base_dir )
+		);
+
+		foreach ( $di as $file ) {
+			if ( ! $file->isFile() ) {
+				continue;
+			}
+
+			$test_files[] = $file->getPathname();
+		}
+
+		// Put them in order.
+		sort( $test_files );
+
+		return $test_files;
+	}
+
+	/**
+	 * Returns the lines where errors should occur.
+	 *
+	 * @return array <int line number> => <int number of errors>
+	 */
+	public function getErrorList() {
+		$file = func_get_arg( 0 );
+		switch ( $file ) {
+			case 'pass.php':
+				return [];
+
+			default:
+				return [
+					3 => 1,
+				];
+		}
+	}
+
+	/**
+	 * Returns the lines where warnings should occur.
+	 *
+	 * @return array <int line number> => <int number of warnings>
+	 */
+	public function getWarningList() {
+		return [];
+	}
+
+}

HM/Tests/Files/NamespaceDirectoryNameUnitTest/inc/pass.php

@@ -0,0 +1,3 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;

HM/Tests/Files/NamespaceDirectoryNameUnitTest/inc/standards/fail.php

@@ -0,0 +1,3 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;

HM/Tests/Files/NamespaceDirectoryNameUnitTest/inc/standards/tests/more/fail.php

@@ -0,0 +1,3 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;

HM/Tests/Files/NamespaceDirectoryNameUnitTest/inc/standards/tests/pass.php

@@ -0,0 +1,3 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;

HM/Tests/Files/NamespaceDirectoryNameUnitTest/inc/tests/more/fail.php

@@ -0,0 +1,3 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;

HM/Tests/Files/NamespaceDirectoryNameUnitTest/inc/tests/pass.php

@@ -0,0 +1,3 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;

HM/Tests/Layout/OrderUnitTest.php

@@ -1,6 +1,10 @@
 <?php
 
-class HM_Tests_Layout_OrderUnitTest extends AbstractSniffUnitTest {
+namespace HM\Tests\Layout;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+class OrderUnitTest extends AbstractSniffUnitTest {
 
 	/**
 	 * Returns the lines where errors should occur.

HM/Tests/Namespaces/NoLeadingSlashOnUseUnitTest.fail

@@ -0,0 +1,6 @@
+<?php
+
+namespace HM\Coding\Standards\Tests;
+
+use \HM\Other;
+use \WP_Post;