cli.py

import re
import json
import click
import logging

from .common import boto_client, list_instances
from .show_cluster import show_instances
from .create_cluster import create_cluster, extend_cluster
from .update_cluster import update_cluster
from .alarm import set_auto_recovery_alarm
from .remote_command import run_shell, run_nodetool, run_cqlsh


def configure_logging(level):
    logging.basicConfig(level=logging.WARN, format='%(asctime)s %(levelname)s: %(message)s')
    logging.getLogger("planb").setLevel(level)
    logging.getLogger('urllib3.connectionpool').setLevel(logging.WARN)
    logging.getLogger('requests.packages.urllib3.connectionpool').setLevel(logging.WARN)


def validate_cluster_name(ctx, param, value):
    #
    # NB: we use cluster_name as the password for generating
    # key/truststore, that requires it to be at least 6 chars long.
    #
    cluster_name_re = '^[a-z][a-z0-9-]{4,}[a-z0-9]$'
    if not re.match(cluster_name_re, value):
        raise click.BadParameter("has to match the regexp: {}".format(cluster_name_re))
    return value


def validate_dc_suffix(ctx, param, value):
    dc_suffix_re = '^[_a-z0-9-]*$'
    if not re.match(dc_suffix_re, value):
        raise click.BadParameter("has to match the regexp: {}".format(dc_suffix_re))
    return value


def is_valid_filter(f: dict) -> bool:
    return isinstance(f, dict) and \
           isinstance(f.get('Name'), str) and \
           isinstance(f.get('Values'), list)


def validate_filters(ctx, param, value):
    try:
        filters = json.loads(value)
    except Exception as e:
        raise click.BadParameter("JSON parsing error: {}".format(e))

    if not (isinstance(filters, list) and
            all(is_valid_filter(f) for f in filters)):
        raise click.BadParameter("has to match schema {}".format(filters_schema_doc))
    return filters


@click.group()
@click.option('--debug', is_flag=True, default=False)
def cli(debug: bool):
    configure_logging(logging.DEBUG if debug else logging.INFO)


filters_schema_doc = "[{\"Name\":\"string\",\"Values\":[\"string\",...]},...]"
filters_help = 'Additional AWS resource filters: {}'.format(filters_schema_doc)
sns_topic_help = 'SNS topic name to send Auto-Recovery notifications to'
sns_email_help = 'Email address to subscribe to Auto-Recovery SNS topic'


@cli.command()
@click.argument('regions', nargs=-1)
@click.option('--cluster-name', required=True, callback=validate_cluster_name, help='name of the cluster, required')
@click.option('--cluster-size', default=3, type=int, help='number of nodes per region, default: 3')
@click.option('--dc-suffix', default='', type=str, callback=validate_dc_suffix)
@click.option('--num-tokens', default=256, type=int, help='number of virtual nodes per node, default: 256')
@click.option('--instance-type', default='t2.medium', help='default: t2.medium')
@click.option('--volume-type', default='gp2', help='gp2 (default) | io1 | standard')
@click.option('--volume-size', default=16, type=int, help='in GB, default: 16')
@click.option('--volume-iops', default=100, type=int, help='for type io1, default: 100')
@click.option('--no-termination-protection', is_flag=True, default=False)
@click.option('--use-dmz', is_flag=True, default=False, help='deploy into DMZ subnets using Public IP addresses')
@click.option('--hosted-zone', help='create SRV records in this Hosted Zone')
@click.option('--scalyr-region')
@click.option('--scalyr-key')
@click.option('--rsyslog-format')
@click.option('--artifact-name', help='Pierone artifact name to use (default: planb-cassandra-3.0)')
@click.option('--docker-image', help='Docker image to use (default: latest planb-cassandra-3.0)')
@click.option('--environment', '-e', multiple=True)
@click.option('--sns-topic', help=sns_topic_help)
@click.option('--sns-email', help=sns_email_help)
def create(regions: list,
           cluster_name: str,
           cluster_size: int,
           dc_suffix: str,
           num_tokens: int,
           instance_type: str,
           volume_type: str,
           volume_size: int,
           volume_iops: int,
           no_termination_protection: bool,
           use_dmz: bool,
           hosted_zone: str,
           scalyr_region: str,
           scalyr_key: str,
           rsyslog_format: str,
           artifact_name: str,
           docker_image: str,
           environment: list,
           sns_topic: str,
           sns_email: str):

    if not regions:
        raise click.UsageError('Please specify at least one region')

    if len(regions) > 1 and not(use_dmz):
        raise click.UsageError('Multi-region deployment requires --use-dmz')

    create_cluster(options=locals())


