update readme and test location

Leantime · Nov 22, 2024 · 4b78fdd · 4b78fdd
1 parent ec63cdc
commit 4b78fdd
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -155,6 +155,21 @@ The dev environment provides a MySQL server, mail server, s3 server, and should
 Additionally, Xdebug is enabled, but you will have to modify your 
 IDE key in the ``.dev/xdebug.ini`` file(or alternatively, on your IDE). You also need to have port 9003 temporarily open on your firewall so you can utilize it effectively. This is because connections from docker to the host will count as external inbound connections
 <br /><br />
+
+### Run Tests
+
+Static Analysis `make phpstan`<br />
+Code Style `make test-code-style` (to fix code style automatically use `make fix-code-style`)<br />
+Unit Tests `make unit-test`<br />
+Acceptance Tests `make acceptance-test`<br /> (requires docker)
+
+You can test individual acceptance test groups directly using:<br />
+For api: <br />
+`docker compose --file .dev/docker-compose.yaml --file .dev/docker-compose.tests.yaml exec leantime-dev php vendor/bin/codecept run -g api --steps`<br />
+For timesheets: <br />
+`docker compose --file .dev/docker-compose.yaml --file .dev/docker-compose.tests.yaml exec leantime-dev php vendor/bin/codecept run -g timesheet --steps`<br />
+
+
 ###  🏗 Update ###
 
 #### Manual

diff --git a/tests/Acceptance/ApiCest.php → tests/Acceptance/API/ApiCest.php b/tests/Acceptance/ApiCest.php → tests/Acceptance/API/ApiCest.php
@@ -1,6 +1,6 @@
 <?php
 
-namespace Acceptance;
+namespace Acceptance\API;
 
 use Codeception\Attribute\Group;
 use Tests\Support\AcceptanceTester;

diff --git a/tests/Support/ApiTester.php b/tests/Support/ApiTester.php
@@ -1,8 +1,10 @@
 <?php
+
 namespace Tests\Support;
 
 /**
  * Inherited Methods
+ *
  * @method void wantToTest($text)
  * @method void wantTo($text)
  * @method void execute($callable)

diff --git a/tests/Support/Helper/Api.php b/tests/Support/Helper/Api.php
@@ -1,4 +1,5 @@
 <?php
+
 namespace Tests\Support\Helper;
 
 use Codeception\Module;

diff --git a/tests/Unit/app/Domain/Api/Controllers/JsonrpcTest.php b/tests/Unit/app/Domain/Api/Controllers/JsonrpcTest.php
@@ -9,6 +9,7 @@
 class JsonrpcTest extends TestCase
 {
     private Jsonrpc $controller;
+
     private Template $template;
 
     protected function setUp(): void
@@ -25,14 +26,15 @@ public function testMethodStringParsing()
             'method' => 'leantime.rpc.Comments.pollComments',
             'params' => ['projectId' => 1],
             'id' => 1,
-            'jsonrpc' => '2.0'
+            'jsonrpc' => '2.0',
         ];
 
         $this->template->expects($this->once())
             ->method('displayJson')
-            ->willReturnCallback(function($response) {
+            ->willReturnCallback(function ($response) {
                 $this->assertArrayHasKey('jsonrpc', $response);
                 $this->assertEquals('2.0', $response['jsonrpc']);
+
                 return response()->json($response);
             });
 
@@ -45,14 +47,15 @@ public function testInvalidMethodString()
             'method' => 'invalid.method.string',
             'params' => ['projectId' => 1],
             'id' => 1,
-            'jsonrpc' => '2.0'
+            'jsonrpc' => '2.0',
         ];
 
         $this->template->expects($this->once())
             ->method('displayJson')
-            ->willReturnCallback(function($response) {
+            ->willReturnCallback(function ($response) {
                 $this->assertArrayHasKey('error', $response);
                 $this->assertEquals(-32602, $response['error']['code']);
+
                 return response()->json($response);
             });
 
@@ -64,14 +67,15 @@ public function testMissingJsonRpcVersion()
         $params = [
             'method' => 'leantime.rpc.Comments.pollComments',
             'params' => ['projectId' => 1],
-            'id' => 1
+            'id' => 1,
         ];
 
         $this->template->expects($this->once())
             ->method('displayJson')
-            ->willReturnCallback(function($response) {
+            ->willReturnCallback(function ($response) {
                 $this->assertArrayHasKey('error', $response);
                 $this->assertEquals(-32600, $response['error']['code']);
+
                 return response()->json($response);
             });
 
@@ -85,21 +89,22 @@ public function testBatchRequest()
                 'method' => 'leantime.rpc.Comments.pollComments',
                 'params' => ['projectId' => 1],
                 'id' => 1,
-                'jsonrpc' => '2.0'
+                'jsonrpc' => '2.0',
             ],
             [
                 'method' => 'leantime.rpc.Comments.pollComments',
                 'params' => ['projectId' => 2],
                 'id' => 2,
-                'jsonrpc' => '2.0'
-            ]
+                'jsonrpc' => '2.0',
+            ],
         ];
 
         $this->template->expects($this->once())
             ->method('displayJson')
-            ->willReturnCallback(function($response) {
+            ->willReturnCallback(function ($response) {
                 $this->assertIsArray($response);
                 $this->assertCount(2, $response);
+
                 return response()->json($response);
             });