application.ExamplesCommand.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of specmatic-executable Show documentation

Command-line standalone executable jar for Specmatic

There is a newer version: 1.3.39

package application

import `in`.specmatic.core.*
import `in`.specmatic.core.log.*
import `in`.specmatic.core.value.Value
import `in`.specmatic.mock.ScenarioStub
import picocli.CommandLine.*
import `in`.specmatic.stub.HttpStub
import `in`.specmatic.test.TestExecutor
import java.io.File
import java.util.concurrent.Callable

@Command(name = "examples",
        mixinStandardHelpOptions = true,
        description = ["Generate externalised JSON example files with API requests and responses"])
class ExamplesCommand : Callable {
    @Parameters(index = "0", description = ["Contract file path"])
    lateinit var contractFile: File

    override fun call() {
        logException {
            if(!contractFile.exists())
                throw Exception("Could not find file ${contractFile.path}")

            try {
                val feature = parseContractFileToFeature(contractFile)

                var ctr = 0

                val examplesDir = contractFile.canonicalFile.parentFile.resolve("""${contractFile.nameWithoutExtension}_data""")
                examplesDir.mkdirs()

                feature.executeTests(object : TestExecutor {
                    override fun execute(request: HttpRequest): HttpResponse {
                        ctr += 1

                        val response = feature.lookupResponse(request).cleanup()

                        val stubJSON = ScenarioStub(request, response).toJSON()

                        val stubString = stubJSON.toStringLiteral()

                        val filename = "example-$ctr.json"

                        val file = examplesDir.resolve(filename)
                        val loggablePath = "Writing to file: ${file.relativeTo(contractFile.canonicalFile.parentFile).path}"

                        println(loggablePath)

                        file.writeText(stubString)

                        return response
                    }

                    override fun setServerState(serverState: Map) {
                    }
                })
            } catch(e: StackOverflowError) {
                logger.log("Got a stack overflow error. You probably have a recursive data structure definition in the contract.")
            }
        }
    }
}

private fun HttpResponse.cleanup(): HttpResponse {
    return this.copy(headers = this.headers.minus(SPECMATIC_RESULT_HEADER))
}