Updating nxp_sdk update script after code review

- dataclass is now used
- subprocess dependencies on cwd removed with possible (for west update and west forall cwd is still required)
- python logging module is now used

Signed-off-by: Gatien Chapon <gatien.chapon@nxp.com>

Author: chapongatien

scripts/setup/nxp/update_nxp_sdk.py

@@ -16,82 +16,104 @@
 #
 
 import argparse
+import logging
 import os
+import shutil
 import subprocess
 import sys
+from dataclasses import dataclass
 
 CHIP_ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '../../..'))
 
-# Array listing all SDK and default targeted path for NXP SDK storage
+
+@dataclass(init=False)
+class NxpSdk:
+    sdk_name: str
+    sdk_target_location: str
+    sdk_manifest_path: str
+
+    def __init__(self, name, sdk_target_location):
+        self.sdk_name = name
+        self.sdk_target_location = sdk_target_location
+        self.sdk_manifest_path = os.path.abspath(os.path.join(sdk_target_location, 'manifest'))
+
+
+def NxpSdk_k32w0():
+    rel_path_k32w0 = 'third_party/nxp/nxp_matter_support/github_sdk/k32w0'
+    sdk = NxpSdk('k32w0', os.path.abspath(os.path.join(CHIP_ROOT, rel_path_k32w0)))
+    return sdk
+
+
 ALL_PLATFORM_SDK = [
-    {'plat_name': 'k32w0', 'plat_sdk_manifest_path': 'third_party/nxp/nxp_matter_support/github_sdk/k32w0'},
+    NxpSdk_k32w0(),
 ]
 
-all_platform_sdk_list = list(map(lambda plat: plat["plat_name"], ALL_PLATFORM_SDK))
+ALL_PLATFORM_NAME = [p.sdk_name for p in ALL_PLATFORM_SDK]
 
 
-def clean_sdk_local_changes(sdk_target_location):
-    print("SDK will be cleaned all local modification(s) will be lost")
+def clean_sdk_local_changes(sdk_location):
+    logging.warning("SDK will be cleaned all local modification(s) will be lost")
     # Cleaning all local modifications
     git_clean_command = "git reset --hard && git clean -xdf"
     command = ['west', 'forall', '-c', git_clean_command, '-a']
-    subprocess.run(command, cwd=sdk_target_location, check=True)
+    subprocess.run(command, cwd=sdk_location, check=True)
 
 
-def init_platform_sdk_version(sdk_target_location, force):
-    print("Init SDK in: " + sdk_target_location)
-    if not force and os.path.exists(os.path.join(sdk_target_location, '.west')):
-        print("Error SDK is already initialized, use --force to force init")
-        print("WARNING -- All local SDK modification(s) will be lost")
-        sys.exit(1)
-    command = ['rm', '-rf', '.west']
-    subprocess.run(command, cwd=sdk_target_location, check=True)
+def init_nxp_sdk_version(nxp_sdk, force):
+    print("Init SDK in: " + nxp_sdk.sdk_target_location)
+    west_path = os.path.join(nxp_sdk.sdk_target_location, '.west')
+    if os.path.exists(west_path):
+        if not force:
+            logging.error("SDK is already initialized, use --force to force init")
+            sys.exit(1)
+        shutil.rmtree(west_path)
 
-    command = ['west', 'init', '-l', 'manifest', '--mf', 'west.yml']
-    subprocess.run(command, cwd=sdk_target_location, check=True)
-    update_platform_sdk_version(sdk_target_location, force)
+    command = ['west', 'init', '-l', nxp_sdk.sdk_manifest_path, '--mf', 'west.yml']
+    subprocess.run(command, check=True)
+    update_nxp_sdk_version(nxp_sdk, force)
 
 
-def update_platform_sdk_version(sdk_target_location, force):
-    print("Update SDK in " + sdk_target_location)
-    if not os.path.exists(os.path.join(sdk_target_location, '.west')):
-        print("--update-only error SDK is not initialized")
+def update_nxp_sdk_version(nxp_sdk, force):
+    print("Update SDK in " + nxp_sdk.sdk_target_location)
+    if not os.path.exists(os.path.join(nxp_sdk.sdk_target_location, '.west')):
+        logging.error("--update-only error SDK is not initialized")
         sys.exit(1)
     command = ['west', 'update', '--fetch', 'smart']
     try:
-        subprocess.run(command, cwd=sdk_target_location, check=True)
+        subprocess.run(command, cwd=nxp_sdk.sdk_target_location, check=True)
     except (RuntimeError, subprocess.CalledProcessError) as exception:
         if force:
-            # In case of force update option and in case of update failure:
-            # 1. try to clean all local modications if any
-            # 2. Retry the west update command. It should be successfull now as all local modifications have been cleaned
-            clean_sdk_local_changes(sdk_target_location)
-            subprocess.run(command, cwd=sdk_target_location, check=True)
+            if nxp_sdk.sdk_name == 'k32w0':
+                logging.error('Force update not yet supported for %s platform', nxp_sdk.sdk_name)
+            else:
+                # In case of force update option and in case of update failure:
+                # 1. try to clean all local modications if any
+                # 2. Retry the west update command. It should be successfull now as all local modifications have been cleaned
+                clean_sdk_local_changes(nxp_sdk.sdk_target_location)
+                subprocess.run(command, cwd=nxp_sdk.sdk_target_location, check=True)
         else:
-            print(exception)
-            print("Error SDK cannot be updated, local changes should be cleaned manually or use --force to force update")
-            print("WARNING -- With --force all local SDK modification(s) will be lost")
+            logging.exception(
+                'Error SDK cannot be updated, local changes should be cleaned manually or use --force to force update %s', exception)
 
 
 def main():
 
     parser = argparse.ArgumentParser(description='Checkout or update relevant NXP SDK')
     parser.add_argument(
         "--update-only", help="Update NXP SDK to the correct version. Would fail if the SDK does not exist", action="store_true")
-    parser.add_argument('--platform', nargs='+', choices=all_platform_sdk_list, default=all_platform_sdk_list,
+    parser.add_argument('--platform', nargs='+', choices=ALL_PLATFORM_NAME, default=ALL_PLATFORM_NAME,
                         help='Allows to select which SDK for a particular NXP platform to initialize')
     parser.add_argument('--force', action='store_true',
                         help='Force SDK initialization, hard clean will be done in case of failure - WARNING -- All local SDK modification(s) will be lost')
 
     args = parser.parse_args()
 
     for current_plat in args.platform:
-        plat_path = list(map(lambda res: res['plat_sdk_manifest_path'], filter(
-            lambda cmd: cmd["plat_name"] == current_plat, ALL_PLATFORM_SDK)))[0]
+        nxp_sdk = [p for p in ALL_PLATFORM_SDK if p.sdk_name == current_plat][0]
         if args.update_only:
-            update_platform_sdk_version(os.path.join(CHIP_ROOT, plat_path), args.force)
+            update_nxp_sdk_version(nxp_sdk, args.force)
         else:
-            init_platform_sdk_version(os.path.join(CHIP_ROOT, plat_path), args.force)
+            init_nxp_sdk_version(nxp_sdk, args.force)
 
 
 if __name__ == '__main__':