mirror of https://github.com/docker/docs.git
Merge pull request #2207 from dnephin/make_config_loader_immutable
Refactor of ServiceLoader to make it immutable
This commit is contained in:
commit
c34a9f165d
|
@ -212,9 +212,16 @@ def load(config_details):
|
||||||
|
|
||||||
|
|
||||||
class ServiceLoader(object):
|
class ServiceLoader(object):
|
||||||
def __init__(self, working_dir, filename, service_name, service_dict, already_seen=None):
|
def __init__(
|
||||||
|
self,
|
||||||
|
working_dir,
|
||||||
|
filename,
|
||||||
|
service_name,
|
||||||
|
service_dict,
|
||||||
|
already_seen=None
|
||||||
|
):
|
||||||
if working_dir is None:
|
if working_dir is None:
|
||||||
raise Exception("No working_dir passed to ServiceLoader()")
|
raise ValueError("No working_dir passed to ServiceLoader()")
|
||||||
|
|
||||||
self.working_dir = os.path.abspath(working_dir)
|
self.working_dir = os.path.abspath(working_dir)
|
||||||
|
|
||||||
|
@ -232,112 +239,109 @@ class ServiceLoader(object):
|
||||||
raise CircularReference(self.already_seen + [self.signature(name)])
|
raise CircularReference(self.already_seen + [self.signature(name)])
|
||||||
|
|
||||||
def make_service_dict(self):
|
def make_service_dict(self):
|
||||||
self.resolve_environment()
|
service_dict = dict(self.service_dict)
|
||||||
if 'extends' in self.service_dict:
|
env = resolve_environment(self.working_dir, self.service_dict)
|
||||||
self.validate_and_construct_extends()
|
if env:
|
||||||
self.service_dict = self.resolve_extends()
|
service_dict['environment'] = env
|
||||||
|
service_dict.pop('env_file', None)
|
||||||
|
|
||||||
|
if 'extends' in service_dict:
|
||||||
|
service_dict = self.resolve_extends(*self.validate_and_construct_extends())
|
||||||
|
|
||||||
if not self.already_seen:
|
if not self.already_seen:
|
||||||
validate_against_service_schema(self.service_dict, self.service_name)
|
validate_against_service_schema(service_dict, self.service_name)
|
||||||
|
|
||||||
return process_container_options(self.service_dict, working_dir=self.working_dir)
|
return process_container_options(service_dict, working_dir=self.working_dir)
|
||||||
|
|
||||||
def resolve_environment(self):
|
|
||||||
"""
|
|
||||||
Unpack any environment variables from an env_file, if set.
|
|
||||||
Interpolate environment values if set.
|
|
||||||
"""
|
|
||||||
if 'environment' not in self.service_dict and 'env_file' not in self.service_dict:
|
|
||||||
return
|
|
||||||
|
|
||||||
env = {}
|
|
||||||
|
|
||||||
if 'env_file' in self.service_dict:
|
|
||||||
for f in get_env_files(self.service_dict, working_dir=self.working_dir):
|
|
||||||
env.update(env_vars_from_file(f))
|
|
||||||
del self.service_dict['env_file']
|
|
||||||
|
|
||||||
env.update(parse_environment(self.service_dict.get('environment')))
|
|
||||||
env = dict(resolve_env_var(k, v) for k, v in six.iteritems(env))
|
|
||||||
|
|
||||||
self.service_dict['environment'] = env
|
|
||||||
|
|
||||||
def validate_and_construct_extends(self):
|
def validate_and_construct_extends(self):
|
||||||
extends = self.service_dict['extends']
|
extends = self.service_dict['extends']
|
||||||
if not isinstance(extends, dict):
|
if not isinstance(extends, dict):
|
||||||
extends = {'service': extends}
|
extends = {'service': extends}
|
||||||
|
|
||||||
validate_extends_file_path(
|
validate_extends_file_path(self.service_name, extends, self.filename)
|
||||||
self.service_name,
|
config_path = self.get_extended_config_path(extends)
|
||||||
extends,
|
service_name = extends['service']
|
||||||
self.filename
|
|
||||||
)
|
|
||||||
self.extended_config_path = self.get_extended_config_path(extends)
|
|
||||||
self.extended_service_name = extends['service']
|
|
||||||
|
|
||||||
config = load_yaml(self.extended_config_path)
|
config = load_yaml(config_path)
|
||||||
validate_top_level_object(config)
|
validate_top_level_object(config)
|
||||||
full_extended_config = interpolate_environment_variables(config)
|
full_extended_config = interpolate_environment_variables(config)
|
||||||
|
|
||||||
validate_extended_service_exists(
|
validate_extended_service_exists(
|
||||||
self.extended_service_name,
|
service_name,
|
||||||
full_extended_config,
|
full_extended_config,
|
||||||
self.extended_config_path
|
config_path
|
||||||
)
|
)
|
||||||
validate_against_fields_schema(full_extended_config)
|
validate_against_fields_schema(full_extended_config)
|
||||||
|
|
||||||
self.extended_config = full_extended_config[self.extended_service_name]
|
service_config = full_extended_config[service_name]
|
||||||
|
return config_path, service_config, service_name
|
||||||
|
|
||||||
def resolve_extends(self):
|
def resolve_extends(self, extended_config_path, service_config, service_name):
|
||||||
other_working_dir = os.path.dirname(self.extended_config_path)
|
other_working_dir = os.path.dirname(extended_config_path)
|
||||||
other_already_seen = self.already_seen + [self.signature(self.service_name)]
|
other_already_seen = self.already_seen + [self.signature(self.service_name)]
|
||||||
|
|
||||||
other_loader = ServiceLoader(
|
other_loader = ServiceLoader(
|
||||||
working_dir=other_working_dir,
|
other_working_dir,
|
||||||
filename=self.extended_config_path,
|
extended_config_path,
|
||||||
service_name=self.service_name,
|
self.service_name,
|
||||||
service_dict=self.extended_config,
|
service_config,
|
||||||
already_seen=other_already_seen,
|
already_seen=other_already_seen,
|
||||||
)
|
)
|
||||||
|
|
||||||
other_loader.detect_cycle(self.extended_service_name)
|
other_loader.detect_cycle(service_name)
|
||||||
other_service_dict = other_loader.make_service_dict()
|
other_service_dict = other_loader.make_service_dict()
|
||||||
validate_extended_service_dict(
|
validate_extended_service_dict(
|
||||||
other_service_dict,
|
other_service_dict,
|
||||||
filename=self.extended_config_path,
|
extended_config_path,
|
||||||
service=self.extended_service_name,
|
service_name,
|
||||||
)
|
)
|
||||||
|
|
||||||
return merge_service_dicts(other_service_dict, self.service_dict)
|
return merge_service_dicts(other_service_dict, self.service_dict)
|
||||||
|
|
||||||
def get_extended_config_path(self, extends_options):
|
def get_extended_config_path(self, extends_options):
|
||||||
"""
|
"""Service we are extending either has a value for 'file' set, which we
|
||||||
Service we are extending either has a value for 'file' set, which we
|
|
||||||
need to obtain a full path too or we are extending from a service
|
need to obtain a full path too or we are extending from a service
|
||||||
defined in our own file.
|
defined in our own file.
|
||||||
"""
|
"""
|
||||||
if 'file' in extends_options:
|
if 'file' in extends_options:
|
||||||
extends_from_filename = extends_options['file']
|
return expand_path(self.working_dir, extends_options['file'])
|
||||||
return expand_path(self.working_dir, extends_from_filename)
|
|
||||||
|
|
||||||
return self.filename
|
return self.filename
|
||||||
|
|
||||||
def signature(self, name):
|
def signature(self, name):
|
||||||
return (self.filename, name)
|
return self.filename, name
|
||||||
|
|
||||||
|
|
||||||
|
def resolve_environment(working_dir, service_dict):
|
||||||
|
"""Unpack any environment variables from an env_file, if set.
|
||||||
|
Interpolate environment values if set.
|
||||||
|
"""
|
||||||
|
if 'environment' not in service_dict and 'env_file' not in service_dict:
|
||||||
|
return {}
|
||||||
|
|
||||||
|
env = {}
|
||||||
|
if 'env_file' in service_dict:
|
||||||
|
for env_file in get_env_files(service_dict, working_dir=working_dir):
|
||||||
|
env.update(env_vars_from_file(env_file))
|
||||||
|
|
||||||
|
env.update(parse_environment(service_dict.get('environment')))
|
||||||
|
return dict(resolve_env_var(k, v) for k, v in six.iteritems(env))
|
||||||
|
|
||||||
|
|
||||||
def validate_extended_service_dict(service_dict, filename, service):
|
def validate_extended_service_dict(service_dict, filename, service):
|
||||||
error_prefix = "Cannot extend service '%s' in %s:" % (service, filename)
|
error_prefix = "Cannot extend service '%s' in %s:" % (service, filename)
|
||||||
|
|
||||||
if 'links' in service_dict:
|
if 'links' in service_dict:
|
||||||
raise ConfigurationError("%s services with 'links' cannot be extended" % error_prefix)
|
raise ConfigurationError(
|
||||||
|
"%s services with 'links' cannot be extended" % error_prefix)
|
||||||
|
|
||||||
if 'volumes_from' in service_dict:
|
if 'volumes_from' in service_dict:
|
||||||
raise ConfigurationError("%s services with 'volumes_from' cannot be extended" % error_prefix)
|
raise ConfigurationError(
|
||||||
|
"%s services with 'volumes_from' cannot be extended" % error_prefix)
|
||||||
|
|
||||||
if 'net' in service_dict:
|
if 'net' in service_dict:
|
||||||
if get_service_name_from_net(service_dict['net']) is not None:
|
if get_service_name_from_net(service_dict['net']) is not None:
|
||||||
raise ConfigurationError("%s services with 'net: container' cannot be extended" % error_prefix)
|
raise ConfigurationError(
|
||||||
|
"%s services with 'net: container' cannot be extended" % error_prefix)
|
||||||
|
|
||||||
|
|
||||||
def process_container_options(service_dict, working_dir=None):
|
def process_container_options(service_dict, working_dir=None):
|
||||||
|
|
Loading…
Reference in New Issue