[GSoC,v2] t: migrate t0110-urlmatch-normalization to the new framework

helper/test-urlmatch-normalization along with
t0110-urlmatch-normalization test the `url_normalize()` function from
'urlmatch.h'. Migrate them to the unit testing framework for better
performance. And also add different test_msg()s for better debugging.

In the migration, last two of the checks from `t_url_general_escape()`
were slightly changed compared to the shellscript. This involves changing

'\'' -> '
'\!' -> !

in the urls of those checks. This is because in C strings, we don't
need to escape "'" and "!". Other than these two, all the urls were
pasted verbatim from the shellscript.

Another change is the removal of MINGW prerequisite from one of the
test. It was there because[1] on Windows, the command line is a Unicode
string, it is not possible to pass arbitrary bytes to a program. But
in unit tests we don't have this limitation.

With the addition of this unit test, we impose a new restriction of
running the unit tests from either 't/' or 't/unit-tests/bin/'
directories. This is to construct the path to files which contain some
input urls under the 't/t-urlmatch-normalization' directory. This
restriction is similar to one we have for end-to-end tests, where they
can be ran from only 't/'. Addition of 't/unit-tests/bin/' is to allow
for running individual tests which is not currently possible via any
'make' targets and also 'unit-tests-test-tool' target is also ran from
the 't/unit-tests/bin' directory.

[1]: https://lore.kernel.org/git/53CAC8EF.6020707@gmail.com/

