Add new scripts to support automatic updating vesions of spring (#29325)

* update to support automatic work

Author: Netyyyy

sdk/spring/scripts/README.md

@@ -16,14 +16,14 @@
 
 def main():
     start_time = time.time()
-    change_to_root_dir()
+    change_to_repo_root_dir()
     log.debug('Current working directory = {}.'.format(os.getcwd()))
     find_all_poms_do_version_control("./sdk/spring")
     elapsed_time = time.time() - start_time
     log.info('elapsed_time = {}'.format(elapsed_time))
 
 
-def change_to_root_dir():
+def change_to_repo_root_dir():
     os.chdir(os.path.dirname(os.path.realpath(__file__)))
     os.chdir('../../..')
 

sdk/spring/scripts/compatibility_delete_version.py

@@ -16,7 +16,7 @@ def get_args():
     return parser.parse_args()
 
 
-def change_to_root_dir():
+def change_to_repo_root_dir():
     os.chdir(os.path.dirname(os.path.realpath(__file__)))
     os.chdir('../../..')
 
@@ -35,7 +35,7 @@ def get_spring_cloud_version(filepath):
 
 
 def main():
-    change_to_root_dir()
+    change_to_repo_root_dir()
     get_spring_cloud_version("./sdk/spring/spring-cloud-azure-supported-spring.json")
 
 

sdk/spring/scripts/compatibility_get_spring_cloud_version.py

@@ -25,14 +25,14 @@ def get_args():
 
 def main():
     start_time = time.time()
-    change_to_root_dir()
+    change_to_repo_root_dir()
     log.debug('Current working directory = {}.'.format(os.getcwd()))
     add_dependency_management_for_all_poms_files_in_directory("./sdk/spring", get_args().spring_boot_dependencies_version, get_args().spring_cloud_dependencies_version)
     elapsed_time = time.time() - start_time
     log.info('elapsed_time = {}'.format(elapsed_time))
 
 
-def change_to_root_dir():
+def change_to_repo_root_dir():
     os.chdir(os.path.dirname(os.path.realpath(__file__)))
     os.chdir('../../..')
 

sdk/spring/scripts/compatibility_insert_dependencymanagement.py

@@ -13,7 +13,7 @@
 import json
 
 
-def change_to_root_dir():
+def change_to_repo_root_dir():
     os.chdir(os.path.dirname(os.path.realpath(__file__)))
     os.chdir('../../..')
 
@@ -43,7 +43,7 @@ def get_supported_spring_boot_version(filepath):
 
 def main():
     start_time = time.time()
-    change_to_root_dir()
+    change_to_repo_root_dir()
     log.debug('Current working directory = {}.'.format(os.getcwd()))
     suppoerted_spring_boot_version = get_supported_spring_boot_version("./sdk/spring/spring-cloud-azure-supported-spring.json")
     update_supported_version_matrix_json_file("./sdk/spring/supported-version-matrix.json", suppoerted_spring_boot_version)

sdk/spring/scripts/compatibility_update_supported_version_matrix_json.py

@@ -58,7 +58,7 @@ def get_spring_boot_managed_external_dependencies_file_name(spring_boot_dependen
 
 def main():
     start_time = time.time()
-    change_to_root_dir()
+    change_to_repo_root_dir()
     log.debug('Current working directory = {}.'.format(os.getcwd()))
     dependency_dict = {}
     args = get_args()
@@ -71,7 +71,7 @@ def main():
     log.info('elapsed_time = {}'.format(elapsed_time))
 
 
-def change_to_root_dir():
+def change_to_repo_root_dir():
     os.chdir(os.path.dirname(os.path.realpath(__file__)))
     os.chdir('../../..')
 

sdk/spring/scripts/get_spring_boot_managed_external_dependencies.py

@@ -48,7 +48,7 @@
 
 def main():
     start_time = time.time()
-    change_to_root_dir()
+    change_to_repo_root_dir()
     log.debug('Current working directory = {}.'.format(os.getcwd()))
     args = get_args()
     init_log(args)
@@ -57,7 +57,7 @@ def main():
     log.info('elapsed_time = {}'.format(elapsed_time))
 
 
-def change_to_root_dir():
+def change_to_repo_root_dir():
     os.chdir(os.path.dirname(os.path.realpath(__file__)))
     os.chdir('../../..')
 

sdk/spring/scripts/replace_util.py

@@ -4,9 +4,9 @@
 #
 # How to use this script.
 #  1. Get `SPRING_BOOT_VERSION` from https://github.com/spring-projects/spring-boot/tags.
-#  2. Make sure file(`.\sdk\spring\spring_boot_SPRING_BOOT_VERSION_managed_external_dependencies.txt`) exist. If it doesn't exist, please run
+#  2. Make sure file(`.\sdk\spring\spring_boot_${SPRING_BOOT_VERSION}_managed_external_dependencies.txt`) exist. If it doesn't exist, please run
 #    `.\sdk\spring\scripts\get_spring_boot_managed_external_dependencies.py` to create that file.
-#  3. Run command, sample: `python .\sdk\spring\scripts\sync_external_dependencies.py -b 2.7.0`.
+#  3. Run command: `python .\sdk\spring\scripts\sync_external_dependencies.py -b 2.7.0`.
 #     Or `python .\sdk\spring\scripts\sync_external_dependencies.py --spring_boot_dependencies_version 2.7.0`.
 #  4. Then `eng/versioning/external_dependencies.txt` will be updated.
 #
@@ -50,15 +50,15 @@ def get_args():
 
 def main():
     start_time = time.time()
-    change_to_root_dir()
+    change_to_repo_root_dir()
     args = get_args()
     log.debug('Current working directory = {}.'.format(os.getcwd()))
     sync_external_dependencies(get_spring_boot_managed_external_dependencies_file_name(args.spring_boot_dependencies_version), EXTERNAL_DEPENDENCIES_FILE)
     elapsed_time = time.time() - start_time
     log.info('elapsed_time = {}'.format(elapsed_time))
 
 
-def change_to_root_dir():
+def change_to_repo_root_dir():
     os.chdir(os.path.dirname(os.path.realpath(__file__)))
     os.chdir('../../..')
 

sdk/spring/scripts/sync_external_dependencies.py

@@ -0,0 +1,59 @@
+# Python version 3.4 or higher is required to run this script.
+#
+# This script is used to update changelog about Spring Boot and Spring Cloud dependencies versions in `/sdk/spring/CHANGELOG.md`.
+#
+# Sample:
+# 1. python .\sdk\spring\scripts\update_changelog.py --spring_boot_dependencies_version 2.7.0 --spring_cloud_dependencies_version 2021.0.3
+# 2. python .\sdk\spring\scripts\update_changelog.py -b 2.7.0 -c 2021.0.3
+#
+# The script must be run at the root of azure-sdk-for-java.
+
+
+import os
+import time
+import argparse
+
+from log import log
+
+
+CHANGELOG_FILE = 'sdk/spring/CHANGELOG.md'
+
+
+def get_args():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-b', '--spring_boot_dependencies_version', type = str, required = True)
+    parser.add_argument('-c', '--spring_cloud_dependencies_version', type = str, required = True)
+    return parser.parse_args()
+
+
+def get_change_log_content(spring_boot_dependencies_version, spring_cloud_dependencies_version):
+    return "\nUpgrade Spring Boot dependencies version to {} and Spring Cloud dependencies version to {}".format(spring_boot_dependencies_version,spring_cloud_dependencies_version)
+
+
+def update_changelog(spring_boot_dependencies_version, spring_cloud_dependencies_version, target_file):
+    with open(target_file, 'r', encoding = 'utf-8') as file:
+        file_content = file.read()
+        insert_position = file_content.find('(Unreleased)') + len('(Unreleased)')
+        insert_content = get_change_log_content(spring_boot_dependencies_version, spring_cloud_dependencies_version)
+        final_content = file_content[:insert_position] + insert_content + file_content[insert_position:]
+    with open(target_file, 'r+', encoding = 'utf-8') as file:
+        file.writelines(final_content)
+
+
+def main():
+    start_time = time.time()
+    change_to_repo_root_dir()
+    log.debug('Current working directory = {}.'.format(os.getcwd()))
+    args = get_args()
+    update_changelog(args.spring_boot_dependencies_version, args.spring_cloud_dependencies_version, CHANGE_LOG_FILE)
+    elapsed_time = time.time() - start_time
+    log.info('elapsed_time = {}'.format(elapsed_time))
+
+
+def change_to_repo_root_dir():
+    os.chdir(os.path.dirname(os.path.realpath(__file__)))
+    os.chdir('../../..')
+
+
+if __name__ == '__main__':
+    main()

sdk/spring/scripts/update_changelog.py

@@ -0,0 +1,60 @@
+############################################################################################################################################
+# This script is used to update comments at the beginning of `eng/versioning/external_dependencies.txt`.
+#
+# How to use this script.
+#  1. Get `SPRING_BOOT_VERSION` from (.\sdk\spring\spring_boot_${SPRING_BOOT_VERSION}_managed_external_dependencies.txt) filename.
+#  2. Run command: `python .\sdk\spring\scripts\update_external_dependencies_comment.py -b 2.7.0`.
+#     Or `python .\sdk\spring\scripts\sync_external_dependencies.py --spring_boot_dependencies_version 2.7.0`.
+#  3. Then `eng/versioning/external_dependencies.txt` will be updated.
+#
+# Please refer to ./README.md to get more information about this script.
+############################################################################################################################################
+
+import time
+import os
+import argparse
+
+from log import log
+
+EXTERNAL_DEPENDENCIES_FILE = 'eng/versioning/external_dependencies.txt'
+
+
+def get_spring_boot_managed_external_dependencies_file_name(spring_boot_version):
+    return 'sdk/spring/scripts/spring_boot_{}_managed_external_dependencies.txt'.format(spring_boot_version)
+
+
+def get_args():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-b', '--spring_boot_dependencies_version', type = str, required = True)
+    args = parser.parse_args()
+    log.set_log_level(args.log)
+    return args
+
+
+def update_external_dependencies_comment(source_name, target_file):
+    with open(target_file, 'r', encoding = 'utf-8') as file:
+        lines = file.readlines()
+        lines[1] = '# make sure the version is same to {}\n'.format(source_name)
+        lines[2] = '# If your version is different from {},\n'.format(source_name)
+    with open(target_file, 'w', encoding = 'utf-8') as file:
+        file.writelines(lines)
+
+
+def main():
+    start_time = time.time()
+    change_to_repo_root_dir()
+    args = get_args()
+    log.debug('Current working directory = {}.'.format(os.getcwd()))
+    file_name = get_spring_boot_managed_external_dependencies_file_name(args.spring_boot_dependencies_version)
+    update_external_dependencies_comment(file_name, EXTERNAL_DEPENDENCIES_FILE)
+    elapsed_time = time.time() - start_time
+    log.info('elapsed_time = {}'.format(elapsed_time))
+
+
+def change_to_repo_root_dir():
+    os.chdir(os.path.dirname(os.path.realpath(__file__)))
+    os.chdir('../../..')
+
+
+if __name__ == '__main__':
+    main()