feat: pest testing framework added

Author: mitulgolakiya

.github/workflows/run-tests.yml

@@ -29,4 +29,4 @@ jobs:
         run: composer install --prefer-dist --no-interaction --no-suggest
 
       - name: Execute tests
-        run: vendor/bin/phpunit --verbose
+        run: vendor/bin/pest

composer.json

@@ -32,7 +32,10 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5.10",
-        "mockery/mockery": "^1.4.4"
+        "mockery/mockery": "^1.4.4",
+        "orchestra/testbench": "^7.5",
+        "pestphp/pest": "^1.21",
+        "pestphp/pest-plugin-laravel": "^1.2"
     },
     "autoload": {
         "psr-4": {
@@ -61,5 +64,10 @@
         }
     ],
     "minimum-stability": "dev",
-    "prefer-stable": true
+    "prefer-stable": true,
+    "config": {
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
+    }
 }

phpunit.xml.dist

@@ -7,11 +7,14 @@
          convertNoticesToExceptions="true"
          convertWarningsToExceptions="true"
          processIsolation="false"
-         stopOnFailure="false"
-         syntaxCheck="false">
+         stopOnFailure="false">
     <testsuites>
         <testsuite name="Package Test Suite">
             <directory suffix=".php">./tests/</directory>
         </testsuite>
     </testsuites>
+
+    <php>
+        <env name="APP_KEY" value="BckfSJCXivnK6r38GVIWUAxmbBSjTsmF"/>
+    </php>
 </phpunit>

src/Commands/RollbackGeneratorCommand.php

@@ -63,7 +63,7 @@ public function handle()
     {
         $type = $this->argument('type');
         if (!in_array($type, ['api', 'scaffold', 'api_scaffold'])) {
-            $this->error('invalid rollback type');
+            $this->error('Invalid rollback type');
 
             return 1;
         }

tests/Commands/PublishTablesCommandTest.php

@@ -0,0 +1,8 @@
+<?php
+
+use InfyOm\Generator\Commands\Publish\PublishTablesCommand;
+use function Pest\Laravel\artisan;
+
+it('thrown exceptions with invalid type passed', function () {
+    artisan(PublishTablesCommand::class, ['type' => 'invalid']);
+})->throws(Exception::class, 'Invalid Table Type');

tests/Commands/RollbackGeneratorCommandTest.php

@@ -0,0 +1,9 @@
+<?php
+
+use InfyOm\Generator\Commands\RollbackGeneratorCommand;
+use function Pest\Laravel\artisan;
+
+it('fails with invalid rollback type', function () {
+    artisan(RollbackGeneratorCommand::class, ['model' => 'User', 'type' => 'random'])
+        ->assertExitCode(1);
+});

tests/Helpers/HelpersTest.php

@@ -2,20 +2,14 @@
 
 namespace Tests\Helpers;
 
-use PHPUnit\Framework\TestCase;
-
-class HelpersTest extends TestCase
-{
-    public function test_model_name_from_table_name()
-    {
-        $tableNames = ['posts', 'person_addresses', 'personEmails'];
-        $modelNames = ['Post', 'PersonAddress', 'PersonEmail'];
-
-        $i = 0;
-        foreach ($tableNames as $tableName) {
-            $result = model_name_from_table_name($tableName);
-            $this->assertEquals($modelNames[$i], $result);
-            $i++;
-        }
+it('verifies model name from table names', function () {
+    $tableNames = ['posts', 'person_addresses', 'personEmails'];
+    $modelNames = ['Post', 'PersonAddress', 'PersonEmail'];
+
+    $i = 0;
+    foreach ($tableNames as $tableName) {
+        $result = model_name_from_table_name($tableName);
+        expect($result)->toBe($modelNames[$i]);
+        $i++;
     }
-}
+});

tests/Pest.php

@@ -0,0 +1,41 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Test Case
+|--------------------------------------------------------------------------
+|
+| The closure you provide to your test functions is always bound to a specific PHPUnit test
+| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
+| need to change it using the "uses()" function to bind a different classes or traits.
+|
+*/
+
+uses(Tests\TestCase::class)->in(__DIR__);
+
+/*
+|--------------------------------------------------------------------------
+| Expectations
+|--------------------------------------------------------------------------
+|
+| When you're writing tests, you often need to check that values meet certain conditions. The
+| "expect()" function gives you access to a set of "expectations" methods that you can use
+| to assert different things. Of course, you may extend the Expectation API at any time.
+|
+*/
+
+expect()->extend('toBeOne', function () {
+    return $this->toBe(1);
+});
+
+/*
+|--------------------------------------------------------------------------
+| Functions
+|--------------------------------------------------------------------------
+|
+| While Pest is very powerful out-of-the-box, you may have some testing code specific to your
+| project that you don't want to repeat in every file. Here you can also expose helpers as
+| global functions to help you to reduce the number of lines of code in your test files.
+|
+*/
+

tests/TestCase.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Tests;
+
+use InfyOm\Generator\InfyOmGeneratorServiceProvider;
+use Orchestra\Testbench\TestCase as Orchestra;
+
+class TestCase extends Orchestra
+{
+    protected function getPackageProviders($app)
+    {
+        return [
+            InfyOmGeneratorServiceProvider::class,
+        ];
+    }
+}

tests/Utils/FileUtilTest.php

@@ -0,0 +1,15 @@
+<?php
+
+use InfyOm\Generator\Utils\FileUtil;
+
+it('mocks create file', function () {
+    $mock = \Mockery::mock('alias:'.FileUtil::class);
+
+    $mock->shouldReceive('createFile')
+        ->withArgs([__DIR__, 'test.php', 'test'])
+        ->andReturn(true);
+
+    $result = FileUtil::createFile(__DIR__, 'test.php', 'test');
+
+    $this->assertEquals(true, $result);
+});