Merge 01d5e4a into 4351a0a

paasta_tools/cli/cmds/check.py

@@ -21,6 +21,7 @@
 
 from paasta_tools.marathon_tools import get_all_namespaces_for_service
 from paasta_tools.monitoring_tools import get_team
+from paasta_tools.cli.utils import get_file_contents
 from paasta_tools.cli.utils import guess_service_name
 from paasta_tools.cli.utils import is_file_in_dir
 from paasta_tools.cli.utils import NoSuchService
@@ -109,10 +110,6 @@ def makefile_responds_to(target):
     return returncode in [0, 1]
 
 
-def get_file_contents(path):
-    return open(path).read()
-
-
 def makefile_has_a_tab(makefile_path):
     contents = get_file_contents(makefile_path)
     return '\t' in contents

paasta_tools/cli/cmds/validate.py

@@ -0,0 +1,165 @@
+#!/usr/bin/env python
+# Copyright 2015 Yelp Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import json
+import os
+import pkgutil
+import yaml
+
+from glob import glob
+from jsonschema import Draft4Validator
+from jsonschema import FormatChecker
+from jsonschema import ValidationError
+from paasta_tools.cli.utils import failure
+from paasta_tools.cli.utils import get_file_contents
+from paasta_tools.cli.utils import lazy_choices_completer
+from paasta_tools.cli.utils import list_services
+from paasta_tools.cli.utils import PaastaColors
+from paasta_tools.cli.utils import success
+
+
+SCHEMA_VALID = success("Successfully validated schema")
+
+SCHEMA_INVALID = failure(
+    "Failed to validate schema. More info:",
+    "http://paasta.readthedocs.org/en/latest/yelpsoa_configs.html")
+
+SCHEMA_NOT_FOUND = failure(
+    "Failed to find schema to validate against. More info:",
+    "http://paasta.readthedocs.org/en/latest/yelpsoa_configs.html")
+
+FAILED_READING_FILE = failure(
+    "Failed to read file. More info:",
+    "http://paasta.readthedocs.org/en/latest/yelpsoa_configs.html")
+
+UNKNOWN_SERVICE = "Unable to determine service to validate.\n" \
+                  "Please supply the %s name you wish to " \
+                  "validate with the %s option." \
+                  % (PaastaColors.cyan('SERVICE'), PaastaColors.cyan('-s'))
+
+
+def get_schema(file_type):
+    """Get the correct schema to use for validation
+
+    :param file_type: what schema type should we validate against
+    """
+    schema_path = 'schemas/%s_schema.json' % file_type
+    try:
+        schema = pkgutil.get_data('paasta_tools.cli', schema_path)
+    except IOError:
+        return None
+    return json.loads(schema)
+
+
+def validate_schema(file_path, file_type):
+    """Check if the specified config file has a valid schema
+
+    :param file_path: path to file to validate
+    :param file_type: what schema type should we validate against
+    """
+    schema = get_schema(file_type)
+    if (schema is None):
+        print '%s: %s' % (SCHEMA_NOT_FOUND, file_path)
+        return
+    validator = Draft4Validator(schema, format_checker=FormatChecker())
+    basename = os.path.basename(file_path)
+    extension = os.path.splitext(basename)[1]
+    try:
+        config_file = get_file_contents(file_path)
+    except IOError:
+        print '%s: %s' % (FAILED_READING_FILE, file_path)
+        return
+    if extension == '.yaml':
+        config_file_object = yaml.load(config_file)
+    elif extension == '.json':
+        config_file_object = json.loads(config_file)
+    else:
+        config_file_object = config_file
+    try:
+        validator.validate(config_file_object)
+    except ValidationError as e:
+        print '%s: %s' % (SCHEMA_INVALID, file_path)
+        print '  Validation Message: %s' % e.message
+    else:
+        print '%s: %s' % (SCHEMA_VALID, file_path)
+
+
+def validate_all_schemas(service_path):
+    """Finds all recognized config files in service directory,
+    and validates their schema.
+
+    :param service_path: path to location of configuration files
+    """
+
+    path = os.path.join(service_path, '*.yaml')
+
+    for file_name in glob(path):
+        if os.path.islink(file_name):
+            continue
+        basename = os.path.basename(file_name)
+        for file_type in ['chronos', 'marathon']:
+            if basename.startswith(file_type):
+                validate_schema(file_name, file_type)
+
+
+def add_subparser(subparsers):
+    validate_parser = subparsers.add_parser(
+        'validate',
+        description="Execute 'paasta validate' from service repo root",
+        help="Validate that all paasta config files in pwd are correct")
+    validate_parser.add_argument(
+        '-s', '--service',
+        required=False,
+        help="Service that you want to validate. Like 'example_service'.",
+    ).completer = lazy_choices_completer(list_services)
+    validate_parser.add_argument(
+        '-y', '--yelpsoa-config-root',
+        dest='yelpsoa_config_root',
+        default=os.getcwd(),
+        required=False,
+        help="Path to root of yelpsoa-configs checkout",
+    )
+    validate_parser.set_defaults(command=paasta_validate)
+
+
+def get_service_path(service, soa_dir):
+    """Determine the path of the directory containing the conf files
+
+    :param args: argparse.Namespace obj created from sys.args by cli
+    """
+    if service:
+        return os.path.join(soa_dir, service)
+    else:
+        if soa_dir == os.getcwd():
+            return os.getcwd()
+        else:
+            print UNKNOWN_SERVICE
+            return None
+
+
+def paasta_validate(args):
+    """Analyze the service in the PWD to determine if conf files are all valid
+
+    :param args: argparse.Namespace obj created from sys.args by cli
+    """
+
+    service = args.service
+    soa_dir = args.yelpsoa_config_root
+    service_path = get_service_path(service, soa_dir)
+
+    if service_path is None:
+        return 1
+
+    validate_all_schemas(service_path)

paasta_tools/cli/schemas/chronos_schema.json

@@ -0,0 +1,11 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "http://paasta.readthedocs.org/en/latest/yelpsoa_configs.html#chronos-clustername-yaml",
+    "type": "object",
+    "minProperties": 1,
+    "additionalProperties": {
+        "type": "object",
+        "properties": {},
+        "additionalProperties": true
+    }
+}

paasta_tools/cli/schemas/marathon_schema.json

@@ -0,0 +1,11 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "description": "http://paasta.readthedocs.org/en/latest/yelpsoa_configs.html#marathon-clustername-yaml",
+    "type": "object",
+    "minProperties": 1,
+    "additionalProperties": {
+        "type": "object",
+        "properties": {},
+        "additionalProperties": true
+    }
+}

paasta_tools/cli/utils.py

@@ -75,6 +75,15 @@ def is_file_in_dir(file_name, path):
     return False
 
 
+def get_file_contents(path):
+    """Open a file for reading
+
+    :param path: path of file to read
+    """
+    with open(path) as p:
+        return p.read()
+
+
 def check_mark():
     """
     :return: string that can print a checkmark

requirements.txt

@@ -15,6 +15,7 @@ httplib2==0.9
 humanize==0.5.1
 importlib==1.0.3
 isodate==0.5.1
+jsonschema==2.5.1
 kazoo==2.2
 lockfile==0.9.1
 marathon==0.7.4