From patchwork Wed Apr 12 21:45:02 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Robin Jarry X-Patchwork-Id: 13209578 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 7E1D5C77B6C for ; Wed, 12 Apr 2023 21:45:22 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229609AbjDLVpV (ORCPT ); Wed, 12 Apr 2023 17:45:21 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42932 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229482AbjDLVpU (ORCPT ); Wed, 12 Apr 2023 17:45:20 -0400 Received: from relay3-d.mail.gandi.net (relay3-d.mail.gandi.net [217.70.183.195]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id D4BD91FD2 for ; Wed, 12 Apr 2023 14:45:17 -0700 (PDT) Received: (Authenticated sender: robin@jarry.cc) by mail.gandi.net (Postfix) with ESMTPSA id D8CEA60006; Wed, 12 Apr 2023 21:45:14 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=jarry.cc; s=gm1; t=1681335916; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=t8leZAQcxzjXduo0kcVpSLamZnkvMZs4egJTfu0P4fg=; b=QCThZfEaWHQhSYZA2avmMc76lDjFzR0nFIT5/0XjOGAjH2UEKiofJcr4uriAJbwfWRZr0s kHiU8bRUwljN+D9mIZf6kmS37U6BAwPk5f20g5g9avQVdlPKv5b/N1OUmmz5xb4txEsJ9L KwIBcm4BVE60cCSZ8fm6JtPKiZBexJO37TyRmGNhNirCOJy4ygrzcpvFnEwfk53mGy9Tw6 gg+hdfcWqe/ijBgO9dzuUZ7BwaVPSmzJ2bFVyAPVI1DWr2Z63B+XR1GppHtEYiqTvBMMWX HTbsuYxq3BQM+akLP3W1feOGcKr8t0E/OM2/PPPfXflPoY51Y/psjJVNUR9txQ== From: Robin Jarry To: git@vger.kernel.org Cc: Phillip Wood , =?utf-8?b?w4Z2YXIgQXJuZmrDtnI=?= =?utf-8?b?w7AgQmphcm1hc29u?= , Tim Culverhouse , Nicolas Dichtel , Bagas Sanjaya , Junio C Hamano , Eric Sunshine , Michael Strawbridge , Robin Jarry Subject: [PATCH v3] send-email: export patch counters in validate environment Date: Wed, 12 Apr 2023 23:45:02 +0200 Message-Id: <20230412214502.90174-1-robin@jarry.cc> X-Mailer: git-send-email 2.40.0 In-Reply-To: <20230412095434.140754-1-robin@jarry.cc> References: <20230412095434.140754-1-robin@jarry.cc> MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org When sending patch series (with a cover-letter or not) sendemail-validate is called with every email/patch file independently from the others. When one of the patches depends on a previous one, it may not be possible to use this hook in a meaningful way. A hook that wants to check some property of the whole series needs to know which patch is the final one. Expose the current and total number of patches to the hook via the GIT_SENDEMAIL_PATCH_COUNTER and GIT_SENDEMAIL_PATCH_TOTAL environment variables so that both incremental and global validation is possible. Sharing any other state between successive invocations of the validate hook must be done via external means. For example, by storing it in a git config sendemail.validateWorktree entry. Add a sample script with placeholders for validation. Suggested-by: Phillip Wood Signed-off-by: Robin Jarry --- Notes: v2 -> v3: * Fixed style in sample script following Documentation/CodingGuidelines * Used git worktree instead of a shallow clone. * Removed set -e and added explicit error handling. * Reworded some comments. Documentation/githooks.txt | 22 +++++++ git-send-email.perl | 17 +++++- templates/hooks--sendemail-validate.sample | 71 ++++++++++++++++++++++ 3 files changed, 109 insertions(+), 1 deletion(-) create mode 100755 templates/hooks--sendemail-validate.sample diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt index 62908602e7be..c8e55b2613f5 100644 --- a/Documentation/githooks.txt +++ b/Documentation/githooks.txt @@ -600,6 +600,28 @@ the name of the file that holds the e-mail to be sent. Exiting with a non-zero status causes `git send-email` to abort before sending any e-mails. +The following environment variables are set when executing the hook. + +`GIT_SENDEMAIL_FILE_COUNTER`:: + A 1-based counter incremented by one for every file holding an e-mail + to be sent (excluding any FIFOs). This counter does not follow the + patch series counter scheme. It will always start at 1 and will end at + GIT_SENDEMAIL_FILE_TOTAL. + +`GIT_SENDEMAIL_FILE_TOTAL`:: + The total number of files that will be sent (excluding any FIFOs). This + counter does not follow the patch series counter scheme. It will always + be equal to the number of files being sent, whether there is a cover + letter or not. + +These variables may for instance be used to validate patch series. + +The sample `sendemail-validate` hook that comes with Git checks that all sent +patches (excluding the cover letter) can be applied on top of the upstream +repository default branch without conflicts. Some placeholders are left for +additional validation steps to be performed after all patches of a given series +have been applied. + fsmonitor-watchman ~~~~~~~~~~~~~~~~~~ diff --git a/git-send-email.perl b/git-send-email.perl index 07f2a0cbeaad..497ec0354790 100755 --- a/git-send-email.perl +++ b/git-send-email.perl @@ -795,11 +795,26 @@ sub is_format_patch_arg { @files = handle_backup_files(@files); if ($validate) { + # FIFOs can only be read once, exclude them from validation. + my @real_files = (); foreach my $f (@files) { unless (-p $f) { - validate_patch($f, $target_xfer_encoding); + push(@real_files, $f); } } + + # Run the loop once again to avoid gaps in the counter due to FIFO + # arguments provided by the user. + my $num = 1; + my $num_files = scalar @real_files; + $ENV{GIT_SENDEMAIL_FILE_TOTAL} = "$num_files"; + foreach my $r (@real_files) { + $ENV{GIT_SENDEMAIL_FILE_COUNTER} = "$num"; + validate_patch($r, $target_xfer_encoding); + $num += 1; + } + delete $ENV{GIT_SENDEMAIL_FILE_COUNTER}; + delete $ENV{GIT_SENDEMAIL_FILE_TOTAL}; } if (@files) { diff --git a/templates/hooks--sendemail-validate.sample b/templates/hooks--sendemail-validate.sample new file mode 100755 index 000000000000..f6dbaa24ad57 --- /dev/null +++ b/templates/hooks--sendemail-validate.sample @@ -0,0 +1,71 @@ +#!/bin/sh + +# An example hook script to validate a patch (and/or patch series) before +# sending it via email. +# +# The hook should exit with non-zero status after issuing an appropriate +# message if it wants to prevent the email(s) from being sent. +# +# To enable this hook, rename this file to "sendemail-validate". +# +# By default, it will only check that the patch(es) can be applied on top of +# the default upstream branch without conflicts. Replace the XXX placeholders +# with appropriate checks according to your needs. + +validate_cover_letter() { + file="$1" + # XXX: Add appropriate checks (e.g. spell checking). +} + +validate_patch() { + file="$1" + # Ensure that the patch applies without conflicts. + git am -3 "$file" || return + # XXX: Add appropriate checks for this patch (e.g. checkpatch.pl). +} + +validate_series() { + # XXX: Add appropriate checks for the whole series + # (e.g. quick build, coding style checks, etc.). +} + +get_worktree() { + if ! git config --get sendemail.validateWorktree + then + # Initialize it to a temp dir, if unset. + worktree=$(mktemp --tmpdir -d sendemail-validate.XXXXXXX) && + git config --add sendemail.validateWorktree "$worktree" && + echo "$worktree" + fi +} + +die() { + echo "sendemail-validate: error: $*" >&2 + exit 1 +} + +# main ------------------------------------------------------------------------- + +worktree=$(get_worktree) && +if test "$GIT_SENDEMAIL_FILE_COUNTER" = 1 +then + # ignore error if not a worktree + git worktree remove -f "$worktree" 2>/dev/null || : + echo "sendemail-validate: worktree $worktree" + git worktree add -fd --checkout "$worktree" refs/remotes/origin/HEAD +fi || die "failed to prepare worktree for validation" + +unset GIT_DIR GIT_WORK_TREE +cd "$worktree" && + +if grep -q "^diff --git " "$1" +then + validate_patch "$1" +else + validate_cover_letter "$1" +fi && + +if test "$GIT_SENDEMAIL_FILE_COUNTER" = "$GIT_SENDEMAIL_FILE_TOTAL" +then + validate_series +fi