Merge pull request #319 from lloc/refactoring-version-2-8

Test Folders Refactoring

Author: lloc

.gitignore

@@ -4,10 +4,10 @@ package-lock.json
 phpunit.xml.bak
 .idea/
 .phpunit.result.cache
-coverage/
+tests/coverage/
+tests/playwright-results/
+tests/playwright-report/
 node_modules/
 vendor/
-/test-results/
-/playwright-report/
 /blob-report/
 /playwright/.cache/

composer.json

@@ -27,12 +27,12 @@
   },
   "autoload-dev": {
     "psr-4": {
-      "lloc\\MslsTests\\": "tests/"
+      "lloc\\MslsTests\\": "tests/phpunit/"
     }
   },
   "scripts": {
     "test": "vendor/bin/phpunit",
-    "coverage": "php -d xdebug.mode=coverage vendor/bin/phpunit --coverage-html coverage",
+    "coverage": "php -d xdebug.mode=coverage vendor/bin/phpunit --coverage-html tests/coverage",
     "analyze": "vendor/bin/phpstan analyze",
     "php74": "phpcs -p ./*.php includes/ --standard=vendor/phpcompatibility/php-compatibility/PHPCompatibility --runtime-set testVersion 7.4",
     "php81": "phpcs -p ./*.php includes/ --standard=vendor/phpcompatibility/php-compatibility/PHPCompatibility --runtime-set testVersion 8.1",

phpunit.xml

@@ -11,6 +11,6 @@
     <const name="WP_DEBUG" value="true"/>
   </php>
   <testsuite name="Internal tests">
-    <directory prefix="Test" suffix=".php">./tests/</directory>
+    <directory prefix="Test" suffix=".php">./tests/phpunit</directory>
   </testsuite>
 </phpunit>

playwright.config.ts

@@ -1,72 +1,23 @@
 import { defineConfig, devices } from '@playwright/test';
 
-/**
- * Read environment variables from file.
- * https://github.com/motdotla/dotenv
- */
-// require('dotenv').config();
-
-/**
- * See https://playwright.dev/docs/test-configuration.
- */
 export default defineConfig({
-  testDir: './tests/e2e/',
-  /* Run tests in files in parallel */
+  testDir: './tests/playwright/',
+  outputDir: './tests/playwright-results/',
   fullyParallel: true,
-  /* Fail the build on CI if you accidentally left test.only in the source code. */
   forbidOnly: !!process.env.CI,
-  /* Retry on CI only */
   retries: process.env.CI ? 2 : 0,
-  /* Opt out of parallel tests on CI. */
   workers: process.env.CI ? 1 : undefined,
-  /* Reporter to use. See https://playwright.dev/docs/test-reporters */
-  reporter: 'html',
-  /* Shared settings for all the projects below. See https://playwright.dev/docs/api/class-testoptions. */
+  reporter: [
+    ['list'],
+    ['json', {  outputFile: './tests/playwright-report/test-results.json' }]
+  ],
   use: {
-    /* Base URL to use in actions like `await page.goto('/')`. */
-    // baseURL: 'http://127.0.0.1:3000',
-
-    /* Collect trace when retrying the failed test. See https://playwright.dev/docs/trace-viewer */
     trace: 'on-first-retry',
   },
-
-  /* Configure projects for major browsers */
   projects: [
     {
       name: 'chromium',
       use: { ...devices['Desktop Chrome'] },
     },
-
-    {
-      name: 'firefox',
-      use: { ...devices['Desktop Firefox'] },
-    },
-
-    /* Test against mobile viewports. */
-    // {
-    //   name: 'Mobile Chrome',
-    //   use: { ...devices['Pixel 5'] },
-    // },
-    // {
-    //   name: 'Mobile Safari',
-    //   use: { ...devices['iPhone 12'] },
-    // },
-
-    /* Test against branded browsers. */
-    // {
-    //   name: 'Microsoft Edge',
-    //   use: { ...devices['Desktop Edge'], channel: 'msedge' },
-    // },
-    // {
-    //   name: 'Google Chrome',
-    //   use: { ...devices['Desktop Chrome'], channel: 'chrome' },
-    // },
   ],
-
-  /* Run your local dev server before starting the tests */
-  // webServer: {
-  //   command: 'npm run start',
-  //   url: 'http://127.0.0.1:3000',
-  //   reuseExistingServer: !process.env.CI,
-  // },
 });

tests/Component/Icon/TestIconPng.php renamed to tests/phpunit/Component/Icon/TestIconPng.php

@@ -3,13 +3,13 @@
 namespace lloc\MslsTests\Component\Icon;
 
 use Brain\Monkey\Functions;
-use lloc\MslsTests\MslsUnitTestCase;
 use lloc\Msls\Component\Icon\IconPng;
+use lloc\MslsTests\MslsUnitTestCase;
 
 class TestIconPng extends MslsUnitTestCase {
 
 	public function test_get(): void {
-		Functions\when( 'plugin_dir_path' )->justReturn( dirname( __DIR__, 3 ) . '/' );
+		Functions\when( 'plugin_dir_path' )->justReturn( dirname( __DIR__, 4 ) . '/' );
 
 		$obj = new IconPng();
 
@@ -18,5 +18,4 @@ public function test_get(): void {
 		$this->assertEquals( 'catalonia.png', $obj->get( 'ca' ) );
 		$this->assertEquals( 'ko.png', $obj->get( 'pinko' ) );
 	}
-
 }

tests/Component/Icon/TestIconSvg.php renamed to tests/phpunit/Component/Icon/TestIconSvg.php

@@ -3,13 +3,13 @@
 namespace lloc\MslsTests\Component\Icon;
 
 use Brain\Monkey\Functions;
-use lloc\MslsTests\MslsUnitTestCase;
 use lloc\Msls\Component\Icon\IconSvg;
+use lloc\MslsTests\MslsUnitTestCase;
 
 class TestIconSvg extends MslsUnitTestCase {
 
 	public function test_get(): void {
-		Functions\when( 'plugin_dir_path' )->justReturn( dirname( __DIR__, 3 ) . '/' );
+		Functions\when( 'plugin_dir_path' )->justReturn( dirname( __DIR__, 4 ) . '/' );
 
 		$obj = new IconSvg();
 
@@ -18,5 +18,4 @@ public function test_get(): void {
 		$this->assertEquals( 'flag-icon-es-ca', $obj->get( 'ca' ) );
 		$this->assertEquals( 'flag-icon-ko', $obj->get( 'pinko' ) );
 	}
-
 }

tests/Map/TestHrefLang.php renamed to tests/phpunit/Map/TestHrefLang.php

@@ -2,35 +2,36 @@
 
 namespace lloc\MslsTests\Map;
 
-use Brain\Monkey\Functions;
 use Brain\Monkey\Filters;
-
-use lloc\MslsTests\MslsUnitTestCase;
+use Brain\Monkey\Functions;
 use lloc\Msls\Map\HrefLang;
 use lloc\Msls\MslsBlog;
 use lloc\Msls\MslsBlogCollection;
+use lloc\MslsTests\MslsUnitTestCase;
 
 class TestHrefLang extends MslsUnitTestCase {
 
 	protected function setUp(): void {
 		parent::setUp();
 
-		$map = [
+		$map = array(
 			'de_DE'        => 'de',
 			'de_DE_formal' => 'de',
 			'fr_FR'        => 'fr',
 			'es_ES'        => 'es',
 			'cat'          => 'cat',
 			'en_US'        => 'en',
 			'en_GB'        => 'en',
-		];
+		);
 
 		foreach ( $map as $locale => $alpha2 ) {
 			$blog = \Mockery::mock( MslsBlog::class );
-			$blog->shouldReceive( [
-				'get_alpha2'   => $alpha2,
-				'get_language' => $locale,
-			] );
+			$blog->shouldReceive(
+				array(
+					'get_alpha2'   => $alpha2,
+					'get_language' => $locale,
+				)
+			);
 
 			$blogs[] = $blog;
 		}
@@ -57,5 +58,4 @@ public function test_get_has_filter(): void {
 
 		$this->assertEquals( 'en-US', $this->test->get( 'en_US' ) );
 	}
-
 }

tests/MslsUnitTestCase.php renamed to tests/phpunit/MslsUnitTestCase.php

@@ -2,9 +2,9 @@
 
 namespace lloc\MslsTests;
 
-use PHPUnit\Framework\TestCase;
 use Brain\Monkey;
 use Brain\Monkey\Functions;
+use PHPUnit\Framework\TestCase;
 
 class MslsUnitTestCase extends TestCase {
 

tests/Query/TestTranslatedPostsQuery.php renamed to tests/phpunit/Query/TestTranslatedPostsQuery.php

@@ -2,9 +2,9 @@
 
 namespace lloc\MslsTests\Query;
 
-use lloc\MslsTests\MslsUnitTestCase;
-use lloc\Msls\Query\TranslatedPostIdQuery;
 use lloc\Msls\MslsSqlCacher;
+use lloc\Msls\Query\TranslatedPostIdQuery;
+use lloc\MslsTests\MslsUnitTestCase;
 
 class TestTranslatedPostsQuery extends MslsUnitTestCase {
 

tests/TestMslsAdmin.php renamed to tests/phpunit/TestMslsAdmin.php

@@ -3,16 +3,15 @@
 namespace lloc\MslsTests;
 
 use Brain\Monkey\Functions;
-
 use lloc\Msls\MslsAdmin;
 use lloc\Msls\MslsBlog;
-use lloc\Msls\MslsOptions;
 use lloc\Msls\MslsBlogCollection;
+use lloc\Msls\MslsOptions;
 
 class TestMslsAdmin extends MslsUnitTestCase {
 
-	public function get_sut( array $users = [] ): MslsAdmin {
-		Functions\when( 'get_option' )->justReturn( [] );
+	public function get_sut( array $users = array() ): MslsAdmin {
+		Functions\when( 'get_option' )->justReturn( array() );
 		Functions\when( 'update_option' )->justReturn( true );
 		Functions\when( 'get_current_blog_id' )->justReturn( 1 );
 		Functions\when( 'checked' )->justReturn( '' );
@@ -22,7 +21,7 @@ public function get_sut( array $users = [] ): MslsAdmin {
 
 		$options = \Mockery::mock( MslsOptions::class );
 		$options->shouldReceive( 'is_empty' )->andReturns( false );
-		$options->shouldReceive( 'get_available_languages' )->andReturns( [ 'de_DE', 'it_IT' ] );
+		$options->shouldReceive( 'get_available_languages' )->andReturns( array( 'de_DE', 'it_IT' ) );
 		$options->shouldReceive( 'get_icon_type' )->andReturns( 'flag' );
 
 		$blog = \Mockery::mock( MslsBlog::class );
@@ -41,12 +40,12 @@ public function get_sut( array $users = [] ): MslsAdmin {
 
 		$blogs[] = $blog;
 		if ( empty( $users ) ) {
-			$users = [
-				(object) [
+			$users = array(
+				(object) array(
 					'ID'            => 1,
-					'user_nicename' => 'realloc'
-				]
-			];
+					'user_nicename' => 'realloc',
+				),
+			);
 		}
 
 		$collection = \Mockery::mock( MslsBlogCollection::class );
@@ -59,7 +58,7 @@ public function get_sut( array $users = [] ): MslsAdmin {
 
 	public function test_has_problems_no_problem(): void {
 		$options = \Mockery::mock( MslsOptions::class );
-		$options->shouldReceive( 'get_available_languages' )->andReturns( [ 'de_DE', 'it_IT' ] );
+		$options->shouldReceive( 'get_available_languages' )->andReturns( array( 'de_DE', 'it_IT' ) );
 
 		$collection = \Mockery::mock( MslsBlogCollection::class );
 		$options->shouldReceive( 'is_empty' )->andReturns( false );
@@ -71,7 +70,7 @@ public function test_has_problems_no_problem(): void {
 
 	public function test_has_problems_one_language(): void {
 		$options = \Mockery::mock( MslsOptions::class );
-		$options->shouldReceive( 'get_available_languages' )->andReturns( [ 'de_DE', ] );
+		$options->shouldReceive( 'get_available_languages' )->andReturns( array( 'de_DE' ) );
 
 		$collection = \Mockery::mock( MslsBlogCollection::class );
 		$options->shouldReceive( 'is_empty' )->andReturns( false );
@@ -84,7 +83,7 @@ public function test_has_problems_one_language(): void {
 	}
 
 	public function test_has_problems_is_empty(): void {
-		Functions\when( 'get_option' )->justReturn( [] );
+		Functions\when( 'get_option' )->justReturn( array() );
 		Functions\when( 'get_current_blog_id' )->justReturn( 1 );
 		Functions\when( 'admin_url' )->justReturn( '' );
 
@@ -135,10 +134,13 @@ public function test_admin_display(): void {
 	}
 
 	public function test_reference_user(): void {
-		$users    = [];
+		$users    = array();
 		$too_much = MslsAdmin::MAX_REFERENCE_USERS + 1;
-		for ( $i = 1; $i <= $too_much; $i ++ ) {
-			$users[] = (object) [ 'ID' => $i, 'user_nicename' => 'realloc' ];
+		for ( $i = 1; $i <= $too_much; $i++ ) {
+			$users[] = (object) array(
+				'ID'            => $i,
+				'user_nicename' => 'realloc',
+			);
 		}
 
 		$obj = $this->get_sut( $users );
@@ -289,7 +291,7 @@ function test_rewrite_pallino(): void {
 		$obj = $this->get_sut();
 
 		$post_type          = \Mockery::mock( \WP_Post_Type::class );
-		$post_type->rewrite = [ 'slug' => 'pallino_slug' ];
+		$post_type->rewrite = array( 'slug' => 'pallino_slug' );
 
 		Functions\when( 'get_post_type_object' )->justReturn( $post_type );
 
@@ -318,17 +320,29 @@ function test_content_priority(): void {
 	function test_validate(): void {
 		$obj = $this->get_sut();
 
-		$arr = [];
-		$this->assertEquals( [ 'display' => 0 ], $obj->validate( $arr ) );
-		$arr = [ 'image_url' => '/test/', 'display' => '1' ];
-		$this->assertEquals( [ 'image_url' => '/test', 'display' => 1 ], $obj->validate( $arr ) );
+		$arr = array();
+		$this->assertEquals( array( 'display' => 0 ), $obj->validate( $arr ) );
+		$arr = array(
+			'image_url' => '/test/',
+			'display'   => '1',
+		);
+		$this->assertEquals(
+			array(
+				'image_url' => '/test',
+				'display'   => 1,
+			),
+			$obj->validate( $arr )
+		);
 	}
 
 	function test_set_blog_language(): void {
 		$obj = $this->get_sut();
 
-		$arr = [ 'abc' => true, 'blog_language' => 'it_IT' ];
-		$this->assertEquals( [ 'abc' => true ], $obj->set_blog_language( $arr ) );
+		$arr = array(
+			'abc'           => true,
+			'blog_language' => 'it_IT',
+		);
+		$this->assertEquals( array( 'abc' => true ), $obj->set_blog_language( $arr ) );
 	}
 
 	function test_render(): void {
@@ -370,7 +384,10 @@ function test_advanced_section(): void {
 	function test_rewrites_section(): void {
 		$obj = $this->get_sut();
 
-		foreach ( [ 'post' => 'Post', 'page' => 'Page' ] as $name => $label ) {
+		foreach ( array(
+			'post' => 'Post',
+			'page' => 'Page',
+		) as $name => $label ) {
 			$post_type        = \Mockery::mock( \WP_Post_Type::class );
 			$post_type->name  = $name;
 			$post_type->label = $label;
@@ -383,5 +400,4 @@ function test_rewrites_section(): void {
 
 		$this->assertEquals( 2, $obj->rewrites_section() );
 	}
-
 }