From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id E4ABB1FF164 for ; Fri, 20 Dec 2024 19:52:47 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 3454DC095; Fri, 20 Dec 2024 19:52:43 +0100 (CET) From: Max Carrara To: pve-devel@lists.proxmox.com Date: Fri, 20 Dec 2024 19:52:05 +0100 Message-Id: <20241220185207.519912-11-m.carrara@proxmox.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241220185207.519912-1-m.carrara@proxmox.com> References: <20241220185207.519912-1-m.carrara@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.042 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pve-devel] [PATCH v2 pve-common 10/12] test: add tests for path_normalize of PVE::Path X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: Proxmox VE development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pve-devel-bounces@lists.proxmox.com Sender: "pve-devel" 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 wrapping File::Spec->canonpath(). Signed-off-by: Max Carrara --- Changes v1 --> v2: * NEW: Split from patch 02 test/Path/Makefile | 1 + test/Path/path_normalize_tests.pl | 176 ++++++++++++++++++++++++++++++ 2 files changed, 177 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..4d1de24 --- /dev/null +++ b/test/Path/path_normalize_tests.pl @@ -0,0 +1,176 @@ +#!/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 => "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