Draft: Deprecated ids

.pre-commit-config.yaml

@@ -84,3 +84,39 @@ repos:
         entry: ./scripts/check-unused-variables.sh
         args: [ "-f" ]
         files: 'platform-configs/.*\.robot$'
+
+      - id: test-ids-check
+        name: test-ids-check
+        description: Check if test IDs are valid
+        language: python
+        additional_dependencies:
+          - robotframework
+          - fire
+        entry: ./scripts/ci/test_ids/test_ids_legal.py
+        args: ["id_valid", "--print_invalid"]
+        files: '^dasharo-.*/.*\.robot$'
+        pass_filenames: false
+
+      - id: test-os-ids-check
+        name: test-os-ids-check
+        description: Check if OS ids in tests are valid
+        language: python
+        additional_dependencies:
+          - robotframework
+          - fire
+        entry: ./scripts/ci/test_ids/test_ids_legal.py
+        args: ["os_valid", "--print_invalid"]
+        files: '^dasharo-.*/.*\.robot$'
+        pass_filenames: false
+
+      - id: test-ids-mappings
+        name: test-ids-mappings
+        description: Check if test IDs are mappped correctly in test_cases.json
+        language: python
+        additional_dependencies:
+          - robotframework
+          - fire
+        entry: ./scripts/ci/test_ids/test_ids_legal.py
+        args: ["id_mapped", "--print_invalid"]
+        files: '(^test_cases\.json$|^dasharo-.*/.*\.robot$)'
+        pass_filenames: false

dasharo-compatibility/acpi-driver.robot

@@ -40,7 +40,8 @@ Suite Teardown      Run Keyword
 *** Test Cases ***
 ACPI001.201 ACPI driver test (Ubuntu)
     [Documentation]    Tests if ACPI drivers can be recognised
-    Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    ACP001.001 not supported
+    ...    Previous IDs: ACPI001.001
+    Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    ACPI001.201 not supported
     Boot System Or From Connected Disk    ${ENV_ID_UBUNTU}
     Login To Linux
     Switch To Root User
@@ -63,7 +64,8 @@ ACPI001.201 ACPI driver test (Ubuntu)
 
 ACPI001.202 ACPI driver test (Fedora)
     [Documentation]    Tests if ACPI drivers can be recognised
-    # Skip If    not ${TEST_IN_FE} or    ACP001.002 not supported
+    ...    Previous IDs: ACPI001.002
+    # Skip If    not ${TEST_IN_FE} or    ACPI001.202 not supported
     Boot System Or From Connected Disk    ${ENV_ID_FEDORA}
     Login To Linux
     Switch To Root User

dasharo-compatibility/custom-boot-order.robot

@@ -10,6 +10,7 @@ Suite Teardown      Log Out And Close Connection
 CBO001.101 Custom Boot Order (EDK2)
     [Documentation]    Check if customization of Boot Order persists and
     ...    correct OS boots.
+    ...    Previous IDs: CBO001.002
     Depends On    ${TESTS_IN_FIRMWARE_SUPPORT}
 
     Power Cycle Into Firmware Setup

dasharo-compatibility/custom-network-boot-entries.robot

@@ -26,7 +26,7 @@ Suite Teardown      Run Keyword
 CNB001.201 Only one iPXE in boot menu
     [Documentation]    Check whether the network boot option with iPXE appears
     ...    only once in the boot option list.
-    ...    Previous IDs: CNB001.001
+    ...    Previous IDs: CNB001.001 CNB001.002
     Skip If    not ${CUSTOM_NETWORK_BOOT_ENTRIES_SUPPORT}    CNB001.201 not supported
     Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    CNB001.201 not supported
     Skip If    '${ENV_ID_UBUNTU}' not in ${TESTED_LINUX_DISTROS}    CNB001.201 not supported

dasharo-compatibility/display-ports-and-lcd-support.robot

