Merge pull request #327 from zalando-stups/sentry

Sentry

Author: jmcs

requirements.txt

@@ -6,4 +6,5 @@ stups-pierone>=1.0.34
 boto3>=1.3.0
 botocore>=1.4.10
 pytest>=2.7.3
+raven
 typing

senza/arguments.py

@@ -1,6 +1,7 @@
-import click
 import re
 
+import click
+
 from .error_handling import HandleExceptions
 
 REGION_PATTERN = re.compile(r'^[a-z]{2}-[a-z]+-[0-9]$')
@@ -54,3 +55,4 @@ def set_stacktrace_visible(ctx, param, value):
                                    type=click.IntRange(1, 300),
                                    metavar='SECS',
                                    help='Auto update the screen every X seconds')
+GLOBAL_OPTIONS = {}

senza/cli.py

@@ -18,14 +18,13 @@
 import boto3
 import click
 import requests
-import senza
 import yaml
 from botocore.exceptions import ClientError
-from clickclick import (Action, AliasedGroup, FloatRange, OutputFormat, choice,
-                        error, fatal_error, info, ok)
+from clickclick import (Action, FloatRange, OutputFormat, choice, error,
+                        fatal_error, info, ok)
 from clickclick.console import print_table
 
-from .arguments import (json_output_option, output_option,
+from .arguments import (GLOBAL_OPTIONS, json_output_option, output_option,
                         parameter_file_option, region_option,
                         stacktrace_visible_option, watch_option,
                         watchrefresh_option)
@@ -43,15 +42,15 @@
 from .patch import patch_auto_scaling_group
 from .respawn import get_auto_scaling_group, respawn_auto_scaling_group
 from .stups.piu import Piu
+from .subcommands.config import cmd_config
+from .subcommands.root import cli
 from .templates import get_template_description, get_templates
 from .templates._helper import get_mint_bucket_name
 from .traffic import (change_version_traffic, get_records,
                       print_version_traffic, resolve_to_ip_addresses)
 from .utils import (camel_case_to_underscore, ensure_keys, named_value,
                     pystache_render)
 
-CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
-
 STYLES = {
     'RUNNING': {'fg': 'green'},
     'TERMINATED': {'fg': 'red'},
@@ -117,8 +116,6 @@
     'ResourceStatusReason': 50
 }
 
-GLOBAL_OPTIONS = {}
-
 
 def print_json(data, output=None):
     if output == 'yaml':
@@ -205,13 +202,6 @@ def watching(w: bool, watch: int):
 }
 
 
-def print_version(ctx, param, value):
-    if not value or ctx.resilient_parsing:
-        return
-    click.echo('Senza {}'.format(senza.__version__))
-    ctx.exit()
-
-
 def evaluate(definition, args, account_info, force: bool):
     # extract Senza* meta information
     info = definition.pop("SenzaInfo")
@@ -255,14 +245,6 @@ def evaluate(definition, args, account_info, force: bool):
     return definition
 
 
-@click.group(cls=AliasedGroup, context_settings=CONTEXT_SETTINGS)
-@click.option('-V', '--version', is_flag=True, callback=print_version, expose_value=False, is_eager=True,
-              help='Print the current version number and exit.')
-@region_option
-def cli(region):
-    GLOBAL_OPTIONS['region'] = region
-
-
 class TemplateArguments:
     def __init__(self, **kwargs):
         for key, val in kwargs.items():
@@ -1634,6 +1616,8 @@ def wait(stack_ref, region, deletion, timeout, interval):
             return
     raise click.Abort()
 
+cli.add_command(cmd_config)
+
 
 def main():
     HandleExceptions(cli)()

senza/configuration.py

@@ -0,0 +1,81 @@
+from collections.abc import MutableMapping
+from pathlib import Path
+from typing import Dict, Tuple
+
+import yaml
+from click import get_app_dir
+
+from .exceptions import InvalidConfigKey
+
+
+class Configuration(MutableMapping):
+
+    def __init__(self, path: Path):
+        self.config_path = path
+
+    def __iter__(self):
+        yield from self.raw_dict
+
+    def __len__(self):
+        return len(self.raw_dict)
+
+    def __getitem__(self, key: str) -> str:
+        section, sub_key = self.__split_key(key)
+        return self.raw_dict[section][sub_key]
+
+    def __setitem__(self, key: str, value):
+        section, sub_key = self.__split_key(key)
+        configuration = self.raw_dict
+
+        if section not in configuration:
+            configuration[section] = {}
+        configuration[section][sub_key] = str(value)
+        self.__save(configuration)
+
+    def __delitem__(self, key):
+        section, sub_key = self.__split_key(key)
+        cfg = self.raw_dict
+        del cfg[section][sub_key]
+        self.__save(cfg)
+
+    @staticmethod
+    def __split_key(key: str) -> Tuple[str, str]:
+        """
+        Splits the full key in section and subkey
+        """
+        try:
+            section, sub_key = key.split('.', 1)
+        except ValueError:
+            # error message inspired by git config
+            raise InvalidConfigKey('key does not contain '
+                                   'a section: {}'.format(key))
+        return section, sub_key
+
+    def __save(self, cfg):
+        """
+        Saves the configuration in the configuration path, creating the
+        directory if necessary.
+        """
+        try:
+            self.config_path.parent.mkdir(parents=True)
+        except FileExistsError:
+            # this try...except can be replaced with exist_ok=True when
+            # we drop python3.4 support
+            pass
+        with self.config_path.open('w+') as config_file:
+            yaml.safe_dump(cfg, config_file,
+                           default_flow_style=False)
+
+    @property
+    def raw_dict(self) -> Dict[str, Dict[str, str]]:
+        """
+        Returns a dict with the configuration data as stored in config.yaml
+        """
+        try:
+            with self.config_path.open() as config_file:
+                cfg = yaml.safe_load(config_file)
+        except FileNotFoundError:
+            cfg = {}
+        return cfg
+
+configuration = Configuration(Path(get_app_dir('senza')) / "config.yaml")

