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

.github/workflows/run-tests.yaml

@@ -0,0 +1,73 @@
+name: Run Tests
+on:
+  workflow_call:
+    inputs:
+      sdk_version:
+        description: 'Run tests based on SDK'
+        type: string
+        default: 'LATEST'
+      sdk_namespace:
+        description: 'SDK to test'
+        type: string
+        default: 'rapid'
+      transformations:
+        description: 'Specs transformations'
+        required: true
+        type: string
+      product_repo:
+        description: 'Product repository'
+        required: true
+        type: string
+
+jobs:
+  generate-test-sdk:
+    uses: ./.github/workflows/generator-test-sdk.yaml
+    secrets: inherit
+    with:
+      version: ${{ inputs.sdk_version }}
+      namespace: ${{ inputs.sdk_namespace }}
+      product_repo: ${{ inputs.product_repo }}
+      transformations: ${{ inputs.transformations }}
+
+  run-rapid-examples:
+    strategy:
+      matrix:
+        jdk: [8, 11, 17, 21]
+    if: inputs.sdk_namespace == 'rapid'
+    needs: [ generate-test-sdk ]
+    uses: "ExpediaGroup/rapid-java-sdk/.github/workflows/run-examples.yaml@main"
+    with:
+      sdk_version: ${{ needs.generate-test-sdk.outputs.version }}
+      jdk: ${{ matrix.jdk }}
+      source: 'specs'
+
+    secrets:
+      KEY: ${{ secrets.RAPID_KEY }}
+      SECRET: ${{ secrets.RAPID_SECRET }}
+
+  generate-contract-tests:
+    needs: [ 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-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/resources/templates/expediagroup-sdk/operation_params.mustache

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

sdk-test/src/main/kotlin/com/expediagroup/sdk/test/CLI.kt

@@ -27,6 +27,7 @@ package com.expediagroup.sdk.test
 
 import com.expediagroup.sdk.test.contract.ContractTestsGenerator
 import com.expediagroup.sdk.test.contract.MAX_TEST_REQUEST_PER_SCENARIO
+import com.expediagroup.sdk.test.openapi.ArtifactMetadata
 import com.expediagroup.sdk.test.openapi.SdkTestGenerator
 import com.expediagroup.sdk.test.openapi.ProductTest
 import com.github.rvesse.airline.SingleCommand
@@ -54,6 +55,15 @@ class CLI {
     @Option(name = ["-t", "--templates-dir"])
     private var templatesDir: File = File("src/main/resources/templates/expediagroup-sdk")
 
+    @Option(name=["-tg", "--target-group"])
+    private lateinit var targetGroup: String
+
+    @Option(name = ["-ta", "--target-artifact"])
+    private lateinit var targetArtifact: String
+
+    @Option(name = ["-tv", "--target-version"])
+    private lateinit var targetVersion: String
+
     private lateinit var sdkTestGenerator: SdkTestGenerator
 
     private lateinit var contractTestsGenerator: ContractTestsGenerator
@@ -81,6 +91,11 @@ class CLI {
         val sdkTestsOutputDirectory = File(outputDir, productTest.artifactId)
 
         val contractTestsOutputDirectory = File("target/sdk/${productTest.artifactId}/src/main/", "resources/contract-tests/").also { it.mkdirs() }
+        val artifact = ArtifactMetadata(
+            artifactId = targetArtifact,
+            version = targetVersion,
+            groupId = targetGroup,
+        )
 
         contractTestsGenerator = ContractTestsGenerator(
             spec = spec,
@@ -96,6 +111,7 @@ class CLI {
             productTest = productTest,
             templatesDir = templatesDir,
             outputDir = sdkTestsOutputDirectory,
+            targetArtifact = artifact,
         ).also { it.generate() }
     }
 }

sdk-test/src/main/kotlin/com/expediagroup/sdk/test/openapi/ArtifactMetadata.kt

@@ -0,0 +1,7 @@
+package com.expediagroup.sdk.test.openapi
+
+data class ArtifactMetadata(
+    val artifactId: String,
+    val groupId: String,
+    val version: String,
+)

sdk-test/src/main/kotlin/com/expediagroup/sdk/test/openapi/SdkTestGenerator.kt

@@ -45,6 +45,7 @@ import java.io.File
 class SdkTestGenerator(
     private val productTest: ProductTest,
     private val spec: File,
+    private val targetArtifact: ArtifactMetadata,
     private val version: String = "1.0.0",
     private val templatesDir: File = File("src/main/resources/templates/expediagroup-sdk"),
     private val outputDir: File = File("target/sdk")
@@ -86,6 +87,10 @@ class SdkTestGenerator(
             addAdditionalProperty("namespace", productTest.namespace)
             addAdditionalProperty("clientClassname", productTest.namespace.pascalCase())
 
+            addAdditionalProperty("targetSdkArtifactId", targetArtifact.artifactId)
+            addAdditionalProperty("targetSdkGroupId", targetArtifact.groupId)
+            addAdditionalProperty("targetSdkVersion", targetArtifact.version)
+
             // Mustache Helpers
             mustacheHelpers.forEach { (name, func) ->
                 addAdditionalProperty(name, func)