Merge ~pappacena/launchpad:bugtrackercompo-matching-interface into launchpad:master

[Thiago F. Pappacena]

Renaming source_package_name attribute on BugTrackerComponent to match interface's naming.

Used pycharm renaming tool, and it didn't find any other usage of this attribute. The lp.bugs* seems to be running fine too.

[Colin Watson (cjwatson)]

I see your initial approach was to rename the attribute in the interface instead, but then you reverted that. Could you explain why you decided not to take that approach? Since we already have things like IBugTrackerComponent.distro_source_package and IBugTrackerComponent.component_group, and since the database column name is underscore-separated, the underscore-separated form seems to be a better fit here.

review: Needs Information

1e6a147... by Thiago F. Pappacena on 2020-01-27

Merge branch 'master' into bugtrackercompo-matching-interface

[Thiago F. Pappacena (pappacena)]

cjwatson, I agree that ideally we should change the attributes to underscore-separed style for consistency, but this would break API compatibility (IBugTrackerComponent is exported at webservice.py).

Wouldn't it be a problem?

[Colin Watson (cjwatson)]

The sourcepackagename attribute of IBugTrackerComponent isn't exported; only those attributes with exported() or methods with one of the @export_* decorators are exported.

(If it had been exported, then you could maintain compatibility using exported_as='sourcepackagename'; but that isn't necessary here.)

[Thiago F. Pappacena (pappacena)]

Ah, right! I'm aware of the exported* now, but I didn't know about it when I opened the MP.

I'll rename it at interface level now.

c780af8... by Thiago F. Pappacena on 2020-01-27

renaming BugTrackerComponent.sourcepackagename to use underscores

[Colin Watson (cjwatson)]

review: Approve

diff --git a/lib/lp/bugs/browser/bugtracker.py b/lib/lp/bugs/browser/bugtracker.py
index 25e8510..88ca12b 100644
--- a/lib/lp/bugs/browser/bugtracker.py
+++ b/lib/lp/bugs/browser/bugtracker.py
@@ -1,4 +1,4 @@
-# Copyright 2009-2018 Canonical Ltd.  This software is licensed under the
+# Copyright 2009-2020 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Bug tracker views."""
@@ -466,8 +466,8 @@ class BugTrackerEditComponentView(LaunchpadEditFormView):
     linked to source packages in the Ubuntu distribution.
     """
     schema = IBugTrackerComponent
-    custom_widget_sourcepackagename = UbuntuSourcePackageNameWidget
-    field_names = ['sourcepackagename']
+    custom_widget_source_package_name = UbuntuSourcePackageNameWidget
+    field_names = ['source_package_name']
     page_title = 'Link component'
 
     @property
@@ -479,10 +479,10 @@ class BugTrackerEditComponentView(LaunchpadEditFormView):
     @property
     def initial_values(self):
         """See `LaunchpadFormView.`"""
-        field_values = dict(sourcepackagename='')
+        field_values = dict(source_package_name='')
         dsp = self.context.distro_source_package
         if dsp is not None:
-            field_values['sourcepackagename'] = dsp.name
+            field_values['source_package_name'] = dsp.name
         return field_values
 
     @property
@@ -498,24 +498,24 @@ class BugTrackerEditComponentView(LaunchpadEditFormView):
         look it up in Ubuntu to retrieve the distro_source_package
         object, and link it to this component.
         """
-        sourcepackagename = data['sourcepackagename']
-        distribution = self.widgets['sourcepackagename'].getDistribution()
-        dsp = distribution.getSourcePackage(sourcepackagename)
+        source_package_name = data['source_package_name']
+        distribution = self.widgets['source_package_name'].getDistribution()
+        dsp = distribution.getSourcePackage(source_package_name)
         bug_tracker = self.context.component_group.bug_tracker
         # Has this source package already been assigned to a component?
         component = bug_tracker.getRemoteComponentForDistroSourcePackageName(
-            distribution, sourcepackagename)
+            distribution, source_package_name)
         if component is not None:
             self.request.response.addNotification(
                 "The %s source package is already linked to %s:%s in %s." % (
-                    sourcepackagename.name,
+                    source_package_name.name,
                     component.component_group.name,
                     component.name, distribution.name))
             return
         # The submitted component can be linked to the distro source package.
         component = context or self.context
         component.distro_source_package = dsp
