org.apache.camel.quarkus.maven.UpdateExtensionDocPageMojo Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF 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 org.apache.camel.quarkus.maven;
import java.io.IOException;
import java.io.StringWriter;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.Path;
import java.text.Normalizer;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import freemarker.template.Configuration;
import freemarker.template.TemplateMethodModelEx;
import freemarker.template.TemplateModel;
import freemarker.template.TemplateModelException;
import freemarker.template.utility.DeepUnwrap;
import io.quarkus.annotation.processor.Constants;
import io.quarkus.annotation.processor.generate_doc.ConfigDocItem;
import io.quarkus.annotation.processor.generate_doc.ConfigDocKey;
import io.quarkus.annotation.processor.generate_doc.DocGeneratorUtil;
import io.quarkus.annotation.processor.generate_doc.FsMap;
import org.apache.camel.catalog.Kind;
import org.apache.camel.quarkus.maven.processor.AppendNewLinePostProcessor;
import org.apache.camel.quarkus.maven.processor.AsciiDocFile;
import org.apache.camel.quarkus.maven.processor.DocumentationPostProcessor;
import org.apache.camel.quarkus.maven.processor.SectionIdPostProcessor;
import org.apache.camel.tooling.model.ArtifactModel;
import org.apache.camel.tooling.model.BaseModel;
import org.apache.camel.tooling.model.ComponentModel;
import org.apache.maven.model.Dependency;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
@Mojo(name = "update-extension-doc-page", threadSafe = true)
public class UpdateExtensionDocPageMojo extends AbstractDocGeneratorMojo {
private static final Map nativeSslActivators = new ConcurrentHashMap<>();
private static final DocumentationPostProcessor[] documentationPostProcessors = {
new AppendNewLinePostProcessor(),
new SectionIdPostProcessor()
};
@Parameter(defaultValue = "false", property = "camel-quarkus.update-extension-doc-page.skip")
boolean skip = false;
/** {@inheritDoc} */
@SuppressWarnings("unchecked")
@Override
public void execute() throws MojoExecutionException, MojoFailureException {
if (skip) {
getLog().info("Skipping per user request");
return;
}
final Charset charset = Charset.forName(encoding);
final Path basePath = baseDir.toPath();
if (!"runtime".equals(basePath.getFileName().toString())) {
getLog().info("Skipping a module that is not a Quarkus extension runtime module");
return;
}
final CqCatalog catalog = new CqCatalog();
final Path multiModuleProjectDirectoryPath = multiModuleProjectDirectory.toPath();
final CamelQuarkusExtension ext = CamelQuarkusExtension.read(basePath.resolve("pom.xml"));
final Path quarkusAwsClientTestsDir = multiModuleProjectDirectoryPath
.resolve("integration-test-groups/aws2-quarkus-client");
final Path pomRelPath = multiModuleProjectDirectoryPath.relativize(basePath).resolve("pom.xml");
if (ext.getJvmSince().isEmpty()) {
throw new IllegalStateException(
CamelQuarkusExtension.CAMEL_QUARKUS_JVM_SINCE + " property must defined in " + pomRelPath);
}
final String extensionsDir = basePath.getParent().getParent().getFileName().toString();
if (!"extensions-jvm".equals(extensionsDir) && ext.getNativeSince().isEmpty()) {
throw new IllegalStateException(
CamelQuarkusExtension.CAMEL_QUARKUS_NATIVE_SINCE + " property must defined in " + pomRelPath);
}
final Configuration cfg = CqUtils.getTemplateConfig(basePath, AbstractDocGeneratorMojo.DEFAULT_TEMPLATES_URI_BASE,
templatesUriBase, encoding);
final List> models = catalog.filterModels(ext.getRuntimeArtifactIdBase())
.filter(artifactModel -> !artifactModel.getArtifactId().equals("camel-management"))
.filter(artifactModel -> !artifactModel.getArtifactId().equals("camel-yaml-io"))
.sorted(BaseModel.compareTitle())
.collect(Collectors.toList());
final Map model = new HashMap<>();
model.put("artifactIdBase", ext.getRuntimeArtifactIdBase());
final String jvmSince = ext.getJvmSince().get();
model.put("firstVersion", jvmSince);
model.put("nativeSupported", ext.isNativeSupported());
final String title = ext.getName().get();
model.put("name", title);
final String description = CqUtils.getDescription(models, ext.getDescription().orElse(null), getLog());
model.put("description", description);
model.put("status", ext.getStatus().getCapitalized());
final boolean deprecated = CqUtils.isDeprecated(title, models, ext.isDeprecated());
model.put("statusDeprecation",
deprecated ? ext.getStatus().getCapitalized() + " Deprecated" : ext.getStatus().getCapitalized());
model.put("deprecated", deprecated);
model.put("unlisted", ext.isUnlisted());
model.put("jvmSince", jvmSince);
model.put("nativeSince", ext.getNativeSince().orElse("n/a"));
if (lowerEqual_1_0_0(jvmSince)) {
model.put("pageAliases", "extensions/" + ext.getRuntimeArtifactIdBase() + ".adoc");
}
model.put("intro", loadSection(basePath, "intro.adoc", charset, description, ext));
model.put("models", models);
model.put("usage", loadSection(basePath, "usage.adoc", charset, null, ext));
model.put("usageAdvanced", loadSection(basePath, "usage-advanced.adoc", charset, null, ext));
model.put("configuration", loadSection(basePath, "configuration.adoc", charset, null, ext));
model.put("limitations", loadSection(basePath, "limitations.adoc", charset, null, ext));
model.put("activatesNativeSsl", ext.isNativeSupported() && detectNativeSsl(multiModuleProjectDirectory.toPath(),
basePath, ext.getRuntimeArtifactId(), ext.getDependencies(), nativeSslActivators));
model.put("activatesContextMapAll",
ext.isNativeSupported()
&& detectComponentOrEndpointOption(catalog, ext.getRuntimeArtifactIdBase(), "allowContextMapAll"));
model.put("activatesTransferException",
ext.isNativeSupported()
&& detectComponentOrEndpointOption(catalog, ext.getRuntimeArtifactIdBase(), "transferException"));
model.put(
"quarkusAwsClient",
getQuarkusAwsClient(
quarkusAwsClientTestsDir,
ext.getRuntimeArtifactIdBase(),
ext.getQuarkusAwsClientBaseName(),
ext.getQuarkusAwsClientFqClassName(),
ext.getRuntimePomXmlPath()));
model.put("configOptions", listConfigOptions(basePath, multiModuleProjectDirectory.toPath()));
model.put("humanReadableKind", new TemplateMethodModelEx() {
@Override
public Object exec(List arguments) throws TemplateModelException {
if (arguments.size() != 1) {
throw new TemplateModelException("Wrong argument count in toCamelCase()");
}
return CqUtils.humanReadableKind(Kind.valueOf(String.valueOf(arguments.get(0))));
}
});
model.put("camelBitLink", new TemplateMethodModelEx() {
@Override
public Object exec(List arguments) throws TemplateModelException {
if (arguments.size() != 2) {
throw new TemplateModelException("Wrong argument count in camelBitLink()");
}
final ArtifactModel model = (ArtifactModel) DeepUnwrap.unwrap((TemplateModel) arguments.get(0));
if (CqCatalog.isFirstScheme(model)) {
return camelBitLink(model);
} else {
final List> models = (List>) DeepUnwrap
.unwrap((TemplateModel) arguments.get(1));
final ArtifactModel firstModel = CqCatalog.findFirstSchemeModel(model, models);
return camelBitLink(firstModel);
}
}
private String camelBitLink(ArtifactModel model) {
model = CqCatalog.toCamelDocsModel(model);
final String kind = model.getKind();
String name = model.getName();
String xrefPrefix = "xref:{cq-camel-components}:" + (!"component".equals(kind) ? kind + "s:" : ":");
if (name.equals("xml-io-dsl")) {
name = "java-xml-io-dsl";
}
if (name.equals("console")) {
xrefPrefix = "xref:manual::";
name = "camel-console";
}
return xrefPrefix + name + (!"other".equals(kind) ? "-" + kind : "") + ".adoc";
}
});
model.put("toAnchor", new TemplateMethodModelEx() {
@Override
public Object exec(List arguments) throws TemplateModelException {
if (arguments.size() != 1) {
throw new TemplateModelException("Wrong argument count in toAnchor()");
}
String string = String.valueOf(arguments.get(0));
string = Normalizer.normalize(string, Normalizer.Form.NFKC)
.replaceAll("[àáâãäåāąă]", "a")
.replaceAll("[çćčĉċ]", "c")
.replaceAll("[ďđð]", "d")
.replaceAll("[èéêëēęěĕė]", "e")
.replaceAll("[ƒſ]", "f")
.replaceAll("[ĝğġģ]", "g")
.replaceAll("[ĥħ]", "h")
.replaceAll("[ìíîïīĩĭįı]", "i")
.replaceAll("[ijĵ]", "j")
.replaceAll("[ķĸ]", "k")
.replaceAll("[łľĺļŀ]", "l")
.replaceAll("[ñńňņʼnŋ]", "n")
.replaceAll("[òóôõöøōőŏœ]", "o")
.replaceAll("[Þþ]", "p")
.replaceAll("[ŕřŗ]", "r")
.replaceAll("[śšşŝș]", "s")
.replaceAll("[ťţŧț]", "t")
.replaceAll("[ùúûüūůűŭũų]", "u")
.replaceAll("[ŵ]", "w")
.replaceAll("[ýÿŷ]", "y")
.replaceAll("[žżź]", "z")
.replaceAll("[æ]", "ae")
.replaceAll("[ÀÁÂÃÄÅĀĄĂ]", "A")
.replaceAll("[ÇĆČĈĊ]", "C")
.replaceAll("[ĎĐÐ]", "D")
.replaceAll("[ÈÉÊËĒĘĚĔĖ]", "E")
.replaceAll("[ĜĞĠĢ]", "G")
.replaceAll("[ĤĦ]", "H")
.replaceAll("[ÌÍÎÏĪĨĬĮİ]", "I")
.replaceAll("[Ĵ]", "J")
.replaceAll("[Ķ]", "K")
.replaceAll("[ŁĽĹĻĿ]", "L")
.replaceAll("[ÑŃŇŅŊ]", "N")
.replaceAll("[ÒÓÔÕÖØŌŐŎ]", "O")
.replaceAll("[ŔŘŖ]", "R")
.replaceAll("[ŚŠŞŜȘ]", "S")
.replaceAll("[ÙÚÛÜŪŮŰŬŨŲ]", "U")
.replaceAll("[Ŵ]", "W")
.replaceAll("[ÝŶŸ]", "Y")
.replaceAll("[ŹŽŻ]", "Z")
.replaceAll("[ß]", "ss");
// Apostrophes.
string = string.replaceAll("([a-z])'s([^a-z])", "$1s$2");
// Allow only letters, -, _, .
string = string.replaceAll("[^\\w-_.]", "-").replaceAll("-{2,}", "-");
// Get rid of any - at the start and end.
string = string.replaceAll("-+$", "").replaceAll("^-+", "");
return string.toLowerCase();
}
});
final Path docPagePath = multiModuleProjectDirectoryPath
.resolve("docs/modules/ROOT/pages/reference/extensions/" + ext.getRuntimeArtifactIdBase() + ".adoc");
evalTemplate(charset, docPagePath, cfg, model, "extension-doc-page.adoc", "//");
camelBits(charset, cfg, models, multiModuleProjectDirectoryPath, model);
}
static void evalTemplate(final Charset charset, final Path docPagePath, final Configuration cfg,
final Map model, String template, String commentMarker) {
try {
Files.createDirectories(docPagePath.getParent());
} catch (IOException e) {
throw new RuntimeException("Could not create directories " + docPagePath.getParent(), e);
}
String pageText = commentMarker
+ " Do not edit directly!\n"
+ commentMarker
+ " This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page\n"
+ evalTemplate(cfg, template, model, new StringWriter());
try {
Files.write(docPagePath, pageText.getBytes(charset));
} catch (IOException e) {
throw new RuntimeException("Could not write to " + docPagePath, e);
}
}
void camelBits(Charset charset, Configuration cfg, List> models, Path multiModuleProjectDirectoryPath,
Map model) {
models.stream()
.filter(CqCatalog::isFirstScheme)
.forEach(m -> {
final Kind kind = Kind.valueOf(m.getKind());
final HashMap modelClone = new HashMap<>(model);
modelClone.put("camelPartName", m.getName());
modelClone.put("camelPartTitle", m.getTitle());
modelClone.put("camelPartDescription", m.getDescription());
final ArtifactModel camelDocModel = CqCatalog.toCamelDocsModel(m);
final Path docPagePath = multiModuleProjectDirectoryPath
.resolve("docs/modules/ROOT/examples/" + CqUtils.kindPlural(kind) + "/"
+ camelDocModel.getName() + ".yml");
evalTemplate(charset, docPagePath, cfg, modelClone, "extensions-camel-bits.yml", "#");
});
}
private boolean lowerEqual_1_0_0(String jvmSince) {
if ("1.0.0".equals(jvmSince)) {
return true;
}
String[] components = jvmSince.split("\\.");
return components[0].equals("0");
}
static boolean detectNativeSsl(Path sourceTreeRoot, Path basePath, String artifactId, List dependencies,
Map cache) {
if (cache.computeIfAbsent(artifactId,
aid -> detectNativeSsl(basePath.resolve("../deployment").toAbsolutePath().normalize()))) {
return true;
}
for (Dependency dependency : dependencies) {
if ("org.apache.camel.quarkus".equals(dependency.getGroupId())
&& !dependency.getArtifactId().endsWith("-component")) {
final String depArtifactId = dependency.getArtifactId();
if (cache.computeIfAbsent(
depArtifactId,
aid -> detectNativeSsl(
CqUtils.findExtensionDirectory(sourceTreeRoot, depArtifactId).resolve("deployment")))) {
return true;
}
}
}
return false;
}
static QuarkusAwsClient getQuarkusAwsClient(Path quarkusAwsClienTestsDir, String artifactIdBase,
Optional quarkusAwsClientBaseName, Optional quarkusAwsClientFqClassName, Path runtimePomPath) {
if (quarkusAwsClientBaseName.isPresent() && quarkusAwsClientFqClassName.isPresent()) {
return new QuarkusAwsClient(quarkusAwsClientBaseName.get(), quarkusAwsClientFqClassName.get());
}
/* We assume Quarkus client exists if there is a test under integration-test-groups/aws2-quarkus-client */
final Path quarkusClientTestPath = quarkusAwsClienTestsDir.resolve(artifactIdBase + "/pom.xml");
if (Files.isRegularFile(quarkusClientTestPath)) {
if (quarkusAwsClientBaseName.isEmpty()) {
throw new IllegalStateException(quarkusClientTestPath
+ " exists but cq.quarkus.aws.client.baseName property is not defined in " + runtimePomPath);
}
if (quarkusAwsClientFqClassName.isEmpty()) {
throw new IllegalStateException(quarkusClientTestPath
+ " exists but cq.quarkus.aws.client.fqClassName property is not defined in " + runtimePomPath);
}
}
return null;
}
static boolean detectNativeSsl(Path deploymentBasePath) {
final Path deploymentPackageDir = deploymentBasePath.resolve("src/main/java/org/apache/camel/quarkus")
.toAbsolutePath()
.normalize();
if (!Files.exists(deploymentPackageDir)) {
return false;
}
try (Stream files = Files.walk(deploymentPackageDir)) {
return files
.filter(p -> p.getFileName().toString().endsWith("Processor.java"))
.map(p -> {
try {
return Files.readString(p);
} catch (Exception e) {
throw new RuntimeException("Could not read from " + p, e);
}
})
.anyMatch(source -> source.contains("new ExtensionSslNativeSupportBuildItem"));
} catch (IOException e) {
throw new RuntimeException("Could not walk " + deploymentPackageDir, e);
}
}
static boolean detectComponentOrEndpointOption(CqCatalog catalog, String artifactId, String option) {
return catalog.filterModels(artifactId)
.filter(m -> m instanceof ComponentModel)
.map(m -> (ComponentModel) m)
.anyMatch(componentModel -> {
for (ComponentModel.ComponentOptionModel model : componentModel.getOptions()) {
if (model.getName().equals(option)) {
return true;
}
}
for (ComponentModel.EndpointOptionModel model : componentModel.getEndpointOptions()) {
if (model.getName().equals(option)) {
return true;
}
}
return false;
});
}
private static String loadSection(
Path basePath,
String fileName,
Charset charset,
String default_,
CamelQuarkusExtension extension) {
Path p = basePath.resolve("src/main/doc/" + fileName);
if (Files.exists(p)) {
AsciiDocFile file = new AsciiDocFile(p, extension.getRuntimeArtifactIdBase(), charset);
for (DocumentationPostProcessor processor : documentationPostProcessors) {
processor.process(file);
}
return file.getContent();
} else {
return default_;
}
}
static List listConfigOptions(Path basePath, Path multiModuleProjectDirectory) {
final List configRootClasses = loadConfigRoots(basePath);
if (configRootClasses.isEmpty()) {
return Collections.emptyList();
}
final Path configRootsModelsDir = multiModuleProjectDirectory
.resolve("target/asciidoc/generated/config/all-configuration-roots-generated-doc");
if (!Files.exists(configRootsModelsDir)) {
throw new IllegalStateException("You should run " + UpdateExtensionDocPageMojo.class.getSimpleName()
+ " after compilation with io.quarkus.annotation.processor.ExtensionAnnotationProcessor");
}
final FsMap configRootsModels = new FsMap(configRootsModelsDir);
final ObjectMapper mapper = new ObjectMapper();
final List configDocItems = new ArrayList<>();
for (String configRootClass : configRootClasses) {
final String rawModel = configRootsModels.get(configRootClass);
if (rawModel == null) {
throw new IllegalStateException("Could not find " + configRootClass + " in " + configRootsModelsDir);
}
try {
final List items = mapper.readValue(rawModel, Constants.LIST_OF_CONFIG_ITEMS_TYPE_REF);
configDocItems.addAll(items);
} catch (JsonProcessingException e) {
throw new RuntimeException("Could not parse " + rawModel, e);
}
}
DocGeneratorUtil.sort(configDocItems);
return configDocItems.stream().map(ConfigItem::of).collect(Collectors.toList());
}
static List loadConfigRoots(Path basePath) {
final Path configRootsListPath = basePath.resolve("target/classes/META-INF/quarkus-config-roots.list");
if (!Files.exists(configRootsListPath)) {
return Collections.emptyList();
}
try (Stream lines = Files.lines(configRootsListPath, StandardCharsets.UTF_8)) {
return lines
.map(String::trim)
.filter(l -> !l.isEmpty())
.map(l -> l.replace('$', '.'))
.collect(Collectors.toList());
} catch (IOException e) {
throw new RuntimeException("Could not read from " + configRootsListPath, e);
}
}
public static class QuarkusAwsClient {
public QuarkusAwsClient(String nameBase, String clientClassFqName) {
super();
this.nameBase = nameBase;
this.clientClassFqName = clientClassFqName;
}
private final String nameBase; // DynamoDB
private final String clientClassFqName; // software.amazon.awssdk.services.dynamodb.DynamoDbClient
public String getExtensionName() {
return "Quarkus Amazon " + nameBase;
}
public String getExtensionNameIdHeading() {
return getExtensionName().toLowerCase().replace(" ", "-");
}
public String getConfigurationUrl() {
String lowerCaseName = nameBase.toLowerCase(Locale.ROOT);
return "https://quarkus.io/guides/amazon-" + lowerCaseName + "#configuring-" + lowerCaseName + "-clients";
}
public String getConfigBase() {
return "quarkus." + nameBase.toLowerCase(Locale.ROOT);
}
public String getClientClassSimpleName() {
final int lastPeriod = clientClassFqName.lastIndexOf('.');
return clientClassFqName.substring(lastPeriod + 1);
}
public String getClientClassFqName() {
return clientClassFqName;
}
public String getClientFieldName() {
/* Just lowercase the first letter of getClientClassSimpleName() */
char[] c = getClientClassSimpleName().toCharArray();
c[0] += 32;
return new String(c);
}
}
public static class ConfigItem {
private static final Pattern LINK_PATTERN = Pattern
.compile("\\Qlink:http\\Es?\\Q://camel.apache.org/camel-quarkus/latest/\\E([^\\[]+).html");
private final String key;
private final String illustration;
private final String configDoc;
private final String type;
private final String defaultValue;
private final boolean optional;
public static ConfigItem of(ConfigDocItem configDocItem) {
final ConfigDocKey configDocKey = configDocItem.getConfigDocKey();
final String adocSource = LINK_PATTERN.matcher(configDocKey.getConfigDoc()).replaceAll("xref:$1.adoc");
return new ConfigItem(
configDocKey.getKey(),
configDocKey.getConfigPhase().getIllustration(),
adocSource,
configDocKey.getType(),
configDocKey.getDefaultValue(),
configDocKey.isOptional());
}
public ConfigItem(String key, String illustration, String configDoc, String type, String defaultValue,
boolean optional) {
this.key = key;
this.illustration = illustration;
this.configDoc = configDoc;
this.type = type;
this.defaultValue = defaultValue;
this.optional = optional;
}
public String getKey() {
return key;
}
public String getIllustration() {
return illustration;
}
public String getConfigDoc() {
return configDoc;
}
public String getType() {
return type;
}
public String getDefaultValue() {
return defaultValue;
}
public boolean isOptional() {
return optional;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy