From 7f1de90f72d6e8287aec6ab1d9f7776b7df624e5 Mon Sep 17 00:00:00 2001
From: Noel Power <noel.power@suse.com>
Date: Tue, 11 Jun 2024 11:19:50 +0100
Subject: [PATCH] selftest: Add a python blackbox test for some misc (widelink)
 DFS tests

On master attempting to chdir into a nested dfs link

e.g. cd dfslink (works)
     cd dfslink/another_dfslink (fails)

[1] Add a test for this scenario (nested chdir)
[2] Add test for enumerating a dfs link in root of dfs share
[3] Add a test to check case insensitive chdir into dfs link on widelink
  enabled share

Add knownfails for tests 1 and 3

Signed-off-by: Noel Power <noel.power@suse.com>
Reviewed-by: Jeremy Allison <jra@samba.org>

BUG: https://bugzilla.samba.org/show_bug.cgi?id=15435
---
 .../samba/tests/blackbox/misc_dfs_widelink.py | 86 +++++++++++++++++++
 selftest/knownfail.d/dfs_widelink             |  2 +
 source4/selftest/tests.py                     |  3 +
 3 files changed, 91 insertions(+)
 create mode 100644 python/samba/tests/blackbox/misc_dfs_widelink.py
 create mode 100644 selftest/knownfail.d/dfs_widelink

diff --git a/python/samba/tests/blackbox/misc_dfs_widelink.py b/python/samba/tests/blackbox/misc_dfs_widelink.py
new file mode 100644
index 00000000000..7948590d710
--- /dev/null
+++ b/python/samba/tests/blackbox/misc_dfs_widelink.py
@@ -0,0 +1,86 @@
+# Blackbox tests for DFS (widelink)
+#
+# Copyright (C) Noel Power noel.power@suse.com
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+from samba.tests import BlackboxTestCase, BlackboxProcessError
+from samba.samba3 import param as s3param
+
+from samba.credentials import Credentials
+
+import os
+
+class DfsWidelinkBlockboxTestBase(BlackboxTestCase):
+
+    def setUp(self):
+        super().setUp()
+        self.lp = s3param.get_context()
+        self.server = os.environ["SERVER"]
+        self.user = os.environ["USER"]
+        self.passwd = os.environ["PASSWORD"]
+        self.creds = Credentials()
+        self.creds.guess(self.lp)
+        self.creds.set_username(self.user)
+        self.creds.set_password(self.passwd)
+        self.testdir = os.getenv("TESTDIR", "msdfs-share-wl")
+        self.share = os.getenv("SHARE", "msdfs-share-wl")
+        self.dirpath = os.path.join(os.environ["LOCAL_PATH"],self.testdir)
+        # allow a custom teardown function to be defined
+        self.cleanup = None
+        self.cleanup_args = []
+
+    def tearDown(self):
+        try:
+            if (self.cleanup):
+                self.cleanup(self.cleanup_args)
+        except Exception as e:
+            print("remote remove failed: %s" % str(e))
+
+    def build_test_cmd(self, cmd, args):
+        cmd = [cmd, "-U%s%%%s" % (self.user, self.passwd)]
+        cmd.extend(args)
+        return cmd
+
+    def test_ci_chdir(self):
+        parent_dir = "msdfs-src1"
+        dirs = [parent_dir, parent_dir.upper()]
+        # try as named dir first then try upper-cased version
+        for adir in dirs:
+            smbclient_args = self.build_test_cmd("smbclient", ["//%s/%s" % (self.server, self.share), "-c", "cd %s" % (adir)])
+            try:
+                out_str = self.check_output(smbclient_args)
+            except BlackboxProcessError as e:
+                print(str(e))
+                self.fail(str(e))
+
+    def test_nested_chdir(self):
+        parent_dir = "dfshop1"
+        child_dir = "dfshop2"
+        smbclient_args = self.build_test_cmd("smbclient", ["//%s/%s" % (self.server, self.share), "-c", "cd %s/%s" % (parent_dir,child_dir)])
+        try:
+            out_str = self.check_output(smbclient_args)
+        except BlackboxProcessError as e:
+            print(str(e))
+            self.fail(str(e))
+
+    def test_enumerate_dfs_link(self):
+        smbclient_args = self.build_test_cmd("smbclient", ["//%s/%s" % (self.server, self.share), "-c", "dir"])
+        try:
+            out_str = self.check_output(smbclient_args)
+        except BlackboxProcessError as e:
+            print(str(e))
+            self.fail(str(e))
+        out_str = out_str.decode()
+        self.assertIn("msdfs-src1", out_str)
diff --git a/selftest/knownfail.d/dfs_widelink b/selftest/knownfail.d/dfs_widelink
new file mode 100644
index 00000000000..2a75c75c6b8
--- /dev/null
+++ b/selftest/knownfail.d/dfs_widelink
@@ -0,0 +1,2 @@
+^samba.tests.blackbox.misc_dfs_widelink.samba.tests.blackbox.misc_dfs_widelink.DfsWidelinkBlockboxTestBase.test_nested_chdir\(fileserver\)
+^samba.tests.blackbox.misc_dfs_widelink.samba.tests.blackbox.misc_dfs_widelink.DfsWidelinkBlockboxTestBase.test_ci_chdir\(fileserver\)
diff --git a/source4/selftest/tests.py b/source4/selftest/tests.py
index 3863c3cd7f6..bd385bb474d 100755
--- a/source4/selftest/tests.py
+++ b/source4/selftest/tests.py
@@ -1519,6 +1519,9 @@ planoldpythontestsuite("fileserver",
                        "samba.tests.blackbox.smbcacls_dfs_propagate_inherit",
                        "samba.tests.blackbox.smbcacls_dfs_propagate_inherit(DFS-msdfs-root)",
                        environ={'SHARE': 'smbcacls_share'})
+
+planoldpythontestsuite("fileserver",
+                       "samba.tests.blackbox.misc_dfs_widelink")
 #
 # Want a selection of environments across the process models
 #