File: task.c

package info (click to toggle)
dbus-test-runner 16.10.0~bzr100%2Brepack1-4
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 676 kB
  • sloc: ansic: 3,632; makefile: 515; xml: 151; sh: 34
file content (458 lines) | stat: -rw-r--r-- 11,820 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
/*
Copyright 2012 Canonical Ltd.

Authors:
    Ted Gould <ted@canonical.com>

This program is free software: you can redistribute it and/or modify it 
under the terms of the GNU General Public License version 3, as published 
by the Free Software Foundation.

This program is distributed in the hope that it will be useful, but 
WITHOUT ANY WARRANTY; without even the implied warranties of 
MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR 
PURPOSE.  See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along 
with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "dbus-test.h"
#include <gio/gio.h>

typedef struct {
	DbusTestTaskReturn return_type;

	gchar * wait_for;
	DbusTestServiceBus wait_for_bus;
	guint wait_task;

	gchar * name;
	gchar * name_padded;
	glong padding_cnt;

	gboolean been_run;
	gboolean wait_until_complete;

	DbusTestServiceBus preferred_bus;
} DbusTestTaskPrivate;

/* Signals */
enum {
	STATE_CHANGED,
	LAST_SIGNAL /* Don't touch! */
};

static void dbus_test_task_class_init (DbusTestTaskClass *klass);
static void dbus_test_task_init       (DbusTestTask *self);
static void dbus_test_task_dispose    (GObject *object);
static void dbus_test_task_finalize   (GObject *object);

G_DEFINE_TYPE_WITH_PRIVATE (DbusTestTask, dbus_test_task, G_TYPE_OBJECT);

static guint signals[LAST_SIGNAL] = {0};

static void
dbus_test_task_class_init (DbusTestTaskClass *klass)
{
	GObjectClass *object_class = G_OBJECT_CLASS (klass);

	object_class->dispose = dbus_test_task_dispose;
	object_class->finalize = dbus_test_task_finalize;

	klass->run = NULL;
	klass->get_state = NULL;
	klass->get_passed = NULL;

	signals[STATE_CHANGED]  = g_signal_new(DBUS_TEST_TASK_SIGNAL_STATE_CHANGED,
	                                       G_TYPE_FROM_CLASS (klass),
	                                       G_SIGNAL_RUN_LAST,
	                                       G_STRUCT_OFFSET (DbusTestTaskClass, state_changed),
	                                       NULL, NULL,
	                                       g_cclosure_marshal_VOID__INT,
	                                       G_TYPE_NONE, 1, G_TYPE_INT, G_TYPE_NONE);

	return;
}

static void
dbus_test_task_init (DbusTestTask *self)
{
	static gint task_count = 0;

	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(self);

	priv->return_type = DBUS_TEST_TASK_RETURN_NORMAL;

	priv->wait_for = NULL;
	priv->wait_for_bus = DBUS_TEST_SERVICE_BUS_BOTH;
	priv->wait_task = 0;

	priv->name = g_strdup_printf("task-%d", task_count++);
	priv->name_padded = NULL;
	priv->padding_cnt = 0;

	priv->been_run = FALSE;
	priv->wait_until_complete = FALSE;

	priv->preferred_bus = DBUS_TEST_SERVICE_BUS_BOTH;

	return;
}

static void
dbus_test_task_dispose (GObject *object)
{
	g_return_if_fail(DBUS_TEST_IS_TASK(object));
	DbusTestTask * self = DBUS_TEST_TASK(object);
	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(self);

	if (priv->wait_task != 0) {
		g_bus_unwatch_name(priv->wait_task);
		priv->wait_task = 0;
	}

	G_OBJECT_CLASS (dbus_test_task_parent_class)->dispose (object);
	return;
}

static void
dbus_test_task_finalize (GObject *object)
{
	g_return_if_fail(DBUS_TEST_IS_TASK(object));
	DbusTestTask * self = DBUS_TEST_TASK(object);
	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(self);

	g_print("%s: Shutting down\n", priv->name);

	g_free(priv->name);
	g_free(priv->name_padded);
	g_free(priv->wait_for);

	G_OBJECT_CLASS (dbus_test_task_parent_class)->finalize (object);
	return;
}

