feat: introduce "in-memory" behavior

.env

@@ -1,5 +1,12 @@
+# DBMS can be changed by adding the following in .env.local:
+#DATABASE_URL="postgresql://zenstruck:[email protected]:5433/zenstruck_foundry?serverVersion=15"
+#DATABASE_URL="sqlite:///%kernel.project_dir%/var/data.db"
 DATABASE_URL="mysql://root:[email protected]:3307/foundry_test?serverVersion=5.7.42"
+
+# Mongo ca be disabled with the following in .env.local:
+# MONGO_URL=""
 MONGO_URL="mongodb://127.0.0.1:27018/dbName?compressors=disabled&gssapiServiceName=mongodb"
-DATABASE_RESET_MODE="schema"
+
 USE_DAMA_DOCTRINE_TEST_BUNDLE="0"
-PHPUNIT_VERSION="9"
+USE_FOUNDRY_PHPUNIT_EXTENSION="0"
+PHPUNIT_VERSION="9" # allowed values: 9, 10, 11

.gitattributes

@@ -1,6 +1,8 @@
 * text=auto
 
 /.codecov.yml                   export-ignore
+/.editorconfig                  export-ignore
+/.env                           export-ignore
 /.gitattributes                 export-ignore
 /.github                        export-ignore
 /.gitignore                     export-ignore
@@ -12,8 +14,12 @@
 /docker-compose.yaml            export-ignore
 /Makefile                       export-ignore
 /phpstan.neon                   export-ignore
-/phpunit-dama-doctrine.xml.dist export-ignore
+/phpunit                        export-ignore
 /phpunit.xml.dist               export-ignore
+/phpunit-10.xml.dist            export-ignore
+/phpunit-paratest.xml.dist      export-ignore
+/psalm.xml                      export-ignore
+/stubs                          export-ignore
 /tests                          export-ignore
 /utils/rector/tests             export-ignore
 /utils/rector/composer.json     export-ignore

.github/issue_template.md

