Merge pull request #74 from neo4j-php/improve-testing-coverage

Improve testing coverage

Author: marijnvanwezel

.github/workflows/analyse.yml

@@ -2,6 +2,7 @@ name: analyse
 
 on:
   push:
+    branches: [ 'main' ]
   pull_request:
   workflow_dispatch:
 

.github/workflows/lint.yml

@@ -2,6 +2,7 @@ name: lint
 
 on:
   push:
+    branches: [ 'main' ]
   pull_request:
   workflow_dispatch:
 

.github/workflows/test.yml

@@ -2,6 +2,7 @@ name: test
 
 on:
   push:
+    branches: ['main']
   pull_request:
   workflow_dispatch:
 
@@ -18,7 +19,7 @@ jobs:
     env:
       COMPOSER_VERSION: 2
       COVERAGE_DRIVER: xdebug
-      MINIMUM_COVERAGE_PERCENTAGE: 80
+      MINIMUM_COVERAGE_PERCENTAGE: 90
       MINIMUM_MSI_PERCENTAGE: 80
 
     steps:
@@ -42,6 +43,9 @@ jobs:
       - name: Check coverage
         run: php vendor/bin/coverage-check coverage/clover.xml ${{ env.MINIMUM_COVERAGE_PERCENTAGE }}
 
+      - name: Run end-to-end tests
+        run: php vendor/bin/phpunit --testsuite end-to-end --no-coverage
+
       - name: Run mutation tests
         run: XDEBUG_MODE=coverage php vendor/bin/infection --show-mutations --min-msi=${{ env.MINIMUM_MSI_PERCENTAGE }} --threads=4
 
@@ -60,8 +64,7 @@ jobs:
       neo4j:
         image: neo4j:${{ matrix.neo4j-version }}
         env:
-          NEO4J_AUTH: neo4j/test
-          NEO4JLABS_PLUGINS: '["apoc"]'
+          NEO4J_AUTH: none
         ports:
           - 7687:7687
           - 7474:7474
@@ -75,7 +78,6 @@ jobs:
     env:
       COMPOSER_VERSION: 2
       COVERAGE_DRIVER: none
-      NEO4J_CONNECTIONS: bolt://neo4j:test@localhost,http://neo4j:test@localhost
 
     steps:
       - name: Checkout repository

.gitignore

@@ -1,9 +1,9 @@
 .DS_Store
 composer.lock
 coverage/
+doxygen/
 phpunit.xml
 vendor/
 *.idea
 .phpunit.result.cache
 .php-cs-fixer.cache
-coverage/

.php-cs-fixer.dist.php

@@ -22,8 +22,9 @@
 $finder = Finder::create()
     ->files()
     ->in(__DIR__ . '/src')
-    ->in(__DIR__ . '/tests/Unit')
-    ->in(__DIR__ . '/tests/Integration')
+    ->in(__DIR__ . '/tests/unit')
+    ->in(__DIR__ . '/tests/integration')
+    ->in(__DIR__ . '/tests/end-to-end')
     ->name('*.php');
 
 $config = new Config();

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to the php-cypher-dsl project will be documented in this file. A changelog has been kept from version 5.0.0 onwards.
+
+The format is based on [Keep a Changelog], and this project adheres to
+[Semantic Versioning].
+
+## 5.0.0 - To be determined
+
+### Added
+
+- Add a blank changelog.
+
+[keep a changelog]: https://keepachangelog.com/en/1.0.0/
+[semantic versioning]: https://semver.org/spec/v2.0.0.html

LIFECYCLE.md

@@ -0,0 +1,13 @@
+# Version lifecycle
+
+Since php-cypher-dsl version 5.0.0, support is governed by this version lifecycle.
+
+**Bugfix support** means that issues will be fixed for a version of php-cypher-dsl. Bugfix support for every major release `X` ends **six months** after the release of the next major version (`X+1`). Bugfix support for minor release `X.Y` will end with the release of the next minor version (`X.(Y+1)`).
+
+It is strongly recommended to use a version of php-cypher-dsl that has active bugfix support. Versions that are no longer receiving bugfix support will not receive any security or bug fixes. They may contain known critical vulnerabilities and other major bugs, including the threat of possible data loss and/or corruption.
+
+## Supported versions
+
+| Major version    | PHP version | Initial release  | End of bugfix support |
+|------------------|-------------|------------------|-----------------------|
+| php-cypher-dsl 5 | >=7.4    | To be determined | To be determined      |

phpstan.neon.dist

@@ -1,4 +1,5 @@
 parameters:
   paths:
     - src
-  level: 7
+  level: 7
+  treatPhpDocTypesAsCertain: false

phpunit.xml.dist

@@ -6,18 +6,25 @@
 >
     <testsuites>
         <testsuite name="unit">
-            <directory>tests/Unit</directory>
+            <directory>tests/unit</directory>
+        </testsuite>
+        <testsuite name="end-to-end">
+            <directory>tests/end-to-end</directory>
         </testsuite>
         <testsuite name="integration">
-            <directory>tests/Integration</directory>
+            <directory>tests/integration</directory>
         </testsuite>
     </testsuites>
     <coverage processUncoveredFiles="true" cacheDirectory="coverage/cache" pathCoverage="true">
         <report>
             <clover outputFile="coverage/clover.xml" />
+            <html outputDirectory="coverage/" />
         </report>
         <include>
             <directory suffix=".php">src</directory>
         </include>
+        <exclude>
+            <file>src/functions.php</file>
+        </exclude>
     </coverage>
 </phpunit>

src/Clauses/CallClause.php

@@ -2,7 +2,7 @@
 /*
  * This file is part of php-cypher-dsl.
  *
- * Copyright (C) 2021-  Wikibase Solutions
+ * Copyright (C) Wikibase Solutions
  *
  * For the full copyright and license information, please view the LICENSE
  * file that was distributed with this source code.
@@ -30,7 +30,7 @@ final class CallClause extends Clause
     use ErrorTrait;
 
     /**
-     * @var Query|null The subquery to call, or NULL if no subquery has been set yet
+     * @var null|Query The sub-query to call, or NULL if no sub-query has been set yet
      */
     private ?Query $subQuery = null;
 
@@ -40,9 +40,10 @@ final class CallClause extends Clause
     private array $withVariables = [];
 
     /**
-     * Sets the query to call. This overwrites any previously set subquery.
+     * Sets the query to call. This overwrites any previously set sub-query.
+     *
+     * @param Query $subQuery The sub-query to call
      *
-     * @param Query $subQuery The subquery to call
      * @return $this
      */
     public function withSubQuery(Query $subQuery): self
@@ -55,7 +56,8 @@ public function withSubQuery(Query $subQuery): self
     /**
      * Add one or more variables to include in the WITH clause.
      *
-     * @param Variable|Pattern|string ...$variables
+     * @param Pattern|string|Variable ...$variables
+     *
      * @return $this
      *
      * @see https://neo4j.com/docs/cypher-manual/current/clauses/call-subquery/#subquery-correlated-importing
@@ -76,8 +78,6 @@ public function addWithVariable(...$variables): self
     /**
      * Returns the query that is being called. This query does not include the WITH clause that is inserted
      * if there are any correlated variables.
-     *
-     * @return Query|null
      */
     public function getSubQuery(): ?Query
     {