DbusTestTask *
dbus_test_task_new (void)
{
	DbusTestTask * task = g_object_new(DBUS_TEST_TYPE_TASK,
	                                   NULL);

	return task;
}

void
dbus_test_task_set_name (DbusTestTask * task, const gchar * name)
{
	g_return_if_fail(DBUS_TEST_IS_TASK(task));

	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	g_free(priv->name);
	g_free(priv->name_padded);

	priv->name = g_strdup(name);
	if (priv->padding_cnt != 0 && priv->name != NULL) {
		gchar * fillstr = g_strnfill(priv->padding_cnt - g_utf8_strlen(priv->name, -1), ' ');
		priv->name_padded = g_strconcat(priv->name, fillstr, NULL);
		g_free(fillstr);
	} else {
		priv->name_padded = NULL;
	}

	return;
}

void
dbus_test_task_set_name_spacing (DbusTestTask * task, glong chars)
{
	g_return_if_fail(DBUS_TEST_IS_TASK(task));

	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	g_free(priv->name_padded);
	priv->padding_cnt = chars;

	g_return_if_fail(priv->padding_cnt >= g_utf8_strlen(priv->name, -1));

	if (chars != 0 && priv->name != NULL) {
		gchar * fillstr = g_strnfill(priv->padding_cnt - g_utf8_strlen(priv->name, -1), ' ');
		priv->name_padded = g_strconcat(priv->name, fillstr, NULL);
		g_free(fillstr);
	} else {
		priv->name_padded = NULL;
	}

	return;
}
void
dbus_test_task_set_wait_for (DbusTestTask * task, const gchar * dbus_name)
{
	return dbus_test_task_set_wait_for_bus(task, dbus_name, DBUS_TEST_SERVICE_BUS_BOTH);
}

void
dbus_test_task_set_wait_for_bus (DbusTestTask * task, const gchar * dbus_name, DbusTestServiceBus bus)
{
	g_return_if_fail(DBUS_TEST_IS_TASK(task));

	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	if (priv->wait_for != NULL) {
		g_free(priv->wait_for);
		priv->wait_for = NULL;
		priv->wait_for_bus = DBUS_TEST_SERVICE_BUS_BOTH;
	}

	if (dbus_name == NULL) {
		return;
	}

	priv->wait_for = g_strdup(dbus_name);
	priv->wait_for_bus = bus;

	return;
}

void
dbus_test_task_set_return (DbusTestTask * task, DbusTestTaskReturn ret)
{
	g_return_if_fail(DBUS_TEST_IS_TASK(task));

	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	if (ret != priv->return_type && dbus_test_task_get_state(task) == DBUS_TEST_TASK_STATE_FINISHED) {
		g_warning("Changing return type after the task has finished");
	}

	priv->return_type = ret;
	return;
}

void
dbus_test_task_print (DbusTestTask * task, const gchar * message)
{
	g_return_if_fail(DBUS_TEST_IS_TASK(task));
	g_return_if_fail(message != NULL);

	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	gchar * name = priv->name;
	if (priv->name_padded != NULL) {
		name = priv->name_padded;
	}

	g_print("%s: %s\n", name, message);

	return;
}

DbusTestTaskState
dbus_test_task_get_state (DbusTestTask * task)
{
	g_return_val_if_fail(DBUS_TEST_IS_TASK(task), DBUS_TEST_TASK_STATE_FINISHED);

	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	if (priv->wait_task != 0) {
		return DBUS_TEST_TASK_STATE_WAITING;
	}

	DbusTestTaskClass * klass = DBUS_TEST_TASK_GET_CLASS(task);
	if (klass->get_state != NULL) {
		return klass->get_state(task);
	}

	if (priv->been_run) {
		return DBUS_TEST_TASK_STATE_FINISHED;
	} else {
		return DBUS_TEST_TASK_STATE_INIT;
	}
}

DbusTestTaskReturn
dbus_test_task_get_return (DbusTestTask * task)
{
	g_return_val_if_fail(DBUS_TEST_IS_TASK(task), DBUS_TEST_TASK_RETURN_IGNORE);

	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	return priv->return_type;
}