@@ -23,7 +23,7 @@ Suite Teardown      Log Out And Close Connection
 
 
 *** Test Cases ***
-DSP001.201 - Internal display in OS (Ubuntu)
+DSP001.201 Internal display in OS (Ubuntu)
     [Documentation]    Check whether an internal display is visible in
     ...    Ubuntu.
     ...    Previous IDs: DSP001.002
@@ -32,14 +32,14 @@ DSP001.201 - Internal display in OS (Ubuntu)
     Skip If    "${ENV_ID_UBUNTU}" not in "${TESTED_LINUX_DISTROS}"    DSP001.201 not supported
     Internal Display In OS    ${ENV_ID_UBUNTU}
 
-DSP001.202 - Internal display in OS (Fedora)
+DSP001.202 Internal display in OS (Fedora)
     [Documentation]    Check whether an internal display is visible in
     ...    Ubuntu.
     Skip If    not ${INTERNAL_LCD_DISPLAY_SUPPORT}    DSP001.202 not supported
     Skip If    "${ENV_ID_FEDORA}" not in "${TESTED_LINUX_DISTROS}"    DSP003.202 not supported
     Internal Display In OS    ${ENV_ID_FEDORA}
 
-DSP001.301 - Internal display in OS (Windows)
+DSP001.301 Internal display in OS (Windows)
     [Documentation]    Check whether an internal display is visible in
     ...    Windows OS.
     ...    Previous IDs: DSP001.003
@@ -49,7 +49,7 @@ DSP001.301 - Internal display in OS (Windows)
     Login To Windows
     Check Internal LCD Windows
 
-DSP002.201 - External HDMI display in OS (Ubuntu)
+DSP002.201 External HDMI display in OS (Ubuntu)
     [Documentation]    Check whether an external HDMI display is visible in
     ...    Linux OS. An external HDMI display must be provided in
     ...    the platform config.
@@ -59,15 +59,15 @@ DSP002.201 - External HDMI display in OS (Ubuntu)
     Skip If    "${ENV_ID_UBUNTU}" not in "${TESTED_LINUX_DISTROS}"    DSP002.201 not supported
     External HDMI Display    ${ENV_ID_UBUNTU}
 
-DSP002.202 - External HDMI display in OS (Fedora)
+DSP002.202 External HDMI display in OS (Fedora)
     [Documentation]    Check whether an external HDMI display is visible in
     ...    Fedora OS. An external HDMI display must be provided in
     ...    the platform config.
     Skip If    not ${EXTERNAL_HDMI_DISPLAY_SUPPORT}    DSP002.202 not supported
     Skip If    "${ENV_ID_FEDORA}" not in "${TESTED_LINUX_DISTROS}"    DSP002.202 not supported
     External HDMI Display    ${ENV_ID_FEDORA}
 
-DSP002.301 - External HDMI display in OS (Windows)
+DSP002.301 External HDMI display in OS (Windows)
     [Documentation]    Check whether an external HDMI display is visible in
     ...    Windows OS. An external HDMI display must be provided in
     ...    the platform config.
@@ -90,7 +90,7 @@ DSP002.401 External HDMI display in OS (ESXi)
     Execute Manual Step    [3/4] Boot into ESXi and wait for the DCUI to appear
     Execute Manual Step    [4/4] Confirm that the ESXi interface is visible on the external HDMI display
 
-DSP003.201 - External DP display in OS (Ubuntu)
+DSP003.201 External DP display in OS (Ubuntu)
     [Documentation]    Check whether an external Display Port is visible in
     ...    Linux OS. An external Display Port must be provided in
     ...    the platform config.
@@ -100,15 +100,15 @@ DSP003.201 - External DP display in OS (Ubuntu)
     Skip If    "${ENV_ID_UBUNTU}" not in "${TESTED_LINUX_DISTROS}"    DSP001.201 not supported
     External DP Display In OS    ${ENV_ID_UBUNTU}
 
