writing the filename where the assertion failed (openscad#2341)

MichaelPFrey · kintel · commit 1d44b5e5866b · 2018-03-21T21:49:07.000-04:00
* writing the filename where the assertion failed * use just the filename and update the tests * relative path * move the path handling to the exception handler * update tests * return fs::path to prevent accidental writes (openscad#6) * using PRINTB instead of stringstream
diff --git a/src/AST.h b/src/AST.h
@@ -17,6 +17,7 @@ class Location {
 	}
 
 	std::string fileName() const { return path ? path->generic_string() : ""; }
+	fs::path filePath() const { return *path; }
 	int firstLine() const { return first_line; }
 	int firstColumn() const { return first_col; }
 	int lastLine() const { return last_line; }
diff --git a/src/FileModule.cc b/src/FileModule.cc
@@ -32,9 +32,10 @@
 #include "modcontext.h"
 #include "parsersettings.h"
 #include "StatCache.h"
-
+#include "evalcontext.h"
 #include <boost/algorithm/string.hpp>
 #include <boost/filesystem.hpp>
+#include "boost-utils.h"
 namespace fs = boost::filesystem;
 #include "FontCache.h"
 #include <sys/stat.h>
@@ -180,6 +181,12 @@ AbstractNode *FileModule::instantiateWithFileContext(FileContext *ctx, const Mod
 		auto instantiatednodes = this->scope.instantiateChildren(ctx);
 		node->children.insert(node->children.end(), instantiatednodes.begin(), instantiatednodes.end());
 	}
+	catch (AssertionFailedException &e) {
+		auto docPath = boost::filesystem::path(ctx->documentPath());
+		auto uncPath = boostfs_uncomplete(e.loc.filePath(), docPath);
+
+		PRINTB("%s failed in file %s, line %d", e.what() % uncPath.generic_string() % e.loc.firstLine());
+	}
 	catch (EvaluationException &e) {
 		PRINT(e.what());
 	}
diff --git a/src/exceptions.h b/src/exceptions.h
@@ -2,6 +2,7 @@
 
 #include <stdexcept>
 #include <sstream>
+#include "expression.h"
 
 class EvaluationException : public std::runtime_error {
 public:
@@ -11,8 +12,11 @@ class EvaluationException : public std::runtime_error {
 
 class AssertionFailedException : public EvaluationException {
 public:
-	AssertionFailedException(const std::string &what_arg) : EvaluationException(what_arg) {}
+	AssertionFailedException(const std::string &what_arg, const Location &loc)  : EvaluationException(what_arg), loc(loc) {}
 	~AssertionFailedException() throw() {}
+	
+public:
+	Location loc;
 };
 
 class RecursionException: public EvaluationException {
diff --git a/src/expr.cc b/src/expr.cc
@@ -728,11 +728,10 @@ void evaluate_assert(const Context &context, const class EvalContext *evalctx, c
 		msg << "ERROR: Assertion";
 		const Expression *expr = assignments["condition"];
 		if (expr) msg << " '" << *expr << "'";
-		msg << " failed, line " << loc.firstLine();
 		const ValuePtr message = c.lookup_variable("message", true);
 		if (message->isDefined()) {
 			msg << ": " << message->toEchoString();
 		}
-		throw AssertionFailedException(msg.str());
+		throw AssertionFailedException(msg.str(),loc);
 	}
 }
diff --git a/tests/regression/echotest/assert-expression-fail1-test-expected.echo b/tests/regression/echotest/assert-expression-fail1-test-expected.echo
@@ -1 +1 @@
-ERROR: Assertion 'false' failed, line 1
+ERROR: Assertion 'false' failed in file ../../../../../testdata/scad/functions/assert-expression-fail1-test.scad, line 1
diff --git a/tests/regression/echotest/assert-expression-fail2-test-expected.echo b/tests/regression/echotest/assert-expression-fail2-test-expected.echo
@@ -1 +1 @@
-ERROR: Assertion '((a < 20) && (b < 20))' failed, line 3: "Test! <html>&</html>"
+ERROR: Assertion '((a < 20) && (b < 20))': "Test! <html>&</html>" failed in file ../../../../../testdata/scad/functions/assert-expression-fail2-test.scad, line 3
diff --git a/tests/regression/echotest/assert-expression-fail3-test-expected.echo b/tests/regression/echotest/assert-expression-fail3-test-expected.echo
@@ -1 +1 @@
-ERROR: Assertion '(f(angle) > 0)' failed, line 4
+ERROR: Assertion '(f(angle) > 0)' failed in file ../../../../../testdata/scad/functions/assert-expression-fail3-test.scad, line 4
diff --git a/tests/regression/echotest/assert-fail1-test-expected.echo b/tests/regression/echotest/assert-fail1-test-expected.echo
@@ -1 +1 @@
-ERROR: Assertion 'false' failed, line 1
+ERROR: Assertion 'false' failed in file ../../../../../testdata/scad/misc/assert-fail1-test.scad, line 1
diff --git a/tests/regression/echotest/assert-fail2-test-expected.echo b/tests/regression/echotest/assert-fail2-test-expected.echo
@@ -1 +1 @@
-ERROR: Assertion '((a < 20) && (b < 20))' failed, line 3: "Test! <html>&</html>"
+ERROR: Assertion '((a < 20) && (b < 20))': "Test! <html>&</html>" failed in file ../../../../../testdata/scad/misc/assert-fail2-test.scad, line 3
diff --git a/tests/regression/echotest/assert-fail3-test-expected.echo b/tests/regression/echotest/assert-fail3-test-expected.echo
@@ -1 +1 @@
-ERROR: Assertion '(f(angle) > 0)' failed, line 4
+ERROR: Assertion '(f(angle) > 0)' failed in file ../../../../../testdata/scad/misc/assert-fail3-test.scad, line 4

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ class Location {`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`std::string fileName() const { return path ? path->generic_string() : ""; }`
	`20`	`+ fs::path filePath() const { return *path; }`
`20`	`21`	`int firstLine() const { return first_line; }`
`21`	`22`	`int firstColumn() const { return first_col; }`
`22`	`23`	`int lastLine() const { return last_line; }`
Original file line number	Diff line number	Diff line change
`@@ -728,11 +728,10 @@ void evaluate_assert(const Context &context, const class EvalContext *evalctx, c`
`728`	`728`	`msg << "ERROR: Assertion";`
`729`	`729`	`const Expression *expr = assignments["condition"];`
`730`	`730`	`if (expr) msg << " '" << *expr << "'";`
`731`		`- msg << " failed, line " << loc.firstLine();`
`732`	`731`	`const ValuePtr message = c.lookup_variable("message", true);`
`733`	`732`	`if (message->isDefined()) {`
`734`	`733`	`msg << ": " << message->toEchoString();`
`735`	`734`	`}`
`736`		`- throw AssertionFailedException(msg.str());`
	`735`	`+ throw AssertionFailedException(msg.str(),loc);`
`737`	`736`	`}`
`738`	`737`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-ERROR: Assertion 'false' failed, line 1`
	`1`	`+ERROR: Assertion 'false' failed in file ../../../../../testdata/scad/functions/assert-expression-fail1-test.scad, line 1`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-ERROR: Assertion '((a < 20) && (b < 20))' failed, line 3: "Test! <html>&</html>"`
	`1`	`+ERROR: Assertion '((a < 20) && (b < 20))': "Test! <html>&</html>" failed in file ../../../../../testdata/scad/functions/assert-expression-fail2-test.scad, line 3`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-ERROR: Assertion '(f(angle) > 0)' failed, line 4`
	`1`	`+ERROR: Assertion '(f(angle) > 0)' failed in file ../../../../../testdata/scad/functions/assert-expression-fail3-test.scad, line 4`