Populate pull requests

.github/workflows/gradle.yml

@@ -8,6 +8,9 @@ on:
 permissions:
   contents: read
 
+concurrency:
+  group: ci-sdk-automation
+
 jobs:
   generate:
     strategy:
@@ -27,10 +30,13 @@ jobs:
         token: ${{ secrets.ADYEN_AUTOMATION_BOT_ACCESS_TOKEN }}
         repository: Adyen/adyen-${{ matrix.project }}-api-library
         path: ${{ matrix.project }}/repo
-    - name: Generate code for ${{ matrix.project }}
+    - name: Setup Gradle
       uses: gradle/gradle-build-action@bd5760595778326ba7f1441bcf7e88b49de61a25 # v2.6.0
-      with:
-        arguments: ${{ matrix.project }}:services
+    - name: Override properties
+      if: matrix.project == 'node'
+      run: cp ${{ matrix.project }}/gradle.properties buildSrc
+    - name: Generate code for ${{ matrix.project }}
+      run: ./gradlew ${{ matrix.project }}:services
     - name: Set PR variables
       id: vars
       run: |
@@ -48,3 +54,5 @@ jobs:
         branch: sdk-automation/models
         title: ${{ steps.vars.outputs.pr_title }}
         body: ${{ steps.vars.outputs.pr_body }}
+        commit-message: |
+          ${{ contains(fromJSON('["go", "php", "node"]'), matrix.project) && '[reformat]' }}[adyen-sdk-automation] automated change

README.md

@@ -14,10 +14,28 @@ For a single specific service:
 ./gradlew php:checkout
 ```
 
-To clean up *most* (except for `repo` folders) of the generated artifacts:
+To clean up spec patches:
 
 ```
-./gradlew clean
+./gradlew cleanSpecs
+```
+
+To clean up all the generated artifacts and repository modifications:
+
+```
+./gradlew cleanRepo
+```
+
+Typical usage during development:
+
+```
+./gradlew :dotnet:cleanRepo :dotnet:checkout
+```
+
+For Node.js, set the generator version via CLI:
+
+```
+./gradlew :node:cleanRepo :node:checkout -PopenapiGeneratorVersion=5.4.0
 ```
 
 ### Development
@@ -29,4 +47,10 @@ For local testing of some library:
 
 ```shell
 rm -rf go/repo && ln -s ~/workspace/adyen-go-api-library go/repo
-```
+```
+
+To run unit tests:
+
+```
+./gradlew :buildSrc:test
+```

build.gradle

@@ -3,9 +3,10 @@ import groovy.json.JsonSlurper
 
 def uri = "https://github.com/Adyen/adyen-openapi.git"
 def specsDir = "$projectDir/schema"
