Resolves broken tests on local and adds GH actions pipeline (#63)

* Resolves broken tests on local and adds gh actions pipeline * additional cleanup * remove sniffer config * remove static analyzers for now * updates pipeline to deal with cake4 requiring php 7.4 * cleanup and emit deprecation warning on deprecated method * adds elastic search test into gh action pipeline with a custom integration test, uses mocks for testing elastic locally, some other cleanup * tests pipeline without elastic to debug * resolve timezone bug * resolve timezone bug * resolve timezone bug * resolve timezone bug * resolve timezone bug * resolve timezone bug * resolve timezone bug * resolve timezone bug * resolve timezone bug * skip timezone bug and enable elastic again * debugging this: elastic/elastic-github-actions#23 * bad copy pasta * debug datetime issue * oh well * oh well 2 * adds #[\ReturnTypeWillChange] to suppress deprecation warnings 8.0/8.1 * cleanup * docblock updates * re-adds integration test and removes a deprecation warning in php 8.1 * testing pipeline * fix test namespaces * try getting elastc running in pipeline again using setup from cakephp/elastic * try getting elastc running in pipeline again using setup from cakephp/elastic * try getting elastc running in pipeline again using setup from cakephp/elastic * fix names
lorenzo · Sep 11, 2023 · c03812d · c03812d
1 parent 58f0c65
commit c03812d
Show file tree

Hide file tree

Showing 24 changed files with 505 additions and 320 deletions.
diff --git a/.github/workflows/pull-request.yml b/.github/workflows/pull-request.yml
@@ -0,0 +1,141 @@
+name: Pull Request
+
+on:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        operating-system: [ ubuntu-20.04 ]
+        php-versions: ['7.2', '7.3', '7.4', '8.0', '8.1', '8.2']
+
+    name: PHP ${{ matrix.php-versions }} Test 
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: mbstring, intl, xdebug
+
+      - name: PHP Version
+        run: php -v
+
+      - name: Install dependencies
+        if: steps.composer-cache.outputs.cache-hit != 'true'
+        run: |
+          composer self-update
+          composer validate
+          composer install --prefer-dist --no-progress
+
+      - name: Test Suite
+        run: |
+          composer test
+
+  #
+  # CakePHP version compatability
+  #
+  compatibility:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: ['~4.0.0', '~4.1.0', '~4.2.0', '~4.3.0']
+
+    name: CakePHP ${{ matrix.version }} Test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.2'
+          extensions: mbstring, intl
+
+      - name: PHP Version
+        run: php -v
+
+      - name: CakePHP ${{matrix.version}} Compatability
+        run: |
+          composer self-update
+          rm -rf composer.lock
+          composer require cakephp/cakephp:${{matrix.version}} --no-update
+          composer install --prefer-dist --no-progress
+          composer test
+
+  compatibility_cakephp4:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: ['~4.4.0']
+
+    name: CakePHP ${{ matrix.version }} Test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          extensions: mbstring, intl
+
+      - name: PHP Version
+        run: php -v
+
+      - name: CakePHP ${{matrix.version}} Compatability
+        run: |
+          composer self-update
+          rm -rf composer.lock
+          composer require cakephp/cakephp:${{matrix.version}} --no-update
+          composer install --prefer-dist --no-progress
+          composer test
+
+  elastic_integration_test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: ['~4.4.0']
+
+    services:
+      elasticsearch:
+        image: elasticsearch:7.11.1
+        ports:
+          - 9200/tcp
+        env:
+          discovery.type: single-node
+          ES_JAVA_OPTS: -Xms500m -Xmx500m
+        options: >-
+          --health-cmd "curl http://127.0.0.1:9200/_cluster/health"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 10
+
+    name: Elastic Search Integration Test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          extensions: mbstring, intl
+
+      - name: PHP Version
+        run: php -v
+
+      - name: Test
+        env:
+          elastic_dsn: Cake\ElasticSearch\Datasource\Connection://127.0.0.1:${{ job.services.elasticsearch.ports['9200'] }}?driver=Cake\ElasticSearch\Datasource\Connection
+        run: |
+          composer self-update
+          rm -rf composer.lock
+          composer require cakephp/cakephp:${{matrix.version}} --no-update
+          composer install --prefer-dist --no-progress
+          vendor/bin/phpunit tests/TestCase/Persister/ElasticSearchPersisterIntegrationTest.php
diff --git a/composer.json b/composer.json
@@ -4,8 +4,9 @@
     "type": "cakephp-plugin",
     "license": "MIT",
     "require": {
-        "php": ">=7.2",
-        "cakephp/orm": "^4.0"
+        "php": "^7.2|^8.0",
+        "cakephp/orm": "^4.0",
+        "ext-json": "*"
     },
     "require-dev": {
         "phpunit/phpunit": "^8.0",
@@ -25,8 +26,11 @@
     },
     "autoload-dev": {
         "psr-4": {
-            "AuditStash\\Test\\": "tests",
+            "AuditStash\\Test\\": "tests/",
             "Cake\\Test\\": "./vendor/cakephp/cakephp/tests"
         }
+    },
+    "scripts": {
+        "test": "phpunit --colors=always"
     }
-}
+}
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -14,6 +14,7 @@
     <testsuites>
         <testsuite name="AuditStash Test Suite">
             <directory>./tests/TestCase</directory>
