Update lint workflow to exclude new usages of SafeAttributePersistenceProvider (project-chip#40776)

* Update files to match the style from the ember exclusion script

* Update lint workflow to use the script

* Remove search for AttributePersistenceProvider

* Restyled - script

* Update lint workflow to skip `scripts/`

Author: jennygaz

.github/workflows/lint.yml

@@ -253,7 +253,10 @@ jobs:
             # to avoid our grep regexp matching itself.
             #
             # Known client-side clusters are allowed to use this only.
-            - name: emberAfClusterInit/Shutdown callbacks are for client side use, not server side. Use ClusterServerInit/Shutdown for server clusters
+            - name:
+                  emberAfClusterInit/Shutdown callbacks are for client side use,
+                  not server side. Use ClusterServerInit/Shutdown for server
+                  clusters
               if: always()
               run: |
                   git grep -I -n "void emberAf.*Cluster\(Init\|Shutdown\)Callback("  -- \
@@ -330,6 +333,18 @@ jobs:
                   --skip-subtree src/controller/tests \
                   --skip-from-file scripts/ember_exclusions.txt
 
+            # This check ensures that `SafeAttributePersistenceProvider` nor `AttributePersistenceProvider`
+            # are being used. Exclusions should be removed as soon as a refactor of the file affected is done.
+            - name:
+                  Check for use of 'SafeAttributePersistenceProvider' and
+                  'AttributePersistenceProvider' symbols
+              if: always()
+              run: |
+                  scripts/find_attribute_persistence_provider_usage.sh \
+                  --skip-subtree .github/ \
+                  --skip-subtree scripts/ \
+                  --skip-from-file scripts/attribute_persistence_provider_exclusions.txt
+
             # git grep exits with 0 if it finds a match, but we want
             # to fail (exit nonzero) on match.  And we want to exclude this file,
             # to avoid our grep regexp matching itself, as well as excluding the files

scripts/attribute_persistence_provider_exclusions.txt

@@ -0,0 +1,36 @@
+# Exclusion list for SafeAttributePersistenceProvider usage checker
+# This file contains paths to files that currently use SafeAttributePersistenceProvider and are allowed to continue using it
+# Files listed here will be skipped when checking for new usage of SafeAttributePersistenceProvider
+
+# Documentation files
+docs/cluster_and_device_type_dev/cluster_and_device_type_dev.md
+
+# Example applications
+examples/energy-management-app/energy-management-common/energy-evse/src/EnergyEvseDelegateImpl.cpp
+examples/energy-management-app/energy-management-common/energy-evse/src/EnergyEvseManager.cpp
+
+# Build files
+src/app/BUILD.gn
+src/app/chip_data_model.cmake
+
+# Core SafeAttributePersistenceProvider implementation files
+src/app/SafeAttributePersistenceProvider.h
+src/app/SafeAttributePersistenceProvider.cpp
+src/app/DefaultSafeAttributePersistenceProvider.h
+src/app/persistence/AttributePersistenceProvider.h
+
+# Server implementation
+src/app/server/Server.cpp
+
+# Cluster server implementations that currently use SafeAttributePersistenceProvider
+src/app/clusters/boolean-state-configuration-server/boolean-state-configuration-server.cpp
+src/app/clusters/camera-av-settings-user-level-management-server/camera-av-settings-user-level-management-server.h
+src/app/clusters/camera-av-stream-management-server/camera-av-stream-management-server.h
+src/app/clusters/chime-server/chime-server.cpp
+src/app/clusters/mode-base-server/mode-base-server.cpp
+src/app/clusters/resource-monitoring-server/resource-monitoring-server.cpp
+src/app/clusters/thread-network-directory-server/thread-network-directory-server.cpp
+src/app/clusters/tls-certificate-management-server/tls-certificate-management-server.cpp
+src/app/clusters/tls-client-management-server/tls-client-management-server.cpp
+src/app/clusters/unit-localization-server/unit-localization-server.cpp
+src/app/clusters/zone-management-server/zone-management-server.h

scripts/find_attribute_persistence_provider_usage.sh

@@ -0,0 +1,55 @@
+#!/bin/bash
+
+# This script checks for the use of 'SafeAttributePersistenceProvider'
+# symbols in the codebase. It takes exclusion folders as arguments and can also read exclusions from a file.
+
+# Function to check for SafeAttributePersistenceProvider symbols
+check_symbols() {
+    local exclusions=()
+    while [[ $# -gt 0 ]]; do
+        case $1 in
+            --skip-subtree)
+                exclusions+=(":(exclude)$2")
+                shift 2
+                ;;
+            --skip-from-file)
+                if [[ -f "$2" ]]; then
+                    while IFS= read -r line || [[ -n "$line" ]]; do
+                        [[ -z "$line" || "$line" =~ ^[[:space:]]*# ]] && continue
+                        exclusions+=(":(exclude)$line")
+                    done <"$2"
+                else
+                    echo "Warning: File '$2' not found, continuing without these exclusions"
+                fi
+                shift 2
+                ;;
+            --help)
+                echo "Usage: $0 [--skip-subtree <dir>] [--skip-from-file <file>]"
+                echo "  --skip-subtree <dir>     Skip the specified subtree or file from the search (can be used multiple times)"
+                echo "  --skip-from-file <file>  Read paths to exclude from the specified file (one path per line)"
+                echo "  --help                   Display this help message"
+                exit 0
+                ;;
+            *)
+                echo "Unknown option: $1"
+                exit 1
+                ;;
+        esac
+    done
+
+    # Search for SafeAttributePersistenceProvider usage (class usage, not just includes)
+    safe_provider_matches=$(git grep -I -n '\<SafeAttributePersistenceProvider\>' -- './*' "${exclusions[@]}" | grep -v '#include')
+
+    if [[ -n "$safe_provider_matches" ]]; then
+        echo "Error: Found 'SafeAttributePersistenceProvider' usage in the following files and lines:"
+        echo ""
+        echo "SafeAttributePersistenceProvider usage:"
+        echo "$safe_provider_matches"
+        exit 1
+    else
+        echo "SUCCESS: No unauthorized usage of SafeAttributePersistenceProvider found."
+    fi
+}
+
+# Main script execution here
+check_symbols "$@"