openstack
/
goal-tools
Code Issues Proposed changes
goal-tools/goal_tools/import_goal.py

305 lines
9.5 KiB
Python
Raw Blame History

#!/usr/bin/env python3
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import argparse
import logging
import os
import os.path
import warnings
import appdirs
import requests
import yaml
from goal_tools import storyboard
from goal_tools import goals
_GOVERNANCE_PROJECT_NAME = 'openstack/governance'
_STORY_URL_TEMPLATE = 'https://storyboard.openstack.org/#!/story/{}'
_BOARD_URL_TEMPLATE = 'https://storyboard.openstack.org/#!/board/{}'
_WORKLISTS = [
('New', 'active', 'Todo'),
('Completed', 'merged', 'Merged'),
]
LOG = logging.getLogger()
def _get_worklist_settings(tag):
for title, status, status_title in _WORKLISTS:
yield {
'automatic': True,
'title': title,
'filters': [
{'type': 'Story',
'filter_criteria': [
{'title': tag,
'value': tag,
'negative': False,
'field': 'Tags'},
{'value': status,
'negative': False,
'field': 'StoryStatus',
'title': status_title},
]},
],
}
def _get_project_info(url):
# First check to see if it's a local path we can read.
if os.path.isfile(url):
with open(url) as f:
return yaml.safe_load(f)
response = requests.get(url)
data = yaml.safe_load(response.text)
return data
def _find_project(sbc, name):
projects = sbc.projects.get_all(name=name)
if projects:
return projects[0]
else:
raise ValueError('Could not find project {}'.format(name))
def _update_tags(sbc, story, tag):
tags = set(story.tags or [])
if tag in tags:
return
if not tag:
return
LOG.info('adding tag %s', tag)
tags.add(tag)
if None in tags:
tags.remove(None)
try:
story.tags_manager.update(list(tags))
except Exception as err:
LOG.info(err)
def main():
parser = argparse.ArgumentParser()
config_dir = appdirs.user_config_dir('OSGoalTools', 'OpenStack')
config_file = os.path.join(config_dir, 'storyboard.ini')
parser.add_argument(
'--config-file',
default=config_file,
help='configuration file (%(default)s)',
)
parser.add_argument(
'--project-list',
default='http://git.openstack.org/cgit/openstack/governance/plain/reference/projects.yaml', # noqa
help='URL or file path for governance projects.yaml list '
'(%(default)s)',
)
group = parser.add_mutually_exclusive_group()
group.add_argument(
'-v',
help='verbose mode',
dest='log_level',
default=logging.INFO,
action='store_const',
const=logging.DEBUG,
)
group.add_argument(
'-q',
help='quiet mode',
dest='log_level',
action='store_const',
const=logging.WARNING,
)
story_group = parser.add_mutually_exclusive_group()
story_group.add_argument(
'--story',
help='ID of an existing story to use',
)
story_group.add_argument(
'--separate-stories',
default=False,
action='store_true',
help='create a story per project and task per repo',
)
parser.add_argument(
'--add-board',
default=False,
action='store_true',
help='create a board as well as the story and tasks',
)
parser.add_argument(
'--tag',
help='provide a tag for the stories',
)
parser.add_argument(
'goal_url',
help='published HTML page describing the goal',
)
args = parser.parse_args()
warnings.filterwarnings(
'ignore',
'.*Unverified HTTPS request is being made.*',
)
logging.basicConfig(level=args.log_level, format='%(message)s')
config = storyboard.get_config(args.config_file)
try:
LOG.debug('reading goal info from {}'.format(args.goal_url))
goal_info = goals.get_info(args.goal_url)
except Exception as err:
parser.error(err)
full_description = (goal_info['description'] +
'\n\n' +
goal_info['url'])
try:
LOG.debug('reading project list from {}'.format(args.project_list))
project_info = _get_project_info(args.project_list)
except Exception as err:
parser.error(err)
project_names = sorted(project_info.keys(), key=lambda x: x.lower())
try:
sbc = storyboard.get_client(config)
except Exception as err:
parser.error(err)
try:
governance_project = _find_project(sbc, _GOVERNANCE_PROJECT_NAME)
except ValueError:
parser.error('Could not find governance project {}'.format(
_GOVERNANCE_PROJECT_NAME))
print('Governance project {} with id {}'.format(
governance_project.name, governance_project.id))
print('Goal: {}\n\n{}\n'.format(goal_info['title'],
goal_info['description']))
urls_to_show = []
if not args.separate_stories:
# One story with a task per project team.
if args.story:
LOG.info('using specified story')
story = sbc.stories.get(args.story)
else:
story = storyboard.find_or_create_story(
sbc=sbc,
title=goal_info['title'],
description=full_description,
)
_update_tags(sbc, story, args.tag)
urls_to_show.append(_STORY_URL_TEMPLATE.format(story.id))
existing_tasks = {
task.title: task
for task in story.tasks.get_all()
}
for project_name in project_names:
if project_name not in existing_tasks:
LOG.info('adding task for %s', project_name)
# NOTE(dhellmann): We always use the governance
# repository for these tasks because a team does not
# have a main repository.
sbc.tasks.create(
title=project_name,
project_id=governance_project.id,
story_id=story.id,
)
else:
LOG.info('already have task for %s', project_name)
else:
# One story per project team with a task per repo.
for project_name in project_names:
deliverables = project_info[project_name]['deliverables'].items()
story = storyboard.find_or_create_story(
sbc=sbc,
title='{}: {}'.format(project_name, goal_info['title']),
description=(goal_info['description'] +
'\n\n' +
goal_info['url'])
)
_update_tags(sbc, story, args.tag)
urls_to_show.append(_STORY_URL_TEMPLATE.format(story.id))
existing_tasks = {
task.title: task
for task in story.tasks.get_all()
}
for d_name, d_info in sorted(deliverables):
LOG.info('processing %s - %s', project_name, d_name)
for repo in d_info['repos']:
title = '{} - {}'.format(project_name, repo)
if title not in existing_tasks:
# Try to attach the task to the repository and
# fall back to the governance repository if
# storyboard doesn't know about the repo.
try:
sb_project = _find_project(sbc, repo)
except ValueError:
sb_project = governance_project
LOG.info('adding task for %s (%s)',
title, sb_project.name)
sbc.tasks.create(
title=title,
project_id=sb_project.id,
story_id=story.id,
)
print()
if args.add_board:
existing = sbc.boards.get_all(title=goal_info['title'])
if not existing:
lanes = []
for position, worklist_settings in enumerate(
_get_worklist_settings(args.tag)):
title = worklist_settings['title']
LOG.debug('creating {} worklist'.format(title))
new_worklist = sbc.worklists.create(**worklist_settings)
lanes.append({
'position': position,
'list_id': str(new_worklist.id),
})
LOG.info('creating new board')
board = sbc.boards.create(
title=goal_info['title'],
description=full_description,
lanes=lanes,
)
LOG.info('created board {}'.format(board.id))
else:
board = existing[0]
LOG.info('found existing board {}'.format(board.id))
urls_to_show.append(_BOARD_URL_TEMPLATE.format(board.id))
for url in urls_to_show:
print(url)
return 0
View Git Blame Copy Permalink