Merge lp:~jelmer/bzr-pqm/2.5-compat into lp:bzr-pqm

[Jelmer Vernooij]

Fix compatibility with bzr 2.5, which has a different configuration API.

This will simplify the code quite a bit once we can drop support for older bzr versions (< 2.3).

[Vincent Ladeuil (vila)]

You beat me to it ;)

8 +

Spurious.

16 + get = _get_user_option
17 +

Cunning !

42 + if bzrlib_version < (2, 5, 0, 'dev', 5):

(2,5,0,'beta',5) < (2, 5, 0, 'dev', 5)
True

Oops !

I think we should go with just (2,5) instead, people encountering issues
with 2.5 compatibility are likely to 1) use at least 2.5b5 or trunk 2) upgrade to at least 2.5b5 anyway.

51 + sections = []
52 + if branch:
53 + bstore = branch._get_config_store()
54 + sections.append(_mod_config.NameMatcher(bstore, None).get_sections)
55 if public_location:
56 - config.add_source(_mod_config.LocationConfig(public_location))
57 - config.add_source(_mod_config.GlobalConfig())
58 + lstore = _mod_config.LocationStore()
59 + sections.append(_mod_config.LocationMatcher(lstore,
60 + public_location).get_sections)
61 + gstore = _mod_config.GlobalStore()
62 + sections.append(_mod_config.NameMatcher(gstore, 'DEFAULT').get_sections)
63 + config = _mod_config.Stack(sections)

This doesn't look correct (locations.conf should override branch,conf when
'branch' is not None and -O also needs to supported), I think we want:

=== modified file 'pqm_submit.py'
--- pqm_submit.py 2012-01-20 00:58:05 +0000
+++ pqm_submit.py 2012-01-20 08:23:21 +0000
@@ -258,17 +258,12 @@
                 config.add_source(_mod_config.LocationConfig(public_location))
             config.add_source(_mod_config.GlobalConfig())
     else:
- sections = []
         if branch:
- bstore = branch._get_config_store()
- sections.append(_mod_config.NameMatcher(bstore, None).get_sections)
- if public_location:
- lstore = _mod_config.LocationStore()
- sections.append(_mod_config.LocationMatcher(lstore,
- public_location).get_sections)
- gstore = _mod_config.GlobalStore()
- sections.append(_mod_config.NameMatcher(gstore, 'DEFAULT').get_sections)
- config = _mod_config.Stack(sections)
+ config = branch.get_config_stack()
+ elif public_location:
+ config = _mod_config.LocationStack(public_location)
+ else:
+ config = _mod_config.GlobalStack()

Which still pass the plugin tests.

I've tested these additional changes and pushed them on lp:~bzr-pqm-devel/bzr-pqm/2.5-compat/

If you agree with them, get them, if you don't tweak them and land the result.

review: Needs Fixing

[Jelmer Vernooij (jelmer)]

On 01/20/2012 09:42 AM, Vincent Ladeuil wrote:
> Review: Needs Fixing
>
> You beat me to it ;)
>
> 8 +
>
> Spurious.
>
> 16 + get = _get_user_option
> 17 +
>
> Cunning !
>
> 42 + if bzrlib_version< (2, 5, 0, 'dev', 5):
>
> (2,5,0,'beta',5)< (2, 5, 0, 'dev', 5)
> True
>
> Oops !
>
> I think we should go with just (2,5) instead, people encountering issues
> with 2.5 compatibility are likely to 1) use at least 2.5b5 or trunk 2) upgrade to at least 2.5b5 anyway.
Fair enough.
>
>
> 51 + sections = []
> 52 + if branch:
> 53 + bstore = branch._get_config_store()
> 54 + sections.append(_mod_config.NameMatcher(bstore, None).get_sections)
> 55 if public_location:
> 56 - config.add_source(_mod_config.LocationConfig(public_location))
> 57 - config.add_source(_mod_config.GlobalConfig())
> 58 + lstore = _mod_config.LocationStore()
> 59 + sections.append(_mod_config.LocationMatcher(lstore,
> 60 + public_location).get_sections)
> 61 + gstore = _mod_config.GlobalStore()
> 62 + sections.append(_mod_config.NameMatcher(gstore, 'DEFAULT').get_sections)
> 63 + config = _mod_config.Stack(sections)
>
> This doesn't look correct (locations.conf should override branch,conf when
> 'branch' is not None and -O also needs to supported), I think we want:
It's consistent with the behaviour in the pre-2.5 version of bzr-pqm. I
don't think we should change that.

Cheers,

Jelmer

[Vincent Ladeuil (vila)]

