Merge pull request #72 from mhahn/combine-namespace-environment

Make environment a required parameter.

Author: phobologic

README.rst

@@ -44,7 +44,7 @@ if you'd like to play with something smaller. To launch the stacks, after
 installing stacker and loading your AWS API keys in your environment
 (AWS\_ACCESS\_KEY\_ID & AWS\_SECRET\_ACCESS\_KEY), call the following::
 
-    stacker build -v -p BaseDomain=blahblah.com -r us-east-1 example.com conf/example.yaml
+    stacker build -v -p BaseDomain=blahblah.com -r us-east-1 conf/stage.env conf/example.yaml
 
 As of now there is no option to tear down the stack in the tool (we plan to
 add it), so you'll need to tear the stacks it creates down manually. When doing
@@ -77,12 +77,17 @@ parameter. If it finds it, it will use that automatically.
 Environments
 ============
 
-As well as definining the stack config, you can further customize the stack
-config via an environment (ie the ``-e or --environment`` argument).
+As well as defining the stack config, you'll need to specify an
+environment. The environment should point to a yaml formatted file that
+contains a flat dictionary (ie: only ``key: value`` pairs).  Those keys
+can be used in the stack config as python `string.Template`_ mappings.
 
-The environment should point at a yaml formatted file that contains a flat
-dictionary (ie: only key: value pairs).  Those keys can be used in the
-stack config as python `string.Template`_ mappings.
+At a minimum the environment must define the ``namespace`` parameter::
+
+  namespace: example.com
+
+This helps preserve the namespace for the stacks between subsequent
+builds.
 
 For example, if you wanted to name a stack based on the environment you were
 building it in, first you would create an environment file with the

conf/empire/example.env

@@ -8,6 +8,12 @@
 # Note: The minimum allowed azcount is 2.
 azcount: 2
 
+# namespace is a unique name that the stacks will be built under. This value
+# will be used to prefix the CloudFormation stack names as well as the s3
+# bucket that contains revisions of the stacker templates. This is the only
+# required environment variable.
+namespace:
+
 # An external domain where empire.<domain> CNAME will be created
 external_domain:
 ssh_key_name:

conf/rds/mysql.env

@@ -1,3 +1,9 @@
+# namespace is a unique name that the stacks will be built under. This value
+# will be used to prefix the CloudFormation stack names as well as the s3
+# bucket that contains revisions of the stacker templates. This is the only
+# required environment variable.
+namespace:
+
 # VPC settings
 azcount: 2
 nat_instance_type: m3.medium

conf/rds/postgres.env

@@ -1,3 +1,9 @@
+# namespace is a unique name that the stacks will be built under. This value
+# will be used to prefix the CloudFormation stack names as well as the s3
+# bucket that contains revisions of the stacker templates. This is the only
+# required environment variable.
+namespace:
+
 # VPC settings
 azcount: 2
 nat_instance_type: m3.medium

conf/stage.env

@@ -1,4 +1,9 @@
-# This is just an example of the format for environment files
+# This is an example of the format for environment files
 # You can use a flag dictionary in yaml format. Values can be strings or
-# numbers, but cannot be more complex data types (dictionaries, lists, etc)
-environment: stage
+# numbers, but cannot be more complex data types (dictionaries, lists, etc).j
+
+# namespace is a unique name that the stacks will be built under. This value
+# will be used to prefix the CloudFormation stack names as well as the s3
+# bucket that contains revisions of the stacker templates. This is the only
+# required environment variable.
+namespace:

stacker/commands/stacker/__init__.py

