including gzoltar support and other changes

Author: s-edwards

.gitignore

@@ -4,3 +4,5 @@ webcat-support-*.*
 src/fikin/*.jar
 src/jacoco/*.jar
 src/defaultJars/*.jar
+src/JavaTddPluginSupport.jar
+src/junit-4.8.2.jar

Properties

@@ -1,6 +1,6 @@
 #This file is automatically rewritten by ANT.  Hand-edits may be lost.
-#Fri Nov 17 08:35:39 EST 2017
-version.minor=0
+#Sun Feb 25 22:29:07 GMT-05:00 2018
+version.minor=1
 timeoutMultiplier=2
 license.url="http\://www.gnu.org/licenses/agpl.html"
 author="Stephen Edwards (edwards@cs.vt.edu)"
@@ -11,10 +11,10 @@ interpreter.prefix="${PerlForPlugins.perl.exe}"
 languages=( { name \= Java; version \= 1.4
 autoPublish=true
 version.major=4
-version.date=20171117
+version.date=20180225
 timeoutInternalPadding=400
 provider="Virginia Tech Computer Science"
 authorUid=edwards
 provider.url="http\://web-cat.cs.vt.edu/updates"
-version.revision=8
+version.revision=0
 name="JavaTddPlugin"

src/.cvsignore

@@ -12,6 +12,7 @@
             value="${pluginHome}/checkstyle.xml"/>
   <property name="jacoco.db"            value="${resultDir}/jacoco.db"/>
   <property name="defaultJars"          value="${pluginHome}/defaultJars"/>
+  <property name="zoltarJars"           value="${pluginHome}/gzoltar"/>
   <property name="enableAssertions"     value="-ea"/>
   <property name="enscriptStyle"        value="msvc"/>
   <property name="instr.results.dir"    value="${resultDir}/instr.results"/>
@@ -115,6 +116,13 @@
     <pathelement location="${studentBuild}.raw"/>
   </path>
 
+  <path id="zoltar.classpath">
+    <path refid="student.classpath"/>
+    <fileset dir="${zoltarJars}">
+      <include name="**/*.jar"/>
+    </fileset>
+  </path>
+
   <path id="checkstyle.classpath">
     <pathelement location="${checkstyle.jar}"/>
     <path refid="student.classpath"/>
@@ -233,8 +241,10 @@ staticAnalysisSrcExclusionPattern = ${staticAnalysisSrcExclusionPattern}
       <classpath refid="instructor.classpath"/>
       <src path="${testCasePath}"/>
       <include name="${testCasePattern}"/>
+      <!--
       <src path="${visibleTestCasePath}"/>
       <include name="${visibleTestCasePattern}"/>
+      -->
     </javac>
   </target>
 
@@ -431,6 +441,58 @@ staticAnalysisSrcExclusionPattern = ${staticAnalysisSrcExclusionPattern}
   </target>
 
 
+  <target name="zoltar" if="generateHeatmaps">
+    <!--
+    <fileset
+      dir="${studentBuild}.raw"
+      casesensitive="false"
+      includes="${studentTestClassPattern}"
+      excludes="${studentTestClassExclusionPattern}"
+      id="student.test.files"/>
+    <pathconvert
+      pathsep=","
+      property="student.test.files.list"
+      refid="student.test.files"/>
+    -->
+
+    <java fork="true" classname="org.webcat.plugins.javatddplugin.ZoltarTest">
+      <assertions enablesystemassertions="true"/>
+      <classpath refid="zoltar.classpath"/>
+      <jvmarg value="-Xms128m"/>
+      <jvmarg value="-Xmx512m"/>
+
+      <sysproperty key="student.testingsupport.junit4.AdaptiveTimeout.ceiling"
+        value="${student.testingsupport.junit4.AdaptiveTimeout.ceiling}"/>
+      <sysproperty key="student.testingsupport.junit4.AdaptiveTimeout.maximum"
+        value="${student.testingsupport.junit4.AdaptiveTimeout.maximum}"/>
+      <sysproperty key="student.testingsupport.junit4.AdaptiveTimeout.minimum"
+        value="${student.testingsupport.junit4.AdaptiveTimeout.minimum}"/>
+      <sysproperty key="student.testingsupport.junit4.AdaptiveTimeout.threshold"
+        value="${student.testingsupport.junit4.AdaptiveTimeout.threshold}"/>
+      <sysproperty key="student.testingsupport.junit4.AdaptiveTimeout.rampup"
+        value="${student.testingsupport.junit4.AdaptiveTimeout.rampup}"/>
+      <sysproperty key="student.testingsupport.junit4.AdaptiveTimeout.rampdown"
+        value="${student.testingsupport.junit4.AdaptiveTimeout.rampdown}"/>
+
+      <sysproperty key="gzoltar.xml.output" value="${resultDir}/gzoltar.xml"/>
+      <sysproperty key="gzoltar.csv.output" value="${resultDir}/gzoltar.csv"/>
+      <sysproperty key="gzoltar.student.pid"
+        value="${userInstitution},${semester},${course},${CRN},${assignment},${userName},${submissionNo}"/>
+      <sysproperty key="gzoltar.student.bin" value="${studentBuild}.raw"/>
+      <sysproperty key="gzoltar.tests.dir" value="${instructorBuild}"/>
+      <sysproperty key="gzoltar.libs" value="${toString:student.classpath}"/>
+    </java>
+
+    <java classname="org.webcat.plugins.javatddplugin.ZoltarHeatmap">
+      <assertions enablesystemassertions="true"/>
+      <classpath refid="zoltar.classpath"/>
+      <sysproperty key="gzoltar.xml.input" value="${resultDir}/gzoltar.xml"/>
+      <sysproperty key="gzoltar.html.output" value="${resultDir}/gzoltar.html"/>
+      <sysproperty key="gzoltar.source.dir" value="${basedir}"/>
+    </java>
+  </target>
+
+
   <target name="checkstyle"
   	unless="disableCheckstyle">
     <taskdef resource="com/puppycrawl/tools/checkstyle/ant/checkstyle-ant-task.properties"
