com.commercetools.rmf.validators.SdkBaseUriRule.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ctp-validators Show documentation

RAML API client code generators based on the REST Modeling Framework. https://github.com/vrapio/rest-modeling-framework

There is a newer version: 1.0.0-20241120142200

package com.commercetools.rmf.validators

import com.damnhandy.uri.template.UriTemplate
import io.vrap.rmf.raml.model.modules.Api
import io.vrap.rmf.raml.model.types.StringInstance
import org.eclipse.emf.common.util.Diagnostic
import java.util.*

@ValidatorSet
class SdkBaseUriRule (severity: RuleSeverity, options: List? = null) : ModulesRule(severity, options) {
    private val exclude: List =
        (options?.filter { ruleOption -> ruleOption.type.lowercase(Locale.getDefault()) == RuleOptionType.EXCLUDE.toString() }
            ?.map { ruleOption -> ruleOption.value }?.plus("") ?: defaultExcludes)

    override fun caseApi(api: Api): List {
        val validationResults: MutableList = ArrayList()

        if (api.baseUri == null) {
            validationResults.add(create(api,"baseUri must not be empty"))
        } else if (api.baseUri.value.variables.isNotEmpty()) {
            val sdkBaseUri = api.getAnnotation("sdkBaseUri")
            if (sdkBaseUri == null) {
                validationResults.add(create(api.baseUri,"sdkBaseUri must be declared as baseUri \"{0}\" contains baseUriParameters", api.baseUri.template))
            } else {
                val sdkBaseUriTemplate = UriTemplate.buildFromTemplate((sdkBaseUri.value as StringInstance).value).build()
                if (sdkBaseUriTemplate.variables.isNotEmpty()) {
                    validationResults.add(create(sdkBaseUri,"sdkBaseUri \"{0}\" must not contain uriParameters", sdkBaseUriTemplate.template))
                }
            }
        }
        return validationResults
    }

    companion object : ValidatorFactory {
        private val defaultExcludes by lazy { listOf("") }

        @JvmStatic
        override fun create(options: List?): SdkBaseUriRule {
            return SdkBaseUriRule(RuleSeverity.ERROR, options)
        }

        @JvmStatic
        override fun create(severity: RuleSeverity, options: List?): SdkBaseUriRule {
            return SdkBaseUriRule(severity, options)
        }
    }
}