openstack/openstack-ansible
Code Issues Proposed changes

Ensure releasing does not inject new lines

Browse Source 
By default ruamel.yaml does attempt to split
lines longer then 80 symbols. We bump this
value to more reasonable 160 symbols.

With that we add new write_data_to_file method
responsible for dumping yaml data to the destination,
instead doing the same operation in multiple places

Change-Id: Ie4a94b5646b31f80372a7974075a60c274abbf0e
Signed-off-by: Dmitriy Rabotyagov <dmitriy.rabotyagov@cleura.com>
This commit is contained in:
Dmitriy Rabotyagov
2025-09-26 12:29:15 +02:00
parent f1eee51ca7
commit 649c0ca5f4
1 changed files with 13 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
osa_toolkit/releasing.py
View File

@@ -14,8 +14,8 @@ try:
from jinja2 import Template as j2_template from jinja2 import Template as j2_template
from packaging import requirements as pyrequirements from packaging import requirements as pyrequirements
from packaging import version from packaging import version
from prettytable import PrettyTable # prettytable from prettytable import PrettyTable
from ruamel.yaml import YAML # ruamel.yaml from ruamel.yaml import YAML
except ImportError as err: except ImportError as err:
raise SystemExit( raise SystemExit(
'Required dependencies are missing for this script! ' 'Required dependencies are missing for this script! '
@@ -155,6 +155,14 @@ def analyse_global_requirement_pins(args):
print_requirements_state(pins, latest_versions, constraints_versions) print_requirements_state(pins, latest_versions, constraints_versions)
def write_data_to_file(data, filename):
yaml = YAML()
yaml.width = 160
yaml.explicit_start = True
with open(filename, "w") as fw:
yaml.dump(data, fw)
def parse_requirements(requirements): def parse_requirements(requirements):
"""Parse requirement file contents into name, constraints specs, and extra data """Parse requirement file contents into name, constraints specs, and extra data
:param pin: Complete string containing a requirement :param pin: Complete string containing a requirement
@@ -281,11 +289,7 @@ def bump_upstream_repos_sha_file(filename):
) )
if changed: if changed:
with open(filename, "w") as fw: write_data_to_file(repofiledata, filename)
# Temporarily revert the explicit start to add --- into first line
yaml.explicit_start = True
yaml.dump(repofiledata, fw)
yaml.explicit_start = False
# def parse_repos_info(filename): # def parse_repos_info(filename):
@@ -427,11 +431,7 @@ def update_ansible_role_requirements_file(
shutil.rmtree(clone_root_path) shutil.rmtree(clone_root_path)
print("Overwriting ansible-role-requirements") print("Overwriting ansible-role-requirements")
with open(filename, "w") as arryml: write_data_to_file(all_roles, filename)
yaml = YAML() # use ruamel.yaml to keep comments that could appear
yaml.explicit_start = True
yaml.dump(all_roles, arryml)
yaml.explicit_start = False
def update_ansible_collection_requirements(filename=''): def update_ansible_collection_requirements(filename=''):
@@ -460,11 +460,7 @@ def update_ansible_collection_requirements(filename=''):
all_requirements['collections'] = all_collections all_requirements['collections'] = all_collections
print("Overwriting ansible-collection-requirements") print("Overwriting ansible-collection-requirements")
with open(filename, "w") as arryml: write_data_to_file(all_requirements, filename)
yaml = YAML() # use ruamel.yaml to keep comments that could appear
yaml.explicit_start = True
yaml.dump(all_requirements, arryml)
yaml.explicit_start = False
def sort_roles(ansible_role_requirements_file): def sort_roles(ansible_role_requirements_file):