From: Max Carrara <m.carrara@proxmox.com>
To: pve-devel@lists.proxmox.com
Subject: [pve-devel] [PATCH v4 pve-common 10/12] test: add tests for path_normalize of PVE::Path
Date: Fri, 7 Feb 2025 15:03:53 +0100 [thread overview]
Message-ID: <20250207140355.280472-11-m.carrara@proxmox.com> (raw)
In-Reply-To: <20250207140355.280472-1-m.carrara@proxmox.com>
Add these tests solely to ensure that the behaviour of path_normalize
stays consistent / stable in case we ever decide to provide our own
implementation instead of partially wrapping `File::Spec->canonpath()`.
These tests also account for any deviations to `canonpath()`.
Signed-off-by: Max Carrara <m.carrara@proxmox.com>
---
Changes v3 --> v4:
* Adapt test cases for changes to patch 01 where applicable
* Minor rewording of commit message
Changes v2 --> v3:
* None
Changes v1 --> v2:
* NEW: Split from patch 02
test/Path/Makefile | 1 +
test/Path/path_normalize_tests.pl | 189 ++++++++++++++++++++++++++++++
2 files changed, 190 insertions(+)
create mode 100755 test/Path/path_normalize_tests.pl
diff --git a/test/Path/Makefile b/test/Path/Makefile
index 9dcb878..8afed17 100644
--- a/test/Path/Makefile
+++ b/test/Path/Makefile
@@ -4,6 +4,7 @@ TESTS = \
path_file_ops_tests.pl \
path_is_absolute_relative_tests.pl \
path_join_tests.pl \
+ path_normalize_tests.pl \
path_parent_tests.pl \
path_push_tests.pl \
diff --git a/test/Path/path_normalize_tests.pl b/test/Path/path_normalize_tests.pl
new file mode 100755
index 0000000..f1555dc
--- /dev/null
+++ b/test/Path/path_normalize_tests.pl
@@ -0,0 +1,189 @@
+#!/usr/bin/env perl
+
+use lib '../../src';
+
+use strict;
+use warnings;
+
+use Test::More;
+
+use PVE::Path;
+
+# Note: These tests exist solely to ensure that the behaviour of path_normalize
+# stays consistent in case we ever decide to provide our own implementation
+# instead of wrapping File::Spec->canonpath().
+
+my $path_normalize_cases = [
+ {
+ name => "empty path",
+ path => "",
+ normalized => "",
+ },
+ {
+ name => "root",
+ path => "/",
+ normalized => "/",
+ },
+ {
+ name => "current path reference",
+ path => ".",
+ normalized => ".",
+ },
+ {
+ name => "parent directory reference",
+ path => "..",
+ normalized => "..",
+ },
+ {
+ name => "single path component",
+ path => "foo",
+ normalized => "foo",
+ },
+ {
+ name => "single path component, absolute",
+ path => "/foo",
+ normalized => "/foo",
+ },
+ {
+ name => "single path component, starting with current path reference",
+ path => "./foo",
+ normalized => "./foo",
+ },
+ {
+ name => "parent directory reference, starting with current path reference",
+ path => "./..",
+ normalized => "..",
+ },
+ {
+ name => "multiple components, with redundant path separators",
+ path => "foo//bar///baz////quo/////qux//////",
+ normalized => "foo/bar/baz/quo/qux",
+ },
+ {
+ name => "multiple components, with redundant current path references",
+ path => "foo/./bar/././baz/./././quo/././././qux/././././.",
+ normalized => "foo/bar/baz/quo/qux",
+ },
+ {
+ name => "multiple components, with parent directory references",
+ path => "foo/../bar/../../baz/../../../quo/../../../../qux/../../../../..",
+ normalized => "foo/../bar/../../baz/../../../quo/../../../../qux/../../../../..",
+ },
+ {
+ name => "multiple components, with redundant path separators,"
+ . " with redundant current path references, starting with current path reference",
+ path => "././//foo/./bar///./baz/./.",
+ normalized => "./foo/bar/baz",
+ },
+ {
+ name => "multiple components, with redundant path separators,"
+ . " with redundant current path references, starting with current path reference"
+ . " (alternative)",
+ path => ".///./foo//./bar/.//baz///./",
+ normalized => "./foo/bar/baz",
+ },
+ {
+ name => "root path, with redundant path separators",
+ path => "///////////",
+ normalized => "/",
+ },
+ {
+ name => "root path, with redundant current path references",
+ path => "/./././././././././.",
+ normalized => "/",
+ },
+ {
+ name => "root with parent directory reference",
+ path => "/..",
+ normalized => "/",
+ },
+ {
+ name => "root with multiple parent directory references",
+ path => "/../../../../../../../../..",
+ normalized => "/",
+ },
+ {
+ name => "current path reference, with redundant path separators",
+ path => ".///////////",
+ normalized => ".",
+ },
+ {
+ name => "current path reference, with redundant current path references",
+ path => "./././././././././.",
+ normalized => ".",
+ },
+ {
+ name => "current path reference, with parent directory references",
+ path => "./../../..",
+ normalized => "../../..",
+ },
+ {
+ name => "multiple components,"
+ . " with redundant path separators,"
+ . " with redundant current path references,"
+ . " with parent directory references",
+ path => "foo//././//bar///./././//.//baz/.././..///quo/..////../qux/././//..",
+ normalized => "foo/bar/baz/../../quo/../../qux/..",
+ },
+ {
+ name => "multiple components, with odd component names",
+ path => ".../ \t/\t/\\/........../.~.^./.+\$={}[]()<>.../!/\"/'",
+ normalized => ".../ \t/\t/\\/........../.~.^./.+\$={}[]()<>.../!/\"/'",
+ },
+ # Diverging from File::Spec->canonpath() here -- canonpath() doesn't throw
+ # if it gets undef, but path_normalize() does in order to stay consistent
+ # with all the other functions of PVE::Path.
+ {
+ name => "path is undef",
+ path => undef,
+ normalized => undef,
+ should_throw => 1,
+ },
+];
+
+sub test_path_normalize : prototype($) {
+ my ($case) = @_;
+
+ my $name = "path_normalize: " . $case->{name};
+
+ my $normalized = eval { PVE::Path::path_normalize($case->{path}); };
+
+ if ($@) {
+ if ($case->{should_throw}) {
+ pass($name);
+ return;
+ }
+
+ fail($name);
+ diag("Failed to normalize path:\n$@");
+ return;
+ }
+
+ # Note: `!is()` isn't the same as `isnt()` -- we want extra output here
+ # if the check fails; can't do that with `isnt()`
+ if (!is($normalized, $case->{normalized}, $name)) {
+ diag("path = " . $case->{path});
+ diag("normalized = " . $case->{normalized});
+ }
+
+ return;
+}
+
+sub main : prototype() {
+ plan(tests => scalar($path_normalize_cases->@*));
+
+ for my $case ($path_normalize_cases->@*) {
+ eval {
+ # suppress warnings here to make output less noisy for certain tests if necessary
+ # local $SIG{__WARN__} = sub {};
+ test_path_normalize($case);
+ };
+ warn "$@\n" if $@;
+ }
+
+ done_testing();
+
+ return;
+}
+
+main();
--
2.39.5
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
next prev parent reply other threads:[~2025-02-07 14:05 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-07 14:03 [pve-devel] [PATCH v4 pve-common 00/12] Introduce and Package PVE::Path & PVE::Filesystem Max Carrara
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 01/12] introduce PVE::Path Max Carrara
2025-04-14 13:36 ` Wolfgang Bumiller
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 02/12] test: add directory for tests of PVE::Path module Max Carrara
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 03/12] test: add tests for path_is_absolute and path_is_relative of PVE::Path Max Carrara
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 04/12] test: add tests for path_components " Max Carrara
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 05/12] test: add tests for path_join " Max Carrara
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 06/12] test: add tests for path_push " Max Carrara
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 07/12] test: add tests for path_parent " Max Carrara
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 08/12] test: add tests for path_starts_with, path_ends_with, path_equals Max Carrara
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 09/12] test: add tests for file path operation functions of PVE::Path Max Carrara
2025-02-07 14:03 ` Max Carrara [this message]
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 11/12] introduce PVE::Filesystem Max Carrara
2025-02-07 14:03 ` [pve-devel] [PATCH v4 pve-common 12/12] debian: introduce package libproxmox-fs-path-utils-perl Max Carrara
2025-03-27 17:24 ` [pve-devel] [PATCH v4 pve-common 00/12] Introduce and Package PVE::Path & PVE::Filesystem Max Carrara
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250207140355.280472-11-m.carrara@proxmox.com \
--to=m.carrara@proxmox.com \
--cc=pve-devel@lists.proxmox.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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal