Make MakePlugin more wonderful

nygrenh · nygrenh · commit 52cb0fa8dd4a · 2017-01-15T17:33:44.000+02:00
Seriously though, this fixes a permission problem that occurs when the
project template has an executable and zip packaging messes up the
permissions.
diff --git a/build-tools/pom.xml b/build-tools/pom.xml
@@ -2,7 +2,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>fi.helsinki.cs.tmc</groupId>
     <artifactId>build-tools</artifactId>
-    <version>0.7.3-SNAPSHOT</version>
+    <version>0.7.4-SNAPSHOT</version>
     <name>build-tools</name>
 
     <!-- Deploy to maven.testmycode.net/nexus -->
diff --git a/pom.xml b/pom.xml
@@ -3,7 +3,7 @@
 
     <groupId>fi.helsinki.cs.tmc</groupId>
     <artifactId>tmc-langs</artifactId>
-    <version>0.7.3-SNAPSHOT</version>
+    <version>0.7.4-SNAPSHOT</version>
     <packaging>pom</packaging>
     <name>tmc-langs</name>
     <url>http://testmycode.net</url>
diff --git a/tmc-langs-cli/pom.xml b/tmc-langs-cli/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <artifactId>tmc-langs</artifactId>
         <groupId>fi.helsinki.cs.tmc</groupId>
-        <version>0.7.3-SNAPSHOT</version>
+        <version>0.7.4-SNAPSHOT</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
diff --git a/tmc-langs-framework/pom.xml b/tmc-langs-framework/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>fi.helsinki.cs.tmc</groupId>
         <artifactId>tmc-langs</artifactId>
-        <version>0.7.3-SNAPSHOT</version>
+        <version>0.7.4-SNAPSHOT</version>
         <relativePath>../</relativePath>
     </parent>
     <properties>
diff --git a/tmc-langs-java/pom.xml b/tmc-langs-java/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>fi.helsinki.cs.tmc</groupId>
         <artifactId>tmc-langs</artifactId>
-        <version>0.7.3-SNAPSHOT</version>
+        <version>0.7.4-SNAPSHOT</version>
     </parent>
 
     <properties>
diff --git a/tmc-langs-make/pom.xml b/tmc-langs-make/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>fi.helsinki.cs.tmc</groupId>
         <artifactId>tmc-langs</artifactId>
-        <version>0.7.3-SNAPSHOT</version>
+        <version>0.7.4-SNAPSHOT</version>
     </parent>
 
     <properties>
