Skip to content

Commit

Permalink
test(2.6.0): check correctness of realisation by reading AsyncAPI exa…
Browse files Browse the repository at this point in the history 
…mple - Streetlights MQTT API example

asyncapi#165
  • Loading branch information
@Pakisan
Pakisan committed Feb 28, 2024
1 parent 6dc4ffe commit 604c425
Show file tree
Hide file tree
Showing 2 changed files with 530 additions and 0 deletions.
314 changes: 314 additions & 0 deletions asyncapi-core/src/test/kotlin/com/asyncapi/examples/v2/_6_0/StreetlightsMQTT.kt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,314 @@
package com.asyncapi.examples.v2._6_0

import com.asyncapi.v2.Reference
import com.asyncapi.v2._6_0.model.Tag
import com.asyncapi.v2._6_0.model.channel.ChannelItem
import com.asyncapi.v2._6_0.model.channel.Parameter
import com.asyncapi.v2._6_0.model.channel.message.Message
import com.asyncapi.v2._6_0.model.channel.message.MessageTrait
import com.asyncapi.v2._6_0.model.channel.operation.Operation
import com.asyncapi.v2._6_0.model.channel.operation.OperationTrait
import com.asyncapi.v2._6_0.model.component.Components
import com.asyncapi.v2._6_0.model.info.Info
import com.asyncapi.v2._6_0.model.info.License
import com.asyncapi.v2._6_0.model.server.Server
import com.asyncapi.v2._6_0.model.server.ServerVariable
import com.asyncapi.v2.binding.operation.mqtt.MQTTOperationBinding
import com.asyncapi.v2.schema.Schema
import com.asyncapi.v2.security_scheme.ApiKeySecurityScheme
import com.asyncapi.v2.security_scheme.OpenIdConnectSecurityScheme
import com.asyncapi.v2.security_scheme.oauth2.OAuth2SecurityScheme
import com.asyncapi.v2.security_scheme.oauth2.OAuthFlows
import com.asyncapi.v2.security_scheme.oauth2.flow.AuthorizationCodeOAuthFlow
import com.asyncapi.v2.security_scheme.oauth2.flow.ClientCredentialsOAuthFlow
import com.asyncapi.v2.security_scheme.oauth2.flow.ImplicitOAuthFlow
import com.asyncapi.v2.security_scheme.oauth2.flow.PasswordOAuthFlow
import java.math.BigDecimal

