Merge lp:~jcsackett/lp-release-manager-tools/bugs-for-juju-reports into lp:~sinzui/lp-release-manager-tools/trunk

[j.c.sackett]

Breaks up pull_bugs.py so useful functions are importable (e..g by juju-reports)

This branch breaks up the pull_bugs.py functionality into useful functions that can be imported and used in the juju-reports scorecard work. It also contains some drive by fixes in report_branch_contributions.py

pull_bugs.py
============
* Getting launchpad projects via launchpad lib has been broken out into its own function. This takes an lp instance and the project name, so other tools can configure lp as necessary for their needs while pull_bugs continues to create an lp instance suitable for its function.

* Getting bug data has been altered so that it receives a dict of bug search parameters suitable for searchTasks rather than assembling said data from options. The dict is assembled in main() out of the options data.

* options.statuses now defaults to an empty list, and if no data is provided in the command line it uses the default list defined at the top. This fixes a bug wherein desired statuses were appended to the list of all statuses and therefor saw no change in behavior. Now -s Fix Committed will get all bugs that are Fix Committed.

* the service root option has been removed, b/c it wasn't used in the script anywhere.

* various lint fixes have been made.

report_branch_contributions.py
==============================
* Filtering out canonical employees now actually looks at the email address; it was accidentally looking at the unparsed author field before.

* show_branch_contributions takes params now so it can handle the verbose option. It would have failed before.

* various lint fixes.

[Curtis Hovey (sinzui)]

Thank you.

review: Approve (code)

=== modified file 'lp_release_tools/pull_bugs.py'
--- lp_release_tools/pull_bugs.py	2014-01-28 13:39:36 +0000
+++ lp_release_tools/pull_bugs.py	2014-02-13 14:18:58 +0000
@@ -25,10 +25,14 @@
     'Fix Committed',
     'Fix Released',
 ]
+
+
 public_information_types = [
     'Public',
     'Public Security',
 ]
