From: Francis Deslauriers <francis.deslauriers@efficios.com>
Date: Tue, 11 Feb 2020 02:46:34 +0000 (-0500)
Subject: Tests: Fix: `wait_on_file()` returns too early
X-Git-Tag: v2.10.11~6
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=aa0a9e96a728e6a4794f08bbb4df684e3274a3d9;p=lttng-tools.git

Tests: Fix: `wait_on_file()` returns too early

Issue
=====
With the current implementation, when calling the `wait_on_file()`
function with the `file_exist` parameter set to false the function will
return even if the target file exists.

In a scenario where we enter the loop and the targer file exist, the
first call to `stat()` will return 0 and will not enter any of the `if`
and break from the loop directly.

Solution
========
If the file exists, only break from the loop if it's the desired exit
condition.

Signed-off-by: Francis Deslauriers <francis.deslauriers@efficios.com>
Change-Id: Ia3e9c41a2a515815d3ff931d8f7c1c14a52b31ae
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/tests/regression/tools/notification/notification.c b/tests/regression/tools/notification/notification.c
index 3bcffdda3..07a8bb464 100644
--- a/tests/regression/tools/notification/notification.c
+++ b/tests/regression/tools/notification/notification.c
@@ -74,16 +74,31 @@ void wait_on_file(const char *path, bool file_exist)
 		ret = stat(path, &buf);
 		if (ret == -1 && errno == ENOENT) {
 			if (file_exist) {
-				(void) poll(NULL, 0, 10);	/* 10 ms delay */
-				continue;			/* retry */
+				/*
+				 * The file does not exist. wait a bit and
+				 * continue looping until it does.
+				 */
+				(void) poll(NULL, 0, 10);
+				continue;
 			}
-			break; /* File does not exist */
+
+			/*
+			 * File does not exist and the exit condition we want.
+			 * Break from the loop and return.
+			 */
+			break;
 		}
 		if (ret) {
 			perror("stat");
 			exit(EXIT_FAILURE);
 		}
-		break;	/* found */
+		/*
+		 * stat() returned 0, so the file exists. break now only if
+		 * that's the exit condition we want.
+		 */
+		if (file_exist) {
+			break;
+		}
 	}
 }