example tests: Save expected test output in a txt file

This commit adds a .txt file next to each example test that generates a
text output. This text file contains the expected output and it is an
error if the actual output does not match the expected output. This
means that we no longer have to run the example tests before we can
expand all the @foo@ expressions that occur.

While touching this, I also fixed some typos and unexpected newlines in
the tests' output.

Signed-off-by: Uli Schlachter <psychon@znc.in>

tests/examples/CMakeLists.txt

@@ -232,12 +232,17 @@ function(run_test test_path namespace escaped_content)
         set(OUTPUT_IMAGE_PATH "")
     endif()
 
+    # Does the text generate text output?
     # If there is an output, assume it is relevant and add it to the
     # documentation under the image.
-    if(NOT ${TEST_OUTPUT} STREQUAL "")
-        if(NOT tmp_content MATCHES "--DOC_GEN_OUTPUT")
-            message(FATAL_ERROR "Unexpected output from ${test_path}: ${TEST_OUTPUT}")
+    if(tmp_content MATCHES "--DOC_GEN_OUTPUT")
+        # The expected output is next to the .lua file in a .output.txt file
+        string(REPLACE ".lua" ".output.txt" expected_output_path ${test_path})
+        file(READ "${expected_output_path}" expected_output)
+        if(NOT "${TEST_OUTPUT}" STREQUAL "${expected_output}")
+            message(SEND_ERROR "Wrong output from ${test_path}:\nExpected:\n${expected_output}\nGot:\n${TEST_OUTPUT}")
         endif()
+
         set(TEST_DOC_CONTENT
             "${TEST_DOC_CONTENT}\n${DOC_LINE_PREFIX}\n${DOC_LINE_PREFIX}**Usage example output**:\n${DOC_LINE_PREFIX}"
         )
@@ -248,6 +253,10 @@ function(run_test test_path namespace escaped_content)
             "${TEST_DOC_CONTENT}" TEST_DOC_CONTENT "    "
         )
         set(TEST_DOC_CONTENT "${TEST_DOC_CONTENT}\n${DOC_LINE_PREFIX}")
+    else()
+        if(NOT ${TEST_OUTPUT} STREQUAL "")
+            message(FATAL_ERROR "Unexpected output from ${test_path}: ${TEST_OUTPUT}")
+        endif()
     endif()
 
     # If there is some @* content, append it.

tests/examples/awful/mouse/coords.output.txt

@@ -0,0 +1 @@
+235

tests/examples/awful/placement/closest_mouse.output.txt

@@ -0,0 +1 @@
+Closest corner:	top_left

tests/examples/awful/placement/no_offscreen.output.txt

@@ -0,0 +1,2 @@
+Before:	x=-30, y=-30, width=100, height=100
+After:	x=10, y=10, width=100, height=100

tests/examples/text/gears/object/properties.lua

@@ -23,7 +23,7 @@ function class:set_foo(value)
 end
 
 function class:method(a, b, c)
-    print("In a mathod", a, b, c)
+    print("In a method", a, b, c)
 end
 
 local o = gears.object {

tests/examples/text/gears/object/properties.output.txt

@@ -0,0 +1,9 @@
+In get foo	bar
+bar
+In set foo	42
+In get foo	42
+42
+In a method	1	2	3
+nil
+In the connection handler!	a cow
+a cow

tests/examples/text/gears/object/signal.output.txt

@@ -0,0 +1,2 @@
+In slot	[obj]	nil	nil	nil
+In slot	[obj]	foo	bar	42

tests/examples/text/gears/sort/topological.output.txt

@@ -0,0 +1,6 @@
+The position #1 is: a
+The position #2 is: b
+The position #3 is: c
+The position #4 is: d
+The position #5 is: e
+The position #6 is: f

tests/examples/wibox/layout/grid/add.output.txt

@@ -0,0 +1 @@
+l:add_widget_at(new, 1, 4, 1, 1)

tests/examples/wibox/layout/grid/extend_column.output.txt

@@ -0,0 +1 @@
+l:extend_column(2)

tests/examples/wibox/layout/grid/insert_column.output.txt

@@ -0,0 +1 @@
+l:insert_column(2)

tests/examples/wibox/layout/grid/orientation.lua

@@ -10,8 +10,7 @@ print([[l = wibox.layout {
     layout = wibox.layout.grid
 }
 l:set_orientation("vertical") -- change to "horizontal"
-l:add(...)
-]]) --DOC_HIDE
+l:add(...)]]) --DOC_HIDE
 
 return --DOC_HIDE
 wibox.widget {

tests/examples/wibox/layout/grid/orientation.output.txt

@@ -0,0 +1,8 @@
+l = wibox.layout {
+    forced_num_cols = 2,
+    forced_num_rows = 2,
+    homogeneous     = true,
+    layout = wibox.layout.grid
+}
+l:set_orientation("vertical") -- change to "horizontal"
+l:add(...)

tests/examples/wibox/layout/grid/remove.output.txt

@@ -0,0 +1 @@
+l:remove_widgets_at(1,1)

tests/examples/wibox/layout/grid/remove_column.output.txt

@@ -0,0 +1 @@
+l:remove_column(2)