Merge pull request #3 from mll-lab/improve-project-setup

Improvements to the project setup

Author: DaveLiddament

Dockerfile

@@ -4,34 +4,24 @@ FROM php:${PHP_VERSION}cli
 # Increase memory limit
 RUN echo 'memory_limit = -1' >> /usr/local/etc/php/conf.d/docker-php-memlimit.ini
 
-# install Composer
-COPY ./docker/composer.sh /root/
-
+# Install Composer
+COPY --from=composer /usr/bin/composer /usr/bin/composer
 RUN <<EOF
-set -eux;
-apt-get update;
-apt-get install -y  \
-    git  \
-    zip;
-rm -rf /var/lib/apt/lists/*;
-cd /root/;
-chmod 755 composer.sh;
-/root/composer.sh;
-mv /root/composer.phar /usr/local/bin/composer;
-rm /root/composer.sh;
+set -eux
+apt-get update
+apt-get install --yes git zip
+rm -rf /var/lib/apt/lists/*
 EOF
 
-# install Xdebug
+# Install Xdebug
 ARG XDEBUG_ENABLED=1
-
 RUN <<EOF
 if [ $XDEBUG_ENABLED -eq 1 ]; then
-    pecl install xdebug;
-    docker-php-ext-enable xdebug;
+    pecl install xdebug
+    docker-php-ext-enable xdebug
 fi
 EOF
 
 # Sort out git
 RUN git config --global --add safe.directory /app
-
-WORKDIR /app/
+WORKDIR /app

README.md

@@ -8,39 +8,39 @@
 [![Continuous Integration](https://github.com/DaveLiddament/test-splitter/workflows/Checks/badge.svg)](https://github.com/DaveLiddament/test-splitter/actions)
 [![Psalm level 1](https://img.shields.io/badge/Psalm-%20level%201-brightgreen.svg)](https://github.com/DaveLiddament/test-splitter/blob/master/psalm.xml)
 
+Have you got a slow running test suite?
+Are existing test parallelisation tools (e.g. [paratest](https://github.com/paratestphp/paratest)) not suitable as you need separate database instances?
 
-
-Have you got a slow running test suite? Are existing test parallelisation tools (e.g. [paratest](https://github.com/paratestphp/paratest)) not suitable as you need separate database instances?
-
-If so PHPUnit test case splitter might help. This splits tests into batches in a deterministic way. Each batch of tests can run in separate instances (e.g. by using a matrix in github actions).
+If so, PHPUnit test case splitter might help.
+It splits tests into batches in a deterministic way.
+Each batch of tests can run in separate instances (e.g. by using a matrix in GitHub actions).
 
 ## Usage
 
-To use. Install:
+Install via [Composer](https://getcomposer.org):
 
-```bash
+```shell
 composer require --dev dave-liddament/test-splitter
 ```
 
-Test splitter (`tsplit`) takes two arguments: batch, and number of batches. The list of tests is piped into `stdin`.
+This package provides an executable under `vendor/bin/tsplit` that takes two arguments: batch, and number of batches.
+It accepts a list of tests piped into `stdin` and outputs the tests for the specified batch to `stdout`.
 
 To split the tests into 4 batches and run the first batch you can do:
 
-```
+```shell
 vendor/bin/phpunit --filter `vendor/bin/phpunit --list-tests | vendor/bin/tsplit 1 4`
 ```
 
-To run the second batch you'd use:
+To run the second batch out of 4 you'd use:
 
-
-```
+```shell
 vendor/bin/phpunit --filter `vendor/bin/phpunit --list-tests | vendor/bin/tsplit 2 4`
 ```
 
+## GitHub actions
 
-## Github actions
-
-Add this to your github actions:
+Add this to your GitHub actions:
 
 ```yaml
 jobs:
@@ -52,7 +52,7 @@ jobs:
         test-batch: [1, 2, 3, 4]
 
     steps: 
-      # Steps to checkout code, setup environment, etc
+      # Steps to checkout code, setup environment, etc.
 
       - name: "Tests batch ${{ matrix.test--batch }}"
         run: vendor/bin/phpunit --filter `vendor/bin/phpunit --list-tests | vendor/bin/tsplit ${{ matrix.test-batch }} 4`
@@ -63,4 +63,4 @@ This will split the tests over 4 different jobs.
 ## Additional documentation
 
 - [Code of Conduct](docs/CodeOfConduct.md)
-- [Contributing](docs/Contributing.md)
+- [Contributing](docs/Contributing.md)

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "dave-liddament/test-splitter",
-  "description": "Splits up PHPUnit tests so they can be ran in parallel (e.g. on github actions)",
+  "description": "Splits up PHPUnit tests so they can be ran in parallel (e.g. on GitHub actions)",
   "type": "project",
   "require": {
     "php": "8.1.*|8.2.*|8.3.*|8.4.*"
@@ -42,8 +42,8 @@
     ],
     "composer-validate" : "@composer validate --no-check-all --strict",
     "lint" : "parallel-lint src tests",
-    "cs" : "php-cs-fixer fix -v --dry-run",
-    "cs-fix" : "php-cs-fixer fix -v",
+    "cs" : "php-cs-fixer fix --verbose --dry-run",
+    "cs-fix" : "php-cs-fixer fix --verbose",
     "psalm" : "psalm --shepherd",
     "test" : "phpunit"
   }

docker-compose.yaml docker-compose.ymldocker-compose.yaml renamed to docker-compose.yml

@@ -5,7 +5,8 @@ services:
         PHP_VERSION: ""
     tty: true
     volumes:
-      - .:/app/:delegated
+      - .:/app:delegated
+    networks: []
   php81:
     build:
       args:

docker/composer.sh

@@ -2,58 +2,64 @@
 
 Contributions are welcome. 
 
-
 ## Requirements for code created
 
 test-splitter MUST support all PHP versions that are either in [active or security](https://www.php.net/supported-versions.php) support. 
 
 The maintainer will aim to add support for new PHP versions within 6 weeks of the official release. 
 
-
 ## Code checks
 
-After writing your code run code style fixer, this will automatically format the code to the project style:
+After writing your code, format it according to the project style:
 
-```
+```shell
 composer cs-fix
 ```
 
+Perform all quality assurance tasks that are run for continuous integration: 
 
-Check all the CI tasks would run. 
-```
+```shell
 composer ci
 ```
 
+## Docker setup
 
-## Docker 
+[Dockerfile](/Dockerfile) and [docker-compose.yml](/docker-compose.yml) have been provided to help with development. 
 
-A docker file has been provided to help with development. 
+### Install dependencies
 
-#### Build
-Build the image: 
+Run the following to install dependencies in the PHP version of your choice (e.g. 8.4):
 
 ```shell
-docker compose build
+docker compose run --rm php84 composer install
 ```
 
-#### Run the services
+### Run composer scripts
+
+You can run composer scripts in any supported PHP version through Docker:
 
-Start the services 
 ```shell
-docker compose up -d
+docker compose run --rm php<version> composer <script> 
 ```
 
-You can run composer command. E.g. To run `composer cs-fix` on PHP 8.2
+For example, to run `cs-fix` on PHP 8.2:
 
 ```shell
-docker compose exec php82 composer cs-fix 
+docker compose run --rm php82 composer cs-fix
 ```
 
-See the composer scripts section for all scripts available.
-
-You can also get shell access. E.g. to get shell access on PHP 8.3:
+To run all validations in every supported PHP version, you can use the following command:
 
 ```shell
-docker compose exec php82 bash 
+for v in 81 82 83 84; do docker compose run --rm php$v composer ci || break; done
 ```
 
+See [composer.json](/composer.json) section `scripts` for all available scripts.
+
+### Shell access
+
+You can get interactive shell access in any PHP version, e.g. on PHP 8.3:
+
+```shell
+docker compose run --rm php83 bash
+```

docs/Contributing.md

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
          bootstrap="vendor/autoload.php"
          cacheResultFile=".phpunit.cache/test-results"
          executionOrder="depends,defects"

phpunit.xml

@@ -13,4 +13,7 @@
             <directory name="vendor"/>
         </ignoreFiles>
     </projectFiles>
-<plugins><pluginClass class="Psalm\PhpUnitPlugin\Plugin"/></plugins></psalm>
+    <plugins>
+        <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
+    </plugins>
+</psalm>

psalm.xml

@@ -26,7 +26,7 @@ public function __construct(array $args)
         $this->denominator = $this->asInt($args[2]);
 
         if ($this->numerator > $this->denominator) {
-            throw new InvalidArgumentsException("Numerator must be less than Demoninator ({$this->denominator})");
+            throw new InvalidArgumentsException("Numerator {$this->numerator} must be less than Denominator {$this->denominator}");
         }
     }
 

src/CliArgumentParser.php

@@ -49,7 +49,7 @@ public function invalidArgumentsDataProvider(): array
                     '2',
                 ],
             ],
-            'denoninator is float' => [
+            'denominator is float' => [
                 [
                     self::SCRIPT_NAME,
                     '1',