senza/error_handling.py

@@ -1,13 +1,16 @@
-from typing import Dict, Any  # noqa: F401
 import sys
 from tempfile import NamedTemporaryFile
 from traceback import format_exception
+from typing import Any, Dict, Optional  # noqa: F401
 
+import senza
 import yaml.constructor
 from botocore.exceptions import ClientError, NoCredentialsError
 from clickclick import fatal_error
+from raven import Client
 
-from .exceptions import PiuNotFound, InvalidDefinition
+from .configuration import configuration
+from .exceptions import InvalidDefinition, PiuNotFound
 from .manaus.exceptions import (ELBNotFound, HostedZoneNotFound, InvalidState,
                                 RecordNotFound)
 
@@ -59,12 +62,20 @@ def __init__(self, function):
         self.function = function
 
     def die_unknown_error(self, e: Exception):
-        if not self.stacktrace_visible:
+        if sentry:
+            # The exception should always be sent to sentry if sentry is
+            # configured
+            sentry.captureException()
+        if self.stacktrace_visible:
+            raise e
+        elif sentry:
+            die_fatal_error("Unknown Error: {e}.\n"
+                            "This error will be pushed to sentry ".format(e=e))
+        elif not sentry:
             file_name = store_exception(e)
             die_fatal_error('Unknown Error: {e}.\n'
                             'Please create an issue with the '
                             'content of {fn}'.format(e=e, fn=file_name))
-        raise e
 
     def __call__(self, *args, **kwargs):
         try:
@@ -108,3 +119,19 @@ def __call__(self, *args, **kwargs):
         except Exception as e:
             # Catch All
             self.die_unknown_error(e)
+
+
+def setup_sentry(sentry_endpoint: Optional[str]):
+    """
+    This function setups sentry, this exists mostly to make sentry integration
+    easier to test
+    """
+    if sentry_endpoint is not None:
+        sentry = Client(sentry_endpoint,
+                        release=senza.__version__)
+    else:
+        sentry = None
+
+    return sentry
+
+sentry = setup_sentry(configuration.get('sentry.endpoint'))

senza/exceptions.py

@@ -20,6 +20,15 @@ def __init__(self):
         super().__init__('Command not found: piu')
 
 
+class InvalidConfigKey(SenzaException, ValueError):
+    """
+    Error raised when trying to use an Invalid Config Key
+    """
+
+    def __init__(self, message: str):
+        super().__init__(message)
+
+
 class InvalidDefinition(SenzaException):
     """
     Exception raised when trying to parse and invalid senza definition

senza/subcommands/__init__.py

@@ -0,0 +1,29 @@
+from typing import Optional
+
+from click import argument, command
+from click.exceptions import BadArgumentUsage
+
+from ..configuration import configuration
+from ..exceptions import InvalidConfigKey
+
+
+@command('config')
+@argument('key')
+@argument('value', required=False)
+def cmd_config(key: str, value: Optional[str]):
+    """
+    Get and set senza options.
+    """
+    if value is None:
+        try:
+            value = configuration[key]
+            print(value)
+        except InvalidConfigKey as e:
+            raise BadArgumentUsage(e)
+        except KeyError:
+            exit(1)
+    else:
+        try:
+            configuration[key] = value
+        except InvalidConfigKey as e:
+            raise BadArgumentUsage(e)

senza/subcommands/config.py

@@ -0,0 +1,22 @@
+import click
+import senza
+from clickclick import AliasedGroup
+
+from ..arguments import GLOBAL_OPTIONS, region_option
+
+CONTEXT_SETTINGS = dict(help_option_names=['-h', '--help'])
+
+
+def print_version(ctx, param, value):
+    if not value or ctx.resilient_parsing:
+        return
+    click.echo('Senza {}'.format(senza.__version__))
+    ctx.exit()
+
+
+@click.group(cls=AliasedGroup, context_settings=CONTEXT_SETTINGS)
+@click.option('-V', '--version', is_flag=True, callback=print_version, expose_value=False, is_eager=True,
+              help='Print the current version number and exit.')
+@region_option
+def cli(region):
+    GLOBAL_OPTIONS['region'] = region

senza/subcommands/root.py

@@ -130,7 +130,7 @@ def setup_package():
         install_requires=install_reqs,
         setup_requires=['flake8'],
         cmdclass=cmdclass,
-        tests_require=['pytest-cov', 'pytest'],
+        tests_require=['pytest-cov', 'pytest', 'mock'],
         command_options=command_options,
         entry_points={'console_scripts': CONSOLE_SCRIPTS,
                       'senza.templates': ['bgapp = senza.templates.bgapp',