Add check to verify the version of cloned repos with expected ones if

the tf-m build directory already exists.
Fix other review comments.

Signed-off-by: Devaraj Ranganna <[email protected]>

Author: urutva

tools/psa/build_tfm.py

@@ -22,31 +22,30 @@
 import sys
 import subprocess
 import logging
-import argparse
 
 logger = logging.getLogger('TF-M-Builder')
 logging.basicConfig(level=logging.INFO,
                     format='[%(name)s] %(asctime)s: %(message)s.',
                     datefmt='%H:%M:%S')
 
-ROOT = abspath(join(dirname(__file__),
-                                    os.pardir, os.pardir))
+ROOT = abspath(join(dirname(__file__), os.pardir, os.pardir))
 sys.path.insert(0, ROOT)
-from tools.targets import Target, TARGET_MAP, TARGET_NAMES
 
 TF_M_BUILD_DIR = join(ROOT, os.pardir, 'tfm_build_dir')
-VERSION_FILE_PATH = join(ROOT,'components/TARGET_PSA/TARGET_TFM')
-
-TFM_GIT = 'https://git.trustedfirmware.org/trusted-firmware-m.git'
-TFM_GIT_BRANCH = 'feature-twincpu'
-MBEDTLS_GIT = 'https://github.com/ARMmbed/mbedtls.git'
-MBEDTLS_GIT_BRANCH = 'mbedtls-2.7.9'
-MBEDCRYPTO_GIT = 'https://github.com/ARMmbed/mbed-crypto.git'
-MBEDCRYPTO_GIT_BRANCH = 'mbedcrypto-1.1.0'
-CMSIS_GIT = 'https://github.com/ARM-software/CMSIS_5.git'
-CMSIS_GIT_BRANCH = '5.5.0'
-
-def run_cmd_return_output(command):
+VERSION_FILE_PATH = join(ROOT, 'features/FEATURE_PSA/FEATURE_TFM')
+
+dependencies = {
+    "trusted-firmware-m":
+    ['https://git.trustedfirmware.org/trusted-firmware-m.git',
+     'feature-twincpu'],
+    "mbedtls": ['https://github.com/ARMmbed/mbedtls.git',
+                'mbedtls-2.7.9'],
+    "mbed-crypto": ['https://github.com/ARMmbed/mbed-crypto.git',
+                    'mbedcrypto-1.1.0'],
+    "CMSIS_5": ['https://github.com/ARM-software/CMSIS_5.git', '5.5.0'],
+}
+
+def run_cmd_and_return_output(command):
     """
     Run the command in the sytem and return output.
     Commands are passed as a list of tokens.
@@ -62,57 +61,83 @@ def run_cmd_return_output(command):
         output = subprocess.check_output(command, stderr=fnull)
     except subprocess.CalledProcessError as e:
         logger.error("The command %s failed with return code: %s",
-                          (' '.join(command)), e.returncode)
+                     (' '.join(command)), e.returncode)
         sys.exit(1)
     return output
 
-def detect_write_tfm_version(tfm_dir, ):
+def detect_and_write_tfm_version(tfm_dir):
     """
