vagrant-config_builder 0.10.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad642e21b08ad1ad7baf002cd01ec1167758a332
-  data.tar.gz: 8f473ceb06a835407c996de34a96c609ab8a0cc0
+  metadata.gz: b242f323d273ed6a555d016d2281609563d28620
+  data.tar.gz: badb6da19a3ec43aea229f162ea616b5e04be7c5
 SHA512:
-  metadata.gz: 8cc9a6ba0eeb0dff69ff001b477b5e4473c072d29ca76f554840a630bdd6cd348df9562d80d645954ff846dbbb365bee82b55bd890b3104b6c62c0525822a443
-  data.tar.gz: ed2c49b370655683309dbffe8cabc7b38bb505ed68e4f92eda5e6a4722d43878a3294a37d50fbd03e5105f23fc39e5ec5e11cd937c99de5d1f7be095238fab17
+  metadata.gz: c78a02cc55ebf0fc674ca2cc3e0038350fd3ffacdd55bbaa659c18e88dcf008f630ba3e1bf9c8c48c07ef3e442383815edac8393582b6a44c34772b7210a940a
+  data.tar.gz: ab497c2f941c60880b6aafa1c586dda6d3f4acfe3a4c6f762d8f8506f7c3066223a9ff89786160796924fc692479b0b60cb701f285992304b2602cc453e7fc49

data/CHANGELOG

@@ -1,6 +1,24 @@
 CHANGELOG
 =========
 
+0.11.0
+------
+
+2014-09-17
+
+This is a backwards feature release.
+
+  * (GH-23) Fix misspelling of `disabled` option for synced folders.
+
+  * (GH-26) Enable configuration of global WinRM options.
+
+  * Enable configuration of global SSH options.
+
+  * Enable configuration of additional box download options such as
+    checksumming and versioning.
+
+Thanks to Nan Liu and Ethan Brown for their contributions to this release.
+
 0.10.1
 ------
 

data/lib/config_builder/model/root.rb

@@ -6,9 +6,27 @@ class ConfigBuilder::Model::Root < ConfigBuilder::Model::Base
   include ConfigBuilder::ModelDelegator
 
   def_model_delegator :vagrant
-  def_model_delegator :ssh
   def_model_delegator :vms
 
+  # @!attribute [rw] ssh
+  #   @return [Hash<Symbol, Object>] The ssh configuration for all VMs
+  #   @example
+  #     >> config.ssh
+  #     => {
+  #           :username => 'administrator',
+  #           :password => 'vagrant',
+  #        }
+  def_model_delegator :ssh
+
+  # @!attribute [rw] winrm
+  #   @return [Hash<Symbol, Object>] The winrm configuration for all VMs
+  #   @example
+  #     >> config.winrm
+  #     => {
+  #           :username => 'administrator',
+  #           :password => 'vagrant',
+  #        }
+  def_model_delegator :winrm
 
   def initialize
     @defaults = {:vms => [], :vagrant => {}}
@@ -36,6 +54,16 @@ class ConfigBuilder::Model::Root < ConfigBuilder::Model::Base
   end
 
   def eval_ssh(root_config)
+    with_attr(:ssh) do |ssh_config|
+      f = ConfigBuilder::Model::SSH.new_from_hash(ssh_config)
+      f.call(root_config)
+    end
+  end
 
+  def eval_winrm(root_config)
+    if attr(:winrm)
+      f = ConfigBuilder::Model::WinRM.new_from_hash(attr(:winrm))
+      f.call(root_config)
+    end
   end
 end

data/lib/config_builder/model/ssh.rb

@@ -1,10 +1,110 @@
+# Vagrant SSH credential model
+#
 # @see http://docs.vagrantup.com/v2/vagrantfile/ssh_settings.html
 class ConfigBuilder::Model::SSH < ConfigBuilder::Model::Base
+  # @!attribute [rw] username
+  #   @return [String] This sets the username that Vagrant will SSH as by
+  #     default. Providers are free to override this if they detect a more
+  #     appropriate user. By default this is "vagrant," since that is what most
+  #     public boxes are made as.
+  def_model_attribute :username
+
+  # @!attribute [rw] password
+  #   @return [String] This sets a password that Vagrant will use to
+  #     authenticate the SSH user. Note that Vagrant recommends you use
+  #     key-based authentiation rather than a password (see #private_key_path)
+  #     below. If you use a password, Vagrant will automatically insert a
+  #     keypair if `insert_key` is true.
+  def_model_attribute :password
+
+  # @!attribute [rw] host
+  #   @return [String] The hostname or IP to SSH into. By default this is
+  #     empty, because the provider usually figures this out for you.
+  def_model_attribute :host
+
+  # @!attribute [rw] port
+  #   @return [Fixnum] The port to SSH into. By default this is port 22.
+  def_model_attribute :port
+
   # @!attribute [rw] guest_port
