Merge pull request #45 from secure-software-engineering/fix/update-coverage-doclet

Update coverage doclet

Author: oshando

README.md

@@ -12,7 +12,7 @@ The project contains the following modules:
 * **swan-pipeline**: core machine learning implementation for SWAN with components for data collection and preparation, feature engineering and model selection phases
 * **swan-assist**: IntelliJ plugin provides GUI support for SWAN and enables active machine learning.
 * **swan-javadoc-exporter**: Doclet exports doc comments to XML files so that they can be analyzed by the Natural Language Processing (NLP) module
-* **swan-javadoc-coverage**: Doclet calculates the software documentation coverage of Java programs based on the presence of doc comments for classes, methods, and other objects.
+* **doc-coverage-doclet**: Doclet calculates the software documentation coverage of Java programs based on the presence of doc comments for classes, methods, and other objects.
 
 How do I get started with SWAN?
 -------------

doc-coverage-doclet/pom.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<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">
+    <modelVersion>4.0.0</modelVersion>
+
+    <groupId>de.fraunhofer.iem</groupId>
+    <artifactId>coverage-doclet</artifactId>
+    <version>1.0-SNAPSHOT</version>
+
+    <properties>
+        <maven.compiler.source>11</maven.compiler.source>
+        <maven.compiler.target>11</maven.compiler.target>
+    </properties>
+
+</project>

doc-coverage-doclet/src/main/java/de/fraunhofer/iem/coveragedoclet/CoverageDoclet.java

@@ -0,0 +1,96 @@
+package de.fraunhofer.iem.coveragedoclet;
+
+import com.sun.source.doctree.DocCommentTree;
+import com.sun.source.util.DocTrees;
+import jdk.javadoc.doclet.Doclet;
+import jdk.javadoc.doclet.DocletEnvironment;
+import jdk.javadoc.doclet.Reporter;
+
+import javax.lang.model.SourceVersion;
+import javax.lang.model.element.Element;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.util.ElementFilter;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Locale;
+import java.util.Set;
+import java.util.logging.Logger;
+
+/**
+ * A minimal doclet that just prints out the names of the
+ * selected elements. It goes on and on
+ */
+public class CoverageDoclet implements Doclet {
+
+    final private Logger log = Logger.getLogger(CoverageDoclet.class.getName());
+
+    @Override
+    public void init(Locale locale, Reporter reporter) {
+    }
+
+    @Override
+    public String getName() {
+        // For this doclet, the name of the doclet is just the
+        // simple name of the class. The name may be used in
+        // messages related to this doclet, such as in command-line
+        // help when doclet-specific options are provided.
+        return getClass().getSimpleName();
+    }
+
+    @Override
+    public Set<? extends Option> getSupportedOptions() {
+        // This doclet does not support any options.
+        return Collections.emptySet();
+    }
+
+    @Override
+    public SourceVersion getSupportedSourceVersion() {
+        // This doclet supports all source versions.
+        // More sophisticated doclets may use a more
+        // specific version, to ensure that they do not
+        // encounter more recent language features that
+        // they may not be able to handle.
+        return SourceVersion.latest();
+    }
+
+    private static final boolean OK = true;
+
+    @Override
+    public boolean run(DocletEnvironment environment) {
+        // This method is called to perform the work of the doclet.
+        // In this case, it just prints out the names of the
+        // elements specified on the command line.
+        //environment.getSpecifiedElements().forEach(System.out::println);
+
+        DocTrees docTrees = environment.getDocTrees();
+
+        CoverageReport docReport = new CoverageReport();
+
+
+        ArrayList<String> classnames = new ArrayList<>();
+
+        for (TypeElement typeElement : ElementFilter.typesIn(environment.getIncludedElements())) {
+
+            docReport.incrementTotalClasses();
+            classnames.add(typeElement.getQualifiedName().toString());
+
+            if (isDocumented(docTrees.getDocCommentTree(typeElement)))
+                docReport.incrementDocumentedClasses();
+
+            for (Element element : ElementFilter.methodsIn(typeElement.getEnclosedElements())) {
+                docReport.incrementTotalMethods();
+
+                if (isDocumented(docTrees.getDocCommentTree(element)))
+                    docReport.incrementDocumentedMethods();
+            }
+        }
+        log.info(classnames.size() + " classes found");
+        log.info("Documentation coverage report: " + docReport);
+        return OK;
+    }
+
+    public boolean isDocumented(DocCommentTree docCommentTree) {
+
+        return !(docCommentTree == null || docCommentTree.getFullBody().isEmpty());
+    }
+}

doc-coverage-doclet/src/main/java/de/fraunhofer/iem/coveragedoclet/CoverageReport.java

@@ -0,0 +1,62 @@
+package de.fraunhofer.iem.coveragedoclet;
+
+import java.text.DecimalFormat;
+
+public class CoverageReport {
+
+    private int totalClasses;
+    private int documentedClasses;
+    private int totalMethods;
+    private int documentedMethods;
+
+    public int getTotalClasses() {
+        return totalClasses;
+    }
+
+    public void incrementTotalClasses() {
+        this.totalClasses++;
+    }
+
+    public int getDocumentedClasses() {
+        return documentedClasses;
+    }
+
+    public void incrementDocumentedClasses() {
+        this.documentedClasses++;
+    }
+
+    public int getTotalMethods() {
+        return totalMethods;
+    }
+
+    public void incrementTotalMethods() {
+        this.totalMethods++;
+    }
+
+    public int getDocumentedMethods() {
+        return documentedMethods;
+    }
+
+    public void incrementDocumentedMethods() {
+        this.documentedMethods++;
+    }
+
+    public double getCoveragePercent() {
+
+        double covPercent = (double) (documentedClasses + documentedMethods) / (totalClasses + totalMethods) * 100.0;
+        DecimalFormat format_2Places = new DecimalFormat("0.00");
+
+       return Double.parseDouble(format_2Places.format(covPercent));
+    }
+
+    @Override
+    public String toString() {
+        return "DocCoverageReport{" +
+                "totalClasses=" + totalClasses +
+                ", documentedClasses=" + documentedClasses +
+                ", totalMethods=" + totalMethods +
+                ", documentedMethods=" + documentedMethods +
+                ", coveragePercent=" + getCoveragePercent() +
+                '}';
+    }
+}

doc-coverage-doclet/src/main/java/de/fraunhofer/iem/coveragedoclet/Main.java

@@ -0,0 +1,20 @@
+package de.fraunhofer.iem.coveragedoclet;
+
+import javax.tools.DocumentationTool;
+import javax.tools.ToolProvider;
+
+public class Main {
+
+    public static void main(String[] args) {
+
+        String[] docletArgs = new String[]{
+                "-doclet", CoverageDoclet.class.getName(),
+                "-docletpath", "target/classes/",
+                "-sourcepath", "source-jars/",
+                "-subpackages", "org.owasp.encoder",
+        };
+
+        DocumentationTool docTool = ToolProvider.getSystemDocumentationTool();
+        docTool.run(System.in, System.out, System.err, docletArgs);
+    }
+}