def test_git_config_warning(path): if 'GIT_AUTHOR_NAME' in os.environ: raise SkipTest("Found existing explicit identity config") with chpwd(path), \ patch.dict('os.environ', get_home_envvars(path)), \ swallow_logs(new_level=30) as cml: # no configs in that empty HOME from datalad.api import Dataset from datalad.config import ConfigManager # reach into the class and disable the "checked" flag that # has already been tripped before we get here ConfigManager._checked_git_identity = False Dataset(path).config.reload() assert_in("configure Git before", cml.out)
def test_git_config_warning(path=None): if 'GIT_AUTHOR_NAME' in os.environ: raise SkipTest("Found existing explicit identity config") # Note: An easier way to test this, would be to just set GIT_CONFIG_GLOBAL # to point somewhere else. However, this is not supported by git before # 2.32. Hence, stick with changed HOME in this test, but be sure to unset a # possible GIT_CONFIG_GLOBAL in addition. patched_env = os.environ.copy() patched_env.pop('GIT_CONFIG_GLOBAL', None) patched_env.update(get_home_envvars(path)) with chpwd(path), \ patch.dict('os.environ', patched_env, clear=True), \ swallow_logs(new_level=30) as cml: # no configs in that empty HOME from datalad.api import Dataset from datalad.config import ConfigManager # reach into the class and disable the "checked" flag that # has already been tripped before we get here ConfigManager._checked_git_identity = False Dataset(path).config.reload() assert_in("configure Git before", cml.out)
def test_something(path=None, new_home=None): # will refuse to work on dataset without a dataset assert_raises(ValueError, ConfigManager, source='branch') # now read the example config cfg = ConfigManager(GitRepo(opj(path, 'ds'), create=True), source='branch') assert_equal(len(cfg), 5) assert_in('something.user', cfg) # multi-value assert_equal(len(cfg['something.user']), 2) assert_equal(cfg['something.user'], ('name=Jane Doe', '[email protected]')) assert_true(cfg.has_section('something')) assert_false(cfg.has_section('somethingelse')) assert_equal(sorted(cfg.sections()), [u'onemore.complicated の beast with.dot', 'something']) assert_true(cfg.has_option('something', 'user')) assert_false(cfg.has_option('something', 'us?er')) assert_false(cfg.has_option('some?thing', 'user')) assert_equal(sorted(cfg.options('something')), ['empty', 'myint', 'novalue', 'user']) assert_equal(cfg.options(u'onemore.complicated の beast with.dot'), ['findme']) assert_equal(sorted(cfg.items()), [(u'onemore.complicated の beast with.dot.findme', '5.0'), ('something.empty', ''), ('something.myint', '3'), ('something.novalue', None), ('something.user', ('name=Jane Doe', '[email protected]'))]) assert_equal(sorted(cfg.items('something')), [('something.empty', ''), ('something.myint', '3'), ('something.novalue', None), ('something.user', ('name=Jane Doe', '[email protected]'))]) # by default get last value only assert_equal(cfg.get('something.user'), '[email protected]') # but can get all values assert_equal(cfg.get('something.user', get_all=True), ('name=Jane Doe', '[email protected]')) assert_raises(KeyError, cfg.__getitem__, 'somedthing.user') assert_equal( cfg.getfloat(u'onemore.complicated の beast with.dot', 'findme'), 5.0) assert_equal(cfg.getint('something', 'myint'), 3) assert_equal(cfg.getbool('something', 'myint'), True) # git demands a key without value at all to be used as a flag, thus True assert_equal(cfg.getbool('something', 'novalue'), True) assert_equal(cfg.get('something.novalue'), None) # empty value is False assert_equal(cfg.getbool('something', 'empty'), False) assert_equal(cfg.get('something.empty'), '') assert_equal(cfg.getbool('doesnot', 'exist', default=True), True) assert_raises(TypeError, cfg.getbool, 'something', 'user') # gitpython-style access assert_equal(cfg.get('something.myint'), cfg.get_value('something', 'myint')) assert_equal(cfg.get_value('doesnot', 'exist', default='oohaaa'), 'oohaaa') # weird, but that is how it is assert_raises(KeyError, cfg.get_value, 'doesnot', 'exist', default=None) # modification follows cfg.add('something.new', 'の') assert_equal(cfg.get('something.new'), u'の') # sections are added on demand cfg.add('unheard.of', 'fame') assert_true(cfg.has_section('unheard.of')) comp = cfg.items('something') cfg.rename_section('something', 'this') assert_true(cfg.has_section('this')) assert_false(cfg.has_section('something')) # direct comparison would fail, because of section prefix assert_equal(len(cfg.items('this')), len(comp)) # fail if no such section with swallow_logs(): assert_raises(CommandError, cfg.rename_section, 'nothere', 'irrelevant') assert_true(cfg.has_option('this', 'myint')) cfg.unset('this.myint') assert_false(cfg.has_option('this', 'myint')) # batch a changes cfg.add('mike.wants.to', 'know', reload=False) assert_false('mike.wants.to' in cfg) cfg.add('mike.wants.to', 'eat') assert_true('mike.wants.to' in cfg) assert_equal(len(cfg['mike.wants.to']), 2) # set a new one: cfg.set('mike.should.have', 'known') assert_in('mike.should.have', cfg) assert_equal(cfg['mike.should.have'], 'known') # set an existing one: cfg.set('mike.should.have', 'known better') assert_equal(cfg['mike.should.have'], 'known better') # set, while there are several matching ones already: cfg.add('mike.should.have', 'a meal') assert_equal(len(cfg['mike.should.have']), 2) # raises with force=False assert_raises(CommandError, cfg.set, 'mike.should.have', 'a beer', force=False) assert_equal(len(cfg['mike.should.have']), 2) # replaces all matching ones with force=True cfg.set('mike.should.have', 'a beer', force=True) assert_equal(cfg['mike.should.have'], 'a beer') # test deprecated 'where' interface and old 'dataset' (not 'branch') value # TODO: remove along with the removal of deprecated 'where' cfg.set('mike.should.have', 'wasknown', where='dataset') assert_equal(cfg['mike.should.have'], 'wasknown') assert_equal(cfg.get_from_source('dataset', 'mike.should.have'), 'wasknown') # fails unknown location assert_raises(ValueError, cfg.add, 'somesuch', 'shit', scope='umpalumpa') # very carefully test non-local config # so carefully that even in case of bad weather Yarik doesn't find some # lame datalad unittest sections in his precious ~/.gitconfig # Note: An easier way to test this, would be to just set GIT_CONFIG_GLOBAL # to point somewhere else. However, this is not supported by git before # 2.32. Hence, stick with changed HOME in this test, but be sure to unset a # possible GIT_CONFIG_GLOBAL in addition. patched_env = os.environ.copy() patched_env.pop('GIT_CONFIG_GLOBAL', None) patched_env.update(get_home_envvars(new_home)) with patch.dict('os.environ', dict(patched_env, DATALAD_SNEAKY_ADDITION='ignore'), clear=True): global_gitconfig = opj(new_home, '.gitconfig') assert (not exists(global_gitconfig)) globalcfg = ConfigManager() assert_not_in('datalad.unittest.youcan', globalcfg) assert_in('datalad.sneaky.addition', globalcfg) cfg.add('datalad.unittest.youcan', 'removeme', scope='global') assert (exists(global_gitconfig)) # it did not go into the dataset's config! assert_not_in('datalad.unittest.youcan', cfg) # does not monitor additions! globalcfg.reload(force=True) assert_in('datalad.unittest.youcan', globalcfg) with swallow_logs(): assert_raises(CommandError, globalcfg.unset, 'datalad.unittest.youcan', scope='local') assert (globalcfg.has_section('datalad.unittest')) globalcfg.unset('datalad.unittest.youcan', scope='global') # but after we unset the only value -- that section is no longer listed assert (not globalcfg.has_section('datalad.unittest')) assert_not_in('datalad.unittest.youcan', globalcfg) ok_file_has_content(global_gitconfig, "") cfg = ConfigManager(Dataset(opj(path, 'ds')), source='branch', overrides={'datalad.godgiven': True}) assert_equal(cfg.get('datalad.godgiven'), True) # setter has no effect cfg.set('datalad.godgiven', 'false') assert_equal(cfg.get('datalad.godgiven'), True)
def setup_package(): import os from datalad.utils import on_osx from datalad.tests import _TEMP_PATHS_GENERATED if on_osx: # enforce honoring TMPDIR (see gh-5307) import tempfile tempfile.tempdir = os.environ.get('TMPDIR', tempfile.gettempdir()) from datalad import consts _test_states['env'] = {} def set_envvar(v, val): """Memoize and then set env var""" _test_states['env'][v] = os.environ.get(v, None) os.environ[v] = val _test_states['DATASETS_TOPURL'] = consts.DATASETS_TOPURL consts.DATASETS_TOPURL = 'http://datasets-tests.datalad.org/' set_envvar('DATALAD_DATASETS_TOPURL', consts.DATASETS_TOPURL) from datalad.tests.utils import ( DEFAULT_BRANCH, DEFAULT_REMOTE, ) set_envvar( "GIT_CONFIG_PARAMETERS", "'init.defaultBranch={}' 'clone.defaultRemoteName={}'".format( DEFAULT_BRANCH, DEFAULT_REMOTE)) # To overcome pybuild overriding HOME but us possibly wanting our # own HOME where we pre-setup git for testing (name, email) if 'GIT_HOME' in os.environ: set_envvar('HOME', os.environ['GIT_HOME']) set_envvar('DATALAD_LOG_EXC', "1") else: # we setup our own new HOME, the BEST and HUGE one from datalad.utils import make_tempfile # TODO: split into a function + context manager with make_tempfile(mkdir=True) as new_home: pass for v, val in get_home_envvars(new_home).items(): set_envvar(v, val) if not os.path.exists(new_home): os.makedirs(new_home) with open(os.path.join(new_home, '.gitconfig'), 'w') as f: f.write("""\ [user] name = DataLad Tester email = [email protected] [datalad "log"] exc = 1 """) _TEMP_PATHS_GENERATED.append(new_home) # Re-load ConfigManager, since otherwise it won't consider global config # from new $HOME (see gh-4153 cfg.reload(force=True) from datalad.interface.common_cfg import compute_cfg_defaults compute_cfg_defaults() # datalad.locations.sockets has likely changed. Discard any cached values. ssh_manager._socket_dir = None # To overcome pybuild by default defining http{,s}_proxy we would need # to define them to e.g. empty value so it wouldn't bother touching them. # But then haskell libraries do not digest empty value nicely, so we just # pop them out from the environment for ev in ('http_proxy', 'https_proxy'): if ev in os.environ and not (os.environ[ev]): lgr.debug("Removing %s from the environment since it is empty", ev) os.environ.pop(ev) # During tests we allow for "insecure" access to local file:// and # http://localhost URLs since all of them either generated as tests # fixtures or cloned from trusted sources from datalad.support.annexrepo import AnnexRepo AnnexRepo._ALLOW_LOCAL_URLS = True DATALAD_LOG_LEVEL = os.environ.get('DATALAD_LOG_LEVEL', None) if DATALAD_LOG_LEVEL is None: # very very silent. Tests introspecting logs should use # swallow_logs(new_level=...) _test_states['loglevel'] = lgr.getEffectiveLevel() lgr.setLevel(100) # And we should also set it within environ so underlying commands also stay silent set_envvar('DATALAD_LOG_LEVEL', '100') else: # We are not overriding them, since explicitly were asked to have some log level _test_states['loglevel'] = None # Set to non-interactive UI from datalad.ui import ui _test_states['ui_backend'] = ui.backend # obtain() since that one consults for the default value ui.set_backend(cfg.obtain('datalad.tests.ui.backend')) # Monkey patch nose so it does not ERROR out whenever code asks for fileno # of the output. See https://github.com/nose-devs/nose/issues/6 from io import StringIO as OrigStringIO class StringIO(OrigStringIO): fileno = lambda self: 1 encoding = None from nose.ext import dtcompat from nose.plugins import capture, multiprocess, plugintest dtcompat.StringIO = StringIO capture.StringIO = StringIO multiprocess.StringIO = StringIO plugintest.StringIO = StringIO # in order to avoid having to fiddle with rather uncommon # file:// URLs in the tests, have a standard HTTP server # that serves an 'httpserve' directory in the test HOME # the URL will be available from datalad.test_http_server.url from datalad.tests.utils import HTTPPath import tempfile global test_http_server serve_path = tempfile.mkdtemp( dir=cfg.get("datalad.tests.temp.dir"), prefix='httpserve', ) test_http_server = HTTPPath(serve_path) test_http_server.start() _TEMP_PATHS_GENERATED.append(serve_path) if cfg.obtain('datalad.tests.setup.testrepos'): lgr.debug("Pre-populating testrepos") from datalad.tests.utils import with_testrepos with_testrepos()(lambda repo: 1)()
def setup_package(): import tempfile from pathlib import Path from datalad import consts from datalad.support.annexrepo import AnnexRepo from datalad.support.cookies import cookies_db from datalad.support.external_versions import external_versions from datalad.tests import _TEMP_PATHS_GENERATED from datalad.tests.utils_pytest import ( DEFAULT_BRANCH, DEFAULT_REMOTE, OBSCURE_FILENAME, HTTPPath, rmtemp, ) from datalad.ui import ui from datalad.utils import ( make_tempfile, on_osx, ) if on_osx: # enforce honoring TMPDIR (see gh-5307) tempfile.tempdir = os.environ.get('TMPDIR', tempfile.gettempdir()) with pytest.MonkeyPatch().context() as m: m.setattr(consts, "DATASETS_TOPURL", 'https://datasets-tests.datalad.org/') m.setenv('DATALAD_DATASETS_TOPURL', consts.DATASETS_TOPURL) m.setenv( "GIT_CONFIG_PARAMETERS", "'init.defaultBranch={}' 'clone.defaultRemoteName={}'".format( DEFAULT_BRANCH, DEFAULT_REMOTE)) def prep_tmphome(): # re core.askPass: # Don't let git ask for credentials in CI runs. Note, that this variable # technically is not a flag, but an executable (which is why name and value # are a bit confusing here - we just want a no-op basically). The environment # variable GIT_ASKPASS overwrites this, but neither env var nor this config # are supported by git-credential on all systems and git versions (most recent # ones should work either way, though). Hence use both across CI builds. gitconfig = """\ [user] name = DataLad Tester email = [email protected] [core] askPass = [datalad "log"] exc = 1 [annex "security"] # from annex 6.20180626 file:/// and http://localhost access isn't # allowed by default allowed-url-schemes = http https file allowed-http-addresses = all """ # TODO: split into a function + context manager with make_tempfile(mkdir=True) as new_home: pass # register for clean-up on exit _TEMP_PATHS_GENERATED.append(new_home) # populate default config new_home = Path(new_home) new_home.mkdir(parents=True, exist_ok=True) cfg_file = new_home / '.gitconfig' cfg_file.write_text(gitconfig) return new_home, cfg_file if external_versions['cmd:git'] < "2.32": # To overcome pybuild overriding HOME but us possibly wanting our # own HOME where we pre-setup git for testing (name, email) if 'GIT_HOME' in os.environ: m.setenv('HOME', os.environ['GIT_HOME']) else: # we setup our own new HOME, the BEST and HUGE one new_home, _ = prep_tmphome() for v, val in get_home_envvars(new_home).items(): m.setenv(v, val) else: _, cfg_file = prep_tmphome() m.setenv('GIT_CONFIG_GLOBAL', str(cfg_file)) # Re-load ConfigManager, since otherwise it won't consider global config # from new $HOME (see gh-4153 cfg.reload(force=True) # datalad.locations.sockets has likely changed. Discard any cached values. ssh_manager._socket_dir = None # To overcome pybuild by default defining http{,s}_proxy we would need # to define them to e.g. empty value so it wouldn't bother touching them. # But then haskell libraries do not digest empty value nicely, so we just # pop them out from the environment for ev in ('http_proxy', 'https_proxy'): if ev in os.environ and not (os.environ[ev]): lgr.debug("Removing %s from the environment since it is empty", ev) os.environ.pop(ev) # Prevent interactive credential entry (note "true" is the command to run) # See also the core.askPass setting above m.setenv('GIT_ASKPASS', 'true') # Set to non-interactive UI _test_states['ui_backend'] = ui.backend # obtain() since that one consults for the default value ui.set_backend(cfg.obtain('datalad.tests.ui.backend')) # in order to avoid having to fiddle with rather uncommon # file:// URLs in the tests, have a standard HTTP server # that serves an 'httpserve' directory in the test HOME # the URL will be available from datalad.test_http_server.url global test_http_server # Start the server only if not running already # Relevant: we have test_misc.py:test_test which runs datalad.test but # not doing teardown, so the original server might never get stopped if test_http_server is None: serve_path = tempfile.mkdtemp( dir=cfg.get("datalad.tests.temp.dir"), prefix='httpserve', ) test_http_server = HTTPPath(serve_path) test_http_server.start() _TEMP_PATHS_GENERATED.append(serve_path) if cfg.obtain('datalad.tests.setup.testrepos'): lgr.debug("Pre-populating testrepos") from datalad.tests.utils_pytest import with_testrepos with_testrepos()(lambda repo: 1)() yield lgr.debug("Printing versioning information collected so far") # Query for version of datalad, so it is included in ev.dumps below - useful while # testing extensions where version of datalad might differ in the environment. external_versions['datalad'] print(external_versions.dumps(query=True)) try: print("Obscure filename: str=%s repr=%r" % (OBSCURE_FILENAME.encode('utf-8'), OBSCURE_FILENAME)) except UnicodeEncodeError as exc: ce = CapturedException(exc) print("Obscure filename failed to print: %s" % ce) def print_dict(d): return " ".join("%s=%r" % v for v in d.items()) print("Encodings: %s" % print_dict(get_encoding_info())) print("Environment: %s" % print_dict(get_envvars_info())) if os.environ.get('DATALAD_TESTS_NOTEARDOWN'): return ui.set_backend(_test_states['ui_backend']) if test_http_server: test_http_server.stop() test_http_server = None else: lgr.debug( "For some reason global http_server was not set/running, thus not stopping" ) if len(_TEMP_PATHS_GENERATED): msg = "Removing %d dirs/files: %s" % ( len(_TEMP_PATHS_GENERATED), ', '.join(_TEMP_PATHS_GENERATED)) else: msg = "Nothing to remove" lgr.debug("Teardown tests. " + msg) for path in _TEMP_PATHS_GENERATED: rmtemp(str(path), ignore_errors=True) # Re-establish correct global config after changing $HOME. # Might be superfluous, since after teardown datalad.cfg shouldn't be # needed. However, maintaining a consistent state seems a good thing # either way. cfg.reload(force=True) ssh_manager._socket_dir = None cookies_db.close()