-  # @!attribute [rw] keepalive
-  # @!attribute [rw] max_tries
-  # @!attribute [rw] timeout
-  # @!attribute [rw] forward_x11
+  #   @return [Fixnum] The port on the guest that SSH is running on. This is
+  #     used by some providers to detect forwarded ports for SSH. For example,
+  #     if this is set to 22 (the default), and Vagrant detects a forwarded
+  #     port to port 22 on the guest from port 4567 on the host, Vagrant will
+  #     attempt to use port 4567 to talk to the guest if there is no other
+  #     option.
+  def_model_attribute :guest_port
+
+  # @!attribute [rw] private_key_path
+  #   @return [String] The path to the private key to use to SSH into the guest
+  #     machine. By default this is the insecure private key that ships with
+  #     Vagrant, since that is what public boxes use. If you make your own
+  #     custom box with a custom SSH key, this should point to that private
+  #     key.
+  #
+  #     You can also specify multiple private keys by setting this to be an
+  #     array. This is useful, for example, if you use the default private key
+  #     to bootstrap the machine, but replace it with perhaps a more secure key
+  #     later.
+  def_model_attribute :private_key_path
+
   # @!attribute [rw] forward_agent
+  #   @return [Boolean] If `true`, agent forwarding over SSH connections is
+  #     enabled. Defaults to `false`.
+  def_model_attribute :forward_agent
+
+  # @!attribute [rw] forward_x11
+  #   @return [Boolean] If `true`, X11 forwarding over SSH connections is
+  #     enabled. Defaults to `false`.
+  def_model_attribute :forward_x11
+
+  # @!attribute [rw] insert_key
+  #   @return [Boolean] If `true`, Vagrant will automatically insert an insecure
+  #     keypair to use for SSH. By default, this is `true`. This only has an
+  #     effect if you don't already use private keys for authentication.
+  def_model_attribute :insert_key
+
+  # @!attribute [rw] proxy_command
+  #   @return [String] A command-line command to execute that receives the data
+  #     to send to SSH on stdin. This can be used to proxy the SSH connection.
+  #     `%h` in the command is replaced with the host and `%p` is replaced with
+  #     the port.
+  def_model_attribute :proxy_command
+
+  # @!attribute [rw] pty
+  #   @return [Boolean] If `true`, pty will be used for provisioning. Defaults
+  #     to `false`.
+  #
+  #     This setting is an _advanced feature_ that should not be enabled unless
+  #     absolutely necessary. It breaks some other features of Vagrant, and is
+  #     really only exposed for cases where it is absolutely necessary. If you
+  #     can find a way to not use a pty, that is recommended instead.
+  def_model_attribute :pty
+
   # @!attribute [rw] shell
+  #   @return [String] The shell to use when executing SSH commands from
+  #     Vagrant. By default this is `bash -l`. Note that this has no effect on
+  #     the shell you get when you run `vagrant ssh`. This configuration option
+  #     only affects the shell to use when executing commands internally in
+  #     Vagrant.
+  def_model_attribute :shell
+
+  def to_proc
+    Proc.new do |global_config|
+      ssh = global_config.ssh
+
+      with_attr(:username)         { |val| ssh.username = val }
+      with_attr(:password)         { |val| ssh.password = val }
+      with_attr(:host)             { |val| ssh.host = val }
+      with_attr(:port)             { |val| ssh.port = val }
+      with_attr(:guest_port)       { |val| ssh.guest_port = val }
+      with_attr(:private_key_path) { |val| ssh.private_key_path = val }
+      with_attr(:forward_agent)    { |val| ssh.forward_agent = val }
+      with_attr(:forward_x11)      { |val| ssh.forward_x11 = val }
+      with_attr(:insert_key)       { |val| ssh.insert_key = val }
+      with_attr(:proxy_command)    { |val| ssh.proxy_command = val }
+      with_attr(:pty)              { |val| ssh.pty = val }
+      with_attr(:shell)            { |val| ssh.shell = val }
+    end
+  end
 end

data/lib/config_builder/model/synced_folder.rb

