vagrant-orchestrate 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9272488db149ae92a448f1338dc9fbc34827651a
-  data.tar.gz: a55eb060f9ed8a64a9e836906418cf7370b79188
+  metadata.gz: 7b77cd8446da22ec260eeafa76cfeca730ead095
+  data.tar.gz: ea87fb3abb6f6431d4e059a0e7712dce4bb567c4
 SHA512:
-  metadata.gz: ed3c4b84dcadbf1c253d9a6e5c961e6130700e3a5f91e14cfdb2b672066f7ea340aec113a5f9c88b25b19d948a0aa1dbc014f3406be288b8967496a01167c33c
-  data.tar.gz: 487e3748e44e7b5610fab054f6e4db4e587e0d07d0b03b49cc8aaf74b079cc77852f7eb167f025faa4d9432710ca9b2397b5a739a2caf58af3e414f25d526294
+  metadata.gz: 13bc391116a4a4a528182801220960e560a563b510fde0949073d0320f9424af19507f6d99d2b0ada3875cc18c0db6d6bc774728faa853903b8c8d20745d5532
+  data.tar.gz: 31cba2e18c9f6262b564b671bdb77067398585089530057e01884e57f6a207a6aedb2557464f3c70a6cdf1ee032d3aadebaae8af6fed2235cb5a3c71e24325d2

data/.gitignore

@@ -16,3 +16,4 @@ mkmf.log
 /.vagrant/
 Vagrantfile
 .DS_Store
+servers.json

data/.rubocop.yml

@@ -16,3 +16,6 @@ StringLiterals:
 
 Style/FileName:
   Enabled: false
+
+Metrics/AbcSize:
+  Max: 100

data/README.md

@@ -83,8 +83,9 @@ line with `--ssh-username` and `--ssh-private-key-path`. The first line of the f
 managed servers that the `push` command will operate on.
 
 ```ruby
-managed_servers = %w( myserver1.mydomain.com myserver2.mydomain.com ) 
+managed_servers = %w( myserver1.mydomain.com myserver2.mydomain.com )
 ```
+#### Windows
 
 This works for Windows managed servers using WinRM as well
 
@@ -101,12 +102,98 @@ This works for Windows managed servers using WinRM as well
   config.winrm.transport = :sspinegotiate
 ```
 
+#### Plugins
+
 This also supports a self-contained way to install plugins, just list them in the required_plugins section
 
 ```ruby
 required_plugins = %w( vagrant-managed-servers vagrant-hostsupdater )
 ```
 
+#### Working with multiple environments
+It is a very common pattern in software development to have separate environments - e.g. dev, test, and prod.
+Vagrant Orchestrate offers a way to manage multiple environments using a combination of a single servers.json
+file and the name of the current git branch to know which the current environment is.
+
+```javascript
+# servers.json
+{
+  "environments": {
+    "dev": {
+      "servers": [
+        "dev.myapp.mydomain.com"
+      ]
+    },
+    "test": {
+      "servers": [
+        "test1.myapp.mydomain.com",
+        "test2.myapp.mydomain.com"
+      ]
+    },
+    "prod": {
+      "servers": [
+        "prod1.myapp.mydomain.com",
+        "prod2.myapp.mydomain.com",
+        "prod3.myapp.mydomain.com"
+      ]
+    }
+  }
+}
+```
+
+Add the following line to the top of your `Vagrantfile`
+
+```ruby
+managed_servers = VagrantPlugins::Orchestrate::Plugin.load_servers_for_branch
+```
+
+If you create git branches named `dev`, `test`, and `prod`, your vagrantfile will become environment aware and
+you'll only be able to see the servers appropriate for that environment.
+
+```
+$ git branch
+* dev
+  test
+  prod
+$ vagrant status
+Current machine states:
+
+local                     not created (virtualbox)
+dev.myapp.mydomain.com    not created (managed)
+
+$ git checkout test
+Switched to branch 'test'
+$ vagrant status
+Current machine states:
+
+local                     not created (virtualbox)
+test1.myapp.mydomain.com  not created (managed)
+test2.myapp.mydomain.com  not created (managed)
+
+$ git checkout prod
+Switched to branch 'prod'
+$ vagrant status
+Current machine states:
+
+local                     not created (virtualbox)
+prod1.myapp.mydomain.com  not created (managed)
+prod2.myapp.mydomain.com  not created (managed)
+prod3.myapp.mydomain.com  not created (managed)
+```
+
+Any branch that doesn't have a matching environment in the servers.json file will
+not list any managed servers.
+
+```
+$ git checkout -b my_feature_branch
+Switched to a new branch 'my_feature_branch'
+$ vagrant status
+Current machine states:
+
+local                     not created (virtualbox)
+```
+#### Puppet
+
 Experimental puppet templating support is available as well with the `--puppet` flag and associated options
 
 ```ruby