diff --git a/tmc-langs-make/src/main/java/fi/helsinki/cs/tmc/langs/make/MakePlugin.java b/tmc-langs-make/src/main/java/fi/helsinki/cs/tmc/langs/make/MakePlugin.java
@@ -50,6 +50,12 @@ public final class MakePlugin extends AbstractLanguagePlugin {
     private static final String CANT_PARSE_EXERCISE_DESCRIPTION =
             "Couldn't parse exercise description.";
     private static final String COMPILE_FAILED_MESSAGE = "Failed to compile project.";
+    private static final String PERMISSION_MITIGATION_MESSAGE =
+            "Permission problems, cleaning and trying again.";
+    private static final String PERMISSIONS_FIX_FAILED_MESSAGE = "Fixing permission issues failed.";
+    private static final String RUNNING_WITHOUT_VALGRIND_MESSAGE =
+            "Trying to run tests without Valgrind.";
+    private static final String PERMISSION_PROBLEM_INDICATOR = "Permission denied";
 
     private static final Logger log = LoggerFactory.getLogger(MakePlugin.class);
 
@@ -166,13 +172,28 @@ public RunResult runTests(Path path) {
         try {
             runTests(path, withValgrind);
         } catch (Exception e) {
-            withValgrind = false;
-
-            try {
-                runTests(path, withValgrind);
-            } catch (Exception e1) {
-                log.error(e1.toString());
-                throw new RuntimeException(TEST_FAIL_MESSAGE);
+            // In case the folder has a test binary without the executable bit
+            if (e.getMessage().contains(PERMISSION_PROBLEM_INDICATOR)) {
+                log.info(PERMISSION_MITIGATION_MESSAGE);
+                clean(path);
+                try {
+                    runTests(path, withValgrind);
+                } catch (Exception e1) {
+                    log.info(PERMISSIONS_FIX_FAILED_MESSAGE);
+                    withValgrind = false;
+                }
+            } else {
+                withValgrind = false;
+            }
+            if (!withValgrind) {
+                // The system probably doesn't have Valgrind properly installed
+                log.info(RUNNING_WITHOUT_VALGRIND_MESSAGE);
+                try {
+                    runTests(path, withValgrind);
+                } catch (Exception e1) {
+                    log.error(e1.toString());
+                    throw new RuntimeException(TEST_FAIL_MESSAGE);
+                }
             }
         }
 
diff --git a/tmc-langs-make/src/test/java/fi/helsinki/cs/tmc/langs/make/MakePluginTest.java b/tmc-langs-make/src/test/java/fi/helsinki/cs/tmc/langs/make/MakePluginTest.java
@@ -246,4 +246,11 @@ public void isExerciseCorrectTypeDoesIsNotFooledByDirectoryNamedMakefile() throw
         Files.delete(make);
         Files.delete(parent);
     }
+
+    @Test
+    public void testProjectWithUnexecutableArtifacts() {
+        Path path = TestUtils.getPath(getClass(), "wrong-permissions");
+        RunResult result = makePlugin.runTests(path);
+        assertEquals(result.status, RunResult.Status.PASSED);
+    }
 }
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/Makefile b/tmc-langs-make/src/test/resources/wrong-permissions/Makefile
@@ -0,0 +1,29 @@
+MAIN_DIR = src
+TEST_DIR = test
+
+.PHONY: main test
+
+all: main test
+
+main:
+	$(MAKE) -C $(MAIN_DIR)
+
+test:
+	$(MAKE) -C $(TEST_DIR)
+
+clean:
+	rm -f tmc_available_points.txt tmc_test_results.xml valgrind.log file_with_exactly_128_bits.txt mockoutput mockinput
+	$(MAKE) -C $(MAIN_DIR) clean
+	$(MAKE) -C $(TEST_DIR) clean
+
+run-main:
+	$(MAKE) -C $(MAIN_DIR) run
+
+run-test:
+	$(MAKE) -C $(TEST_DIR) run
+
+run-test-with-valgrind:
+	$(MAKE) -C $(TEST_DIR) run-valgrind
+
+get-points:
+	$(MAKE) -C $(TEST_DIR) get-points
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/src/Makefile b/tmc-langs-make/src/test/resources/wrong-permissions/src/Makefile
@@ -0,0 +1,13 @@
+SRC_FILES=main.c source.c
+
+all: main
+
+main: $(SRC_FILES)
+	gcc -g -Wall -Wextra -pedantic -std=c99 -o $@ $(SRC_FILES) -lm
+
+clean:
+	rm -f main
+
+run: main
+	# Running our main function from file main.c
+	./main
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/src/main.c b/tmc-langs-make/src/test/resources/wrong-permissions/src/main.c
@@ -0,0 +1,7 @@
+#include <stdio.h>
+#include "source.h"
+
+int main()
+{
+    return 0;
+}
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/src/source.c b/tmc-langs-make/src/test/resources/wrong-permissions/src/source.c
@@ -0,0 +1,7 @@
+#include <stdio.h>
+#include "source.h"
+
+int one(void)
+{
+  return 1;
+}
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/src/source.h b/tmc-langs-make/src/test/resources/wrong-permissions/src/source.h
@@ -0,0 +1 @@
+int one(void);
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/test/Makefile b/tmc-langs-make/src/test/resources/wrong-permissions/test/Makefile
@@ -0,0 +1,20 @@
+CHECK_CFLAGS=$(shell pkg-config --cflags check)
+CHECK_LDFLAGS=$(shell pkg-config --libs check)
+SRC_FILES=test_source.c tmc-check.c checkhelp.c ../src/source.c
+
+all: test
+
+test: $(SRC_FILES)
+	gcc $(CHECK_CFLAGS) -g -Wall -Wextra -std=c99 -o $@ $(SRC_FILES) $(CHECK_LDFLAGS) -lm
+
+clean:
+	rm -f test tmc_available_points.txt tmc_test_results.xml valgrind.log mockinput mockoutput
+
+run: test
+	./test
+
+run-valgrind: test
+	valgrind --track-origins=yes --leak-check=full --log-file=valgrind.log ./test
+
+get-points:
+	./test --print-available-points
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/test/checkhelp.c b/tmc-langs-make/src/test/resources/wrong-permissions/test/checkhelp.c
@@ -0,0 +1,59 @@
+#include <string.h>
+#include <stdio.h>
+
+// Sometimes Netbeans TMC plugin pukes when it gets non-ASCII characters
+// in test output. Trying to avoid that
+void remove_nonascii(char *str)
+{
+    while (*str) {
+        if (*str & 0x80)
+            *str = '?';
+        str++;
+    }
+}
+
+
+void printchar(char *buf, char c)
+{
+    if (c == '\n') {
+        strcpy(buf, "\\n");
+    } else if (c & 0x80) {
+        strcpy(buf, "(invalid)");
+    } else {
+        *buf++ = c;
+        *buf = 0;
+    }
+}
+
+int mycompare(char *student, char *model, char *infostr)
+{
+    int i = 0, line = 1;
+    char bufS[16] = { 0 };
+    char bufM[16] = { 0 };
+    while(*student) {
+        printchar(bufS, *student);
+        printchar(bufM, *model);
+        if (!(*model)) {
+            sprintf(infostr, "your output is longer than expected: character: '%s', position: %d, line: %d\n",
+                    bufS, i+1, line);
+            return -1;
+        }
+        if (*student != *model) {
+            sprintf(infostr, "position: %d, line: %d, your output: '%s' , expected: '%s'\n", 
+                    i+1, line, bufS, bufM);
+            return -1;
+        }
+        if (*student == '\n') {
+            line++;
+            i = -1;
+        }
+        student++; model++; i++;
+    }
+    if (*model) {
+        printchar(bufM, *model);
+        sprintf(infostr, "output correct until position: %d, line: %d, but shorter than expected. Next character should be '%s'\n",
+                i+1, line, bufM);
+        return -1;
+    }
+    return 0;
+}
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/test/test b/tmc-langs-make/src/test/resources/wrong-permissions/test/test
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/test/test_source.c b/tmc-langs-make/src/test/resources/wrong-permissions/test/test_source.c
@@ -0,0 +1,24 @@
+#include <check.h>
+#include "tmc-check.h"
+#include <stdlib.h>
+#include <stdio.h>
+#include <time.h>
+#include "../src/source.h"
+
+START_TEST(test_one)
+{
+    int res = one();
+    fail_unless(res == 1, "[Task 1.1] one returned %d. Should have returned: %d",
+            res, 1);
+}
+END_TEST
+
+int main(int argc, const char *argv[])
+{
+    srand((unsigned)time(NULL));
+	Suite *s = suite_create("Test-Passing");
+
+	tmc_register_test(s, test_one, "1.1");
+
+	return tmc_run_tests(argc, argv, s);
+}
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/test/tmc-check.c b/tmc-langs-make/src/test/resources/wrong-permissions/test/tmc-check.c
diff --git a/tmc-langs-make/src/test/resources/wrong-permissions/test/tmc-check.h b/tmc-langs-make/src/test/resources/wrong-permissions/test/tmc-check.h
diff --git a/tmc-langs-notests/pom.xml b/tmc-langs-notests/pom.xml
diff --git a/tmc-langs-python3/pom.xml b/tmc-langs-python3/pom.xml
diff --git a/tmc-langs-util/pom.xml b/tmc-langs-util/pom.xml

Original file line number	Diff line number	Diff line change
`@@ -246,4 +246,11 @@ public void isExerciseCorrectTypeDoesIsNotFooledByDirectoryNamedMakefile() throw`
`246`	`246`	`Files.delete(make);`
`247`	`247`	`Files.delete(parent);`
`248`	`248`	`}`
	`249`	`+`
	`250`	`+ @Test`
	`251`	`+ public void testProjectWithUnexecutableArtifacts() {`
	`252`	`+ Path path = TestUtils.getPath(getClass(), "wrong-permissions");`
	`253`	`+ RunResult result = makePlugin.runTests(path);`
	`254`	`+ assertEquals(result.status, RunResult.Status.PASSED);`
	`255`	`+ }`
`249`	`256`	`}`