class Playbook:
def __init__(self,
tmpdir: Path,
name,
repo,
is_test_playbook: bool = False):
# Save entities
self.name = name
self._repo = repo
self.repo_path = repo.path
self.is_test_playbook = is_test_playbook
self.path = str(tmpdir)
self.yml = YAML(tmpdir / f'{self.name}.yml', self._repo.path)
if not self.is_test_playbook:
self.readme = File(tmpdir / f'{self.name}_README.md',
self._repo.path)
if not self.is_test_playbook:
# build playbook
self.create_default_playbook()
else:
# build test playbook
self.create_default_test_playbook()
def build(
self,
yml: Optional[dict] = None,
readme: Optional[str] = None,
):
"""Writes not None objects to files.
"""
if yml is not None:
self.yml.write_dict(yml)
if not self.is_test_playbook and readme is not None:
self.readme.write(readme)
def create_default_playbook(self, name: str = 'sample playbook'):
"""Creates a new playbook with basic data.
Args:
name: The name and ID of the new playbook, default is "sample playbook".
"""
default_playbook_dir = 'assets/default_playbook'
with open(suite_join_path(default_playbook_dir,
'playbook-sample.yml')) as yml_file:
yml = yaml.load(yml_file)
yml['id'] = yml['name'] = name
self.build(yml=yml)
def create_default_test_playbook(self, name: str = 'SamplePlaybookTest'):
default_test_playbook_dir = 'assets/default_playbook'
with open(
suite_join_path(default_test_playbook_dir,
'playbook-sample.yml')) as yml_file:
yml = yaml.load(yml_file)
yml['id'] = yml['name'] = name
self.build(yml=yml)
def __init__(self,
tmpdir: Path,
name,
repo,
create_unified: Optional[bool] = False):
# Save entities
self.name = name
self._repo = repo
self.repo_path = repo.path
# Create paths
self._tmpdir_integration_path = tmpdir / f'{self.name}'
self._tmpdir_integration_path.mkdir()
# if creating a unified yaml
self.create_unified = create_unified
self.path = str(self._tmpdir_integration_path)
self.code = File(self._tmpdir_integration_path / f'{self.name}.py',
self._repo.path)
self.yml = YAML(self._tmpdir_integration_path / f'{self.name}.yml',
self._repo.path)
self.readme = File(self._tmpdir_integration_path / 'README.md',
self._repo.path)
self.description = File(
self._tmpdir_integration_path / f'{self.name}_description.md',
self._repo.path)
self.changelog = File(self._tmpdir_integration_path / 'CHANGELOG.md',
self._repo.path)
self.image = File(
self._tmpdir_integration_path / f'{self.name}_image.png',
self._repo.path)
def _create_yaml_based(
self,
name,
dir_path,
content: dict = {},
) -> YAML:
yaml_name = f"{name}.yml"
yaml_path = dir_path / yaml_name
obj = YAML(yaml_path, self.repo_path)
obj.write_dict(content)
return obj
class Playbook:
def __init__(self,
tmpdir: Path,
name,
repo,
is_test_playbook: bool = False):
# Save entities
self.name = name
self._repo = repo
self.repo_path = repo.path
self.is_test_playbook = is_test_playbook
self.path = str(tmpdir)
self.yml = YAML(tmpdir / f'{self.name}.yml', self._repo.path)
if not self.is_test_playbook:
self.readme = File(tmpdir / 'README.md', self._repo.path)
if not self.is_test_playbook:
# build playbook
self.create_default_playbook()
else:
# build test playbook
self.create_default_test_playbook()
def build(
self,
yml: Optional[dict] = None,
readme: Optional[str] = None,
):
"""Writes not None objects to files.
"""
if yml is not None:
self.yml.write_dict(yml)
if not self.is_test_playbook and readme is not None:
self.readme.write(readme)
def create_default_playbook(self):
default_playbook_dir = 'assets/default_playbook'
with open(suite_join_path(default_playbook_dir,
'playbook-sample.yml')) as yml:
self.build(yml=yaml.safe_load(yml))
def create_default_test_playbook(self):
default_test_playbook_dir = 'assets/default_playbook'
with open(
suite_join_path(default_test_playbook_dir,
'playbook-sample.yml')) as yml:
self.build(yml=yaml.safe_load(yml))
def __init__(
self,
tmpdir: Path,
name: str,
repo: Repo,
):
self.name = name
self._repo = repo
self.repo_path = repo.path
self._tmpdir_rule_path = tmpdir / f'{self.name}'
self._tmpdir_rule_path.mkdir()
self.path = str(self._tmpdir_rule_path)
self.yml = YAML(self._tmpdir_rule_path / f'{self.name}.yml',
self._repo.path)
self.rules = File(self._tmpdir_rule_path / f'{self.name}.xif',
self._repo.path)
self.samples: list[JSONBased] = []
self.samples_dir_path = tmpdir / SAMPLES_DIR
class Rule:
def __init__(
self,
tmpdir: Path,
name: str,
repo: Repo,
):
self.name = name
self._repo = repo
self.repo_path = repo.path
self._tmpdir_rule_path = tmpdir / f'{self.name}'
self._tmpdir_rule_path.mkdir()
self.path = str(self._tmpdir_rule_path)
self.yml = YAML(self._tmpdir_rule_path / f'{self.name}.yml',
self._repo.path)
self.rules = File(self._tmpdir_rule_path / f'{self.name}.xif',
self._repo.path)
self.samples: list[JSONBased] = []
self.samples_dir_path = tmpdir / SAMPLES_DIR
def build(
self,
yml: dict,
rules: str | None = None,
samples: list[dict] | None = None,
):
self.yml.write_dict(yml)
if rules:
self.rules.write(rules)
if samples:
self.samples_dir_path.mkdir()
for sample in samples:
sample_file = JSONBased(
dir_path=self.samples_dir_path,
name=f'sample-{len(self.samples)}',
prefix='',
)
sample_file.write_json(sample)
self.samples.append(sample_file)
def __init__(self,
tmpdir: Path,
name,
repo,
is_test_playbook: bool = False):
# Save entities
self.name = name
self._repo = repo
self.repo_path = repo.path
self.is_test_playbook = is_test_playbook
self.path = str(tmpdir)
self.yml = YAML(tmpdir / f'{self.name}.yml', self._repo.path)
if not self.is_test_playbook:
self.readme = File(tmpdir / 'README.md', self._repo.path)
if not self.is_test_playbook:
# build playbook
self.create_default_playbook()
else:
# build test playbook
self.create_default_test_playbook()
class Integration:
def __init__(self,
tmpdir: Path,
name,
repo,
create_unified: Optional[bool] = False):
# Save entities
self.name = name
self._repo = repo
self.repo_path = repo.path
# Create paths
self._tmpdir_integration_path = tmpdir / f'{self.name}'
self._tmpdir_integration_path.mkdir()
# if creating a unified yaml
self.create_unified = create_unified
self.path = str(self._tmpdir_integration_path)
self.code = File(self._tmpdir_integration_path / f'{self.name}.py',
self._repo.path)
self.yml = YAML(self._tmpdir_integration_path / f'{self.name}.yml',
self._repo.path)
self.readme = File(self._tmpdir_integration_path / 'README.md',
self._repo.path)
self.description = File(
self._tmpdir_integration_path / f'{self.name}_description.md',
self._repo.path)
self.changelog = File(self._tmpdir_integration_path / 'CHANGELOG.md',
self._repo.path)
self.image = File(
self._tmpdir_integration_path / f'{self.name}_image.png',
self._repo.path)
def build(self,
code: Optional[str] = None,
yml: Optional[dict] = None,
readme: Optional[str] = None,
description: Optional[str] = None,
changelog: Optional[str] = None,
image: Optional[bytes] = None):
"""Writes not None objects to files.
"""
if code is not None:
self.code.write(code)
if yml is not None:
self.yml.write_dict(yml)
if readme is not None:
self.readme.write(readme)
if description is not None:
self.description.write(description)
if changelog is not None:
self.changelog.write(changelog)
if image is not None:
self.image.write_bytes(image)
def create_default_integration(self):
default_integration_dir = 'assets/default_integration'
with open(suite_join_path(default_integration_dir,
'sample.py')) as code_file:
code = str(code_file.read())
with open(suite_join_path(default_integration_dir,
'sample.yml')) as yml_file:
yml = yaml.safe_load(yml_file)
with open(suite_join_path(default_integration_dir, 'sample_image.png'),
'rb') as image_file:
image = image_file.read()
with open(suite_join_path(default_integration_dir,
'CHANGELOG.md')) as changelog_file:
changelog = str(changelog_file.read())
with open(
suite_join_path(default_integration_dir,
'sample_description.md')) as description_file:
description = str(description_file.read())
self.build(code=code,
yml=yml,
image=image,
changelog=changelog,
description=description)
if self.create_unified:
unifier = Unifier(input=self.path,
output=os.path.dirname(
self._tmpdir_integration_path))
unifier.merge_script_package_to_yml()
shutil.rmtree(self._tmpdir_integration_path)
class Integration:
def __init__(self,
tmpdir: Path,
name,
repo,
create_unified: Optional[bool] = False):
# Save entities
self.name = name
self._repo = repo
self.repo_path = repo.path
# Create paths
self._tmpdir_integration_path = tmpdir / f'{self.name}'
self._tmpdir_integration_path.mkdir()
# if creating a unified yaml
self.create_unified = create_unified
self.path = str(self._tmpdir_integration_path)
self.code = File(self._tmpdir_integration_path / f'{self.name}.py',
self._repo.path)
self.yml = YAML(self._tmpdir_integration_path / f'{self.name}.yml',
self._repo.path)
self.readme = File(self._tmpdir_integration_path / 'README.md',
self._repo.path)
self.description = File(
self._tmpdir_integration_path / f'{self.name}_description.md',
self._repo.path)
self.changelog = File(self._tmpdir_integration_path / 'CHANGELOG.md',
self._repo.path)
self.image = File(
self._tmpdir_integration_path / f'{self.name}_image.png',
self._repo.path)
def build(self,
code: Optional[str] = None,
yml: Optional[dict] = None,
readme: Optional[str] = None,
description: Optional[str] = None,
changelog: Optional[str] = None,
image: Optional[bytes] = None):
"""Writes not None objects to files.
"""
if code is not None:
self.code.write(code)
if yml is not None:
self.yml.write_dict(yml)
if readme is not None:
self.readme.write(readme)
if description is not None:
self.description.write(description)
if changelog is not None:
self.changelog.write(changelog)
if image is not None:
self.image.write_bytes(image)
def create_default_integration(self):
default_integration_dir = 'assets/default_integration'
with open(suite_join_path(default_integration_dir,
'sample.py')) as code_file:
code = str(code_file.read())
with open(suite_join_path(default_integration_dir,
'sample.yml')) as yml_file:
yml = yaml.load(yml_file, Loader=yaml.FullLoader)
with open(suite_join_path(default_integration_dir, 'sample_image.png'),
'rb') as image_file:
image = image_file.read()
with open(suite_join_path(default_integration_dir,
'CHANGELOG.md')) as changelog_file:
changelog = str(changelog_file.read())
with open(
suite_join_path(default_integration_dir,
'sample_description.md')) as description_file:
description = str(description_file.read())
self.build(code=code,
yml=yml,
image=image,
changelog=changelog,
description=description)
if self.create_unified:
unifier = Unifier(input=self.path,
output=os.path.dirname(
self._tmpdir_integration_path))
unifier.merge_script_package_to_yml()
shutil.rmtree(self._tmpdir_integration_path)
# Deprecated methods
@deprecated(reason="use integration.code.write instead")
def write_code(self, code: str):
self.code.write(code)
@deprecated(reason="use integration.code.read instead")
def read_code(self):
return self.code.read()
@deprecated(reason="use integration.yml.write_dict instead")
def write_yml(self, yml: dict):
self.yml.write_dict(yml)
@deprecated(reason="use integration.image.write_bytes instead")
def write_image(self, image: bytes):
self.image.write_bytes(image)
@deprecated(reason="use integration.description.write instead")
def write_description(self, description: str):
self.description.write(description)
@deprecated(reason="use integration.readme.write instead")
def write_readme(self, readme: str):
self.readme.write(readme)
@deprecated(reason="use integration.readme.write instead")
def write_changelog(self, changelog: str):
self.readme.write(changelog)
@deprecated(reason="use integration.yml.update instead")
def update_yml(self, update_obj: dict):
yml_contents = yaml.load(self.yml.read())
yml_contents.update(update_obj)
self.yml.write(yml_contents)
@deprecated(reason="use integration.yml.update_description instead")
def update_description(self, description: str):
self.yml.update_description(description)
@property # type: ignore
@deprecated(reason="use integration.code.rel_path instead")
def py_path(self):
return self.code.rel_path
@property # type: ignore
@deprecated(reason="use integration.yml.rel_path instead")
def yml_path(self):
return self.yml.rel_path
def image_path(self):
return os.path.relpath(str(self._image_file), self._repo.path)
class Integration:
def __init__(self, tmpdir: Path, name, repo, create_unified: Optional[bool] = False):
# Save entities
self.name = name
self._repo = repo
self.repo_path = repo.path
# Create paths
self._tmpdir_integration_path = tmpdir / f'{self.name}'
self._tmpdir_integration_path.mkdir()
# if creating a unified yaml
self.create_unified = create_unified
self.path = str(self._tmpdir_integration_path)
self.code = File(self._tmpdir_integration_path / f'{self.name}.py', self._repo.path)
self.yml = YAML(self._tmpdir_integration_path / f'{self.name}.yml', self._repo.path)
self.readme = File(self._tmpdir_integration_path / 'README.md', self._repo.path)
self.description = File(self._tmpdir_integration_path / f'{self.name}_description.md', self._repo.path)
self.changelog = File(self._tmpdir_integration_path / 'CHANGELOG.md', self._repo.path)
self.image = File(self._tmpdir_integration_path / f'{self.name}_image.png', self._repo.path)
def build(
self,
code: Optional[str] = None,
yml: Optional[dict] = None,
readme: Optional[str] = None,
description: Optional[str] = None,
changelog: Optional[str] = None,
image: Optional[bytes] = None
):
"""Writes not None objects to files.
"""
if code is not None:
self.code.write(code)
if yml is not None:
self.yml.write_dict(yml)
if readme is not None:
self.readme.write(readme)
if description is not None:
self.description.write(description)
if changelog is not None:
self.changelog.write(changelog)
if image is not None:
self.image.write_bytes(image)
if self.create_unified:
unifier = IntegrationScriptUnifier(input=self.path, output=os.path.dirname(self._tmpdir_integration_path))
yml_path = unifier.unify()[0]
readme_path = unifier.move_readme_next_to_unified(yml_path)
shutil.rmtree(self._tmpdir_integration_path)
self.yml.path = yml_path
self.readme.path = readme_path
def create_default_integration(self, name: str = 'Sample', commands: List[str] = None):
"""Creates a new integration with basic data
Args:
name: The name and ID of the new integration, default is "Sample".
commands: List of additional commands to add to the integration.
"""
default_integration_dir = 'assets/default_integration'
with open(suite_join_path(default_integration_dir, 'sample.py')) as code_file:
code = str(code_file.read())
with open(suite_join_path(default_integration_dir, 'sample.yml')) as yml_file:
yml = yaml.load(yml_file)
yml['name'] = yml['commonfields']['id'] = name
if commands:
for command in commands:
yml['script']['commands'].append({'name': command})
with open(suite_join_path(default_integration_dir, 'sample_image.png'), 'rb') as image_file:
image = image_file.read()
with open(suite_join_path(default_integration_dir, 'CHANGELOG.md')) as changelog_file:
changelog = str(changelog_file.read())
with open(suite_join_path(default_integration_dir, 'sample_description.md')) as description_file:
description = str(description_file.read())
self.build(
code=code,
yml=yml,
image=image,
changelog=changelog,
description=description
)