Lift too strict restrictions on cross-deps role name

Allow a user to specify any arbitrary string
as role name for cross-deps that could be
a regexp or a TASK_ROLE_PATTERN string

Change-Id: I7124195fd9249acf13236751b7c59bcff2f42b2c
Closes-bug: #1557997

fuel_plugin_builder/errors.py

@@ -33,6 +33,10 @@ class ValidationError(FuelPluginException):
     pass
 
 
+class TaskFieldError(ValidationError):
+    pass
+
+
 class FileIsEmpty(ValidationError):
     def __init__(self, file_path):
         super(FileIsEmpty, self).__init__(

fuel_plugin_builder/tests/test_base_validator.py

@@ -13,7 +13,7 @@
 #    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 jsonschema
 import mock
 
 from fuel_plugin_builder import errors
@@ -37,6 +37,7 @@ class TestBaseValidator(BaseTestCase):
         self.validator = NewValidator(self.plugin_path)
         self.data = {'data': 'data1'}
         self.schema = self.make_schema(['data'], {'data': {'type': 'string'}})
+        self.format_checker = jsonschema.FormatChecker
 
     @classmethod
     def make_schema(cls, required, properties):
@@ -54,7 +55,7 @@ class TestBaseValidator(BaseTestCase):
             'file_path')
         schema_mock.validate.assert_called_once_with(
             self.data,
-            self.schema)
+            self.schema, format_checker=self.format_checker)
 
     def test_validate_schema_raises_error(self):
         schema = self.make_schema(['key'], {'key': {'type': 'string'}})

fuel_plugin_builder/tests/test_validator_v4.py

@@ -290,7 +290,7 @@ class TestValidatorV4(TestValidatorV3):
         mock_data = [{
             'id': 'plugin_task',
             'type': 'puppet',
-            'group': ['controller'],
+            'groups': ['controller'],
             'reexecute_on': ['bla']}]
         err_msg = "File '/tmp/plugin_path/deployment_tasks.yaml', " \
                   "'bla' is not one of"
@@ -333,7 +333,8 @@ class TestValidatorV4(TestValidatorV3):
         ]
 
         err_msg = "File '/tmp/plugin_path/deployment_tasks.yaml', " \
