bugzilla: Prefer caching creds in ~/.cache/python-bugzilla/

crobinso · crobinso · commit dd5876ae5387 · 2016-05-24T17:38:55.000-04:00
We still use the old files in ~/.<filename> if they are present, but otherwise we put new files in ~/.cache/python-bugzilla. Additionally add ~/.config/python-bugzilla/bugzillarc as the preferred rcfile. Resolves #4
diff --git a/bin/bugzilla b/bin/bugzilla
@@ -550,19 +550,20 @@ should work, like --bug_status becomes %{bug_status}, etc.
 .SH AUTHENTICATION COOKIES AND TOKENS
 
 Older bugzilla instances use cookie-based authentication, and
-bugzilla.redhat.com uses a non-cookie token system.
+newer bugzilla instances (around 5.0) use a non-cookie token system.
 
 When you log into bugzilla with the "login" subcommand or the "--login"
-argument, we cache the cookie in ~/.bugzillacookies. If you are using
-bugzilla.redhat.com, we also cache the token in ~/.bugzillatoken.
+argument, we cache the login credentials in ~/.cache/python-bugzilla/
+Previously we cached credentials in ~/.<filename>. If you want to see
+which file the tool is using, check --debug output.
 
 To perform an authenticated bugzilla command on a new machine, run a one time
 "bugzilla login" to cache credentials before running the desired command. You
 can also run "bugzilla --login" and the login process will be initiated before
 invoking the command.
 
 Additionally, the --no-cache-credentials option will tell the bugzilla tool to
-_not_ save any credentials to ~/.bugzillacookies or ~/.bugzillatoken.
+_not_ save any credentials in $HOME, or use any previously cached credentials.
 
 .SH EXAMPLES
 .PP
diff --git a/bugzilla/base.py b/bugzilla/base.py
@@ -72,6 +72,24 @@ def _detect_filetype(fname):
     return None
 
 
+def _default_auth_location(filename):
+    """
+    Determine auth location for filename, like 'bugzillacookies'. If
+    old style ~/.bugzillacookies exists, we use that, otherwise we
+    use ~/.cache/python-bugzilla/bugzillacookies. Same for bugzillatoken
+    """
+    homepath = os.path.expanduser("~/.%s" % filename)
+    xdgpath = os.path.expanduser("~/.cache/python-bugzilla/%s" % filename)
+    if os.path.exists(xdgpath):
+        return xdgpath
+    if os.path.exists(homepath):
+        return homepath
+
+    if not os.path.exists(os.path.dirname(xdgpath)):
+        os.makedirs(os.path.dirname(xdgpath), 0o700)
+    return xdgpath
+
+
 def _build_cookiejar(cookiefile):
     cj = MozillaCookieJar(cookiefile)
     if cookiefile is None:
@@ -137,9 +155,12 @@ class Bugzilla(object):
     get cookies this way, you will be considered logged in until the cookie
     expires.
 
-    You may also specify 'user' and 'password' in a bugzillarc file, either
-    /etc/bugzillarc or ~/.bugzillarc. The latter will override the former.
-    The format works like this:
+    You may also specify 'user' and 'password' in a bugzillarc file. The
+    locations are preferred in this order:
+      ~/.config/python-bugzilla/bugzillarc
+      ~/.bugzillarc
+      /etc/bugzillarc
+    It has content like:
       [bugzilla.yoursite.com]
       user = username
       password = password
