chore: add self serve action to enable specs based service virtualization

.github/workflows/generator-test-sdk.yaml

@@ -27,36 +27,7 @@ on:
         value: ${{ jobs.sdk-metadata.outputs.version }}
 
 jobs:
-  download-specs:
-    uses: ./.github/workflows/generator-download-specs.yaml
-    with:
-      url: ${{ inputs.specs_url }}
-
-  transform-specs:
-    needs: [ download-specs ]
-    uses: ./.github/workflows/selfserve-transform-specs.yaml
-    with:
-      specs_key: 'raw-specs'
-      transformations: -th -te ${{ inputs.endpoint_prefix }} --operationIdsToTags
-
-  upload-templates:
-    uses: ./.github/workflows/selfserve-checkout-and-upload.yaml
-    with:
-      artifact_key: 'templates'
-      artifact_path: 'generator/openapi/src/main/resources/templates/expediagroup-sdk'
-      repository: 'ExpediaGroup/expediagroup-java-sdk'
-      ref: "${{ github.head_ref || github.ref_name }}"
-
-  upload-repo:
-    uses: ./.github/workflows/selfserve-checkout-and-upload.yaml
-    with:
-      artifact_key: 'sdk-repo'
-      artifact_path: ''
-      repository: 'ExpediaGroup/expediagroup-java-sdk'
-      ref: "${{ github.head_ref || github.ref_name }}"
-
   generate-sdk:
-    needs: [ transform-specs, upload-repo ]
     uses: ./.github/workflows/selfserve-generate-sdk.yaml
     with:
       name: ${{ inputs.namespace }}

.github/workflows/run-tests.yaml

@@ -17,14 +17,16 @@ on:
         default: ''
       sdk_version:
         description: 'Run tests based on SDK'
-        required: false
         type: string
         default: 'LATEST'
       sdk_namespace:
         description: 'SDK to test'
-        required: true
         type: string
         default: 'rapid'
+      sdk_artifact_id:
+        description: 'SDK artifactId'
+        type: string
+        default: 'rapid-sdk'
       endpoint_prefix:
         description: 'Endpoint to prepend specs paths with'
         required: true
@@ -42,7 +44,7 @@ on:
   workflow_call:
     inputs:
       source:
-        description: 'Source of tests'
+        description: 'Source of tests. Can be `sdk` or `specs`'
         required: true
         type: string
         default: 'sdk'
@@ -58,9 +60,12 @@ on:
         default: 'LATEST'
       sdk_namespace:
         description: 'SDK to test'
-        required: true
         type: string
         default: 'rapid'
+      sdk_artifact_id:
+        description: 'SDK artifactId'
+        type: string
+        default: 'rapid-sdk'
       endpoint_prefix:
         description: 'Endpoint to prepend specs paths with'
         required: true
@@ -80,26 +85,91 @@ jobs:
             print('::error::Invalid SDK version: ${{ inputs.sdk_version }}')
             exit(1)
 
+  download-specs:
+    uses: ./.github/workflows/generator-download-specs.yaml
+    with:
+      url: ${{ inputs.specs_url }}
+
+  transform-and-upload-specs:
+    needs: [ download-specs ]
+    uses: ./.github/workflows/selfserve-transform-specs.yaml
+    with:
+      specs_key: 'raw-specs'
+      transformations: -th -te ${{ inputs.endpoint_prefix }} --operationIdsToTags
+
+  upload-templates:
+    uses: ./.github/workflows/selfserve-checkout-and-upload.yaml
+    with:
+      artifact_key: 'templates'
+      artifact_path: 'generator/openapi/src/main/resources/templates/expediagroup-sdk'
+      repository: 'ExpediaGroup/expediagroup-java-sdk'
+      ref: "${{ github.head_ref || github.ref_name }}"
+
+  upload-test-templates:
+    uses: ./.github/workflows/selfserve-checkout-and-upload.yaml
+    with:
+      artifact_key: 'test-templates'
+      artifact_path: 'sdk-test/src/main/resources/templates/expediagroup-sdk'
+      repository: 'ExpediaGroup/expediagroup-java-sdk'
+      ref: "${{ github.head_ref || github.ref_name }}"
+
+  upload-repo:
+    uses: ./.github/workflows/selfserve-checkout-and-upload.yaml
+    with:
+      artifact_key: 'sdk-repo'
+      artifact_path: ''
+      repository: 'ExpediaGroup/expediagroup-java-sdk'
+      ref: "${{ github.head_ref || github.ref_name }}"
+
   generate-test-sdk:
     if: inputs.source == 'specs'
