Merge lp:~ted/dbus-test-runner/stop-premature-exiting into lp:dbus-test-runner/12.10

[Ted Gould]

Add option to wait until task complete

Adding an option to wait until the task is complete even if we don't care about its return value.

[jenkins (martin-mrazik+qa)]

PASSED: Continuous integration, rev:49
http://jenkins.qa.ubuntu.com/job/dbus-test-runner-ci/5/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/dbus-test-runner-ci/./label=precise/5/console

review: Approve (continuous-integration)

[Charles Kerr (charlesk)]

review: Approve

[jenkins (martin-mrazik+qa)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/dbus-test-runner-autolanding/3/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/dbus-test-runner-autolanding/./build=pbuilder,distribution=quantal,flavor=amd64/3/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/dbus-test-runner-autolanding/./build=pbuilder,distribution=quantal,flavor=i386/3/console

review: Needs Fixing (continuous-integration)

[lp:~ted/dbus-test-runner/stop-premature-exiting]

50. By Ted Gould on 2012-10-03

Updating to trunk to resolve conflicts

[jenkins (martin-mrazik+qa)]

PASSED: Continuous integration, rev:50
http://jenkins.qa.ubuntu.com/job/dbus-test-runner-ci/7/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/dbus-test-runner-ci/./build=pbuilder,distribution=quantal,flavor=amd64/7/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/dbus-test-runner-ci/./build=pbuilder,distribution=quantal,flavor=i386/7/console

review: Approve (continuous-integration)

=== modified file '.bzrignore'
--- .bzrignore	2011-11-28 22:21:06 +0000
+++ .bzrignore	2012-10-03 03:18:18 +0000
@@ -24,3 +24,7 @@
 test-check-name
 test-own-name
 test-wait-for
+test-wait-output.filtered
+test-wait-output.output
+test-wait-output
+test-wait-output.output-only

=== modified file 'libdbustest/service.c'
--- libdbustest/service.c	2012-10-02 03:11:56 +0000
+++ libdbustest/service.c	2012-10-03 03:18:18 +0000
@@ -209,7 +209,7 @@
 	DbusTestTaskState state = dbus_test_task_get_state(task);
 	DbusTestTaskReturn ret  = dbus_test_task_get_return(task);
 
-	if (state != DBUS_TEST_TASK_STATE_FINISHED && ret != DBUS_TEST_TASK_RETURN_IGNORE) {
+	if (state != DBUS_TEST_TASK_STATE_FINISHED && (ret != DBUS_TEST_TASK_RETURN_IGNORE || dbus_test_task_get_wait_finished(task))) {
 		*all_finished = FALSE;
 	}
 

=== modified file 'libdbustest/task.c'
--- libdbustest/task.c	2012-10-02 03:11:56 +0000
+++ libdbustest/task.c	2012-10-03 03:18:18 +0000
@@ -35,6 +35,7 @@
 	glong padding_cnt;
 
 	gboolean been_run;
+	gboolean wait_until_complete;
 };
 
 /* Signals */
@@ -97,6 +98,7 @@
 	self->priv->padding_cnt = 0;
 
 	self->priv->been_run = FALSE;
+	self->priv->wait_until_complete = FALSE;
 
 	return;
 }
@@ -346,3 +348,37 @@
 
 	return task->priv->wait_for;
 }
+
+/**
+ * dbus_test_task_set_wait_finished:
+ * @task: Task to adjust the value on
+ * @wait_till_complete: Set this task to wait until complete
+ *    even if we don't care about the return value.
+ *
+ * If this task has the value of its return set to ignore this
+ * means we won't exit early.
+ */
+void
+dbus_test_task_set_wait_finished (DbusTestTask * task, gboolean wait_till_complete)
+{
+	g_return_if_fail(DBUS_TEST_IS_TASK(task));
+
+	task->priv->wait_until_complete = wait_till_complete;
+
+	return;
+}
+
+/**
+ * dbus_test_task_set_wait_finished:
+ * @task: Task to get the value from
+ *
+ * Check to see if we should wait on this taks irregardless
+ * of whether we care about the return value.
+ */
+gboolean
+dbus_test_task_get_wait_finished (DbusTestTask * task)
+{
+	g_return_val_if_fail(DBUS_TEST_IS_TASK(task), FALSE);
+
+	return task->priv->wait_until_complete;
+}

=== modified file 'libdbustest/task.h'
--- libdbustest/task.h	2012-04-22 18:22:22 +0000
+++ libdbustest/task.h	2012-10-03 03:18:18 +0000
@@ -81,6 +81,7 @@
 void dbus_test_task_set_name_spacing (DbusTestTask * task, glong chars);
 void dbus_test_task_set_wait_for (DbusTestTask * task, const gchar * dbus_name);
 void dbus_test_task_set_return (DbusTestTask * task, DbusTestTaskReturn ret);
+void dbus_test_task_set_wait_finished (DbusTestTask * task, gboolean wait_till_complete);
 
 void dbus_test_task_print (DbusTestTask * task, const gchar * message);
 