Mentored-by: Christian Couder <chriscool@tuxfamily.org>
Mentored-by: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
Signed-off-by: Ghanshyam Thakkar <shyamthakkar001@gmail.com>
---
 Makefile                                      |   2 +-
 t/helper/test-tool.c                          |   1 -
 t/helper/test-tool.h                          |   1 -
 t/helper/test-urlmatch-normalization.c        |  56 ----
 t/t0110-urlmatch-normalization.sh             | 182 -----------
 t/unit-tests/t-urlmatch-normalization.c       | 294 ++++++++++++++++++
 .../t-urlmatch-normalization}/README          |   0
 .../t-urlmatch-normalization}/url-1           | Bin
 .../t-urlmatch-normalization}/url-10          | Bin
 .../t-urlmatch-normalization}/url-11          | Bin
 .../t-urlmatch-normalization}/url-2           | Bin
 .../t-urlmatch-normalization}/url-3           | Bin
 .../t-urlmatch-normalization}/url-4           | Bin
 .../t-urlmatch-normalization}/url-5           | Bin
 .../t-urlmatch-normalization}/url-6           | Bin
 .../t-urlmatch-normalization}/url-7           | Bin
 .../t-urlmatch-normalization}/url-8           | Bin
 .../t-urlmatch-normalization}/url-9           | Bin
 18 files changed, 295 insertions(+), 241 deletions(-)
 delete mode 100644 t/helper/test-urlmatch-normalization.c
 delete mode 100755 t/t0110-urlmatch-normalization.sh
 create mode 100644 t/unit-tests/t-urlmatch-normalization.c
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/README (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-1 (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-10 (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-11 (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-2 (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-3 (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-4 (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-5 (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-6 (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-7 (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-8 (100%)
 rename t/{t0110 => unit-tests/t-urlmatch-normalization}/url-9 (100%)

Range-diff against v1:
1:  6a44d676cd ! 1:  3f4e4be1a6 t: migrate helper/test-urlmatch-normalization to unit tests
    @@ Commit message
         string, it is not possible to pass arbitrary bytes to a program. But
         in unit tests we don't have this limitation.

    +    With the addition of this unit test, we impose a new restriction of
    +    running the unit tests from either 't/' or 't/unit-tests/bin/'
    +    directories. This is to construct the path to files which contain some
    +    input urls under the 't/t-urlmatch-normalization' directory. This
    +    restriction is similar to one we have for end-to-end tests, where they
    +    can be ran from only 't/'. Addition of 't/unit-tests/bin/' is to allow
    +    for running individual tests which is not currently possible via any
    +    'make' targets and also 'unit-tests-test-tool' target is also ran from
    +    the 't/unit-tests/bin' directory.
    +
         [1]: https://lore.kernel.org/git/53CAC8EF.6020707@gmail.com/

         Mentored-by: Christian Couder <chriscool@tuxfamily.org>
    @@ t/unit-tests/t-urlmatch-normalization.c (new)
     +		if (!check_str(url1_norm, url2_norm))
     +			test_msg("input url1: %s\n  input url2: %s", url1,
     +				 url2);
    -+	} else if (!check_int(strcmp(url1_norm, url2_norm), !=, 0))
    ++	} else if (!check_int(strcmp(url1_norm, url2_norm), !=, 0)) {
     +		test_msg(" url1_norm: %s\n   url2_norm: %s\n"
     +			 "  input url1: %s\n  input url2: %s",
     +			 url1_norm, url2_norm, url1, url2);
    ++	}
     +	free(url1_norm);
     +	free(url2_norm);
     +}
    @@ t/unit-tests/t-urlmatch-normalization.c (new)
     +static void check_normalized_url_from_file(const char *file, const char *expect)
     +{
     +	struct strbuf content = STRBUF_INIT, path = STRBUF_INIT;
    ++	char *cwd_basename;
    ++
    ++	if (!check_int(strbuf_getcwd(&path), ==, 0))
    ++		return;
    ++
    ++	cwd_basename = basename(path.buf);
    ++	if (!check(!strcmp(cwd_basename, "t") || !strcmp(cwd_basename, "bin"))) {
    ++		test_msg("BUG: unit-tests should be run from either 't/' or 't/unit-tests/bin' directory");
    ++		return;
    ++	}
     +
    -+	strbuf_getcwd(&path);
    -+	strbuf_strip_suffix(&path, "/unit-tests/bin"); /* because 'unit-tests-test-tool' is run from 'bin' directory */
    ++	strbuf_strip_suffix(&path, "/unit-tests/bin");
     +	strbuf_addf(&path, "/unit-tests/t-urlmatch-normalization/%s", file);
     +
     +	if (!check_int(strbuf_read_file(&content, path.buf, 0), >, 0)) {

Message ID	20240813172432.55487-1-shyamthakkar001@gmail.com (mailing list archive)
State	Superseded
Headers	show Received: from mail-pl1-f174.google.com (mail-pl1-f174.google.com [209.85.214.174]) (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 E0FA119CCF2 for <git@vger.kernel.org>; Tue, 13 Aug 2024 17:25:24 +0000 (UTC) From: Ghanshyam Thakkar <shyamthakkar001@gmail.com> To: git@vger.kernel.org Cc: Patrick Steinhardt <ps@pks.im>, Karthik Nayak <karthik.188@gmail.com>, Phillip Wood <phillip.wood123@gmail.com>, Christian Couder <christian.couder@gmail.com>, Ghanshyam Thakkar <shyamthakkar001@gmail.com>, Christian Couder <chriscool@tuxfamily.org>, Kaartic Sivaraam <kaartic.sivaraam@gmail.com> Subject: [GSoC][PATCH v2] t: migrate t0110-urlmatch-normalization to the new framework Date: Tue, 13 Aug 2024 22:54:21 +0530 Message-ID: <20240813172432.55487-1-shyamthakkar001@gmail.com> In-Reply-To: <20240628125632.45603-1-shyamthakkar001@gmail.com> References: <20240628125632.45603-1-shyamthakkar001@gmail.com> Precedence: bulk MIME-Version: 1.0 Content-Transfer-Encoding: 8bit
Series	[GSoC,v2] t: migrate t0110-urlmatch-normalization to the new framework \| expand [GSoC,v2] t: migrate t0110-urlmatch-normalization to the new framework

[GSoC,v2] t: migrate t0110-urlmatch-normalization to the new framework

Commit Message

Comments

Patch