com.seleniumtests.util.helper.AppTestDocumentation.java Source code

Java tutorial

Introduction

Here is the source code for com.seleniumtests.util.helper.AppTestDocumentation.java

Source

/**
 * Orignal work: Copyright 2015 www.seleniumtests.com
 * Modified work: Copyright 2016 www.infotel.com
 *             Copyright 2017-2019 B.Hecquet
 *
 * Licensed 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 com.seleniumtests.util.helper;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.NoSuchElementException;
import java.util.stream.Collectors;

import org.apache.commons.io.FileUtils;
import org.testng.annotations.Test;

import com.github.javaparser.JavaParser;
import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.Modifier;
import com.github.javaparser.ast.body.ClassOrInterfaceDeclaration;
import com.github.javaparser.ast.body.MethodDeclaration;
import com.github.javaparser.ast.comments.Comment;
import com.github.javaparser.ast.visitor.VoidVisitorAdapter;
import com.seleniumtests.customexception.ConfigurationException;

/**
 * Class for creating test documentation, which can be imported into confluence through API
 * It generates a template.confluence file which contains the formatted javadoc for each Test method and step
 * @author s047432
 *
 */
public class AppTestDocumentation {

    private static StringBuilder javadoc;

    public static void main(String[] args) throws IOException {
        File srcDir = Paths.get(args[0].replace(File.separator, "/"), "src", "test", "java").toFile();

        javadoc = new StringBuilder(
                "Cette page rfrence l'ensemble des tests et des opration disponible pour l'application\n");
        javadoc.append("\n{toc}\n\n");
        javadoc.append("${project.summary}\n");
        javadoc.append("h1. Tests\n");
        try {
            Path testsFolders = Files.walk(Paths.get(srcDir.getAbsolutePath())).filter(Files::isDirectory)
                    .filter(p -> p.getFileName().toString().equals("tests")).collect(Collectors.toList()).get(0);

            exploreTests(testsFolders.toFile());
        } catch (IndexOutOfBoundsException e) {
            throw new ConfigurationException("no 'tests' sub-package found");
        }

        javadoc.append("----");
        javadoc.append("h1. Pages\n");
        try {
            Path pagesFolders = Files.walk(Paths.get(srcDir.getAbsolutePath())).filter(Files::isDirectory)
                    .filter(p -> p.getFileName().toString().equals("webpage")).collect(Collectors.toList()).get(0);

            explorePages(pagesFolders.toFile());
        } catch (IndexOutOfBoundsException e) {
            throw new ConfigurationException("no 'webpage' sub-package found");
        }

        javadoc.append("${project.scmManager}\n");
        FileUtils.write(Paths.get(args[0], "src/site/confluence/template.confluence").toFile(), javadoc,
                Charset.forName("UTF-8"));
    }

    private static void exploreTests(File srcDir) throws IOException {
        Files.walk(Paths.get(srcDir.getAbsolutePath())).filter(Files::isRegularFile)
                .filter(p -> p.getFileName().toString().endsWith(".java")).forEach(t -> {
                    try {
                        parseTest(t);
                    } catch (FileNotFoundException e) {
                        // TODO Auto-generated catch block
                        e.printStackTrace();
                    }
                });

    }

    private static void parseTest(Path path) throws FileNotFoundException {
        javadoc.append(String.format("\nh2. Tests: %s\n", path.getFileName().toString()));

        FileInputStream in = new FileInputStream(path.toAbsolutePath().toString());

        // parse the file
        CompilationUnit cu = JavaParser.parse(in);

        // prints the resulting compilation unit to default system output
        cu.accept(new ClassVisitor(), "Tests");
        cu.accept(new TestMethodVisitor(), null);
    }

    private static void explorePages(File srcDir) throws IOException {
        Files.walk(Paths.get(srcDir.getAbsolutePath())).filter(Files::isRegularFile)
                .filter(p -> p.getFileName().toString().endsWith(".java")).forEach(t -> {
                    try {
                        parseWebPage(t);
                    } catch (FileNotFoundException e) {
                        // TODO Auto-generated catch block
                        e.printStackTrace();
                    }
                });
    }

    private static void parseWebPage(Path path) throws FileNotFoundException {
        javadoc.append(String.format("\nh2. Page: %s\n", path.getFileName().toString()));

        FileInputStream in = new FileInputStream(path.toAbsolutePath().toString());

        // parse the file
        CompilationUnit cu = JavaParser.parse(in);

        // prints the resulting compilation unit to default system output
        cu.accept(new ClassVisitor(), "Pages");
        cu.accept(new WebPageMethodVisitor(), null);
    }

    private static class TestMethodVisitor extends VoidVisitorAdapter<Void> {

        public void visit(MethodDeclaration n, Void arg) {

            // ignore non test methods
            try {
                n.getAnnotationByClass(Test.class).get();
            } catch (NoSuchElementException e) {
                return;
            }

            javadoc.append(String.format("\nh4. Test: %s\n", n.getNameAsString()));
            try {
                Comment comment = n.getComment().get();
                javadoc.append(formatJavadoc(comment.getContent()));
            } catch (NoSuchElementException e) {
            }
        }
    }

    private static class WebPageMethodVisitor extends VoidVisitorAdapter<Void> {

        public void visit(MethodDeclaration n, Void arg) {

            // only display public methods
            if (!n.getModifiers().contains(Modifier.PUBLIC)) {
                return;
            }

            javadoc.append(String.format("\nh4. Operation: %s\n", n.getNameAsString()));
            try {
                Comment comment = n.getComment().get();
                javadoc.append(formatJavadoc(comment.getContent()));
            } catch (NoSuchElementException e) {
            }
        }
    }

    private static class ClassVisitor extends VoidVisitorAdapter<String> {

        public void visit(ClassOrInterfaceDeclaration n, String objectType) {
            try {
                Comment comment = n.getComment().get();
                javadoc.append(String.format("{panel}%s{panel}\n", formatJavadoc(comment.getContent())));
            } catch (NoSuchElementException e) {
                javadoc.append(
                        String.format("{panel}%s de la classe %s{panel}\n", objectType, n.getNameAsString()));
            }
        }
    }

    /**
     * Remove the star in front of each line 
     * @return
     */
    private static String formatJavadoc(String javadoc) {
        StringBuilder out = new StringBuilder();
        for (String line : javadoc.split("\n")) {
            line = line.trim();
            if (line.startsWith("*")) {
                line = line.substring(1).trim();
            }
            if (line.startsWith("@")) {
                line = String.format("{{%s}}", line);
            }
            out.append(line + "\n");
        }
        return out.toString();
    }
}