@cli.command()
@click.option('--from-region', type=str, required=True)
@click.option('--to-region', type=str, required=True)
@click.option('--cluster-name', type=str, required=True)
@click.option('--ring-size', type=int, required=True)
@click.option('--dc-suffix', default='', type=str, callback=validate_dc_suffix)
@click.option('--num-tokens', default=256, type=int, help='number of virtual nodes per node, default: 256')
@click.option('--allocate-tokens-for-keyspace', type=str, help='allocate tokens for specified keyspace on non-seed nodes')
@click.option('--instance-type', default='t2.medium', help='default: t2.medium')
@click.option('--volume-type', default='gp2', help='gp2 (default) | io1 | standard')
@click.option('--volume-size', default=16, type=int, help='in GB, default: 16')
@click.option('--volume-iops', default=100, type=int, help='for type io1, default: 100')
@click.option('--no-termination-protection', is_flag=True, default=False)
@click.option('--use-dmz', is_flag=True, default=False, help='deploy into DMZ subnets using Public IP addresses')
@click.option('--hosted-zone', help='create SRV records in this Hosted Zone')
@click.option('--artifact-name', help='Pierone artifact name to use (default: planb-cassandra-3.0)')
@click.option('--docker-image', help='Docker image to use (default: latest planb-cassandra-3.0)')
@click.option('--environment', '-e', multiple=True)
@click.option('--sns-topic', help=sns_topic_help)
@click.option('--sns-email', help=sns_email_help)
def extend(from_region: str,
           to_region: str,
           cluster_name: str,
           ring_size: int,
           dc_suffix: str,
           num_tokens: int,
           allocate_tokens_for_keyspace: str,
           instance_type: str,
           volume_type: str,
           volume_size: int,
           volume_iops: int,
           no_termination_protection: bool,
           use_dmz: bool,
           hosted_zone: str,
           artifact_name: str,
           docker_image: str,
           environment: list,
           sns_topic: str,
           sns_email: str):

    if from_region != to_region and not(use_dmz):
        raise click.UsageError('Extending to a new region requires --use-dmz')

    extend_cluster(options=locals())


@cli.command()
@click.option('--region', type=str, required=True)
@click.option('--odd-host', '-O', type=str, required=True)
@click.option('--cluster-name', type=str, required=True)
@click.option('--filters', type=str, default="[]", callback=validate_filters,
              required=False, help=filters_help)
@click.option('--force-termination', is_flag=True, default=False)
@click.option('--no-prompt', is_flag=True, default=False)
@click.option('--docker-image', type=str)
@click.option('--taupage-ami-id', type=str)
@click.option('--instance-type', type=str)
@click.option('--scalyr-region')
@click.option('--scalyr-key')
@click.option('--rsyslog-format')
@click.option('--environment', '-e', multiple=True)
@click.option('--sns-topic', help=sns_topic_help)
@click.option('--sns-email', help=sns_email_help)
def update(region: str,
           odd_host: str,
           cluster_name: str,
           filters: list,
           force_termination: bool,
           no_prompt: bool,
           docker_image: str,
           taupage_ami_id: str,
           instance_type: str,
           scalyr_region: str,
           scalyr_key: str,
           rsyslog_format: str,
           environment: list,
           sns_topic: str,
           sns_email: str):

    update_cluster(options=locals())


@cli.command()
@click.option('--region', type=str, required=True)
@click.option('--instance-id', type=str, required=True)
@click.option('--sns-topic', help=sns_topic_help)
@click.option('--sns-email', help=sns_email_help)
def setalarm(region: str,
             instance_id: str,
             sns_topic: str,
             sns_email: str):

    set_auto_recovery_alarm(options=locals())


@cli.command()
@click.option('--region', type=str, required=True)
@click.option('--cluster-name', type=str, required=True)
@click.option('--filters', type=str, default="[]", callback=validate_filters,
              required=False, help=filters_help)
def nodes(region: str, cluster_name: str, filters: list):
    # TODO: we should extend it to list of regions
    # TODO: we could derive the regions a cluster is deployed to from SRV DNS record
    ec2 = boto_client('ec2', region)
    instances = list_instances(ec2, cluster_name, filters)
    show_instances(instances)


@cli.group()
@click.option('--region', type=str, required=True)
@click.option('--odd-host', '-O', type=str, required=True)
@click.option('--piu', type=str, required=True, help="Run piu first with this parameter as reason.")
@click.option('--cluster-name', type=str, required=True)
@click.option('--filters', type=str, default="[]", callback=validate_filters,
              required=False, help=filters_help)
@click.option('--echo', is_flag=True, help="Print the ssh command before running it.")
@click.option('--no-prompt', is_flag=True, help="Don't prompt before running the ssh command.")
@click.option('--no-wait', is_flag=True, help="Don't wait for the ssh command to exit.")
@click.option('--ip-label', is_flag=True, help="Label all output from the node with its IP address.")
@click.pass_context
def remote(ctx: object, **kwargs):
    ctx.obj = kwargs


@remote.command(help='Run shell command on Cassandra nodes.')
@click.argument('command', nargs=-1)
@click.pass_context
def shell(ctx: object, command: list):
    run_shell(**dict(ctx.obj, command=command))


@remote.command(help='Run nodetool command on Cassandra nodes.')
@click.argument('command', nargs=-1)
@click.pass_context
def nodetool(ctx: object, command: list):
    run_nodetool(**dict(ctx.obj, command=command))


@remote.command(help='Run admin cqlsh command on Cassandra nodes.')
@click.argument('command', nargs=-1)
@click.pass_context
def cqlsh(ctx: object, command: list):
    run_cqlsh(**dict(ctx.obj, command=command))