class StreetlightsMQTT: AbstractExampleValidationTest() {

override fun specificationLocation(): String = "/examples/v2.6.0/streetlights-mqtt.yml"

override fun expectedInfo(): Info {
return Info(
"Streetlights MQTT API",
"1.0.0",
"The Smartylighting Streetlights API allows you to remotely manage the city lights.\n\n" +
"### Check out its awesome features:\n\n" +
"* Turn a specific streetlight on/off \uD83C\uDF03\n" +
"* Dim a specific streetlight \uD83D\uDE0E\n" +
"* Receive real-time information about environmental lighting conditions \uD83D\uDCC8\n",
null,
null,
License("Apache 2.0", "https://www.apache.org/licenses/LICENSE-2.0")
)
}

override fun expectedDefaultContentType(): String = "application/json"

override fun expectedServers(): Map<String, Any> {
return mapOf(
Pair("production",
Server.builder()
.url("test.mosquitto.org:{port}")
.protocol("mqtt")
.description("Test broker")
.variables(mapOf(
Pair("port",
ServerVariable.builder()
.description("Secure connection (TLS) is available through port 8883.")
.defaultValue("1883")
.enumValues(listOf("1883", "8883"))
.build()
)
))
.security(listOf(
mapOf(Pair("apiKey", emptyList())),
mapOf(Pair("supportedOauthFlows", listOf(
"streetlights:on",
"streetlights:off",
"streetlights:dim",
))),
mapOf(Pair("openIdConnectWellKnown", emptyList())),
))
.tags(listOf(
Tag("env:production", "This environment is meant for production use case", null),
Tag("kind:remote", "This server is a remote server. Not exposed by the application", null),
Tag("visibility:public", "This resource is public and available to everyone", null)
))
.build()
)
)
}

override fun expectedChannels(): Map<String, Any> {
return mapOf(
Pair("smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured",
ChannelItem.builder()
.description("The topic on which measured values may be produced and consumed.")
.parameters(mapOf(Pair("streetlightId", Reference("#/components/parameters/streetlightId"))))
.publish(Operation.builder()
.operationId("receiveLightMeasurement")
.summary("Inform about environmental lighting conditions of a particular streetlight.")
.traits(listOf(Reference("#/components/operationTraits/mqtt")))
.message(Reference("#/components/messages/lightMeasured"))
.build())
.build()
),
Pair("smartylighting/streetlights/1/0/action/{streetlightId}/turn/on",
ChannelItem.builder()
.parameters(mapOf(Pair("streetlightId", Reference("#/components/parameters/streetlightId"))))
.subscribe(Operation.builder()
.operationId("turnOn")
.traits(listOf(Reference("#/components/operationTraits/mqtt")))
.message(Reference("#/components/messages/turnOnOff"))
.build())
.build()
),
Pair("smartylighting/streetlights/1/0/action/{streetlightId}/turn/off",
ChannelItem.builder()
.parameters(mapOf(Pair("streetlightId", Reference("#/components/parameters/streetlightId"))))
.subscribe(Operation.builder()
.operationId("turnOff")
.traits(listOf(Reference("#/components/operationTraits/mqtt")))
.message(Reference("#/components/messages/turnOnOff"))
.build())
.build()
),
Pair("smartylighting/streetlights/1/0/action/{streetlightId}/dim",
ChannelItem.builder()
.parameters(mapOf(Pair("streetlightId", Reference("#/components/parameters/streetlightId"))))
.subscribe(Operation.builder()
.operationId("dimLight")
.traits(listOf(Reference("#/components/operationTraits/mqtt")))
.message(Reference("#/components/messages/dimLight"))
.build())
.build()
)
)
}

override fun expectedComponents(): Components {
return Components.builder()
.messages(mapOf(
Pair("lightMeasured",
Message.builder()
.name("lightMeasured")
.title("Light measured")
.summary("Inform about environmental lighting conditions of a particular streetlight.")
.contentType("application/json")
.traits(listOf(Reference("#/components/messageTraits/commonHeaders")))
.payload(Schema.builder().ref("#/components/schemas/lightMeasuredPayload").build())
.build()
),
Pair("turnOnOff",
Message.builder()
.name("turnOnOff")
.title("Turn on/off")
.summary("Command a particular streetlight to turn the lights on or off.")
.traits(listOf(Reference("#/components/messageTraits/commonHeaders")))
.payload(Schema.builder().ref("#/components/schemas/turnOnOffPayload").build())
.build()
),
Pair("dimLight",
Message.builder()
.name("dimLight")
.title("Dim light")
.summary("Command a particular streetlight to dim the lights.")
.traits(listOf(Reference("#/components/messageTraits/commonHeaders")))
.payload(Schema.builder().ref("#/components/schemas/dimLightPayload").build())
.build()
)
))
.schemas(mapOf(
Pair("lightMeasuredPayload",
Schema.builder()
.type("object")
.properties(mapOf(
Pair("lumens",
Schema.builder()
.type("integer")
.minimum(BigDecimal.ZERO)
.description("Light intensity measured in lumens.")
.build()
),
Pair("sentAt",
Schema.builder().ref("#/components/schemas/sentAt").build()
)
))
.build()
),
Pair("turnOnOffPayload",
Schema.builder()
.type("object")
.properties(mapOf(
Pair("command",
Schema.builder()
.type("string")
.enumValue(listOf("on", "off"))
.description("Whether to turn on or off the light.")
.build()
),
Pair("sentAt",
Schema.builder().ref("#/components/schemas/sentAt").build()
)
))
.build()
),
Pair("dimLightPayload",
Schema.builder()
.type("object")
.properties(mapOf(
Pair("percentage",
Schema.builder()
.type("integer")
.minimum(BigDecimal.ZERO)
.maximum(BigDecimal.valueOf(100))
.description("Percentage to which the light should be dimmed to.")
.build()
),
Pair("sentAt",
Schema.builder().ref("#/components/schemas/sentAt").build()
)
))
.build()
),
Pair("sentAt",
Schema.builder()
.type("string")
.format("date-time")
.description("Date and time when the message was sent.")
.build()
)
))
.securitySchemes(mapOf(
Pair("apiKey",
ApiKeySecurityScheme("Provide your API key as the user and leave the password empty.", ApiKeySecurityScheme.ApiKeyLocation.USER)
),
Pair("supportedOauthFlows",
OAuth2SecurityScheme(
"Flows to support OAuth 2.0",
OAuthFlows(
ImplicitOAuthFlow(
"",
mapOf(
Pair("streetlights:on", "Ability to switch lights on"),
Pair("streetlights:off", "Ability to switch lights off"),
Pair("streetlights:dim", "Ability to dim the lights")
),
"https://authserver.example/auth"
),
PasswordOAuthFlow(
"",
mapOf(
Pair("streetlights:on", "Ability to switch lights on"),
Pair("streetlights:off", "Ability to switch lights off"),
Pair("streetlights:dim", "Ability to dim the lights")
),
"https://authserver.example/token"
),
ClientCredentialsOAuthFlow(
"",
mapOf(
Pair("streetlights:on", "Ability to switch lights on"),
Pair("streetlights:off", "Ability to switch lights off"),
Pair("streetlights:dim", "Ability to dim the lights")
),
"https://authserver.example/token"
),
AuthorizationCodeOAuthFlow(
"https://authserver.example/refresh",
mapOf(
Pair("streetlights:on", "Ability to switch lights on"),
Pair("streetlights:off", "Ability to switch lights off"),
Pair("streetlights:dim", "Ability to dim the lights")
),
"https://authserver.example/auth",
"https://authserver.example/token"
)
)
)
),
Pair("openIdConnectWellKnown", OpenIdConnectSecurityScheme(null, "https://authserver.example/.well-known"))
))
.parameters(mapOf(
Pair("streetlightId", Parameter.builder()
.description("The ID of the streetlight.")
.schema(Schema.builder().type("string").build())
.build()
)
))
.messageTraits(mapOf(
Pair("commonHeaders",
MessageTrait.builder()
.headers(Schema.builder()
.type("object")
.properties(mapOf(
Pair("my-app-header", Schema.builder()
.type("integer")
.minimum(BigDecimal.ZERO)
.maximum(BigDecimal.valueOf(100))
.build()
)
))
.build()
)
.build()
)
))
.operationTraits(mapOf(
Pair("mqtt",
OperationTrait.builder()
.bindings(mapOf(
Pair("mqtt", MQTTOperationBinding.builder()
.qos(1)
.build()
)
))
.build()
)
))
.build()
}

}
Loading

0 comments on commit 604c425

Please sign in to comment.