-def checkoutDir = "$projectDir/schema/json/CheckoutService-v70.json"
+def checkoutDir = "$projectDir/schema/json/CheckoutService-v71.json"
 
 tasks.register('specs', Exec) {
+    group 'setup'
     description 'Clone OpenAPI spec (and apply local patches).'
     commandLine 'git', 'clone', '--depth', '1', uri, specsDir
     outputs.dir specsDir
@@ -36,6 +37,7 @@ tasks.register('specs', Exec) {
 }
 
 tasks.register('pmTable', Task) {
+    group 'specs'
     description 'Generate Checkout Payment Method Table'
     dependsOn('specs')
     onlyIf { file(checkoutDir).exists() }
@@ -75,6 +77,8 @@ tasks.register('pmTable', Task) {
     }
 }
 
-tasks.register('clean', Delete) {
+tasks.register('cleanSpecs', Delete) {
+    group 'clean'
+    description 'Delete OpenAPI specifications'
     delete specsDir
 }

buildSrc/build.gradle

@@ -1,25 +1,15 @@
-buildscript {
-    repositories {
-        mavenLocal()
-        mavenCentral()
-        // or, via Gradle Plugin Portal:
-        // url "https://plugins.gradle.org/m2/"
-    }
-    dependencies {
-        classpath "org.openapitools:openapi-generator-gradle-plugin:6.0.1"
-    }
-}
-
 plugins {
     // Support convention plugins written in Groovy. Convention plugins are build scripts in 'src/main' that automatically become available as plugins in the main build.
     id 'groovy-gradle-plugin'
 }
 
 repositories {
+    mavenCentral()
     // Use the plugin portal to apply community plugins in convention plugins.
     gradlePluginPortal()
 }
 
 dependencies {
-    implementation "org.openapitools:openapi-generator-gradle-plugin:6.0.1"
+    implementation "org.openapitools:openapi-generator-gradle-plugin:${openapiGeneratorVersion}"
+    testImplementation 'junit:junit:4.13'
 }

buildSrc/gradle.properties

@@ -0,0 +1 @@
+openapiGeneratorVersion=6.0.1

buildSrc/src/main/groovy/adyen.sdk-automation-conventions.gradle

@@ -1,67 +1,77 @@
+plugins {
+    id 'org.openapi.generator'
+}
+
+import com.adyen.sdk.Service
+import groovy.json.JsonOutput
+import groovy.json.JsonSlurper
 import org.openapitools.generator.gradle.plugin.tasks.GenerateTask
 
 repositories {
     // Use Maven Central for resolving dependencies.
     mavenCentral()
 }
 
+List<Service> services = [
+        // Payments
+        new Service(name: 'Checkout', version: 71),
+        new Service(name: 'Payout', version: 68),
+        new Service(name: 'Recurring', version: 68, small: true),
+        new Service(name: 'BinLookup', version: 54, small: true),
+        // Point of Sale
+        new Service(name: 'PosTerminalManagement', spec: 'TfmAPIService', version: 1, small: true),
+        // Management
+        new Service(name: 'Management', version: 3),
+        new Service(name: 'BalanceControl', version: 1, small: true),
+        // Adyen for Platforms
+        new Service(name: 'LegalEntityManagement', spec: 'LegalEntityService', version: 3),
+        new Service(name: 'BalancePlatform', version: 2),
+        new Service(name: 'Transfers', spec: 'TransferService', version: 4),
+        new Service(name: 'DataProtection', version: 1, small: true),
+        // Classic Payments
+        new Service(name: 'Payment', version: 68, small: true),
+        // Others
+        new Service(name: 'StoredValue', version: 46, small: true),
+        new Service(name: 'Disputes', spec: 'DisputeService', version: 30, small: true),
+        // Webhooks
+        new Service(name: 'ConfigurationWebhooks', spec: 'BalancePlatformConfigurationNotification', version: 1),
+        new Service(name: 'AcsWebhooks', spec: 'BalancePlatformAcsNotification', version: 1),
+        new Service(name: 'ReportWebhooks', spec: 'BalancePlatformReportNotification', version: 1),
+        new Service(name: 'TransferWebhooks', spec: 'BalancePlatformTransferNotification', version: 4),
+        new Service(name: 'TransactionWebhooks', spec: 'BalancePlatformTransactionNotification', version: 4),
+        new Service(name: 'ManagementWebhooks', spec: 'ManagementNotificationService', version: 3),
+]
+
 ext {
     generator = project.name
     templates = 'templates'
-    services = [
-            // Payments
-            new Service(name: 'Checkout', version: 71),
-            new Service(name: 'Payout', version: 68),
-            new Service(name: 'Recurring', version: 68),
-            new Service(name: 'BinLookup', version: 54),
-            // Point of Sale
-            new Service(name: 'POSTerminalManagement', spec: 'TfmAPIService', version: 1),
-            // Management
-            new Service(name: 'Management', version: 3),
-            new Service(name: 'BalanceControl', version: 1),
-            // Adyen for Platforms
-            new Service(name: 'LegalEntityManagement', spec: 'LegalEntityService', version: 3),
-            new Service(name: 'BalancePlatform', version: 2),
-            new Service(name: 'Transfers', spec: 'TransferService', version: 4),
-            new Service(name: 'DataProtection', version: 1),
-            // Classic Payments
-            new Service(name: 'Payment', version: 68),
-            // Others
-            new Service(name: 'StoredValue', version: 46),
-            // Webhooks
-            new Service(name: 'ConfigurationWebhook', spec: 'BalancePlatformConfigurationNotification', version: 1),
-            new Service(name: 'ACSWebhook', spec: 'BalancePlatformAcsNotification', version: 1),
-            new Service(name: 'ReportWebhook', spec: 'BalancePlatformReportNotification', version: 1),
-            new Service(name: 'TransferWebhook', spec: 'BalancePlatformTransferNotification', version: 4),
-            new Service(name: 'TransactionWebhook', spec: 'BalancePlatformTransactionNotification', version: 4),
-            new Service(name: 'ManagementWebhook', spec: 'ManagementNotificationService', version: 3),
-    ]
     serviceName = ''
-}
-
-class Service {
-    String name, spec
-    int version
-
-    String getSpec() { spec ?: "${name}Service" }
-
-    String getId() { name.toLowerCase() }
+    removeTags = true
+    setProperty('services', services)
+    smallServices = services.findAll { it.small }
+    serviceNaming = services.collectEntries { [it.id, it.name] }
+    serviceNamingCamel = services.collectEntries {
+        [it.id, it.name.substring(0, 1).toLowerCase() + it.name.substring(1)]
+    }
 }
 
 // Generate a full client for each service
-project.ext.services.each { Service svc ->
+services.each { Service svc ->
     def generate = tasks.register("generate$svc.name", GenerateTask) {
+        group 'generate'
         description "Generate a $project.name client for $svc.name."
-        dependsOn 'clone'
+        dependsOn 'cloneRepo'
         dependsOn ':specs'
 
         // Current service being processed
+        ext.serviceId = svc.id
         project.ext.serviceName = svc.name
 
         generatorName.set(project.ext.generator as String)
-        inputSpec.set("$rootDir/schema/json/${svc.spec}-v${svc.version}.json")
+        inputSpec.set("$rootDir/schema/json/${svc.filename}")
         outputDir.set("$buildDir/services/${svc.id}")
         templateDir.set("$projectDir/repo/$project.ext.templates")
+        engine.set('mustache')
         validateSpec.set(false)
         skipValidateSpec.set(true)
         reservedWordsMappings.set([
@@ -70,31 +80,41 @@ project.ext.services.each { Service svc ->
         additionalProperties.set([
                 'serviceName': project.ext.serviceName,
         ])
+        globalProperties.set([
+                'modelDocs' : 'false',
+                'modelTests': 'false'
+        ])
 
         if (project.ext.has('configFile')) {
             configFile.set("$projectDir/repo/$project.ext.configFile")
         }
     }
 
     tasks.register(svc.id) {
+        group 'service'
         description "Base task for $svc.name."
         dependsOn generate
     }
 }
 
 tasks.register('services') {
     description 'Generate code for multiple services.'
-    dependsOn project.ext.services.collect { it.id }
+    dependsOn services.collect { it.id }
 }
 
 tasks.named('generateCheckout', GenerateTask) {
+    if (project.name == 'node') {
+        // generator v5 does not support inlineSchemaNameMappings
+        return
+    }
     inlineSchemaNameMappings.set([
             'PaymentRequest_paymentMethod'        : 'CheckoutPaymentMethod',
             'DonationPaymentRequest_paymentMethod': 'DonationPaymentMethod',
     ])
 }
 
-tasks.register('clone', Exec) {
+tasks.register('cloneRepo', Exec) {
+    group 'setup'
     def uri = "https://github.com/Adyen/adyen-$project.name-api-library.git"
     def dest = 'repo'
     description "Clone this project's repository."
@@ -109,13 +129,51 @@ tasks.withType(GenerateTask).configureEach {
     outputs.cacheIf { false }
 }
 
-tasks.register('clean', Delete) {
-    delete buildDir
+tasks.register('cleanRepo', Delete) {
+    group 'clean'
+    description 'Clean this project state'
+    delete layout.buildDirectory
+    doLast {
+        exec {
+            // cleanTracked: discard changes to existing files
+            commandLine 'git', 'checkout', '.'
+            workingDir 'repo'
+        }
+        exec {
+            // cleanUntracked: discard unknown files
+            commandLine 'git', 'clean', '-f', '-d'
+            workingDir 'repo'
+        }
+    }
 }
 
 tasks.register('addPMTable', Copy) {
-    dependsOn("clone")
+    dependsOn("cloneRepo")
     dependsOn(":pmTable")
     from(rootProject.file('PaymentMethodOverview.md'))
     into layout.projectDirectory.dir("repo")
-}
+}
+
+project.ext.smallServices.each { Service svc ->
+    def ungroup = tasks.register("ungroup${svc.name}") {
+        group 'specs'
+        description "Remove tags from ${svc.name}"
+        dependsOn ':specs'
+        // The `removeTags` setting only works in isolation (e.g. CI). Locally, specs are shared between all projects.
+        onlyIf { project.ext.removeTags }
+        doLast {
+            def specFile = file("$rootDir/schema/json/${svc.filename}")
+            def json = new JsonSlurper().parse(specFile)
+
+            json["paths"].each { Map.Entry endpoint ->
+                endpoint.value.each { Map.Entry httpMethod ->
+                    httpMethod.value.remove('tags')
+                }
+            }
+
+            specFile.text = JsonOutput.prettyPrint(JsonOutput.toJson(json))
+        }
+    }
+
+    tasks.named("generate$svc.name") { dependsOn ungroup }
+}

buildSrc/src/main/groovy/com/adyen/sdk/Service.groovy

@@ -0,0 +1,15 @@
+package com.adyen.sdk
+
+class Service {
+    String name, spec
+    int version
+    boolean small
+
+    String getId() { name.toLowerCase() }
+
+    String getSpec() { spec ?: "${name}Service" }
+
+    String getFilename() { "${getSpec()}-v${version}.json" }
+
+    boolean isWebhook() { name.endsWith('Webhooks') }
+}