-        if sourcepackagename is None:
+        if source_package_name is None:
             self.request.response.addNotification(
                 "%s:%s is now unlinked." % (
                     component.component_group.name, component.name))
@@ -523,7 +523,7 @@ class BugTrackerEditComponentView(LaunchpadEditFormView):
             self.request.response.addNotification(
                 "%s:%s is now linked to the %s source package in %s." % (
                     component.component_group.name, component.name,
-                    sourcepackagename.name, distribution.name))
+                    source_package_name.name, distribution.name))
 
     @action('Save Changes', name='save')
     def save_action(self, action, data):
diff --git a/lib/lp/bugs/browser/tests/test_bugtracker_component.py b/lib/lp/bugs/browser/tests/test_bugtracker_component.py
index a80c254..5d24556 100644
--- a/lib/lp/bugs/browser/tests/test_bugtracker_component.py
+++ b/lib/lp/bugs/browser/tests/test_bugtracker_component.py
@@ -1,4 +1,4 @@
-# Copyright 2010-2016 Canonical Ltd.  This software is licensed under the
+# Copyright 2010-2020 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version (see the file LICENSE).
 
 """Unit tests for linking bug tracker components to source packages."""
@@ -36,7 +36,7 @@ class BugTrackerEditComponentViewTextCase(TestCaseWithFactory):
         else:
             name = sourcepackage.name
         return {
-            'field.sourcepackagename': name,
+            'field.source_package_name': name,
             'field.actions.save': 'Save',
             }
 
@@ -57,7 +57,7 @@ class BugTrackerEditComponentViewTextCase(TestCaseWithFactory):
         label = 'Link a distribution source package to Example component'
         self.assertEqual(label, view.label)
         self.assertEqual('Link component', view.page_title)
-        self.assertEqual(['sourcepackagename'], view.field_names)
+        self.assertEqual(['source_package_name'], view.field_names)
         url = canonical_url(component.component_group.bug_tracker)
         self.assertEqual(url, view.next_url)
         self.assertEqual(url, view.cancel_url)
diff --git a/lib/lp/bugs/interfaces/bugtracker.py b/lib/lp/bugs/interfaces/bugtracker.py
index e2414e9..b0e06fa 100644
--- a/lib/lp/bugs/interfaces/bugtracker.py
+++ b/lib/lp/bugs/interfaces/bugtracker.py
@@ -1,4 +1,4 @@
-# Copyright 2009-2019 Canonical Ltd.  This software is licensed under the
+# Copyright 2009-2020 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Bug tracker interfaces."""
@@ -576,7 +576,7 @@ class IBugTrackerComponent(Interface):
             title=_('Name'),
             description=_("The name of a software component "
                           "as shown in Launchpad.")))
-    sourcepackagename = Choice(
+    source_package_name = Choice(
         title=_("Package"), required=False, vocabulary='SourcePackageName')
     distribution = Choice(
         title=_("Distribution"), required=False, vocabulary='Distribution')
diff --git a/lib/lp/bugs/model/bugtracker.py b/lib/lp/bugs/model/bugtracker.py
index 05a2e8f..fe10f33 100644
--- a/lib/lp/bugs/model/bugtracker.py
+++ b/lib/lp/bugs/model/bugtracker.py
@@ -1,4 +1,4 @@
-# Copyright 2009-2019 Canonical Ltd.  This software is licensed under the
+# Copyright 2009-2020 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 __metaclass__ = type
@@ -731,7 +731,7 @@ class BugTracker(SQLBase):
             BugTrackerComponent,
             BugTrackerComponent.distribution == distribution.id,
             BugTrackerComponent.source_package_name ==
-                dsp.sourcepackagename.id).one()
+            dsp.sourcepackagename.id).one()
 
     def getRelatedPillars(self, user=None):
         """See `IBugTracker`."""