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..996f3ae --- /dev/null +++ b/PMDRuleSet.xml @@ -0,0 +1,34 @@ + + + + + + My custom rules + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..6a251f1 --- /dev/null +++ b/build.gradle @@ -0,0 +1,53 @@ +apply plugin: 'java' +apply plugin: 'application' +apply plugin: 'pmd' + +group 'com.github.aravij' +version '0.1.0' + +repositories { + mavenCentral() +} + +dependencies { + implementation 'net.sourceforge.pmdpmd-java:6.29.0' + implementation 'info.picocli:picocli:4.5.2' + + 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") +} + +test { + useJUnitPlatform() +} + +application { + mainClassName = 'com.github.emcat.Emcat' + applicationDefaultJvmArgs = ["--enable-preview"] +} + +run{ + standardInput = System.in +} + +sourceCompatibility = 14 +targetCompatibility = 14 + +tasks.withType(JavaCompile) { + options.compilerArgs += '--enable-preview' +} + +tasks.withType(Test) { + jvmArgs += "--enable-preview" +} + +tasks.withType(JavaExec) { + jvmArgs += '--enable-preview' +} 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..621c120 --- /dev/null +++ b/src/main/java/com/github/emcat/Emcat.java @@ -0,0 +1,49 @@ +package com.github.emcat; + +import picocli.CommandLine; +import picocli.CommandLine.Option; +import picocli.CommandLine.Command; + +import java.util.concurrent.Callable; + +import com.github.emcat.metric_calculators.MethodDescriptor; +import com.github.emcat.metric_calculators.MethodMetricsAggregator; +import com.github.emcat.metric_calculators.MethodMetricsData; + +@Command(name = "emcat", description = "Calculates given NCSS and cyclomatic complexity of a given method.", version = "1.0") +public class Emcat implements Callable { + @Option(names = {"-f", "--file"}, required = true, description = "File path to Java source code to analyse") + private transient String sourceCodeFilePath; + + @Option(names = {"-c", "--class_name"}, required = true, description = "Name of the class to analyse") + private transient String className; + + @Option(names = {"-m", "--method_name"}, required = true, description = "Method name to analyse") + private transient String methodName; + + @Override + public Integer call() { + final MethodMetricsAggregator methodMetricsAggregator = new MethodMetricsAggregator(); + final MethodDescriptor methodDescriptor = new MethodDescriptor(sourceCodeFilePath, className, methodName); + final MethodMetricsData methodMetrics = methodMetricsAggregator.calculateSingleMethodMetrics(methodDescriptor); + + int exitCode; + if (methodMetrics == null) { + System.err.println("Failed to calculate metrics"); + System.err.println(methodMetricsAggregator.getException()); + exitCode = 1; + } + else + { + System.out.println("NCSS: " + methodMetrics.Ncss()); + System.out.println("Cyclomatic complexity: " + methodMetrics.CyclomaticComplexity()); + exitCode = 0; + } + + return exitCode; + } + + public static void main(final String... args) { + System.exit(new CommandLine(new Emcat()).execute(args));//NOPMD + } +} diff --git a/src/main/java/com/github/emcat/metric_calculators/MethodDescriptor.java b/src/main/java/com/github/emcat/metric_calculators/MethodDescriptor.java new file mode 100644 index 0000000..b9d2559 --- /dev/null +++ b/src/main/java/com/github/emcat/metric_calculators/MethodDescriptor.java @@ -0,0 +1,6 @@ +package com.github.emcat.metric_calculators; + +// TODO: Add line number to support overloaded methods and constructors +// TODO: Add text range as extraction opportunity +public record MethodDescriptor(String filepath, String className, String methodName) { +} diff --git a/src/main/java/com/github/emcat/metric_calculators/MethodMetricsAggregator.java b/src/main/java/com/github/emcat/metric_calculators/MethodMetricsAggregator.java new file mode 100644 index 0000000..b033be5 --- /dev/null +++ b/src/main/java/com/github/emcat/metric_calculators/MethodMetricsAggregator.java @@ -0,0 +1,75 @@ +package com.github.emcat.metric_calculators; + +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 java.io.FileReader; +import java.io.IOException; +import java.io.Reader; + +public class MethodMetricsAggregator { + public MethodMetricsData calculateSingleMethodMetrics(MethodDescriptor methodDescriptor) { + try { + exception = null; + + ASTMethodDeclaration methodDeclaration = getMethodDeclaration( + methodDescriptor.filepath(), + methodDescriptor.className(), + methodDescriptor.methodName() + ); + + return metricsCalculator.calculateMethodMetrics(methodDeclaration); + } + catch (Exception exception) { + this.exception = new MethodProcessingException(methodDescriptor, exception); + return null; + } + } + + public MethodProcessingException getException() { + return exception; + } + + private ASTMethodDeclaration getMethodDeclaration(String filename, String className, String methodName) throws IOException { + ASTClassOrInterfaceDeclaration classDeclaration = getClassDeclaration(filename, className); + for (ASTAnyTypeBodyDeclaration classInnerDeclaration : classDeclaration.getDeclarations()) { + if (classInnerDeclaration.getKind() == ASTAnyTypeBodyDeclaration.DeclarationKind.METHOD) { + ASTMethodDeclaration methodDeclaration = (ASTMethodDeclaration) classInnerDeclaration.getDeclarationNode(); + if (methodDeclaration.getName().equals(methodName)) { + return methodDeclaration; + } + } + } + + throw new RuntimeException(String.format("There is no method named %s in class named %s in file %s", methodName, className, filename)); + } + + private ASTClassOrInterfaceDeclaration getClassDeclaration(String filename, String className) throws IOException { + ASTCompilationUnit compilationUnit = getCompilationUnit(filename); + for (JavaNode child : compilationUnit.children()) { + if (child instanceof ASTTypeDeclaration) { + for (JavaNode grandChild : child.children()) { + if (grandChild instanceof ASTClassOrInterfaceDeclaration classDeclaration) { + if (!classDeclaration.isInterface() && classDeclaration.getSimpleName().equals(className)) { + return classDeclaration; + } + } + } + } + } + + throw new RuntimeException(String.format("There is no class named %s in file %s", className, filename)); + } + + private ASTCompilationUnit getCompilationUnit(String filename) throws IOException { + try (Reader sourceCodeReader = new FileReader(filename)) { + return (ASTCompilationUnit) javaParser.parse(filename, sourceCodeReader); + } + } + + private Parser javaParser = new JavaLanguageModule().getDefaultVersion().getLanguageVersionHandler().getParser(new ParserOptions()); + private MethodMetricsCalculator metricsCalculator = new MethodMetricsCalculator(); + private MethodProcessingException exception = null; +} diff --git a/src/main/java/com/github/emcat/metric_calculators/MethodMetricsCalculator.java b/src/main/java/com/github/emcat/metric_calculators/MethodMetricsCalculator.java new file mode 100644 index 0000000..e1f0d6b --- /dev/null +++ b/src/main/java/com/github/emcat/metric_calculators/MethodMetricsCalculator.java @@ -0,0 +1,18 @@ +package com.github.emcat.metric_calculators; + +import net.sourceforge.pmd.lang.java.ast.ASTMethodOrConstructorDeclaration; +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 MethodMetricsCalculator { + private final transient CycloMetric cyclomaticComplexityCalculator = new CycloMetric(); + private final transient NcssMetric.NcssOperationMetric ncssCalculator = new NcssMetric.NcssOperationMetric(); + + public MethodMetricsData calculateMethodMetrics(final ASTMethodOrConstructorDeclaration declarationNode) { + return new MethodMetricsData( + (int) ncssCalculator.computeFor(declarationNode, MetricOptions.emptyOptions()), + (int) cyclomaticComplexityCalculator.computeFor(declarationNode, MetricOptions.emptyOptions()) + ); + } +} diff --git a/src/main/java/com/github/emcat/metric_calculators/MethodMetricsData.java b/src/main/java/com/github/emcat/metric_calculators/MethodMetricsData.java new file mode 100644 index 0000000..8f5677e --- /dev/null +++ b/src/main/java/com/github/emcat/metric_calculators/MethodMetricsData.java @@ -0,0 +1,4 @@ +package com.github.emcat.metric_calculators; + +public record MethodMetricsData(int Ncss, int CyclomaticComplexity) { +} diff --git a/src/main/java/com/github/emcat/metric_calculators/MethodProcessingException.java b/src/main/java/com/github/emcat/metric_calculators/MethodProcessingException.java new file mode 100644 index 0000000..a263140 --- /dev/null +++ b/src/main/java/com/github/emcat/metric_calculators/MethodProcessingException.java @@ -0,0 +1,22 @@ +package com.github.emcat.metric_calculators; + +public class MethodProcessingException extends RuntimeException { + private final transient MethodDescriptor method; + private final transient Exception exception; + + private static final long serialVersionUID = -2272341134842435255L; + + public MethodProcessingException(final MethodDescriptor method, final Exception exception) { + super("Processing method:\n" + method + "\nFollowing error occurred:\n" + exception); + this.method = method; + this.exception = exception; + } + + public MethodDescriptor getMethodDescriptor() { + return method; + } + + public Exception getException() { + return exception; + } +} 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..af63962 --- /dev/null +++ b/src/test/java/com/github/emcat/metric_calculators/JavaSourceCodeExample.java @@ -0,0 +1,23 @@ +// 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 + } +} diff --git a/src/test/java/com/github/emcat/metric_calculators/MethodMetricsAggregatorTest.java b/src/test/java/com/github/emcat/metric_calculators/MethodMetricsAggregatorTest.java new file mode 100644 index 0000000..079b33c --- /dev/null +++ b/src/test/java/com/github/emcat/metric_calculators/MethodMetricsAggregatorTest.java @@ -0,0 +1,70 @@ +package com.github.emcat.metric_calculators; + +import org.junit.jupiter.api.Test; + +import java.io.FileNotFoundException; + +import static org.junit.jupiter.api.Assertions.*; + +@SuppressWarnings("PMD.LawOfDemeter") +public class MethodMetricsAggregatorTest { + @Test + public void testMethodMetrics() { + final MethodMetricsAggregator methodMetricsAggregator = new MethodMetricsAggregator(); + final MethodDescriptor methodDescriptor = new MethodDescriptor( + "./src/test/java/com/github/emcat/metric_calculators/JavaSourceCodeExample.java", + "JavaSourceCodeExample", + "methodExample" + ); + + final MethodMetricsData methodMetrics = methodMetricsAggregator.calculateSingleMethodMetrics(methodDescriptor); + assertNotNull(methodMetrics, "MethodMetrics is null\n" + methodMetricsAggregator.getException()); + assertEquals(5, methodMetrics.Ncss(), "Failed to calculate NCSS right"); + assertEquals(2, methodMetrics.CyclomaticComplexity(), "Failed to calculate Cyclomatic complexity right"); + } + + @Test + public void testNotExistingFile() { + final MethodMetricsAggregator methodMetricsAggregator = new MethodMetricsAggregator(); + final MethodDescriptor methodDescriptor = new MethodDescriptor( + "NOT_EXISTING_FILE_PATH", + "JavaSourceCodeExample", + "methodExample" + ); + + final MethodMetricsData methodMetrics = methodMetricsAggregator.calculateSingleMethodMetrics(methodDescriptor); + assertNull(methodMetrics, "There should be an error in methodMetricsAggregator, but methodMetrics is not null"); + assertEquals(methodMetricsAggregator.getException().getMethodDescriptor(), methodDescriptor, "Error from methodMetricsAggregator does not has the same method descriptor"); + assertEquals(methodMetricsAggregator.getException().getException().getClass(), FileNotFoundException.class, "Exception class must be \"FileNotFoundException\""); + } + + @Test + public void testNotExistingClass() { + final MethodMetricsAggregator methodMetricsAggregator = new MethodMetricsAggregator(); + final MethodDescriptor methodDescriptor = new MethodDescriptor( + "./src/test/java/com/github/emcat/metric_calculators/JavaSourceCodeExample.java", + "NOT_EXISTING_CLASS", + "methodExample" + ); + + final MethodMetricsData methodMetrics = methodMetricsAggregator.calculateSingleMethodMetrics(methodDescriptor); + assertNull(methodMetrics, "There should be an error in methodMetricsAggregator, but methodMetrics is not null"); + assertEquals(methodMetricsAggregator.getException().getMethodDescriptor(), methodDescriptor, "Error from methodMetricsAggregator does not has the same method descriptor"); + assertEquals(methodMetricsAggregator.getException().getException().getClass(), RuntimeException.class, "Exception class must be \"RuntimeException\""); + } + + @Test + public void testNotExistingMethod() { + final MethodMetricsAggregator methodMetricsAggregator = new MethodMetricsAggregator(); + final MethodDescriptor methodDescriptor = new MethodDescriptor( + "./src/test/java/com/github/emcat/metric_calculators/JavaSourceCodeExample.java", + "JavaSourceCodeExample", + "NOT_EXISTING_METHOD" + ); + + final MethodMetricsData methodMetrics = methodMetricsAggregator.calculateSingleMethodMetrics(methodDescriptor); + assertNull(methodMetrics, "There should be an error in methodMetricsAggregator, but methodMetrics is not null"); + assertEquals(methodMetricsAggregator.getException().getMethodDescriptor(), methodDescriptor, "Error from methodMetricsAggregator does not has the same method descriptor"); + assertEquals(methodMetricsAggregator.getException().getException().getClass(), RuntimeException.class, "Exception class must be \"RuntimeException\""); + } +}