From patchwork Tue Jun 18 08:19:22 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: shejialuo X-Patchwork-Id: 13701954 Received: from mail-pl1-f170.google.com (mail-pl1-f170.google.com [209.85.214.170]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id BB35013A272 for ; Tue, 18 Jun 2024 08:19:26 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.214.170 ARC-Seal: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718698768; cv=none; b=aJiiS5VUQoz0UwvorrnMMOtAHSkTtZmC6SQNdNPadiZzlziMJwPaC2J7XiP2wWgry2V7sR51g/5vpIoL9LtRYpwz7N3fGc0Y8nHzfoqyWuWGYRSEvADjPKNqR5vua8g7+lc1Ya0Ds5IfZ6G+DPO45Yo1npzxSbPWC9AC/VN8TWc= ARC-Message-Signature: i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1718698768; c=relaxed/simple; bh=1Q8puiLoNUcNBqvk/z1cUrV9dXJeB9YkESBsIwYKecQ=; h=Date:From:To:Cc:Subject:Message-ID:MIME-Version:Content-Type: Content-Disposition:In-Reply-To; b=oD+5JKJKyXdEIXCLQQNVTdO0NCslb5j8p+OYa50AsB+mme6X1EZLaAXq1W/fPm5pbYSaLO6z43kY5xTZ6fcar/s1ir9Xzg14WlhI7uHtCZg+dUXO0lt/pnT95aXlLs/eGUK9zQbeOPd3hhbxR4tfRkpIgXZ5s2ps+NBlG1bRbfE= ARC-Authentication-Results: i=1; smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com; spf=pass smtp.mailfrom=gmail.com; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b=SG9r3Lhj; arc=none smtp.client-ip=209.85.214.170 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=gmail.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="SG9r3Lhj" Received: by mail-pl1-f170.google.com with SMTP id d9443c01a7336-1f70131063cso40488685ad.2 for ; Tue, 18 Jun 2024 01:19:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1718698765; x=1719303565; darn=vger.kernel.org; h=in-reply-to:content-disposition:mime-version:message-id:subject:cc :to:from:date:from:to:cc:subject:date:message-id:reply-to; bh=nE2Oa4gqJF3nO4hU1u0l34qW8igxmELgn7c9koyU1D4=; b=SG9r3LhjO+qocwaZbeg948NJ+Plhw/PL2JYnEt3cu+5xJbis2dGRuzdMIuDOs+ftWF JPXoMZ+6CslPXk9GBSAWyWA0qquPkwJ2CYPHRKlbMpv/SQyp060jlO5VsKjxfLru836w 7EwSEx8oqeai7snlFm3NCdsenfT8Y+tHap/8TEsGc48qXsPht0fuahWvsaQivdVmhn45 UPhaTbicCyT7cRP9LkZpOD7lRAq7PNoz0t48Me7IEYaAwPL+GOzvRRTtSRC3UlR4B0dy VjBkvch+/iLrt0Oy7QgqQuBES3+guukympvhpxgzk+2N8+4DYcymecNnkDELrkQMRzNM +jbA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1718698765; x=1719303565; h=in-reply-to:content-disposition:mime-version:message-id:subject:cc :to:from:date:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=nE2Oa4gqJF3nO4hU1u0l34qW8igxmELgn7c9koyU1D4=; b=pcZrTR9TsUFfWfEOlSlGlDnuPzk3vXuyCi5pfhP1DPHATf2ZKJungiIDteTSJI9FAE 1UNora7HzjpXlfjiBURohSoUGj6pip1WJq6W3ubfqBFGxXagEhv6Vs6h+rs9ZyXw55wr kgOb0EJ1D4nm6H1EhRgwu/ehvVYpc+GOPRZH4UcpAFy7QR2znPED31h67YjoJT4sF5fL 3x0rMdbHqKOr8iitG7hzjZrfV7Zy2pvZk72iiEX1ORR6x+Vu8Y/9KOobv+MgrAgWaSb8 9Iwx3BScPPrlS6KWTQKzH717aM2Vpps5MrCw5DCGCvOVyrUV0Yi1oBNslfjnbMR8pLOj wvIA== X-Gm-Message-State: AOJu0YxaNRQbt9pVY+fo565q8qlqUWafpgk+1hsO1ebhD4IBYi8R5EGm dbJ+m2Z/x+GjcLw96+KNsoUliRRaRix3u0SCqVM8WCy2zkjDpxyn3Im74g== X-Google-Smtp-Source: AGHT+IGjEPFrgR5E8gxwntx10E3Elrl684IJ2+X/3WkHiM/0V8VRw6af7rMssI3CBP62NzJMPNQ+kQ== X-Received: by 2002:a17:902:e5d1:b0:1f6:23ce:156b with SMTP id d9443c01a7336-1f8627e8deamr147574765ad.41.1718698765237; Tue, 18 Jun 2024 01:19:25 -0700 (PDT) Received: from localhost ([2605:52c0:1:4cf:6c5a:92ff:fe25:ceff]) by smtp.gmail.com with ESMTPSA id d9443c01a7336-1f855e81d13sm91797155ad.108.2024.06.18.01.19.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 18 Jun 2024 01:19:24 -0700 (PDT) Date: Tue, 18 Jun 2024 16:19:22 +0800 From: shejialuo To: git@vger.kernel.org Cc: Patrick Steinhardt , Karthik Nayak , Junio C Hamano , Eric Sunshine Subject: [PATCH v3 6/7] fsck: add ref name check for files backend Message-ID: Precedence: bulk X-Mailing-List: git@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20240612085349.710785-1-shejialuo@gmail.com> The git-fsck(1) only implicitly checks the reference, it does not fully check refs with bad format name such as standalone "@" and name ending with ".lock". In order to provide such checks, add a new fsck message id "badRefName" with default ERROR type. Use existing "check_refname_format" to explicit check the ref name. And add a new unit test to verify the functionality. Mentored-by: Patrick Steinhardt Mentored-by: Karthik Nayak Signed-off-by: shejialuo --- Documentation/fsck-msgids.txt | 3 + fsck.h | 1 + refs/files-backend.c | 20 +++++++ t/t0602-reffiles-fsck.sh | 101 ++++++++++++++++++++++++++++++++++ 4 files changed, 125 insertions(+) create mode 100755 t/t0602-reffiles-fsck.sh diff --git a/Documentation/fsck-msgids.txt b/Documentation/fsck-msgids.txt index 5edc06c658..cc85c897cc 100644 --- a/Documentation/fsck-msgids.txt +++ b/Documentation/fsck-msgids.txt @@ -19,6 +19,9 @@ `badParentSha1`:: (ERROR) A commit object has a bad parent sha1. +`badRefName`:: + (ERROR) A ref has a bad name. + `badTagName`:: (INFO) A tag has an invalid format. diff --git a/fsck.h b/fsck.h index 6a38ac4a16..6b3e68b873 100644 --- a/fsck.h +++ b/fsck.h @@ -31,6 +31,7 @@ enum fsck_msg_type { FUNC(BAD_NAME, ERROR) \ FUNC(BAD_OBJECT_SHA1, ERROR) \ FUNC(BAD_PARENT_SHA1, ERROR) \ + FUNC(BAD_REF_NAME, ERROR) \ FUNC(BAD_TIMEZONE, ERROR) \ FUNC(BAD_TREE, ERROR) \ FUNC(BAD_TREE_SHA1, ERROR) \ diff --git a/refs/files-backend.c b/refs/files-backend.c index 74242dbba4..3f0b565a13 100644 --- a/refs/files-backend.c +++ b/refs/files-backend.c @@ -3413,6 +3413,25 @@ typedef int (*files_fsck_refs_fn)(struct fsck_refs_options *o, const char *refs_check_dir, struct dir_iterator *iter); +static int files_fsck_refs_name(struct fsck_refs_options *o, + const char *gitdir UNUSED, + const char *refs_check_dir, + struct dir_iterator *iter) +{ + struct strbuf sb = STRBUF_INIT; + int ret = 0; + + if (check_refname_format(iter->basename, REFNAME_ALLOW_ONELEVEL)) { + strbuf_addf(&sb, "%s/%s", refs_check_dir, iter->relative_path); + ret = fsck_refs_report(o, sb.buf, + FSCK_MSG_BAD_REF_NAME, + "invalid refname format"); + } + + strbuf_release(&sb); + return ret; +} + static int files_fsck_refs_dir(struct ref_store *ref_store, struct fsck_refs_options *o, const char *refs_check_dir, @@ -3464,6 +3483,7 @@ static int files_fsck_refs(struct ref_store *ref_store, { int ret; files_fsck_refs_fn fsck_refs_fns[]= { + files_fsck_refs_name, NULL }; diff --git a/t/t0602-reffiles-fsck.sh b/t/t0602-reffiles-fsck.sh new file mode 100755 index 0000000000..b2db58d2c6 --- /dev/null +++ b/t/t0602-reffiles-fsck.sh @@ -0,0 +1,101 @@ +#!/bin/sh + +test_description='Test reffiles backend consistency check' + +GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME=main +export GIT_TEST_DEFAULT_INITIAL_BRANCH_NAME +GIT_TEST_DEFAULT_REF_FORMAT=files +export GIT_TEST_DEFAULT_REF_FORMAT + +. ./test-lib.sh + +test_expect_success 'ref name should be checked' ' + test_when_finished "rm -rf repo" && + git init repo && + branch_dir_prefix=.git/refs/heads && + tag_dir_prefix=.git/refs/tags && + ( + cd repo && + git commit --allow-empty -m initial && + git checkout -b branch-1 && + git tag tag-1 && + git commit --allow-empty -m second && + git checkout -b branch-2 && + git tag tag-2 && + git tag multi_hierarchy/tag-2 + ) && + ( + cd repo && + cp $branch_dir_prefix/branch-1 $branch_dir_prefix/.branch-1 && + test_must_fail git fsck 2>err && + cat >expect <<-EOF && + error: refs/heads/.branch-1: badRefName: invalid refname format + EOF + rm $branch_dir_prefix/.branch-1 && + test_cmp expect err + ) && + ( + cd repo && + cp $tag_dir_prefix/tag-1 $tag_dir_prefix/tag-1.lock && + test_must_fail git fsck 2>err && + cat >expect <<-EOF && + error: refs/tags/tag-1.lock: badRefName: invalid refname format + EOF + rm $tag_dir_prefix/tag-1.lock && + test_cmp expect err + ) && + ( + cd repo && + cp $branch_dir_prefix/branch-1 $branch_dir_prefix/@ && + test_must_fail git fsck 2>err && + cat >expect <<-EOF && + error: refs/heads/@: badRefName: invalid refname format + EOF + rm $branch_dir_prefix/@ && + test_cmp expect err + ) && + ( + cd repo && + cp $tag_dir_prefix/multi_hierarchy/tag-2 $tag_dir_prefix/multi_hierarchy/@ && + test_must_fail git fsck 2>err && + cat >expect <<-EOF && + error: refs/tags/multi_hierarchy/@: badRefName: invalid refname format + EOF + rm $tag_dir_prefix/multi_hierarchy/@ && + test_cmp expect err + ) +' + +test_expect_success 'ref name check should be adapted into fsck messages' ' + test_when_finished "rm -rf repo" && + git init repo && + branch_dir_prefix=.git/refs/heads && + tag_dir_prefix=.git/refs/tags && + ( + cd repo && + git commit --allow-empty -m initial && + git checkout -b branch-1 && + git tag tag-1 && + git commit --allow-empty -m second && + git checkout -b branch-2 && + git tag tag-2 + ) && + ( + cd repo && + cp $branch_dir_prefix/branch-1 $branch_dir_prefix/.branch-1 && + git -c fsck.badRefName=warn fsck 2>err && + cat >expect <<-EOF && + warning: refs/heads/.branch-1: badRefName: invalid refname format + EOF + rm $branch_dir_prefix/.branch-1 && + test_cmp expect err + ) && + ( + cd repo && + cp $branch_dir_prefix/branch-1 $branch_dir_prefix/@ && + git -c fsck.badRefName=ignore fsck 2>err && + test_must_be_empty err + ) +' + +test_done