Skip to content

[GSoC Patch] t2000: modernize path checks to use helper functions#2256

Open
alibaba0010 wants to merge 1 commit intogit:masterfrom
alibaba0010:modernize-test-path-checking
Open

[GSoC Patch] t2000: modernize path checks to use helper functions#2256
alibaba0010 wants to merge 1 commit intogit:masterfrom
alibaba0010:modernize-test-path-checking

Conversation

@alibaba0010
Copy link
Copy Markdown
Contributor

This is my GSoC microproject submission modernizing test path checks in t/t2000-conflict-when-checking-files-out.sh.

Replace old-style path checks using test -f, test -d, and test ! -h with dedicated test helper functions for improved test clarity and consistency.

This modernization improves test script readability by using Git's dedicated test helpers:

test -f → test_path_is_file
test -d → test_path_is_dir
test ! -h && test -f → test_path_is_file_not_symlink
test ! -h && test -d → test_path_is_dir_not_symlink
Found instances using: git grep 'test -[efd]' t/ | grep 'test -[efd].*&&'

Converted 5 instances in t/t2000-conflict-when-checking-files-out.sh

This improves test clarity and consistency across the test suite.

I'm excited to contribute to Git and look forward to your feedback!

CC: Christian Couder christian.couder@gmail.com
CC: Karthik Nayak karthik.188@gmail.com
CC: Justin Tobler jltobler@gmail.com
CC: Siddharth Asthana siddharthasthana31@gmail.com
CC: Ayush Chandekar ayu.chandekar@gmail.com

@gitgitgadget-git
Copy link
Copy Markdown

Welcome to GitGitGadget

Hi @alibaba0010, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests.

Please make sure that either:

  • Your Pull Request has a good description, if it consists of multiple commits, as it will be used as cover letter.
  • Your Pull Request description is empty, if it consists of a single commit, as the commit message should be descriptive enough by itself.

You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <revi.ewer@example.com>, Ill Takalook <ill.takalook@example.net>

NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description,
because it will result in a malformed CC list on the mailing list. See
example.

Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:

  • the lines should not exceed 76 columns,
  • the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
  • the commit messages' body should be describing the "why?" of the change.
  • Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code.

Contributing the patches

Before you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail).

If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

Need help?

New contributors who want advice are encouraged to join git-mentoring@googlegroups.com, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join.

You may also be able to find help in real time in the developer IRC channel, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

@alibaba0010 alibaba0010 force-pushed the modernize-test-path-checking branch from 5f612a9 to 5f7cfe7 Compare March 26, 2026 04:36
@gitgitgadget-git
Copy link
Copy Markdown

Invalid author email in 04b1502: "99949368+alibaba0010@users.noreply.github.com"

@gitgitgadget-git
Copy link
Copy Markdown

There is a merge commit in this Pull Request:

04b15028f83b90dc648892be36e765164896dce3

Please rebase the branch and force-push.

@alibaba0010 alibaba0010 force-pushed the modernize-test-path-checking branch from 04b1502 to 261ebbc Compare March 29, 2026 15:20
Copy link
Copy Markdown

@ahmedoosh ahmedoosh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alibaba0010:modernize-test-path-checking

'test ! -h path2 && test -d path2 &&
test ! -h path3 && test -d path3 &&
test ! -h path2/file0 && test -f path2/file0 &&
test ! -h path3/file1 && test -f path3/file1'
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with the advice given. However I want some more eyes on thi

@alibaba0010
Copy link
Copy Markdown
Contributor Author

@wattsonsean8-del i don't get what you meant by "some more eyes on this"

@alibaba0010 alibaba0010 force-pushed the modernize-test-path-checking branch from 261ebbc to de6fb2c Compare April 7, 2026 03:16
@gitgitgadget-git
Copy link
Copy Markdown

Invalid author email in db649ab: "99949368+alibaba0010@users.noreply.github.com"

@gitgitgadget-git
Copy link
Copy Markdown

There is a merge commit in this Pull Request:

db649ab4e94cc01752702556e18d1b3645b88cc8

Please rebase the branch and force-push.

This test script that dates back to 2005 certainly shows its age and
both its style and the way the tests are laid out do not match the
modern standard. Modernize it to match the current testing standards:

  * Executables that prepare the data used to test the command should
    be inside the test_expect_success block in modern tests.

  * In modern tests, running a command that is being tested, making
    sure it succeeds, and inspecting other side effects that are
    expected, are all done in a single test_expect_success block.

  * A test_expect_success block in modern tests are laid out as

         test_expect_success 'title of the test' '
                 body of the test &&
                 ...
                 body of the test
         '

    not as

         test_expect_success \
                 'title of the test' \
                 'body of the test &&
                 ...
                 body of the test'

    which is in a prehistoric style.

  * In modern tests, each &&-chained statement in the body of the
    test_expect_success block are indented with a horizontal tab,
    unlike prehistoric style that used 4-space indent.

  * Replace bare 'test -f/-d' and 'test ! -h' assertions with dedicated
    test_path_is_* helpers (specifically test_path_is_file_not_symlink and
    test_path_is_dir_not_symlink). While less commonly used in the test
    suite than test_path_is_file/dir, they act as direct replacements
    for the specific checks being performed and provide clearer
    diagnostics on failure.

Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Zakariyah Ali <zakariyahali100@gmail.com>
@alibaba0010 alibaba0010 force-pushed the modernize-test-path-checking branch from db649ab to b6680f4 Compare April 7, 2026 03:32
@dscho
Copy link
Copy Markdown
Member

dscho commented Apr 7, 2026

@wattsonsean8-del i don't get what you meant by "some more eyes on this"

That's most likely AI slop. Sadly, the Git maintainer seems uninterested to keep this here repository clean of spam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants