def __init__(self, org, repo, token=None, dev=False):
self._organization = org
self._repository = repo
self._dev = dev
gh = github3.login(token=token)
self._repo = gh.repository(self._organization, self._repository)
self._requirements = self._get_requirements_from_issues()
self._tags = Tags(org, repo, token=token)
self._current_tag = self._tags.get_latest_tag(self._dev)
self._requirements_tag_map = self._get_requirement_tag_map()
def get_latest_release(token, dev=False):
_tags = Tags(GITHUB_ORG, GITHUB_REPO, token=token)
return _tags._repo.release_from_tag(_tags.get_latest_tag(dev=dev))
def main():
"""Main."""
parser = argparse.ArgumentParser(formatter_class=argparse.RawDescriptionHelpFormatter,
description=__doc__)
parser.add_argument('--ldd_output_path',
help='directory to output generated LDDs',
required=True)
parser.add_argument('--ingest_ldd_src_dir',
help='/path/to/src/ dir for IngestLDD file',
default=os.path.join('tmp', 'logs'),
required=True)
parser.add_argument('--dev',
help='flag to indicate this is a dev release',
action='store_true', default=False)
parser.add_argument('--token',
help='github token')
parser.add_argument('--repo_name',
help='full name of github repo (e.g. user/repo)')
parser.add_argument('--workspace',
help=('path of workspace. defaults to current working directory if this '
'or GITHUB_WORKSPACE not specified')
)
parser.add_argument('--pds4_version',
help='pds4 IM version')
args, unknown = parser.parse_known_args()
token = args.token or os.environ.get('GITHUB_TOKEN')
if not token:
logger.error(f'Github token must be provided or set as environment variable (GITHUB_TOKEN).')
sys.exit(1)
repo_full_name = args.repo_name or os.environ.get('GITHUB_REPOSITORY')
if not repo_full_name:
logger.error(f'Github repository must be provided or set as environment variable (GITHUB_REPOSITORY).')
sys.exit(1)
org = repo_full_name.split('/')[0]
repo_name = repo_full_name.split('/')[1]
workspace = args.workspace or os.environ.get('GITHUB_WORKSPACE')
if not workspace:
workspace = os.getcwd()
os.environ['GITHUB_WORKSPACE'] = workspace
try:
ingest_ldd, namespace_id, ldd_version = get_info(args.ingest_ldd_src_dir)
ldd_dict = find_ldds(args.ldd_output_path, namespace_id, ldd_version, args.pds4_version)
assets = package_assets(ingest_ldd, ldd_dict, namespace_id)
tagger = {"name": "PDSEN CI Bot",
"email": "*****@*****.**"}
gh = github3.login(token=token)
repo = gh.repository(org, repo_name)
delete_snapshot_releases(repo, SNAPSHOT_TAG_SUFFIX)
for release_name in ldd_dict.keys():
if 'dependencies' not in release_name:
if args.dev:
tag_name = release_name + SNAPSHOT_TAG_SUFFIX
else:
tag_name = release_name
# Check tag exists before continuing
tags = Tags(org, repo_name, token=token)
if not tags.get_tag(tag_name):
release = create_release(repo, "master", tag_name, tagger, args.dev)
logger.info("upload assets")
ldd_upload_assets(release, assets)
else:
logger.warning(f"tag {tag_name} already exists. skipping...")
except Exception:
traceback.print_exc()
sys.exit(1)
logger.info(f'SUCCESS: LDD release complete.')
class Requirements:
ISSUE_TYPES = ['bug', 'enhancement']
def __init__(self, org, repo, token=None, dev=False):
self._organization = org
self._repository = repo
self._dev = dev
gh = github3.login(token=token)
self._repo = gh.repository(self._organization, self._repository)
self._requirements = self._get_requirements_from_issues()
self._tags = Tags(org, repo, token=token)
self._current_tag = self._tags.get_latest_tag(self._dev)
self._requirements_tag_map = self._get_requirement_tag_map()
def _get_requirement_topic(self, issue):
requirement_topic = None
for label in issue.labels():
if label.name.startswith("requirement-topic"):
requirement_topic = label.name.split(':')[1]
continue
if not requirement_topic:
requirement_topic = 'default'
return requirement_topic
def _get_requirements_from_issues(self):
summary = {}
for issue in self._repo.issues(state='all', direction='asc', labels='requirement'):
requirement_topic = self._get_requirement_topic(issue)
if requirement_topic not in summary.keys():
summary[requirement_topic] = []
summary[requirement_topic].append({'number': issue.number,
'title': issue.title,
'link': issue.url})
return summary
def _get_requirement_tag_map(self):
requirements_issue_map = {}
requirements_tag_map = {}
for issue in self._repo.issues(state='closed', direction='asc'):
body_sections = issue.body.split("**Applicable requirements")
if len(body_sections) > 1:
impacted_requirements_str = body_sections[1]
prog = re.compile("#[0-9]+")
requirements = prog.findall(impacted_requirements_str)
requirements = [ int(req[1:]) for req in requirements] # remove leading # and convert to int to be consistent with requirement dictionnary
for req in requirements:
if req not in requirements_tag_map.keys():
requirements_tag_map[req] = {'issues': set(), 'tags': set()}
issue_date_isoz = issue.closed_at.isoformat().replace('+00:00', 'Z')
earliest_tag_closed_after = self._tags.get_earliest_tag_after(issue_date_isoz)
requirements_tag_map[req]['issues'].add(issue.number)
requirements_tag_map[req]['tags'].add(earliest_tag_closed_after)
return requirements_tag_map
def get_requirements(self):
return self._requirements
@staticmethod
def _version_paragraph_intro(versions_len):
if versions_len == 0:
return ''
elif versions_len ==1:
return 'The version implementing or impacting this requirement is:'
else:
return 'The versions implementing or impacting this requirement are:'
@staticmethod
def _issue_is_bug_or_enhancement(issue):
for label in issue.labels():
if label.name in Requirements.ISSUE_TYPES:
return label.name
def _clean_previous_dev_requirements(self, root_dir):
if self._dev:
requirement_version_dev_dirs = glob.glob(os.path.join(root_dir, '*' + Tags.PYTHON_DEV_SUFFIX))
requirement_version_dev_dirs.extend(glob.glob(os.path.join(root_dir, '*' + Tags.JAVA_DEV_SUFFIX)))
for dir in requirement_version_dev_dirs:
if dir != self._current_tag:
shutil.rmtree(dir)
def write_requirements(self, root_dir='.', md_file_name=None, format='md'):
if not md_file_name:
if self._current_tag:
md_file_name = os.path.join(root_dir, self._current_tag, 'REQUIREMENTS.md')
else:
dev_or_stable = "dev" if self._dev else "stable"
raise NoAppropriateVersionFoundException("No suitable version for " + dev_or_stable + "release")
os.makedirs(os.path.dirname(md_file_name), exist_ok=True)
requirements_md = MdUtils(file_name=md_file_name, title="Requirements Summary")
for req_topic in self._requirements:
requirements_md.new_header(level=1, title=req_topic)
for req in self._requirements[req_topic]:
impacted = self._current_tag in self._requirements_tag_map[req['number']]['tags'] if req['number'] in self._requirements_tag_map else False
impacted_icon = ':boom:' if impacted else ''
title = f"{req['title']} ([#{req['number']}](https://github.com/{self._repo}/issues/{req['number']})) {impacted_icon}"
requirements_md.new_header(level=2, title=title)
if impacted:
issue_lines = {t : [] for t in Requirements.ISSUE_TYPES}
for n in self._requirements_tag_map[req['number']]['issues']:
issue = self._repo.issue(n)
bug_or_enhancement = Requirements._issue_is_bug_or_enhancement(issue)
issue_lines[bug_or_enhancement].append(f'{issue.title} ([#{n}](https://github.com/{self._repo}/issues/{n}))')
for issue_type, issue_list in issue_lines.items():
if len(issue_lines[issue_type]):
requirements_md.new_paragraph(f'The {issue_type}s which impact this requirements are:')
requirements_md.new_list(issue_list)
else:
requirements_md.new_paragraph('This requirement is not impacted by the current version')
requirements_md.create_md_file()
if format == 'md':
return md_file_name
if format == 'html':
html_file_name = md_file_name.replace('.md', '.html')
return md_to_html(md_file_name, html_file_name,
{'name': self._repo, 'description': self._repo.description, 'tag': self._current_tag})
else:
logger.error(f'output format {format} is not supported')
return ''
self._clean_previous_dev_requirements(root_dir)
def test_get_earliest_tag_after(self):
tags = Tags('NASA-PDS', 'validate', token=GITHUB_TOKEN)
tags.get_earliest_tag_after(
datetime(2020, 1, 1).isoformat().replace('+00:00', 'Z'))