Added github actions workflow and code style fixes

sineflow · Oct 10, 2023 · a8a3268 · a8a3268
1 parent 2f48c5d
commit a8a3268
Show file tree

Hide file tree

Showing 48 changed files with 569 additions and 424 deletions.
diff --git a/.coveralls.yml b/.coveralls.yml
diff --git a/.env b/.env
@@ -0,0 +1,5 @@
+# Override for the ES port to use for the docker container
+ELASTICSEARCH_PORT=9201
+
+# Override for the ES version to use for the docker container
+#ELASTICSEARCH_VERSION=8.8.0
diff --git a/.github/workflows/phpunit-tests.yml b/.github/workflows/phpunit-tests.yml
@@ -0,0 +1,124 @@
+name: tests
+
+concurrency:
+    group: phpunit-tests-${{ github.ref_name }}
+    cancel-in-progress: true
+
+on: ['push', 'pull_request', 'workflow_dispatch']
+
+env:
+    ELASTICSEARCH_PORT: 9201
+
+jobs:
+    static_code_analysis:
+        runs-on: 'ubuntu-20.04'
+        name: 'Static code analysis'
+        steps:
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: '8.1'
+
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: 'Validate composer.json and composer.lock'
+              run: composer validate
+
+            - name: 'Install dependencies with Composer'
+              uses: 'ramsey/composer-install@v2'
+              with:
+                  dependency-versions: 'highest'
+                  composer-options: '--prefer-dist'
+
+            - name: Check PHP coding standards
+              run: php vendor/bin/php-cs-fixer fix --verbose --dry-run
+
+    phpunit:
+        needs: [ static_code_analysis ]
+        runs-on: 'ubuntu-20.04'
+        name: 'PHPUnit (PHP ${{ matrix.php }}, Symfony ${{ matrix.symfony }}, ES ${{ matrix.elasticsearch }})'
+        timeout-minutes: 30
+        continue-on-error: ${{ matrix.experimental }}
+        strategy:
+            matrix:
+                experimental:
+                    - false
+                dependencies:
+                    - 'highest'
+                php:
+                    - '8.1'
+                    - '8.2'
+                elasticsearch:
+                    - '7.17.13'
+                symfony:
+                    - '~5.0'
+                include:
+                    - php: '8.1'
+                      symfony: '~5.0'
+                      elasticsearch: '8.0.1'
+                      experimental: false
+                    - php: '8.1'
+                      symfony: '~5.0'
+                      elasticsearch: '8.1.3' # there are some bc in minor version https://www.elastic.co/guide/en/elasticsearch/reference/current/migrating-8.1.html#breaking-changes-8.1
+                      experimental: false
+                    - php: '8.1'
+                      symfony: '~5.0'
+                      elasticsearch: '8.5.3' # there are some bc in minor version https://www.elastic.co/guide/en/elasticsearch/reference/current/migrating-8.5.html
+                      experimental: false
+                    - php: '8.1'
+                      symfony: '~5.0'
+                      elasticsearch: '8.6.2' # there are no bc in minor version https://www.elastic.co/guide/en/elasticsearch/reference/current/migrating-8.6.html
+                      experimental: false
+                    - php: '8.1'
+                      symfony: '~5.0'
+                      elasticsearch: '8.7.1' # there are no bc in minor version https://www.elastic.co/guide/en/elasticsearch/reference/current/migrating-8.7.html
+                      experimental: false
+                    - php: '8.1'
+                      symfony: '~5.0'
+                      elasticsearch: '8.8.0' # there are no bc in minor version https://www.elastic.co/guide/en/elasticsearch/reference/current/migrating-8.8.html
+                      experimental: false
+                    - php: '8.1'
+                      symfony: '~6.0'
+                      elasticsearch: '8.10.2' # newest version
+                      experimental: false
+            fail-fast: false
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                  php-version: '${{ matrix.php }}'
+                  coverage: 'pcov'
+                  tools: 'composer:v2'
+                  extensions: 'curl, json, mbstring, openssl'
+                  ini-values: 'memory_limit=256M'
+
+            - name: 'Fix symfony/framework-bundle version'
+              run: composer require --no-update symfony/framework-bundle:${{ matrix.symfony }}
+
+            - name: 'Install dependencies with Composer'
+              uses: 'ramsey/composer-install@v2'
+              with:
+                  dependency-versions: '${{ matrix.dependencies }}'
+                  composer-options: '--prefer-dist'
+
+            - name: 'Dump composer autoloader'
+              run: composer dump-autoload --classmap-authoritative --no-ansi --no-interaction --no-scripts
+
+            - name: 'Setup Elasticsearch'
+              env:
+                  ELASTICSEARCH_VERSION: ${{ matrix.elasticsearch }}
+              run: docker compose up --detach --wait ; curl -XGET 'http://localhost:'"$ELASTICSEARCH_PORT"
+
+            - name: 'Run phpunit tests'
+              run: |
+                  vendor/bin/simple-phpunit --coverage-clover=tests/App/build/clover.xml 2>/dev/null
+
+            - name: Upload coverage results to Coveralls
+              env:
+                  COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_TOKEN }}
+              run: |
+                  vendor/bin/php-coveralls --coverage_clover=tests/App/build/clover.xml --json_path=tests/App/build/coveralls.json -v
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -8,31 +8,15 @@
 return (new PhpCsFixer\Config())
     ->setFinder($finder)
     ->setRules([
-        '@PHP73Migration' => true,
-        '@PHPUnit75Migration:risky' => true,
-        '@PSR2' => true,
         '@Symfony' => true,
-        '@Symfony:risky' => true,
-        'modernize_strpos' => true,
-        'is_null' => true,
-        'method_argument_space' => ['on_multiline' => 'ensure_fully_multiline'],
-        'native_constant_invocation' => true,
-        'native_function_invocation' => [
-            'include' => ['@all'],
-        ],
-        'no_alias_functions' => true,
-        'no_useless_else' => true,
-        'nullable_type_declaration_for_default_null_value' => true,
-        'ordered_imports' => true,
-        'php_unit_dedicate_assert' => ['target' => 'newest'],
-        'static_lambda' => true,
-        'ternary_to_null_coalescing' => true,
-        'visibility_required' => ['elements' => ['property', 'method', 'const']],
-        'void_return' => false,
-        'protected_to_private' => false,
-        'phpdoc_summary' => false,
+
+        // Exclude "phpdoc_summary" rule: "PHPDoc summary should end in either a full stop, exclamation mark, or question mark"
+        'phpdoc_summary'                => false,
         'phpdoc_annotation_without_dot' => false,
-        'phpdoc_to_comment' => ['ignored_tags' => ['@var']]
+        'no_superfluous_phpdoc_tags'    => ['allow_mixed' => true, 'remove_inheritdoc' => false],
+        // Indent '=>' operator
+        'binary_operator_spaces' => ['operators' => ['=>' => 'align_single_space_minimal']],
+        // PSR12 imports order
+        'ordered_imports' => ['imports_order' => ['class', 'function', 'const']],
     ])
 ;
