diff --git a/.gitignore b/.gitignore index a1c2a23..d1f1ea8 100644 --- a/.gitignore +++ b/.gitignore @@ -21,3 +21,13 @@ # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml hs_err_pid* + +# gradle files +.gradle +build + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# IDEA project files +.idea diff --git a/PMDRuleSet.xml b/PMDRuleSet.xml new file mode 100644 index 0000000..0559942 --- /dev/null +++ b/PMDRuleSet.xml @@ -0,0 +1,40 @@ + + + + + + My custom rules + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..6dfe060 --- /dev/null +++ b/build.gradle @@ -0,0 +1,36 @@ +apply plugin: 'java' +apply plugin: 'application' +apply plugin: 'pmd' + +group 'com.github' +version '1.0-SNAPSHOT' + +repositories { + mavenCentral() +} + +dependencies { + implementation('net.sourceforge.pmd:pmd-java:6.29.0') + implementation('info.picocli:picocli:4.5.2') + implementation('com.opencsv:opencsv:5.2') + implementation("com.google.guava:guava:30.1-jre") + + testImplementation(platform('org.junit:junit-bom:5.7.0')) + testImplementation('org.junit.jupiter:junit-jupiter') + + testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.7.0") +} + +pmd { + consoleOutput = true + ruleSetFiles = files("PMDRuleSet.xml") + toolVersion = "6.29.0" +} + +test { + useJUnitPlatform() +} + +application { + mainClassName = 'com.github.emcat.Emcat' +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..62d4c05 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..a4b4429 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.3-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..fbd7c51 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# 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 +# +# https://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. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..a9f778a --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,104 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..bd65c73 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'emcat' + diff --git a/src/main/java/com/github/emcat/Emcat.java b/src/main/java/com/github/emcat/Emcat.java new file mode 100644 index 0000000..854dce6 --- /dev/null +++ b/src/main/java/com/github/emcat/Emcat.java @@ -0,0 +1,167 @@ +package com.github.emcat; + +import com.github.emcat.source_code_method.SourceCodeMethod; +import com.github.emcat.source_code_method.SourceCodeMethodDescriptor; +import com.github.emcat.source_code_method.SourceCodeMethodFactory; +import com.opencsv.bean.*; +import com.opencsv.exceptions.CsvDataTypeMismatchException; +import com.opencsv.exceptions.CsvRequiredFieldEmptyException; +import net.sourceforge.pmd.lang.ast.ParseException; +import org.apache.commons.collections.comparators.FixedOrderComparator; +import picocli.CommandLine; +import picocli.CommandLine.Option; +import picocli.CommandLine.Command; + +import java.io.*; +import java.nio.file.FileVisitOption; +import java.nio.file.Files; +import java.nio.file.Path; +import java.util.List; +import java.util.NoSuchElementException; +import java.util.stream.Collectors; + +import static java.lang.Integer.MAX_VALUE; + +@Command( + name = "emcat", + mixinStandardHelpOptions = true, + description = "Calculates NCSS and Cyclomatic complexity of Java methods.", + version = "1.0" +) +public class Emcat { + @Command(mixinStandardHelpOptions = true, description = "Calculates metric of single method and print to output") + public int single( + @Option(names = {"-f", "--file"}, required = true, description = "File path to Java source code to analyze") + final String sourceCodeFilePath, + @Option(names = {"-c", "--class_name"}, required = true, description = "Name of the class to analyze") + final String className, + @Option(names = {"-m", "--method_name"}, required = true, description = "Method name to analyze") + final String methodName + ) throws IOException { + final SourceCodeMethodDescriptor methodDescriptor = new SourceCodeMethodDescriptor( + sourceCodeFilePath, + className, + methodName + ); + + final SourceCodeMethod method = SourceCodeMethodFactory.createSourCodeMethod(methodDescriptor); + + System.out.println("NCSS: " + method.getNcss()); + System.out.println("Cyclomatic complexity: " + method.getCyclomaticComplexity()); + return 0; + + } + + @Command(mixinStandardHelpOptions = true, description = "Calculate metrics of all method described in batch file") + public int batch( + @Option(names = {"-f", "--file"}, required = true, description = "File path to CSV file") + final String batchFilePath, + @Option(names = {"-o", "--output"}, required = true, description = "Path to output file") + final String outputPath + ) throws IOException, CsvDataTypeMismatchException, CsvRequiredFieldEmptyException { + if (batchFilePath.equals(outputPath)) { + System.err.println("ERROR: Output file can't be the same as batch input file."); + return 2; + } + + try ( + Reader batchRawInput = new FileReader(batchFilePath); + Writer batchRawOutput = new FileWriter(new File(outputPath)) + ) { + final CsvToBean batchInput = createBatchInput(batchRawInput); + + @SuppressWarnings("PMD.DataflowAnomalyAnalysis") + final StatefulBeanToCsv batchOutput = createBatchOutput(batchRawOutput); + + for (final SourceCodeMethodDescriptor methodDescriptor : batchInput.parse()) { + try { + final SourceCodeMethod method = SourceCodeMethodFactory.createSourCodeMethod(methodDescriptor); + batchOutput.write(method); + } + catch (NoSuchElementException | IOException | ParseException e) { + System.err.println("WARNING: " + e); + } + } + + return 0; + } + } + + @Command(mixinStandardHelpOptions = true, description = "Finds all methods in all files in file tree under provided directory ") + public int discover( + @Option( + names = {"-d", "--directory"}, + required = true, + description = "Root directory of discovery, keeps files with '.java' extension only" + ) + final String rootPath, + @Option(names = {"-o", "--output"}, required = true, description = "Path to output file") + final String outputPath + ) throws IOException, CsvDataTypeMismatchException, CsvRequiredFieldEmptyException { + try (Writer batchRawOutput = new FileWriter(new File(outputPath))) { + @SuppressWarnings("PMD.DataflowAnomalyAnalysis") + final StatefulBeanToCsv output = createBatchOutput(batchRawOutput); + + final List paths = Files.find( + Path.of(rootPath), + MAX_VALUE, + (path, attrs) -> path.toString().endsWith(".java"), + FileVisitOption.FOLLOW_LINKS + ) + .collect(Collectors.toList()); + + for (final Path path : paths) { + try { + output.write(SourceCodeMethodFactory.createAllSourceCodeMethodFromFile(String.valueOf(path))); + } + catch (IOException | ParseException e) { + System.err.println("WARNING: " + e); + } + } + + return 0; + } + } + + @SuppressWarnings("PMD.DoNotCallSystemExit") + public static void main(final String... args) { + System.exit(new CommandLine(new Emcat()).execute(args)); + } + + private static CsvToBean createBatchInput(final Reader batchRawInput) { + final HeaderColumnNameMappingStrategy columnNameOrder = + new HeaderColumnNameMappingStrategy<>(); + + columnNameOrder.setType(SourceCodeMethodDescriptor.class); + columnNameOrder.setColumnOrderOnWrite( + new FixedOrderComparator(new String[]{ + "FILE_PATH", + "CLASS_NAME", + "METHOD_NAME" + }) + ); + + return new CsvToBeanBuilder(batchRawInput) + .withType(SourceCodeMethodDescriptor.class) + .withMappingStrategy(columnNameOrder) + .build(); + } + + private static StatefulBeanToCsv createBatchOutput(final Writer batchRawOutput) { + final HeaderColumnNameMappingStrategy columnNameOrder = new HeaderColumnNameMappingStrategy<>(); + columnNameOrder.setType(SourceCodeMethod.class); + columnNameOrder.setColumnOrderOnWrite( + new FixedOrderComparator(new String[]{ + "FILE_PATH", + "CLASS_NAME", + "METHOD_NAME", + "NCSS", + "CYCLOMATIC_COMPLEXITY" + }) + ); + + return new StatefulBeanToCsvBuilder(batchRawOutput) + .withMappingStrategy(columnNameOrder) + .build(); + } +} diff --git a/src/main/java/com/github/emcat/source_code_method/SourceCodeMethod.java b/src/main/java/com/github/emcat/source_code_method/SourceCodeMethod.java new file mode 100644 index 0000000..87f096b --- /dev/null +++ b/src/main/java/com/github/emcat/source_code_method/SourceCodeMethod.java @@ -0,0 +1,50 @@ +package com.github.emcat.source_code_method; + +import com.opencsv.bean.CsvBindByName; + +import net.sourceforge.pmd.lang.java.ast.ASTMethodDeclaration; +import net.sourceforge.pmd.lang.java.metrics.impl.CycloMetric; +import net.sourceforge.pmd.lang.java.metrics.impl.NcssMetric; +import net.sourceforge.pmd.lang.metrics.MetricOptions; + +public class SourceCodeMethod extends SourceCodeMethodDescriptor { + @CsvBindByName(column = "NCSS") + private final transient int ncss; + + @CsvBindByName(column = "CYCLOMATIC_COMPLEXITY") + private final transient int cyclomaticComplexity; + + private final static CycloMetric CYCLOMATIC_COMPLEXITY_CALCULATOR = new CycloMetric(); + + private final static NcssMetric.NcssOperationMetric NCSS_CALCULATOR = new NcssMetric.NcssOperationMetric(); + + public SourceCodeMethod( + final SourceCodeMethodDescriptor sourceCodeMethodDescriptor, + final ASTMethodDeclaration astMethodDeclarationNode + ) { + super(sourceCodeMethodDescriptor); + + this.ncss = (int) NCSS_CALCULATOR.computeFor(astMethodDeclarationNode, MetricOptions.emptyOptions()); + this.cyclomaticComplexity = (int) CYCLOMATIC_COMPLEXITY_CALCULATOR.computeFor( + astMethodDeclarationNode, + MetricOptions.emptyOptions() + ); + } + + public SourceCodeMethod( + final String filePath, + final String className, + final String methodName, + final ASTMethodDeclaration astMethodDeclarationNode + ) { + this( new SourceCodeMethodDescriptor(filePath, className, methodName), astMethodDeclarationNode); + } + + public int getNcss() { + return ncss; + } + + public int getCyclomaticComplexity() { + return cyclomaticComplexity; + } +} diff --git a/src/main/java/com/github/emcat/source_code_method/SourceCodeMethodDescriptor.java b/src/main/java/com/github/emcat/source_code_method/SourceCodeMethodDescriptor.java new file mode 100644 index 0000000..f17f962 --- /dev/null +++ b/src/main/java/com/github/emcat/source_code_method/SourceCodeMethodDescriptor.java @@ -0,0 +1,84 @@ +package com.github.emcat.source_code_method; + +import com.opencsv.bean.CsvBindByName; + +import java.util.Objects; + +// TODO: Add line number to support overloaded methods and constructors +// TODO: Add text range as extraction opportunity +@SuppressWarnings("PMD.DataClass") +public class SourceCodeMethodDescriptor { + @CsvBindByName(column = "FILE_PATH") + private String filePath; + + @CsvBindByName(column = "CLASS_NAME") + private String className; + + @CsvBindByName(column = "METHOD_NAME") + private String methodName; + + public SourceCodeMethodDescriptor( + final String filePath, + final String className, + final String methodName + ) { + this.filePath = filePath; + this.className = className; + this.methodName = methodName; + } + + public SourceCodeMethodDescriptor() { + this("", "", ""); + } + + public SourceCodeMethodDescriptor(final SourceCodeMethodDescriptor sourceCodeMethodDescriptor) { + this.filePath = sourceCodeMethodDescriptor.getFilePath(); + this.className = sourceCodeMethodDescriptor.getClassName(); + this.methodName = sourceCodeMethodDescriptor.getMethodName(); + } + + public String getFilePath() { + return filePath; + } + + public void setFilePath(final String filePath) { + this.filePath = filePath; + } + + public String getClassName() { + return className; + } + + public void setClassName(final String className) { + this.className = className; + } + + public String getMethodName() { + return methodName; + } + + public void setMethodName(final String methodName) { + this.methodName = methodName; + } + + @Override + public boolean equals(final Object obj) { + if (obj == this) { + return true; + } + + if (!(obj instanceof SourceCodeMethodDescriptor)) { + return false; + } + + final SourceCodeMethodDescriptor methodDescriptor = (SourceCodeMethodDescriptor) obj; + return filePath.equals(methodDescriptor.getFilePath()) && + className.equals(methodDescriptor.getClassName()) && + methodName.equals(methodDescriptor.getMethodName()); + } + + @Override + public int hashCode() { + return Objects.hash(filePath, className, methodName); + } +} diff --git a/src/main/java/com/github/emcat/source_code_method/SourceCodeMethodFactory.java b/src/main/java/com/github/emcat/source_code_method/SourceCodeMethodFactory.java new file mode 100644 index 0000000..ec89bae --- /dev/null +++ b/src/main/java/com/github/emcat/source_code_method/SourceCodeMethodFactory.java @@ -0,0 +1,104 @@ +package com.github.emcat.source_code_method; + +import net.sourceforge.pmd.lang.Parser; +import net.sourceforge.pmd.lang.ParserOptions; +import net.sourceforge.pmd.lang.java.JavaLanguageModule; +import net.sourceforge.pmd.lang.java.ast.*; + +import com.google.common.collect.Streams; +import org.apache.commons.lang3.NotImplementedException; + +import java.io.FileReader; +import java.io.IOException; +import java.io.Reader; +import java.util.ArrayList; +import java.util.List; +import java.util.NoSuchElementException; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +public final class SourceCodeMethodFactory { + private static final Parser JAVA_PARSER = new JavaLanguageModule() + .getDefaultVersion() + .getLanguageVersionHandler() + .getParser(new ParserOptions()); + + public static SourceCodeMethod createSourCodeMethod( + final SourceCodeMethodDescriptor methodDescriptor + ) throws IOException { + final ASTCompilationUnit compilationUnit = getCompilationUnit(methodDescriptor.getFilePath()); + + final ASTClassOrInterfaceDeclaration classDeclaration = getAllAstCLassDeclarations(compilationUnit) + .stream() + .filter(cd -> cd.getSimpleName().equals(methodDescriptor.getClassName())) + .findFirst() + .orElseThrow(() -> new NoSuchElementException( + String.format( + "Can't find class %s in file %s.", + methodDescriptor.getClassName(), + methodDescriptor.getFilePath()) + )); + + final ASTMethodDeclaration methodDeclaration = getAllAstMethodDeclarations(classDeclaration) + .stream() + .filter(md -> md.getName().equals(methodDescriptor.getMethodName())) + .findFirst() + .orElseThrow(() -> new NoSuchElementException( + String.format( + "Can't find method %s in class %s in file %s", + methodDescriptor.getMethodName(), + methodDescriptor.getClassName(), + methodDescriptor.getFilePath()) + )); + + return new SourceCodeMethod(methodDescriptor, methodDeclaration); + } + + public static List createAllSourceCodeMethodFromFile(final String filePath) throws IOException { + final ASTCompilationUnit compilationUnit = getCompilationUnit(filePath); + final List methods = new ArrayList<>(); + for (final ASTClassOrInterfaceDeclaration classDeclaration : getAllAstCLassDeclarations(compilationUnit)) { + for (final ASTMethodDeclaration methodDeclaration : getAllAstMethodDeclarations(classDeclaration)) { + methods.add( + new SourceCodeMethod( + filePath, + classDeclaration.getSimpleName(), + methodDeclaration.getName(), + methodDeclaration + ) + ); + } + } + + return methods; + } + + private static List getAllAstMethodDeclarations(final ASTClassOrInterfaceDeclaration classDeclaration) { + return classDeclaration.getDeclarations() + .stream() + .filter(declaration -> declaration.getKind() == ASTAnyTypeBodyDeclaration.DeclarationKind.METHOD) + .map(declaration -> (ASTMethodDeclaration) declaration.getDeclarationNode()) + .collect(Collectors.toList()); + } + + private static List getAllAstCLassDeclarations(final ASTCompilationUnit compilationUnit) { + return Streams.stream(compilationUnit.children()) + .filter(item -> item instanceof ASTTypeDeclaration) + .map(item -> Streams.stream(item.children())) + .reduce(Stream.empty(), Streams::concat) + .filter(item -> item instanceof ASTClassOrInterfaceDeclaration) + .map(item -> (ASTClassOrInterfaceDeclaration) item) + .filter(declaration -> !declaration.isInterface()) + .collect(Collectors.toList()); + } + + private static ASTCompilationUnit getCompilationUnit(final String filename) throws IOException { + try (Reader sourceCodeReader = new FileReader(filename)) { + return (ASTCompilationUnit) JAVA_PARSER.parse(filename, sourceCodeReader); + } + } + + private SourceCodeMethodFactory() { + throw new NotImplementedException(); + } +} diff --git a/src/test/java/com/github/emcat/metric_calculators/JavaSourceCodeExample.java b/src/test/java/com/github/emcat/metric_calculators/JavaSourceCodeExample.java new file mode 100644 index 0000000..6ad0bdf --- /dev/null +++ b/src/test/java/com/github/emcat/metric_calculators/JavaSourceCodeExample.java @@ -0,0 +1,34 @@ +// This code is intended to be used as input to PMD Java parser +// and not used as a Java source file in this project + +package com.github.emcat.metric_calculators; + +@SuppressWarnings("all") +public class JavaSourceCodeExample { + /* + * Simple example of java class methods to test NCSS and Cyclomatic complexity calculation. + * Expected metrics values: + * - NCSS = 5 + * - Cyclomatic complexity = 2 + */ + public int methodExample() { // NCSS: +1, Cyclomatic: +0 + int x = 0; // NCSS: +1, Cyclomatic: +0 + + for (int i = 0; i < 10; i++) { // NCSS: +1, Cyclomatic: +1 + x += i; // NCSS: +1, Cyclomatic: +1 + } + + return x; // NCSS: +1, Cyclomatic: +0 + } + + public int anotherMethod() { + return 0; + } +} + +@SuppressWarnings("PMD") +class AnotherClass { + public int someMethod() { + return 0; + } +} diff --git a/src/test/java/com/github/emcat/metric_calculators/SourceCodeMethodFactoryTest.java b/src/test/java/com/github/emcat/metric_calculators/SourceCodeMethodFactoryTest.java new file mode 100644 index 0000000..5268222 --- /dev/null +++ b/src/test/java/com/github/emcat/metric_calculators/SourceCodeMethodFactoryTest.java @@ -0,0 +1,106 @@ +package com.github.emcat.metric_calculators; + +import com.github.emcat.source_code_method.SourceCodeMethodFactory; +import com.github.emcat.source_code_method.SourceCodeMethod; +import com.github.emcat.source_code_method.SourceCodeMethodDescriptor; +import org.junit.jupiter.api.Test; + +import java.io.IOException; +import java.util.List; +import java.util.NoSuchElementException; +import java.util.stream.Collectors; + +import static org.junit.jupiter.api.Assertions.*; + +@SuppressWarnings("PMD.LawOfDemeter") +public class SourceCodeMethodFactoryTest { + private final static String SOURCE_CODE_EXAMPLE_PATH = + "./src/test/java/com/github/emcat/metric_calculators/JavaSourceCodeExample.java"; + + private final static String CLASS_NAME = "JavaSourceCodeExample"; + + private final static String METHOD_NAME = "methodExample"; + + @Test + public void testMethodMetrics() throws IOException { + final SourceCodeMethodDescriptor sourceCodeMethodDescriptor = new SourceCodeMethodDescriptor( + SOURCE_CODE_EXAMPLE_PATH, + CLASS_NAME, + METHOD_NAME + ); + final SourceCodeMethod sourceCodeMethod = SourceCodeMethodFactory.createSourCodeMethod(sourceCodeMethodDescriptor); + + assertEquals(5, sourceCodeMethod.getNcss(), "Failed to calculate NCSS right"); + assertEquals(2, sourceCodeMethod.getCyclomaticComplexity(), "Failed to calculate Cyclomatic complexity right"); + } + + @Test + public void testNotExistingFile() { + final SourceCodeMethodDescriptor sourceCodeMethodDescriptor = new SourceCodeMethodDescriptor( + "NOT_EXISTING_FILE_PATH", + CLASS_NAME, + METHOD_NAME + ); + + assertThrows( + IOException.class, + () -> { + SourceCodeMethodFactory.createSourCodeMethod(sourceCodeMethodDescriptor); + }, + "Expects RunTimeException when looking for not existing file" + ); + } + + @Test + public void testNotExistingClass() { + final SourceCodeMethodDescriptor sourceCodeMethodDescriptor = new SourceCodeMethodDescriptor( + SOURCE_CODE_EXAMPLE_PATH, + "NOT_EXISTING_CLASS", + METHOD_NAME + ); + + assertThrows( + NoSuchElementException.class, + () -> { + SourceCodeMethodFactory.createSourCodeMethod(sourceCodeMethodDescriptor); + }, + "Expects RunTimeException when looking for not existing class" + ); + } + + @Test + public void testNotExistingMethod() { + final SourceCodeMethodDescriptor sourceCodeMethodDescriptor = new SourceCodeMethodDescriptor( + SOURCE_CODE_EXAMPLE_PATH, + CLASS_NAME, + "NOT_EXISTING_METHOD" + ); + + assertThrows( + NoSuchElementException.class, + () -> { + SourceCodeMethodFactory.createSourCodeMethod(sourceCodeMethodDescriptor); + }, + "Expects RunTimeException when looking for not existing method" + ); + } + + @Test + public void testDiscovery() throws IOException { + final List methods = SourceCodeMethodFactory.createAllSourceCodeMethodFromFile(SOURCE_CODE_EXAMPLE_PATH); + + final List methodDescriptors = methods + .stream() + .map(SourceCodeMethodDescriptor::new) + .collect(Collectors.toList()); + + final SourceCodeMethodDescriptor[] expectedMethodDescriptors = { + new SourceCodeMethodDescriptor(SOURCE_CODE_EXAMPLE_PATH, CLASS_NAME, METHOD_NAME), + new SourceCodeMethodDescriptor(SOURCE_CODE_EXAMPLE_PATH, CLASS_NAME, "anotherMethod"), + new SourceCodeMethodDescriptor(SOURCE_CODE_EXAMPLE_PATH, "AnotherClass", "someMethod") + }; + + assertArrayEquals(methodDescriptors.toArray(), expectedMethodDescriptors, "Failed to discover all methods"); + + } +}