-                  "'role' is a required property, value path '0'"
+                  "'(role|groups|roles)' is " \
+                  "a required property, value path '0'"
         for task in deployment_tasks_data:
             self.check_raised_exception(
                 utils_mock, [task],
@@ -342,21 +343,89 @@ class TestValidatorV4(TestValidatorV3):
     # This is the section of tests inherited from the v3 validator
     # where decorators is re-defined for module v4
 
-    @mock.patch('fuel_plugin_builder.validators.validator_v4.utils')
-    def test_check_deployment_task_role(self, utils_mock, *args):
-        super(TestValidatorV4, self).test_check_deployment_task_role(
-            utils_mock)
-
     @mock.patch('fuel_plugin_builder.validators.validator_v4.utils')
     @mock.patch('fuel_plugin_builder.validators.base.utils.exists')
     def test_check_tasks_no_file(self, exists_mock, utils_mock, *args):
         super(TestValidatorV4, self).test_check_deployment_task_role(
             exists_mock, utils_mock)
 
+    @mock.patch('fuel_plugin_builder.validators.validator_v4.utils')
+    def test_check_deployment_task_role(self, utils_mock, *args):
+        utils_mock.parse_yaml.return_value = [
+            {'id': 'plugin_name', 'type': 'group', 'groups': ['a', 'b']},
+            {'id': 'plugin_name', 'type': 'group', 'groups': '*'},
+            {'id': 'plugin_name', 'type': 'puppet', 'role': ['a', 'b']},
+            {'id': 'plugin_name', 'type': 'puppet', 'role': '*'},
+            {'id': 'plugin_name', 'type': 'shell', 'roles': ['a', 'b']},
+            {'id': 'plugin_name', 'type': 'shell', 'roles': '*'},
+            {'id': 'plugin_name', 'type': 'skipped', 'role': '/test/'},
+            {'id': 'plugin_name', 'type': 'stage'},
+            {'id': 'plugin_name', 'type': 'reboot', 'groups': 'contrail'},
+            {
+                'id': 'plugin_name',
+                'type': 'copy_files',
+                'role': '*',
+                'parameters': {
+                    'files': [
+                        {'src': 'some_source', 'dst': 'some_destination'}]}
+            },
+            {
+                'id': 'plugin_name',
+                'type': 'sync',
+                'role': 'plugin_name',
+                'parameters': {
+                    'src': 'some_source', 'dst': 'some_destination'}
+            },
+            {
+                'id': 'plugin_name',
+                'type': 'upload_file',
+                'role': '/^.*plugin\w+name$/',
+                'parameters': {
+                    'path': 'some_path', 'data': 'some_data'}
+            },
+        ]
+
+        self.validator.check_deployment_tasks()
+
     @mock.patch('fuel_plugin_builder.validators.validator_v4.utils')
     def test_check_deployment_task_role_failed(self, utils_mock, *args):
-        super(TestValidatorV4, self).test_check_deployment_task_role_failed(
+        mock_data = [{
-            utils_mock)
+            'id': 'plugin_name',
+            'type': 'group',
+            'role': ['plugin_n@me']}]
+        err_msg = "field should"
+        self.check_raised_exception(
+            utils_mock, mock_data,
+            err_msg, self.validator.check_deployment_tasks)
+
+    @mock.patch('fuel_plugin_builder.validators.validator_v4.utils')
+    def test_check_deployment_task_required_missing(self, utils_mock, *args):
+        mock_data = [{
+            'id': 'plugin_name',
+            'type': 'puppet'}]
+        err_msg = "is a required property"
+        self.check_raised_exception(
+            utils_mock, mock_data,
+            err_msg, self.validator.check_deployment_tasks)
+
+    @mock.patch('fuel_plugin_builder.validators.validator_v4.utils')
+    def test_check_deployment_task_required_roles_missing_is_ok(
+            self, utils_mock, *args):
+        utils_mock.parse_yaml.return_value = [{
+            'id': 'plugin_name',
+            'type': 'stage'}]
+        self.validator.check_deployment_tasks()
+
+    @mock.patch('fuel_plugin_builder.validators.validator_v4.utils')
+    def test_check_deployment_task_role_regexp_failed(self, utils_mock, *args):
+        mock_data = [{
+            'id': 'plugin_name',
+            'type': 'group',
+            'role': '/[0-9]++/'}]
+        err_msg = "field should.*multiple repeat"
+        self.check_raised_exception(
+            utils_mock, mock_data,
+            err_msg, self.validator.check_deployment_tasks)
 
     @mock.patch('fuel_plugin_builder.validators.validator_v4.utils')
     def test_check_group_type_deployment_task_does_not_contain_manifests(

fuel_plugin_builder/validators/base.py

@@ -35,15 +35,16 @@ class BaseValidator(object):
     def basic_version(self):
         pass
 
-    def __init__(self, plugin_path):
+    def __init__(self, plugin_path, format_checker=jsonschema.FormatChecker):
         self.plugin_path = plugin_path
+        self.format_checker = format_checker
 
     def validate_schema(self, data, schema, file_path, value_path=None):
         logger.debug(
             'Start schema validation for %s file, %s', file_path, schema)
-
         try:
-            jsonschema.validate(data, schema)
+            jsonschema.validate(data, schema,
+                                format_checker=self.format_checker)
         except jsonschema.exceptions.ValidationError as exc:
             raise errors.ValidationError(
                 self._make_error_message(exc, file_path, value_path))
@@ -104,6 +105,7 @@ class BaseValidator(object):
     @abc.abstractmethod
     def validate(self):
         """Performs validation
+
         """
 
     def check_schemas(self):
@@ -169,9 +171,11 @@ class BaseValidator(object):
 
     def check_compatibility(self):
         """Json schema doesn't have any conditions, so we have
+
         to make sure here, that this validation schema can be used
         for described fuel releases
         """
+
         meta = utils.parse_yaml(self.meta_path)
         for fuel_release in meta['fuel_version']:
             if StrictVersion(fuel_release) < StrictVersion(self.basic_version):

fuel_plugin_builder/validators/formatchecker.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+
+#    Copyright 2016 Mirantis, 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 re
+from sre_constants import error as sre_error
+
+import jsonschema
+import six
+
+from fuel_plugin_builder import errors
+
+
+class FormatChecker(jsonschema.FormatChecker):
+
+    def __init__(self, role_patterns=(), *args, **kwargs):
+        super(FormatChecker, self).__init__()
+
+        @self.checks('fuel_task_role_format')
+        def _validate_role(instance):
+            sre_msg = None
+            if isinstance(instance, six.string_types):
+                if instance.startswith('/') and instance.endswith('/'):
+                    try:
+                        if re.compile(instance[1:-1]):
+                            return True
+                    except sre_error as e:
+                        sre_msg = str(e)
+                else:
+                    for role_pattern in role_patterns:
+                        if re.match(role_pattern, instance):
+                            return True
+                err_msg = "Role field should be either a valid " \
+                          "regexp enclosed by " \
+                          "slashes or a string of '{0}' or an " \
+                          "array of those. " \
+                          "Got '{1}' instead.".format(", ".join(role_patterns),
+                                                      instance)
+                if sre_msg:
+                    err_msg += "SRE error: \"{0}\"".format(sre_msg)
+                raise errors.TaskFieldError(err_msg)

fuel_plugin_builder/validators/schemas/v4.py

@@ -27,16 +27,23 @@ COMPATIBLE_COMPONENT_NAME_PATTERN = \
     '^({0}):([0-9a-z_-]+:)*([0-9a-z_-]+|(\*)?)$'.format(COMPONENTS_TYPES_STR)
 
 
-TASK_NAME_PATTERN = TASK_ROLE_PATTERN = '^[0-9a-zA-Z_-]+$'
+TASK_NAME_PATTERN = TASK_ROLE_PATTERN = '^[0-9a-zA-Z_-]+$|^\*$'
 NETWORK_ROLE_PATTERN = '^[0-9a-z_-]+$'
 FILE_PERMISSIONS_PATTERN = '^[0-7]{4}$'
 TASK_VERSION_PATTERN = '^\d+.\d+.\d+$'
 STAGE_PATTERN = '^(post_deployment|pre_deployment)' \
                 '(/[-+]?([0-9]*\.[0-9]+|[0-9]+))?$'
 
+DEFAULT_TASK_ROLE_GROUP_ASSIGNMENT = ('roles', 'groups', 'role')
+TASK_OBLIGATORY_FIELDS = ['id', 'type']
+
 
 class SchemaV4(SchemaV3):
 
+    def __init__(self):
+        super(SchemaV4, self).__init__()
+        self.role_pattern = TASK_ROLE_PATTERN
+
     @property
     def _task_relation(self):
         return {
@@ -58,13 +65,13 @@ class SchemaV4(SchemaV3):
             'oneOf': [
                 {
                     'type': 'string',
-                    'enum': ['*', 'master', 'self']
+                    'format': 'fuel_task_role_format'
                 },
                 {
                     'type': 'array',
                     'items': {
                         'type': 'string',
-                        'pattern': TASK_ROLE_PATTERN
+                        'format': 'fuel_task_role_format'
                     }
                 }
             ]
@@ -95,7 +102,9 @@ class SchemaV4(SchemaV3):
             }
         }
 
-    def _gen_task_schema(self, task_types, required=None, parameters=None):
+    def _gen_task_schema(self, task_types, required=None,
+                         parameters=None,
+                         required_any=DEFAULT_TASK_ROLE_GROUP_ASSIGNMENT):
         """Generate deployment task schema using prototype.
 
         :param task_types: task types
@@ -119,11 +128,21 @@ class SchemaV4(SchemaV3):
         }
         parameters.setdefault("properties", {})
         parameters["properties"].setdefault("strategy", self._task_strategy)
+        task_specific_req_fields = list(set(TASK_OBLIGATORY_FIELDS +
+                                            (required or [])))
+        required_fields = []
 
+        # Some tasks are ephemeral, so we can leave it as is without target
+        # groups|role|roles, others must have at least one such field
+        if required_any:
+            for group_name_alias in DEFAULT_TASK_ROLE_GROUP_ASSIGNMENT:
+                required_fields.append({"required": task_specific_req_fields
+                                        + [group_name_alias]})
+        else:
+            required_fields.append({"required": task_specific_req_fields})
         return {
             '$schema': 'http://json-schema.org/draft-04/schema#',
             'type': 'object',
-            'required': list(set(['id', 'type'] + (required or []))),
             'properties': {
                 'type': {'enum': task_types},
                 'id': {
@@ -132,6 +151,8 @@ class SchemaV4(SchemaV3):
                 'version': {
                     'type': 'string', "pattern": TASK_VERSION_PATTERN},
                 'role': self._task_role,
+                'groups': self._task_role,
+                'roles': self._task_role,
                 'required_for': self.task_group,
                 'requires': self.task_group,
                 'cross-depends': {
@@ -148,7 +169,8 @@ class SchemaV4(SchemaV3):
                         'pattern': TASK_ROLE_PATTERN}},
                 'reexecute_on': self._task_reexecute,
                 'parameters': parameters or {},
-            }
+            },
+            'anyOf': required_fields
         }
 
     @property
@@ -180,7 +202,7 @@ class SchemaV4(SchemaV3):
     def copy_files_task(self):
         return self._gen_task_schema(
             "copy_files",
-            ['role', 'parameters'],
+            ['parameters'],
             {
                 'type': 'object',
                 'required': ['files'],
@@ -203,7 +225,7 @@ class SchemaV4(SchemaV3):
 
     @property
     def group_task(self):
-        return self._gen_task_schema("group", ['role'])
+        return self._gen_task_schema("group", [])
 
     @property
     def puppet_task(self):
@@ -242,7 +264,7 @@ class SchemaV4(SchemaV3):
     def shell_task(self):
         return self._gen_task_schema(
             "shell",
-            ['role'],
+            [],
             {
                 'type': 'object',
                 'required': ['cmd'],
@@ -265,13 +287,13 @@ class SchemaV4(SchemaV3):
 
     @property
     def stage_task(self):
-        return self._gen_task_schema("stage")
+        return self._gen_task_schema("stage", required_any=())
 
     @property
     def sync_task(self):
         return self._gen_task_schema(
             "sync",
-            ['role', 'parameters'],
+            ['parameters'],
             {
                 'type': 'object',
                 'required': ['src', 'dst'],
@@ -287,7 +309,7 @@ class SchemaV4(SchemaV3):
     def upload_file_task(self):
         return self._gen_task_schema(
             "upload_file",
-            ['role', 'parameters'],
+            ['parameters'],
             {
                 'type': 'object',
                 'required': ['path', 'data'],

fuel_plugin_builder/validators/validator_v4.py

@@ -19,9 +19,11 @@ from os.path import join as join_path
 
 from fuel_plugin_builder import errors
 from fuel_plugin_builder import utils
+from fuel_plugin_builder.validators.formatchecker import FormatChecker
 from fuel_plugin_builder.validators.schemas import SchemaV4
 from fuel_plugin_builder.validators import ValidatorV3
 
+
 logger = logging.getLogger(__name__)
 
 
@@ -30,7 +32,8 @@ class ValidatorV4(ValidatorV3):
     schema = SchemaV4()
 
     def __init__(self, *args, **kwargs):
-        super(ValidatorV4, self).__init__(*args, **kwargs)
+        super(ValidatorV4, self).__init__(format_checker=FormatChecker(
+            role_patterns=[self.schema.role_pattern]), *args, **kwargs)
         self.components_path = join_path(self.plugin_path, 'components.yaml')
 
     @property