From: "Derrick Stolee via GitGitGadget" <gitgitgadget@gmail.com>
To: git@vger.kernel.org
Cc: Eric Sunshine <sunshine@sunshineco.com>,
Derrick Stolee <stolee@gmail.com>,
Derrick Stolee <derrickstolee@github.com>
Subject: [PATCH v7 0/4] Maintenance IV: Platform-specific background maintenance
Date: Tue, 05 Jan 2021 13:08:24 +0000 [thread overview]
Message-ID: <pull.776.v7.git.1609852108.gitgitgadget@gmail.com> (raw)
In-Reply-To: <pull.776.v6.git.1607542142.gitgitgadget@gmail.com>
This is based on ds/maintenance-part-3.
After sitting with the background maintenance as it has been cooking, I
wanted to come back around and implement the background maintenance for
Windows. However, I noticed that there were some things bothering me with
background maintenance on my macOS machine. These are detailed in PATCH 3,
but the tl;dr is that 'cron' is not recommended by Apple and instead
'launchd' satisfies our needs.
This series implements the background scheduling so git maintenance
(start|stop) works on those platforms. I've been operating with these
schedules for a while now without the problems described in the patches.
There is a particularly annoying case about console windows popping up on
Windows, but PATCH 4 describes a plan to get around that.
Update in V7
============
* I had included an "encoding" string in the XML file for schtasks based on
an example using UTF-8. The cross-platform tests then complained (in
xmllint) because they wrote in ASCII instead. However, actually testing
the situation on Windows (see [1]) against the real schtasks finds that
it doesn't like that encoding string. I removed it entirely, and
everything seems happier.
* I squashed Eric's two commits making the tests better. He remains a
co-author and I kept his Helped-by. I had to rearrange the commit message
a bit to point out the care he took for the cross-platform tests without
referring to the test doing the wrong thing.
[1] https://github.com/microsoft/git/pull/304
Thanks, -Stolee
cc: jrnieder@gmail.com cc: jonathantanmy@google.com cc: sluongng@gmail.com
cc: Đoàn Trần Công Danh congdanhqx@gmail.com cc: Martin Ågren
martin.agren@gmail.com cc: Eric Sunshine sunshine@sunshineco.com cc: Derrick
Stolee stolee@gmail.com
Derrick Stolee (4):
maintenance: extract platform-specific scheduling
maintenance: include 'cron' details in docs
maintenance: use launchctl on macOS
maintenance: use Windows scheduled tasks
Documentation/git-maintenance.txt | 116 ++++++++
builtin/gc.c | 422 ++++++++++++++++++++++++++++--
t/t7900-maintenance.sh | 104 +++++++-
t/test-lib.sh | 7 +-
4 files changed, 615 insertions(+), 34 deletions(-)
base-commit: 0016b618182f642771dc589cf0090289f9fe1b4f
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-776%2Fderrickstolee%2Fmaintenance%2FmacOS-v7
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-776/derrickstolee/maintenance/macOS-v7
Pull-Request: https://github.com/gitgitgadget/git/pull/776
Range-diff vs v6:
1: 4807342b001 = 1: 4807342b001 maintenance: extract platform-specific scheduling
2: 7cc70a8fe7b = 2: 7cc70a8fe7b maintenance: include 'cron' details in docs
3: cd015a5cbd7 ! 3: 3576c7aa54e maintenance: use launchctl on macOS
@@ Commit message
the XML format. This is useful for any system that might contain
the tool, so use it whenever it is available.
+ We strive to make these tests work on all platforms, but Windows caused
+ some headaches. In particular, the value of getuid() called by the C
+ code is not guaranteed to be the same as `$(id -u)` invoked by a test.
+ This is because `git.exe` is a native Windows program, whereas the
+ utility programs run by the test script mostly utilize the MSYS2 runtime,
+ which emulates a POSIX-like environment. Since the purpose of the test
+ is to check that the input to the hook is well-formed, the actual user
+ ID is immaterial, thus we can work around the problem by making the the
+ test UID-agnostic. Another subtle issue is the $HOME environment
+ variable being a Windows-style path instead of a Unix-style path. We can
+ be more flexible here instead of expecting exact path matches.
+
+ Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Co-authored-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
@@ t/t7900-maintenance.sh: test_expect_success 'start preserves existing schedule'
grep "Important information!" cron.txt
'
-+test_expect_success !MINGW 'start and stop macOS maintenance' '
-+ uid=$(id -u) &&
++test_expect_success 'start and stop macOS maintenance' '
++ # ensure $HOME can be compared against hook arguments on all platforms
++ pfx=$(cd "$HOME" && pwd) &&
+
+ write_script print-args <<-\EOF &&
-+ echo $* >>args
++ echo $* | sed "s:gui/[0-9][0-9]*:gui/[UID]:" >>args
+ EOF
+
+ rm -f args &&
@@ t/t7900-maintenance.sh: test_expect_success 'start preserves existing schedule'
+ EOF
+ test_cmp expect actual &&
+
-+ rm expect &&
++ rm -f expect &&
+ for frequency in hourly daily weekly
+ do
-+ PLIST="$HOME/Library/LaunchAgents/org.git-scm.git.$frequency.plist" &&
++ PLIST="$pfx/Library/LaunchAgents/org.git-scm.git.$frequency.plist" &&
+ test_xmllint "$PLIST" &&
+ grep schedule=$frequency "$PLIST" &&
-+ echo "bootout gui/$uid $PLIST" >>expect &&
-+ echo "bootstrap gui/$uid $PLIST" >>expect || return 1
++ echo "bootout gui/[UID] $PLIST" >>expect &&
++ echo "bootstrap gui/[UID] $PLIST" >>expect || return 1
+ done &&
+ test_cmp expect args &&
+
@@ t/t7900-maintenance.sh: test_expect_success 'start preserves existing schedule'
+ # stop does not unregister the repo
+ git config --get --global maintenance.repo "$(pwd)" &&
+
-+ printf "bootout gui/$uid $HOME/Library/LaunchAgents/org.git-scm.git.%s.plist\n" \
++ printf "bootout gui/[UID] $pfx/Library/LaunchAgents/org.git-scm.git.%s.plist\n" \
+ hourly daily weekly >expect &&
+ test_cmp expect args &&
+ ls "$HOME/Library/LaunchAgents" >actual &&
4: 6ad4a6b98c6 ! 4: 68f5013dee3 maintenance: use Windows scheduled tasks
@@ Documentation/git-maintenance.txt: To create more advanced customizations to you
Part of the linkgit:git[1] suite
## builtin/gc.c ##
+@@ builtin/gc.c: static int launchctl_schedule_plist(const char *exec_path, enum schedule_priorit
+ die(_("failed to create directories for '%s'"), filename);
+ plist = xfopen(filename, "w");
+
+- preamble = "<?xml version=\"1.0\" encoding=\"US-ASCII\"?>\n"
++ preamble = "<?xml version=\"1.0\"?>\n"
+ "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
+ "<plist version=\"1.0\">"
+ "<dict>\n"
@@ builtin/gc.c: static int launchctl_update_schedule(int run_maintenance, int fd, const char *cm
return launchctl_remove_plists(cmd);
}
@@ builtin/gc.c: static int launchctl_update_schedule(int run_maintenance, int fd,
+ char *name = schtasks_task_name(frequency);
+ struct strbuf tfilename = STRBUF_INIT;
+
-+ strbuf_addf(&tfilename, "schedule_%s_XXXXXX", frequency);
++ strbuf_addf(&tfilename, "%s/schedule_%s_XXXXXX",
++ get_git_common_dir(), frequency);
+ tfile = xmks_tempfile(tfilename.buf);
+ strbuf_release(&tfilename);
+
+ if (!fdopen_tempfile(tfile, "w"))
+ die(_("failed to create temp xml file"));
+
-+ xml = "<?xml version=\"1.0\" encoding=\"US-ASCII\"?>\n"
++ xml = "<?xml version=\"1.0\" ?>\n"
+ "<Task version=\"1.4\" xmlns=\"http://schemas.microsoft.com/windows/2004/02/mit/task\">\n"
+ "<Triggers>\n"
+ "<CalendarTrigger>\n";
@@ builtin/gc.c: static int update_background_schedule(int enable)
else
## t/t7900-maintenance.sh ##
-@@ t/t7900-maintenance.sh: test_expect_success !MINGW 'start and stop macOS maintenance' '
+@@ t/t7900-maintenance.sh: test_expect_success 'start and stop macOS maintenance' '
test_line_count = 0 actual
'
@@ t/t7900-maintenance.sh: test_expect_success !MINGW 'start and stop macOS mainten
+ EOF
+
+ rm -f args &&
-+ GIT_TEST_MAINT_SCHEDULER="schtasks:./print-args" GIT_TRACE2_PERF=1 git maintenance start &&
++ GIT_TEST_MAINT_SCHEDULER="schtasks:./print-args" git maintenance start &&
+
+ # start registers the repo
+ git config --get --global maintenance.repo "$(pwd)" &&
@@ t/t7900-maintenance.sh: test_expect_success !MINGW 'start and stop macOS mainten
+ for frequency in hourly daily weekly
+ do
+ grep "/create /tn Git Maintenance ($frequency) /f /xml" args &&
-+ file=$(ls schedule_$frequency*.xml) &&
-+ test_xmllint "$file" &&
-+ grep "encoding=.US-ASCII." "$file" || return 1
++ file=$(ls .git/schedule_${frequency}*.xml) &&
++ test_xmllint "$file" || return 1
+ done &&
+
+ rm -f args &&
@@ t/t7900-maintenance.sh: test_expect_success !MINGW 'start and stop macOS mainten
+ # stop does not unregister the repo
+ git config --get --global maintenance.repo "$(pwd)" &&
+
-+ rm expect &&
+ printf "/delete /tn Git Maintenance (%s) /f\n" \
+ hourly daily weekly >expect &&
+ test_cmp expect args
--
gitgitgadget
next prev parent reply other threads:[~2021-01-05 13:10 UTC|newest]
Thread overview: 83+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-03 14:03 [PATCH 0/3] Maintenance IV: Platform-specific background maintenance Derrick Stolee via GitGitGadget
2020-11-03 14:03 ` [PATCH 1/3] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-11-03 14:03 ` [PATCH 2/3] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-11-03 18:45 ` Eric Sunshine
2020-11-03 21:21 ` Derrick Stolee
2020-11-03 22:27 ` Eric Sunshine
2020-11-04 13:33 ` Derrick Stolee
2020-11-04 14:17 ` Derrick Stolee
2020-11-03 14:03 ` [PATCH 3/3] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-11-03 19:06 ` Eric Sunshine
2020-11-03 21:23 ` Derrick Stolee
2020-11-03 20:18 ` [PATCH 0/3] Maintenance IV: Platform-specific background maintenance Junio C Hamano
2020-11-03 20:21 ` Junio C Hamano
2020-11-03 21:09 ` Derrick Stolee
2020-11-03 22:30 ` Junio C Hamano
2020-11-04 13:02 ` Derrick Stolee
2020-11-04 17:00 ` Junio C Hamano
2020-11-04 18:43 ` Derrick Stolee
2020-11-04 20:06 ` [PATCH v2 0/4] " Derrick Stolee via GitGitGadget
2020-11-04 20:06 ` [PATCH v2 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-11-04 20:06 ` [PATCH v2 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2020-11-11 7:10 ` Eric Sunshine
2020-11-04 20:06 ` [PATCH v2 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-11-11 8:12 ` Eric Sunshine
2020-11-12 13:42 ` Derrick Stolee
2020-11-12 16:43 ` Eric Sunshine
2020-11-04 20:06 ` [PATCH v2 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-11-11 8:59 ` Eric Sunshine
2020-11-12 13:56 ` Derrick Stolee
2020-11-13 14:00 ` [PATCH v3 0/4] Maintenance IV: Platform-specific background maintenance Derrick Stolee via GitGitGadget
2020-11-13 14:00 ` [PATCH v3 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-11-13 14:00 ` [PATCH v3 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2020-11-13 14:00 ` [PATCH v3 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-11-13 20:19 ` Eric Sunshine
2020-11-13 20:42 ` Derrick Stolee
2020-11-13 20:53 ` Eric Sunshine
2020-11-13 20:56 ` Eric Sunshine
2020-11-13 14:00 ` [PATCH v3 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-11-13 20:44 ` Eric Sunshine
2020-11-13 21:32 ` Derrick Stolee
2020-11-13 21:40 ` Eric Sunshine
2020-11-16 13:13 ` Derrick Stolee
2020-11-13 20:47 ` [PATCH v3 0/4] Maintenance IV: Platform-specific background maintenance Eric Sunshine
2020-11-14 9:23 ` Eric Sunshine
2020-11-16 13:17 ` Derrick Stolee
2020-11-17 21:13 ` [PATCH v4 " Derrick Stolee via GitGitGadget
2020-11-17 21:13 ` [PATCH v4 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-11-17 21:13 ` [PATCH v4 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2020-11-18 0:34 ` Eric Sunshine
2020-11-18 18:30 ` Derrick Stolee
2020-11-17 21:13 ` [PATCH v4 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-11-18 6:45 ` Eric Sunshine
2020-11-18 18:22 ` Derrick Stolee
2020-11-17 21:13 ` [PATCH v4 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-11-18 7:15 ` Eric Sunshine
2020-11-18 18:30 ` Derrick Stolee
2020-11-18 20:54 ` Eric Sunshine
2020-11-18 21:16 ` Derrick Stolee
2020-11-17 23:36 ` [PATCH v4 0/4] Maintenance IV: Platform-specific background maintenance Eric Sunshine
2020-11-24 2:20 ` Derrick Stolee
2020-11-24 2:59 ` Eric Sunshine
2020-11-17 23:54 ` Eric Sunshine
2020-11-24 4:16 ` [PATCH v5 " Derrick Stolee via GitGitGadget
2020-11-24 4:16 ` [PATCH v5 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-11-24 4:16 ` [PATCH v5 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2020-11-24 4:16 ` [PATCH v5 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-11-24 4:16 ` [PATCH v5 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-11-27 9:08 ` Eric Sunshine
2020-12-09 19:28 ` [PATCH v6 0/4] Maintenance IV: Platform-specific background maintenance Derrick Stolee via GitGitGadget
2020-12-09 19:28 ` [PATCH v6 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2020-12-09 19:29 ` [PATCH v6 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2020-12-09 19:29 ` [PATCH v6 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2020-12-09 19:29 ` [PATCH v6 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
2020-12-10 0:32 ` [PATCH v6 0/4] Maintenance IV: Platform-specific background maintenance Junio C Hamano
2020-12-10 0:49 ` Eric Sunshine
2020-12-10 1:04 ` Junio C Hamano
2021-01-05 12:17 ` Derrick Stolee
2021-01-05 13:08 ` Derrick Stolee via GitGitGadget [this message]
2021-01-05 13:08 ` [PATCH v7 1/4] maintenance: extract platform-specific scheduling Derrick Stolee via GitGitGadget
2021-01-05 13:08 ` [PATCH v7 2/4] maintenance: include 'cron' details in docs Derrick Stolee via GitGitGadget
2021-01-05 13:08 ` [PATCH v7 3/4] maintenance: use launchctl on macOS Derrick Stolee via GitGitGadget
2021-01-10 6:34 ` Eric Sunshine
2021-01-05 13:08 ` [PATCH v7 4/4] maintenance: use Windows scheduled tasks Derrick Stolee via GitGitGadget
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=pull.776.v7.git.1609852108.gitgitgadget@gmail.com \
--to=gitgitgadget@gmail.com \
--cc=derrickstolee@github.com \
--cc=git@vger.kernel.org \
--cc=stolee@gmail.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).