@@ -532,6 +594,30 @@ staticAnalysisSrcExclusionPattern = ${staticAnalysisSrcExclusionPattern}
   </target>
 
 
+  <target name="remote.post" if="remote.post.url">
+    <pathconvert property="post.file.list" pathsep="${line.separator}">
+      <fileset dir="${resultDir}/.." includes="*.*"/>
+    </pathconvert>
+    <loadresource property="post.file.name">
+      <string value="${post.file.list}"/>
+      <filterchain><headfilter lines="1"/></filterchain>
+    </loadresource>
+    <echo message="post file: ${post.file.name}"/>
+    <httpmpost url="${remote.post.url}"
+      logFile="${resultDir}/remote.post.html"
+      logLevel="content"
+      shutdown="true"
+      failOnError="false"
+      retryAttempts="2"
+      sslAcceptUntrusted="true"
+      >
+      <userCredentials username="admin0" password="0admin" domain="" host="courses.cs.vt.edu"/>
+      <postString name="user" value="${userName}"/>
+      <postFile name="uploadedfile" file="${post.file.name}"/>
+    </httpmpost>
+  </target>
+
+
   <target name="generate.pdf"
           description="generates a pdf printout of student's source code"
           if="generatePDF">
@@ -615,9 +701,9 @@ staticAnalysisSrcExclusionPattern = ${staticAnalysisSrcExclusionPattern}
        The main target
        ============================================================ -->
 
-  <target name="test.bundle" depends="instructor.test, jacoco.report"/>
+  <target name="test.bundle" depends="instructor.test, jacoco.report, zoltar"/>
   <target name="checkstyle.bundle"
-    depends="checkstyle, run.comtor, generate.pdf, generate.diagrams"/>
+    depends="checkstyle, run.comtor, remote.post, generate.pdf, generate.diagrams"/>
 
   <target name="sequential.middle" depends="compile" if="run.sequential">
   	<echo message="Running steps sequentially ..."/>

src/JavaTddPluginSupport.jar

@@ -408,12 +408,10 @@
     <!-- <module name="FinalClass"/> -->
     <!-- <module name="HideUtilityClassConstructor"/> -->
     <!-- <module name="InterfaceIsType"/> -->
-    <!--
     <module name="VisibilityModifier">
       <message key="variable.notPrivate"
         value="The field ''{0}'' should be declared private.  Only constants (static final fields) are allowed to be public.  If this field is intended to represent a constant value, declare it to be static and final."/>
     </module>
-    -->
 
 
     <!-- Miscellaneous other checks.                   -->

src/build.xml