-    needs: [ inputs-validation ]
+    needs: [ inputs-validation, transform-and-upload-specs, upload-templates, upload-repo ]
     uses: ./.github/workflows/generator-test-sdk.yaml
     with:
       version: ${{ inputs.sdk_version }}
       namespace: ${{ inputs.sdk_namespace }}
       endpoint_prefix: ${{ inputs.endpoint_prefix }}
       specs_url: ${{ inputs.specs_url }}
     secrets: inherit
+
+  generate-contract-tests:
+    needs: [ inputs-validation, generate-test-sdk ]
+    uses: ./.github/workflows/selfserve-generate-contract-test-sources.yaml
+    with:
+      artifact_key: 'sdk-test'
+      repo_key: 'sdk-repo'
+      templates_key: 'test-templates'
+      specs_key: 'transformedSpecs'
+      namespace: ${{ inputs.sdk_namespace }}
+      generation_options: '--version 0.0.1 --target-group com.expediagroup --target-artifact ${{ inputs.sdk_artifact_id }} --target-version ${{ inputs.sdk_version }} -m 5' # TODO: remove -m param
+
   run-rapid-examples:
-    strategy:
-      matrix:
-        jdk: [8, 11, 17, 21]
     if: always() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') && inputs.sdk_namespace == 'rapid'
     needs: [ generate-test-sdk ]
     uses: "ExpediaGroup/rapid-java-sdk/.github/workflows/run-examples.yaml@main"
     with:
+      source: 'specs'
       sdk_version: ${{ needs.generate-test-sdk.outputs.version }}
       jdk: ${{ matrix.jdk }}
     secrets:
       KEY: ${{ secrets.RAPID_KEY }}
       SECRET: ${{ secrets.RAPID_SECRET }}
+    strategy:
+      matrix:
+        jdk: [ 8, 11, 17, 21 ]
+
+  run-rapid-contract-tests:
+    if: always() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') && inputs.sdk_namespace == 'rapid'
+    needs: [ generate-contract-tests ]
+    uses: ./.github/workflows/selfserve-run-mocked-service-tests.yaml
+    with:
+      specs_key: 'transformedSpecs'
+      test_sources_key: 'sdk-test'
+      sdk_key: 'sdk'
+      jdk: ${{ matrix.jdk }}
+    secrets:
+      KEY: ${{ secrets.RAPID_KEY }}
+      SECRET: ${{ secrets.RAPID_SECRET }}
+    strategy:
+      matrix:
+        jdk: [ 8, 11, 17, 21 ]

.github/workflows/selfserve-generate-contract-test-sources.yaml