+            <exclude>./tests/TestCase/Persister/ElasticSearchPersisterIntegrationTest.php</exclude>
         </testsuite>
     </testsuites>
 

diff --git a/src/Event/AuditDeleteEvent.php b/src/Event/AuditDeleteEvent.php
@@ -16,9 +16,9 @@ class AuditDeleteEvent implements EventInterface
     }
 
     /**
-     * Construnctor.
+     * Constructor.
      *
-     * @param string $transationId The global transaction id
+     * @param string $transactionId The global transaction id
      * @param mixed $id The primary key record that got deleted
      * @param string $source The name of the source (table) where the record was deleted
      * @param string $parentSource The name of the source (table) that triggered this change

diff --git a/src/Event/BaseEvent.php b/src/Event/BaseEvent.php
@@ -29,9 +29,9 @@ abstract class BaseEvent implements EventInterface
     protected $original;
 
     /**
-     * Construnctor.
+     * Constructor.
      *
-     * @param string $transationId The global transaction id
+     * @param string $transactionId The global transaction id
      * @param mixed $id The entities primary key
      * @param string $source The name of the source (table)
      * @param array $changed The array of changes that got detected for the entity
@@ -77,9 +77,10 @@ abstract public function getEventType();
     /**
      * Returns the array to be used for encoding this object as json.
      *
-     * @return array
+     * @return mixed
      */
