[gnome-battery-bench] gbb test: allow running tests from the command line

[Owen Taylor <otaylor src gnome org>]

commit 4f80cb309944809d26b2c2a632a16b341209b5de
Author: Owen W. Taylor <otaylor fishsoup net>
Date:   Fri Jan 2 16:16:26 2015 -0500

    gbb test: allow running tests from the command line
    
    Allow running tests from the command line instead of the GUI by
    using 'gbb test' which has options to set the duration, screen
    brightness, and output filename.

 src/application.c |   17 +----
 src/commandline.c |  202 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 src/test-run.c    |   22 ++++++
 src/test-run.h    |    3 +
 src/test-runner.c |    6 ++
 src/test-runner.h |    1 +
 src/util.h        |    2 +
 7 files changed, 235 insertions(+), 18 deletions(-)
---
diff --git a/src/application.c b/src/application.c
index 9112498..0256c2b 100644
--- a/src/application.c
+++ b/src/application.c
@@ -436,8 +436,6 @@ write_run_to_disk(GbbApplication *application,
 {
     GError *error = NULL;
 
-    gint64 start_time = gbb_test_run_get_start_time(application->run);
-
     if (!g_file_query_exists(application->log_folder, NULL)) {
         if (!g_file_make_directory_with_parents(application->log_folder, NULL, &error)) {
             g_warning("Cannot create log directory: %s\n", error->message);
@@ -446,21 +444,12 @@ write_run_to_disk(GbbApplication *application,
         }
     }
 
-    GDateTime *start_datetime = g_date_time_new_from_unix_utc(start_time);
-    char *start_string = g_date_time_format(start_datetime, "%F-%T");
-    char *file_name = g_strdup_printf("%s-%s.json", start_string, application->test->id);
-    GFile *file = g_file_get_child(application->log_folder, file_name);
-    g_free(file_name);
-    g_free(start_string);
-    g_date_time_unref(start_datetime);
-
-    char *file_path = g_file_get_path(file);
-    if (!gbb_test_run_write_to_file(application->run, file_path, &error)) {
+    char *path = gbb_test_run_get_default_path(run, application->log_folder);
+    if (!gbb_test_run_write_to_file(application->run, path, &error)) {
         g_warning("Can't write test run to disk: %s\n", error->message);
         g_clear_error(&error);
     }
-    g_free(file_path);
-    g_object_unref(file);
+    g_free(path);
 }
 
 static void
diff --git a/src/commandline.c b/src/commandline.c
index 36e7919..812e100 100644
--- a/src/commandline.c
+++ b/src/commandline.c
@@ -1,5 +1,7 @@
 /* -*- mode: C; c-file-style: "stroustrup"; indent-tabs-mode: nil; -*- */
 
+#include "config.h"
+
 #include <dirent.h>
 #include <fcntl.h>
 #include <stdio.h>
@@ -17,6 +19,7 @@
 #include "remote-player.h"
 #include "event-recorder.h"
 #include "power-monitor.h"
+#include "test-runner.h"
 #include "xinput-wait.h"
 #include "util.h"
 
@@ -162,9 +165,196 @@ record(int argc, char **argv)
     return 0;
 }
 
+static char *test_duration;
+static int test_min_battery = -42;
+static int test_screen_brightness = 50;
+static char *test_output;
+
+static GOptionEntry test_options[] =
+{
+    { "duration", 'd', 0, G_OPTION_ARG_STRING, &test_duration, "Duration (1h, 10m, etc.)", "DURATION" },
+    { "min-battery", 'm', 0, G_OPTION_ARG_INT, &test_duration, "", "PERCENT" },
+    { "screen-brightness", 0, 0, G_OPTION_ARG_INT, &test_screen_brightness, "screen backlight brightness 
(0-100)", "PERCENT" },
+    { "output", 'o', 0, G_OPTION_ARG_FILENAME, &test_output, "Output filename", "FILENAME" },
+    { NULL }
+};
+
+static void
+test_on_player_ready(GbbEventPlayer *player,
+                     GbbTestRunner  *runner)
+{
+    gbb_test_runner_start(runner);
+}
+
+static char *
+make_default_filename(GbbTestRunner *runner)
+{
+    char *folder_path = g_build_filename(g_get_user_data_dir(), PACKAGE_NAME, "logs", NULL);
+    GFile *log_folder = g_file_new_for_path(folder_path);
+    g_free(folder_path);
+
+    if (!g_file_query_exists(log_folder, NULL)) {
+        GError *error = NULL;
+        if (!g_file_make_directory_with_parents(log_folder, NULL, &error))
+            die("Cannot create log directory: %s\n", error->message);
+    }
+
+    GbbTestRun *run = gbb_test_runner_get_run(runner);
+    char *filename = gbb_test_run_get_default_path(run, log_folder);
+    g_object_unref(log_folder);
+    return filename;
+}
+
+static void
+on_runner_phase_changed(GbbTestRunner *runner,
+                        GMainLoop     *loop)
+{
+    switch (gbb_test_runner_get_phase(runner)) {
+    case GBB_TEST_PHASE_RUNNING:
+        if (test_output == NULL)
+            test_output = make_default_filename(runner);
+        fprintf(stderr, "Running; will write output to %s\n", test_output);
+
+        break;
+    case GBB_TEST_PHASE_STOPPED: {
+        GbbTestRun *run = gbb_test_runner_get_run(runner);
+        GError *error = NULL;
+        if (!gbb_test_run_write_to_file(run, test_output, &error))
+            die("Can't write test run to disk: %s", error->message);
+        g_main_loop_quit(loop);
+        break;
+    }
+    default:
+        break;
+    }
+}
+
+static char *
+test_string(void)
+{
+    GString *s = g_string_new(NULL);
+
+    g_string_append(s, "Available tests:\n");
+    GList *tests = gbb_battery_test_list_all();
+    GList *l;
+    for (l = tests; l; l = l->next) {
+        GbbBatteryTest *t = l->data;
+        g_string_append_printf(s, "  %s%s%s",
+                               t->id,
+                               t->description ? " - " : "",
+                               t->description ? t->description : "");
+        if (l->next)
+            g_string_append(s, "\n");
+    }
+    return g_string_free(s, FALSE);
+}
+
+static void
+test_prepare_context(GOptionContext *context)
+{
+    char *description = test_string();
+    g_option_context_set_description(context, description);
+}
+
+static gboolean
+add_unit(char unit, int value, int *total)
+{
+    switch (unit) {
+    case 'h':
+        *total += 3600 * value;
+        return TRUE;
+    case 'm':
+        *total += 60 * value;
+        return TRUE;
+    case 's':
+        *total += value;
+        return TRUE;
+    default:
+        return FALSE;
+    }
+}
+
+static int
+parse_duration(const char *duration)
+{
+    char after;
+    int v1, v2, v3;
+    char u1, u2, u3;
+    int total = 0;
+
+    int count = sscanf(duration, "%d%c%d%c%d%c%c",
+                       &v1, &u1, &v2, &u2, &v3, &u3, &after);
+    if (count < 2 || count > 6)
+        goto fail;
+    if (count %2 != 0)
+        goto fail;
+    if (count >= 2 && !add_unit(u1, v1, &total))
+        goto fail;
+    if (count >= 4 && !add_unit(u2, v2, &total))
+        goto fail;
+    if (count >= 6 && !add_unit(u3, v3, &total))
+        goto fail;
+
+    return total;
+
+fail:
+    die("Can't parse duration string '%s'", duration);
+}
+
+static int
+test(int argc, char **argv)
+{
+    if (test_duration != NULL && test_min_battery != -42)
+        die("Only one of --min-battery and --duration can be specified");
+    if (test_min_battery != -42 && (test_min_battery < 0 || test_min_battery > 100))
+        die("--min-battery argument must be between 0 and 100");
+    if (test_screen_brightness < 0 || test_screen_brightness > 100)
+        die("--screen-brightness argument must be between 0 and 100");
+
+    const char *test_id = argv[1];
+    GbbBatteryTest *test = gbb_battery_test_get_for_id(test_id);
+    if (test == NULL) {
+        fprintf(stderr, "Unknown test %s\n", test_id);
+        fprintf(stderr, "%s\n", test_string());
+        exit(1);
+    }
+
+    GbbTestRun *run = gbb_test_run_new(test);
+
+    if (test_min_battery != -42) {
+    } else if (test_duration != NULL) {
+        int seconds = parse_duration(test_duration);
+        gbb_test_run_set_duration_time(run, seconds);
+    } else {
+        gbb_test_run_set_duration_time(run, 10 * 60);
+    }
+
+    gbb_test_run_set_screen_brightness(run, test_screen_brightness);
+
+    GbbTestRunner *runner = gbb_test_runner_new();
+    gbb_test_runner_set_run(runner, run);
+
+    GbbEventPlayer *player = gbb_test_runner_get_event_player(runner);
+    if (gbb_event_player_is_ready(player)) {
+        test_on_player_ready(player, runner);
+    } else {
+        g_signal_connect(player, "ready",
+                         G_CALLBACK(test_on_player_ready), runner);
+    }
+
+    GMainLoop *loop = g_main_loop_new (NULL, FALSE);
+    g_signal_connect(runner, "phase-changed",
+                         G_CALLBACK(on_runner_phase_changed), loop);
+
+    g_main_loop_run (loop);
+
+    return 0;
+}
+
 typedef struct {
     const char *command;
     const GOptionEntry *options;
+    void (*prepare_context) (GOptionContext *context);
     int (*run) (int argc, char **argv);
     int min_args;
     int max_args;
@@ -172,10 +362,11 @@ typedef struct {
 } Subcommand;
 
 Subcommand subcommands[] = {
-    { "monitor",      monitor_options, monitor, 0, 0 },
-    { "play",         play_options, play, 1, 1, "FILENAME" },
-    { "play-local",   play_options, play_local, 1, 1, "FILENAME" },
-    { "record",       record_options, record, 0, 0 },
+    { "monitor",      monitor_options, NULL, monitor, 0, 0 },
+    { "play",         play_options, NULL, play, 1, 1, "FILENAME" },
+    { "play-local",   play_options, NULL, play_local, 1, 1, "FILENAME" },
+    { "record",       record_options, NULL, record, 0, 0 },
+    { "test",         test_options, test_prepare_context, test, 1, 1, "TEST_ID" },
     { NULL }
 };
 
@@ -215,6 +406,9 @@ main(int argc, char **argv)
             GOptionContext *context = g_option_context_new(subcommand->param_string);
             GError *error = NULL;
 
+            if (subcommand->prepare_context)
+                subcommand->prepare_context(context);
+
             g_option_context_add_main_entries(context, subcommand->options, NULL);
             if (!g_option_context_parse (context, &argc, &argv, &error))
                 die("option parsing failed: %s", error->message);
diff --git a/src/test-run.c b/src/test-run.c
index d3dc1cd..dab23a3 100644
--- a/src/test-run.c
+++ b/src/test-run.c
@@ -408,6 +408,28 @@ gbb_test_run_write_to_file(GbbTestRun *run,
     return success;
 }
 
+char *
+gbb_test_run_get_default_path(GbbTestRun *run,
+                              GFile      *folder)
+{
+    g_return_val_if_fail(run->start_time != 0, NULL);
+    g_return_val_if_fail(run->test != NULL, NULL);
+
+    GDateTime *start_datetime = g_date_time_new_from_unix_utc(run->start_time);
+    char *start_string = g_date_time_format(start_datetime, "%F-%T");
+    char *file_name = g_strdup_printf("%s-%s.json", start_string, run->test->id);
+    GFile *file = g_file_get_child(folder, file_name);
+    g_free(file_name);
+    g_free(start_string);
+    g_date_time_unref(start_datetime);
+
+    char *file_path = g_file_get_path(file);
+
+    g_object_unref(file);
+
+    return file_path;
+}
+
 typedef enum {
     MISSING, ERROR, OK
 } GetResult;
diff --git a/src/test-run.h b/src/test-run.h
index 6330c33..19f1c95 100644
--- a/src/test-run.h
+++ b/src/test-run.h
@@ -68,6 +68,9 @@ const GbbPowerState *gbb_test_run_get_last_state  (GbbTestRun *run);
 double          gbb_test_run_get_max_power        (GbbTestRun *run);
 double          gbb_test_run_get_max_battery_life (GbbTestRun *run);
 
+char *gbb_test_run_get_default_path(GbbTestRun *run,
+                                    GFile      *folder);
+
 gboolean gbb_test_run_write_to_file(GbbTestRun *run,
                                     const char *filename,
                                     GError    **error);
diff --git a/src/test-runner.c b/src/test-runner.c
index 24bb853..cd9fa02 100644
--- a/src/test-runner.c
+++ b/src/test-runner.c
@@ -187,6 +187,12 @@ gbb_test_runner_set_run(GbbTestRunner *runner,
     runner->test = gbb_test_run_get_test(run);
 }
 
+GbbTestRun *
+gbb_test_runner_get_run(GbbTestRunner *runner)
+{
+    return runner->run;
+}
+
 void
 gbb_test_runner_start(GbbTestRunner *runner)
 {
diff --git a/src/test-runner.h b/src/test-runner.h
index f36ace3..53e78a6 100644
--- a/src/test-runner.h
+++ b/src/test-runner.h
@@ -38,6 +38,7 @@ gboolean     gbb_test_runner_get_stop_requested(GbbTestRunner *runner);
 
 void gbb_test_runner_set_run(GbbTestRunner *runner,
                              GbbTestRun    *run);
+GbbTestRun *gbb_test_runner_get_run(GbbTestRunner *runner);
 
 void gbb_test_runner_start(GbbTestRunner *runner);
 void gbb_test_runner_stop (GbbTestRunner *runner);
diff --git a/src/util.h b/src/util.h
index 9149580..a131c19 100644
--- a/src/util.h
+++ b/src/util.h
@@ -12,4 +12,6 @@ void die_errno(const char *msg, ...)
 void break_time(double span,
                 int *h, int *m, int *s);
 
+
+
 #endif /* __UTIL_H__ */