@@ -0,0 +1,69 @@
+name: Generate & Upload Tests Sources
+
+on:
+  workflow_call:
+    inputs:
+      artifact_key:
+        description: 'Generated output artifact key. Defaults to `sdk-test`'
+        type: string
+        default: 'sdk-test'
+      repo_key:
+        description: 'SDK repository artifact key'
+        type: string
+      templates_key:
+        description: 'Templates artifact key'
+        type: string
+        required: true
+      specs_key:
+        description: 'Specs artifact key'
+        type: string
+        required: true
+      namespace:
+        description: 'Namespace of the product'
+        type: string
+        required: true
+      generation_options:
+        description: 'Options to pass to the generator. Includes `--version` and `--max-test-combinations`'
+        type: string
+        required: true
+
+jobs:
+  generate-and-upload-contract-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-java@v4
+        with:
+          java-version: 21
+          distribution: 'corretto'
+
+      - name: Download Repository
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.repo_key }}
+          path: sdk-repo
+
+      - name: Download Templates
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.templates_key }}
+          path: templates
+
+      - name: Download Specs
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.specs_key }}
+          path: specs
+
+      - name: Install SDK Generator Module
+        working-directory: sdk-repo/generator/openapi
+        run: mvn clean install
+        continue-on-error: true
+
+      - name: Generate Test Sources
+        run: mvn -f sdk-repo/sdk-test clean install exec:java -Dexec.args="--input-spec specs/${{ inputs.specs_key }}.yaml --templates-dir templates --namespace ${{ inputs.namespace }} ${{ inputs.generation_options }}"
+
+      - name: Upload Generated Sources
+        uses: actions/upload-artifact@v4
+        with:
+          path: target/sdk/*-sdk-test/**
+          name: ${{ inputs.artifact_key }}

.github/workflows/selfserve-run-mocked-service-tests.yaml

@@ -0,0 +1,99 @@
+name: SelfServe Run Service Mocked Tests
+on:
+  workflow_call:
+    inputs:
+      specs_key:
+        description: 'Specs artifact key. Defaults to `specs`'
+        type: string
+        default: 'transformedSpecs'
+        required: true
+      test_sources_key:
+        description: 'Test sources artifact key. Defaults to `sdk-test`'
+        type: string
+        default: 'sdk-test'
+        required: true
+      sdk_key:
+        description: 'SDK artifact key to download'
+        type: string
+        required: false
+        default: ''
+      jdk:
+        description: 'JDK version to use'
+        type: string
+        default: '21'
+    secrets:
+      KEY:
+        description: 'API Key'
+        required: true
+      SECRET:
+        description: 'API Key'
+        required: true
+
+jobs:
+  run-tests-with-mocked-service:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/setup-java@v4
+        with:
+          java-version: 21
+          distribution: 'corretto'
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.18.2
+
+      - name: Download Specs
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.specs_key }}
+          path: specs
+
+      - name: Transform Specs
+        working-directory: specs
+        run: npx --yes -p @expediagroup/spec-transformer cli -i ${{ inputs.specs_key }}.yaml -o ${{ inputs.specs_key }}.yaml -to
+
+      - name: Download Test Sources Artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.test_sources_key }}
+          path: test
+
+      - name: Download SDK Artifact
+        if: inputs.sdk_key != ''
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ inputs.sdk_key }}
+          path: sdk
+
+      - name: Install SDK into Local Repository
+        if: inputs.sdk_key != ''
+        working-directory: sdk
+        run: mvn clean install
+
+      - name: Download Latest Specmatic Executable
+        working-directory: specs
+        run: |
+          curl -s https://api.github.com/repos/znsio/specmatic/releases/latest \
+          | grep "browser_download_url.*specmatic.jar" \
+          | cut -d : -f 2,3 \
+          | tr -d \" \
+          | xargs curl -L -o specmatic.jar
+
+      - name: Run Mock Server
+        working-directory: specs
+        run: java -jar specmatic.jar stub ${{ inputs.specs_key }}.yaml --port 8080 & disown
+
+      - uses: actions/setup-java@v4
+        with:
+          java-version: ${{ inputs.jdk }}
+          distribution: 'corretto'
+
+      - name: Wait for Mock Server to Start
+        run: sleep 10
+
+      - name: Run Tests
+        working-directory: test
+        run: |
+          cd $(find . -type d -name "*-sdk-test" -print -quit)
+          mvn clean install exec:java -Dsdk.key="${{ secrets.KEY }}" -Dsdk.secret="${{ secrets.SECRET }}"

generator/openapi/src/main/kotlin/com/expediagroup/sdk/generators/openapi/OpenApiSdkGenerator.kt

@@ -126,6 +126,8 @@ class OpenApiSdkGenerator {
                     if (ProductFamily.isRapid(product.namespace)) {
                         rapidHelpers.forEach { (name, function) -> addAdditionalProperty(name, function()) }
                     }
+
+                    addTypeMapping("java.io.File", "java.io.InputStream")
                 }
 
             val generatorInput =

generator/openapi/src/main/resources/templates/expediagroup-sdk/operation_params.mustache

@@ -93,6 +93,7 @@
                             ) {
                                 {{#allowableValues}}
                                     {{#enumVars}}
+                                        @JsonProperty({{{value}}})
                                         {{name}}({{{value}}})
                                         {{^-last}},{{/-last}}
                                     {{/enumVars}}