Merge pull request #162 from php-api-clients/add-tests

Add tests

Author: WyriHaximus

.github/workflows/ci.yml

@@ -0,0 +1,19 @@
+name: Continuous Integration
+on:
+  push:
+    branches:
+      - 'main'
+      - 'master'
+      - 'refs/heads/v[0-9]+.[0-9]+.[0-9]+'
+  pull_request:
+## This workflow needs the `pull-request` permissions to work for the package diffing
+## Refs: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions
+permissions:
+  pull-requests: write
+  contents: read
+jobs:
+  ci:
+    name: Continuous Integration
+    uses: WyriHaximus/github-workflows/.github/workflows/package.yaml@package
+    with:
+      jsonPattern: "composer.json"

.github/workflows/generate-clients.yaml

@@ -0,0 +1,18 @@
+name: Generate and Test Clients
+on:
+  push:
+    branches:
+      - 'main'
+      - 'master'
+      - 'refs/heads/v[0-9]+.[0-9]+.[0-9]+'
+  pull_request:
+jobs:
+  generate-and-test-client:
+    name: Continuous Integration
+    strategy:
+      fail-fast: false
+      matrix:
+        client: ["miele", "one"]
+    uses: ./.github/workflows/test-client.yaml
+    with:
+      name: ${{ matrix.client }}

.github/workflows/single-client.yaml renamed to .github/workflows/test-client.yaml

@@ -1,11 +1,11 @@
-name: Continuous Integration (Single Client)
+name: Generate and test client
 on:
-  push:
-    branches:
-      - 'main'
-      - 'master'
-      - 'refs/heads/v[0-9]+.[0-9]+.[0-9]+'
-  pull_request:
+  workflow_call:
+    inputs:
+      name:
+        description: Name of the client to test
+        required: true
+        type: string
 jobs:
   generate-and-test-client:
     runs-on: ubuntu-latest
@@ -18,13 +18,13 @@ jobs:
           fetch-depth: '0'
           persist-credentials: 'false'
       - uses: "ramsey/composer-install@v2"
-      - run: make generate-example-client-one
+      - run: make generate-example-client-${{ inputs.name }}
       - name: Tar example files
         run: tar -czf example.tar ./example
       - name: Upload Generated Client
         uses: actions/upload-artifact@v3
         with:
-          name: example-single-client
+          name: example-${{ inputs.name }}-client
           path: ./example.tar
   supported-versions-matrix:
     name: Supported Versions Matrix
@@ -50,14 +50,14 @@ jobs:
       - name: Download Generated Client
         uses: actions/download-artifact@v3
         with:
-          name: example-single-client
+          name: example-${{ inputs.name }}-client
           path: ./
       - name: UnTar example files
-        run:  tar -xzf example.tar
+        run: tar -xzf example.tar
       - id: supported-checks-matrix
         name: Generate check
         run: |
-          cd example/generated
+          cd example/generated-${{ inputs.name }}
           printf "Checks found: %s\r\n" $(make task-list-ci)
           printf "::set-output name=check::%s" $(make task-list-ci)
   qa:
@@ -83,23 +83,23 @@ jobs:
       - name: Download Generated Client
         uses: actions/download-artifact@v3
         with:
-          name: example-single-client
+          name: example-${{ inputs.name }}-client
           path: ./
       - name: UnTar example files
-        run:  tar -xzf example.tar
+        run: tar -xzf example.tar
       - uses: ramsey/composer-install@v2
         with:
-          working-directory: "example/generated/"
+          working-directory: "example/generated-${{ inputs.name }}/"
           ignore-cache: "yes"
       - run: |
-          cd example/generated
+          cd example/generated-${{ inputs.name }}
           make ${{ matrix.check }} || true
         if: needs.supported-versions-matrix.outputs.upcoming == matrix.php
         env:
           COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
           COVERALLS_RUN_LOCALLY: ${{ secrets.COVERALLS_RUN_LOCALLY }}
       - run: |
-          cd example/generated
+          cd example/generated-${{ inputs.name }}
           make ${{ matrix.check }}
         if: needs.supported-versions-matrix.outputs.upcoming != matrix.php
         env:

.gitignore

@@ -4,4 +4,5 @@ example/etc
 example/generated-github
 example/generated-github-subsplit
 example/generated-miele
+tests/test-app
 vendor

etc/ci/markdown-link-checker.json

@@ -0,0 +1,15 @@
+{
+  "ignorePatterns": [
+    {
+      "pattern": "^(.*){{[^}]+([^{])*}}(.*)$"
+    }
+  ],
+  "httpHeaders": [
+    {
+      "urls": ["https://docs.github.com/"],
+      "headers": {
+        "Accept-Encoding": "zstd, br, gzip, deflate"
+      }
+    }
+  ]
+}

etc/qa/phpcs.xml

@@ -8,6 +8,8 @@
 
     <file>../../src</file>
     <file>../../tests</file>
+    <exclude-pattern type="relative-root">*/tests/app/*</exclude-pattern>
+    <exclude-pattern type="relative-root">*/tests/test-app/*</exclude-pattern>
 
     <rule ref="WyriHaximus-OSS" />
 </ruleset>

etc/qa/phpstan.neon

@@ -1,4 +1,7 @@
 parameters:
+	excludePaths:
+		- ../../tests/app/*
+		- ../../tests/test-app/*
 	ignoreErrors:
 		- '#cebe\\openapi\\spec\\Reference#'
 		- '#Call to function in_array\(\) requires parameter \#3 to be true.#'

etc/qa/phpunit.xml

@@ -2,7 +2,7 @@
 <phpunit bootstrap="../../vendor/autoload.php" colors="true">
     <testsuites>
         <testsuite name="Test Suite">
-            <directory>../../tests/</directory>
+            <file>../../tests/GenerateTest.php</file>
         </testsuite>
     </testsuites>
     <filter>

example/openapi-client-miele.yaml

@@ -32,4 +32,3 @@ voter:
     - ApiClients\Tools\OpenApiClientGenerator\Voter\ListOperation\PageAndPerPageInQuery
   streamOperation:
     - ApiClients\Tools\OpenApiClientGenerator\Voter\StreamOperation\DownloadInOperationId
-

src/Configuration.php

@@ -25,7 +25,7 @@ public function __construct(
         public string $spec,
         #[MapFrom('entryPoints')]
         public EntryPoints $entryPoints,
-        public Templates $templates,
+        public ?Templates $templates,
         public Namespace_ $namespace,
         public Destination $destination,
         #[MapFrom('contentType')]