@@ -1,9 +1,9 @@
 {
     name             = "JavaTddPlugin";
     version.major    = 4;
-    version.minor    = 0;
-    version.revision = 8;
-    version.date     = 20160906;
+    version.minor    = 1;
+    version.revision = 0;
+    version.date     = 20180225;
     autoPublish      = true;
     requires         = ( ANTForPlugins, PerlForPlugins,
                          PMDForPlugins, CheckstyleForPlugins );
@@ -12,7 +12,7 @@
     license          = "GNU Affero General Public License v.3";
     license.url      = "http://www.gnu.org/licenses/agpl.html";
     copyright        =
-        "(c) 2006-2016 Virginia Tech Department of Computer Science";
+        "(c) 2006-2018 Virginia Tech Department of Computer Science";
     info.url         = "http://wiki.web-cat.org/WCWiki/JavaTddPlugin";
     history.url      =
         "http://wiki.web-cat.org/WCWiki/JavaTddPlugin/ChangeHistory";
@@ -165,6 +165,20 @@
   run-time.  Leave unset to use the built-in default, which plugs most
   security holes and prevents any file system access outside the subtree
   rooted at the program's working directory.";
+        },
+        {
+            property    = remote.post.url;
+            advanced    = true;
+            type        = shortText;
+            size        = 40;
+            name        = "Remotely Post Submissions";
+            category    = "Advanced Settings";
+            description =
+  "A URL to which submissions will be posted as they are processed, to
+  allow for external tools to receive student submissions.  If a URL is
+  specified an HTML POST request will be sent to the given URL, with the
+  student's user name provided in the parameter 'user', and the student's
+  submission file provided in the parameter 'uploadedfile'.";
         },
         {
             property    = "grader.partnerExcludePatterns";
@@ -651,6 +665,17 @@
   files are deleted when a given submission has been completely processed.
   This setting is provided for debugging purposes, when one wishes to
   inspect the intermediate test driver source code or other derived files.";
+        },
+        {
+            property    = generateHeatmaps;
+            type        = antBoolean;
+            advanced    = true;
+            name        = "Generate Bug Heatmaps";
+            category    = "Developer Settings";
+            description =
+  "Set to true to generate GZoltar-based defect heatmaps.  This option is
+  <b>experimental</b> and for research use only.  Using it will slow down
+  generation of student feedback.";
         }
     );
     globalOptions = (

src/checkstyle.xml

@@ -3122,6 +3122,22 @@ sub extractExemptLines
     }
     elsif ($status{'instrTestResults'}->allTestsFail)
     {
+        my $hints = $status{'instrTestResults'}->formatHints(
+            1, $hintsLimit);
+    print "hints = $hints\n";
+        if (defined $hints && $hints ne "" && $hints =~ /honor code viol/i)
+        {
+            $hints =~ s/<p>Failure during test case setup[^<]*<\/p>//g;
+            $hints =~ s/symptom: [^\s]*:\s*//g;
+            $hints =~ s/\s*expected: \S*false\S* but was: \S*true\S*//g;
+            $hints =~ s/<pre>/<p>/g;
+            $hints =~ s/<\/pre>/<\/p>/g;
+        $status{'feedback'}->print(<<EOF);
+<p><b class="warn">$hints</b></p>
+EOF
+    }
+        else
+        {
         $status{'feedback'}->print(<<EOF);
 <p><b class="warn">Your problem setup does not appear to be
 consistent with the assignment.</b></p>
@@ -3152,6 +3168,7 @@ sub extractExemptLines
 <p>Double check that you have carefully followed all initial conditions
 requested in the assignment in setting up your solution.</p>
 EOF
+        }
     }
     elsif ($status{'instrTestResults'}->allTestsPass)
     {
@@ -3365,6 +3382,7 @@ sub extractExemptLines
 
 # First, the static analysis, tool-based score
 my $staticScore  = $maxToolScore - $status{'toolDeductions'};
+my $show_gzoltar = ($instructorCasesPercent < 10) ? 0 : 1;
 
 # Second, the coverage/testing/correctness component
 my $runtimeScore = $runtimeScoreWithoutCoverage;
@@ -3374,6 +3392,11 @@ sub extractExemptLines
     {
         my $multiplier = $gradedElementsCovered * 1.0 / $gradedElements
             / $coverageGoal;
+        if ($multiplier * 100.0 < $minCoverageLevel)
+        {
+            # print "multiplier = $multiplier\n";
+            $show_gzoltar = 0;
+        }
         if ($multiplier < 1.0)
         {
             $runtimeScore *= $multiplier;
@@ -3394,6 +3417,41 @@ sub extractExemptLines
 #     : 0;
 
 
+#=============================================================================
+# Include zoltar info, if present.
+#=============================================================================
+
+my $gzoltar_file = "${resultDir}/gzoltar.html";
+# print "instructor cases = $instructorCasesPercent, show = $show_gzoltar\n";
+if ($show_gzoltar && -f $gzoltar_file && ! -z $gzoltar_file)
+{
+    # print "starting feedback section\n";
+    $status{'feedback'}->startFeedbackSection(
+        "Heatmap of Suspicious Code",
+        ++$expSectionId);
+    $status{'feedback'}->print(<<EOF);
+<p>
+This color-coded view of your source code shows the <b>most suspicious</b>
+areas in your program--the lines that are most strongly associated with
+failing reference tests provided by your instructor.</p>
+<p>
+The lines highlighted in color are hints for place(s) you can look for
+bugs, with lines that are darker or more red being more suspicious.  Only
+classes containing suspicious lines are shown.</p>
+<p>
+Hover your mouse over colored lines to see line numbers.</p>
+EOF
+    open(GZOLTAR, $gzoltar_file);
+    my $line;
+    while ($line = <GZOLTAR>)
+    {
+        $status{'feedback'}->print($line);
+    }
+    close(GZOLTAR);
+    $status{'feedback'}->endFeedbackSection;
+}
+
+
 #=============================================================================
 # generate score explanation for student
 #=============================================================================