config: read configs from directories in lexicographical order

Mercurial currently reads the .rc files specified in HGRCPATH (and the
system-default paths) in directory order, which is unspecified. My
team at work maintains a set of .rc files. So far there has been no
overlap between them, so we had not noticed this behavior. However, we
would now like to release some common .rc files and then have another
one per plaform with platform-specific overrides. It would be nice if
we can determine the load order by choosing names carefully. This
patch enables that by loading the .rc files in lexicographical order.

Before this patch, the added test case would consistently say "30" on
my file system (whatever I have -- some Linux FS).

Differential Revision: https://phab.mercurial-scm.org/D6193

mercurial/rcutil.py

@@ -1,98 +1,99 b''
 # rcutil.py - utilities about config paths, special config sections etc.
 #
 #  Copyright Mercurial Contributors
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 
 from __future__ import absolute_import
 
 import os
 
 from . import (
     encoding,
     pycompat,
     util,
 )
 
 if pycompat.iswindows:
     from . import scmwindows as scmplatform
 else:
     from . import scmposix as scmplatform
 
 fallbackpager = scmplatform.fallbackpager
 systemrcpath = scmplatform.systemrcpath
 userrcpath = scmplatform.userrcpath
 
 def _expandrcpath(path):
     '''path could be a file or a directory. return a list of file paths'''
     p = util.expandpath(path)
     if os.path.isdir(p):
         join = os.path.join
-        return [join(p, f) for f, k in util.listdir(p) if f.endswith('.rc')]
+        return sorted(join(p, f) for f, k in util.listdir(p)
+                      if f.endswith('.rc'))
     return [p]
 
 def envrcitems(env=None):
     '''Return [(section, name, value, source)] config items.
 
     The config items are extracted from environment variables specified by env,
     used to override systemrc, but not userrc.
 
     If env is not provided, encoding.environ will be used.
     '''
     if env is None:
         env = encoding.environ
     checklist = [
         ('EDITOR', 'ui', 'editor'),
         ('VISUAL', 'ui', 'editor'),
         ('PAGER', 'pager', 'pager'),
     ]
     result = []
     for envname, section, configname in checklist:
         if envname not in env:
             continue
         result.append((section, configname, env[envname], '$%s' % envname))
     return result
 
 def defaultrcpath():
     '''return rc paths in default.d'''
     path = []
     defaultpath = os.path.join(util.datapath, 'default.d')
     if os.path.isdir(defaultpath):
         path = _expandrcpath(defaultpath)
     return path
 
 def rccomponents():
     '''return an ordered [(type, obj)] about where to load configs.
 
     respect $HGRCPATH. if $HGRCPATH is empty, only .hg/hgrc of current repo is
     used. if $HGRCPATH is not set, the platform default will be used.
 
     if a directory is provided, *.rc files under it will be used.
 
     type could be either 'path' or 'items', if type is 'path', obj is a string,
     and is the config file path. if type is 'items', obj is a list of (section,
     name, value, source) that should fill the config directly.
     '''
     envrc = ('items', envrcitems())
 
     if 'HGRCPATH' in encoding.environ:
         # assume HGRCPATH is all about user configs so environments can be
         # overridden.
         _rccomponents = [envrc]
         for p in encoding.environ['HGRCPATH'].split(pycompat.ospathsep):
             if not p:
                 continue
             _rccomponents.extend(('path', p) for p in _expandrcpath(p))
     else:
         normpaths = lambda paths: [('path', os.path.normpath(p)) for p in paths]
         _rccomponents = normpaths(defaultrcpath() + systemrcpath())
         _rccomponents.append(envrc)
         _rccomponents.extend(normpaths(userrcpath()))
     return _rccomponents
 
 def defaultpagerenv():
     '''return a dict of default environment variables and their values,
     intended to be set before starting a pager.
     '''
     return {'LESS': 'FRX', 'LV': '-c'}

tests/test-config.t

