org.graylog.api.GenerateApiDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 6.1.4
/*
 * Copyright (C) 2020 Graylog, Inc.
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the Server Side Public License, version 1,
 * as published by MongoDB, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Server Side Public License for more details.
 *
 * You should have received a copy of the Server Side Public License
 * along with this program. If not, see
 * .
 */
package org.graylog.api;

import com.fasterxml.jackson.databind.ObjectMapper;
import com.google.common.collect.ImmutableSet;
import io.github.classgraph.ClassGraph;
import io.github.classgraph.ClassInfo;
import io.github.classgraph.ScanResult;
import org.graylog2.shared.bindings.providers.ObjectMapperProvider;
import org.graylog2.shared.rest.documentation.generator.Generator;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;

public class GenerateApiDefinition {
    private static final ObjectMapper objectMapper = new ObjectMapper();

    private static void log(String s) {
        System.out.println(s);
    }

    private static void bail(String s) {
        log(s);
        System.exit(-1);
    }

    private static Set> findResources(String[] controllerPackages) {
        final ImmutableSet.Builder> resources = ImmutableSet.builder();
        final ClassGraph classGraph = new ClassGraph().enableAnnotationInfo().acceptPackages(controllerPackages);

        try (final ScanResult scanResult = classGraph.scan()) {
            for (final ClassInfo classInfo : scanResult.getClassesWithAnnotation("javax.ws.rs.Path")) {
                resources.add(classInfo.loadClass());
            }
        }

        return resources.build();
    }

    private static boolean deleteDirectory(File directoryToBeDeleted) {
        File[] allContents = directoryToBeDeleted.listFiles();
        if (allContents != null) {
            for (File file : allContents) {
                deleteDirectory(file);
            }
        }
        return directoryToBeDeleted.delete();
    }

    public static void main(String[] args) throws IOException {
        if (args.length < 2) {
            bail("Syntax: " + GenerateApiDefinition.class.getSimpleName() + "   ... ");
        }
        final String targetName = args[0];
        final Path targetPath = Paths.get(targetName);

        deleteDirectory(targetPath.toFile());
        Files.createDirectories(targetPath);
        log("Generating Swagger definition for API ...");
        final String[] packageNames = Arrays.stream(args).skip(1).toArray(String[]::new);

        final Set> resourceClasses = findResources(packageNames);

        final ObjectMapper objectMapper = new ObjectMapperProvider().get();

        final Generator generator = new Generator(resourceClasses, Collections.emptyMap(), "/plugins", objectMapper, false);

        final Map overview = generator.generateOverview();
        writeJsonToFile(targetName + "/api.json", overview);

        final List> apis = retrieveApis(overview);

        apis.forEach(api -> {
            final String path = pathFromApi(api);
            try {
                log("Writing " + path);
                final Map apiResponse = generator.generateForRoute(path, "/");
                writeJsonToFile(targetName + path + ".json", apiResponse);
            } catch (IOException e) {
                log("Unable to write " + targetName + path + ":" + e);
            }
        });
        log("Done.");
    }

    private static String pathFromApi(Map api) {
        return (String) api.get("path");
    }

    private static List> retrieveApis(Map overview) {
        return overview.containsKey("apis")
                ? (List>) overview.get("apis")
                : Collections.emptyList();
    }

    private static void writeJsonToFile(String filename, Object content) throws IOException {
        final File file = new File(filename);
        file.getParentFile().mkdirs();
        if (!file.createNewFile()) {
            throw new RuntimeException("Unable to create file " + file.getAbsolutePath());
        }

        final FileOutputStream outputStream = new FileOutputStream(file);

        objectMapper.writeValue(outputStream, content);
    }
}