etl/scripts/update_release.py

import shutil
import os

# Get the current path of the script
script_dir = os.path.dirname(os.path.abspath(__file__))

# Get the root folder of the ETL
etl_dir = os.path.abspath(os.path.join(script_dir, os.pardir))

# Get the ETL repository folder
include_dir = os.path.join(etl_dir, 'include')

# Get the ETL headers folder
headers_dir = os.path.join(include_dir, 'etl')

# Get the Hugo folder
hugo_dir = os.path.join(etl_dir, 'hugo')

# Get the Arduino folder
arduino_dir = os.path.join(etl_dir, 'arduino')

# Get the ETL arduino_examples folder
arduino_examples_dir = os.path.join(arduino_dir, 'examples')

# Get the root folder of both repositories
common_dir = os.path.abspath(os.path.join(etl_dir, os.pardir))

# Get the ETL Arduino repository folder
etl_arduino_dir = os.path.join(common_dir, 'etl-arduino')

# Get the ETL Arduino src repository folder
etl_arduino_src_dir = os.path.join(etl_arduino_dir, 'src')

# Get the ETL Arduino examples repository folder
etl_arduino_examples_dir = os.path.join(etl_arduino_dir, 'examples')

major_version = ''
minor_version = ''
patch_version = ''

#------------------------------------------------------------------------------
# Assumes this folder structure.
# Folder              Variable
# ---------------------------------------
# etl                 etl_dir
#   arduino           arduino_dir
#   include           include_dir
# etl-arduino         etl_arduino_dir
#   src               etl_arduino_src_dir
def create_arduino_variant():
  print('')
  print('Copy ETL files to the etl-arduino repository')
  print('')

  print('script_dir               = ', script_dir)
  print('etl_dir                  = ', etl_dir)
  print('include_dir              = ', include_dir)
  print('headers_dir              = ', headers_dir)
  print('hugo_dir                 = ', hugo_dir)
  print('arduino_dir              = ', arduino_dir)
  print('examples_dir             = ', arduino_examples_dir)
  print('common_dir               = ', common_dir)
  print('etl_arduino_dir          = ', etl_arduino_dir)
  print('etl_arduino_src_dir      = ', etl_arduino_src_dir)
  print('etl_arduino_examples_dir = ', etl_arduino_examples_dir)

  print('')

  # Copy the library properties
  src_filename    = 'library-arduino.properties'
  dst_filename    = 'library.properties'
  source      = os.path.join(arduino_dir, src_filename)
  destination = os.path.join(etl_arduino_dir, dst_filename)
  print('Copy the library properties')
  print('  From :', source)
  print('  To   :', destination)
  shutil.copyfile(source, destination)

  print('')

  # Copy the library json
  src_filename    = 'library-arduino.json'
  dst_filename    = 'library.json'
  source      = os.path.join(arduino_dir, src_filename)
  destination = os.path.join(etl_arduino_dir, dst_filename)
  print('Copy the library json')
  print('  From :', source)
  print('  To   :', destination)
  shutil.copyfile(source, destination)

  print('')

  # Copy the Arduino ETL header
  filename    = 'Embedded_Template_Library.h'
  source      = os.path.join(arduino_dir, filename)
  destination = os.path.join(etl_arduino_src_dir, filename)
  print('Copy the Arduino ETL header')
  print('  From :', source)
  print('  To   :', destination)
  shutil.copyfile(source, destination)

  print('')

  # Copy the ETL headers
  source      = include_dir
  destination = etl_arduino_src_dir
  print('Copy the ETL headers')
  print('  From :', source)
  print('  To   :', destination)
  shutil.copytree(source, destination, dirs_exist_ok = True)

  print('')

  # Copy the ETL arduino_examples
  source      = arduino_examples_dir
  destination = etl_arduino_examples_dir
  print('Copy the ETL Arduino examples')
  print('  From :', source)
  print('  To   :', destination)
  shutil.copytree(source, destination, dirs_exist_ok = True)

#------------------------------------------------------------------------------
def get_version():
  version_file = os.path.join(etl_dir, 'version.txt')
  print('')
  print('version_file = ', version_file)

  with open(version_file) as f:
    version = f.read().splitlines()

  elements = version[0].split('.', 3)

  return version[0], elements[0], elements[1], elements[2]

#------------------------------------------------------------------------------
def update_version_h():
  print('')
  print('Creating version.h')

  version_h = os.path.join(headers_dir, 'version.h')

  with open(version_h) as f:
    text = f.read().splitlines()

  search_major = '#define ETL_VERSION_MAJOR '
  search_minor = '#define ETL_VERSION_MINOR '
  search_patch = '#define ETL_VERSION_PATCH '

  length_major = len(search_major)
  length_minor = len(search_minor)
  length_patch = len(search_patch)

  for i in range(len(text) - 1):

    index = text[i].find(search_major)
    if index != -1:
      text[i] = text[i][index:length_major] + major_version
      print(text[i])

    index = text[i].find(search_minor)
    if index != -1:
      text[i] = text[i][index:length_minor] + minor_version
      print(text[i])

    index = text[i].find(search_patch)
    if index != -1:
      text[i] = text[i][index:length_patch] + patch_version
      print(text[i])

  with open(version_h, 'w') as f:
    for line in text:
      f.write(line)
      f.write('\n')

#------------------------------------------------------------------------------
def update_hugo_version_txt():
  print('')
  print('Copying version.txt to hugo/assets')

  src = os.path.join(etl_dir,  'version.txt')
  dst = os.path.join(hugo_dir, 'assets', 'version.txt')

  try:
      shutil.copyfile(src, dst)
      print("Copy successful!")
  except PermissionError:
      print(f"Permission denied. Check if the file is open or locked.")

#------------------------------------------------------------------------------
def update_library_json(filename):
  print('')
  print('Creating %s' % filename)

  with open(filename) as f:
    text = f.read().splitlines()

  search = 'version'

  for i in range(len(text) - 1):
    index = text[i].find(search)
    if index != -1:
      text[i] = '  \"version\": \"' + full_version + '\",'

  with open(filename, 'w') as f:
    for line in text:
      f.write(line)
      f.write('\n')

#------------------------------------------------------------------------------
def update_library_properties(filename):
  print('')
  print('Creating %s' % filename)

  with open(filename, 'r') as f:
    text = f.read().splitlines()

  search = 'version'

  for i in range(len(text) - 1):
    index = text[i].find(search)
    if index != -1:
      text[i] = 'version=' + full_version

  with open(filename, 'w') as f:
    for line in text:
      f.write(line)
      f.write('\n')

#------------------------------------------------------------------------------
def update_versions():
  print('')
  print('Update Versions')

  global full_version
  global major_version
  global minor_version
  global patch_version

  full_version, major_version, minor_version, patch_version = get_version()

  print("Version = %s.%s.%s" % (major_version, minor_version, patch_version ))

  update_version_h()
  update_hugo_version_txt()

  update_library_json(os.path.join(etl_dir,     'library.json'))
  update_library_json(os.path.join(arduino_dir, 'library-arduino.json'))

  update_library_properties(os.path.join(etl_dir,     'library.properties'))
  update_library_properties(os.path.join(arduino_dir, 'library-arduino.properties'))

#------------------------------------------------------------------------------
if __name__ == "__main__":
  update_versions()
  create_arduino_variant()