From 7009806b94a16bd7b66a8b0bbf984923b5377d0e Mon Sep 17 00:00:00 2001
From: Pekka Paalanen <pekka.paalanen@collabora.com>
Date: Tue, 21 Jan 2020 15:37:14 +0200
Subject: [PATCH] tests: rename check_screen() to verify_screen_content() + doc

The old name felt too... short.

The return type is changed to bool; fits better for a success/failure.

Signed-off-by: Pekka Paalanen <pekka.paalanen@collabora.com>
---
 tests/subsurface-shot-test.c      | 15 ++++++++++++
 tests/weston-test-client-helper.c | 40 ++++++++++++++++++++++++-------
 tests/weston-test-client-helper.h | 12 +++++-----
 3 files changed, 53 insertions(+), 14 deletions(-)

diff --git a/tests/subsurface-shot-test.c b/tests/subsurface-shot-test.c
index 9a9a7fd6..7f42dbb9 100644
--- a/tests/subsurface-shot-test.c
+++ b/tests/subsurface-shot-test.c
@@ -115,6 +115,21 @@ color(pixman_color_t *tmp, uint8_t r, uint8_t g, uint8_t b)
 	return tmp;
 }
 
+static int
+check_screen(struct client *client,
+	     const char *ref_image,
+	     int ref_seq_no,
+	     const struct rectangle *clip,
+	     int seq_no)
+{
+	bool match;
+
+	match = verify_screen_content(client, ref_image, ref_seq_no, clip,
+				      seq_no);
+
+	return match ? 0 : -1;
+}
+
 static struct buffer *
 surface_commit_color(struct client *client, struct wl_surface *surface,
 		     pixman_color_t *color, int width, int height)
diff --git a/tests/weston-test-client-helper.c b/tests/weston-test-client-helper.c
index 06cf5e07..b6eaa22d 100644
--- a/tests/weston-test-client-helper.c
+++ b/tests/weston-test-client-helper.c
@@ -1543,12 +1543,36 @@ write_visual_diff(pixman_image_t *ref_image,
 	free(ext_test_name);
 }
 
-int
-check_screen(struct client *client,
-	     const char *ref_image,
-	     int ref_seq_no,
-	     const struct rectangle *clip,
-	     int seq_no)
+/**
+ * Take a screenshot and verify its contents
+ *
+ * Takes a screenshot and writes the image into a PNG file named with
+ * get_test_name() and seq_no. Compares the contents to the given reference
+ * image over the given clip rectangle, reports whether they match to the
+ * test log, and if they do not match writes a visual diff into a PNG file.
+ *
+ * The compositor output size and the reference image size must both contain
+ * the clip rectangle.
+ *
+ * This function uses the pixel value allowed fuzz approriate for GL-renderer
+ * with 8 bits per channel data.
+ *
+ * \param client The client, for connecting to the compositor.
+ * \param ref_image The reference image file basename, without sequence number
+ * and .png suffix.
+ * \param ref_seq_no The reference image sequence number.
+ * \param clip The region of interest, or NULL for comparing the whole
+ * images.
+ * \param seq_no Test sequence number, for writing output files.
+ * \return True if the screen contents matches the reference image,
+ * false otherwise.
+ */
+bool
+verify_screen_content(struct client *client,
+		      const char *ref_image,
+		      int ref_seq_no,
+		      const struct rectangle *clip,
+		      int seq_no)
 {
 	const char *test_name = get_test_name();
 	const struct range gl_fuzz = { 0, 1 };
@@ -1568,7 +1592,7 @@ check_screen(struct client *client,
 	assert(shot);
 
 	match = check_images_match(ref, shot->image, clip, &gl_fuzz);
-	testlog("ref %s vs. shot %s: %s\n", ref_fname, shot_fname,
+	testlog("Verify reference image %s vs. shot %s: %s\n", ref_fname, shot_fname,
 		match ? "PASS" : "FAIL");
 
 	write_image_as_png(shot->image, shot_fname);
@@ -1580,5 +1604,5 @@ check_screen(struct client *client,
 	free(ref_fname);
 	free(shot_fname);
 
-	return match ? 0 : -1;
+	return match;
 }
diff --git a/tests/weston-test-client-helper.h b/tests/weston-test-client-helper.h
index 046c1cf9..cbb0512d 100644
--- a/tests/weston-test-client-helper.h
+++ b/tests/weston-test-client-helper.h
@@ -246,11 +246,11 @@ load_image_from_png(const char *fname);
 struct buffer *
 capture_screenshot_of_output(struct client *client);
 
-int
-check_screen(struct client *client,
-	     const char *ref_image,
-	     int ref_seq_no,
-	     const struct rectangle *clip,
-	     int seq_no);
+bool
+verify_screen_content(struct client *client,
+		      const char *ref_image,
+		      int ref_seq_no,
+		      const struct rectangle *clip,
+		      int seq_no);
 
 #endif