From 604c42552a146bb0e830ba40861edec012d4c3e1 Mon Sep 17 00:00:00 2001 From: Pavel Bodiachevskii Date: Thu, 29 Feb 2024 01:56:39 +0400 Subject: [PATCH] test(2.6.0): check correctness of realisation by reading AsyncAPI example - Streetlights MQTT API example https://github.com/asyncapi/jasyncapi/issues/165 --- .../examples/v2/_6_0/StreetlightsMQTT.kt | 314 ++++++++++++++++++ .../examples/v2.6.0/streetlights-mqtt.yml | 216 ++++++++++++ 2 files changed, 530 insertions(+) create mode 100644 asyncapi-core/src/test/kotlin/com/asyncapi/examples/v2/_6_0/StreetlightsMQTT.kt create mode 100644 asyncapi-core/src/test/resources/examples/v2.6.0/streetlights-mqtt.yml diff --git a/asyncapi-core/src/test/kotlin/com/asyncapi/examples/v2/_6_0/StreetlightsMQTT.kt b/asyncapi-core/src/test/kotlin/com/asyncapi/examples/v2/_6_0/StreetlightsMQTT.kt new file mode 100644 index 00000000..44b393b0 --- /dev/null +++ b/asyncapi-core/src/test/kotlin/com/asyncapi/examples/v2/_6_0/StreetlightsMQTT.kt @@ -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 { + 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 { + 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() + } + +} \ No newline at end of file diff --git a/asyncapi-core/src/test/resources/examples/v2.6.0/streetlights-mqtt.yml b/asyncapi-core/src/test/resources/examples/v2.6.0/streetlights-mqtt.yml new file mode 100644 index 00000000..b9025981 --- /dev/null +++ b/asyncapi-core/src/test/resources/examples/v2.6.0/streetlights-mqtt.yml @@ -0,0 +1,216 @@ +asyncapi: "2.6.0" +info: + title: Streetlights MQTT API + version: '1.0.0' + description: | + The Smartylighting Streetlights API allows you to remotely manage the city lights. + + ### Check out its awesome features: + + * Turn a specific streetlight on/off 🌃 + * Dim a specific streetlight 😎 + * Receive real-time information about environmental lighting conditions 📈 + license: + name: Apache 2.0 + url: https://www.apache.org/licenses/LICENSE-2.0 + +servers: + production: + url: test.mosquitto.org:{port} + protocol: mqtt + description: Test broker + variables: + port: + description: Secure connection (TLS) is available through port 8883. + default: '1883' + enum: + - '1883' + - '8883' + security: + - apiKey: [] + - supportedOauthFlows: + - streetlights:on + - streetlights:off + - streetlights:dim + - openIdConnectWellKnown: [] + tags: + - name: "env:production" + description: "This environment is meant for production use case" + - name: "kind:remote" + description: "This server is a remote server. Not exposed by the application" + - name: "visibility:public" + description: "This resource is public and available to everyone" + +defaultContentType: application/json + +channels: + smartylighting/streetlights/1/0/event/{streetlightId}/lighting/measured: + description: The topic on which measured values may be produced and consumed. + parameters: + streetlightId: + $ref: '#/components/parameters/streetlightId' + publish: + summary: Inform about environmental lighting conditions of a particular streetlight. + operationId: receiveLightMeasurement + traits: + - $ref: '#/components/operationTraits/mqtt' + message: + $ref: '#/components/messages/lightMeasured' + + smartylighting/streetlights/1/0/action/{streetlightId}/turn/on: + parameters: + streetlightId: + $ref: '#/components/parameters/streetlightId' + subscribe: + operationId: turnOn + traits: + - $ref: '#/components/operationTraits/mqtt' + message: + $ref: '#/components/messages/turnOnOff' + + smartylighting/streetlights/1/0/action/{streetlightId}/turn/off: + parameters: + streetlightId: + $ref: '#/components/parameters/streetlightId' + subscribe: + operationId: turnOff + traits: + - $ref: '#/components/operationTraits/mqtt' + message: + $ref: '#/components/messages/turnOnOff' + + smartylighting/streetlights/1/0/action/{streetlightId}/dim: + parameters: + streetlightId: + $ref: '#/components/parameters/streetlightId' + subscribe: + operationId: dimLight + traits: + - $ref: '#/components/operationTraits/mqtt' + message: + $ref: '#/components/messages/dimLight' + +components: + messages: + lightMeasured: + name: lightMeasured + title: Light measured + summary: Inform about environmental lighting conditions of a particular streetlight. + contentType: application/json + traits: + - $ref: '#/components/messageTraits/commonHeaders' + payload: + $ref: "#/components/schemas/lightMeasuredPayload" + turnOnOff: + name: turnOnOff + title: Turn on/off + summary: Command a particular streetlight to turn the lights on or off. + traits: + - $ref: '#/components/messageTraits/commonHeaders' + payload: + $ref: "#/components/schemas/turnOnOffPayload" + dimLight: + name: dimLight + title: Dim light + summary: Command a particular streetlight to dim the lights. + traits: + - $ref: '#/components/messageTraits/commonHeaders' + payload: + $ref: "#/components/schemas/dimLightPayload" + + schemas: + lightMeasuredPayload: + type: object + properties: + lumens: + type: integer + minimum: 0 + description: Light intensity measured in lumens. + sentAt: + $ref: "#/components/schemas/sentAt" + turnOnOffPayload: + type: object + properties: + command: + type: string + enum: + - 'on' + - 'off' + description: Whether to turn on or off the light. + sentAt: + $ref: "#/components/schemas/sentAt" + dimLightPayload: + type: object + properties: + percentage: + type: integer + description: Percentage to which the light should be dimmed to. + minimum: 0 + maximum: 100 + sentAt: + $ref: "#/components/schemas/sentAt" + sentAt: + type: string + format: date-time + description: Date and time when the message was sent. + + securitySchemes: + apiKey: + type: apiKey + in: user + description: Provide your API key as the user and leave the password empty. + supportedOauthFlows: + type: oauth2 + description: Flows to support OAuth 2.0 + flows: + implicit: + authorizationUrl: 'https://authserver.example/auth' + scopes: + 'streetlights:on': Ability to switch lights on + 'streetlights:off': Ability to switch lights off + 'streetlights:dim': Ability to dim the lights + password: + tokenUrl: 'https://authserver.example/token' + scopes: + 'streetlights:on': Ability to switch lights on + 'streetlights:off': Ability to switch lights off + 'streetlights:dim': Ability to dim the lights + clientCredentials: + tokenUrl: 'https://authserver.example/token' + scopes: + 'streetlights:on': Ability to switch lights on + 'streetlights:off': Ability to switch lights off + 'streetlights:dim': Ability to dim the lights + authorizationCode: + authorizationUrl: 'https://authserver.example/auth' + tokenUrl: 'https://authserver.example/token' + refreshUrl: 'https://authserver.example/refresh' + scopes: + 'streetlights:on': Ability to switch lights on + 'streetlights:off': Ability to switch lights off + 'streetlights:dim': Ability to dim the lights + openIdConnectWellKnown: + type: openIdConnect + openIdConnectUrl: 'https://authserver.example/.well-known' + + parameters: + streetlightId: + description: The ID of the streetlight. + schema: + type: string + + messageTraits: + commonHeaders: + headers: + type: object + properties: + my-app-header: + type: integer + minimum: 0 + maximum: 100 + + operationTraits: + mqtt: + bindings: + mqtt: + qos: 1 \ No newline at end of file