def test_is_valid_file(integration, file_input, result):
"""
Given
- Description file with Contribution details or not
When
- Run validate on Description file
Then
- Ensure no Contribution details in the file
"""
integration.description.write(file_input)
description_path = integration.description.path
with ChangeCWD(integration.repo_path):
description_validator = DescriptionValidator(description_path)
answer = description_validator.is_valid_file()
assert answer == result
assert description_validator._is_valid == answer
def test_is_duplicate_description_given(pack, mocker):
"""
Given:
- Description file path
When:
- Running detailed description validator on the integration.
Then:
- Ensure validation passes
- Ensure handle error is not called.
"""
mocker.patch.object(DescriptionValidator, 'handle_error')
integration = pack.create_integration()
integration.create_default_integration()
description_validator = DescriptionValidator(integration.description.path)
assert description_validator.is_duplicate_description()
assert not DescriptionValidator.handle_error.called
def test_is_valid_description_name(repo):
"""
Given
- An integration description with a valid name
When
- Validating the integration description name
Then
- Ensure that description validator for integration passes.
"""
pack = repo.create_pack('PackName')
integration = pack.create_integration('IntName')
integration.create_default_integration()
description_validator = DescriptionValidator(integration.yml.path)
assert description_validator.is_valid_description_name()
def test_is_duplicate_description_unified_deprecated_integration(mocker, tmp_path, integration_obj):
"""
Given:
- Case A: Content pack with unified integration
- Case B: Content pack with deprecated integration
When:
- Running detailed description validator on the integration
Then:
- Ensure validation passes
- Ensure no warning is printed
"""
mocker.patch.object(DescriptionValidator, 'handle_error')
integration_dir = tmp_path / 'Packs' / 'SomePack' / 'Integrations' / 'SomeIntegration'
integration_dir.mkdir(parents=True)
unified_integration_yml = integration_dir / 'SomeIntegration.yml'
yaml.dump(integration_obj, unified_integration_yml.open('w'), default_flow_style=False)
description_validator = DescriptionValidator(str(unified_integration_yml))
assert description_validator.is_duplicate_description()
assert not DescriptionValidator.handle_error.called
def test_demisto_not_in_description(repo):
"""
Given
- An integration description without the word 'Demisto'.
When
- Running verify_demisto_in_description_content.
Then
- Ensure that the validation passes.
"""
pack = repo.create_pack('PackName')
integration = pack.create_integration('IntName')
integration.create_default_integration()
integration.description.write('This checks if we have the word XSOAR in the description.')
with ChangeCWD(repo.path):
description_validator = DescriptionValidator(integration.yml.path)
assert description_validator.verify_demisto_in_description_content()
description_validator = DescriptionValidator(integration.description.path)
assert description_validator.verify_demisto_in_description_content()
def test_is_invalid_description_name(repo):
"""
Given
- An integration description with a invalid name
When
- Validating the integration description name
Then
- Ensure that description validator for integration failed.
"""
pack = repo.create_pack('PackName')
integration = pack.create_integration('IntName')
description_path = glob.glob(os.path.join(os.path.dirname(integration.yml.path), '*_description.md'))
new_name = f'{description_path[0].rsplit("/", 1)[0]}/IntName_desc.md'
os.rename(description_path[0], new_name)
with ChangeCWD(repo.path):
description_validator = DescriptionValidator(integration.yml.path)
assert not description_validator.is_valid_description_name()
def validate_added_files(self,
added_files,
file_type: str = None): # 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.
file_type (str): Used only with -p flag (the type of the file).
"""
for file_path in added_files:
print('Validating {}'.format(file_path))
if re.match(TEST_PLAYBOOK_REGEX, file_path,
re.IGNORECASE) and not file_type:
continue
elif 'README' in file_path:
readme_validator = ReadMeValidator(file_path)
if not readme_validator.is_valid_file():
self._is_valid = False
continue
structure_validator = StructureValidator(
file_path, is_new_file=True, predefined_scheme=file_type)
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) or file_type == 'playbook':
playbook_validator = PlaybookValidator(structure_validator)
if not playbook_validator.is_valid_playbook():
self._is_valid = False
elif checked_type(
file_path,
YML_INTEGRATION_REGEXES) or file_type == 'integration':
image_validator = ImageValidator(file_path)
# if file_type(non git path) the image is not in a separate path
image_validator.file_path = file_path if file_type else image_validator.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=not file_type):
self._is_valid = False
elif checked_type(
file_path,
PACKAGE_SCRIPTS_REGEXES) or file_type == 'script':
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=not file_type):
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) or \
file_type in ('incidentfield', 'indicatorfield'):
incident_field_validator = IncidentFieldValidator(
structure_validator)
if not incident_field_validator.is_valid_file(
validate_rn=not file_type):
self._is_valid = False
elif checked_type(file_path,
[REPUTATION_REGEX]) or file_type == 'reputation':
reputation_validator = ReputationValidator(structure_validator)
if not reputation_validator.is_valid_file(
validate_rn=not file_type):
self._is_valid = False
elif checked_type(
file_path,
JSON_ALL_LAYOUT_REGEXES) or file_type == 'layout':
layout_validator = LayoutValidator(structure_validator)
if not layout_validator.is_valid_layout(
validate_rn=not file_type):
self._is_valid = False
elif checked_type(
file_path,
JSON_ALL_DASHBOARDS_REGEXES) or file_type == 'dashboard':
dashboard_validator = DashboardValidator(structure_validator)
if not dashboard_validator.is_valid_dashboard(
validate_rn=not file_type):
self._is_valid = False
elif checked_type(file_path, JSON_ALL_INCIDENT_TYPES_REGEXES):
incident_type_validator = IncidentTypeValidator(
structure_validator)
if not incident_type_validator.is_valid_incident_type(
validate_rn=not file_type):
self._is_valid = False
elif 'CHANGELOG' in file_path:
self.is_valid_release_notes(file_path)
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_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
elif 'README' in file_path:
readme_validator = ReadMeValidator(file_path)
if not readme_validator.is_valid_file():
self._is_valid = False
continue
structure_validator = StructureValidator(
file_path, old_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(
validate_rn=True):
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, [REPUTATION_REGEX]):
reputation_validator = ReputationValidator(structure_validator)
if not reputation_validator.is_valid_file(validate_rn=True):
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(validate_rn=True):
self._is_valid = False
elif checked_type(file_path, JSON_ALL_DASHBOARDS_REGEXES):
dashboard_validator = DashboardValidator(structure_validator)
if not dashboard_validator.is_valid_dashboard(
validate_rn=True):
self._is_valid = False
elif checked_type(file_path, JSON_ALL_INCIDENT_TYPES_REGEXES):
incident_type_validator = IncidentTypeValidator(
structure_validator)
if not incident_type_validator.is_valid_incident_type(
validate_rn=True):
self._is_valid = False
if self.is_backward_check and not incident_type_validator.is_backward_compatible(
):
self._is_valid = False
elif 'CHANGELOG' in file_path:
self.is_valid_release_notes(file_path)
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, is_new_file=True)
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