Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Miscellaneous fixes #1306

Merged
merged 4 commits into from
Sep 17, 2024
Merged

Miscellaneous fixes #1306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
05d3af2
Added `--debug` support to all the `examples` commands
joelrosario Sep 16, 2024
e44f075
Fixed issue where allOfs were not getting stored in the patterns dict…
joelrosario Sep 16, 2024
5ce0142
Updated the error message shown when an examples working directory is…
joelrosario Sep 16, 2024
7b4f79b
Merge branch 'main' into fixes
joelrosario Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 86 additions & 32 deletions application/src/main/kotlin/application/ExamplesCommand.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,55 +1,82 @@
package application

import io.specmatic.core.examples.server.ExamplesInteractiveServer
import io.specmatic.core.log.StringLog
import io.specmatic.core.log.consoleLog
import io.specmatic.core.log.logger
import io.specmatic.core.log.*
import io.specmatic.core.utilities.exceptionCauseMessage
import io.specmatic.core.utilities.exitWithMessage
import io.specmatic.mock.NoMatchingScenario
import net.bytebuddy.implementation.bytecode.Throw
import picocli.CommandLine.*
import java.io.File
import java.lang.Thread.sleep
import java.util.concurrent.Callable
import kotlin.system.exitProcess

@Command(name = "examples",
mixinStandardHelpOptions = true,
description = ["Generate externalised JSON example files with API requests and responses"],
subcommands = [ExamplesCommand.Validate::class, ExamplesCommand.Interactive::class]
@Command(
name = "examples",
mixinStandardHelpOptions = true,
description = ["Generate externalised JSON example files with API requests and responses"],
subcommands = [ExamplesCommand.Validate::class, ExamplesCommand.Interactive::class]
)
class ExamplesCommand : Callable<Unit> {

@Option(names = ["--filter-name"], description = ["Use only APIs with this value in their name"], defaultValue = "\${env:SPECMATIC_FILTER_NAME}")
@Option(
names = ["--filter-name"],
description = ["Use only APIs with this value in their name"],
defaultValue = "\${env:SPECMATIC_FILTER_NAME}"
)
var filterName: String = ""

@Option(names = ["--filter-not-name"], description = ["Use only APIs which do not have this value in their name"], defaultValue = "\${env:SPECMATIC_FILTER_NOT_NAME}")
@Option(
names = ["--filter-not-name"],
description = ["Use only APIs which do not have this value in their name"],
defaultValue = "\${env:SPECMATIC_FILTER_NOT_NAME}"
)
var filterNotName: String = ""

@Option(names = ["--extensive"], description = ["Generate all examples (by default, generates one example per 2xx API)"], defaultValue = "false")
@Option(
names = ["--extensive"],
description = ["Generate all examples (by default, generates one example per 2xx API)"],
defaultValue = "false"
)
var extensive: Boolean = false

@Option(names = ["--overwrite"], description = ["Overwrite the examples directory if it exists"], defaultValue = "false")
@Option(
names = ["--overwrite"],
description = ["Overwrite the examples directory if it exists"],
defaultValue = "false"
)
var overwrite: Boolean = false

@Parameters(index = "0", description = ["Contract file path"], arity = "0..1")
var contractFile: File? = null

@Option(names = ["--debug"], description = ["Debug logs"])
var verbose = false

override fun call() {
if(contractFile == null) {
if (contractFile == null) {
println("No contract file provided. Use a subcommand or provide a contract file. Use --help for more details.")
return
}
if (!contractFile!!.exists())
exitWithMessage("Could not find file ${contractFile!!.path}")

configureLogger(this.verbose)

try {
ExamplesInteractiveServer.generate(contractFile!!, ExamplesInteractiveServer.ScenarioFilter(filterName, filterNotName), extensive, overwrite)
} catch (e: Exception) {
exitWithMessage("An unexpected error occurred while generating examples: ${e.message}")
ExamplesInteractiveServer.generate(
contractFile!!,
ExamplesInteractiveServer.ScenarioFilter(filterName, filterNotName),
extensive,
overwrite
)
} catch (e: Throwable) {
logger.log(e)
exitProcess(1)
}
}


@Command(
name = "validate",
mixinStandardHelpOptions = true,
Expand All @@ -62,10 +89,15 @@ class ExamplesCommand : Callable<Unit> {
@Option(names = ["--example-file"], description = ["Example file path"], required = false)
val exampleFile: File? = null

@Option(names = ["--debug"], description = ["Debug logs"])
var verbose = false

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

configureLogger(this.verbose)

if (exampleFile != null) {
try {
ExamplesInteractiveServer.validate(contractFile, exampleFile)
Expand All @@ -78,7 +110,7 @@ class ExamplesCommand : Callable<Unit> {
} else {
val result = ExamplesInteractiveServer.validate(contractFile)

if(result.isSuccess() == false) {
if (result.isSuccess() == false) {
logger.log(result.reportString())
exitProcess(1)
}
Expand All @@ -95,28 +127,41 @@ class ExamplesCommand : Callable<Unit> {
@Option(names = ["--contract-file"], description = ["Contract file path"], required = false)
var contractFile: File? = null

@Option(names = ["--filter-name"], description = ["Use only APIs with this value in their name"], defaultValue = "\${env:SPECMATIC_FILTER_NAME}")
@Option(
names = ["--filter-name"],
description = ["Use only APIs with this value in their name"],
defaultValue = "\${env:SPECMATIC_FILTER_NAME}"
)
var filterName: String = ""

@Option(names = ["--filter-not-name"], description = ["Use only APIs which do not have this value in their name"], defaultValue = "\${env:SPECMATIC_FILTER_NOT_NAME}")
@Option(
names = ["--filter-not-name"],
description = ["Use only APIs which do not have this value in their name"],
defaultValue = "\${env:SPECMATIC_FILTER_NOT_NAME}"
)
var filterNotName: String = ""

@Option(names = ["--debug"], description = ["Debug logs"])
var verbose = false

var server: ExamplesInteractiveServer? = null

override fun call() {
try {
if (contractFile != null && !contractFile!!.exists())
exitWithMessage("Could not find file ${contractFile!!.path}")

server = ExamplesInteractiveServer("0.0.0.0", 9001, contractFile, filterName, filterNotName)
addShutdownHook()

consoleLog(StringLog("Examples Interactive server is running on http://0.0.0.0:9001/_specmatic/examples. Ctrl + C to stop."))
while(true) sleep(10000)
} catch(e: Exception) {
logger.log(exceptionCauseMessage(e))
exitWithMessage(e.message.orEmpty())
}
configureLogger(verbose)

try {
if (contractFile != null && !contractFile!!.exists())
exitWithMessage("Could not find file ${contractFile!!.path}")

server = ExamplesInteractiveServer("0.0.0.0", 9001, contractFile, filterName, filterNotName)
addShutdownHook()

consoleLog(StringLog("Examples Interactive server is running on http://0.0.0.0:9001/_specmatic/examples. Ctrl + C to stop."))
while (true) sleep(10000)
} catch (e: Exception) {
logger.log(exceptionCauseMessage(e))
exitWithMessage(e.message.orEmpty())
}
}

private fun addShutdownHook() {
Expand All @@ -135,3 +180,12 @@ class ExamplesCommand : Callable<Unit> {
}
}
}

private fun configureLogger(verbose: Boolean) {
val logPrinters = listOf(ConsolePrinter)

logger = if (verbose)
Verbose(CompositePrinter(logPrinters))
else
NonVerbose(CompositePrinter(logPrinters))
}
6 changes: 5 additions & 1 deletion core/src/main/kotlin/io/specmatic/conversions/OpenApiSpecification.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1266,7 +1266,7 @@ class OpenApiSpecification(
toJSONObjectPattern(properties, "(${componentName})")
}

if (oneOfs.size == 1)
val pattern = if (oneOfs.size == 1)
oneOfs.single()
else if (oneOfs.size > 1)
AnyPattern(oneOfs)
Expand All @@ -1276,6 +1276,10 @@ class OpenApiSpecification(
AnyPattern(schemaProperties.map { toJSONObjectPattern(it, "(${patternName})") })
else
toJSONObjectPattern(schemaProperties.single(), "(${patternName})")

cacheComponentPattern(patternName, pattern)

pattern
} else if (schema.oneOf != null) {
val candidatePatterns = schema.oneOf.filterNot { nullableEmptyObject(it) }.map { componentSchema ->
val (componentName, schemaToProcess) =
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/kotlin/io/specmatic/core/examples/server/ExamplesInteractiveServer.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ class ExamplesInteractiveServer(

if(examplesDir.exists() && overwriteByDefault.not()) {
val response: String = Scanner(System.`in`).use { scanner ->
print("Do you want to overwrite all the existing examples in ${examplesDir.name}? (y/n): ")
print("Found examples working directory at \"${examplesDir.path}\". Overwrite it? (y/n): ")
scanner.nextLine().trim().lowercase()
}
if(response == "y") {
Expand Down
2 changes: 1 addition & 1 deletion version.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
version=2.0.21
version=2.0.22