@@ -249,16 +270,17 @@ def __init__(self, url=-1, user=None, password=None, cookiefile=-1,
         self._field_aliases = []
         self._init_field_aliases()
 
-        self.configpath = ['/etc/bugzillarc', '~/.bugzillarc']
+        self.configpath = ['/etc/bugzillarc', '~/.bugzillarc',
+                           '~/.config/python-bugzilla/bugzillarc']
         if not use_creds:
             cookiefile = None
             tokenfile = None
             self.configpath = []
 
         if cookiefile == -1:
-            cookiefile = os.path.expanduser('~/.bugzillacookies')
+            cookiefile = _default_auth_location("bugzillacookies")
         if tokenfile == -1:
-            tokenfile = os.path.expanduser("~/.bugzillatoken")
+            tokenfile = _default_auth_location("bugzillatoken")
         log.debug("Using tokenfile=%s", tokenfile)
         self.cookiefile = cookiefile
         self.tokenfile = tokenfile
diff --git a/tests/rw_functional.py b/tests/rw_functional.py
@@ -65,7 +65,7 @@ class RHPartnerTest(BaseTest):
     # Despite its name, this instance is simply for bugzilla testing,
     # doesn't send out emails and is blown away occasionally. The front
     # page has some info.
-    url = tests.REDHAT_URL or "https://partner-bugzilla.redhat.com/xmlrpc.cgi"
+    url = tests.REDHAT_URL or "partner-bugzilla.redhat.com"
     bzclass = bugzilla.RHBugzilla
 
 
@@ -78,22 +78,24 @@ def _check_have_admin(self, bz, funcname):
             print("\nNo admin privs, reduced testing of %s" % funcname)
         return ret
 
-    def _check_rh_privs(self, bz, funcname, authtype, quiet=False):
-        noprivs = bool(bz.getbugs([184858]) == [None])
-        if noprivs and not quiet:
-            print("\nNo RH %s privs, skipping %s" % (authtype, funcname))
-        return not noprivs
+    test2 = BaseTest._testBZClass
 
 
-    test1 = BaseTest._testCookieOrToken
-    test2 = BaseTest._testBZClass
+    def test00LoginState(self):
+        bz = self.bzclass(url=self.url)
+        self.assertTrue(bz.logged_in,
+            "R/W tests require cached login credentials for url=%s" % self.url)
+
+        bz = self.bzclass(url=self.url, use_creds=False)
+        self.assertFalse(bz.logged_in,
+            "Login state check failed for logged out user.")
 
 
     def test03NewBugBasic(self):
         """
         Create a bug with minimal amount of fields, then close it
         """
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         component = "python-bugzilla"
         version = "rawhide"
         summary = ("python-bugzilla test basic bug %s" %
@@ -131,7 +133,7 @@ def test04NewBugAllFields(self):
         """
         Create a bug using all 'new' fields, check some values, close it
         """
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
 
         summary = ("python-bugzilla test manyfields bug %s" %
                    datetime.datetime.today())
@@ -195,7 +197,7 @@ def test05ModifyStatus(self):
         """
         Modify status and comment fields for an existing bug
         """
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         bugid = "663674"
         cmd = "bugzilla modify %s " % bugid
 
@@ -282,7 +284,7 @@ def test06ModifyEmails(self):
         """
         Modify cc, assignee, qa_contact for existing bug
         """
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         bugid = "663674"
         cmd = "bugzilla modify %s " % bugid
 
@@ -330,7 +332,7 @@ def test07ModifyMultiFlags(self):
         """
         Modify flags and fixed_in for 2 bugs
         """
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         bugid1 = "461686"
         bugid2 = "461687"
         cmd = "bugzilla modify %s %s " % (bugid1, bugid2)
@@ -406,7 +408,7 @@ def cleardict(b):
     def test07ModifyMisc(self):
         bugid = "461686"
         cmd = "bugzilla modify %s " % bugid
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         bug = bz.getbug(bugid)
 
         # modify --dependson
@@ -508,7 +510,7 @@ def _test8Attachments(self):
         """
         Get and set attachments for a bug
         """
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         getallbugid = "663674"
         setbugid = "461686"
         cmd = "bugzilla attach "
@@ -585,7 +587,7 @@ def _test8Attachments(self):
 
 
     def test09Whiteboards(self):
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         bug_id = "663674"
         cmd = "bugzilla modify %s " % bug_id
         bug = bz.getbug(bug_id)
@@ -687,19 +689,9 @@ def fakegetpass(prompt):
             getpass.getpass = oldgetpass
 
 
-    def test10LoginState(self):
-        bz = self.bzclass(url=self.url, use_creds=False)
-        self.assertFalse(bz.logged_in,
-            "Login state check failed for logged out user.")
-
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
-        self.assertTrue(bz.logged_in,
-            "Login state check failed for logged in user.")
-
-
     def test11UserUpdate(self):
         # This won't work if run by the same user we are using
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         email = "anaconda-maint-list@redhat.com"
         group = "fedora_contrib"
 
@@ -761,7 +753,7 @@ def test11UserUpdate(self):
 
 
     def test11ComponentEditing(self):
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         component = ("python-bugzilla-testcomponent-%s" %
                      str(random.randint(1, 1024 * 1024 * 1024)))
         basedata = {
@@ -833,11 +825,7 @@ def compare(data, newid):
 
     def test12SetCookie(self):
         bz = self.bzclass("partner-bugzilla.redhat.com",
-            cookiefile=cf, tokenfile=None)
-
-        fn = sys._getframe().f_code.co_name  # pylint: disable=protected-access
-        if not self._check_rh_privs(bz, "cookie", fn):
-            return
+            cookiefile=-1, tokenfile=None)
 
         try:
             bz.cookiefile = None
@@ -850,11 +838,10 @@ def test12SetCookie(self):
         bz.disconnect()
         bz.cookiefile = None
         bz.connect()
-        self.assertFalse(bool(self._check_rh_privs(
-            bz, "", "cookie", quiet=True)))
+        self.assertFalse(bz.logged_in)
 
     def test13SubComponents(self):
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         # Long closed RHEL5 lvm2 bug. This component has sub_components
         bug = bz.getbug("185526")
         bug.autorefresh = True
@@ -871,13 +858,13 @@ def test13SubComponents(self):
         self.assertEqual(bug.sub_components, {})
 
     def _deleteAllExistingExternalTrackers(self, bugid):
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         ids = [bug['id'] for bug in bz.getbug(bugid).external_bugs]
         if ids != []:
             bz.remove_external_tracker(ids=ids)
 
     def test14ExternalTrackersQuery(self):
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         bugid = 461686
         ext_bug_id = 1234659
 
@@ -925,7 +912,7 @@ def test14ExternalTrackersQuery(self):
         assert bugid in [qr.id for qr in query_results]
 
     def test14ExternalTrackersAddUpdateRemoveQuery(self):
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         bugid = 461686
         ext_bug_id = 380489
 
@@ -973,14 +960,14 @@ def test14ExternalTrackersAddUpdateRemoveQuery(self):
         assert len(ids) == 0
 
     def test15EnsureLoggedIn(self):
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         comm = "bugzilla --ensure-logged-in query --bug_id 979546"
         tests.clicomm(comm, bz)
 
     def test16ModifyTags(self):
         bugid = "461686"
         cmd = "bugzilla modify %s " % bugid
-        bz = self.bzclass(url=self.url, cookiefile=cf, tokenfile=tf)
+        bz = self.bzclass(url=self.url)
         bug = bz.getbug(bugid)
 
         if bug.tags:
