s

Author: schlad

tests/kernel/nfs_client.pm

@@ -3,11 +3,7 @@
 # Copyright 2023-2025 SUSE LLC
 # SPDX-License-Identifier: FSFAP
 
-# Summary: NFS Client
-#    This module provisions the NFS client and then runs some basic
-#    sanity tests. Detailed description of the tests can be found in:
-#    tests/kernel/nfs_server.pm
-
+# Summary: NFS client setup and basic validation
 # Maintainer: Kernel QE <[email protected]>
 
 use Mojo::Base "opensusebasetest";
@@ -148,3 +144,63 @@ sub post_fail_hook {
 }
 
 1;
+
+=head1 Description
+
+This module provisions the NFS client side of the kernel multimachine NFS
+tests. It waits until the server export is ready, mounts the configured NFSv3
+and NFSv4 exports if the kernel supports them, and performs basic write and
+data-integrity checks.
+
+The client creates a reference file with C<dd>, stores its checksum, copies the
+file and checksum to each mounted export, and then creates additional copies
+with C<dd> using the following output flags:
+
+=over 4
+
+=item * C<direct>
+
+=item * C<dsync>
+
+=item * C<sync>
+
+=back
+
+In IPMI baremetal jobs the module resolves the peer by comparing
+C<IBTEST_IP1>/C<IBTEST_IP2> with locally detected IPv4 addresses. In regular
+VM-based multimachine jobs it falls back to C<SERVER_NODE> or the default
+C<server-node00> hostname.
+
+=head1 Configuration
+
+=head2 SERVER_NODE
+
+Optional. Hostname or address of the NFS server in non-IPMI multimachine jobs.
+Defaults to C<server-node00>.
+
+=head2 IBTEST_IP1, IBTEST_IP2
+
+Required for IPMI baremetal jobs. Used to determine which of the two configured
+addresses belongs to the local host and which one is the remote peer.
+
+=head2 NFS_LOCAL_NFS3
+
+Optional. Local mount point for the synchronous NFSv3 export.
+Defaults to C</home/localNFS3>.
+
+=head2 NFS_LOCAL_NFS3_ASYNC
+
+Optional. Local mount point for the asynchronous NFSv3 export.
+Defaults to C</home/localNFS3async>.
+
+=head2 NFS_LOCAL_NFS4
+
+Optional. Local mount point for the synchronous NFSv4 export.
+Defaults to C</home/localNFS4>.
+
+=head2 NFS_LOCAL_NFS4_ASYNC
+
+Optional. Local mount point for the asynchronous NFSv4 export.
+Defaults to C</home/localNFS4async>.
+
+=cut

tests/kernel/nfs_server.pm

@@ -3,23 +3,7 @@
 # Copyright SUSE LLC
 # SPDX-License-Identifier: FSFAP
 
-# Summary: NFS server
-#    This module provisions the NFS server and then runs some basic sanity tests
-#    NFS server - provisioned on SUSE/openSUSE - provides specific exports:
-#      - NFS v3 with sync and async flags
-#      - NFS v4 with sync and async flags
-#    NFS client (tests/kernel/nfs_client.pm) creates a file using dd tool and then copies
-#    that file to all exports mounted on the client side.
-#    Data integrity of the file is checked with the md5 checksum
-#
-#    Extension to the NFS tests uses dd tool for copying created file using various flags,
-#    specifically:
-#      - direct
-#      - dsync
-#      - sync
-#    An earlier created file is copied with each flag to each mounted export and then md5 checksum is
-#    used again to check data integridty for each file copied with dd tool with all each flag
-
+# Summary: NFS server setup and export verification
 # Maintainer: Kernel QE <[email protected]>
 
 use Mojo::Base "opensusebasetest";
@@ -229,3 +213,76 @@ sub post_fail_hook {
 }
 
 1;
+
+=head1 Description
+
+This module provisions the server side of the kernel multimachine NFS tests.
+It installs and starts the local NFS services, creates the configured exports,
+and waits for the client to mount and populate them.
+
+The server provides up to four exports, depending on kernel support:
+
+=over 4
+
+=item * NFSv3 synchronous export
+
+=item * NFSv3 asynchronous export
+
+=item * NFSv4 synchronous export
+
+=item * NFSv4 asynchronous export
+
+=back
+
+After the client copies the reference file and checksum data to the mounted
+exports, the server verifies the checksum of the original file as well as the
+files copied via C<dd> with C<direct>, C<dsync>, and C<sync> output flags.
+
+In IPMI baremetal jobs the module resolves the client peer by comparing
+C<IBTEST_IP1>/C<IBTEST_IP2> with locally detected IPv4 addresses. In regular
+VM-based multimachine jobs it falls back to C<CLIENT_NODE> or the default
+C<client-node00> hostname.
+
+=head1 Configuration
+
+=head2 CLIENT_NODE
+
+Optional. Hostname or address of the NFS client in non-IPMI multimachine jobs.
+Defaults to C<client-node00>.
+
+=head2 IBTEST_IP1, IBTEST_IP2
+
+Required for IPMI baremetal jobs. Used to determine which of the two configured
+addresses belongs to the local host and which one is the remote peer.
+
+=head2 NFS_MOUNT_NFS3
+
+Optional. Export path for the synchronous NFSv3 export.
+Defaults to C</nfs/shared_nfs3>.
+
+=head2 NFS_MOUNT_NFS3_ASYNC
+
+Optional. Export path for the asynchronous NFSv3 export.
+Defaults to C</nfs/shared_nfs3_async>.
+
+=head2 NFS_MOUNT_NFS4
+
+Optional. Export path for the synchronous NFSv4 export.
+Defaults to C</nfs/shared_nfs4>.
+
+=head2 NFS_MOUNT_NFS4_ASYNC
+
+Optional. Export path for the asynchronous NFSv4 export.
+Defaults to C</nfs/shared_nfs4_async>.
+
+=head2 NFS_PERMISSIONS
+
+Optional. Export options used for synchronous exports.
+Defaults to C<rw,sync,no_root_squash>.
+
+=head2 NFS_PERMISSIONS_ASYNC
+
+Optional. Export options used for asynchronous exports.
+Defaults to C<rw,async,no_root_squash>.
+
+=cut