Coverage for cedar/cli/config.py : 0%

""" CLI tools for working with cedar configuration files 

""" 

import json 

import logging 

import os 

from pathlib import Path 

import shutil 

import click 

from . import options 

@click.group('config', help='Create or check cedar configuration files') 

@click.pass_context 

def group_config(ctx): 

pass 

@group_config.command('template', short_help='Generate a config file template') 

@click.argument('dest', required=False, type=click.Path(dir_okay=False)) 

@click.option('--comment', is_flag=True, help='Comment out the template file') 

@click.pass_context 

def config_template(ctx, dest, comment): 

""" Generate a template configuration file 

""" 

from cedar.config import TEMPLATE_FILE 

with open(str(TEMPLATE_FILE)) as template: 

lines = list(template) 

if comment: 

lines = ['# ' + line if not line.startswith('#') else line 

for line in lines] 

if dest: 

dest = Path(dest) 

dest.parent.mkdir(parents=True, exist_ok=True) 

tmp = f'{dest}.tmp.{os.getpid()}' 

with open(tmp, 'w') as tmp_dst: 

tmp_dst.write(''.join(lines)) 

shutil.move(str(tmp), str(dest)) 

click.echo(f'Wrote template file to "{dest}"') 

else: 

for line in lines: 

click.echo(line, nl=False) 

@group_config.command('build', short_help='Interactively build a config file') 

@click.argument('dest', type=click.Path(dir_okay=False)) 

@click.pass_context 

def config_build(ctx, dest): 

click.echo('To do... maybe you?') 

raise click.Abort() 

@group_config.command('print', short_help='Parse and print config file') 

@click.argument('config_file', 

type=click.Path(dir_okay=False, resolve_path=True)) 

@click.pass_context 

def config_print(ctx, config_file): 

""" This program should help you check your config file is valid 

""" 

from jsonschema.exceptions import ValidationError 

from cedar.config import Config 

try: 

cfg = Config.from_yaml(config_file) 

except ValidationError as ve: 

click.echo(f'Configuration file failed to validate: "{ve.message}"') 

raise click.Abort() 

except Exception as e: 

click.echo(f'Could not parse configuration file "{config_file}":\n{e}') 

raise click.Abort() 

else: 

click.echo(cfg.to_yaml(indent=2))