@@ -150,7 +237,7 @@ You can run vagrant with increased verbosity if you run into problems
     $ vagrant orchestrate push --debug
 
 ## Filtering managed commands
-It can be easy to make mistakes such as rebooting production if you have managed long-lived servers as well as local VMs defined in your Vagrantfile. We add some protection with the `orchestrate.filter_managed_commands` configuration setting, which will cause up, provision, reload, and destroy commands to be ignored for servers with the managed provider. 
+It can be easy to make mistakes such as rebooting production if you have managed long-lived servers as well as local VMs defined in your Vagrantfile. We add some protection with the `orchestrate.filter_managed_commands` configuration setting, which will cause up, provision, reload, and destroy commands to be ignored for servers with the managed provider.
 
 ```ruby
   config.orchestrate.filter_managed_commands = true

data/lib/vagrant-orchestrate/command/init.rb

@@ -15,12 +15,13 @@ module VagrantPlugins
         DEFAULT_SSH_PRIVATE_KEY_PATH = "{{YOUR_SSH_PRIVATE_KEY_PATH}}"
         DEFAULT_PLUGINS = ["vagrant-managed-servers"]
 
-        # rubocop:disable Metrics/AbcSize, MethodLength, Metrics/CyclomaticComplexity
+        # rubocop:disable Metrics/AbcSize, MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
         def execute
           options = {}
 
           options[:provisioners] = []
           options[:servers] = []
+          options[:environments] = []
           options[:plugins] = DEFAULT_PLUGINS
           options[:puppet_librarian_puppet] = true
           options[:puppet_hiera] = true
@@ -90,10 +91,14 @@ module VagrantPlugins
               options[:plugins] += p
             end
 
-            o.on("--servers x,y,z", Array, "A comma separated list of servers hostnames or IPs to deploy to") do |list|
+            o.on("--servers x,y,z", Array, "A CSV list of FQDNs to target managed servers") do |list|
               options[:servers] = list
             end
 
+            o.on("--environments x,y,z", Array, "A CSV list of environments. Takes precedence over --servers") do |list|
+              options[:environments] = list
+            end
+
             o.on("-f", "--force", "Force overwriting of files") do
               options[:force] = true
             end
@@ -102,29 +107,8 @@ module VagrantPlugins
           argv = parse_options(opts)
           return unless argv
 
-          if options[:provisioners].include? "puppet"
-            FileUtils.mkdir_p(File.join(@env.cwd, "puppet"))
-            if options[:puppet_librarian_puppet]
-              contents = TemplateRenderer.render(Orchestrate.source_root.join("templates/puppet/Puppetfile"))
-              write_file File.join("puppet", "Puppetfile"), contents, options
-              FileUtils.mkdir_p(File.join(@env.cwd, "puppet", "modules"))
-              write_file(File.join(@env.cwd, "puppet", "modules", ".gitignore"), "*", options)
-              options[:plugins] << "vagrant-librarian-puppet"
-            end
-
-            if options[:puppet_hiera]
-              contents = TemplateRenderer.render(Orchestrate.source_root.join("templates/puppet/hiera.yaml"))
-              write_file(File.join("puppet", "hiera.yaml"), contents, options)
-              FileUtils.mkdir_p(File.join(@env.cwd, "puppet", "hieradata"))
-              contents = TemplateRenderer.render(Orchestrate.source_root.join("templates/puppet/hiera/common.yaml"))
-              write_file(File.join(@env.cwd, "puppet", "hieradata", "common.yaml"), contents, options)
-            end
-
-            FileUtils.mkdir_p(File.join(@env.cwd, "puppet", "manifests"))
-            write_file(File.join(@env.cwd, "puppet", "manifests", "default.pp"),
-                       "# Your puppet code goes here",
-                       options)
-          end
+          init_puppet options
+          init_environments options
 
           options[:shell_paths] ||= options[:shell_inline] ? [] : [DEFAULT_SHELL_PATH]
           options[:winrm_username] ||= DEFAULT_WINRM_USERNAME
@@ -146,6 +130,7 @@ module VagrantPlugins
                                              ssh_password: options[:ssh_password],
                                              ssh_private_key_path: options[:ssh_private_key_path],
                                              servers: options[:servers],
+                                             environments: options[:environments],
                                              plugins: options[:plugins]
                                              )
           write_file("Vagrantfile", contents, options)
@@ -156,10 +141,51 @@ module VagrantPlugins
           # Success, exit status 0
           0
         end
-        # rubocop:enable Metrics/AbcSize, MethodLength, Metrics/CyclomaticComplexity
+        # rubocop:enable Metrics/AbcSize, MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
 
         private
 
+        def init_puppet(options)
+          return unless options[:provisioners].include? "puppet"
+
+          FileUtils.mkdir_p(File.join(@env.cwd, "puppet"))
+          if options[:puppet_librarian_puppet]
+            contents = TemplateRenderer.render(Orchestrate.source_root.join("templates/puppet/Puppetfile"))
+            write_file File.join("puppet", "Puppetfile"), contents, options
+            FileUtils.mkdir_p(File.join(@env.cwd, "puppet", "modules"))
+            write_file(File.join(@env.cwd, "puppet", "modules", ".gitignore"), "*", options)
+            options[:plugins] << "vagrant-librarian-puppet"
+          end
+
+          if options[:puppet_hiera]
+            contents = TemplateRenderer.render(Orchestrate.source_root.join("templates/puppet/hiera.yaml"))
+            write_file(File.join("puppet", "hiera.yaml"), contents, options)
+            FileUtils.mkdir_p(File.join(@env.cwd, "puppet", "hieradata"))
+            contents = TemplateRenderer.render(Orchestrate.source_root.join("templates/puppet/hiera/common.yaml"))
+            write_file(File.join(@env.cwd, "puppet", "hieradata", "common.yaml"), contents, options)
+          end
+
+          FileUtils.mkdir_p(File.join(@env.cwd, "puppet", "manifests"))
+          write_file(File.join(@env.cwd, "puppet", "manifests", "default.pp"),
+                     "# Your puppet code goes here", options)
+        end
+
+        def init_environments(options)
+          environments = options[:environments]
+          return unless environments.any?
+
+          contents = TemplateRenderer.render(Orchestrate.source_root.join("templates/environment/servers.json"),
+                                             environments: environments)
+          write_file("servers.json", contents, options)
+          @env.ui.info("You've created an environment aware configuration.")
+          @env.ui.info("To complete the process you need to do the following: ")
+          @env.ui.info(" 1. Add the target servers to servers.json")
+          @env.ui.info(" 2. Create a git branch for each environment")
+          environments.each do |env|
+            @env.ui.info("    git branch #{env}")
+          end
+        end
+
         def write_file(filename, contents, options)
           save_path = Pathname.new(filename).expand_path(@env.cwd)
           save_path.delete if save_path.exist? && options[:force]

data/lib/vagrant-orchestrate/plugin.rb

@@ -76,11 +76,53 @@ module VagrantPlugins
 
         # Set the logging level on all "vagrant" namespaced
         # logs as long as we have a valid level.
-        if level
-          Log4r::Logger.new("vagrant_orchestrate").tap do |logger|
-            logger.outputters = Log4r::Outputter.stderr
-            logger.level = level
+        @logger = Log4r::Logger.new("vagrant_orchestrate").tap do |logger|
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level || 6
+        end
+      end
+
+      def self.read_git_branch
+        @logger.debug("Reading git branch")
+        if ENV["GIT_BRANCH"]
+          git_branch = ENV["GIT_BRANCH"]
+          @logger.debug("Read git branch #{git_branch} from GIT_BRANCH environment variable")
+        else
+          command = "git rev-parse --abbrev-ref HEAD"
+          git_branch = `#{command}`.chomp
+          if git_branch.include? "fatal"
+            @logger.error("Unable to determine git branch `#{command}`. Is this a git repo?")
+            git_branch = nil
+          else
+            @logger.debug("Read git branch #{git_branch} using `#{command}`")
+          end
+        end
+        git_branch
+      end
+
+      def self.load_servers_for_branch
+        setup_logging
+
+        git_branch = read_git_branch
+        return [] if git_branch.nil?
+
+        begin
+          fail "servers.json not found" unless File.exist?("servers.json")
+          @logger.debug("Reading servers.json")
+          contents = IO.read("servers.json")
+          @logger.debug("Read servers.json:\n: #{contents}")
+
+          environments = JSON.parse(contents)["environments"]
+          if environments.key? git_branch
+            return environments[git_branch]["servers"]
+          else
+            @logger.info("No environment found for #{git_branch}, no servers loaded.")
+            return []
           end