+
+
 private_information_types = [
     'Private',
     'Private Secruity',
@@ -45,14 +49,11 @@
     return previous_bugs
 
 
-def get_bug_data(target, all_bugs, options):
+def get_bug_data(target, all_bugs, search_params, private=False):
     information_types = public_information_types
-    if options.private:
+    if private:
         information_types = information_types + private_information_types
-    found_tasks = target.searchTasks(
-        status=options.statuses, modified_since=options.since,
-        importance=options.importance, milestone=options.milestone,
-        tags=options.tags, tags_combinator='All')
+    found_tasks = target.searchTasks(**search_params)
     count = 0
     for task in found_tasks:
         json_data = dict(task._wadl_resource.representation)
@@ -63,39 +64,14 @@
         json_data[u'bug_tags'] = bug.tags
         all_bugs[bug.id] = json_data
         count += 1
-    print(count)
-
-
-def main():
-    argv = sys.argv
-    parser = get_option_parser()
-    (options, args) = parser.parse_args(args=argv[1:])
-    if len(args) < 1:
-        print(parser.usage)
-        sys.exit(1)
-    project = args[0]
-    lp = Launchpad.login_with(
-        'milestone-report', service_root='https://api.launchpad.net',
-        version='devel')
-    project = lp.projects[project]
-    if options.union_file:
-        all_bugs = get_saved_bug_data(options)
-        print(len(all_bugs))
-    else:
-        all_bugs = {}
+    return count
+
+
+def get_targets(lp, project_name):
+    project = lp.projects[project_name]
     targets = [s for s in project.series]
     targets.insert(0, project)
-    for target in targets:
-        get_bug_data(target, all_bugs, options)
-    print(len(all_bugs))
-    now = datetime.utcnow()
-    json_source = {
-        u'date_retrieved': now.isoformat(' '),
-        u'bugs': all_bugs.values(),
-    }
-    json_data = json.dumps(json_source, indent=0)
-    with open(options.outfile, 'w') as json_file:
-        json_file.write(json_data)
+    return targets
 
 
 def get_option_parser():
@@ -104,9 +80,6 @@
     usage = "usage: %%prog [options] project\n%s" % example
     parser = OptionParser(usage=usage)
     parser.add_option(
-        "-r", "--service-root", dest="root",
-        help="The service to use.")
-    parser.add_option(
         "-o", "--outfile", dest="outfile",
         help="The name of the file to write the json data to.")
     parser.add_option(
@@ -131,7 +104,6 @@
         "-s", "--statuses", dest="statuses", action="append",
         type="string", help="Match bugs with all of the listed statues.")
     parser.set_defaults(
-        root='https://api.launchpad.net',
         outfile='bug-data.json',
         union_file=None,
         since=None,
@@ -139,10 +111,48 @@
         tags=None,
         milestone=None,
         importance=None,
-        statuses=all_bug_statuses
+        statuses=[]
     )
     return parser
 
 
+def main():
+    argv = sys.argv
+    parser = get_option_parser()
+    (options, args) = parser.parse_args(args=argv[1:])
+    if len(args) < 1:
+        print(parser.usage)
+        sys.exit(1)
+    if not options.statuses:
+        options.statuses = all_bug_statuses
+    project = args[0]
+    if options.union_file:
+        all_bugs = get_saved_bug_data(options)
+        print(len(all_bugs))
+    else:
+        all_bugs = {}
+    lp = Launchpad.login_with(
+        'milestone-report',
+        service_root='https://api.launchpad.net',
+        version='devel')
+    targets = get_targets(lp, project)
+    search_params = dict(
+        status=options.statuses, modified_since=options.since,
+        importance=options.importance, milestone=options.milestone,
+        tags=options.tags, tags_combinator='All')
+    for target in targets:
+        count = get_bug_data(target, all_bugs, search_params, options.private)
+        print(count)
+    print(len(all_bugs))
+    now = datetime.utcnow()
+    json_source = {
+        u'date_retrieved': now.isoformat(' '),
+        u'bugs': all_bugs.values(),
+    }
+    json_data = json.dumps(json_source, indent=0)
+    with open(options.outfile, 'w') as json_file:
+        json_file.write(json_data)
+
+
 if __name__ == '__main__':
     sys.exit(main())

=== modified file 'lp_release_tools/report_branch_contributions.py'
--- lp_release_tools/report_branch_contributions.py	2014-01-28 17:15:57 +0000
+++ lp_release_tools/report_branch_contributions.py	2014-02-13 14:18:58 +0000
@@ -41,7 +41,7 @@
         canonical = True
         for author in rev.get_apparent_authors():
             email = parse_username(author)
-            if '@canonical' not in author:
+            if '@canonical' not in email:
                 canonical = False
                 break
         return canonical
@@ -53,7 +53,7 @@
         """
         if self.filter and self._only_canonical_contributors(lr.rev):
             # If we're filtering, and this revision has only canonical
-            # contributors, there's no need to check the revision date. 
+            # contributors, there's no need to check the revision date.
             return
         rev_date = datetime.datetime.fromtimestamp(lr.rev.timestamp)
         if rev_date >= self.start_date and rev_date <= self.end_date:
@@ -113,7 +113,8 @@
     logger.show(log_formatter)
     return log_formatter.matched_revs
 
-def show_contributions(branch, matched_revs, options):
+
+def show_contributions(branch, matched_revs, params, options):
     total_commits = 0
     total_inserts = 0
     total_delta = 0
@@ -159,7 +160,7 @@
     if len(args) == 1:
         start_date = datetime.datetime.strptime(args[0], fmt)
         end_date = datetime.datetime.utcnow()
-    elif len(args) == 2: 
+    elif len(args) == 2:
         start_date = datetime.datetime.strptime(args[0], fmt)
         end_date = datetime.datetime.strptime(args[1], fmt)
     else:
@@ -204,7 +205,7 @@
         log_formatter = AuthorLogFormatter(params)
     matched_revs = get_contributions(
         branch, log_formatter, options.start_revno, options.end_revno)
-    show_contributions(branch, matched_revs, options)
+    show_contributions(branch, matched_revs, params, options)
     return 0