Migrate legacy plugins to PDK

/tmp pdk generate workspace
WARN: Congrats, you are the plugin developer. Fasten the seat belts, I'll show you how deep the rabbit hole goes.
INFO: Writing log to the file /Users/imago/.flowpdf/pdk.log
WARN: You are using EDGE version of flowpdf-cli
INFO: Plugin name is not provided
Please provide a name for the new plugin, e.g. MyPlugin: EC-CloudFoundry
Please provide a workspace type or types.
Available types are rest, reporting or default (default: 'default', separated by a comma or a space):
Please provide the author name (default: none):
Please provide the support URL (default: none):
Please provide the plugin category (default: Utilities):
Please provide the description for the plugin:
Please provide the language for the plugin (default: groovy, available languages are perl, groovy):
WARN: Language  is not supported, Groovy will be used by default
INFO: Wrote initial declaration to /private/tmp/EC-CloudFoundry/config/pluginspec.yaml
INFO: Plugin folder is /private/tmp/EC-CloudFoundry
INFO: Wrote flowpdf specification into /private/tmp/EC-CloudFoundry/config/flowpdf.yaml
INFO: Initial plugin spec has been placed into /private/tmp/EC-CloudFoundry/config/pluginspec.yaml
INFO: Go into the plugin directory: 'cd /private/tmp/EC-CloudFoundry'
INFO: Change the plugin spec and run 'pdk generate plugin' from the plugin directory
INFO: Command took 16443 ms to execute
▼

    def unmapRoute(StepParameters p, StepResult sr) {
        // Use this parameters wrapper for convenient access to your parameters
        UnmapRouteParameters sp = UnmapRouteParameters.initParameters(p)

        // Calling logger:
        log.info p.asMap.get('config')
        log.info p.asMap.get('space')
        log.info p.asMap.get('applicationName')
        log.info p.asMap.get('domain')
        log.info p.asMap.get('hostname')
        log.info p.asMap.get('path')
        log.info p.asMap.get('port')


        // Setting job step summary to the config name
        sr.setJobStepSummary(p.getParameter('config')?.getValue() ?: 'null')

        sr.setReportUrl("Sample Report", 'https://cloudbees.com')
        sr.apply()
        log.info("step Unmap Route has been finished")
    }
▼

import com.cloudbees.flowpdf.*

/**
* CloudFoundry
*/
class CloudFoundry extends FlowPlugin {

    @Override
    Map<String, Object> pluginInfo() {
        return [
            pluginName         : '@PLUGIN_KEY@',
            pluginVersion      : '@PLUGIN_VERSION@',
            configFields       : ['config'],
            configLocations    : ['ec_plugin_cfgs'],
            defaultConfigValues: [:]
        ]
    }

    /** This is a special method for checking connection during configuration creation
     */
    def checkConnection(StepParameters p, StepResult sr) {
        // Use this pre-defined method to check connection parameters
        try {
            // Put some checks here
            def config = context.configValues
            log.info(config)
            // Getting parameters:
            // log.info config.asMap.get('config')
            // log.info config.asMap.get('desc')
            // log.info config.asMap.get('endpoint')
            // log.info config.asMap.get('credential')

            // assert config.getRequiredCredential("credential").secretValue == "secret"
        } catch (Throwable e) {
            // Set this property to show the error in the UI
            sr.setOutcomeProperty("/myJob/configError", e.message + System.lineSeparator() + "Please change the code of checkConnection method to incorporate your own connection checking logic")
            sr.apply()
            throw e
        }
    }

    // === check connection ends ===
    /**
     * unmapRoute - Unmap Route/Unmap Route
     * Add your code into this method and it will be called when the step runs
     * @param config (required: true)
     * @param space (required: true)
     * @param applicationName (required: true)
     * @param domain (required: true)
     * @param hostname (required: false)
     * @param path (required: false)
     * @param port (required: false)

     */
    def unmapRoute(StepParameters p, StepResult sr) {
        // Use this parameters wrapper for convenient access to your parameters
        UnmapRouteParameters sp = UnmapRouteParameters.initParameters(p)

        Map params = p.asMap
        params.space = context.configValues.getParameter('space').value
        cfClient.unmapRoute(params)
        sr.setJobStepSummary("The route has been unmapped")
        sr.apply()
    }

    @Lazy
    def cfClient = {
        new CFClient(
            endpoint: context.configValues.getParameter('endpoint').value,
            userName: context.configValues.getCredential('credential')?.userName,
            password: context.configValues.getCredential('credential').secretValue,
            space: context.configValues.getParameter('space')?.value,
            organization: context.configValues.getParameter('organization')?.value,
            logLevel: context.configValues.getParameter('debugLevel')?.value as int
        )
    }()

    // === step ends ===

}
▼