@@ -1,213 +1,222 b''
 hide outer repo
   $ hg init
 
 Invalid syntax: no value
 
   $ cat > .hg/hgrc << EOF
   > novaluekey
   > EOF
   $ hg showconfig
   hg: parse error at $TESTTMP/.hg/hgrc:1: novaluekey
   [255]
 
 Invalid syntax: no key
 
   $ cat > .hg/hgrc << EOF
   > =nokeyvalue
   > EOF
   $ hg showconfig
   hg: parse error at $TESTTMP/.hg/hgrc:1: =nokeyvalue
   [255]
 
 Test hint about invalid syntax from leading white space
 
   $ cat > .hg/hgrc << EOF
   >  key=value
   > EOF
   $ hg showconfig
   hg: parse error at $TESTTMP/.hg/hgrc:1:  key=value
   unexpected leading whitespace
   [255]
 
   $ cat > .hg/hgrc << EOF
   >  [section]
   > key=value
   > EOF
   $ hg showconfig
   hg: parse error at $TESTTMP/.hg/hgrc:1:  [section]
   unexpected leading whitespace
   [255]
 
 Reset hgrc
 
   $ echo > .hg/hgrc
 
 Test case sensitive configuration
 
   $ cat <<EOF >> $HGRCPATH
   > [Section]
   > KeY = Case Sensitive
   > key = lower case
   > EOF
 
   $ hg showconfig Section
   Section.KeY=Case Sensitive
   Section.key=lower case
 
   $ hg showconfig Section -Tjson
   [
    {
     "name": "Section.KeY",
     "source": "*.hgrc:*", (glob)
     "value": "Case Sensitive"
    },
    {
     "name": "Section.key",
     "source": "*.hgrc:*", (glob)
     "value": "lower case"
    }
   ]
   $ hg showconfig Section.KeY -Tjson
   [
    {
     "name": "Section.KeY",
     "source": "*.hgrc:*", (glob)
     "value": "Case Sensitive"
    }
   ]
   $ hg showconfig -Tjson | tail -7
    },
    {
     "name": "*", (glob)
     "source": "*", (glob)
     "value": "*" (glob)
    }
   ]
 
 Test empty config source:
 
   $ cat <<EOF > emptysource.py
   > def reposetup(ui, repo):
   >     ui.setconfig(b'empty', b'source', b'value')
   > EOF
   $ cp .hg/hgrc .hg/hgrc.orig
   $ cat <<EOF >> .hg/hgrc
   > [extensions]
   > emptysource = `pwd`/emptysource.py
   > EOF
 
   $ hg config --debug empty.source
   read config from: * (glob)
   none: value
   $ hg config empty.source -Tjson
   [
    {
     "name": "empty.source",
     "source": "",
     "value": "value"
    }
   ]
 
   $ cp .hg/hgrc.orig .hg/hgrc
 
 Test "%unset"
 
   $ cat >> $HGRCPATH <<EOF
   > [unsettest]
   > local-hgrcpath = should be unset (HGRCPATH)
   > %unset local-hgrcpath
   > 
   > global = should be unset (HGRCPATH)
   > 
   > both = should be unset (HGRCPATH)
   > 
   > set-after-unset = should be unset (HGRCPATH)
   > EOF
 
   $ cat >> .hg/hgrc <<EOF
   > [unsettest]
   > local-hgrc = should be unset (.hg/hgrc)
   > %unset local-hgrc
   > 
   > %unset global
   > 
   > both = should be unset (.hg/hgrc)
   > %unset both
   > 
   > set-after-unset = should be unset (.hg/hgrc)
   > %unset set-after-unset
   > set-after-unset = should be set (.hg/hgrc)
   > EOF
 
   $ hg showconfig unsettest
   unsettest.set-after-unset=should be set (.hg/hgrc)
 
 Test exit code when no config matches
 
   $ hg config Section.idontexist
   [1]
 
 sub-options in [paths] aren't expanded
 
   $ cat > .hg/hgrc << EOF
   > [paths]
   > foo = ~/foo
   > foo:suboption = ~/foo
   > EOF
 
   $ hg showconfig paths
   paths.foo:suboption=~/foo
   paths.foo=$TESTTMP/foo
 
 edit failure
 
   $ HGEDITOR=false hg config --edit
   abort: edit failed: false exited with status 1
   [255]
 
 config affected by environment variables
 
   $ EDITOR=e1 VISUAL=e2 hg config --debug | grep 'ui\.editor'
   $VISUAL: ui.editor=e2
 
   $ VISUAL=e2 hg config --debug --config ui.editor=e3 | grep 'ui\.editor'
   --config: ui.editor=e3
 
   $ PAGER=p1 hg config --debug | grep 'pager\.pager'
   $PAGER: pager.pager=p1
 
   $ PAGER=p1 hg config --debug --config pager.pager=p2 | grep 'pager\.pager'
   --config: pager.pager=p2
 
 verify that aliases are evaluated as well
 
   $ hg init aliastest
   $ cd aliastest
   $ cat > .hg/hgrc << EOF
   > [ui]
   > user = repo user
   > EOF
   $ touch index
   $ unset HGUSER
   $ hg ci -Am test
   adding index
   $ hg log --template '{author}\n'
   repo user
   $ cd ..
 
 alias has lower priority
 
   $ hg init aliaspriority
   $ cd aliaspriority
   $ cat > .hg/hgrc << EOF
   > [ui]
   > user = alias user
   > username = repo user
   > EOF
   $ touch index
   $ unset HGUSER
   $ hg ci -Am test
   adding index
   $ hg log --template '{author}\n'
   repo user
   $ cd ..
+
+configs should be read in lexicographical order
+
+  $ mkdir configs
+  $ for i in `$TESTDIR/seq.py 10 99`; do
+  >    printf "[section]\nkey=$i" > configs/$i.rc
+  > done
+  $ HGRCPATH=configs hg config section.key
+  99