@@ -35,7 +35,7 @@ class ConfigBuilder::Model::SyncedFolder < ConfigBuilder::Model::Base
   def folder_opts
     h = {}
     with_attr(:extra)   { |val| h[:extra]    = val }
-    with_attr(:disable) { |val| h[:disabled] = val }
+    with_attr(:disabled) { |val| h[:disabled] = val }
     with_attr(:nfs)     { |val| h[:nfs]      = val }
 
     h

data/lib/config_builder/model/vm.rb

@@ -73,18 +73,75 @@ class ConfigBuilder::Model::VM < ConfigBuilder::Model::Base
   #
   def_model_delegator :synced_folders
 
-  # @!attribute [rw] box
-  #   @return [String] The name of the Vagrant box to instantiate for this VM
-  def_model_attribute :box
-
   # @!attribute [rw] guest
   #   @return [String] The guest type to use for this VM
   def_model_attribute :guest
 
-  # @!attribute [rw] box_url
-  #   @return [String] The source URL for the Vagrant box associated with this VM
+  # @!attribute [rw] box
+  #   @return [String] This configures what box the machine will be brought up
+  #     against. The value here should be the name of an installed box or a
+  #     shorthand name of a box in Vagrant Cloud.
   def_model_attribute :box
 
+  # @!attribute [rw] box_url
+  #   @return [String, Array<String>] The URL that the configured box can be
+  #     found at. If `box` is a shorthand to a box in Vagrant Cloud then this
+  #     value doesn't need to be specified. Otherwise, it should point to the
+  #     proper place where the box can be found if it isn't installed.
+  #
+  #     This can also be an array of multiple URLs. The URLs will be tried in
+  #     order. Note that any client certificates, insecure download settings,
+  #     and so on will apply to all URLs in this list.
+  #
+  #     The URLs can also be local files by using the file:// scheme. For
+  #     example: "file:///tmp/test.box".
+  def_model_attribute :box_url
+
+  # @!attribute [rw] box_download_checksum
+  #   @return [String] The checksum of the box specified by `box_url`.
+  #     If not specified, no checksum comparison will be done. If specified,
+  #     Vagrant will compare the checksum of the downloaded box to this value
+  #     and error if they do not match. Checksum checking is only done when
+  #     Vagrant must download the box.
+  #
+  #     If this is specified, then `box_download_checksum_type` must also be
+  #     specified.
+  def_model_attribute :box_download_checksum
+
+  # @!attribute [rw] box_download_checksum_type
+  #   @return [String] The type of checksum specified by
+  #     `box_download_checksum` (if any). Supported values are currently `md5`,
+  #     `sha1`, and `sha256`.
+  def_model_attribute :box_download_checksum_type
+
+  # @!attribute [rw] box_download_client_cert
+  #   @return [String] Path to a client certificate to use when downloading the
+  #     box, if it is necessary. By default, no client certificate is used to
+  #     download the box.
+  def_model_attribute :box_download_client_cert
+
+  # @!attribute [rw] box_download_insecure
+  #   @return [Boolean] If `true`, then SSL certificates from the server will
+  #     not be verified. By default, if the URL is an HTTPS URL, then SSL certs
+  #     will be verified.
+  def_model_attribute :box_download_insecure
+
+  # @!attribute [rw] box_check_update
+  #   @return [Boolean] If true, Vagrant will check for updates to the
+  #     configured box on every `vagrant up`. If an update is found, Vagrant
+  #     will tell the user. By default this is `true`. Updates will only be
+  #     checked for boxes that properly support updates (boxes from Vagrant
+  #     Cloud or some other versioned box).
+  def_model_attribute :box_check_update
+
+  # @!attribute [rw] box_version
+  #   @return [String] The version of the box to use. This defaults to ">= 0"
+  #     (the latest version available). This can contain an arbitrary list of
+  #     constraints, separated by commas, such as: >= 1.0, < 1.5. When
+  #     constraints are given, Vagrant will use the latest available box
+  #     satisfying these constraints.
+  def_model_attribute :box_version
+
   # @!attribute [rw] name
   #   @return [String] The name of the instantiated box in this environment
   def_model_attribute :name
@@ -113,8 +170,15 @@ class ConfigBuilder::Model::VM < ConfigBuilder::Model::Base
       global_config.vm.define(attr(:name)) do |config|
         vm_config = config.vm
 
