Tamarin/lib/tamarin.py

import os, glob, subprocess, configparser, codecs, sys, pathlib

def run_profile_hooks(profile, step, **kwargs):
  hooks_dir = get_hooks_dir()
  step_hooks = profile[step]["hooks"]
  if not step_hooks:
    return
  for hook_name in step_hooks.split(","):
    trimmed_hook_name = hook_name.strip(' \t\n\r')
    if not trimmed_hook_name:
      continue
    hook_path = hooks_dir.joinpath(trimmed_hook_name)
    run([hook_path], **kwargs)

def get_base_dir():
  base_dir = pathlib.Path(__file__).absolute().parent.parent.resolve()
  return base_dir

def get_hooks_dir():
  hooks_dir = get_base_dir().joinpath('hooks')
  return hooks_dir

def get_lib_dir():
  lib_dir = get_base_dir().joinpath('lib')
  return lib_dir

def get_utils_dir():
  utils_dir = get_base_dir().joinpath('utils')
  return utils_dir

def get_profiles_dir():
  profiles_dir = get_base_dir().joinpath('profiles')
  return profiles_dir

def get_workspace_dir():
    """Return the absolute path to the tamarin workspace ($HOME/.tamarin)"""
    home = pathlib.Path(os.environ["HOME"])
    workspace_dir = home.joinpath('.tamarin')
    return workspace_dir

def get_workspace_subdir(subdir):
    """Return the absolute path to a subdirectory in tamarin workspace"""
    subdir_path = get_workspace_dir().joinpath(subdir)
    subdir_path.mkdir(parents=True, exist_ok=True)
    return subdir_path

def load_profile(profile_name, debug=False):
  profile_filename = profile_name+".conf"
  profile_path = get_profiles_dir().joinpath(profile_filename)
  if profile_path.exists():
    config = configparser.ConfigParser()
    with codecs.open(profile_path, encoding = 'utf-8', mode = 'r') as handle:
      config.read_file(handle)
      return config
  return None

def get_available_profiles():
  return get_profiles_dir().glob('*.conf')

def get_available_profile_names():
    profile_files = get_available_profiles()
    return [p.stem for p in profile_files]

def run(cmd, captureOutput=False, pty=False, debug=False, **kwargs):
    """Execute an arbitrary command on the system"""
    if debug:
        print(" ".join(cmd) if isinstance(cmd, list) else cmd)
    stdin=subprocess.PIPE
    kwargs['shell'] = False if isinstance(cmd, list) else True
    if pty:
        kwargs['stdin'] = sys.stdin
    if captureOutput:
        return subprocess.check_output(cmd, **kwargs)
    else:
        return subprocess.check_call(cmd, **kwargs)

def run_docker(args, captureOutput=False, **kwargs):
    if isinstance(args, list):
        cmd = ["docker"] + args
    else:
        cmd = "docker " + args
    return run(cmd, captureOutput=captureOutput, **kwargs)