-
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -2,8 +2,8 @@
 
 ![License](https://img.shields.io/github/license/sineflow/elasticsearchbundle.svg)
 [![Latest Stable Version](https://img.shields.io/github/release/sineflow/elasticsearchbundle.svg)](https://packagist.org/packages/sineflow/elasticsearch-bundle)
-[![Build Status](https://travis-ci.com/sineflow/ElasticsearchBundle.svg?branch=main)](https://app.travis-ci.com/github/sineflow/ElasticsearchBundle)
-[![Coverage Status](https://coveralls.io/repos/sineflow/ElasticsearchBundle/badge.svg?branch=master&service=github)](https://coveralls.io/github/sineflow/ElasticsearchBundle?branch=master)
+![Tests Workflow](https://github.com/sineflow/ElasticsearchBundle/actions/workflows/phpunit-tests.yml/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/github/sineflow/ElasticsearchBundle/badge.svg?branch=main)](https://coveralls.io/github/sineflow/ElasticsearchBundle?branch=main)
 
 ## Key points
 
@@ -31,3 +31,12 @@ Installation instructions and documentation of the bundle can be found [here](do
 ## License
 
 This bundle is licensed under the MIT license. Please, see the complete license in the [LICENSE](LICENSE) file.
+
+## Running tests
+
+```
+composer install
+docker compose up --detach --wait
+vendor/bin/simple-phpunit
+docker compose down --remove-orphans
+```
diff --git a/composer.json b/composer.json
@@ -32,11 +32,12 @@
         "symfony/stopwatch": "^4.4 || ^5.0",
         "symfony/phpunit-bridge": "^4.4 || ^5.0",
         "symfony/browser-kit": "^4.4 || ^5.0",
+        "symfony/dotenv": "^4.4 || ^5.0",
         "doctrine/orm": "^2.6.3",
 
         "monolog/monolog": "^1.0|^2.0|^3.0",
         "knplabs/knp-paginator-bundle": "^4.0 || ^5.0",
-        "squizlabs/php_codesniffer": "^3.0",
+        "friendsofphp/php-cs-fixer": "^3.34",
         "php-coveralls/php-coveralls": "^2.1",
         "escapestudios/symfony2-coding-standard": "^3.0",
         "jchook/phpunit-assert-throws": "^1.0",
@@ -50,8 +51,7 @@
     "autoload": {
         "psr-4": {
             "Sineflow\\ElasticsearchBundle\\": "src/"
-        },
-        "exclude-from-classmap": ["/tests/"]
+        }
     },
     "autoload-dev": {
         "psr-4": {

diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,34 @@
+services:
+  elasticsearch:
+    image: "docker.elastic.co/elasticsearch/elasticsearch:${ELASTICSEARCH_VERSION:-7.17.13}"
+    container_name: sfes_elasticsearch
+    environment:
+      - discovery.type=single-node
+      - bootstrap.memory_lock=true
+      - "ES_JAVA_OPTS=-Xms${ELASTICSEARCH_JAVA_MEM:-2048m} -Xmx${ELASTICSEARCH_JAVA_MEM:-2048m}"
+      - cluster.name=sfes
+      - node.name=sfes1
+      - xpack.security.enabled=false
+      - indices.id_field_data.enabled=true # TODO: temporary requirement for ES8 until tests are fixed to not do sorting/aggregations on _id (https://github.com/elastic/elasticsearch/issues/43599)
+    ulimits:
+      memlock:
+        soft: -1
+        hard: -1
+    volumes:
+      - elasticsearch-data:/usr/share/elasticsearch/data
+    ports:
+      - "${ELASTICSEARCH_PORT:-9200}:9200"
+    networks:
+      - elastic
+    healthcheck:
+      test: curl -s http://sfes_elasticsearch:$${ELASTICSEARCH_PORT:-9200} > /dev/null || exit 1
+      interval: 1s
+      timeout: 5s
+      retries: 120
+
+volumes:
+  elasticsearch-data:
+
+networks:
+  elastic:
+    driver: bridge
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -25,6 +25,7 @@
     </testsuites>
 
     <php>
+        <server name="APP_ENV" value="test" force="true" />
         <server name="KERNEL_CLASS" value="Sineflow\ElasticsearchBundle\Tests\App\AppKernel" />
         <server name="SHELL_VERBOSITY" value="-1" />
         <env name="SYMFONY_PHPUNIT_VERSION" value="9" />

diff --git a/src/Annotation/DocObject.php b/src/Annotation/DocObject.php
@@ -6,6 +6,7 @@
  * Annotation to mark a class as an object during the parsing process.
  *
  * @Annotation
+ *
  * @Target("CLASS")
  */
 final class DocObject

diff --git a/src/Annotation/Id.php b/src/Annotation/Id.php
@@ -6,6 +6,7 @@
  * Annotation used for the meta _id field
  *
  * @Annotation
+ *
  * @Target("PROPERTY")
  */
 final class Id

diff --git a/src/Annotation/Score.php b/src/Annotation/Score.php
@@ -6,6 +6,7 @@
  * Annotation used for the meta _score field, returned when searching
  *
  * @Annotation
+ *
  * @Target("PROPERTY")
  */
 final class Score

diff --git a/src/Document/Provider/ElasticsearchProvider.php b/src/Document/Provider/ElasticsearchProvider.php
@@ -66,8 +66,8 @@ public function getDocuments()
             ['sort' => ['_doc']],
             Finder::RESULTS_RAW | Finder::ADAPTER_SCROLL,
             [
-                'index' => $this->sourceIndexManager->getLiveIndex(),
-                'size' => $this->chunkSize,
+                'index'  => $this->sourceIndexManager->getLiveIndex(),
+                'size'   => $this->chunkSize,
                 'scroll' => $this->scrollTime,
             ]
         );
@@ -90,7 +90,7 @@ public function getDocument($id): array
     {
         $params = [
             'index' => $this->sourceIndexManager->getLiveIndex(),
-            'id' => $id,
+            'id'    => $id,
         ];
         $doc = $this->sourceIndexManager->getConnection()->getClient()->get($params);
         $result = $doc['_source'];

diff --git a/src/Document/Repository/Repository.php b/src/Document/Repository/Repository.php
@@ -65,7 +65,7 @@ public function getById(string $id, int $resultType = Finder::RESULTS_OBJECT)
      *
      * @return mixed
      */
-    public function find(array $searchBody, int $resultsType = Finder::RESULTS_OBJECT, array $additionalRequestParams = [], ?int &$totalHits = null)
+    public function find(array $searchBody, int $resultsType = Finder::RESULTS_OBJECT, array $additionalRequestParams = [], int &$totalHits = null)
     {
         return $this->finder->find([$this->documentClass], $searchBody, $resultsType, $additionalRequestParams, $totalHits);
     }

diff --git a/src/Exception/IndexOrAliasNotFoundException.php b/src/Exception/IndexOrAliasNotFoundException.php
@@ -2,8 +2,6 @@
 
 namespace Sineflow\ElasticsearchBundle\Exception;
 
-use Throwable;
-
 /**
  * Class IndexOrAliasNotFoundException
  */
@@ -19,7 +17,7 @@ class IndexOrAliasNotFoundException extends Exception
      *
      * @param int $code
      */
-    public function __construct(string $indexOrAlias, bool $isAlias = false, $code = 0, ?Throwable $previous = null)
+    public function __construct(string $indexOrAlias, bool $isAlias = false, $code = 0, \Throwable $previous = null)
     {
         $this->indexOrAlias = $indexOrAlias;
 

diff --git a/src/Exception/IndexRebuildingException.php b/src/Exception/IndexRebuildingException.php
@@ -16,7 +16,7 @@ class IndexRebuildingException extends Exception
      * @param array $indicesInProgress The physical indices, which are in the process of being built
      * @param int   $code
      */
-    public function __construct(array $indicesInProgress, $code = 0, ?Exception $previous = null)
+    public function __construct(array $indicesInProgress, $code = 0, Exception $previous = null)
     {
         parent::__construct(\sprintf('Index is currently being rebuilt as "%s"', \implode(', ', $indicesInProgress)), $code, $previous);
 

diff --git a/src/Finder/Adapter/ScrollAdapter.php b/src/Finder/Adapter/ScrollAdapter.php
@@ -36,9 +36,9 @@ class ScrollAdapter
     private $resultsType;
 
     /**
-     * @var int
+     * @var int|null
      */
-    private $totalHits = null;
+    private $totalHits;
 
     /**
      * When a search query with a 'scroll' param is performed, not only the scroll id is returned, but also the