feat: initial implementation of OpenApiServerMock module

Author: Fahl-Design

.gitattributes

@@ -0,0 +1,10 @@
+# Exclude files from the final zip package (composer install --prefer-dist)
+/.github             export-ignore
+/.gitignore          export-ignore
+/.idea               export-ignore
+/.php-cs-fixer.php   export-ignore
+/.php-version        export-ignore
+/.releaserc          export-ignore
+/composer.lock       export-ignore
+/phpstan.neon        export-ignore
+/renovate.json       export-ignore

.github/workflows/ci.yml

@@ -0,0 +1,221 @@
+on:
+  push:
+    branches:
+      - "main"
+  pull_request:
+#  schedule:
+#    - cron: '24 10 * * 4'
+
+name: "CI"
+
+permissions:
+  contents: read
+
+env:
+  PHP_VERSION: "8.3"
+
+jobs:
+  qa:
+    name: "QA (lint + static analysis)"
+    if: "!startsWith(github.event.head_commit.message, 'chore(release)')"
+    runs-on: "ubuntu-latest"
+    steps:
+      -   name: "Checkout"
+          uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
+
+      -   name: "Install PHP"
+          uses: "shivammathur/setup-php@44454db4f0199b8b9685a5d763dc37cbf79108e1" # 2.36.0
+          with:
+            coverage: "none"
+            php-version: "${{ env.PHP_VERSION }}"
+
+      -   name: "Validate composer.json and composer.lock"
+          if: "github.actor != 'renovate[bot]' || contains(github.head_ref, 'lock-file-maintenance')"
+          run: "composer validate --ansi --strict"
+
+      -   name: "Determine composer cache directory"
+          uses: "ergebnis/.github/actions/composer/determine-cache-directory@4103ff7c010d2c18dc84f72d6704227868412482" # 1.10.0
+
+      -   name: "Cache dependencies installed with composer"
+          uses: "actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306" # v5.0.3
+          with:
+            path: "${{ env.COMPOSER_CACHE_DIR }}"
+            key: "php-${{ env.PHP_VERSION }}-composer-locked-${{ hashFiles('composer.lock') }}"
+            restore-keys: |
+              php-${{ env.PHP_VERSION }}-composer-locked-${{ github.ref_name }}
+              php-${{ env.PHP_VERSION }}-composer-locked-
+              php-${{ env.PHP_VERSION }}-composer-main
+
+      -   name: "Install locked dependencies with composer"
+          uses: "ergebnis/.github/actions/composer/install@4103ff7c010d2c18dc84f72d6704227868412482" # 1.10.0
+          with:
+            dependencies: "${{ (github.actor == 'renovate[bot]' && !contains(github.head_ref, 'lock-file-maintenance')) && 'highest' || 'locked' }}"
+
+      -   name: "Check coding style"
+          run: "vendor/bin/codecept build"
+
+      -   name: "Check coding style"
+          run: "composer cs:check"
+
+      -   name: "Run static analysis"
+          run: "composer stan"
+
+#  codacy:
+#    name: "Codacy Security Scan"
+#    if: "!startsWith(github.event.head_commit.message, 'chore(release)')"
+#    runs-on: "ubuntu-latest"
+#    permissions:
+#      contents: read
+#      security-events: write
+#      actions: read
+#    steps:
+#      - name: Checkout code
+#        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+#
+#      - name: Run Codacy Analysis CLI
+#        uses: codacy/codacy-analysis-cli-action@30783d03e758713bb5ed7b79292cfb14b9dd9a4a
+#        with:
+#          project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
+#          verbose: false
+#          output: results.sarif
+#          format: sarif
+#          upload: true
+#          skip-uncommitted-files-check: true
+#          gh-code-scanning-compat: true
+#          max-allowed-issues: 2147483647
+
+  tests:
+    name: "Run codeception tests"
+    needs: [ qa ]
+    runs-on: "ubuntu-latest"
+    strategy:
+      matrix:
+        include:
+          - { php-version: 8.3, dependencies: locked, coverage: pcov, with_coverage: true, allow-fail: false }
+
+          - { php-version: 8.4, dependencies: highest, coverage: pcov, with_coverage: false, allow-fail: true }
+          - { php-version: 8.5, dependencies: highest, coverage: pcov, with_coverage: false, allow-fail: true }
+    steps:
+      -   name: "Checkout"
+          uses: "actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd" # v6.0.2
+
+      -   name: "Install PHP"
+          uses: "shivammathur/setup-php@44454db4f0199b8b9685a5d763dc37cbf79108e1" # 2.36.0
+          with:
+            coverage: "${{ matrix.coverage }}"
+            ini-values: display_errors=On, display_startup_errors=On, error_reporting=32767
+            php-version: "${{ matrix.php-version }}"
+
+      -   name: "Set up problem matchers for PHP"
+          run: "echo \"::add-matcher::${{ runner.tool_cache }}/php.json\""
+
+      -   name: "Set up problem matchers for phpunit/phpunit"
+          run: "echo \"::add-matcher::${{ runner.tool_cache }}/phpunit.json\""
+
+      -   name: "Validate composer.json and composer.lock"
+          if: "github.actor != 'renovate[bot]' || contains(github.head_ref, 'lock-file-maintenance')"
+          run: "composer validate --ansi --strict"
+
+      -   name: "Determine composer cache directory"
+          uses: "ergebnis/.github/actions/composer/determine-cache-directory@4103ff7c010d2c18dc84f72d6704227868412482" # 1.10.0
+
+      -   name: "Cache dependencies installed with composer"
+          uses: "actions/cache@cdf6c1fa76f9f475f3d7449005a359c84ca0f306" # v5.0.3
+          with:
+            path: "${{ env.COMPOSER_CACHE_DIR }}"
+            key: "php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}"
+            restore-keys: |
+              php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ github.ref_name }}
+              php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-
+              php-${{ matrix.php-version }}-composer-main
+
+      -   name: "Install ${{ matrix.dependencies }} dependencies with composer"
+          uses: "ergebnis/.github/actions/composer/install@4103ff7c010d2c18dc84f72d6704227868412482" # 1.10.0
+          with:
+            dependencies: "${{ (github.actor == 'renovate[bot]' && !contains(github.head_ref, 'lock-file-maintenance') && matrix.dependencies == 'locked') && 'highest' || matrix.dependencies }}"
+
+      -   name: "Run Tests (coverage)"
+          if: matrix.with_coverage == true
+          run: |
+            vendor/bin/codecept build
+            vendor/bin/codecept run --coverage --coverage-xml=coverage.xml --xml  --report
+
+      -   name: "Run Tests"
+          if: matrix.with_coverage != true
+          run: |
+            vendor/bin/codecept build
+            vendor/bin/codecept run --xml --report
+
+      -   name: "Upload coverage artifact"
+          if: matrix.with_coverage == true
+          uses: actions/upload-artifact@bbbca2ddaa5d8feaa63e36b76fdaad77386f024f # v7.0.0
+          with:
+            name: code-coverage-results
+            path: tests/_output/
+            retention-days: 5
+
+#      -   name: "Upload Coverage coverage"
+#          if: matrix.with_coverage == true
+#          run: |
+#            export CODACY_PROJECT_TOKEN=${{ secrets.CODACY_PROJECT_TOKEN }}
+#            bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r ./build/logs/coverage.xml
+#
+#      -   name: Upload test results to Codecov
+#          if: ${{ !cancelled() && matrix.with_coverage == true }}
+#          uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5
+#          with:
+#            token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+#            files: ./build/logs/report.xml
+#            flags: unittests # optional
+#            report_type: test_results
+#            fail_ci_if_error: "${{ matrix.with_coverage }}" # optional (default = false)
+#            verbose: false # optional (default = false)
+#      -   name: Upload coverage to Codecov
+#          if: ${{ !cancelled() && matrix.with_coverage == true }}
+#          uses: codecov/codecov-action@671740ac38dd9b0130fbe1cec585b89eea48d3de # v5
+#          with:
+#            token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
+#            files: ./build/logs/coverage.xml
+#            flags: unittests # optional
+#            fail_ci_if_error: "${{ matrix.with_coverage }}" # optional (default = false)
+#            verbose: false # optional (default = false)
+
+  release:
+    name: "Release"
+    needs:
+    - tests
+#    - codacy
+    if: "github.event_name == 'push' && github.ref == 'refs/heads/main' && !startsWith(github.event.head_commit.message, 'chore(release)')"
+    runs-on: "ubuntu-latest"
+    permissions:
+      actions: read
+      contents: read
+    steps:
+      - name: Generate Token
+        id: generate_token
+        uses: actions/create-github-app-token@29824e69f54612133e76f7eaac726eef6c875baf # v2
+        with:
+          app-id: ${{ secrets.BOT_APP_ID }}
+          private-key: ${{ secrets.BOT_APP_PRIVATE_KEY }}
+
+      - name: Checkout
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+        with:
+          fetch-depth: 0
+          token: ${{ steps.generate_token.outputs.token }}
+
+      - name: Semantic Release
+        uses: cycjimmy/semantic-release-action@v6.0.0
+        with:
+          tag_format: ${version}
+          branches: |
+            ['main']
+          extra_plugins: |
+            @semantic-release/commit-analyzer
+            @semantic-release/release-notes-generator
+            @semantic-release/github
+            @semantic-release/changelog
+            @semantic-release/git
+            conventional-changelog-conventionalcommits
+        env:
+          GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}

