Skip to content
Permalink
Browse files
AMBARI-23456. Generate markdown docs from internal annotations. (#53)
* AMBARI-23456. Generate markdown docs from internal annotations.

* fix typo

* fix another typo

* Fix typos that depend on last changes

* prop-doc: depends on install, also without install

* Review changes

* fix typo

* add missing list item tag

* fix another typo
  • Loading branch information
oleewere committed Dec 4, 2018
1 parent cd2bc53 commit a1f1c6755d862d32806bcb003008db516e60d1df
Showing 20 changed files with 595 additions and 277 deletions.
@@ -46,6 +46,12 @@ rpm:
deb:
$(MAVEN_BINARY) clean package -Dbuild-deb -DskipTests -Djdk.version=$(LOGSEARCH_JAVA_VERSION)

prop-docs: install
$(MAVEN_BINARY) -pl ambari-logsearch-docs exec:java -DskipTests -Djdk.version=$(LOGSEARCH_JAVA_VERSION)

prop-docs-only:
$(MAVEN_BINARY) -pl ambari-logsearch-docs clean package exec:java -DskipTests -Djdk.version=$(LOGSEARCH_JAVA_VERSION)

update-version:
$(MAVEN_BINARY) versions:set-property -Dproperty=revision -DnewVersion=$(new-version) -DgenerateBackupPoms=false

@@ -0,0 +1,87 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>ambari-logsearch</artifactId>
<groupId>org.apache.ambari</groupId>
<version>${revision}</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<packaging>jar</packaging>
<url>http://maven.apache.org</url>
<name>Ambari Logsearch Docs</name>
<artifactId>ambari-logsearch-docs</artifactId>
<build>
<resources>
<resource>
<directory>src/main/resources</directory>
<filtering>true</filtering>
</resource>
</resources>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>${jdk.version}</source>
<target>${jdk.version}</target>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>exec-maven-plugin</artifactId>
<version>1.2.1</version>
<executions>
<execution>
<goals>
<goal>java</goal>
</goals>
</execution>
</executions>
<configuration>
<mainClass>org.apache.ambari.logsearch.doc.LogSearchMarkdownGenerator</mainClass>
<arguments>
<argument>--output-dir</argument>
<argument>${project.basedir}/../docs</argument>
</arguments>
</configuration>
</plugin>
</plugins>
</build>

<dependencies>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
</dependency>
<dependency>
<groupId>org.apache.ambari</groupId>
<artifactId>ambari-logsearch-logfeeder</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>org.apache.ambari</groupId>
<artifactId>ambari-logsearch-server</artifactId>
<version>${project.version}</version>
</dependency>
</dependencies>


</project>
@@ -0,0 +1,68 @@
/*
* 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.ambari.logsearch.doc;

public abstract class AbstractDescriptionData {

private final String description;
private final String defaultValue;
private final String examples;

public AbstractDescriptionData(String description, String defaultStr, String[] examplesArr) {
this.description = description;
examples = generateExamplesString(examplesArr);
defaultValue = generateDefaultValue(defaultStr);
}

protected String generateDefaultValue(String defaultValue) {
if (defaultValue == null || defaultValue.length() == 0) {
return "`EMPTY`";
} else {
return defaultValue;
}
}

protected String generateExamplesString(String[] examples) {
if (examples == null) {
return "";
} else {
final StringBuilder stringBuilder = new StringBuilder();
if(examples.length > 0){
stringBuilder.append("<ul>");
for( String example : examples){
stringBuilder.append("<li>").append("`").append(example).append("`").append("</li>");
}
stringBuilder.append("</ul>");
}
return stringBuilder.toString();
}
}

public String getDescription() {
return description;
}

public String getDefaultValue() {
return defaultValue;
}

public String getExamples() {
return examples;
}
}
@@ -0,0 +1,214 @@
/*
* 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.ambari.logsearch.doc;

import freemarker.template.Configuration;
import freemarker.template.Template;
import org.apache.ambari.logsearch.config.api.LogSearchPropertyDescription;
import org.apache.ambari.logsearch.config.api.ShipperConfigElementDescription;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.CommandLineParser;
import org.apache.commons.cli.DefaultParser;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;
import org.apache.commons.io.FileUtils;
import org.reflections.Reflections;
import org.reflections.scanners.FieldAnnotationsScanner;
import org.reflections.scanners.MethodAnnotationsScanner;
import org.springframework.core.io.ClassPathResource;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.StringWriter;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.nio.charset.Charset;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.stream.Collectors;

public class LogSearchMarkdownGenerator {

private static final String SHIPPER_CONFIG_TEMPLATE_KEY = "shipperConfigs";
private static final String LOGSEARCH_PROPERTIES_TEMPLATE_KEY = "logsearchProperties";
private static final String LOGFEEDER_PROPERTIES_TEMPLATE_KEY = "logfeederProperties";

private static final String OUTPUT_DIR_OPTION = "output-dir";

private static final String LOGSEARCH_PACKAGE = "org.apache.ambari.logsearch";
private static final String LOGFEEDER_PACKAGE = "org.apache.ambari.logfeeder";
private static final String CONFIG_API_PACKAGE = "org.apache.ambari.logsearch.config.json.model.inputconfig.impl";

private static final String TEMPLATES_FOLDER = "templates";

private static final String LOGSEARCH_PROPERTIES = "logsearch.properties";
private static final String LOGSEARCH_PROPERTIES_MARKDOWN_TEMPLATE_FILE = "logsearch_properties.md.ftl";
private static final String LOGSEARCH_PROPERTIES_MARKDOWN_OUTPUT = "logsearch_properties.md";

private static final String LOGFEEDER_PROPERTIES = "logfeeder.properties";
private static final String LOGFEEDER_PROPERTIES_MARKDOWN_TEMPLATE_FILE = "logfeeder_properties.md.ftl";
private static final String LOGFEEDER_PROPERTIES_MARKDOWN_OUTPUT = "logfeeder_properties.md";

private static final String SHIPPER_CONFIGURATIONS_MARKDOWN_TEMPLATE_FILE = "shipper_configurations.md.ftl";
private static final String SHIPPER_CONFIGURATIONS_MARKDOWN_OUTPUT = "shipper_configurations.md";


public static void main(String[] args) {
try {
Options options = new Options();
options.addOption(Option.builder()
.desc("Output folder of the markdowns")
.longOpt(OUTPUT_DIR_OPTION)
.hasArg()
.required()
.type(String.class)
.build());
CommandLineParser parser = new DefaultParser();
CommandLine cmdLine = parser.parse(options, args);

String outputDir = cmdLine.getOptionValue(OUTPUT_DIR_OPTION);
File outputFileDir = new File(outputDir);
if (!outputFileDir.exists() || !outputFileDir.isDirectory()) {
throw new FileNotFoundException(String.format("Directory '%s' does not exist", outputDir));
}

final Map<String, List<PropertyDescriptionData>> propertyDescriptions = new ConcurrentHashMap<>();
final List<String> configPackagesToScan = Arrays.asList(LOGSEARCH_PACKAGE, LOGFEEDER_PACKAGE);
fillPropertyDescriptions(propertyDescriptions, configPackagesToScan);
System.out.println(String.format("Number of logsearch.properties configuration descriptors found: %d", propertyDescriptions.get(LOGSEARCH_PROPERTIES).size()));
System.out.println(String.format("Number of logfeeder.properties configuration descriptors found: %d", propertyDescriptions.get(LOGFEEDER_PROPERTIES).size()));

final List<String> shipperConfigPackagesToScan = Collections.singletonList(CONFIG_API_PACKAGE);
ShipperConfigDescriptionDataHolder shipperConfigDescriptionDataHolder = createShipperConfigDescriptions(shipperConfigPackagesToScan);

System.out.println(String.format("Number of top level section shipper descriptors found: %d", shipperConfigDescriptionDataHolder.getTopLevelConfigSections().size()));
System.out.println(String.format("Number of input config section shipper descriptors found: %d", shipperConfigDescriptionDataHolder.getInputConfigSections().size()));
System.out.println(String.format("Number of filter config section shipper descriptors found: %d", shipperConfigDescriptionDataHolder.getFilterConfigSections().size()));
System.out.println(String.format("Number of mapper section shipper descriptors found: %d", shipperConfigDescriptionDataHolder.getPostMapValuesConfigSections().size()));

final Configuration freemarkerConfiguration = new Configuration();
final ClassPathResource cpr = new ClassPathResource(TEMPLATES_FOLDER);
freemarkerConfiguration.setDirectoryForTemplateLoading(cpr.getFile());

final Map<String, Object> logsearchModels = new HashMap<>();
logsearchModels.put(LOGSEARCH_PROPERTIES_TEMPLATE_KEY, propertyDescriptions.get(LOGSEARCH_PROPERTIES));
File logsearchPropertiesOutputFile = Paths.get(outputDir,LOGSEARCH_PROPERTIES_MARKDOWN_OUTPUT).toFile();
writeMarkdown(freemarkerConfiguration, LOGSEARCH_PROPERTIES_MARKDOWN_TEMPLATE_FILE, logsearchModels, logsearchPropertiesOutputFile);

final Map<String, Object> logfeederModels = new HashMap<>();
logfeederModels.put(LOGFEEDER_PROPERTIES_TEMPLATE_KEY, propertyDescriptions.get(LOGFEEDER_PROPERTIES));
File logfeederPropertiesOutputFile = Paths.get(outputDir, LOGFEEDER_PROPERTIES_MARKDOWN_OUTPUT).toFile();
writeMarkdown(freemarkerConfiguration, LOGFEEDER_PROPERTIES_MARKDOWN_TEMPLATE_FILE, logfeederModels, logfeederPropertiesOutputFile);

final Map<String, Object> shipperConfigModels = new HashMap<>();
shipperConfigModels.put(SHIPPER_CONFIG_TEMPLATE_KEY, shipperConfigDescriptionDataHolder);

File shipperConfigsOutputFile = Paths.get(outputDir, SHIPPER_CONFIGURATIONS_MARKDOWN_OUTPUT).toFile();
writeMarkdown(freemarkerConfiguration, SHIPPER_CONFIGURATIONS_MARKDOWN_TEMPLATE_FILE, shipperConfigModels, shipperConfigsOutputFile);

} catch (Exception e) {
e.printStackTrace();
System.exit(1);
}
}

private static void writeMarkdown(Configuration freemarkerConfiguration, String templateName,
Map<String, Object> models, File outputFile) throws Exception {
final StringWriter stringWriter = new StringWriter();
final Template template = freemarkerConfiguration.getTemplate(templateName);
template.process(models, stringWriter);
FileUtils.writeStringToFile(outputFile, stringWriter.toString(), Charset.defaultCharset(), false);
}

private static void fillPropertyDescriptions(Map<String, List<PropertyDescriptionData>> propertyDescriptions, List<String> packagesToScan) {
List<PropertyDescriptionData> propertyDescriptionsList = getPropertyDescriptions(packagesToScan);
Map<String, List<PropertyDescriptionData>> mapToAdd = propertyDescriptionsList.stream()
.sorted(Comparator.comparing(PropertyDescriptionData::getName))
.collect(Collectors.groupingBy(PropertyDescriptionData::getSource));
propertyDescriptions.putAll(mapToAdd);
}

private static ShipperConfigDescriptionDataHolder createShipperConfigDescriptions(List<String> shipperConfigPackagesToScan) {
final List<ShipperConfigDescriptionData> shipperConfigDescription = new ArrayList<>();
Reflections reflections = new Reflections(shipperConfigPackagesToScan, new FieldAnnotationsScanner());
Set<Field> fields = reflections.getFieldsAnnotatedWith(ShipperConfigElementDescription.class);
for (Field field : fields) {
ShipperConfigElementDescription description = field.getAnnotation(ShipperConfigElementDescription.class);
shipperConfigDescription.add(new ShipperConfigDescriptionData(description.path(), description.description(),
description.examples(), description.defaultValue()));
}
shipperConfigDescription.sort(Comparator.comparing(ShipperConfigDescriptionData::getPath));

final List<ShipperConfigDescriptionData> topLevelConfigSections = shipperConfigDescription.stream()
.filter(
s -> (s.getPath().equals("/filter") || s.getPath().equals("/input") || s.getPath().equals("/output")))
.distinct()
.collect(Collectors.toList());

final List<ShipperConfigDescriptionData> inputConfigSection = shipperConfigDescription.stream()
.filter(
s -> (s.getPath().startsWith("/input") && !s.getPath().equals("/input")))
.distinct()
.collect(Collectors.toList());

final List<ShipperConfigDescriptionData> filterConfigSection = shipperConfigDescription.stream()
.filter(
s -> (s.getPath().startsWith("/filter") && !s.getPath().equals("/filter") && !s.getPath().startsWith("/filter/[]/post_map_values")) || s.getPath().equals("/filter/[]/post_map_values"))
.distinct()
.collect(Collectors.toList());

final List<ShipperConfigDescriptionData> postMapValuesConfigSection = shipperConfigDescription.stream()
.filter(
s -> (s.getPath().startsWith("/filter/[]/post_map_values") && !s.getPath().equals("/filter/[]/post_map_values")))
.distinct()
.collect(Collectors.toList());

return new ShipperConfigDescriptionDataHolder(topLevelConfigSections, inputConfigSection, filterConfigSection, postMapValuesConfigSection);
}

private static List<PropertyDescriptionData> getPropertyDescriptions(List<String> packagesToScan) {
List<PropertyDescriptionData> result = new ArrayList<>();
for (String packageToScan : packagesToScan) {
Reflections reflections = new Reflections(packageToScan, new FieldAnnotationsScanner(), new MethodAnnotationsScanner());
Set<Field> fields = reflections.getFieldsAnnotatedWith(LogSearchPropertyDescription.class);
for (Field field : fields) {
LogSearchPropertyDescription propDescription = field.getAnnotation(LogSearchPropertyDescription.class);
for (String source : propDescription.sources()) {
result.add(new PropertyDescriptionData(propDescription.name(), propDescription.description(), propDescription.examples(), propDescription.defaultValue(), source));
}
}
Set<Method> methods = reflections.getMethodsAnnotatedWith(LogSearchPropertyDescription.class);
for (Method method : methods) {
LogSearchPropertyDescription propDescription = method.getAnnotation(LogSearchPropertyDescription.class);
for (String source : propDescription.sources()) {
result.add(new PropertyDescriptionData(propDescription.name(), propDescription.description(), propDescription.examples(), propDescription.defaultValue(), source));
}
}
}
return result;
}
}

0 comments on commit a1f1c67

Please sign in to comment.