+        rescue StandardError => ex
+          # Don't break the user's whole vagrantfile if we can't load the environment
+          @logger.error(ex.message)
+          return []
         end
       end
     end

data/lib/vagrant-orchestrate/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Orchestrate
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/spec/vagrant-orchestrate/command/init_spec.rb

@@ -277,6 +277,24 @@ describe VagrantPlugins::Orchestrate::Command::Init do
     end
   end
 
+  context "environments" do
+    let(:argv) { ["--environments", "a,b,c"] }
+    describe "vagrantfile" do
+      it "should contain the loading code" do
+        subject.execute
+        vagrantfile = File.readlines(File.join(iso_env.cwd, "Vagrantfile")).join
+        expect(vagrantfile).to include("managed_servers = VagrantPlugins::Orchestrate::Plugin.load_servers_for_branch")
+      end
+    end
+
+    describe "servers.json" do
+      it "should exist in the target directory" do
+        subject.execute
+        expect(Dir.entries(iso_env.cwd)).to include("servers.json")
+      end
+    end
+  end
+
   context "box" do
     describe "dummy.box" do
       it "winds up in the target directory" do

data/templates/environment/servers.json.erb

@@ -0,0 +1,11 @@
+{
+  "environments": {
+    <% environments.each_with_index do |environment, index| -%>
+    "<%= environment %>": {
+      "servers": [
+
+      ]
+    }<% if index < environments.length - 1 -%>,<% end -%>
+    <% end -%>
+  }
+}

data/templates/vagrant/Vagrantfile.erb

@@ -1,4 +1,8 @@
+<% if environments.any? -%>
+managed_servers = VagrantPlugins::Orchestrate::Plugin.load_servers_for_branch
+<% else -%>
 managed_servers = %w( <% servers.each do |s| -%><%= s %> <% end -%>)
+<% end -%>
 
 <% if plugins.any? -%>
 required_plugins = %w( <% plugins.each do |p| -%><%= p %> <% end -%>)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-orchestrate
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Christopher Baldauf
@@ -93,6 +93,7 @@ files:
 - spec/spec_helper.rb
 - spec/vagrant-orchestrate/command/init_spec.rb
 - spec/vagrant-orchestrate/command/root_spec.rb
+- templates/environment/servers.json.erb
 - templates/puppet/Puppetfile.erb
 - templates/puppet/hiera.yaml.erb
 - templates/puppet/hiera/common.yaml.erb