-    Identify the version of TF-M and write it to VERSION.TXT
+    Identify the version of TF-M and write it to VERSION.txt
     :param tfm_dir: The filesystem path where TF-M repo is cloned
     """
-    cmd = ['git', '-C', tfm_dir, 'describe', '--tags', '--abbrev=12', '--dirty', '--always']
-    tfm_version = run_cmd_return_output(cmd)
-    logger.debug('TF-M version: %s', tfm_version)
-    with open(join(VERSION_FILE_PATH, 'VERSION.TXT'), 'w+') as f:
-        f.writelines(tfm_version.splitlines(True)[0])
+    cmd = ['git', '-C', tfm_dir, 'describe', '--tags',
+           '--abbrev=12', '--dirty', '--always']
+    tfm_version = run_cmd_and_return_output(cmd)
+    logger.info('TF-M version: %s', tfm_version)
+    if not isdir(VERSION_FILE_PATH):
+        os.makedirs(VERSION_FILE_PATH)
+    with open(join(VERSION_FILE_PATH, 'VERSION.txt'), 'w+') as f:
+        f.write(tfm_version)
+
+def check_repo_version(name, deps):
+    """
+    Compare the version of cloned and expected and exit if they dont match
+    :param name: Name of the git repository
+    :param deps: Dictionary containing dependency details
+    """
+    basedir = TF_M_BUILD_DIR
+    if name == 'trusted-firmware-m':
+        cmd = ['git', '-C', join(basedir, name),
+               'rev-parse', '--abbrev-ref', 'HEAD']
+    else:
+        cmd = ['git', '-C', join(basedir, name),
+               'describe', '--tags']
+    _out = run_cmd_and_return_output(cmd)
+    if _out.strip('\n') != deps.get(name)[1]:
+        logger.error('Conflict: cloned "%s" and expected "%s"',
+                     _out.strip('\n'), deps.get(name)[1])
+        logger.error('check and remove folder %s',
+                     join(basedir, name))
+        sys.exit(1)
+    else:
+        logger.info('%s: version check OK', name)
 
-def check_clone_repo(basedir, name, git_branch, git):
+def check_and_clone_repo(name, deps):
     """
     Test if the repositories are already cloned. If not clone them
-    :param basedir: Base directory into which the repos will be cloned
     :param name: Name of the git repository
-    :param git_branch: Git branch to be cloned
-    :param git: Web link to the git respository
+    :param deps: Dictionary containing dependency details
     """
+    basedir = TF_M_BUILD_DIR
     if not isdir(join(basedir, name)):
         logger.info('Cloning %s repo', name)
-        cmd = ['git', '-C', basedir, 'clone', '-b', git_branch, git]
-        _out = run_cmd_return_output(cmd)
+        cmd = ['git', '-C', basedir, 'clone', '-b',
+               deps.get(name)[1], deps.get(name)[0]]
+        _out = run_cmd_and_return_output(cmd)
         logger.info('Cloned %s repo successfully', name)
     else:
-        logger.info('%s repo exists', name)
+        logger.info('%s repo exists, checking git version...', name)
+        check_repo_version(name, deps)
 
 def clone_tfm_repo():
     """
     Clone TF-M git repos and it's dependencies
     """
-    check_clone_repo(TF_M_BUILD_DIR, 'trusted-firmware-m', TFM_GIT_BRANCH, TFM_GIT)
-    check_clone_repo(TF_M_BUILD_DIR, 'mbedtls', MBEDTLS_GIT_BRANCH, MBEDTLS_GIT)
-    check_clone_repo(TF_M_BUILD_DIR, 'mbed-crypto', MBEDCRYPTO_GIT_BRANCH, MBEDCRYPTO_GIT)
-    check_clone_repo(TF_M_BUILD_DIR, 'CMSIS_5', CMSIS_GIT_BRANCH, CMSIS_GIT)
-
-    detect_write_tfm_version(join(TF_M_BUILD_DIR, 'trusted-firmware-m'), )
+    check_and_clone_repo('trusted-firmware-m', dependencies)
+    check_and_clone_repo('mbedtls', dependencies)
+    check_and_clone_repo('mbed-crypto', dependencies)
+    check_and_clone_repo('CMSIS_5', dependencies)
+    detect_and_write_tfm_version(join(TF_M_BUILD_DIR, 'trusted-firmware-m'), )
 
 def main():
     """
     Build Trusted Firmware M (TF-M) image for mbed-os supported TF-M targets.
     Current version of the script only clones TF-M git repo and dependencies
-    and creates a VERSION.TXT file under 'components/TARGET_PSA/TARGET_TFM'
+    and creates a VERSION.txt file under 'features/FEATURE_PSA/FEATURE_TFM'
     """
     if not isdir(TF_M_BUILD_DIR):
         os.mkdir(TF_M_BUILD_DIR)
     clone_tfm_repo()
 
 if __name__ == '__main__':
-    main()
+    main()