static void
wait_for_found (G_GNUC_UNUSED GDBusConnection * connection, G_GNUC_UNUSED const gchar * name, G_GNUC_UNUSED const gchar * name_owner, gpointer user_data)
{
	g_return_if_fail(DBUS_TEST_IS_TASK(user_data));
	DbusTestTask * task = DBUS_TEST_TASK(user_data);

	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	g_bus_unwatch_name(priv->wait_task);
	priv->wait_task = 0;

	DbusTestTaskClass * klass = DBUS_TEST_TASK_GET_CLASS(task);
	priv->been_run = TRUE;
	if (klass->run != NULL) {
		klass->run(task);
	} else {
		g_signal_emit(G_OBJECT(task), signals[STATE_CHANGED], 0, DBUS_TEST_TASK_STATE_FINISHED, NULL);
	}

	return;
}

void
dbus_test_task_run (DbusTestTask * task)
{
	g_return_if_fail(DBUS_TEST_IS_TASK(task));

	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	/* We're going to process the waiting at this level if we've been
	   asked to do so */
	if (priv->wait_for != NULL) {
		GBusType bustype = G_BUS_TYPE_SESSION;
		if (priv->wait_for_bus == DBUS_TEST_SERVICE_BUS_BOTH &&
				priv->preferred_bus == DBUS_TEST_SERVICE_BUS_SYSTEM) {
			bustype = G_BUS_TYPE_SYSTEM;
		}

		priv->wait_task = g_bus_watch_name(bustype,
		                                         priv->wait_for,
		                                         G_BUS_NAME_WATCHER_FLAGS_NONE,
		                                         wait_for_found,
		                                         NULL,
		                                         task,
		                                         NULL);
		g_signal_emit(G_OBJECT(task), signals[STATE_CHANGED], 0, DBUS_TEST_TASK_STATE_WAITING, NULL);
		return;
	}

	DbusTestTaskClass * klass = DBUS_TEST_TASK_GET_CLASS(task);
	priv->been_run = TRUE;
	if (klass->run != NULL) {
		klass->run(task);
	} else {
		g_signal_emit(G_OBJECT(task), signals[STATE_CHANGED], 0, DBUS_TEST_TASK_STATE_FINISHED, NULL);
	}

	return;
}

gboolean
dbus_test_task_passed (DbusTestTask * task)
{
	g_return_val_if_fail(DBUS_TEST_IS_TASK(task), FALSE);
	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	g_return_val_if_fail(priv->been_run, FALSE);

	/* If we don't care, we always pass */
	if (priv->return_type == DBUS_TEST_TASK_RETURN_IGNORE) {
		return TRUE;
	}

	DbusTestTaskClass * klass = DBUS_TEST_TASK_GET_CLASS(task);
	if (klass->get_passed == NULL) {
		return FALSE;
	}

	gboolean subret = klass->get_passed(task);

	if (priv->return_type == DBUS_TEST_TASK_RETURN_INVERT) {
		return !subret;
	}

	return subret;
}

const gchar *
dbus_test_task_get_name (DbusTestTask * task)
{
	g_return_val_if_fail(DBUS_TEST_IS_TASK(task), NULL);
	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	return priv->name;
}

const gchar *
dbus_test_task_get_wait_for (DbusTestTask * task)
{
	g_return_val_if_fail(DBUS_TEST_IS_TASK(task), NULL);
	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	return 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));
	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(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);
	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	return priv->wait_until_complete;
}

/**
 * dbus_test_task_set_bus:
 * @task: Task to get the bus from
 * @bus: Preferred bus for this task
 *
 * Set which bus this task prefers to be on.
 */
void
dbus_test_task_set_bus (DbusTestTask * task, DbusTestServiceBus bus)
{
	g_return_if_fail(DBUS_TEST_IS_TASK(task));
	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	priv->preferred_bus = bus;
}

/**
 * dbus_test_task_get_bus:
 * @task: Task to get the bus from
 *
 * Check to see which bus this task prefers to be on.
 */
DbusTestServiceBus
dbus_test_task_get_bus (DbusTestTask * task)
{
	g_return_val_if_fail(DBUS_TEST_IS_TASK(task), DBUS_TEST_SERVICE_BUS_BOTH);
	DbusTestTaskPrivate *priv = dbus_test_task_get_instance_private(task);

	return priv->preferred_bus;
}