def test_scheme_validation_playbook(self, path, scheme, answer, error,
mocker):
mocker.patch.object(StructureValidator,
'scheme_of_file_by_path',
return_value=scheme)
validator = StructureValidator(file_path=path)
assert validator.is_valid_scheme() is answer, error
def test_is_valid_file_path(self, path, answer, mocker):
mocker.patch.object(StructureValidator,
"load_data_from_file",
return_value=None)
structure = StructureValidator(path)
structure.scheme_name = None
assert structure.is_valid_file_path() is answer
def test_is_file_valid(self, source, target, answer):
try:
copyfile(source, target)
structure = StructureValidator(target)
assert structure.is_valid_file() is answer
finally:
os.remove(target)
def validate_all_files(self):
"""Validate all files in the repo are in the right format."""
# go over packs
for root, dirs, _ in os.walk(PACKS_DIR):
for dir_in_dirs in dirs:
for directory in PACKS_DIRECTORIES:
for inner_root, inner_dirs, files in os.walk(
os.path.join(root, dir_in_dirs, directory)):
for inner_dir in inner_dirs:
if inner_dir.startswith('.'):
continue
project_dir = os.path.join(inner_root, inner_dir)
_, file_path = get_yml_paths_in_dir(
os.path.normpath(project_dir),
Errors.no_yml_file(project_dir))
if file_path:
print("Validating {}".format(file_path))
structure_validator = StructureValidator(
file_path)
if not structure_validator.is_valid_scheme():
self._is_valid = False
# go over regular content entities
for directory in DIR_LIST_FOR_REGULAR_ENTETIES:
print_color('Validating {} directory:'.format(directory),
LOG_COLORS.GREEN)
for root, dirs, files in os.walk(directory):
for file_name in files:
file_path = os.path.join(root, file_name)
# skipping hidden files
if not file_name.endswith('.yml'):
continue
print('Validating ' + file_name)
structure_validator = StructureValidator(file_path)
if not structure_validator.is_valid_scheme():
self._is_valid = False
# go over regular PACKAGE_SUPPORTING_DIRECTORIES entities
for directory in PACKAGE_SUPPORTING_DIRECTORIES:
for root, dirs, files in os.walk(directory):
for inner_dir in dirs:
if inner_dir.startswith('.'):
continue
project_dir = os.path.join(root, inner_dir)
_, file_path = get_yml_paths_in_dir(
project_dir, Errors.no_yml_file(project_dir))
if file_path:
print('Validating ' + file_path)
structure_validator = StructureValidator(file_path)
if not structure_validator.is_valid_scheme():
self._is_valid = False
def initiate_file_validator(self, validator_type, scheme_type):
print_color('Starting validating files structure', LOG_COLORS.GREEN)
structure = StructureValidator(file_path=str(self.output_file_name),
predefined_scheme=scheme_type)
validator = validator_type(structure)
if structure.is_valid_file() and validator.is_valid_file(
validate_rn=False):
print_color('The files are valid', LOG_COLORS.GREEN)
return 0
else:
print_color('The files are invalid', LOG_COLORS.RED)
return 1
def test_is_file_valid(self, source, target, answer, validator):
# type: (str, str, Any, Type[BaseValidator]) -> None
try:
copyfile(source, target)
structure = StructureValidator(source)
validator = validator(structure)
assert validator.is_valid_file(validate_rn=False) is answer
finally:
os.remove(target)
def test_is_id_equals_name(self, source, target, answer, validator):
# type: (str, str, Any, Type[BaseValidator]) -> None
try:
copyfile(str(source), target)
structure = StructureValidator(str(source))
validator = validator(structure)
assert validator.is_id_equals_name() is answer
finally:
os.remove(target)
def mock_structure(file_path=None, current_file=None, old_file=None):
# type: (Optional[str], Optional[dict], Optional[dict]) -> StructureValidator
with patch.object(StructureValidator, '__init__', lambda a, b: None):
structure = StructureValidator(file_path)
structure.is_valid = True
structure.scheme_name = 'integration'
structure.file_path = file_path
structure.current_file = current_file
structure.old_file = old_file
return structure
def test_is_valid_name_sanity(self, current_file, answer):
with patch.object(StructureValidator, '__init__', lambda a, b: None):
structure = StructureValidator("")
structure.current_file = current_file
structure.old_file = None
structure.file_path = "random_path"
structure.is_valid = True
validator = IncidentFieldValidator(structure)
validator.current_file = current_file
assert validator.is_valid_name() is answer
assert validator.is_valid_file() is answer
def get_validator(current_file=None, old_file=None, file_path=""):
with patch.object(StructureValidator, '__init__', lambda a, b: None):
structure = StructureValidator("")
structure.current_file = current_file
structure.old_file = old_file
structure.file_path = file_path
structure.is_valid = True
validator = ScriptValidator(structure)
validator.old_script = old_file
validator.current_script = current_file
return validator
def test_scheme_validation_indicatorfield(self, path, scheme, answer,
mocker):
validator = StructureValidator(file_path=path,
predefined_scheme='incidentfield')
assert validator.is_valid_scheme() is answer
def test_fromversion_update_validation_yml_structure(
self, path, old_file_path, answer):
validator = StructureValidator(file_path=path)
with open(old_file_path) as f:
validator.old_file = yaml.safe_load(f)
assert validator.is_valid_fromversion_on_modified() is answer
def validate_modified_files(self, modified_files): # noqa: C901
"""Validate the modified files from your branch.
In case we encounter an invalid file we set the self._is_valid param to False.
Args:
modified_files (set): A set of the modified files in the current branch.
"""
for file_path in modified_files:
old_file_path = None
if isinstance(file_path, tuple):
old_file_path, file_path = file_path
print('Validating {}'.format(file_path))
if not checked_type(file_path):
print_warning(
'- Skipping validation of non-content entity file.')
continue
if re.match(TEST_PLAYBOOK_REGEX, file_path, re.IGNORECASE):
continue
structure_validator = StructureValidator(file_path, old_file_path)
if not structure_validator.is_valid_file():
self._is_valid = False
if self.validate_id_set:
if not self.id_set_validator.is_file_valid_in_set(file_path):
self._is_valid = False
elif checked_type(file_path, YML_INTEGRATION_REGEXES):
image_validator = ImageValidator(file_path)
if not image_validator.is_valid():
self._is_valid = False
description_validator = DescriptionValidator(file_path)
if not description_validator.is_valid():
self._is_valid = False
integration_validator = IntegrationValidator(
structure_validator)
if self.is_backward_check and not integration_validator.is_backward_compatible(
):
self._is_valid = False
if not integration_validator.is_valid_file():
self._is_valid = False
elif checked_type(file_path, YML_BETA_INTEGRATIONS_REGEXES):
image_validator = ImageValidator(file_path)
if not image_validator.is_valid():
self._is_valid = False
description_validator = DescriptionValidator(file_path)
if not description_validator.is_valid_beta_description():
self._is_valid = False
integration_validator = IntegrationValidator(
structure_validator)
if not integration_validator.is_valid_beta_integration():
self._is_valid = False
elif checked_type(file_path, [SCRIPT_REGEX]):
script_validator = ScriptValidator(structure_validator)
if self.is_backward_check and not script_validator.is_backward_compatible(
):
self._is_valid = False
if not script_validator.is_valid_file():
self._is_valid = False
elif checked_type(file_path, PLAYBOOKS_REGEXES_LIST):
playbook_validator = PlaybookValidator(structure_validator)
if not playbook_validator.is_valid_playbook(
is_new_playbook=False):
self._is_valid = False
elif checked_type(file_path, PACKAGE_SCRIPTS_REGEXES):
unifier = Unifier(os.path.dirname(file_path))
yml_path, _ = unifier.get_script_package_data()
# Set file path to the yml file
structure_validator.file_path = yml_path
script_validator = ScriptValidator(structure_validator)
if self.is_backward_check and not script_validator.is_backward_compatible(
):
self._is_valid = False
if not script_validator.is_valid_file():
self._is_valid = False
elif re.match(IMAGE_REGEX, file_path, re.IGNORECASE):
image_validator = ImageValidator(file_path)
if not image_validator.is_valid():
self._is_valid = False
# incident fields and indicator fields are using the same scheme.
elif checked_type(file_path, JSON_INDICATOR_AND_INCIDENT_FIELDS):
incident_field_validator = IncidentFieldValidator(
structure_validator)
if not incident_field_validator.is_valid_file():
self._is_valid = False
if self.is_backward_check and not incident_field_validator.is_backward_compatible(
):
self._is_valid = False
elif checked_type(file_path, JSON_ALL_LAYOUT_REGEXES):
layout_validator = LayoutValidator(structure_validator)
if not layout_validator.is_valid_layout():
self._is_valid = False
elif 'CHANGELOG' in file_path:
self.is_valid_release_notes(file_path)
else:
print_error(
"The file type of {} is not supported in validate command".
format(file_path))
print_error(
"'validate' command supports: Integrations, Scripts, Playbooks, "
"Incident fields, Indicator fields, Images, Release notes, Layouts and Descriptions"
)
self._is_valid = False
def validate_added_files(self, added_files): # noqa: C901
"""Validate the added files from your branch.
In case we encounter an invalid file we set the self._is_valid param to False.
Args:
added_files (set): A set of the modified files in the current branch.
"""
for file_path in added_files:
print('Validating {}'.format(file_path))
if re.match(TEST_PLAYBOOK_REGEX, file_path, re.IGNORECASE):
continue
structure_validator = StructureValidator(file_path)
if not structure_validator.is_valid_file():
self._is_valid = False
if self.validate_id_set:
if not self.id_set_validator.is_file_valid_in_set(file_path):
self._is_valid = False
if self.id_set_validator.is_file_has_used_id(file_path):
self._is_valid = False
elif re.match(PLAYBOOK_REGEX, file_path, re.IGNORECASE):
playbook_validator = PlaybookValidator(structure_validator)
if not playbook_validator.is_valid_playbook():
self._is_valid = False
elif checked_type(file_path, YML_INTEGRATION_REGEXES):
image_validator = ImageValidator(file_path)
if not image_validator.is_valid():
self._is_valid = False
description_validator = DescriptionValidator(file_path)
if not description_validator.is_valid():
self._is_valid = False
integration_validator = IntegrationValidator(
structure_validator)
if not integration_validator.is_valid_file(validate_rn=False):
self._is_valid = False
elif checked_type(file_path, PACKAGE_SCRIPTS_REGEXES):
unifier = Unifier(os.path.dirname(file_path))
yml_path, _ = unifier.get_script_package_data()
# Set file path to the yml file
structure_validator.file_path = yml_path
script_validator = ScriptValidator(structure_validator)
if not script_validator.is_valid_file(validate_rn=False):
self._is_valid = False
elif re.match(BETA_INTEGRATION_REGEX, file_path, re.IGNORECASE) or \
re.match(BETA_INTEGRATION_YML_REGEX, file_path, re.IGNORECASE):
description_validator = DescriptionValidator(file_path)
if not description_validator.is_valid_beta_description():
self._is_valid = False
integration_validator = IntegrationValidator(
structure_validator)
if not integration_validator.is_valid_beta_integration():
self._is_valid = False
elif re.match(IMAGE_REGEX, file_path, re.IGNORECASE):
image_validator = ImageValidator(file_path)
if not image_validator.is_valid():
self._is_valid = False
# incident fields and indicator fields are using the same scheme.
elif checked_type(file_path, JSON_INDICATOR_AND_INCIDENT_FIELDS):
incident_field_validator = IncidentFieldValidator(
structure_validator)
if not incident_field_validator.is_valid_file():
self._is_valid = False
elif checked_type(file_path, JSON_ALL_LAYOUT_REGEXES):
layout_validator = LayoutValidator(structure_validator)
if not layout_validator.is_valid_layout():
self._is_valid = False
elif 'CHANGELOG' in file_path:
self.is_valid_release_notes(file_path)
elif checked_type(file_path, [REPUTATION_REGEX]):
print_color(
F'Skipping validation for file {file_path} since no validation is currently defined.',
LOG_COLORS.YELLOW)
elif checked_type(file_path, CHECKED_TYPES_REGEXES):
pass
else:
print_error(
"The file type of {} is not supported in validate command".
format(file_path))
print_error(
"validate command supports: Integrations, Scripts, Playbooks, "
"Incident fields, Indicator fields, Images, Release notes, Layouts and Descriptions"
)
self._is_valid = False
def test_is_valid_version_locked_paths(self, source, answer, validator):
"""Tests locked path (as reputations.json) so we won't override the file"""
structure = StructureValidator(source)
validator = validator(structure)
assert validator.is_valid_version() is answer
def test_integration_file_with_valid_id(self, path, answer, error):
validator = StructureValidator(file_path=path)
assert validator.is_file_id_without_slashes() is answer, error
def test_is_id_modified(self, current_file, old_file, answer, error):
validator = StructureValidator(file_path=current_file)
with open(old_file) as f:
validator.old_file = yaml.safe_load(f)
assert validator.is_id_modified() is answer, error