-DSP003.202 - External DP display in OS (Fedora)
+DSP003.202 External DP display in OS (Fedora)
     [Documentation]    Check whether an external Display Port is visible in
     ...    Linux OS. An external Display Port must be provided in
     ...    the platform config.
     Skip If    not ${EXTERNAL_DISPLAY_PORT_SUPPORT}    DSP003.202 not supported
     Skip If    "${ENV_ID_FEDORA}" not in "${TESTED_LINUX_DISTROS}"    DSP003.202 not supported
     External DP Display In OS    ${ENV_ID_FEDORA}
 
-DSP003.301 - External DP display in OS (Windows)
+DSP003.301 External DP display in OS (Windows)
     [Documentation]    Check whether an external Display Port is visible in
     ...    Windows OS. An external Display Port must be provided in
     ...    the platform config.

dasharo-compatibility/efi.robot

@@ -40,7 +40,7 @@ EFI001.201 Boot into UEFI OS (Ubuntu)
 EFI001.301 Boot into UEFI OS (Windows)
     [Documentation]    Boot into Windows 11 OS and check whether there is a
     ...    possibility to identify the system
-    ...    Previous IDs: EFI001.301
+    ...    Previous IDs: EFI001.002
     Skip If    not ${TESTS_IN_WINDOWS_SUPPORT}    EFI001.301 not supported
     Power On
     Login To Windows

dasharo-compatibility/sata-detect.robot

@@ -23,6 +23,7 @@ Suite Teardown      Run Keyword
 SAT001.201 SATA support in OS (Ubuntu)
     [Documentation]    This test aims to verify that SATA is detected from OS
     ...    by using smartctl.
+    ...    Previous IDs: SAT001.002
     Depends On    ${TESTS_IN_FIRMWARE_SUPPORT}
     Depends On    ${TESTS_IN_UBUNTU_SUPPORT}
     Depends On    ${SATA_SUPPORT}

dasharo-compatibility/watchdog.robot

@@ -108,7 +108,7 @@ WDT004.001 Change watchdog timeout
 WDT005.001 Watchdog is detected by OS (Ubuntu)
     [Documentation]    Boot into an OS with the watchdog enabled and verify
     ...    that the OS detects and stops the watchdog.
-    Skip If    not ${TESTS_IN_FIRMWARE_SUPPORT}    APU002.001 not supported
+    Skip If    not ${TESTS_IN_FIRMWARE_SUPPORT}    WDT005.001 not supported
     Skip If    not ${WATCHDOG_SUPPORT}    Watchdog tests not supported.
     Power On
     ${setup_menu}=    Enter Setup Menu Tianocore And Return Construction
@@ -134,10 +134,10 @@ WDT005.001 Watchdog is detected by OS (Ubuntu)
     END
     Should Be Equal    ${platform_has_reset}    ${FALSE}
 
-WTD006.001 Watchdog resets platform on kernel crash (Ubuntu 22.04)
+WDT006.001 Watchdog resets platform on kernel crash (Ubuntu)
     [Documentation]    Boot into OS with the watchdog enabled, crash the kernel
     ...    and verify that the watchdog resets the machine.
-    Skip If    not ${TESTS_IN_FIRMWARE_SUPPORT}    APU002.001 not supported
+    Skip If    not ${TESTS_IN_FIRMWARE_SUPPORT}    WDT006.001 not supported
     Skip If    not ${WATCHDOG_SUPPORT}    Watchdog tests not supported.
     Power On
     ${setup_menu}=    Enter Setup Menu Tianocore And Return Construction

dasharo-performance/cpu-frequency.robot

@@ -67,7 +67,7 @@ CPF003.201 CPU not stuck on initial frequency (Ubuntu) (AC)
 CPF004.201 CPU not stuck on initial frequency (Ubuntu) (USB-PD)
     [Documentation]    This test aims to verify whether the mounted CPU does not
     ...    stuck on the initial frequency after booting into the OS.
