Merge pull request #14 from tattersoftware/test

Test Cases

Author: MGatner

.github/workflows/test.yml

@@ -85,6 +85,7 @@ jobs:
     steps:
       - name: Upload Coveralls results
         uses: coverallsapp/github-action@master
+        continue-on-error: true
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           parallel-finished: true

src/Test/BundlesTestCase.php

@@ -0,0 +1,57 @@
+<?php
+
+namespace Tatter\Frontend\Test;
+
+use CodeIgniter\Publisher\Publisher;
+use Tatter\Frontend\FrontendBundle;
+
+abstract class BundlesTestCase extends TestCase
+{
+    private $didPublish = false;
+
+    /**
+     * Publishes all files once so they are
+     * available for bundles.
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        // Make sure everything is published
+        if (! $this->didPublish) {
+            foreach (Publisher::discover() as $publisher) {
+                $publisher->publish();
+            }
+
+            $this->didPublish = true;
+        }
+    }
+
+    /**
+     * @dataProvider bundleProvider
+     *
+     * @param class-string<FrontendBundle> $class
+     * @param string[]                     $expectedHeadFiles
+     * @param string[]                     $expectedBodyFiles
+     */
+    public function testBundlesFiles(string $class, array $expectedHeadFiles, array $expectedBodyFiles): void
+    {
+        $bundle = new $class();
+        $head   = $bundle->head();
+        $body   = $bundle->body();
+
+        foreach ($expectedHeadFiles as $file) {
+            $this->assertStringContainsString($file, $head);
+        }
+
+        foreach ($expectedBodyFiles as $file) {
+            $this->assertStringContainsString($file, $body);
+        }
+    }
+
+    /**
+     * Returns an array of items to test with each item
+     * as a triple of [string publisherClassName, string[] headFileNames, string[] bodyFileNames]
+     */
+    abstract public function bundleProvider(): array;
+}

src/Test/PublishersTestCase.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Tatter\Frontend\Test;
+
+use Tatter\Frontend\FrontendPublisher;
+
+abstract class PublishersTestCase extends TestCase
+{
+    /**
+     * @dataProvider publisherProvider
+     *
+     * @param class-string<FrontendPublisher> $class
+     * @param string[]                        $expected
+     */
+    public function testPublishesFiles(string $class, array $expected): void
+    {
+        $publisher = new $class();
+        $result    = $publisher->publish();
+
+        // Verify that publication succeeded
+        $this->assertTrue($result);
+        $this->assertSame([], $publisher->getErrors());
+        $this->assertNotSame([], $publisher->getPublished());
+
+        // Check for each of the expected files
+        foreach ($expected as $path) {
+            $file = $this->config->directory . $this->config->vendor . $path;
+            $this->assertFileExists($file);
+        }
+    }
+
+    /**
+     * Returns an array of items to test with each item
+     * as a tuple of [string publisherClassName, string[] expectedFileNames]
+     */
+    abstract public function publisherProvider(): array;
+}

tests/_support/TestCase.php src/Test/TestCase.phptests/_support/TestCase.php renamed to src/Test/TestCase.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Tests\Support;
+namespace Tatter\Frontend\Test;
 
 use CodeIgniter\Test\CIUnitTestCase;
 use org\bovigo\vfs\vfsStream;

tests/BundlesTest.php

@@ -2,58 +2,14 @@
 
 namespace Tatter\Frontend\Bundles;
 
-use CodeIgniter\Publisher\Publisher;
-use Tatter\Frontend\FrontendBundle;
-use Tests\Support\TestCase;
+use Tatter\Frontend\Test\BundlesTestCase;
 
 /**
  * @internal
  */
-final class BundlesTest extends TestCase
+final class BundlesTest extends BundlesTestCase
 {
-    private $didPublish = false;
-
-    /**
-     * Publishes all files once so they are
-     * available for bundles.
-     */
-    protected function setUp(): void
-    {
-        parent::setUp();
-
-        // Make sure everything is published
-        if (! $this->didPublish) {
-            foreach (Publisher::discover() as $publisher) {
-                $publisher->publish();
-            }
-
-            $this->didPublish = true;
-        }
-    }
-
-    /**
-     * @dataProvider bundleProvider
-     *
-     * @param class-string<FrontendBundle> $class
-     * @param string[]                     $expectedHeadFiles
-     * @param string[]                     $expectedBodyFiles
-     */
-    public function testBundlesFiles(string $class, array $expectedHeadFiles, array $expectedBodyFiles): void
-    {
-        $bundle = new $class();
-        $head   = $bundle->head();
-        $body   = $bundle->body();
-
-        foreach ($expectedHeadFiles as $file) {
-            $this->assertStringContainsString($file, $head);
-        }
-
-        foreach ($expectedBodyFiles as $file) {
-            $this->assertStringContainsString($file, $body);
-        }
-    }
-
-    public function bundleProvider()
+    public function bundleProvider(): array
     {
         return [
             [

tests/FrontendPublisherTest.php

@@ -1,7 +1,7 @@
 <?php
 
 use Tatter\Frontend\FrontendPublisher;
-use Tests\Support\TestCase;
+use Tatter\Frontend\Test\TestCase;
 
 /**
  * @internal

tests/PublishersTest.php

@@ -2,38 +2,14 @@
 
 namespace Tatter\Frontend\Publishers;
 
-use Tatter\Frontend\FrontendPublisher;
-use Tests\Support\TestCase;
+use Tatter\Frontend\Test\PublishersTestCase;
 
 /**
  * @internal
  */
-final class PublishersTest extends TestCase
+final class PublishersTest extends PublishersTestCase
 {
-    /**
-     * @dataProvider publisherProvider
-     *
-     * @param class-string<FrontendPublisher> $class
-     * @param string[]                        $expected
-     */
-    public function testPublishesFiles(string $class, array $expected): void
-    {
-        $publisher = new $class();
-        $result    = $publisher->publish();
-
-        // Verify that publication succeeded
-        $this->assertTrue($result);
-        $this->assertSame([], $publisher->getErrors());
-        $this->assertNotSame([], $publisher->getPublished());
-
-        // Check for each of the expected files
-        foreach ($expected as $path) {
-            $file = $this->config->directory . $this->config->vendor . $path;
-            $this->assertFileExists($file);
-        }
-    }
-
-    public function publisherProvider()
+    public function publisherProvider(): array
     {
         return [
             [