@@ -88,6 +89,7 @@
 DbusTestTaskReturn dbus_test_task_get_return (DbusTestTask * task);
 const gchar * dbus_test_task_get_name (DbusTestTask * task);
 const gchar * dbus_test_task_get_wait_for (DbusTestTask * task);
+gboolean dbus_test_task_get_wait_finished (DbusTestTask * task);
 
 void dbus_test_task_run (DbusTestTask * task);
 

=== modified file 'src/dbus-test-runner.c'
--- src/dbus-test-runner.c	2012-10-02 03:15:57 +0000
+++ src/dbus-test-runner.c	2012-10-03 03:18:18 +0000
@@ -62,6 +62,23 @@
 }
 
 static gboolean
+option_complete (G_GNUC_UNUSED const gchar * arg, G_GNUC_UNUSED const gchar * value, G_GNUC_UNUSED gpointer data, GError ** error)
+{
+	if (last_task == NULL) {
+		g_set_error(error, G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE, "No task to put adjust return on.");
+		return FALSE;
+	}
+
+	if (dbus_test_task_get_wait_finished(DBUS_TEST_TASK(last_task))) {
+		g_set_error(error, G_OPTION_ERROR, G_OPTION_ERROR_BAD_VALUE, "Task has already be setup to wait until finished.");
+		return FALSE;
+	}
+
+	dbus_test_task_set_wait_finished(DBUS_TEST_TASK(last_task), TRUE);
+	return TRUE;
+}
+
+static gboolean
 option_noreturn (G_GNUC_UNUSED const gchar * arg, G_GNUC_UNUSED const gchar * value, G_GNUC_UNUSED gpointer data, GError ** error)
 {
 	if (last_task == NULL) {
@@ -154,6 +171,7 @@
 	{"invert-return", 'i',  G_OPTION_FLAG_NO_ARG,     G_OPTION_ARG_CALLBACK,  option_invert,   "Invert the return value of the task before calculating whether the test passes or fails.", NULL},
 	{"parameter",     'p',  0,                        G_OPTION_ARG_CALLBACK,  option_param,    "Add a parameter to the call of this utility.  May be called as many times as you'd like.", NULL},
 	{"wait-for",      'f',  0,                        G_OPTION_ARG_CALLBACK,  option_wait,     "A dbus-name that should appear on the bus before this task is started", "dbus-name"},
+	{"wait-until-complete", 'c', G_OPTION_FLAG_NO_ARG,G_OPTION_ARG_CALLBACK,  option_complete, "Signal that we should wait until this task exits even if we don't need the return value", NULL},
 	{NULL}
 };
 

=== modified file 'tests/Makefile.am'
--- tests/Makefile.am	2012-10-01 21:45:55 +0000
+++ tests/Makefile.am	2012-10-03 03:18:18 +0000
@@ -266,6 +266,19 @@
 XFAIL_TESTS += test-daemon-junk
 DISTCLEANFILES += test-daemon-junk-spitter
 
+TESTS += test-wait-output
+test-wait-output: Makefile.am test-wait-outputer
+	@echo "#!/bin/sh" > $@
+	@echo $(DBUS_RUNNER) --task "$(srcdir)/test-wait-outputer" --task-name output --ignore-return --wait-until-complete \| tee $(builddir)/test-wait-output.output >> $@
+	@echo "grep ^output: $(builddir)/test-wait-output.output | tail -n +2 > $(builddir)/test-wait-output.output-only" >> $@
+	@echo "sed -e s/output:\\ //g $(builddir)/test-wait-output.output-only > $(builddir)/test-wait-output.filtered" >> $@
+	@echo diff test-wait-output.reference test-wait-output.filtered >> $@
+	@chmod +x $@
+DISTCLEANFILES += \
+	test-wait-output.output \
+	test-wait-output.output-only \
+	test-wait-output.filtered
+
 ###########################
 # libdbustest
 ###########################
@@ -306,6 +319,8 @@
 DISTCLEANFILES += $(LIBDBUSTEST_XML_REPORT)
 
 EXTRA_DIST = \
+	test-wait-outputer \
+	test-wait-output.reference \
 	delayrm.sh \
 	test-bustle.reference \
 	test-bustle-data-check.sh \

=== added file 'tests/test-wait-output.reference'
--- tests/test-wait-output.reference	1970-01-01 00:00:00 +0000
+++ tests/test-wait-output.reference	2012-10-03 03:18:18 +0000
@@ -0,0 +1,5 @@
+One
+Two
+Three
+Four
+Five

=== added file 'tests/test-wait-outputer'
--- tests/test-wait-outputer	1970-01-01 00:00:00 +0000
+++ tests/test-wait-outputer	2012-10-03 03:18:18 +0000
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+sleep 1
+echo "One"
+sleep 1
+echo "Two"
+sleep 1
+echo "Three"
+sleep 1
+echo "Four"
+sleep 1
+echo "Five"