.gitignore

@@ -0,0 +1,2 @@
+vendor/
+.idea/

.php-cs-fixer.cache

@@ -0,0 +1 @@
+{"php":"8.3.30","version":"3.94.2:v3.94.2#7787ceff91365ba7d623ec410b8f429cdebb4f63","indent":"    ","lineEnding":"\n","rules":{"binary_operator_spaces":{"default":"align","operators":{"??":"single_space"}},"blank_lines_before_namespace":true,"braces_position":{"allow_single_line_anonymous_functions":true,"allow_single_line_empty_anonymous_classes":true},"class_definition":{"single_line":true},"compact_nullable_type_declaration":true,"declare_equal_normalize":true,"lowercase_cast":true,"lowercase_static_reference":true,"modifier_keywords":true,"new_with_parentheses":{"anonymous_class":false},"no_blank_lines_after_class_opening":true,"no_extra_blank_lines":{"tokens":["attribute","case","continue","curly_brace_block","default","extra","parenthesis_brace_block","square_brace_block","switch","throw","use"]},"no_leading_import_slash":true,"no_whitespace_in_blank_line":true,"ordered_class_elements":{"order":["use_trait"]},"ordered_imports":{"sort_algorithm":"alpha"},"return_type_declaration":true,"short_scalar_cast":true,"single_import_per_statement":true,"single_space_around_construct":true,"single_trait_insert_per_statement":true,"ternary_operator_spaces":true,"unary_operator_spaces":true,"blank_line_after_namespace":true,"constant_case":true,"control_structure_braces":true,"control_structure_continuation_position":true,"elseif":true,"function_declaration":{"closure_fn_spacing":"one"},"indentation_type":true,"line_ending":true,"lowercase_keywords":true,"method_argument_space":{"after_heredoc":true},"no_break_comment":true,"no_closing_tag":true,"no_multiple_statements_per_line":true,"no_space_around_double_colon":true,"no_spaces_after_function_name":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_class_element_per_statement":true,"single_line_after_imports":true,"spaces_inside_parentheses":true,"statement_indentation":{"stick_comment_to_next_continuous_control_statement":true},"switch_case_semicolon_to_colon":true,"switch_case_space":true,"encoding":true,"full_opening_tag":true,"align_multiline_comment":true,"backtick_to_shell_exec":true,"blank_line_before_statement":{"statements":["return"]},"class_attributes_separation":{"elements":{"method":"one"}},"class_reference_name_casing":true,"clean_namespace":true,"concat_space":{"spacing":"one"},"declare_parentheses":true,"echo_tag_syntax":true,"empty_loop_body":{"style":"braces"},"empty_loop_condition":true,"fully_qualified_strict_types":true,"general_phpdoc_tag_rename":{"replacements":{"inheritDocs":"inheritDoc"}},"global_namespace_import":{"import_classes":true,"import_functions":true,"import_constants":true},"include":true,"increment_style":true,"integer_literal_case":true,"lambda_not_used_import":true,"linebreak_after_opening_tag":true,"magic_constant_casing":true,"magic_method_casing":true,"native_function_casing":true,"native_type_declaration_casing":true,"no_alias_language_construct_call":true,"no_alternative_syntax":true,"no_binary_string":true,"no_blank_lines_after_phpdoc":true,"no_empty_comment":true,"no_empty_phpdoc":true,"no_empty_statement":true,"no_leading_namespace_whitespace":true,"no_mixed_echo_print":true,"no_multiline_whitespace_around_double_arrow":true,"no_null_property_initialization":true,"no_short_bool_cast":true,"no_singleline_whitespace_before_semicolons":true,"no_spaces_around_offset":true,"no_superfluous_phpdoc_tags":{"allow_hidden_params":true,"remove_inheritdoc":true},"no_trailing_comma_in_singleline":true,"no_unneeded_braces":{"namespaces":true},"no_unneeded_control_parentheses":{"statements":["break","clone","continue","echo_print","negative_instanceof","others","return","switch_case","yield","yield_from"]},"no_unneeded_import_alias":true,"no_unset_cast":true,"no_unused_imports":true,"no_useless_concat_operator":true,"no_useless_else":true,"no_useless_nullsafe_operator":true,"no_useless_return":true,"no_whitespace_before_comma_in_array":{"after_heredoc":true},"normalize_index_brace":true,"nullable_type_declaration_for_default_null_value":true,"object_operator_without_whitespace":true,"operator_linebreak":{"only_booleans":true},"php_unit_fqcn_annotation":true,"php_unit_method_casing":true,"phpdoc_align":true,"phpdoc_annotation_without_dot":true,"phpdoc_indent":true,"phpdoc_inline_tag_normalizer":true,"phpdoc_no_access":true,"phpdoc_no_alias_tag":{"replacements":{"const":"var","link":"see","property-read":"property","property-write":"property","type":"var"}},"phpdoc_no_package":true,"phpdoc_no_useless_inheritdoc":true,"phpdoc_order":{"order":["param","return","throws"]},"phpdoc_return_self_reference":true,"phpdoc_scalar":{"types":["boolean","callback","double","integer","never-return","never-returns","no-return","real","str"]},"phpdoc_separation":{"groups":[["Annotation","NamedArgumentConstructor","Target"],["author","copyright","license"],["category","package","subpackage"],["property","property-read","property-write"],["deprecated","link","see","since"]],"skip_unlisted_annotations":false},"phpdoc_single_line_var_spacing":true,"phpdoc_summary":true,"phpdoc_tag_type":{"tags":{"inheritDoc":"inline"}},"phpdoc_trim":true,"phpdoc_trim_consecutive_blank_line_separation":true,"phpdoc_types":true,"phpdoc_types_order":{"null_adjustment":"always_last","sort_algorithm":"none"},"phpdoc_var_annotation_correct_order":true,"phpdoc_var_without_name":true,"protected_to_private":true,"semicolon_after_instruction":true,"simple_to_complex_string_variable":true,"single_line_comment_spacing":true,"single_line_comment_style":{"comment_types":["hash"]},"single_line_throw":true,"single_quote":true,"space_after_semicolon":{"remove_in_empty_for_expressions":true},"standardize_increment":true,"standardize_not_equals":true,"switch_continue_to_break":true,"trailing_comma_in_multiline":{"after_heredoc":true},"trim_array_spaces":true,"type_declaration_spaces":{"elements":["function","property"]},"whitespace_after_comma_in_array":true,"yoda_style":true,"nullable_type_declaration":true,"ordered_types":{"null_adjustment":"always_last","sort_algorithm":"none"},"types_spaces":true,"array_indentation":true,"array_syntax":true,"attribute_block_no_spaces":true,"cast_spaces":true,"array_push":true,"combine_nested_dirname":true,"dir_constant":true,"ereg_to_preg":true,"error_suppression":true,"fopen_flag_order":true,"fopen_flags":{"b_mode":false},"function_to_constant":true,"implode_call":true,"is_null":true,"logical_operators":true,"long_to_shorthand_operator":true,"modern_serialization_methods":true,"modernize_types_casting":true,"native_constant_invocation":{"fix_built_in":false,"include":["DIRECTORY_SEPARATOR","PHP_INT_SIZE","PHP_SAPI","PHP_VERSION_ID"],"scope":"namespaced","strict":true},"native_function_invocation":{"include":["@compiler_optimized"],"scope":"namespaced","strict":true},"no_alias_functions":{"sets":["@all"]},"no_homoglyph_names":true,"no_php4_constructor":true,"no_trailing_whitespace_in_string":true,"no_unneeded_final_method":true,"no_useless_sprintf":true,"non_printable_character":true,"ordered_traits":true,"php_unit_construct":true,"php_unit_mock_short_will_return":true,"php_unit_set_up_tear_down_visibility":true,"php_unit_test_annotation":true,"psr_autoloading":true,"self_accessor":true,"set_type_to_cast":true,"static_lambda":true,"string_length_to_empty":true,"string_line_ending":true,"ternary_to_elvis_operator":true,"pow_to_exponentiation":true,"no_unreachable_default_argument_value":true,"comment_to_phpdoc":true,"final_internal_class":true,"no_unset_on_property":true,"php_unit_data_provider_name":true,"php_unit_data_provider_return_type":true,"php_unit_data_provider_static":{"force":true},"php_unit_strict":true,"php_unit_test_case_static_method_calls":{"call_type":"self"},"strict_comparison":true,"strict_param":true,"yield_from_array_to_yields":true,"octal_notation":true,"assign_null_coalescing_to_coalesce_equal":true,"heredoc_indentation":true,"list_syntax":true,"ternary_to_null_coalescing":true,"doctrine_annotation_array_assignment":{"operator":":"},"doctrine_annotation_braces":true,"doctrine_annotation_indentation":true,"doctrine_annotation_spaces":{"before_array_assignments_colon":false},"declare_strict_types":true,"php_unit_dedicate_assert":{"target":"newest"}},"ruleCustomisationPolicyVersion":"null-policy","hashes":{"tests\/Support\/UnitTester.php":"6eb8ec62c8f4500953b807c18952b117","tests\/Support\/AcceptanceTester.php":"a99adc231aef83a856e1b6420654fbd1","tests\/Acceptance\/MockServerCest.php":"4477201d6bdf59a5c96ee5bac1b0484d",".php-cs-fixer.php":"024df4f6538b23e62193ca8db8f0164c","rector.php":"daa347ebd629417ca7c018b5b9cbb8b1","src\/OpenApiServerMock.php":"cac84ab2bc13590c334ad26b033a9137"}}