# -*- coding: utf-8 -*- from __future__ import absolute_import, division, print_function, unicode_literals from conda.common.io import env_var, env_vars from conda._vendor.auxlib.ish import dals from conda.common.compat import odict, string_types from conda.common.configuration import (Configuration, MapParameter, ParameterFlag, PrimitiveParameter, SequenceParameter, YamlRawParameter, load_file_configs, MultiValidationError, InvalidTypeError, CustomValidationError) from conda.common.serialize import yaml_load from conda.common.configuration import ValidationError from os import environ, mkdir from os.path import join from pytest import raises from shutil import rmtree from tempfile import mkdtemp from unittest import TestCase test_yaml_raw = { 'file1': dals(""" always_yes: no proxy_servers: http: taz https: sly s3: pepé channels_altname: - bugs - daffy - tweety """), 'file2': dals(""" always_yes: yes changeps1: no proxy_servers: http: marv https: sam channels: - porky - bugs - elmer """), 'file3': dals(""" always_yes_altname2: yes #!final proxy_servers: http: foghorn #!final https: elmer s3: porky channels: - wile #!top - daffy - foghorn """), 'file4': dals(""" always_yes: yes #!final changeps1: no #!final proxy_servers: #!final http: bugs https: daffy channels: #!final - pepé - marv - sam """), 'file5': dals(""" channels: - pepé - marv #!top - sam """), 'file6': dals(""" channels: - elmer - marv #!bottom - bugs """), 'file7': dals(""" channels: - wile - daffy #!top - sam #!top - foghorn """), 'file8': dals(""" channels: - pepé #!bottom - marv #!top - wile - sam """), 'file9': dals(""" channels: #!final - sam - pepé - marv #!top - daffy #!bottom """), 'bad_boolean': "always_yes: yeah", 'too_many_aliases': dals(""" always_yes: yes always_yes_altname2: yes """), 'not_an_int': "always_an_int: nope", 'good_boolean_map': dals(""" boolean_map: a_true: true a_yes: yes a_1: 1 a_false: False a_no: no a_0: 0 """), 'bad_boolean_map': dals(""" boolean_map: a_string: not true an_int: 2 a_float: 1.2 a_complex: 1+2j proxy_servers: channels: """), 'commented_map': dals(""" commented_map: key: # comment value """), 'env_vars': dals(""" env_var_map: expanded: $EXPANDED_VAR unexpanded: $UNEXPANDED_VAR env_var_str: $EXPANDED_VAR env_var_bool: $BOOL_VAR normal_str: $EXPANDED_VAR env_var_list: - $EXPANDED_VAR - $UNEXPANDED_VAR - regular_var """), } class SampleConfiguration(Configuration): always_yes = PrimitiveParameter(False, aliases=('always_yes_altname1', 'yes', 'always_yes_altname2')) changeps1 = PrimitiveParameter(True) proxy_servers = MapParameter(string_types) channels = SequenceParameter(string_types, aliases=('channels_altname', )) always_an_int = PrimitiveParameter(0) boolean_map = MapParameter(bool) commented_map = MapParameter(string_types) env_var_map = MapParameter(string_types, expandvars=True) env_var_str = PrimitiveParameter('', expandvars=True) env_var_bool = PrimitiveParameter(False, element_type=bool, expandvars=True) normal_str = PrimitiveParameter('', expandvars=False) env_var_list = SequenceParameter(string_types, expandvars=True) def load_from_string_data(*seq): return odict((f, YamlRawParameter.make_raw_parameters(f, yaml_load(test_yaml_raw[f]))) for f in seq) class ConfigurationTests(TestCase): def test_simple_merges_and_caching(self): config = SampleConfiguration()._set_raw_data(load_from_string_data('file1', 'file2')) assert config.changeps1 is False assert config.always_yes is True assert config.channels == ('porky', 'bugs', 'elmer', 'daffy', 'tweety') assert config.proxy_servers == {'http': 'marv', 'https': 'sam', 's3': 'pepé'} config = SampleConfiguration()._set_raw_data(load_from_string_data('file2', 'file1')) assert len(config._cache_) == 0 assert config.changeps1 is False assert len(config._cache_) == 1 assert config.always_yes is False assert len(config._cache_) == 2 assert config.always_yes is False assert config._cache_['always_yes'] is False assert config.channels == ('bugs', 'daffy', 'tweety', 'porky', 'elmer') assert config.proxy_servers == {'http': 'taz', 'https': 'sly', 's3': 'pepé'} def test_default_values(self): config = SampleConfiguration() assert config.channels == () assert config.always_yes is False assert config.proxy_servers == {} assert config.changeps1 is True def test_env_var_config(self): def make_key(appname, key): return "{0}_{1}".format(appname.upper(), key.upper()) appname = "myapp" test_dict = {} test_dict[make_key(appname, 'always_yes')] = 'yes' test_dict[make_key(appname, 'changeps1')] = 'false' try: environ.update(test_dict) assert 'MYAPP_ALWAYS_YES' in environ config = SampleConfiguration(app_name=appname) assert config.changeps1 is False assert config.always_yes is True finally: [environ.pop(key) for key in test_dict] def test_env_var_config_alias(self): def make_key(appname, key): return "{0}_{1}".format(appname.upper(), key.upper()) appname = "myapp" test_dict = {} test_dict[make_key(appname, 'yes')] = 'yes' test_dict[make_key(appname, 'changeps1')] = 'false' try: environ.update(test_dict) assert 'MYAPP_YES' in environ config = SampleConfiguration()._set_env_vars(appname) assert config.always_yes is True assert config.changeps1 is False finally: [environ.pop(key) for key in test_dict] def test_env_var_config_split_sequence(self): def make_key(appname, key): return "{0}_{1}".format(appname.upper(), key.upper()) appname = "myapp" test_dict = {} test_dict[make_key(appname, 'channels')] = 'channel1,channel2' try: environ.update(test_dict) assert 'MYAPP_CHANNELS' in environ config = SampleConfiguration()._set_env_vars(appname) assert config.channels == ('channel1', 'channel2') finally: [environ.pop(key) for key in test_dict] def test_env_var_config_no_split_sequence(self): def make_key(appname, key): return "{0}_{1}".format(appname.upper(), key.upper()) appname = "myapp" test_dict = {} test_dict[make_key(appname, 'channels')] = 'channel1' try: environ.update(test_dict) assert 'MYAPP_CHANNELS' in environ config = SampleConfiguration()._set_env_vars(appname) assert config.channels == ('channel1',) finally: [environ.pop(key) for key in test_dict] def test_env_var_config_empty_sequence(self): def make_key(appname, key): return "{0}_{1}".format(appname.upper(), key.upper()) appname = "myapp" test_dict = {} test_dict[make_key(appname, 'channels')] = '' try: environ.update(test_dict) assert 'MYAPP_CHANNELS' in environ config = SampleConfiguration()._set_env_vars(appname) assert config.channels == () finally: [environ.pop(key) for key in test_dict] def test_load_raw_configs(self): try: tempdir = mkdtemp() condarc = join(tempdir, '.condarc') condarcd = join(tempdir, 'condarc.d') f1 = join(condarcd, 'file1.yml') f2 = join(condarcd, 'file2.yml') not_a_file = join(tempdir, 'not_a_file') mkdir(condarcd) with open(f1, 'wb') as fh: fh.write(test_yaml_raw['file1'].encode('utf-8')) with open(f2, 'wb') as fh: fh.write(test_yaml_raw['file2'].encode('utf-8')) with open(condarc, 'wb') as fh: fh.write(test_yaml_raw['file3'].encode('utf-8')) search_path = [condarc, not_a_file, condarcd] raw_data = load_file_configs(search_path) assert not_a_file not in raw_data assert raw_data[condarc]['channels'].value(None)[0] == "wile" assert raw_data[f1]['always_yes'].value(None) == "no" assert raw_data[f2]['proxy_servers'].value(None)['http'] == "marv" config = SampleConfiguration(search_path) from pprint import pprint for key, val in config.collect_all().items(): print(key) pprint(val) assert config.channels == ('wile', 'porky', 'bugs', 'elmer', 'daffy', 'tweety', 'foghorn') finally: rmtree(tempdir, ignore_errors=True) def test_important_primitive_map_merges(self): raw_data = load_from_string_data('file1', 'file3', 'file2') config = SampleConfiguration()._set_raw_data(raw_data) assert config.changeps1 is False assert config.always_yes is True assert config.channels == ('wile', 'porky', 'bugs', 'elmer', 'daffy', 'foghorn', 'tweety') assert config.proxy_servers == {'http': 'foghorn', 'https': 'sam', 's3': 'porky'} raw_data = load_from_string_data('file3', 'file2', 'file1') config = SampleConfiguration()._set_raw_data(raw_data) assert config.changeps1 is False assert config.always_yes is True assert config.channels == ('wile', 'bugs', 'daffy', 'tweety', 'porky', 'elmer', 'foghorn') assert config.proxy_servers == {'http': 'foghorn', 'https': 'sly', 's3': 'pepé'} raw_data = load_from_string_data('file4', 'file3', 'file1') config = SampleConfiguration()._set_raw_data(raw_data) assert config.changeps1 is False assert config.always_yes is True assert config.proxy_servers == {'https': 'daffy', 'http': 'bugs'} raw_data = load_from_string_data('file1', 'file4', 'file3', 'file2') config = SampleConfiguration()._set_raw_data(raw_data) assert config.changeps1 is False assert config.always_yes is True assert config.proxy_servers == {'http': 'bugs', 'https': 'daffy', 's3': 'pepé'} raw_data = load_from_string_data('file1', 'file2', 'file3', 'file4') config = SampleConfiguration()._set_raw_data(raw_data) assert config.changeps1 is False assert config.always_yes is True assert config.proxy_servers == {'https': 'daffy', 'http': 'foghorn', 's3': 'porky'} raw_data = load_from_string_data('file3', 'file1') config = SampleConfiguration()._set_raw_data(raw_data) assert config.changeps1 is True assert config.always_yes is True assert config.proxy_servers == {'https': 'sly', 'http': 'foghorn', 's3': 'pepé'} raw_data = load_from_string_data('file4', 'file3') config = SampleConfiguration()._set_raw_data(raw_data) assert config.changeps1 is False assert config.always_yes is True assert config.proxy_servers == {'http': 'bugs', 'https': 'daffy'} def test_list_merges(self): raw_data = load_from_string_data('file5', 'file3') config = SampleConfiguration()._set_raw_data(raw_data) assert config.channels == ('marv', 'wile', 'daffy', 'foghorn', 'pepé', 'sam') raw_data = load_from_string_data('file6', 'file5', 'file4', 'file3') config = SampleConfiguration()._set_raw_data(raw_data) assert config.channels == ('pepé', 'sam', 'elmer', 'bugs', 'marv') raw_data = load_from_string_data('file3', 'file4', 'file5', 'file6') config = SampleConfiguration()._set_raw_data(raw_data) assert config.channels == ('wile', 'pepé', 'marv', 'sam', 'daffy', 'foghorn') raw_data = load_from_string_data('file6', 'file3', 'file4', 'file5') config = SampleConfiguration()._set_raw_data(raw_data) assert config.channels == ('wile', 'pepé', 'sam', 'daffy', 'foghorn', 'elmer', 'bugs', 'marv') raw_data = load_from_string_data('file7', 'file8', 'file9') config = SampleConfiguration()._set_raw_data(raw_data) assert config.channels == ('sam', 'marv', 'wile', 'foghorn', 'daffy', 'pepé') raw_data = load_from_string_data('file7', 'file9', 'file8') config = SampleConfiguration()._set_raw_data(raw_data) assert config.channels == ('sam', 'marv', 'pepé', 'wile', 'foghorn', 'daffy') raw_data = load_from_string_data('file8', 'file7', 'file9') config = SampleConfiguration()._set_raw_data(raw_data) assert config.channels == ('marv', 'sam', 'wile', 'foghorn', 'daffy', 'pepé') raw_data = load_from_string_data('file8', 'file9', 'file7') config = SampleConfiguration()._set_raw_data(raw_data) assert config.channels == ('marv', 'sam', 'wile', 'daffy', 'pepé') raw_data = load_from_string_data('file9', 'file7', 'file8') config = SampleConfiguration()._set_raw_data(raw_data) assert config.channels == ('marv', 'sam', 'pepé', 'daffy') raw_data = load_from_string_data('file9', 'file8', 'file7') config = SampleConfiguration()._set_raw_data(raw_data) assert config.channels == ('marv', 'sam', 'pepé', 'daffy') def test_validation(self): config = SampleConfiguration()._set_raw_data(load_from_string_data('bad_boolean')) raises(ValidationError, lambda: config.always_yes) config = SampleConfiguration()._set_raw_data(load_from_string_data('too_many_aliases')) raises(ValidationError, lambda: config.always_yes) config = SampleConfiguration()._set_raw_data(load_from_string_data('not_an_int')) raises(ValidationError, lambda: config.always_an_int) config = SampleConfiguration()._set_raw_data(load_from_string_data('bad_boolean_map')) raises(ValidationError, lambda: config.boolean_map) config = SampleConfiguration()._set_raw_data(load_from_string_data('good_boolean_map')) assert config.boolean_map['a_true'] is True assert config.boolean_map['a_yes'] is True assert config.boolean_map['a_1'] is True assert config.boolean_map['a_false'] is False assert config.boolean_map['a_no'] is False assert config.boolean_map['a_0'] is False def test_parameter(self): assert ParameterFlag.from_name('top') is ParameterFlag.top def test_validate_all(self): config = SampleConfiguration()._set_raw_data(load_from_string_data('file1')) config.validate_configuration() config = SampleConfiguration()._set_raw_data(load_from_string_data('bad_boolean_map')) try: config.validate_configuration() except ValidationError as e: # the `proxy_servers: ~` part of 'bad_boolean_map' is a regression test for #4757 # in the future, the below should probably be a MultiValidationError # with TypeValidationError for 'proxy_servers' and 'channels' assert isinstance(e, CustomValidationError) else: assert False def test_cross_parameter_validation(self): pass # test primitive can't be list; list can't be map, etc def test_map_parameter_must_be_map(self): # regression test for conda/conda#3467 string = dals(""" proxy_servers: bad values """) data = odict(s1=YamlRawParameter.make_raw_parameters('s1', yaml_load(string))) config = SampleConfiguration()._set_raw_data(data) raises(InvalidTypeError, config.validate_all) def test_config_resets(self): appname = "myapp" config = SampleConfiguration(app_name=appname) assert config.changeps1 is True with env_var("MYAPP_CHANGEPS1", "false"): config.__init__(app_name=appname) assert config.changeps1 is False def test_empty_map_parameter(self): config = SampleConfiguration()._set_raw_data(load_from_string_data('bad_boolean_map')) config.check_source('bad_boolean_map') def test_commented_map_parameter(self): config = SampleConfiguration()._set_raw_data(load_from_string_data('commented_map')) assert config.commented_map == {'key': 'value'} def test_invalid_map_parameter(self): data = odict(s1=YamlRawParameter.make_raw_parameters('s1', {'proxy_servers': 'blah'})) config = SampleConfiguration()._set_raw_data(data) with raises(InvalidTypeError): config.proxy_servers def test_invalid_seq_parameter(self): data = odict(s1=YamlRawParameter.make_raw_parameters('s1', {'channels': 'y_u_no_tuple'})) config = SampleConfiguration()._set_raw_data(data) with raises(InvalidTypeError): config.channels def test_expanded_variables(self): with env_vars({'EXPANDED_VAR': 'itsexpanded', 'BOOL_VAR': 'True'}): config = SampleConfiguration()._set_raw_data(load_from_string_data('env_vars')) assert config.env_var_map['expanded'] == 'itsexpanded' assert config.env_var_map['unexpanded'] == '$UNEXPANDED_VAR' assert config.env_var_str == 'itsexpanded' assert config.env_var_bool is True assert config.normal_str == '$EXPANDED_VAR' assert config.env_var_list == ('itsexpanded', '$UNEXPANDED_VAR', 'regular_var')