print_error shouldn't return trailing new line

Replicates graphql/graphql-js@3ddf148

Author: Cito

graphql/error/print_error.py

@@ -31,7 +31,7 @@ def print_error(error: "GraphQLError") -> str:
         for location in error.locations:
             print_location(highlight_source_at_location(source, location))
     if printed_locations:
-        return "\n\n".join([error.message] + printed_locations) + "\n"
+        return "\n\n".join([error.message] + printed_locations)
     return error.message
 
 

tests/error/test_print_error.py

@@ -25,7 +25,7 @@ def prints_line_numbers_with_correct_padding():
             Source("*", "Test", SourceLocation(9, 1)),
             [0],
         )
-        assert print_error(single_digit) == dedent(
+        assert print_error(single_digit) + "\n" == dedent(
             """
             Single digit line number with no padding
 
@@ -42,7 +42,7 @@ def prints_line_numbers_with_correct_padding():
             [0],
         )
 
-        assert print_error(double_digit) == dedent(
+        assert print_error(double_digit) + "\n" == dedent(
             """
             Left padded first line number
 
@@ -92,7 +92,7 @@ def prints_an_error_with_nodes_from_different_sources():
         )
 
         printed_error = print_error(error)
-        assert printed_error == dedent(
+        assert printed_error + "\n" == dedent(
             """
             Example error with two nodes
 

tests/language/test_lexer.py

@@ -61,7 +61,7 @@ def errors_respect_whitespace():
         with raises(GraphQLSyntaxError) as exc_info:
             lex_one("\n\n    ?\n\n\n")
 
-        assert str(exc_info.value) == dedent(
+        assert str(exc_info.value) + "\n" == dedent(
             """
             Syntax Error: Cannot parse the unexpected character '?'.
 
@@ -78,7 +78,7 @@ def updates_line_numbers_in_error_for_file_context():
         source = Source(s, "foo.js", SourceLocation(11, 12))
         with raises(GraphQLSyntaxError) as exc_info:
             Lexer(source).advance()
-        assert str(exc_info.value) == dedent(
+        assert str(exc_info.value) + "\n" == dedent(
             """
             Syntax Error: Cannot parse the unexpected character '?'.
 
@@ -94,7 +94,7 @@ def updates_column_numbers_in_error_for_file_context():
         source = Source("?", "foo.js", SourceLocation(1, 5))
         with raises(GraphQLSyntaxError) as exc_info:
             Lexer(source).advance()
-        assert str(exc_info.value) == dedent(
+        assert str(exc_info.value) + "\n" == dedent(
             """
             Syntax Error: Cannot parse the unexpected character '?'.
 

tests/language/test_parser.py

@@ -67,7 +67,7 @@ def parse_provides_useful_errors():
         assert error.message == "Syntax Error: Expected Name, found <EOF>"
         assert error.positions == [1]
         assert error.locations == [(1, 2)]
-        assert str(error) == dedent(
+        assert str(error) + "\n" == dedent(
             """
             Syntax Error: Expected Name, found <EOF>
 
@@ -91,7 +91,7 @@ def parse_provides_useful_error_when_using_source():
         with raises(GraphQLSyntaxError) as exc_info:
             parse(Source("query", "MyQuery.graphql"))
         error = exc_info.value
-        assert str(error) == (
+        assert str(error) + "\n" == (
             "Syntax Error: Expected {, found <EOF>\n\n"
             "MyQuery.graphql:1:6\n1: query\n        ^\n"
         )

tests/utilities/test_strip_ignored_characters.py

@@ -66,11 +66,6 @@ def to_equal(self, expected: str):
     def to_stay_the_same(self):
         self.to_equal(self.doc_string)
 
-    def to_raise(self, expected_stringify_error):
-        with raises(GraphQLSyntaxError) as exc_info:
-            strip_ignored_characters(self.doc_string)
-        assert str(exc_info.value) == expected_stringify_error
-
 
 def describe_strip_ignored_characters():
     def asserts_that_a_source_was_provided():
@@ -128,17 +123,18 @@ def strips_ignored_characters_from_graphql_sdl_document():
         )
 
     def report_document_with_invalid_token():
-        ExpectStripped('{ foo(arg: "\n"').to_raise(
-            dedent(
-                """
-                Syntax Error: Unterminated string.
-
-                GraphQL request:1:13
-                1: { foo(arg: "
-                               ^
-                2: "
-                """
-            )
+        with raises(GraphQLSyntaxError) as exc_info:
+            strip_ignored_characters('{ foo(arg: "\n"')
+
+        assert str(exc_info.value) + "\n" == dedent(
+            """
+            Syntax Error: Unterminated string.
+
+            GraphQL request:1:13
+            1: { foo(arg: "
+                           ^
+            2: "
+            """
         )
 
     def strips_non_parsable_document():