bugzilla: Switch bug_autorefresh default to False

crobinso · crobinso · commit 7fd3328bb46b · 2016-05-24T16:47:50.000-04:00
The bug_autorefresh behavior is not a good idea as a default. It's been this way forever but it's time to change. While it makes writing the code slightly easier, it's really easy to make scripts incredibly non-performant scripts, which has come up in many different instances. Extend the error message for missing attributes to try and hint at the solution as well. https://bugzilla.redhat.com/show_bug.cgi?id=1297637
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -244,7 +244,7 @@ def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
         self._cookiejar = None
         self._sslverify = sslverify
         self._cache = _BugzillaAPICache()
-        self._bug_autorefresh = True
+        self._bug_autorefresh = False
 
         self._field_aliases = []
         self._init_field_aliases()
diff --git a/bugzilla/bug.py b/bugzilla/bug.py
@@ -25,7 +25,7 @@ class Bug(object):
                       you can read any attributes or make modifications to this
                       bug.
     '''
-    def __init__(self, bugzilla, bug_id=None, dict=None, autorefresh=True):
+    def __init__(self, bugzilla, bug_id=None, dict=None, autorefresh=False):
         # pylint: disable=redefined-builtin
         # API had pre-existing issue that we can't change ('dict' usage)
 
@@ -102,7 +102,12 @@ def __getattr__(self, name):
             self.refresh(extra_fields=[name])
             refreshed = True
 
-        raise AttributeError("Bug object has no attribute '%s'" % name)
+        msg = ("Bug object has no attribute '%s'." % name)
+        if not self.autorefresh:
+            msg += ("\nIf '%s' is a bugzilla attribute, it may not have "
+                    "been cached when the bug was fetched. You may want "
+                    "to adjust your include_fields for getbug/query." % name)
+        raise AttributeError(msg)
 
     def refresh(self, include_fields=None, exclude_fields=None,
         extra_fields=None):
diff --git a/tests/ro_functional.py b/tests/ro_functional.py
@@ -283,15 +283,23 @@ def testBugFields(self):
     def testBugAutoRefresh(self):
         bz = self.bzclass(self.url, use_creds=False)
 
+        bz.bug_autorefresh = True
+
         bug = bz.query(bz.build_query(bug_id=720773,
             include_fields=["summary"]))[0]
         self.assertTrue(hasattr(bug, "component"))
+        self.assertTrue(bool(bug.component))
 
         bz.bug_autorefresh = False
 
         bug = bz.query(bz.build_query(bug_id=720773,
             include_fields=["summary"]))[0]
         self.assertFalse(hasattr(bug, "component"))
+        try:
+            self.assertFalse(bool(bug.component))
+        except:
+            e = sys.exc_info()[1]
+            self.assertTrue("adjust your include_fields" in str(e))
 
     def testExtraFields(self):
         bz = self.bzclass(self.url, cookiefile=None, tokenfile=None)
diff --git a/tests/rw_functional.py b/tests/rw_functional.py
@@ -158,7 +158,7 @@ def test04NewBugAllFields(self):
         self.assertTrue(len(newout.splitlines()) == 3)
 
         bugid = int(newout.splitlines()[2])
-        bug = bz.getbug(bugid)
+        bug = bz.getbug(bugid, extra_fields=["sub_components"])
         print("\nCreated bugid: %s" % bugid)
 
         self.assertEquals(bug.summary, summary)
@@ -515,7 +515,7 @@ def _test8Attachments(self):
         testfile = "../tests/data/bz-attach-get1.txt"
 
         # Add attachment as CLI option
-        setbug = bz.getbug(setbugid)
+        setbug = bz.getbug(setbugid, extra_fields=["attachments"])
         orignumattach = len(setbug.attachments)
 
         # Add attachment from CLI with mime guessing
@@ -571,6 +571,7 @@ def _test8Attachments(self):
 
         # Get all attachments
         getbug = bz.getbug(getallbugid)
+        getbug.autorefresh = True
         numattach = len(getbug.attachments)
         out = tests.clicomm(cmd + "--getall %s" % getallbugid, bz).splitlines()
 
@@ -856,6 +857,7 @@ def test13SubComponents(self):
         bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
         # Long closed RHEL5 lvm2 bug. This component has sub_components
         bug = bz.getbug("185526")
+        bug.autorefresh = True
         self.assertEquals(bug.component, "lvm2")
 
         bz.update_bugs(bug.id, bz.build_update(
