creating a Ci integration for github action

Author: p123-stack

.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI Pipeline
+
+on:
+  push:
+    branches-ignore:
+      - '**' # Ignore all branches pushed as part of a pull request
+  pull_request:
+    branches:
+      - '**'
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    name: Run PHPUnit Tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.2
+          tools: composer, xdebug
+
+      - name: Cache Composer dependencies
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: ${{ runner.os }}-composer-${{ hashFiles('composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --no-progress --prefer-dist
+
+      - name: Verify phpunit.xml
+        run: |
+          if [ ! -f phpunit.xml ]; then
+            echo "phpunit.xml not found, ensure the configuration file exists."
+            exit 1
+          fi
+
+      - name: Run Tests
+        run: vendor/bin/phpunit

src/query-api-test.php

@@ -1,14 +1,25 @@
 <?php
 
 use Neo4j\QueryAPI\Neo4jQueryAPI;
+use GuzzleHttp\Exception\RequestException;
 
 require __DIR__ . '/../vendor/autoload.php';
 
-$api = Neo4jQueryAPI::login('https://bb79fe35.databases.neo4j.io', 'neo4j', 'OXDRMgdWFKMcBRCBrIwXnKkwLgDlmFxipnywT6t_AK0');
 
-// Run the query and fetch results
-$results = $api->run('MATCH (n:Person) RETURN n.name LIMIT 10');
+// Login to the Neo4j instance
+$api = Neo4jQueryAPI::login(
+    'https://bb79fe35.databases.neo4j.io',
+    'neo4j',
+    'OXDRMgdWFKMcBRCBrIwXnKkwLgDlmFxipnywT6t_AK0'
+);
 
+// Run a query to fetch results
+$query = 'MATCH (n:Person) RETURN n.name LIMIT 10';
+$results = $api->run($query, []);
+
+// Display the results
 echo "<pre>";
 print_r($results);
-echo "</pre>";
+echo "</pre>";
+
+

tests/Integration/Neo4jQueryAPIIntegrationTest.php

@@ -16,9 +16,10 @@ class Neo4jQueryAPIIntegrationTest extends TestCase
     protected function setUp(): void
     {
         parent::setUp();
-        $this->address = 'https://bb79fe35.databases.neo4j.io';
-        $this->username = 'neo4j';
-        $this->password = 'OXDRMgdWFKMcBRCBrIwXnKkwLgDlmFxipnywT6t_AK0';
+        // Use environment variables from phpunit.xml
+        $this->address = getenv('NEO4J_ADDRESS');
+        $this->username = getenv('NEO4J_USERNAME');
+        $this->password = getenv('NEO4J_PASSWORD');
     }
     public function testRunSuccess(): void
     {

tests/Integration/Neo4jQueryAPIIntegrationTest1.php

@@ -7,7 +7,6 @@
 
 class Neo4jQueryAPIIntegrationTest1 extends TestCase
 {
-
     public static function setUpBeforeClass(): void
     {
         $api = Neo4jQueryAPI::login(
@@ -16,65 +15,55 @@ public static function setUpBeforeClass(): void
             'OXDRMgdWFKMcBRCBrIwXnKkwLgDlmFxipnywT6t_AK0'
         );
 
-
         self::clearDatabase($api);
-
         self::populateFixtures($api);
     }
 
-    protected function setUp(): void
-    {
-        parent::setUp();
-        $this->address = 'https://bb79fe35.databases.neo4j.io';
-        $this->username = 'neo4j';
-        $this->password = 'OXDRMgdWFKMcBRCBrIwXnKkwLgDlmFxipnywT6t_AK0';
-        $this->query = 'MATCH (n:Person) WHERE n.name IN ["neo4j-php-client", "neo4j-symfony"] RETURN n.name';
-    }
-
     private static function clearDatabase(Neo4jQueryAPI $api): void
     {
-
         $api->run('MATCH (n) DETACH DELETE n', []);
     }
 
-
     private static function populateFixtures(Neo4jQueryAPI $api): void
     {
-
         $api->run('CREATE (:Person {name: "neo4j-php-client"})', []);
         $api->run('CREATE (:Person {name: "neo4j-symfony"})', []);
     }
 
+    /**
+     * @dataProvider queryProvider
+     */
     public function testRunSuccessWithParameters(
         string $address,
         string $username,
         string $password,
         string $query,
-        array  $expectedResults
-    ): void
-    {
-
+        array $expectedResults
+    ): void {
+        // Login to Neo4j
         $api = Neo4jQueryAPI::login($address, $username, $password);
 
+        // Execute the query
         $results = $api->run($query, []);
 
+        // Remove unnecessary data from results
         if (isset($results['bookmarks'])) {
             unset($results['bookmarks']);
         }
 
+        // Validate the results
         $this->assertIsArray($results);
         $this->assertEquals($expectedResults, $results);
     }
 
-
     public static function queryProvider(): array
     {
         return [
             [
-                'https://bb79fe35.databases.neo4j.io',
-                'neo4j',
-                'OXDRMgdWFKMcBRCBrIwXnKkwLgDlmFxipnywT6t_AK0',
-                'MATCH (n:Person) WHERE n.name IN ["neo4j-php-client", "neo4j-symfony"] RETURN n.name',
+                'https://bb79fe35.databases.neo4j.io', // Address
+                'neo4j',                              // Username
+                'OXDRMgdWFKMcBRCBrIwXnKkwLgDlmFxipnywT6t_AK0', // Password
+                'MATCH (n:Person) WHERE n.name IN ["neo4j-php-client", "neo4j-symfony"] RETURN n.name', // Query
                 [
                     'data' => [
                         ['row' => ['n.name' => 'neo4j-php-client']],

tests/Integration/Neo4jQueryAPIIntegrationTest2.php

@@ -12,9 +12,9 @@ class Neo4jQueryAPIIntegrationTest2 extends TestCase
     public static function setUpBeforeClass(): void
     {
         $api = Neo4jQueryAPI::login(
-            'https://bb79fe35.databases.neo4j.io',
-            'neo4j',
-            'OXDRMgdWFKMcBRCBrIwXnKkwLgDlmFxipnywT6t_AK0'
+            getenv('NEO4J_ADDRESS'),
+            getenv('NEO4J_USERNAME'),
+            getenv('NEO4J_PASSWORD')
         );
 
         // Clear the database
@@ -30,9 +30,9 @@ public static function setUpBeforeClass(): void
     protected function setUp(): void
     {
         parent::setUp();
-        $this->address = 'https://bb79fe35.databases.neo4j.io';
-        $this->username = 'neo4j';
-        $this->password = 'OXDRMgdWFKMcBRCBrIwXnKkwLgDlmFxipnywT6t_AK0';
+        $this->address = getenv('NEO4J_ADDRESS');
+        $this->username = getenv('NEO4J_USERNAME');
+        $this->password = getenv('NEO4J_PASSWORD');
         $this->query = 'MATCH (n:Person) RETURN n.name LIMIT 2';
     }