-    ...    Previous IDs: CPF001.0010
+    ...    Previous IDs: CPF001.010
     Skip If    not ${CPU_FREQUENCY_MEASURE}    CPF004.201 not supported
     Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    CPF004.201 not supported
     Skip If    '${ENV_ID_UBUNTU}' not in ${TESTED_LINUX_DISTROS}    CPF004.201 not supported

dasharo-performance/cpu-performance.robot

@@ -17,7 +17,8 @@ ${DEVIATION_DOWN}=      0.8
 CPP001.201 Single Threaded CPU Benchmark (Ubuntu) (AC)
     [Documentation]    Test single threaded performance using phoronix
     ...    test suite, for Ubuntu, while connected to power supply.
-    Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    CPP001.001 not supported
+    ...    Previous IDs: CPP001.001
+    Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    CPP001.201 not supported
     Skip If    not ${LAPTOP_PLATFORM}    The Platform is not a Laptop
     Skip If    not ${AC_CONNECTED}    The platform is not connected to AC
     Power On
@@ -32,7 +33,8 @@ CPP001.201 Single Threaded CPU Benchmark (Ubuntu) (AC)
 CPP001.202 Single Threaded CPU Benchmark (Ubuntu) (Battery)
     [Documentation]    Test single threaded performance using phoronix
     ...    test suite, for Ubuntu, while powered by inbuilt battery.
-    Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    CPP001.002 not supported
+    ...    Previous IDs: CPP001.002
+    Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    CPP001.202 not supported
     Skip If    not ${LAPTOP_PLATFORM}    The Platform is not a Laptop
     Skip If    not ${BATTERY_PRESENT}    Battery is not present
     Skip If    ${AC_CONNECTED}    The platform is not connected to AC
@@ -49,8 +51,9 @@ CPP001.202 Single Threaded CPU Benchmark (Ubuntu) (Battery)
 CPP002.201 Multi Threaded CPU Benchmark (Ubuntu) (AC)
     [Documentation]    Test multi threaded performance using phoronix
     ...    test suite, for Ubuntu, while connected to power supply.
+    ...    Previous IDs: CPP002.001
     Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}
-    Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    CPP001.002 not supported
+    Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    CPP002.201 not supported
     Skip If    not ${LAPTOP_PLATFORM}    The Platform is not a Laptop
     Skip If    not ${AC_CONNECTED}    The platform is not connected to AC
     Power On
@@ -63,7 +66,8 @@ CPP002.201 Multi Threaded CPU Benchmark (Ubuntu) (AC)
 CPP002.202 Multi Threaded CPU Benchmark (Ubuntu) (Battery)
     [Documentation]    Test multi threaded performance using phoronix
     ...    test suite, for Ubuntu, while powered by inbuilt battery.
-    Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    CPP001.002 not supported
+    ...    Previous IDs: CPP002.002
+    Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    CPP002.202 not supported
     Skip If    not ${LAPTOP_PLATFORM}    The Platform is not a Laptop
     Skip If    not ${BATTERY_PRESENT}    Battery not present
     Skip If    ${AC_CONNECTED}    AC connected

dasharo-performance/cpu-temperature.robot

@@ -114,7 +114,7 @@ CPT005.201 CPU temperature after stress test (Ubuntu)
     CPU Temperature After Stress Test
     Exit From Root User
 
-CPT006.002 CPU temperature after stress test (Ubuntu) (battery)
+CPT006.201 CPU temperature after stress test (Ubuntu) (battery)
     [Documentation]    This test aims to verify whether the temperature of the
     ...    CPU cores is not higher than the maximum allowed
     ...    temperature during stress test.

dasharo-security/tpm-support.robot

@@ -148,7 +148,7 @@ TPM003.301 Check TPM Physical Presence Interface (Windows)
 TPM011.101 Change active PCR banks with TPM PPI (EDK2 UEFI)
     [Documentation]    This test aims to verify that the TPM Physical Presence
     ...    Interface is working properly in the firmware by changing active TPM PCR banks.