-        with_attr(:box)      { |val| vm_config.box      = attr(:box)      }
-        with_attr(:box_url)  { |val| vm_config.box_url  = attr(:box_url)  }
+        with_attr(:box)                        { |val| vm_config.box = val }
+        with_attr(:box_url)                    { |val| vm_config.box_url = val }
+        with_attr(:box_download_checksum)      { |val| vm_config.box_download_checksum = val }
+        with_attr(:box_download_checksum_type) { |val| vm_config.box_download_checksum_type = val }
+        with_attr(:box_download_client_cert)   { |val| vm_config.box_download_client_cert = val }
+        with_attr(:box_download_insecure)      { |val| vm_config.box_download_insecure = val }
+        with_attr(:box_check_update)           { |val| vm_config.box_check_update = val }
+        with_attr(:box_version)                { |val| vm_config.box_version = val }
+
         with_attr(:hostname) { |val| vm_config.hostname = attr(:hostname) }
         with_attr(:guest)    { |val| vm_config.guest    = attr(:guest)    }
 

data/lib/config_builder/model/winrm.rb

@@ -0,0 +1,56 @@
+# Vagrant WinRM credential model.
+#
+# @see http://docs.vagrantup.com/v2/vagrantfile
+class ConfigBuilder::Model::WinRM < ConfigBuilder::Model::Base
+  # @!attribute [rw] username
+  #   @return [String] This sets the username that Vagrant will WinRM as by
+  #     default. Providers are free to override this if they detect a more
+  #     appropriate user. By default this is "vagrant," since that is what most
+  #     public boxes are made as.
+  def_model_attribute :username
+
+  # @!attribute [rw] password
+  #   @return [String] This sets a password that Vagrant will use to
+  #     authenticate the WinRM user.
+  def_model_attribute :password
+
+  # @!attribute [rw] host
+  #   @return [String] The hostname or IP to WinRM into. By default this is
+  #     empty, because the provider usually figures this out for you.
+  def_model_attribute :host
+
+  # @!attribute [rw] port
+  #   @return [Fixnum] The port to WinRM into. By default this is port 5985.
+  def_model_attribute :port
+
+  # @!attribute [rw] guest_port
+  #   @return [Fixnum] The port on the guest that WinRM is running on.
+  #     This is used by some providers to detect forwarded ports for WinRM.
+  #     For example, if this is set to 5985 (the default), and Vagrant detects
+  #     a forwarded port to port 5985 on the guest from port 4567 on the host,
+  #     Vagrant will attempt to use port 4567 to talk to the guest if there is
+  #     no other option.
+  def_model_attribute :guest_port
+
+  # @!attribute [rw] max_tries
+  #   @return [Fixnum] Maximum number of retry attempts.  By default this is 20.
+  def_model_attribute :max_tries
+
+  # @!attribute [rw] timeout
+  #   @return [Fixnum] The timeout in seconds.  By default this is 1800 seconds.
+  def_model_attribute :timeout
+
+  def to_proc
+    Proc.new do |global_config|
+      winrm = global_config.winrm
+
+      with_attr(:username)   { |val| winrm.username = val }
+      with_attr(:password)   { |val| winrm.password = val }
+      with_attr(:host)       { |val| winrm.host = val }
+      with_attr(:guest)      { |val| winrm.guest = val }
+      with_attr(:guest_port) { |val| winrm.guest_port = val }
+      with_attr(:max_tries)  { |val| winrm.max_tries = val }
+      with_attr(:timeout)    { |val| winrm.timeout = val }
+    end
+  end
+end

data/lib/config_builder/model.rb

@@ -11,6 +11,7 @@ module ConfigBuilder
     require 'config_builder/model/root'
 
     require 'config_builder/model/ssh'
+    require 'config_builder/model/winrm'
     #require 'config_builder/model/host'
 
     require 'config_builder/model/vm'

data/lib/config_builder/version.rb

@@ -1,3 +1,3 @@
 module ConfigBuilder
-  VERSION = '0.10.1'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-config_builder
 version: !ruby/object:Gem::Version
-  version: 0.10.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Adrien Thebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-08 00:00:00.000000000 Z
+date: 2014-09-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -77,6 +77,7 @@ files:
 - lib/config_builder/model/ssh.rb
 - lib/config_builder/model/synced_folder.rb
 - lib/config_builder/model/vm.rb
+- lib/config_builder/model/winrm.rb
 - lib/config_builder/model_delegator.rb
 - lib/config_builder/plugin.rb
 - lib/config_builder/runner.rb