> > This doesn't look correct (locations.conf should override branch,conf when
> > 'branch' is not None and -O also needs to supported), I think we want:

> It's consistent with the behaviour in the pre-2.5 version of bzr-pqm. I
> don't think we should change that.

Yeah, your proposal is bug-compatible but do we need to file a bug first ?

It's a common misconception that branch.conf overrides locations.conf (or that locations.conf provides default values for branch.conf), I'm pretty sure whoever coded that was misled.

[Vincent Ladeuil (vila)]

Meh, I've re-read the original code:

   config = StackedConfig()
    if branch:
        config.add_source(branch.get_config())
    else:
        if public_location:
            config.add_source(_mod_config.LocationConfig(public_location))
        config.add_source(_mod_config.GlobalConfig())

So that's indeed what my fix does, either there is a branch and the usual location/branch/global is in effect or there is a location and it's location/global or there is only global.

[Jelmer Vernooij (jelmer)]

On 01/20/2012 03:17 PM, Vincent Ladeuil wrote:
> Meh, I've re-read the original code:
>
> config = StackedConfig()
> if branch:
> config.add_source(branch.get_config())
> else:
> if public_location:
> config.add_source(_mod_config.LocationConfig(public_location))
> config.add_source(_mod_config.GlobalConfig())
>
> So that's indeed what my fix does, either there is a branch and the usual location/branch/global is in effect or there is a location and it's location/global or there is only global.
Ah, I see. I'll fix my code and land.

Cheers,

Jelmer

=== modified file 'pqm_submit.py'
--- pqm_submit.py	2011-12-16 20:21:06 +0000
+++ pqm_submit.py	2012-01-20 01:00:32 +0000
@@ -211,6 +211,7 @@
     def add_source(self, source):
         self._sources.append(source)
 
+
     def _get_user_option(self, option_name):
         """See Config._get_user_option."""
         for source in self._sources:
@@ -219,6 +220,8 @@
                 return value
         return None
 
+    get = _get_user_option
+
     def _get_user_id(self):
         for source in self._sources:
             value = source._get_user_id()
@@ -233,11 +236,11 @@
     :param local_config: Config object for local branch
     :param submit_location: Location of submit branch
     """
-    mail_to = local_config.get_user_option('pqm_email')
+    mail_to = local_config.get('pqm_email')
     if not mail_to:
         submit_branch = Branch.open(submit_location)
         submit_branch_config = submit_branch.get_config()
-        mail_to = submit_branch_config.get_user_option('child_pqm_email')
+        mail_to = submit_branch_config.get('child_pqm_email')
         if mail_to is None:
             return None
     return mail_to.encode('utf8') # same here
@@ -246,22 +249,35 @@
 def submit(branch, message, dry_run=False, public_location=None,
            submit_location=None, tree=None, ignore_local=False):
     """Submit the given branch to the pqm."""
-    config = StackedConfig()
-    if branch:
-        config.add_source(branch.get_config())
+    if bzrlib_version < (2, 5, 0, 'dev', 5):
+        config = StackedConfig()
+        if branch:
+            config.add_source(branch.get_config())
+        else:
+            if public_location:
+                config.add_source(_mod_config.LocationConfig(public_location))
+            config.add_source(_mod_config.GlobalConfig())
     else:
+        sections = []
+        if branch:
+            bstore = branch._get_config_store()
+            sections.append(_mod_config.NameMatcher(bstore, None).get_sections)
         if public_location:
-            config.add_source(_mod_config.LocationConfig(public_location))
-        config.add_source(_mod_config.GlobalConfig())
+            lstore = _mod_config.LocationStore()
+            sections.append(_mod_config.LocationMatcher(lstore,
+                public_location).get_sections)
+        gstore = _mod_config.GlobalStore()
+        sections.append(_mod_config.NameMatcher(gstore, 'DEFAULT').get_sections)
+        config = _mod_config.Stack(sections)
 
     submission = PQMSubmission(
         source_branch=branch, public_location=public_location, message=message,
         submit_location=submit_location,
         tree=tree)
 
-    mail_from = config.get_user_option('pqm_user_email')
+    mail_from = config.get('pqm_user_email')
     if not mail_from:
-        mail_from = config.username()
+        mail_from = config.get('email')
     mail_from = mail_from.encode('utf8') # Make sure this isn't unicode
     mail_to = pqm_email(config, submit_location)
     if not mail_to:
@@ -273,7 +289,7 @@
 
     message = submission.to_email(mail_from, mail_to)
 
-    mail_bcc = config.get_user_option('pqm_bcc')
+    mail_bcc = config.get('pqm_bcc')
     if mail_bcc is not None:
         message["Bcc"] = mail_bcc