-    ...    Previous IDs: TPM003.004
+    ...    Previous IDs: TPM003.004 TPM003.101
     Skip If    not ${TPM_SUPPORTED_VERSION} == 2    TPM003.101 not supported
     Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    TPM003.101 not supported
     Power On
@@ -185,6 +185,7 @@ TPM011.101 Change active PCR banks with TPM PPI (EDK2 UEFI)
 
 TPM012.201 Check if the ChangeEPS works (Ubuntu)
     [Documentation]    Check if the `TPM2 ChangeEPS` setup menu option works properly.
+    ...    Previous IDs: TPM004.201
     Power On
     Boot System Or From Connected Disk    ${ENV_ID_UBUNTU}
     Login To Linux

dasharo-stability/m2-wifi.robot

@@ -18,11 +18,16 @@ Suite Teardown      Run Keyword
 
 
 *** Test Cases ***
+# WARNING: test case IDs in this file were originally using IDs with 4 digits
+# before decimal point. These are present in release scopes, so they must be
+# preserved in 'Previous IDs'.
+#
 # Tests will work on laptops with access to the serial console and possibility
 # of remote power control
 # SMW001.001 Wi-fi connection after cold boot (Ubuntu)
 #    [Documentation]    Check whether the Wi-Fi card is detected and working
 #    ...    correctly after performing a cold boot.
+#    ...    Previous IDs: SMW0001.001
 #    Skip If    not ${m2_wifi_support}    SMW001.001 not supported
 #    Skip If    not ${tests_in_ubuntu_support}    SMW001.001 not supported
 #    Skip If    '${POWER_CTRL}' == 'none'    Coldboot automatic tests not supported
@@ -48,7 +53,7 @@ Suite Teardown      Run Keyword
 SMW002.201 Wi-fi connection after warm boot (Ubuntu)
     [Documentation]    Check whether the Wi-Fi card is detected and working
     ...    correctly after performing a warm boot.
-    ...    Previous IDs: SMW002.001
+    ...    Previous IDs: SMW0002.001 SMW002.001
     Skip If    not ${M2_WIFI_SUPPORT}    SMW002.201 not supported
     Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    SMW002.201 not supported
     Skip If    '${ENV_ID_UBUNTU}' not in ${TESTED_LINUX_DISTROS}    SMW002.201 not supported
@@ -62,7 +67,7 @@ SMW002.201 Wi-fi connection after warm boot (Ubuntu)
 SMW003.201 Wi-fi connection after reboot (Ubuntu)
     [Documentation]    Check whether the Wi-Fi card is detected and working
     ...    correctly after performing a reboot.
-    ...    Previous IDs: SMW003.001
+    ...    Previous IDs: SMW0003.001 SMW003.001
     Skip If    not ${M2_WIFI_SUPPORT}    SMW003.201 not supported
     Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    SMW003.201 not supported
     Skip If    '${ENV_ID_UBUNTU}' not in ${TESTED_LINUX_DISTROS}    SMW003.201 not supported
@@ -76,7 +81,7 @@ SMW003.201 Wi-fi connection after reboot (Ubuntu)
 SMW004.201 Wi-fi connection after suspension (Ubuntu)
     [Documentation]    Check whether the Wi-Fi card is detected and working
     ...    correctly after performing suspension.
-    ...    Previous IDs: SMW004.001
+    ...    Previous IDs: SMW0004.001 SMW004.001
     Skip If    not ${M2_WIFI_SUPPORT}    SMW004.201 not supported
     Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    SMW004.201 not supported
     Skip If    ${PLATFORM_SLEEP_TYPE_SELECTABLE}    SMW004.201 not supported
