def update_pack_releasenotes(**kwargs):
_pack = kwargs.get('pack')
update_type = kwargs.get('update_type')
pre_release = kwargs.get('pre_release')
is_all = kwargs.get('all')
modified, added, old, _packs = FilesValidator(
use_git=True).get_modified_and_added_files()
packs_existing_rn = set()
for pf in added:
if 'ReleaseNotes' in pf:
pack_with_existing_rn = get_pack_name(pf)
packs_existing_rn.add(pack_with_existing_rn)
if len(packs_existing_rn):
existing_rns = ''.join(f"{p}, " for p in packs_existing_rn)
print_warning(
f"Found existing release notes for the following packs: {existing_rns.rstrip(', ')}"
)
if len(_packs) > 1:
pack_list = ''.join(f"{p}, " for p in _packs)
if not is_all:
if _pack:
pass
else:
print_error(
f"Detected changes in the following packs: {pack_list.rstrip(', ')}\n"
f"To update release notes in a specific pack, please use the -p parameter "
f"along with the pack name.")
sys.exit(0)
if len(modified) < 1:
print_warning('No changes were detected.')
sys.exit(0)
if is_all and not _pack:
packs = list(_packs - packs_existing_rn)
packs_list = ''.join(f"{p}, " for p in packs)
print_warning(
f"Adding release notes to the following packs: {packs_list.rstrip(', ')}"
)
for pack in packs:
update_pack_rn = UpdateRN(pack=pack,
update_type=update_type,
pack_files=modified,
pre_release=pre_release)
update_pack_rn.execute_update()
elif is_all and _pack:
print_error(
"Please remove the --all flag when specifying only one pack.")
sys.exit(0)
else:
if _pack:
if _pack in packs_existing_rn:
print_error(
f"New release notes file already found for {_pack}. "
f"Please update manually or delete {pack_name_to_path(_pack)}"
)
else:
update_pack_rn = UpdateRN(pack=_pack,
update_type=update_type,
pack_files=modified,
pre_release=pre_release)
update_pack_rn.execute_update()
def test_add_and_modify_files_without_update_docker_image(self, mocker):
"""
Given
- Modified .yml file, but relevant release notes is already exist.
When
- Updating docker image tag.
Then
- A new record with the updated docker image is added.
"""
from demisto_sdk.commands.update_release_notes.update_rn import UpdateRN
import os
with open('demisto_sdk/commands/update_release_notes/tests_data/Packs/Test/pack_metadata.json', 'r') as file:
pack_data = json.load(file)
mocker.patch('demisto_sdk.commands.update_release_notes.update_rn.run_command',
return_value='+ type:True')
mocker.patch('demisto_sdk.commands.update_release_notes.update_rn.pack_name_to_path',
return_value='demisto_sdk/commands/update_release_notes/tests_data/Packs/Test')
mocker.patch.object(UpdateRN, 'is_bump_required', return_value=True)
mocker.patch.object(UpdateRN, 'get_pack_metadata', return_value=pack_data)
mocker.patch.object(UpdateRN, 'get_display_name', return_value='Test')
mocker.patch.object(UpdateRN, 'build_rn_template', return_value='##### Test\n')
mocker.patch.object(UpdateRN, 'return_release_notes_path', return_value='demisto_sdk/commands'
'/update_release_notes/tests_data'
'/Packs/release_notes/1_1_0.md')
client = UpdateRN(pack_path="Packs/Test", update_type='minor', modified_files_in_pack={
'Packs/Test/Integrations/Test.yml'}, added_files=set('Packs/Test/some_added_file.py'))
client.execute_update()
with open('demisto_sdk/commands/update_release_notes/tests_data/Packs/release_notes/1_1_0.md', 'r') as file:
RN = file.read()
os.remove('demisto_sdk/commands/update_release_notes/tests_data/Packs/release_notes/1_1_0.md')
assert 'Upgraded the Docker image to dockerimage:python/test:1243' not in RN
def test_update_docker_image_in_yml(self, mocker):
"""
Given
- Modified .yml file
When
- Updating docker image tag
Then
- A new release notes is created. and it has a new record for updating docker image.
"""
from demisto_sdk.commands.update_release_notes.update_rn import UpdateRN
import os
with open('demisto_sdk/commands/update_release_notes/tests_data/Packs/Test/pack_metadata.json', 'r') as file:
pack_data = json.load(file)
mocker.patch('demisto_sdk.commands.update_release_notes.update_rn.run_command',
return_value='+ dockerimage:python/test:1243')
mocker.patch('demisto_sdk.commands.update_release_notes.update_rn.pack_name_to_path',
return_value='demisto_sdk/commands/update_release_notes/tests_data/Packs/Test')
mocker.patch.object(UpdateRN, 'is_bump_required', return_value=False)
mocker.patch.object(UpdateRN, 'get_pack_metadata', return_value=pack_data)
mocker.patch.object(UpdateRN, 'get_display_name', return_value='Test')
mocker.patch.object(UpdateRN, 'build_rn_template', return_value='##### Test')
mocker.patch.object(UpdateRN, 'return_release_notes_path',
return_value='demisto_sdk/commands/update_release_notes/tests_data/Packs/release_notes'
'/1_1_0.md')
client = UpdateRN(pack_path="Packs/Test", update_type='minor',
modified_files_in_pack={'Packs/Test/Integrations/Test.yml'},
added_files=set())
client.execute_update()
with open('demisto_sdk/commands/update_release_notes/tests_data/Packs/release_notes/1_1_0.md', 'r') as file:
RN = file.read()
os.remove('demisto_sdk/commands/update_release_notes/tests_data/Packs/release_notes/1_1_0.md')
assert 'Upgraded the Docker image to dockerimage:python/test:1243' in RN
def test_execute_update_invalid(self):
"""
Given:
- A protected pack name
When:
- running the update command
Then:
- return an error message and exit.
"""
from demisto_sdk.commands.update_release_notes.update_rn import UpdateRN
update_rn = UpdateRN(pack_path="Packs/Legacy", update_type='minor', modified_files_in_pack=set(),
added_files=set())
update_rn.execute_update()
def create_pack_release_notes(self, pack: str, filtered_modified_files: set, filtered_added_files: set,
old_format_files: set):
""" Creates the release notes for a given pack if was changed.
:param
pack: The pack to create release notes for
filtered_modified_files: A set of filtered modified files
filtered_added_files: A set of filtered added files
old_format_files: A set of old formatted files
"""
existing_rn_version = self.get_existing_rn(pack)
if existing_rn_version is None: # New release notes file already found for the pack
raise RuntimeError(f"New release notes file already found for {pack}. "
f"Please update manually or run `demisto-sdk update-release-notes "
f"-i {pack}` without specifying the update_type.")
pack_modified = filter_files_on_pack(pack, filtered_modified_files)
pack_added = filter_files_on_pack(pack, filtered_added_files)
pack_old = filter_files_on_pack(pack, old_format_files)
# Checks if update is required
if pack_modified or pack_added or pack_old or self.is_force:
pack_path = pack_name_to_path(pack)
update_pack_rn = UpdateRN(pack_path=pack_path, update_type=self.update_type,
modified_files_in_pack=pack_modified.union(pack_old),
pre_release=self.pre_release,
added_files=pack_added, specific_version=self.specific_version,
text=self.text, is_force=self.is_force,
existing_rn_version_path=existing_rn_version, is_bc=self.is_bc)
updated = update_pack_rn.execute_update()
self.rn_path.append(update_pack_rn.rn_path)
# If new release notes were created add it to the total number of packs that were updated.
if updated:
self.total_updated_packs.add(pack)
# If there is an outdated previous release notes, remove it (for example: User updated his version to
# 1.0.4 and meanwhile the master version changed to 1.0.4, so we want to remove the user's 1_0_4 file
# and add a 1_0_5 file.)
if update_pack_rn.should_delete_existing_rn:
os.unlink(self.packs_existing_rn[pack])
else:
print_warning(f'Either no changes were found in {pack} pack '
f'or the changes found should not be documented in the release notes file.\n'
f'If relevant changes were made, please commit the changes and rerun the command.')
def update_pack_releasenotes(**kwargs):
_pack = kwargs.get('pack')
update_type = kwargs.get('update_type')
pre_release = kwargs.get('pre_release')
is_all = kwargs.get('all')
specific_version = kwargs.get('version')
print("Starting to update release notes.")
modified, added, old, _packs = FilesValidator(
use_git=True, silence_init_prints=True).get_modified_and_added_files()
packs_existing_rn = set()
for pf in added:
if 'ReleaseNotes' in pf:
pack_with_existing_rn = get_pack_name(pf)
packs_existing_rn.add(pack_with_existing_rn)
if len(packs_existing_rn):
existing_rns = ''.join(f"{p}, " for p in packs_existing_rn)
print_warning(
f"Found existing release notes for the following packs: {existing_rns.rstrip(', ')}"
)
if len(_packs) > 1:
pack_list = ''.join(f"{p}, " for p in _packs)
if not is_all:
if _pack:
pass
else:
print_error(
f"Detected changes in the following packs: {pack_list.rstrip(', ')}\n"
f"To update release notes in a specific pack, please use the -p parameter "
f"along with the pack name.")
sys.exit(0)
if (len(modified) < 1) and (len(added) < 1):
print_warning(
'No changes were detected. If changes were made, please commit the changes '
'and rerun the command')
sys.exit(0)
if is_all and not _pack:
packs = list(_packs - packs_existing_rn)
packs_list = ''.join(f"{p}, " for p in packs)
print_warning(
f"Adding release notes to the following packs: {packs_list.rstrip(', ')}"
)
for pack in packs:
update_pack_rn = UpdateRN(pack=pack,
update_type=update_type,
pack_files=modified,
pre_release=pre_release,
added_files=added,
specific_version=specific_version)
update_pack_rn.execute_update()
elif is_all and _pack:
print_error(
"Please remove the --all flag when specifying only one pack.")
sys.exit(0)
else:
if _pack:
if _pack in packs_existing_rn and update_type is not None:
print_error(
f"New release notes file already found for {_pack}. "
f"Please update manually or run `demisto-sdk update-release-notes "
f"-p {_pack}` without specifying the update_type.")
else:
update_pack_rn = UpdateRN(pack=_pack,
update_type=update_type,
pack_files=modified,
pre_release=pre_release,
added_files=added,
specific_version=specific_version)
update_pack_rn.execute_update()
