Add NPU tests (New) (#2198)

* Add NPU provider (New)

* Check RW permissions together, not separately

* Replace find with in for string search

* Add a job to check modinfo

* Add the npu provider to CI

* Add the npu provider to CI (paths)

* Add tox.ini

* remove the pytest import from tests

* Remove type hints for python<3.10 compatibility

* Remove assert_called_once for python<3.6 compatibility

* Use OrderedDict for python<3.6 compatibility

* Make it optional to specify the config file

* Update according to the latest version of intel-npu-driver

* Fix certification-status

* Fix CI

* Update providers/npu/bin/check_firmware_version.py

Remove unreachable return

Co-authored-by: Fernando Bravo <39527354+fernando79513@users.noreply.github.com>

* Reformatting for less lines

* Replace subprocess.run with subprocess.check_output

* Print more information when fw not found

* Add error message when fw version not found in file.

* Run known failures always but return success

* Fix formatting

* Use packaging.version

* Add a comment about the fw version regex

* Fix formatting

* Separate job template for known failures

* Move the kernel version check into check_firmware_version.py

* Adjust template summary of known failures.

* Add a npu-umd-test detect job.

* Remove old resource from test plan.

* Move NPU tests into the base provider.

---------

Co-authored-by: Fernando Bravo <39527354+fernando79513@users.noreply.github.com>

Author: vandah

providers/base/README.rst

@@ -13,27 +13,27 @@ Base Provider Units
 ###################
 
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| 6lowpan   | eeprom      | hibernate   | memory            | self        | tmp            |
+| 6lowpan   | eeprom      | hibernate   | memory            | security    | touchscreen    |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| acpi      | esata       | i2c         | miscellanea       | serial      | ubuntucore     |
+| acpi      | esata       | i2c         | miscellanea       | self        | tmp            |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| audio     | ethernet    | image       | mobilebroadband   | smoke       | usb            |
+| audio     | ethernet    | image       | mobilebroadband   | serial      | ubuntucore     |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| benchmarks| expresscard | info        | monitor           | snapd       | virtualization |
+| benchmarks| expresscard | info        | monitor           | smoke       | usb            |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| bluetooth | fingerprint | input       | networking        | socketcan   | watchdog       |
+| bluetooth | fingerprint | input       | networking        | snapd       | virtualization |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| camera_   | firewire    | install     | nvdimm            | submission  | wireless       |
+| camera_   | firewire    | install     | npu               | socketcan   | watchdog       |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| canary    | firmware    | kernel-snap | oob-management    | suspend     | wwan           |
+| canary    | firmware    | kernel-snap | nvdimm            | submission  | wireless       |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| codecs    | fscrypt     | keys        | optical           | tpm         |                |
+| codecs    | fscrypt     | keys        | oob-management    | suspend     | wwan           |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| cpu       | gadget      | led         | power-management  | thunderbolt |                |
+| cpu       | gadget      | led         | optical           | tpm         |                |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| disk      | gpio        | location    | rtc               | touchpad    |                |
+| disk      | gpio        | location    | power-management  | thunderbolt |                |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
-| dock      | graphics    | mediacard   | security          | touchscreen |                |
+| dock      | graphics    | mediacard   | rtc               | touchpad    |                |
 +-----------+-------------+-------------+-------------------+-------------+----------------+
 
 .. _camera: units/camera/README.rst

providers/base/bin/npu_check_accel_permissions.py

@@ -0,0 +1,39 @@
+#!/usr/bin/env python3
+import os
+from pathlib import Path
+
+
+def find_npu_device_path():
+    base_sys_path = Path("/sys/class/accel")
+    if not base_sys_path.is_dir():
+        raise SystemExit("'{}' is not a directory.".format(base_sys_path))
+
+    for device_dir in base_sys_path.iterdir():
+        try:
+            # Check if the driver's name is 'intel_vpu'
+            driver_path = device_dir / "device" / "driver"
+            if "intel_vpu" in driver_path.readlink().name:
+                device_path = Path("/dev/accel") / device_dir.name
+                if device_path.exists():
+                    return device_path
+        except (IOError, FileNotFoundError):
+            # Ignore directories that don't match the expected structure
+            continue
+
+    raise SystemExit("Could not find an Intel NPU device in /sys/class/accel.")
+
+
+def main():
+    npu_device = find_npu_device_path()
+
+    # Check for read and write permissions
+    has_readwrite_perm = os.access(npu_device, os.R_OK | os.W_OK)
+
+    if not has_readwrite_perm:
+        raise SystemExit(
+            "User lacks required permissions for {}".format(npu_device)
+        )
+
+
+if __name__ == "__main__":
+    main()

providers/base/bin/npu_check_firmware_version.py

@@ -0,0 +1,108 @@
+#!/usr/bin/env python3
+import re
+import subprocess
+from pathlib import Path
+import platform
+from packaging import version
+
+FIRMWARE_SEARCH_DIR = Path("/var/snap/intel-npu-driver/current/intel/vpu")
+
+# Version string always starts with a date followed by an asterisk, the date is
+#   in one of these two formats: YYYYMMDD or Mmm DD YYYY
+#
+# Examples of both formats:
+#  - "20250925*MTL_CLIENT_SILICON-NVR+NN-deployment*2485cfeafeed591eaa9a320bfa\
+#        e2407c1b83b29f*2485cfeafeed591eaa9a320bfae2407c1b83b29f*2485cfeafee"
+#  - "Sep 25 2025*NPU40xx*build/ci/npu-fw-ci-ci_branch_UD202538_PTL_PV_npu_rel\
+#        ease_25ww35-20250915_222036-29036-1-g2485cfeafee*2485cfeafeed591eaa9a\
+#        320bfae2407c1b83b29f"
+VERSION_PATTERN = re.compile(r"^(\d{8}\*|[A-Z][a-z]{2}\s+\d{1,2}\s+\d{4}\*).*")
+
+
+def check_kernel_version(required_version):
+    current_version_str = platform.release()
+
+    current_version = version.Version(current_version_str.rsplit("-", 1)[0])
+    required_version = version.Version(required_version.rsplit("-", 1)[0])
+
+    # Return True if current version is at least the required version
+    return (
+        current_version is not None
+        and required_version is not None
+        and current_version >= required_version
+    )
+
+
+def get_active_firmware_line():
+    result = subprocess.check_output(
+        ["journalctl", "--dmesg"], universal_newlines=True
+    ).splitlines()
+
+    matching_lines = [line for line in result if "Firmware: intel/vpu" in line]
+
+    if not matching_lines:
+        raise SystemExit("No 'intel_vpu' firmware logs found in dmesg.")
+
+    return matching_lines[-1]
+
+
+def find_version_in_file(filepath):
+    try:
+        result = subprocess.check_output(
+            ["strings", filepath], universal_newlines=True
+        )
+        for line in result.splitlines():
+            # Return the first match found
+            if VERSION_PATTERN.match(line):
+                return line
+    except (subprocess.CalledProcessError, FileNotFoundError):
+        # This can happen with corrupted files or if 'strings' isn't installed
+        raise SystemExit(
+            "`strings` is not installed or can't read "
+            "the firmware file {}.".format(filepath)
+        )
+
+    print("No version number found in the file {}".format(filepath))
+
+
+def main():
+    if not check_kernel_version("6.8"):
+        print(
+            "Getting the firmware version out of dmesg is not supported "
+            "on this system. Skipping..."
+        )
+        return
+
+    active_firmware_line = get_active_firmware_line()
+
+    if not FIRMWARE_SEARCH_DIR.is_dir():
+        raise SystemExit("Firmware directory not found.")
+
+    found_driver_versions = []
+    for filepath in FIRMWARE_SEARCH_DIR.iterdir():
+        if filepath.is_file() and filepath.suffix == ".bin":
+            driver_version = find_version_in_file(filepath)
+
+            if driver_version:
+                if driver_version in active_firmware_line:
+                    print(
+                        "Test success: Loaded NPU firmware version matches a "
+                        "file from the snap. Version: {}, File: "
+                        "{}".format(driver_version, str(filepath))
+                    )
+                    return
+
+                found_driver_versions.append(driver_version)
+
+    raise SystemExit(
+        "The loaded firmware does not match any version in the snap files.\n"
+        "Loaded firmware: {}\n"
+        "Versions found in the snap: {}".format(
+            active_firmware_line,
+            "\n".join(map(lambda e: " - " + e, found_driver_versions)),
+        )
+    )
+
+
+if __name__ == "__main__":
+    main()

providers/base/bin/npu_gtest_resource.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python3
+import os
+import subprocess
+from collections import OrderedDict
+
+
+def print_as_resource(d):
+    for k, v in d.items():
+        print("{}: {}".format(k, v))
+    print("")
+
+
+def get_extra_flags(category):
+    extra_flags = []
+    if category.startswith("ZeInit"):
+        extra_flags.append("--ze-init-tests")
+
+    if "DmaHeap" in category:
+        extra_flags.append("--dma-heap")
+
+    return extra_flags
+
+
+def main():
+    config_path = os.environ.get("NPU_UMD_TEST_CONFIG") or "basic.yaml"
+
+    gtest_output = subprocess.check_output(
+        ["intel-npu-driver.npu-umd-test", "-l", "--config", config_path],
+        universal_newlines=True,
+    )
+
+    known_failures = (
+        subprocess.check_output(
+            ["intel-npu-driver.known-failures"], universal_newlines=True
+        )
+        .strip()
+        .splitlines()
+    )
+
+    for line in gtest_output.strip().splitlines():
+        if "." in line:
+            is_known_failure = line in known_failures
+
+            category, test_name = line.split(".", 1)
+            extra_flags = get_extra_flags(category)
+
+            records = OrderedDict()
+            records["name"] = test_name
+            records["category"] = category
+            records["extra_flags"] = " ".join(extra_flags)
+            records["known_failure"] = is_known_failure
+
+            print_as_resource(records)
+
+
+if __name__ == "__main__":
+    main()