-    public function jsonSerialize(): mixed
+    #[\ReturnTypeWillChange]
+    public function jsonSerialize()
     {
         return $this->basicSerialize() + [
             'original' => $this->original,

diff --git a/src/Event/SerializableEventTrait.php b/src/Event/SerializableEventTrait.php
@@ -14,7 +14,7 @@ trait SerializableEventTrait
      */
     public function serialize()
     {
-        return $this->__serialize();
+        return serialize(get_object_vars($this));
     }
 
     /**
@@ -28,16 +28,6 @@ public function unserialize($data)
         $this->__unserialize($data);
     }
 
-    /**
-     * Returns the string representation of this object.
-     *
-     * @return string
-     */
-    public function __serialize()
-    {
-        return serialize(get_object_vars($this));
-    }
-
     /**
      * Takes the string representation of this object so it can be reconstructed.
      *
@@ -55,9 +45,10 @@ public function __unserialize($data)
     /**
      * Returns an array with the basic variables that should be json serialized.
      *
-     * @return array
+     * @return mixed
      */
-    protected function basicSerialize(): mixed
+    #[\ReturnTypeWillChange]
+    protected function basicSerialize()
     {
         return [
             'type' => $this->getEventType(),

diff --git a/src/EventFactory.php b/src/EventFactory.php
@@ -18,7 +18,8 @@ class EventFactory
      * converts it into an AuditStash\EventInterface object.
      *
      * @param array $data The array data from elastic search
-     * @return AuditStash\EventInterface
+     * @return \AuditStash\EventInterface
+     * @throws \ReflectionException
      */
     public function create(array $data)
     {

diff --git a/src/Meta/ApplicationMetadata.php b/src/Meta/ApplicationMetadata.php
@@ -40,10 +40,9 @@ public function implementedEvents(): array
     }
 
     /**
-     * Enriches all of the passed audit logs to add the request
-     * info metadata.
+     * Enriches all the passed audit logs to add the request info metadata.
      *
-     * @param Event The AuditStash.beforeLog event
+     * @param Event $event The AuditStash.beforeLog event
      * @param array $logs The audit log event objects
      * @return void
      */

diff --git a/src/Meta/RequestMetadata.php b/src/Meta/RequestMetadata.php
@@ -49,10 +49,9 @@ public function implementedEvents(): array
     }
 
     /**
-     * Enriches all of the passed audit logs to add the request
-     * info metadata.
+     * Enriches all the passed audit logs to add the request info metadata.
      *
-     * @param Event The AuditStash.beforeLog event
+     * @param Event $event The AuditStash.beforeLog event
      * @param array $logs The audit log event objects
      * @return void
      */

diff --git a/src/Model/Behavior/AuditLogBehavior.php b/src/Model/Behavior/AuditLogBehavior.php
@@ -62,8 +62,8 @@ public function implementedEvents(): array
      * Conditionally adds the `_auditTransaction` and `_auditQueue` keys to $options. They are
      * used to track all changes done inside the same transaction.
      *
-     * @param Cake\Event\Event The Model event that is enclosed inside a transaction
-     * @param Cake\Datasource\EntityInterface $entity The entity that is to be saved
+     * @param \Cake\Event\Event $event The Model event that is enclosed inside a transaction
+     * @param \Cake\Datasource\EntityInterface $entity The entity that is to be saved
      * @param ArrayObject $options The options to be passed to the save or delete operation
      * @return void
      */
@@ -82,8 +82,8 @@ public function injectTracking(Event $event, EntityInterface $entity, ArrayObjec
      * Calculates the changes done to the entity and stores the audit log event object into the
      * log queue inside the `_auditQueue` key in $options.
      *
-     * @param Cake\Event\Event The Model event that is enclosed inside a transaction
-     * @param Cake\Datasource\EntityInterface $entity The entity that is to be saved
+     * @param \Cake\Event\Event $event The Model event that is enclosed inside a transaction
+     * @param \Cake\Datasource\EntityInterface $entity The entity that is to be saved
      * @param ArrayObject $options Options array containing the `_auditQueue` key
      * @return void
      */
@@ -135,8 +135,8 @@ public function afterSave(Event $event, EntityInterface $entity, $options)
     /**
      * Persists all audit log events stored in the `_eventQueue` key inside $options.
      *
-     * @param Cake\Event\Event The Model event that is enclosed inside a transaction
-     * @param Cake\Datasource\EntityInterface $entity The entity that is to be saved or deleted
+     * @param \Cake\Event\Event $event The Model event that is enclosed inside a transaction
+     * @param \Cake\Datasource\EntityInterface $entity The entity that is to be saved or deleted
      * @param ArrayObject $options Options array containing the `_auditQueue` key
      * @return void
      */
@@ -163,8 +163,8 @@ public function afterCommit(Event $event, EntityInterface $entity, $options)
     /**
      * Persists all audit log events stored in the `_eventQueue` key inside $options.
      *
-     * @param Cake\Event\Event The Model event that is enclosed inside a transaction
-     * @param Cake\Datasource\EntityInterface $entity The entity that is to be saved or deleted
+     * @param \Cake\Event\Event $event The Model event that is enclosed inside a transaction
+     * @param \Cake\Datasource\EntityInterface $entity The entity that is to be saved or deleted
      * @param ArrayObject $options Options array containing the `_auditQueue` key
      * @return void
      */
@@ -184,8 +184,8 @@ public function afterDelete(Event $event, EntityInterface $entity, $options)
      * Sets the persister object to use for logging all audit events.
      * If called with no arguments, it will return the currently configured persister.
      *
-     * @param PersisterInterface $persister The persister object to use
-     * @return PersisterInterface The configured persister
+     * @param \AuditStash\PersisterInterface $persister The persister object to use
+     * @return \AuditStash\PersisterInterface The configured persister
      */
     public function persister(PersisterInterface $persister = null)
     {

diff --git a/src/Persister/DatabasePersister.php b/src/Persister/DatabasePersister.php
@@ -19,13 +19,14 @@ class DatabasePersister implements PersisterInterface
     use ModelAwareTrait;
 
     /**
-     * Persists all of the audit log event objects that are provided
+     * Persists all the audit log event objects that are provided
      *
-     * @param array $auditLogs An array of EventInterface objects
+     * @param \AuditStash\EventInterface[] $auditLogs An array of EventInterface objects
      * @return void
      */
     public function logEvents(array $auditLogs)
     {
+        deprecationWarning('Use \AuditStash\Persister\TablePersister instead');
         foreach ($auditLogs as $log) {
             $eventType = $log->getEventType();
             $primaryKey = $log->getId();