Hi Lénaïc
I've added some comments about testing
On 09/05/2021 22:32, Lénaïc Huard wrote:
[...]
+struct maintenance_start_opts {
+ enum scheduler scheduler;
+};
+
+static void resolve_auto_scheduler(enum scheduler *scheduler)
+{
+ if (*scheduler != SCHEDULER_AUTO)
+ return;
+
#if defined(__APPLE__)
-static const char platform_scheduler[] = "launchctl";
+ *scheduler = SCHEDULER_LAUNCHCTL;
+ return;
+
#elif defined(GIT_WINDOWS_NATIVE)
-static const char platform_scheduler[] = "schtasks";
+ *scheduler = SCHEDULER_SCHTASKS;
+ return;
+
+#elif defined(__linux__)
+ if (is_systemd_timer_available("systemctl"))
+ *scheduler = SCHEDULER_SYSTEMD;
+ else if (is_crontab_available("crontab"))
+ *scheduler = SCHEDULER_CRON;
+ else
+ die(_("neither systemd timers nor crontab are available"));
+ return;
+
#else
-static const char platform_scheduler[] = "crontab";
+ *scheduler = SCHEDULER_CRON;
+ return;
#endif
+}
As it stands this function is untested and there is no way to test it
with the current setup. There are two difficulties with testing it (i)
it uses conditional compilation and (ii) there is no way to fake crontab
and systemctl with the current test setup. I think we can address the
latter (see below) and handle the condition compilation issues using
test prerequisites if necessary.
-static int update_background_schedule(int enable)
+static void validate_scheduler(enum scheduler scheduler)
{
- int result;
- const char *scheduler = platform_scheduler;
- const char *cmd = scheduler;
+ const char *cmd;
+
+ if (scheduler == SCHEDULER_INVALID)
+ BUG("invalid scheduler");
+ if (scheduler == SCHEDULER_AUTO)
+ BUG("resolve_auto_scheduler should have been called before");
+
+ cmd = scheduler_fn[scheduler].cmd;
+ if (!scheduler_fn[scheduler].is_available(cmd))
+ die(_("%s scheduler is not available"), cmd);
+}
+
+static int update_background_schedule(const struct maintenance_start_opts *opts,
+ int enable)
+{
+ unsigned int i;
+ int res, result = 0;
+ enum scheduler scheduler;
+ const char *cmd = NULL;
char *testing;
struct lock_file lk;
char *lock_path = xstrfmt("%s/schedule", the_repository->objects->odb->path);
+ if (hold_lock_file_for_update(&lk, lock_path, LOCK_NO_DEREF) < 0)
+ return error(_("another process is scheduling background maintenance"));
+
testing = xstrdup_or_null(getenv("GIT_TEST_MAINT_SCHEDULER"));
if (testing) {
char *sep = strchr(testing, ':');
if (!sep)
die("GIT_TEST_MAINT_SCHEDULER unparseable: %s", testing);
*sep = '\0';
- scheduler = testing;
+ scheduler = parse_scheduler(testing);
cmd = sep + 1;
+ result = scheduler_fn[scheduler].update_schedule(
+ enable, get_lock_file_fd(&lk), cmd);
+ goto done;
}
- if (hold_lock_file_for_update(&lk, lock_path, LOCK_NO_DEREF) < 0)
- return error(_("another process is scheduling background maintenance"));
-
- if (!strcmp(scheduler, "launchctl"))
- result = launchctl_update_schedule(enable, get_lock_file_fd(&lk), cmd);
- else if (!strcmp(scheduler, "schtasks"))
- result = schtasks_update_schedule(enable, get_lock_file_fd(&lk), cmd);
- else if (!strcmp(scheduler, "crontab"))
- result = crontab_update_schedule(enable, get_lock_file_fd(&lk), cmd);
- else
- die("unknown background scheduler: %s", scheduler);
+ for (i = 1; i < ARRAY_SIZE(scheduler_fn); i++) {
+ int enable_scheduler = enable && (opts->scheduler == i);
+ cmd = scheduler_fn[i].cmd;
+ if (!scheduler_fn[i].is_available(cmd))
+ continue;
+ res = scheduler_fn[i].update_schedule(
+ enable_scheduler, get_lock_file_fd(&lk), cmd);
+ if (enable_scheduler)
+ result = res;
+ }
This loop which is responsible for disabling the existing scheduler and
enabling a new one is completely untested. I think that before this
patch special casing the testing above still ran the important code,
however now we fail to test an important aspect of the business logic.
As we can only fake one command name the current test setup is
insufficient to fix this. I think the best solution would be to mock
systemctl, crontab, and the other commands in the test environment.
mkdir bin &&
PATH="$(pwd)/bin:$PATH" &&
test_write_script systemctl <<-\EOF &&
# Mock systemctl, set FAKE_SYSTEMD=0 in the
# environment to fake systemctl missing
case "$*" in
"--user list-timers") test ${FAKE_SYSTEMD:-1} = 1;
exit $?;;
*) printf "%s\n" "$*";;
esac
EOF
# and so on for crontab etc
Then it would be possible to test the various values
--scheduler=<scheduler> including 'auto' (by setting FAKE_SYSTEMD=0 or
FAKE_CRONTAB=0) and that we disable cron when enabling systemd and vice
versa. Mocking the commands would also allow us to cleanup the code in
gc.c as it would no longer need to pass command names around.
+done:
rollback_lock_file(&lk);
free(testing);
return result;
}
-static int maintenance_start(void)
+static const char *const builtin_maintenance_start_usage[] = {
+ N_("git maintenance start [--scheduler=<scheduler>]"), NULL
+};
+
+static int maintenance_start(int argc, const char **argv, const char *prefix)
{
+ struct maintenance_start_opts opts;
+ struct option builtin_maintenance_start_options[] = {
+ OPT_CALLBACK(
+ 0, "scheduler", &opts.scheduler, N_("scheduler"),
+ N_("scheduler to use to trigger git maintenance run"),
+ maintenance_opt_scheduler),
+ OPT_END()
+ };
+ memset(&opts, 0, sizeof(opts));
+
+ argc = parse_options(argc, argv, prefix,
+ builtin_maintenance_start_options,
+ builtin_maintenance_start_usage, 0);
This new command line option is completely untested
Best Wishes
Phillip
+
+ resolve_auto_scheduler(&opts.scheduler);
+ validate_scheduler(opts.scheduler);
+
+ if (argc > 0)
+ usage_with_options(builtin_maintenance_start_usage,
+ builtin_maintenance_start_options);
+
if (maintenance_register())
warning(_("failed to add repo to global config"));
-
- return update_background_schedule(1);
+ return update_background_schedule(&opts, 1);
}
static int maintenance_stop(void)
{
- return update_background_schedule(0);
+ return update_background_schedule(NULL, 0);
}
static const char builtin_maintenance_usage[] = N_("git maintenance <subcommand> [<options>]");
@@ -2027,7 +2354,7 @@ int cmd_maintenance(int argc, const char **argv, const char *prefix)
if (!strcmp(argv[1], "run"))
return maintenance_run(argc - 1, argv + 1, prefix);
if (!strcmp(argv[1], "start"))
- return maintenance_start();
+ return maintenance_start(argc - 1, argv + 1, prefix);
if (!strcmp(argv[1], "stop"))
return maintenance_stop();
if (!strcmp(argv[1], "register"))
diff --git a/t/t7900-maintenance.sh b/t/t7900-maintenance.sh
index 2412d8c5c0..6e6316cd90 100755
--- a/t/t7900-maintenance.sh
+++ b/t/t7900-maintenance.sh
@@ -20,6 +20,20 @@ test_xmllint () {
fi
}
+test_lazy_prereq SYSTEMD_ANALYZE '
+ systemd-analyze --help >out &&
+ grep verify out
+'
+
+test_systemd_analyze_verify () {
+ if test_have_prereq SYSTEMD_ANALYZE
+ then
+ systemd-analyze verify "$@"
+ else
+ true
+ fi
+}
+
test_expect_success 'help text' '
test_expect_code 129 git maintenance -h 2>err &&
test_i18ngrep "usage: git maintenance <subcommand>" err &&
@@ -615,6 +629,43 @@ test_expect_success 'start and stop Windows maintenance' '
test_cmp expect args
'
+test_expect_success 'start and stop Linux/systemd maintenance' '
+ write_script print-args <<-\EOF &&
+ echo $* >>args
+ EOF
+
+ rm -f args &&
+ GIT_TEST_MAINT_SCHEDULER="systemd:./print-args" git maintenance start &&
+
+ # start registers the repo
+ git config --get --global --fixed-value maintenance.repo "$(pwd)" &&
+
+ test_systemd_analyze_verify "$HOME/.config/systemd/user/git-maintenance@.service" &&
+
+ rm -f expect &&
+ for frequency in hourly daily weekly
+ do
+ echo "--user enable --now git-maintenance@${frequency}.timer" >>expect || return 1
+ done &&
+ test_cmp expect args &&
+
+ rm -f args &&
+ GIT_TEST_MAINT_SCHEDULER="systemd:./print-args" git maintenance stop &&
+
+ # stop does not unregister the repo
+ git config --get --global --fixed-value maintenance.repo "$(pwd)" &&
+
+ test_path_is_missing "$HOME/.config/systemd/user/git-maintenance@.timer" &&
+ test_path_is_missing "$HOME/.config/systemd/user/git-maintenance@.service" &&
+
+ rm -f expect &&
+ for frequency in hourly daily weekly
+ do
+ echo "--user disable --now git-maintenance@${frequency}.timer" >>expect || return 1
+ done &&
+ test_cmp expect args
+'
+
test_expect_success 'register preserves existing strategy' '
git config maintenance.strategy none &&
git maintenance register &&
