def __init__(self,
is_backward_check=True,
prev_ver='origin/master',
use_git=False,
is_circle=False,
print_ignored_files=False,
validate_conf_json=True,
validate_id_set=False,
configuration=Configuration()):
self.branch_name = ''
self.use_git = use_git
if self.use_git:
print('Using git')
branches = run_command('git branch')
branch_name_reg = re.search(r'\* (.*)', branches)
self.branch_name = branch_name_reg.group(1)
print(f'Running validation on branch {self.branch_name}')
self.prev_ver = prev_ver
if not self.prev_ver:
# validate against master if no version was provided
self.prev_ver = 'origin/master'
self._is_valid = True
self.configuration = configuration
self.is_backward_check = is_backward_check
self.is_circle = is_circle
self.print_ignored_files = print_ignored_files
self.validate_conf_json = validate_conf_json
self.validate_id_set = validate_id_set
if self.validate_conf_json:
self.conf_json_validator = ConfJsonValidator()
if self.validate_id_set:
self.id_set_validator = IDSetValidator(
is_circle=self.is_circle, configuration=self.configuration)
class FilesValidator:
"""FilesValidator is a class that's designed to validate all the changed files on your branch, and all files in case
you are on master, this class will be used on your local env as the validation hook(pre-commit), and on CircleCi
to make sure you did not bypass the hooks as a safety precaution.
Attributes:
is_backward_check (bool): Whether to check for backwards compatibility.
prev_ver (str): If using git, holds the branch to compare the current one to. Default is origin/master.
use_git (bool): Whether to use git or not.
is_circle: (bool): Whether the validation was initiated by CircleCI or not.
print_ignored_files (bool): Whether to print the files that were ignored during the validation or not.
validate_conf_json (bool): Whether to validate conf.json or not.
validate_id_set (bool): Whether to validate id_set or not.
file_path (string): If validating a specific file, golds it's path.
configuration (Configuration): Configurations for IDSetValidator.
"""
def __init__(self,
is_backward_check=True,
prev_ver='origin/master',
use_git=False,
is_circle=False,
print_ignored_files=False,
validate_conf_json=True,
validate_id_set=False,
file_path=None,
configuration=Configuration()):
self.branch_name = ''
self.use_git = use_git
if self.use_git:
print('Using git')
self.branch_name = self.get_current_working_branch()
print(f'Running validation on branch {self.branch_name}')
self.prev_ver = prev_ver
if not self.prev_ver:
# validate against master if no version was provided
self.prev_ver = 'origin/master'
self._is_valid = True
self.configuration = configuration
self.is_backward_check = is_backward_check
self.is_circle = is_circle
self.print_ignored_files = print_ignored_files
self.validate_conf_json = validate_conf_json
self.validate_id_set = validate_id_set
self.file_path = file_path
if self.validate_conf_json:
self.conf_json_validator = ConfJsonValidator()
if self.validate_id_set:
self.id_set_validator = IDSetValidator(
is_circle=self.is_circle, configuration=self.configuration)
def run(self):
print_color('Starting validating files structure', LOG_COLORS.GREEN)
if self.is_valid_structure():
print_color('The files are valid', LOG_COLORS.GREEN)
return 0
else:
print_color(
'The files were found as invalid, the exact error message can be located above',
LOG_COLORS.RED)
return 1
@staticmethod
def get_current_working_branch():
branches = run_command('git branch')
branch_name_reg = re.search(r'\* (.*)', branches)
return branch_name_reg.group(1)
@staticmethod
def get_modified_files(files_string,
tag='master',
print_ignored_files=False):
"""Get lists of the modified files in your branch according to the files string.
Args:
files_string (string): String that was calculated by git using `git diff` command.
tag (string): String of git tag used to update modified files.
print_ignored_files (bool): should print ignored files.
Returns:
(modified_files_list, added_files_list, deleted_files). Tuple of sets.
"""
all_files = files_string.split('\n')
deleted_files = set([])
added_files_list = set([])
modified_files_list = set([])
old_format_files = set([])
for f in all_files:
file_data = f.split()
if not file_data:
continue
file_status = file_data[0]
file_path = file_data[1]
if file_status.lower().startswith('r'):
file_status = 'r'
file_path = file_data[2]
if checked_type(file_path, CODE_FILES_REGEX) and file_status.lower() != 'd' \
and not file_path.endswith('_test.py'):
# naming convention - code file and yml file in packages must have same name.
file_path = os.path.splitext(file_path)[0] + '.yml'
elif file_path.endswith('.js') or file_path.endswith('.py'):
continue
if file_status.lower() in ['m', 'a', 'r'] and checked_type(file_path, OLD_YML_FORMAT_FILE) and \
FilesValidator._is_py_script_or_integration(file_path):
old_format_files.add(file_path)
elif file_status.lower() == 'm' and checked_type(
file_path) and not file_path.startswith('.'):
modified_files_list.add(file_path)
elif file_status.lower() == 'a' and checked_type(
file_path) and not file_path.startswith('.'):
added_files_list.add(file_path)
elif file_status.lower() == 'd' and checked_type(
file_path) and not file_path.startswith('.'):
deleted_files.add(file_path)
elif file_status.lower().startswith('r') and checked_type(
file_path):
# if a code file changed, take the associated yml file.
if checked_type(file_data[2], CODE_FILES_REGEX):
modified_files_list.add(file_path)
else:
modified_files_list.add((file_data[1], file_data[2]))
elif checked_type(file_path, [SCHEMA_REGEX]):
modified_files_list.add(file_path)
elif file_status.lower() not in KNOWN_FILE_STATUSES:
print_error(
'{} file status is an unknown one, please check. File status was: {}'
.format(file_path, file_status))
elif print_ignored_files and not checked_type(
file_path, IGNORED_TYPES_REGEXES):
print_warning('Ignoring file path: {}'.format(file_path))
modified_files_list, added_files_list, deleted_files = filter_packagify_changes(
modified_files_list, added_files_list, deleted_files, tag)
return modified_files_list, added_files_list, deleted_files, old_format_files
def get_modified_and_added_files(self, tag='origin/master'):
"""Get lists of the modified and added files in your branch according to the git diff output.
Args:
tag (string): String of git tag used to update modified files
Returns:
(modified_files, added_files). Tuple of sets.
"""
# Two dots is the default in git diff, it will compare with the last known commit as the base
# Three dots will compare with the last known shared commit as the base
compare_type = '.' if 'master' in tag else ''
all_changed_files_string = run_command(
'git diff --name-status {tag}..{compare_type}refs/heads/{branch}'.
format(tag=tag, branch=self.branch_name,
compare_type=compare_type))
modified_files, added_files, _, old_format_files = self.get_modified_files(
all_changed_files_string,
tag=tag,
print_ignored_files=self.print_ignored_files)
if not self.is_circle:
files_string = run_command(
'git diff --name-status --no-merges HEAD')
nc_modified_files, nc_added_files, nc_deleted_files, nc_old_format_files = self.get_modified_files(
files_string, print_ignored_files=self.print_ignored_files)
all_changed_files_string = run_command(
'git diff --name-status {}'.format(tag))
modified_files_from_tag, added_files_from_tag, _, _ = \
self.get_modified_files(all_changed_files_string,
print_ignored_files=self.print_ignored_files)
if self.file_path:
if F'M\t{self.file_path}' in files_string:
modified_files = {self.file_path}
added_files = set()
else:
modified_files = set()
added_files = {self.file_path}
return modified_files, added_files, set(), set()
old_format_files = old_format_files.union(nc_old_format_files)
modified_files = modified_files.union(
modified_files_from_tag.intersection(nc_modified_files))
added_files = added_files.union(
added_files_from_tag.intersection(nc_added_files))
modified_files = modified_files - set(nc_deleted_files)
added_files = added_files - set(nc_modified_files) - set(
nc_deleted_files)
packs = self.get_packs(modified_files, added_files)
return modified_files, added_files, old_format_files, packs
@staticmethod
def get_packs(modified_files, added_files):
packs = set()
changed_files = modified_files.union(added_files)
for changed_file in changed_files:
if isinstance(changed_file, tuple):
changed_file = changed_file[1]
pack = get_pack_name(changed_file)
if pack and is_file_path_in_pack(changed_file):
packs.add(pack)
return packs
def is_valid_release_notes(self, file_path):
release_notes_validator = ReleaseNotesValidator(file_path)
if not release_notes_validator.is_file_valid():
self._is_valid = False
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)
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 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 validate_no_old_format(self, old_format_files):
""" Validate there are no files in the old format(unified yml file for the code and configuration).
Args:
old_format_files(set): file names which are in the old format.
"""
invalid_files = []
for f in old_format_files:
yaml_data = get_yaml(f)
if 'toversion' not in yaml_data: # we only fail on old format if no toversion (meaning it is latest)
invalid_files.append(f)
if invalid_files:
print_error(
'You should update the following files to the package format, for further details please visit '
'https://github.com/demisto/content/tree/master/docs/package_directory_structure. '
'The files are:\n{}'.format('\n'.join(list(invalid_files))))
self._is_valid = False
def validate_committed_files(self):
"""Validate that all the committed files in your branch are valid"""
modified_files, added_files, old_format_files, packs = self.get_modified_and_added_files(
)
schema_changed = False
for f in modified_files:
if isinstance(f, tuple):
_, f = f
if checked_type(f, [SCHEMA_REGEX]):
schema_changed = True
# Ensure schema change did not break BC
if schema_changed:
print("Schema changed, validating all files")
self.validate_all_files()
else:
self.validate_modified_files(modified_files)
self.validate_added_files(added_files)
self.validate_no_old_format(old_format_files)
self.validate_pack_unique_files(packs)
def validate_pack_unique_files(self, packs):
for pack in packs:
pack_unique_files_validator = PackUniqueFilesValidator(pack)
pack_errors = pack_unique_files_validator.validate_pack_unique_files(
)
if pack_errors:
print_error(pack_errors)
self._is_valid = False
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 is_valid_structure(self):
"""Check if the structure is valid for the case we are in, master - all files, branch - changed files.
Returns:
(bool). Whether the structure is valid or not.
"""
if self.validate_conf_json:
if not self.conf_json_validator.is_valid_conf_json():
self._is_valid = False
if self.use_git:
if self.branch_name != 'master' and (
not self.branch_name.startswith('19.')
and not self.branch_name.startswith('20.')):
print('Validates only committed files')
self.validate_committed_files()
self.validate_against_previous_version(no_error=True)
else:
self.validate_against_previous_version(no_error=True)
print(
'Validates all of Content repo directories according to their schemas'
)
self.validate_all_files()
else:
if self.file_path:
self.branch_name = self.get_current_working_branch()
self.validate_committed_files()
else:
print('Not using git, validating all files')
self.validate_all_files()
return self._is_valid
def validate_against_previous_version(self, no_error=False):
"""Validate all files that were changed between previous version and branch_sha
Args:
no_error (bool): If set to true will restore self._is_valid after run (will not return new errors)
"""
if self.prev_ver and self.prev_ver != 'master':
print_color('Starting validation against {}'.format(self.prev_ver),
LOG_COLORS.GREEN)
modified_files, _, _, _ = self.get_modified_and_added_files(
self.prev_ver)
prev_self_valid = self._is_valid
self.validate_modified_files(modified_files)
if no_error:
self._is_valid = prev_self_valid
# parser.add_argument('-t', '--test-filter', type=str2bool, default=False,
# help='Check that tests are valid.')
# TODO: after validation there was a step to run the configure_tests script to check that each changed file
# had a relevant test - was used as part of the hooks.
@staticmethod
def _is_py_script_or_integration(file_path):
file_yml = get_yaml(file_path)
if re.match(INTEGRATION_REGEX, file_path, re.IGNORECASE):
if file_yml.get('script', {}).get('type',
'javascript') != 'python':
return False
return True
if re.match(SCRIPT_REGEX, file_path, re.IGNORECASE):
if file_yml.get('type', 'javascript') != 'python':
return False
return True
return False
def test_conf_json_description_not_given():
validator = ConfJsonValidator()
assert validator.is_valid_description_in_conf_dict(checked_dict=MISSING_DESCRIPTION) is False, \
"The conf validator couldn't find the missing description in the dictionary"
def test_conf_json_description():
validator = ConfJsonValidator()
assert validator.is_valid_description_in_conf_dict(checked_dict=WITH_DESCRIPTION), \
"The conf validator couldn't find the description in the dictionary"