@@ -123,7 +128,6 @@ SMW006.201 Wi-fi connection after suspension (Ubuntu) (S3)
 SMW002.202 Wi-fi connection after warm boot (Fedora)
     [Documentation]    Check whether the Wi-Fi card is detected and working
     ...    correctly after performing a warm boot.
-    ...    Previous IDs: SMW002.001
     Skip If    not ${M2_WIFI_SUPPORT}    SMW002.202 not supported
     Skip If    '${ENV_ID_FEDORA}' not in ${TESTED_LINUX_DISTROS}    SMW002.202 not supported
     Power On
@@ -136,7 +140,6 @@ SMW002.202 Wi-fi connection after warm boot (Fedora)
 SMW003.202 Wi-fi connection after reboot (Fedora)
     [Documentation]    Check whether the Wi-Fi card is detected and working
     ...    correctly after performing a reboot.
-    ...    Previous IDs: SMW003.202
     Skip If    not ${M2_WIFI_SUPPORT}    SMW003.202 not supported
     Skip If    '${ENV_ID_FEDORA}' not in ${TESTED_LINUX_DISTROS}    SMW003.202 not supported
     Power On
@@ -149,7 +152,6 @@ SMW003.202 Wi-fi connection after reboot (Fedora)
 SMW004.202 Wi-fi connection after suspension (Fedora)
     [Documentation]    Check whether the Wi-Fi card is detected and working
     ...    correctly after performing suspension.
-    ...    Previous IDs: SMW004.001
     Skip If    not ${M2_WIFI_SUPPORT}    SMW004.202 not supported
     Skip If    ${PLATFORM_SLEEP_TYPE_SELECTABLE}    SMW004.202 not supported
     Skip If    '${ENV_ID_FEDORA}' not in ${TESTED_LINUX_DISTROS}    SMW004.202 not supported
@@ -163,7 +165,6 @@ SMW004.202 Wi-fi connection after suspension (Fedora)
 SMW005.202 Wi-fi connection after suspension (Fedora) (S0ix)
     [Documentation]    Check whether the Wi-Fi card is detected and working
     ...    correctly after performing suspension.
-    ...    Previous IDs: SMW004.002
     Skip If    not ${M2_WIFI_SUPPORT}    SMW005.202 not supported
     Skip If    not ${PLATFORM_SLEEP_TYPE_SELECTABLE}    SMW005.202 not supported
     Skip If    '${ENV_ID_FEDORA}' not in ${TESTED_LINUX_DISTROS}    SMW005.202 not supported
@@ -178,7 +179,6 @@ SMW005.202 Wi-fi connection after suspension (Fedora) (S0ix)
 SMW006.202 Wi-fi connection after suspension (Fedora) (S3)
     [Documentation]    Check whether the Wi-Fi card is detected and working
     ...    correctly after performing suspension.
-    ...    Previous IDs: SMW004.003
     Skip If    not ${M2_WIFI_SUPPORT}    SMW006.202 not supported
     Skip If    not ${PLATFORM_SLEEP_TYPE_SELECTABLE}    SMW006.202 not supported
     Skip If    '${ENV_ID_FEDORA}' not in ${TESTED_LINUX_DISTROS}    SMW006.202 not supported

dasharo-stability/network-interface-after-suspend.robot

@@ -70,7 +70,7 @@ NET004.201 NET controller after suspend (Ubuntu)
 NET005.201 NET controller after suspend (Ubuntu) (S0ix)
     [Documentation]    This test aims to verify that the network controller works and the platform
     ...    is able to connect to the network after suspend.
-    ...    Previous IDs: NET04.002
+    ...    Previous IDs: NET004.002
     Skip If    not ${TESTS_IN_UBUNTU_SUPPORT}    NET005.201 not supported
     Skip If    '${ENV_ID_UBUNTU}' not in ${TESTED_LINUX_DISTROS}    NET005.201 not supported
     Skip If    not ${PLATFORM_SLEEP_TYPE_SELECTABLE}    NET005.201 not supported