io.github.microcks.util.asyncapi.AsyncAPIImporter Maven / Gradle / Ivy
/*
* Licensed to Laurent Broudoux (the "Author") under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. Author licenses this
* file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package io.github.microcks.util.asyncapi;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.JsonNodeType;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import io.github.microcks.domain.*;
import io.github.microcks.util.DispatchStyles;
import io.github.microcks.util.MockRepositoryImportException;
import io.github.microcks.util.MockRepositoryImporter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.*;
import java.util.Map.Entry;
import java.util.stream.Collectors;
/**
* An implementation of MockReopsitoryImporter that deals with AsyncAPI v2.0.x specification
* file ; whether encoding into JSON or YAML documents.
* @author laurent
*/
public class AsyncAPIImporter implements MockRepositoryImporter {
/** A simple logger for diagnostic messages. */
private static Logger log = LoggerFactory.getLogger(AsyncAPIImporter.class);
private boolean isYaml = true;
private JsonNode spec;
private String specContent;
private static final List VALID_VERBS = Arrays.asList("subscribe", "publish");
/**
* Build a new importer.
* @param specificationFilePath The path to local AsyncAPI spec file
* @throws IOException if project file cannot be found or read.
*/
public AsyncAPIImporter(String specificationFilePath) throws IOException {
try {
// Analyse first lines of file content to guess repository type.
String line = null;
BufferedReader reader = Files.newBufferedReader(new File(specificationFilePath).toPath(), Charset.forName("UTF-8"));
while ((line = reader.readLine()) != null) {
line = line.trim();
// Check is we start with json object or array definition.
if (line.startsWith("{") || line.startsWith("[")) {
isYaml = false;
break;
}
else if (line.startsWith("---") || line.startsWith("asyncapi: ")) {
isYaml = true;
break;
}
}
reader.close();
// Read spec bytes.
byte[] bytes = Files.readAllBytes(Paths.get(specificationFilePath));
specContent = new String(bytes, Charset.forName("UTF-8"));
// Convert them to Node using Jackson object mapper.
ObjectMapper mapper = null;
if (isYaml) {
mapper = new ObjectMapper(new YAMLFactory());
} else {
mapper = new ObjectMapper();
}
spec = mapper.readTree(bytes);
} catch (Exception e) {
log.error("Exception while parsing AsyncAPI specification file " + specificationFilePath, e);
throw new IOException("AsyncAPI spec file parsing error");
}
}
@Override
public List getServiceDefinitions() throws MockRepositoryImportException {
List result = new ArrayList<>();
// Build a new service.
Service service = new Service();
service.setName(spec.path("info").path("title").asText());
service.setVersion(spec.path("info").path("version").asText());
service.setType(ServiceType.EVENT);
// Then build its operations.
service.setOperations(extractOperations());
result.add(service);
return result;
}
@Override
public List getResourceDefinitions(Service service) {
List results = new ArrayList<>();
// Build a suitable name.
String name = service.getName() + "-" + service.getVersion();
if (isYaml) {
name += ".yaml";
} else {
name += ".json";
}
// Build a brand new resource just with spec content.
Resource resource = new Resource();
resource.setName(name);
resource.setType(ResourceType.ASYNC_API_SPEC);
resource.setContent(specContent);
results.add(resource);
return results;
}
@Override
public List getMessageDefinitions(Service service, Operation operation) throws MockRepositoryImportException {
List result = new ArrayList<>();
// Retrieve default content type, defaulting to application/json.
String defaultContentType = spec.get("defaultContentType").asText("application/json");
// Iterate on specification "channels" nodes.
Iterator> channels = spec.path("channels").fields();
while (channels.hasNext()) {
Entry channel = channels.next();
String channelName = channel.getKey();
// Iterate on specification path, "verbs" nodes.
Iterator> verbs = channel.getValue().fields();
while (verbs.hasNext()) {
Entry verb = verbs.next();
String verbName = verb.getKey();
// Find the correct operation.
if (operation.getName().equals(verbName.toUpperCase() + " " + channelName.trim())) {
JsonNode messageBody = verb.getValue().path("message");
// Get message content type.
String contentType = defaultContentType;
if (messageBody.has("contentType")) {
contentType = messageBody.path("contentType").asText();
}
// No need to go further if no examples.
if (messageBody.has("examples")) {
Iterator examples = messageBody.path("examples").elements();
while (examples.hasNext()) {
JsonNode exampleNode = examples.next();
Iterator exampleNames = exampleNode.fieldNames();
while (exampleNames.hasNext()) {
String exampleName = exampleNames.next();
JsonNode example = exampleNode.path(exampleName);
// No need to go further if no payload.
if (example.has("payload")) {
String exampleValue = getExamplePayload(example);
// Build and store a request object.
EventMessage eventMessage = new EventMessage();
eventMessage.setName(exampleName);
eventMessage.setContent(exampleValue);
eventMessage.setMediaType(contentType);
// Now complete with specified headers.
List headers = getExampleHeaders(example);
for (Header header : headers) {
eventMessage.addHeader(header);
}
result.add(new UnidirectionalEvent(eventMessage));
}
}
}
// If we've got examples, look also for bindings. First at the channel level.
if (verb.getValue().has("bindings")) {
Iterator bindingNames = verb.getValue().path("bindings").fieldNames();
while (bindingNames.hasNext()) {
String bindingName = bindingNames.next();
JsonNode binding = verb.getValue().path("bindings").path(bindingName);
switch (bindingName) {
case "kafka":
break;
case "amqp1":
Binding b = retrieveOrInitOperationBinding(operation, BindingType.AMQP1);
if (binding.has("destinationName")) {
b.setDestinationName(binding.path("destinationName").asText());
}
if (binding.has("destinationType")) {
b.setDestinationType(binding.path("destinationType").asText());
}
break;
}
}
}
// Then look for bindings at the message level.
if (messageBody.has("bindings")) {
Iterator bindingNames = messageBody.path("bindings").fieldNames();
while (bindingNames.hasNext()) {
String bindingName = bindingNames.next();
JsonNode binding = messageBody.path("bindings").path(bindingName);
switch (bindingName) {
case "kafka":
Binding b = retrieveOrInitOperationBinding(operation, BindingType.KAFKA);
if (binding.has("key")) {
b.setKeyType(binding.path("key").path("type").asText());
}
break;
case "amqp1":
break;
}
}
}
}
}
}
}
return result;
}
/**
* Extract the list of operations from Specification.
*/
private List extractOperations() throws MockRepositoryImportException {
List results = new ArrayList<>();
// Iterate on specification "channels" nodes.
Iterator> channels = spec.path("channels").fields();
while (channels.hasNext()) {
Entry channel = channels.next();
String channelName = channel.getKey();
// Iterate on specification path, "verbs" nodes.
Iterator> verbs = channel.getValue().fields();
while (verbs.hasNext()) {
Entry verb = verbs.next();
String verbName = verb.getKey();
// Only deal with real verbs for now.
if (VALID_VERBS.contains(verbName)) {
String operationName = verbName.toUpperCase() + " " + channelName.trim();
Operation operation = new Operation();
operation.setName(operationName);
operation.setMethod(verbName.toUpperCase());
// Deal with dispatcher stuffs.
if (channelHasParts(channelName)) {
operation.setDispatcher(DispatchStyles.URI_PARTS);
} else {
operation.addResourcePath(channelName);
}
results.add(operation);
}
}
}
return results;
}
/** Extract the list of Header from an example node. */
private List getExampleHeaders(JsonNode example) {
List results = new ArrayList<>();
if (example.has("headers")) {
Iterator> headers = null;
if (example.path("headers").getNodeType() == JsonNodeType.OBJECT ) {
headers = example.path("headers").fields();
} else if (example.path("headers").getNodeType() == JsonNodeType.STRING) {
// Try to parse string as a JSON Object...
try {
ObjectMapper mapper = new ObjectMapper();
JsonNode headersNode = mapper.readTree(example.path("headers").asText());
headers = headersNode.fields();
} catch (Exception e) {
log.warn("Headers value {} is a string but not JSON, skipping it", example.path("headers").asText());
}
}
if (headers != null) {
while (headers.hasNext()) {
Entry property = headers.next();
String propertyName = property.getKey();
Header header = new Header();
header.setName(property.getKey());
// Values may be multiple and CSV.
Set headerValues = Arrays.stream(property.getValue().asText().split(","))
.map(value -> value.trim())
.collect(Collectors.toSet());
header.setValues(headerValues);
results.add(header);
}
}
}
return results;
}
/** Get the value of an example. This can be direct value field or those of followed $ref. */
private String getExamplePayload(JsonNode example) {
if (example.has("payload")) {
if (example.path("payload").getNodeType() == JsonNodeType.ARRAY ||
example.path("payload").getNodeType() == JsonNodeType.OBJECT ) {
return example.path("payload").toString();
}
return example.path("payload").asText();
}
if (example.has("$payloadRef")) {
// $ref: '#/components/examples/param_laurent'
String ref = example.path("$payloadRef").asText();
JsonNode component = spec.at(ref.substring(1));
return getExamplePayload(component);
}
return null;
}
/** Check parameters presence into given operation node. */
private static boolean operationHasParameters(JsonNode operation) {
if (!operation.has("parameters")) {
return false;
}
Iterator> parameters = operation.path("parameters").fields();
while (parameters.hasNext()) {
Entry parameter = parameters.next();
return true;
}
return false;
}
/** Check variables parts presence into given channel. */
private static boolean channelHasParts(String channel) {
return (channel.indexOf("/:") != -1 || channel.indexOf("/{") != -1);
}
/** */
private static Binding retrieveOrInitOperationBinding(Operation operation, BindingType type) {
Binding binding = null;
if (operation.getBindings() != null) {
binding = operation.getBindings().get(type);
}
if (binding == null) {
binding = new Binding(type);
operation.addBinding(type.toString(), binding);
}
return binding;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy