refactor(ci): common configuration file for update scripts

avoid multiple json files.

Signed-off-by: Frederic Pillon <[email protected]>

Author: fpistm

.gitignore

@@ -5,7 +5,6 @@ boards.local.txt
 platform.local.txt
 path_config.json
 update_config.json
-variant_config.json
 
 # Backup
 *.bak

CI/update/stm32cube.py

@@ -15,15 +15,14 @@
 script_path = Path(__file__).parent.resolve()
 sys.path.append(str(script_path.parent))
 from utils import copyFile, copyFolder, createFolder, deleteFolder, genSTM32List
-from utils import execute_cmd, getRepoBranchName
+from utils import defaultConfig, execute_cmd, getRepoBranchName
 
 if sys.platform.startswith("win32"):
     from colorama import init
 
     init(autoreset=True)
 
 home = Path.home()
-path_config_filename = "update_config.json"
 
 # GitHub
 gh_st = "https://github.com/STMicroelectronics/"
@@ -85,19 +84,6 @@
 out_separator = "-" * 70
 
 
-def create_config(config_file_path):
-    global repo_local_path
-
-    # Create a Json file for a better path management
-    print(f"'{config_file_path}' file created. Please check the configuration.")
-    path_config_file = open(config_file_path, "w")
-    path_config_file.write(
-        json.dumps({"REPO_LOCAL_PATH": str(repo_local_path)}, indent=2)
-    )
-    path_config_file.close()
-    exit(1)
-
-
 def checkConfig():
     global repo_local_path
     global hal_dest_path
@@ -107,14 +93,18 @@ def checkConfig():
     global md_CMSIS_path
     global stm32_def
 
-    config_file_path = script_path / path_config_filename
+    config_file_path = script_path / "update_config.json"
     if config_file_path.is_file():
         try:
             config_file = open(config_file_path, "r")
             path_config = json.load(config_file)
-            # Common path
-            repo_local_path = Path(path_config["REPO_LOCAL_PATH"])
             config_file.close()
+            # Common path
+            if "REPO_LOCAL_PATH" not in path_config:
+                path_config["REPO_LOCAL_PATH"] = str(repo_local_path)
+                defaultConfig(config_file_path, path_config)
+            else:
+                repo_local_path = Path(path_config["REPO_LOCAL_PATH"])
             hal_dest_path = repo_local_path / repo_core_name / hal_dest_path
             md_HAL_path = hal_dest_path / md_HAL_path
             cmsis_dest_path = repo_local_path / repo_core_name / cmsis_dest_path
@@ -130,7 +120,7 @@ def checkConfig():
         except IOError:
             print(f"Failed to open {config_file}!")
     else:
-        create_config(config_file_path)
+        defaultConfig(config_file_path, {"REPO_LOCAL_PATH": str(repo_local_path)})
     createFolder(repo_local_path)
 
 

CI/update/stm32variant.py

@@ -14,7 +14,7 @@
 
 script_path = Path(__file__).parent.resolve()
 sys.path.append(str(script_path.parent))
-from utils import deleteFolder, execute_cmd, getRepoBranchName
+from utils import defaultConfig, deleteFolder, execute_cmd, getRepoBranchName
 
 mcu_list = []  # 'name'
 io_list = []  # 'PIN','name'
@@ -1274,9 +1274,9 @@ def print_pinamevar():
 
 # Variant files generation
 def spi_pins_variant():
-    ss_pin = (
-        ss1_pin
-    ) = ss2_pin = ss3_pin = mosi_pin = miso_pin = sck_pin = "PNUM_NOT_DEFINED"
+    ss_pin = ss1_pin = ss2_pin = ss3_pin = mosi_pin = miso_pin = sck_pin = (
+        "PNUM_NOT_DEFINED"
+    )
 
     # Iterate to find match instance if any
     for mosi in spimosi_list:
@@ -2385,51 +2385,41 @@ def default_cubemxdir():
 
 
 # Config management
-def create_config():
-    # Create a Json file for a better path management
-    try:
-        print(f"Please set your configuration in '{config_filename}' file")
-        config_file = open(config_filename, "w", newline="\n")
-        config_file.write(
-            json.dumps(
-                {
-                    "CUBEMX_DIRECTORY": str(cubemxdir),
-                    "REPO_LOCAL_PATH": str(repo_local_path),
-                },
-                indent=2,
-            )
-        )
-        config_file.close()
-    except IOError:
-        print(f"Failed to open {config_filename}")
-    exit(1)
-
-
-def check_config():
+def checkConfig():
     global cubemxdir
     global repo_local_path
     global repo_path
     default_cubemxdir()
     if config_filename.is_file():
         try:
             config_file = open(config_filename, "r")
-            config = json.load(config_file)
+            path_config = json.load(config_file)
             config_file.close()
 
-            if "REPO_LOCAL_PATH" in config:
-                conf = config["REPO_LOCAL_PATH"]
-                if conf:
-                    if conf != "":
-                        repo_local_path = Path(conf)
-                        repo_path = repo_local_path / repo_name
-            if "CUBEMX_DIRECTORY" in config:
-                conf = config["CUBEMX_DIRECTORY"]
-                if conf:
-                    cubemxdir = Path(conf)
+            if "REPO_LOCAL_PATH" not in path_config:
+                path_config["REPO_LOCAL_PATH"] = str(repo_local_path)
+                defaultConfig(config_filename, path_config)
+            else:
+                conf = path_config["REPO_LOCAL_PATH"]
+                if conf != "":
+                    repo_local_path = Path(conf)
+                    repo_path = repo_local_path / repo_name
+
+            if "CUBEMX_DIRECTORY" not in path_config:
+                path_config["CUBEMX_DIRECTORY"] = str(cubemxdir)
+                defaultConfig(config_filename, path_config)
+            else:
+                cubemxdir = Path(path_config["CUBEMX_DIRECTORY"])
         except IOError:
             print(f"Failed to open {config_filename}")
     else:
-        create_config()
+        defaultConfig(
+            config_filename,
+            {
+                "CUBEMX_DIRECTORY": str(cubemxdir),
+                "REPO_LOCAL_PATH": str(repo_local_path),
+            },
+        )
 
 
 def manage_repo():
@@ -2487,7 +2477,7 @@ def manage_repo():
 refname_filter = ["STM32MP13", "STM32H7R", "STM32H7S"]
 periph_c_filename = "PeripheralPins.c"
 pinvar_h_filename = "PinNamesVar.h"
-config_filename = script_path / "variant_config.json"
+config_filename = script_path / "update_config.json"
 variant_h_filename = "variant_generic.h"
 variant_cpp_filename = "variant_generic.cpp"
 boards_entry_filename = "boards_entry.txt"
@@ -2499,7 +2489,7 @@ def manage_repo():
 repo_path = repo_local_path / repo_name
 db_release = "Unknown"
 
-check_config()
+checkConfig()
 
 # By default, generate for all mcu xml files description
 parser = argparse.ArgumentParser(

CI/utils/common_ext.py

@@ -1,9 +1,19 @@
+import json
 import re
 import subprocess
 import shutil
 import sys
 
 
+# Add default key/value pair to config file
+def defaultConfig(config_file_path, data):
+    print(f"Please check the default configuration '{config_file_path}'.")
+    config_file = open(config_file_path, "w")
+    config_file.write(json.dumps(data, indent=2))
+    config_file.close()
+    exit(1)
+
+
 # Create a folder if not exists
 def createFolder(path):
     try: