Add: Qualcomm User Data Encryption test script & Document

Runner/suites/Kernel/Baseport/UserDataEncryption/README_UserDataEncryption.md

@@ -0,0 +1,96 @@
+Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+SPDX-License-Identifier: BSD-3-Clause-Clear
+
+# Qualcomm UserDataEncryption Functionality Test Script
+## Overview
+
+The `UserDataEncryption` test script verifies basic filesystem encryption functionality. It generates a 64-byte key, adds it to the system, applies an encryption policy to a mount directory, and confirms the setup by creating and reading a test file. This ensures that key management and encryption policies work as expected.
+
+## Features
+
+- **Dependency Check**: Verifies the presence of the `fscryptctl` binary.
+- **Key Management**: Generates a 64-byte key and adds it to the filesystem.
+- **Encryption Policy**: Applies and verifies encryption policy on a mount directory.
+- **Functional Validation**: Creates and reads a test file to confirm encryption functionality.
+- **Automated Result Logging**: Outputs test results to a `.res` file for automated result collection.
+
+## Prerequisites
+
+Ensure the following components are present on the target device:
+
+- `fscryptctl` binary is available
+- Sufficient permissions to create and mount directories
+
+## Directory Structure
+```
+Runner/
+├── suites/
+│   ├── Kernel/
+│   │   │   ├── baseport/
+│   │   │   │   ├── UserDataEncryption/
+│   │   │   │   │   ├── run.sh
+```
+## Usage
+
+1. Copy repo to Target Device: Use scp to transfer the scripts from the host to the target device. The scripts should be copied to the ```/<user-defined-location>``` directory on the target device.
+
+2. Verify Transfer: Ensure that the repo have been successfully copied to the ```/<user-defined-location>``` directory on the target device.
+
+3. Run Scripts: Navigate to the ```/<user-defined-location>``` directory on the target device and execute the scripts as needed.
+
+---
+Quick Example
+```
+git clone <this-repo>
+cd <this-repo>
+scp -r common Runner user@target_device_ip:/<user-defined-location>
+ssh user@target_device_ip 
+cd /<user-defined-location>/Runner && ./run-test.sh UserDataEncryption
+
+Sample output:
+sh-5.2# ./run-test.sh UserDataEncryption
+[Executing test case: UserDataEncryption] 2025-12-24 06:19:59 -
+[INFO] 2025-12-24 06:19:59 - Running as root. Continuing...
+[INFO] 2025-12-24 06:19:59 - -----------------------------------------------------------------------------------------
+[INFO] 2025-12-24 06:19:59 - -------------------Starting UserDataEncryption Testcase----------------------------
+[INFO] 2025-12-24 06:19:59 - === Test Initialization ===
+[PASS] 2025-12-24 06:20:00 - Kernel config CONFIG_FS_ENCRYPTION is enabled
+[INFO] 2025-12-24 06:20:00 - Checking if dependency binary is available
+[INFO] 2025-12-24 06:20:00 - Temporary key file created: /tmp/tmp.wZdZ0ladk0
+[INFO] 2025-12-24 06:20:00 - Generating 64-byte encryption key
+[INFO] 2025-12-24 06:20:00 - Using existing writable /mnt for mount directory base
+[INFO] 2025-12-24 06:20:00 - Creating unique mount folder under /mnt
+[INFO] 2025-12-24 06:20:00 - Created unique mount directory: /mnt/testing.jkttLK
+[INFO] 2025-12-24 06:20:00 - Derived filesystem mount point: /var
+[INFO] 2025-12-24 06:20:00 - Filesystem at /var: ext4
+[INFO] 2025-12-24 06:20:00 - Adding encryption key to the filesystem
+[INFO] 2025-12-24 06:20:00 - Key ID: 6acffc5b7e670c7f841ef20c37027b52
+[INFO] 2025-12-24 06:20:00 - Checking key status
+[INFO] 2025-12-24 06:20:00 - Key Status: Present (user_count=1, added_by_self)
+[INFO] 2025-12-24 06:20:00 - Setting encryption policy on /mnt/testing.jkttLK
+[INFO] 2025-12-24 06:20:00 - Verifying encryption policy
+[INFO] 2025-12-24 06:20:00 - Policy verification successful: Master key identifier matches key_id
+[INFO] 2025-12-24 06:20:00 - Creating test file in encrypted directory
+[INFO] 2025-12-24 06:20:00 - Reading test file
+[PASS] 2025-12-24 06:20:00 - UserDataEncryption : Test Passed
+[INFO] 2025-12-24 06:20:00 - Cleaning up mount directory: /mnt/testing.jkttLK
+[INFO] 2025-12-24 06:20:00 - No relevant, non-benign errors for modules [fscrypt] in recent dmesg.
+[PASS] 2025-12-24 06:20:00 - UserDataEncryption passed
+
+[INFO] 2025-12-24 06:20:00 - ========== Test Summary ==========
+PASSED:
+UserDataEncryption
+
+FAILED:
+ None
+
+SKIPPED:
+ None
+[INFO] 2025-12-24 06:20:00 - ==================================
+4. Results will be available in the `/<user-defined-location>/Runner/suites/Kernel/baseport/UserDataEncryption/` directory.
+
+## Notes
+
+- The script uses /mnt as the base directory (with /UDE as a fallback) for all operations.
+- Temporary files such as the encryption key are cleaned up after the test.
+- If any test fails, the script logs the error and exits with a failure code.

Runner/suites/Kernel/Baseport/UserDataEncryption/UserDataEncryption.yaml

@@ -0,0 +1,21 @@
+metadata:
+    format: Lava-Test Test Definition 1.0
+    name: UserDataEncryption
+    description: "Validates fscrypt-based user data encryption on supported filesystems"
+    maintainer:
+        - bbharani@qti.qualcomm.com
+    os:
+        - openembedded
+    scope:
+        - functional
+    devices:
+        - rb3gen2
+        - ridesx
+        - lemans evk
+        - monaco evk
+
+run:
+    steps:
+        - cd Runner
+        - $PWD/suites/Kernel/Baseport/UserDataEncryption/run.sh || true
+        - $PWD/utils/send-to-lava.sh $PWD/suites/Kernel/Baseport/UserDataEncryption/UserDataEncryption.res || true