com.commercetools.rmf.validators.SuccessBodyRule.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 io.vrap.rmf.raml.model.resources.Method
import io.vrap.rmf.raml.model.resources.Resource
import org.eclipse.emf.common.util.Diagnostic
import java.util.*

@ValidatorSet
class SuccessBodyRule(severity: RuleSeverity, options: List? = null) : ResourcesRule(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 caseMethod(method: Method): List {
        val validationResults: MutableList = ArrayList()
        val successResponses = method.responses.filter { response -> response.statusCode.toInt() >= 200 && response.statusCode.toInt() < 300 }
        if (!successResponses.all { response -> response.bodies.all { body -> body.type != null } } && exclude.contains("${method.method.name} ${(method.eContainer() as Resource).fullUri.template}").not()) {
            validationResults.add(create(method, "Method \"{0} {1}\" must have body type for success response(s) defined", method.method.name, (method.eContainer() as Resource).fullUri.template))
        }
        return validationResults
    }

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

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

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