@@ -17,7 +17,6 @@ def configure(self, options, **kwargs):
         super(Stacker, self).configure(options, **kwargs)
         options.provider = aws.Provider(region=options.region)
         options.context = Context(
-            namespace=options.namespace,
             environment=options.environment,
             parameters=copy.deepcopy(options.parameters),
             # We use

stacker/commands/stacker/base.py

@@ -146,22 +146,17 @@ def add_arguments(self, parser):
         parser.add_argument("-r", "--region", default="us-east-1",
                             help="The AWS region to launch in. Default: "
                                  "%(default)s")
-        parser.add_argument("-e", "--environment", type=yaml_file_type,
-                            default={},
-                            help="Path to a yaml environment file. The values "
-                                 "in the environment file can be used in the "
-                                 "stack config as if it were a "
-                                 "string.Template type: "
-                                 "https://docs.python.org/2/library/"
-                                 "string.html#template-strings")
         parser.add_argument("-v", "--verbose", action="count", default=0,
                             help="Increase output verbosity. May be specified "
                                  "up to twice.")
-        parser.add_argument("namespace",
-                            help="The namespace for the stack collection. "
-                                 "This will be used as the prefix to the "
-                                 "cloudformation stacks as well as the s3 "
-                                 "bucket where templates are stored.")
-        parser.add_argument("config", type=argparse.FileType(),
-                            help="The config file where stack configuration "
-                                 "is located. Must be in yaml format.")
+        parser.add_argument('environment', type=yaml_file_type,
+                            default={},
+                            help="Path to a yaml environment file. The values in "
+                                 "the environment file can be used in the stack "
+                                 "config as if it were a string.Template type: "
+                                 "https://docs.python.org/2/library/string.html"
+                                 "#template-strings. Must define at least a "
+                                 "'namespace'.")
+        parser.add_argument('config', type=argparse.FileType(),
+                            help="The config file where stack configuration is "
+                                 "located. Must be in yaml format.")

stacker/context.py

@@ -1,3 +1,4 @@
+from .exceptions import MissingEnvironment
 from .config import parse_config
 from .stack import Stack
 
@@ -24,18 +25,21 @@ class Context(object):
 
     """
 
-    def __init__(self, namespace, environment=None, stack_names=None,
+    def __init__(self, environment, stack_names=None,
                  parameters=None, mappings=None, config=None,
                  force_stacks=None):
-        self.namespace = namespace
-        self.environment = environment or {}
+        try:
+            self.namespace = environment['namespace']
+        except KeyError:
+            raise MissingEnvironment(['namespace'])
+
+        self.environment = environment
         self.stack_names = stack_names or []
         self.parameters = parameters or {}
         self.mappings = mappings or {}
         self.config = config or {}
         self.force_stacks = force_stacks or []
-
-        self._base_fqn = namespace.replace('.', '-').lower()
+        self._base_fqn = self.namespace.replace('.', '-').lower()
 
     def load_config(self, conf_string):
         self.config = parse_config(conf_string, environment=self.environment)

stacker/tests/actions/test_build.py

@@ -41,7 +41,7 @@ def get_outputs(self, stack_name, *args, **kwargs):
 class TestBuildAction(unittest.TestCase):
 
     def setUp(self):
-        self.context = Context('namespace')
+        self.context = Context({'namespace': 'namespace'})
         self.build_action = build.Action(self.context, provider=TestProvider())
 
     def _get_context(self, **kwargs):
@@ -52,7 +52,7 @@ def _get_context(self, **kwargs):
              'else': 'bastion::something'}},
             {'name': 'other', 'parameters': {}}
         ]}
-        return Context('namespace', config=config, **kwargs)
+        return Context({'namespace': 'namespace'}, config=config, **kwargs)
 
     def test_resolve_parameters_referencing_non_existant_output(self):
         parameters = {

stacker/tests/actions/test_destroy.py

@@ -25,7 +25,7 @@ def __init__(self, name, tags=None, **kwargs):
 class TestDestroyAction(unittest.TestCase):
 
     def setUp(self):
-        self.context = Context('namespace')
+        self.context = Context({'namespace': 'namespace'})
         self.context.config = {
             'stacks': [
                 {'name': 'vpc'},