@@ -0,0 +1,13 @@
+<!--
+If your issue concerns a bug, please consider providing the following information:
+-->
+
+| Q                                                                                                                                  | A                       |
+|------------------------------------------------------------------------------------------------------------------------------------|-------------------------|
+| Foundry's version?                                                                                                                 | x.y.z                   |
+| PHP version                                                                                                                        | 8.1 / 8.2 / 8.3 / 8.4   |
+| PHPUnit version                                                                                                                    | 9 / 10 / 11 / 12        |
+| `symfony/framework-bundle` version?                                                                                                | 6.4 / 7.1 / 7.2         |
+| Do you use [dama/doctrine-test-bundle](https://github.com/dmaicher/doctrine-test-bundle)?                                          | yes / no                |
+| Which reset database strategy do you use?                                                                                          | schema / migrate / none |
+| Do you use Foundry's [PHPUnit extension](https://symfony.com/bundles/ZenstruckFoundryBundle/current/index.html#phpunit-extension)? | yes / no                |

.github/workflows/ci.yml

@@ -8,98 +8,55 @@ on:
 
 jobs:
   tests:
-    name: P:${{ matrix.php }}, S:${{ matrix.symfony }}, D:${{ matrix.database }}, PU:${{ matrix.phpunit }}${{ matrix.deps == 'lowest' && ' (lowest)' || '' }}${{ matrix.use-dama == 1 && contains(matrix.database, 'sql') && ' (dama)' || '' }}${{ !contains(matrix.database, 'sql') && '' || matrix.use-migrate == 1 && ' (migrate)' || ' (schema)' }}
+    name: P:${{ matrix.php }}, S:${{ matrix.symfony }}, D:${{ matrix.database }}, PU:${{ matrix.phpunit }}${{ matrix.deps == 'lowest' && ' (lowest)' || '' }}${{ matrix.use-phpunit-extension == 1 && ' (phpunit extension)' || '' }}
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        php: [ 8.1, 8.2, 8.3 ]
-        deps: [ highest ]
-        symfony: [ 6.4.*, 7.0.*, 7.1.* ]
-        database: [ mysql, mongo ]
-        use-dama: [ 1 ]
-        use-migrate: [ 0 ]
-        phpunit: [ 9 ]
+        php: [ 8.2, 8.3, 8.4 ]
+        symfony: [ 6.4.*, 7.1.*, 7.2.* ]
+        database: [ mysql|mongo ]
+        phpunit: [ 11 ]
+
+        # default values:
+        # deps: [ highest ]
+        # use-phpunit-extension: [ 0 ]
+
         exclude:
-          - php: 8.1
-            symfony: 7.0.*
-          - php: 8.1
-            symfony: 7.1.*
+          - {php: 8.1, symfony: 7.1.*}
+          - {php: 8.1, symfony: 7.2.*}
         include:
-          - php: 8.3
-            deps: highest
-            symfony: '*'
-            database: none
-            use-dama: 1
-            use-migrate: 0
-            phpunit: 9
-          - php: 8.3
-            deps: highest
-            symfony: '*'
-            database: mysql|mongo
-            use-dama: 1
-            use-migrate: 0
-            phpunit: 9
-          - php: 8.3
-            deps: highest
-            symfony: '*'
-            database: pgsql|mongo
-            use-dama: 1
-            use-migrate: 0
-            phpunit: 9
-          - php: 8.3
-            deps: highest
-            symfony: '*'
-            database: pgsql
-            use-dama: 0
-            use-migrate: 0
-            phpunit: 9
-          - php: 8.3
-            deps: highest
-            symfony: '*'
-            database: sqlite
-            use-dama: 0
-            use-migrate: 0
-            phpunit: 9
-          - php: 8.3
-            deps: lowest
-            symfony: '*'
-            database: sqlite
-            use-dama: 0
-            use-migrate: 0
-            phpunit: 9
-          - php: 8.3
-            deps: lowest
-            symfony: '*'
-            database: mysql
-            use-dama: 1
-            use-migrate: 0
-            phpunit: 9
-          - php: 8.3
-            deps: highest
-            symfony: '*'
-            database: mysql
-            use-dama: 1
-            use-migrate: 1
-            phpunit: 9
-          - php: 8.3
-            deps: highest
-            symfony: '*'
-            database: mysql|mongo
-            use-dama: 1
-            use-migrate: 0
-            phpunit: 10
-          - php: 8.3
-            deps: highest
-            symfony: '*'
-            database: mysql|mongo
-            use-dama: 1
-            use-migrate: 0
-            phpunit: 11
+          # php 8.1
+          - {php: 8.1, symfony: 6.4.*, phpunit: 9, database: mysql}
+
+          # old PHPUnit versions
+          - {php: 8.3, symfony: '*', phpunit: 9, database: mysql}
+          - {php: 8.3, symfony: '*', phpunit: 10, database: mysql}
+
+          # test with no database (PHPUnit 9 is used to prevent some problems with empty data providers)
+          - {php: 8.3, symfony: '*', phpunit: 9, database: none}
+          - {php: 8.3, symfony: '*', phpunit: 9, database: none, deps: lowest}
+
+          # One permutation per DBMS
+          - {php: 8.3, symfony: '*', phpunit: 11, database: mongo}
+          - {php: 8.3, symfony: '*', phpunit: 11, database: pgsql}
+          - {php: 8.3, symfony: '*', phpunit: 11, database: sqlite}
+          - {php: 8.3, symfony: '*', phpunit: 11, database: mysql}
+
+          # lowest deps (one per DBMS)
+          - {php: 8.3, symfony: '*', phpunit: 9, database: mysql|mongo, deps: lowest}
+          - {php: 8.3, symfony: '*', phpunit: 9, database: mongo, deps: lowest}
+          - {php: 8.3, symfony: '*', phpunit: 9, database: pgsql, deps: lowest}
+          - {php: 8.3, symfony: '*', phpunit: 9, database: sqlite, deps: lowest}
+          - {php: 8.3, symfony: '*', phpunit: 9, database: mysql, deps: lowest}
+
+          # using Foundry's PHPUnit extension
+          - {php: 8.3, symfony: '*', phpunit: 11, database: mysql|mongo, use-phpunit-extension: 1}
     env:
       DATABASE_URL: ${{ contains(matrix.database, 'mysql') && 'mysql://root:root@localhost:3306/foundry?serverVersion=5.7.42' || contains(matrix.database, 'pgsql') && 'postgresql://root:root@localhost:5432/foundry?serverVersion=15' || contains(matrix.database, 'sqlite') && 'sqlite:///%kernel.project_dir%/var/data.db' || '' }}
       MONGO_URL: ${{ contains(matrix.database, 'mongo') && 'mongodb://127.0.0.1:27017/dbName?compressors=disabled&gssapiServiceName=mongodb' || '' }}
-      USE_DAMA_DOCTRINE_TEST_BUNDLE: ${{ matrix.use-dama == 1 && contains(matrix.database, 'sql') && 1 || 0 }}
+      USE_DAMA_DOCTRINE_TEST_BUNDLE: ${{ contains(matrix.database, 'sql') && 1 || 0 }}
+      USE_FOUNDRY_PHPUNIT_EXTENSION: ${{ matrix.use-phpunit-extension || 0 }}
       PHPUNIT_VERSION: ${{ matrix.phpunit }}
     services:
       postgres:
@@ -145,8 +102,111 @@ jobs:
       - name: Test
         run: ./phpunit
         shell: bash
+
+  test-reset-database:
+    name: Reset DB - D:${{ matrix.database }} ${{ matrix.use-dama == 1 && ' (dama)' || '' }} ${{ matrix.reset-database-mode == 'migrate' && ' (migrate)' || '' }} ${{ contains(matrix.with-migration-configuration-file, 'transactional') && '(configuration file transactional)' || contains(matrix.with-migration-configuration-file, 'configuration') && '(configuration file)' || '' }}${{ matrix.deps == 'lowest' && ' (lowest)' || '' }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        database: [ mysql, pgsql, sqlite, mysql|mongo ]
+        use-dama: [ 0, 1 ]
+        reset-database-mode: [ schema, migrate ]
+        migration-configuration-file: ['no']
+        deps: [ highest, lowest ]
+        include:
+          - { database: mongo, migration-configuration-file: 'no', use-dama: 0, reset-database-mode: schema }
+          - { database: pgsql, migration-configuration-file: 'migration-configuration', use-dama: 0, reset-database-mode: migration }
+          - { database: pgsql, migration-configuration-file: 'migration-configuration-transactional', use-dama: 0, reset-database-mode: migration }
+    env:
+      DATABASE_URL: ${{ contains(matrix.database, 'mysql') && 'mysql://root:root@localhost:3306/foundry?serverVersion=5.7.42' || contains(matrix.database, 'pgsql') && 'postgresql://root:root@localhost:5432/foundry?serverVersion=15' || 'sqlite:///%kernel.project_dir%/var/data.db' }}
+      MONGO_URL: ${{ contains(matrix.database, 'mongo') && 'mongodb://127.0.0.1:27017/dbName?compressors=disabled&gssapiServiceName=mongodb' || '' }}
+      USE_DAMA_DOCTRINE_TEST_BUNDLE: ${{ matrix.use-dama == 1 && 1 || 0 }}
+      DATABASE_RESET_MODE: ${{ matrix.reset-database-mode == 1 && 1 || 0 }}
+      MIGRATION_CONFIGURATION_FILE: ${{ matrix.migration-configuration-file == 'no' && '' || format('tests/Fixture/MigrationTests/configs/{0}.php', matrix.migration-configuration-file) }}
+      PHPUNIT_VERSION: 11
+    services:
+      postgres:
+        image: ${{ contains(matrix.database, 'pgsql') && 'postgres:15' || '' }}
         env:
-          DATABASE_RESET_MODE: ${{ matrix.use-migrate == 1 && 'migrate' || 'schema' }}
+          POSTGRES_USER: root
+          POSTGRES_PASSWORD: root
+          POSTGRES_DB: foundry
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+      mongo:
+        image: ${{ contains(matrix.database, 'mongo') && 'mongo:4' || '' }}
+        ports:
+          - 27017:27017
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+          coverage: none
+          tools: flex
+
+      - name: Install dependencies
+        uses: ramsey/composer-install@v2
+        with:
+          dependency-versions: ${{ matrix.deps }}
+          composer-options: --prefer-dist
+        env:
+          SYMFONY_REQUIRE: 7.1.*
+
+      - name: Set up MySQL
+        if: contains(matrix.database, 'mysql')
+        run: sudo /etc/init.d/mysql start
+
+      - name: Test
+        run: |
+          ./phpunit --testsuite reset-database --bootstrap tests/bootstrap-reset-database.php
+
+          # We should be able to run the tests twice in order to check if the second run also starts from a fresh db
+          # some bugs could be detected this way
+          ./phpunit --testsuite reset-database --bootstrap tests/bootstrap-reset-database.php
+        shell: bash
+
+  test-with-paratest:
+    name: Test with paratest
+    runs-on: ubuntu-latest
+    env:
+      DATABASE_URL: 'mysql://root:root@localhost:3306/foundry?serverVersion=5.7.42'
+      MONGO_URL: ''
+      USE_DAMA_DOCTRINE_TEST_BUNDLE: 1
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.4
+          coverage: none
+          tools: flex
+
+      - name: Install dependencies
+        uses: ramsey/composer-install@v2
+        with:
+          dependency-versions: highest
+          composer-options: --prefer-dist
+        env:
+          SYMFONY_REQUIRE: 7.2.*
+
+      - name: Set up MySQL
+        run: sudo /etc/init.d/mysql start
+
+      - name: Test
+        run: vendor/bin/paratest --processes 1 --configuration phpunit-paratest.xml.dist
+        shell: bash
 
   code-coverage:
     name: Code Coverage
@@ -155,7 +215,8 @@ jobs:
       DATABASE_URL: postgresql://root:root@localhost:5432/foundry?serverVersion=15
       MONGO_URL: mongodb://127.0.0.1:27017/dbName?compressors=disabled&gssapiServiceName=mongodb
       USE_DAMA_DOCTRINE_TEST_BUNDLE: 1
-      PHPUNIT_VERSION: 9
+      USE_FOUNDRY_PHPUNIT_EXTENSION: 1
+      PHPUNIT_VERSION: 11
     services:
       mongo:
         image: mongo:4
@@ -236,6 +297,9 @@ jobs:
         with:
           composer-options: --prefer-dist
 
+      - name: Validate PSR-4
+        run: composer dump-autoload --optimize --strict-psr --strict-ambiguous
+
       - name: Install PHPStan
         run: composer bin phpstan install
 
@@ -256,7 +320,7 @@ jobs:
     steps:
       - uses: zenstruck/.github/actions/php-cs-fixer@main
         with:
-          php: 8
+          php: 8.1
           key: ${{ secrets.GPG_PRIVATE_KEY }}
           token: ${{ secrets.COMPOSER_TOKEN }}
 

.gitignore

@@ -4,7 +4,7 @@
 /.phpunit.cache
 /vendor/
 /bin/tools/*/vendor/
-/bin/tools/php-cs-fixer/composer.lock
+/bin/tools/csfixer
 /build/
 /.php-cs-fixer.cache
 /.phpunit.result.cache
@@ -14,5 +14,4 @@
 /docker/.makefile
 /.env.local
 /docker-compose.override.yaml
-/tests/Fixture/Migrations/
 /tests/Fixture/Maker/tmp/