def get_defined_udas_as_strings(conf, main_section):
targets = aslist(conf.get(main_section, 'targets'))
services = set([conf.get(target, 'service') for target in targets])
uda_list = build_uda_config_overrides(services)
for uda in convert_override_args_to_taskrc_settings(uda_list):
yield uda
def __init__(self, main_config, main_section, target):
self.config = ServiceConfig(self.CONFIG_PREFIX, main_config, target)
self.main_section = main_section
self.main_config = main_config
self.target = target
self.desc_len = self._get_config_or_default('description_length', 35,
asint)
self.anno_len = self._get_config_or_default('annotation_length', 45,
asint)
self.inline_links = self._get_config_or_default(
'inline_links', True, asbool)
self.annotation_links = self._get_config_or_default(
'annotation_links', not self.inline_links, asbool)
self.annotation_comments = self._get_config_or_default(
'annotation_comments', True, asbool)
self.shorten = self._get_config_or_default('shorten', False, asbool)
self.default_priority = self._get_config_or_default(
'default_priority', 'M')
self.add_tags = []
for raw_option in aslist(self.config.get('add_tags', '')):
option = raw_option.strip(' +;')
if option:
self.add_tags.append(option)
log.info("Working on [%s]", self.target)
def get_defined_udas_as_strings(conf, main_section):
targets = aslist(conf.get(main_section, 'targets'))
services = set([conf.get(target, 'service') for target in targets])
uda_list = build_uda_config_overrides(services)
for uda in convert_override_args_to_taskrc_settings(uda_list):
yield uda
def run_hooks(conf, name):
if conf.has_option('hooks', name):
pre_import = aslist(conf.get('hooks', name))
if pre_import is not None:
for hook in pre_import:
exit_code = subprocess.call(hook, shell=True)
if exit_code is not 0:
msg = 'Non-zero exit code %d on hook %s' % (exit_code,
hook)
log.error(msg)
raise RuntimeError(msg)
def run_hooks(conf, name):
if conf.has_option('hooks', name):
pre_import = aslist(conf.get('hooks', name))
if pre_import is not None:
for hook in pre_import:
exit_code = subprocess.call(hook, shell=True)
if exit_code is not 0:
msg = 'Non-zero exit code %d on hook %s' % (
exit_code, hook
)
log.error(msg)
raise RuntimeError(msg)
def aggregate_issues(conf, main_section, debug):
""" Return all issues from every target. """
log.info("Starting to aggregate remote issues.")
# Create and call service objects for every target in the config
targets = aslist(conf.get(main_section, 'targets'))
queue = multiprocessing.Queue()
log.info("Spawning %i workers." % len(targets))
processes = []
if debug:
for target in targets:
_aggregate_issues(
conf,
main_section,
target,
queue,
conf.get(target, 'service')
)
else:
for target in targets:
proc = multiprocessing.Process(
target=_aggregate_issues,
args=(conf, main_section, target, queue, conf.get(target, 'service'))
)
proc.start()
processes.append(proc)
# Sleep for 1 second here to try and avoid a race condition where
# all N workers start up and ask the gpg-agent process for
# information at the same time. This causes gpg-agent to fumble
# and tell some of our workers some incomplete things.
time.sleep(1)
currently_running = len(targets)
while currently_running > 0:
issue = queue.get(True)
if isinstance(issue, tuple):
completion_type, args = issue
if completion_type == SERVICE_FINISHED_ERROR:
target, e = args
log.info("Terminating workers")
for process in processes:
process.terminate()
raise RuntimeError(
"critical error in target '{}'".format(target))
currently_running -= 1
continue
yield issue
log.info("Done aggregating remote issues.")
def aggregate_issues(conf, main_section, debug):
""" Return all issues from every target. """
log.info("Starting to aggregate remote issues.")
# Create and call service objects for every target in the config
targets = aslist(conf.get(main_section, 'targets'))
queue = multiprocessing.Queue()
log.info("Spawning %i workers." % len(targets))
processes = []
if debug:
for target in targets:
_aggregate_issues(conf, main_section, target, queue,
conf.get(target, 'service'))
else:
for target in targets:
proc = multiprocessing.Process(target=_aggregate_issues,
args=(conf, main_section, target,
queue,
conf.get(target, 'service')))
proc.start()
processes.append(proc)
# Sleep for 1 second here to try and avoid a race condition where
# all N workers start up and ask the gpg-agent process for
# information at the same time. This causes gpg-agent to fumble
# and tell some of our workers some incomplete things.
time.sleep(1)
currently_running = len(targets)
while currently_running > 0:
issue = queue.get(True)
if isinstance(issue, tuple):
completion_type, args = issue
if completion_type == SERVICE_FINISHED_ERROR:
target, e = args
log.info("Terminating workers")
for process in processes:
process.terminate()
raise RuntimeError(
"critical error in target '{}'".format(target))
currently_running -= 1
continue
yield issue
log.info("Done aggregating remote issues.")
def __init__(self, main_config, main_section, target):
self.config = ServiceConfig(self.CONFIG_PREFIX, main_config, target)
self.main_section = main_section
self.main_config = main_config
self.target = target
self.desc_len = self._get_config_or_default('description_length', 35, asint);
self.anno_len = self._get_config_or_default('annotation_length', 45, asint);
self.inline_links = self._get_config_or_default('inline_links', True, asbool);
self.annotation_links = self._get_config_or_default('annotation_links', not self.inline_links, asbool)
self.annotation_comments = self._get_config_or_default('annotation_comments', True, asbool)
self.shorten = self._get_config_or_default('shorten', False, asbool)
self.default_priority = self._get_config_or_default('default_priority','M')
self.add_tags = []
for raw_option in aslist(self.config.get('add_tags', '')):
option = raw_option.strip(' +;')
if option:
self.add_tags.append(option)
log.info("Working on [%s]", self.target)
def synchronize(issue_generator, conf, main_section, dry_run=False):
def _bool_option(section, option, default):
try:
return asbool(conf.get(section, option))
except (NoSectionError, NoOptionError):
return default
targets = aslist(conf.get(main_section, 'targets'))
services = set([conf.get(target, 'service') for target in targets])
key_list = build_key_list(services)
uda_list = build_uda_config_overrides(services)
if uda_list:
log.info('Service-defined UDAs exist: you can optionally use the '
'`bugwarrior-uda` command to export a list of UDAs you can '
'add to your taskrc file.')
static_fields = ['priority']
if conf.has_option(main_section, 'static_fields'):
static_fields = aslist(conf.get(main_section, 'static_fields'))
# Before running CRUD operations, call the pre_import hook(s).
run_hooks(conf, 'pre_import')
notify = _bool_option('notifications', 'notifications',
False) and not dry_run
tw = TaskWarriorShellout(
config_filename=get_taskrc_path(conf, main_section),
config_overrides=uda_list,
marshal=True,
)
legacy_matching = _bool_option(main_section, 'legacy_matching', False)
merge_annotations = _bool_option(main_section, 'merge_annotations', True)
merge_tags = _bool_option(main_section, 'merge_tags', True)
issue_updates = {
'new': [],
'existing': [],
'changed': [],
'closed': get_managed_task_uuids(tw, key_list, legacy_matching),
}
for issue in issue_generator:
try:
issue_dict = dict(issue)
# We received this issue from The Internet, but we're not sure what
# kind of encoding the service providers may have handed us. Let's try
# and decode all byte strings from UTF8 off the bat. If we encounter
# other encodings in the wild in the future, we can revise the handling
# here. https://github.com/ralphbean/bugwarrior/issues/350
for key in issue_dict.keys():
if isinstance(issue_dict[key], six.binary_type):
try:
issue_dict[key] = issue_dict[key].decode('utf-8')
except UnicodeDecodeError:
log.warn("Failed to interpret %r as utf-8" % key)
existing_uuid = find_local_uuid(tw,
key_list,
issue,
legacy_matching=legacy_matching)
_, task = tw.get_task(uuid=existing_uuid)
# Drop static fields from the upstream issue. We don't want to
# overwrite local changes to fields we declare static.
for field in static_fields:
if field in issue_dict:
del issue_dict[field]
# Merge annotations & tags from online into our task object
if merge_annotations:
merge_left('annotations', task, issue_dict, hamming=True)
if merge_tags:
merge_left('tags', task, issue_dict)
issue_dict.pop('annotations', None)
issue_dict.pop('tags', None)
task.update(issue_dict)
if task.get_changes(keep=True):
issue_updates['changed'].append(task)
else:
issue_updates['existing'].append(task)
if existing_uuid in issue_updates['closed']:
issue_updates['closed'].remove(existing_uuid)
except MultipleMatches as e:
log.exception("Multiple matches: %s", six.text_type(e))
except NotFound:
issue_updates['new'].append(issue_dict)
notreally = ' (not really)' if dry_run else ''
# Add new issues
log.info("Adding %i tasks", len(issue_updates['new']))
for issue in issue_updates['new']:
log.info(u"Adding task %s%s", issue['description'], notreally)
if dry_run:
continue
if notify:
send_notification(issue, 'Created', conf)
try:
tw.task_add(**issue)
except TaskwarriorError as e:
log.exception("Unable to add task: %s" % e.stderr)
log.info("Updating %i tasks", len(issue_updates['changed']))
for issue in issue_updates['changed']:
changes = '; '.join([
'{field}: {f} -> {t}'.format(field=field,
f=repr(ch[0]),
t=repr(ch[1]))
for field, ch in six.iteritems(issue.get_changes(keep=True))
])
log.info("Updating task %s, %s; %s%s", six.text_type(issue['uuid']),
issue['description'], changes, notreally)
if dry_run:
continue
try:
tw.task_update(issue)
except TaskwarriorError as e:
log.exception("Unable to modify task: %s" % e.stderr)
log.info("Closing %i tasks", len(issue_updates['closed']))
for issue in issue_updates['closed']:
_, task_info = tw.get_task(uuid=issue)
log.info("Completing task %s %s%s", issue,
task_info.get('description', ''), notreally)
if dry_run:
continue
if notify:
send_notification(task_info, 'Completed', conf)
try:
tw.task_done(uuid=issue)
except TaskwarriorError as e:
log.exception("Unable to close task: %s" % e.stderr)
# Send notifications
if notify:
only_on_new_tasks = _bool_option('notifications', 'only_on_new_tasks',
False)
if not only_on_new_tasks or len(issue_updates['new']) + len(
issue_updates['changed']) + len(issue_updates['closed']) > 0:
send_notification(
dict(description="New: %d, Changed: %d, Completed: %d" %
(len(issue_updates['new']), len(issue_updates['changed']),
len(issue_updates['closed']))),
'bw_finished',
conf,
)
def synchronize(issue_generator, conf, main_section, dry_run=False):
def _bool_option(section, option, default):
try:
return asbool(conf.get(section, option))
except (NoSectionError, NoOptionError):
return default
targets = aslist(conf.get(main_section, 'targets'))
services = set([conf.get(target, 'service') for target in targets])
key_list = build_key_list(services)
uda_list = build_uda_config_overrides(services)
if uda_list:
log.info(
'Service-defined UDAs exist: you can optionally use the '
'`bugwarrior-uda` command to export a list of UDAs you can '
'add to your taskrc file.'
)
static_fields = ['priority']
if conf.has_option(main_section, 'static_fields'):
static_fields = aslist(conf.get(main_section, 'static_fields'))
# Before running CRUD operations, call the pre_import hook(s).
run_hooks(conf, 'pre_import')
notify = _bool_option('notifications', 'notifications', False) and not dry_run
tw = TaskWarriorShellout(
config_filename=get_taskrc_path(conf, main_section),
config_overrides=uda_list,
marshal=True,
)
legacy_matching = _bool_option(main_section, 'legacy_matching', False)
merge_annotations = _bool_option(main_section, 'merge_annotations', True)
merge_tags = _bool_option(main_section, 'merge_tags', True)
issue_updates = {
'new': [],
'existing': [],
'changed': [],
'closed': get_managed_task_uuids(tw, key_list, legacy_matching),
}
for issue in issue_generator:
try:
issue_dict = dict(issue)
# We received this issue from The Internet, but we're not sure what
# kind of encoding the service providers may have handed us. Let's try
# and decode all byte strings from UTF8 off the bat. If we encounter
# other encodings in the wild in the future, we can revise the handling
# here. https://github.com/ralphbean/bugwarrior/issues/350
for key in issue_dict.keys():
if isinstance(issue_dict[key], six.binary_type):
try:
issue_dict[key] = issue_dict[key].decode('utf-8')
except UnicodeDecodeError:
log.warn("Failed to interpret %r as utf-8" % key)
existing_uuid = find_local_uuid(
tw, key_list, issue, legacy_matching=legacy_matching
)
_, task = tw.get_task(uuid=existing_uuid)
# Drop static fields from the upstream issue. We don't want to
# overwrite local changes to fields we declare static.
for field in static_fields:
if field in issue_dict:
del issue_dict[field]
# Merge annotations & tags from online into our task object
if merge_annotations:
merge_left('annotations', task, issue_dict, hamming=True)
if merge_tags:
merge_left('tags', task, issue_dict)
issue_dict.pop('annotations', None)
issue_dict.pop('tags', None)
task.update(issue_dict)
if task.get_changes(keep=True):
issue_updates['changed'].append(task)
else:
issue_updates['existing'].append(task)
if existing_uuid in issue_updates['closed']:
issue_updates['closed'].remove(existing_uuid)
except MultipleMatches as e:
log.exception("Multiple matches: %s", six.text_type(e))
except NotFound:
issue_updates['new'].append(issue_dict)
notreally = ' (not really)' if dry_run else ''
# Add new issues
log.info("Adding %i tasks", len(issue_updates['new']))
for issue in issue_updates['new']:
log.info(u"Adding task %s%s", issue['description'], notreally)
if dry_run:
continue
if notify:
send_notification(issue, 'Created', conf)
try:
tw.task_add(**issue)
except TaskwarriorError as e:
log.exception("Unable to add task: %s" % e.stderr)
log.info("Updating %i tasks", len(issue_updates['changed']))
for issue in issue_updates['changed']:
changes = '; '.join([
'{field}: {f} -> {t}'.format(
field=field,
f=repr(ch[0]),
t=repr(ch[1])
)
for field, ch in six.iteritems(issue.get_changes(keep=True))
])
log.info(
"Updating task %s, %s; %s%s",
six.text_type(issue['uuid']),
issue['description'],
changes,
notreally
)
if dry_run:
continue
try:
tw.task_update(issue)
except TaskwarriorError as e:
log.exception("Unable to modify task: %s" % e.stderr)
log.info("Closing %i tasks", len(issue_updates['closed']))
for issue in issue_updates['closed']:
_, task_info = tw.get_task(uuid=issue)
log.info(
"Completing task %s %s%s",
issue,
task_info.get('description', ''),
notreally
)
if dry_run:
continue
if notify:
send_notification(task_info, 'Completed', conf)
try:
tw.task_done(uuid=issue)
except TaskwarriorError as e:
log.exception("Unable to close task: %s" % e.stderr)
# Send notifications
if notify:
only_on_new_tasks = _bool_option('notifications', 'only_on_new_tasks', False)
if not only_on_new_tasks or len(issue_updates['new']) + len(issue_updates['changed']) + len(issue_updates['closed']) > 0:
send_notification(
dict(
description="New: %d, Changed: %d, Completed: %d" % (
len(issue_updates['new']),
len(issue_updates['changed']),
len(issue_updates['closed'])
)
),
'bw_finished',
conf,
)
