Source code for idmtools_platform_comps.utils.ssmt_utils.common

"""idmtools common ssmt tools.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
import json
import os
import traceback
from argparse import Namespace
from logging import getLogger, DEBUG
from COMPS import Client
from idmtools.core.exceptions import idmtools_error_handler

logger = getLogger(__name__)
user_logger = getLogger('user')

[docs]def ensure_debug_logging(): """Ensure we have debug logging enabled in idmtools.""" # set to debug before loading idmtools os.environ['IDMTOOLS_LOGGING_LEVEL'] = 'DEBUG' os.environ['IDMTOOLS_LOGGING_CONSOLE'] = 'on' from idmtools.core.logging import setup_logging, IdmToolsLoggingConfig setup_logging(IdmToolsLoggingConfig(level=DEBUG, console=True, force=True)) # Import idmtools here to enable logging from idmtools import __version__ logger.debug(f"Using idmtools {__version__}")
[docs]def setup_verbose(args: Namespace): """Setup verbose logging for ssmt.""" print(args) if args.verbose: ensure_debug_logging() logger.debug(f"Args: {args}")
[docs]def login_to_env(): """Ensure we are logged in to COMPS client.""" # load the work item client = Client() if logger.isEnabledFor(DEBUG): logger.debug(f"Logging into {os.environ['COMPS_SERVER']}") client.login(os.environ['COMPS_SERVER']) return client
[docs]def get_error_handler_dump_config_and_error(job_config): """ Define our exception handler for ssmt. This exception handler writes a "error_reason.json" file to the job that contains error info with additional data. Args: job_config: Job config used to execute items Returns: Error handler for ssmt """ def ssmt_error_handler(exctype, value: Exception, tb): with open("error_reason.json", 'w') as err_out: output_error = dict(type=exctype.__name__, args=list(value.args), tb=traceback.format_tb(tb), job_config=job_config) output_error['tb'] = [t.strip() for t in output_error['tb']] if hasattr(value, 'doc_link'): output_error['doc_link'] = value.doc_link json.dump(output_error, err_out, indent=4, sort_keys=True) idmtools_error_handler(exctype, value, tb) return ssmt_error_handler