vagrant-azure 2.0.0.pre7 → 2.0.0.pre8

data/lib/vagrant-azure/config.rb

@@ -3,10 +3,12 @@
 # Licensed under the MIT License. See License in the project root for license information.
 require 'vagrant'
 require 'haikunator'
+require 'vagrant-azure/util/managed_image_helper'
 
 module VagrantPlugins
   module Azure
     class Config < Vagrant.plugin('2', :config)
+      include VagrantPlugins::Azure::Util::ManagedImagedHelper
 
       # The Azure Active Directory Tenant ID -- ENV['AZURE_TENANT_ID']
       #
@@ -43,6 +45,16 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :vm_name
 
+      # (Optional) DNS Name prefix of the virtual machine
+      #
+      # @return [String]
+      attr_accessor :dns_name
+
+      # (Optional) Network Security Group Name prefix of the virtual machine
+      #
+      # @return [String]
+      attr_accessor :nsg_name
+
       # Password for the VM -- This is not recommended for *nix deployments
       #
       # @return [String]
@@ -53,11 +65,51 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :vm_size
 
-      # (Optional) Name of the virtual machine image urn to use -- defaults to 'canonical:ubuntuserver:16.04.0-DAILY-LTS:latest'. See: https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-linux-cli-ps-findimage/
+      # (Optional) Name of the virtual machine image URN to use -- defaults to 'canonical:ubuntuserver:16.04.0-DAILY-LTS:latest'. See: https://azure.microsoft.com/en-us/documentation/articles/virtual-machines-linux-cli-ps-findimage/
       #
       # @return [String]
       attr_accessor :vm_image_urn
 
+      # (Optional) Custom OS Image URI (like: http://mystorage1.blob.core.windows.net/vhds/myosdisk1.vhd) -- default nil.
+      #
+      # @return [String]
+      attr_accessor :vm_vhd_uri
+
+      # (Optional) The Managed Image Id which will be used to build the VM
+      # (like: /subscriptions/{sub_id}/resourceGroups/{group_name}/providers/Microsoft.Compute/images/{image_name}) -- default nil.
+      #
+      # @return [String]
+      attr_accessor :vm_managed_image_id
+
+      # (Optional unless using custom image) OS of the custom image
+      #
+      # @return [String] "Linux" or "Windows"
+      attr_accessor :vm_operating_system
+
+      # (Optional) Array of data disks to attach to the VM
+      #
+      # sample of creating empty data disk
+      #     {
+      #         name: "mydatadisk1",
+      #         size_gb: 30
+      #     }
+      #
+      # sample of attaching an existing VHD as a data disk
+      #     {
+      #         name: "mydatadisk2",
+      #         vhd_uri: "http://mystorage.blob.core.windows.net/vhds/mydatadisk2.vhd"
+      #     },
+      #
+      # sample of attaching a data disk from image
+      #     {
+      #         name: "mydatadisk3",
+      #         vhd_uri: "http://mystorage.blob.core.windows.net/vhds/mydatadisk3.vhd",
+      #         image: "http: //storagename.blob.core.windows.net/vhds/VMImageName-datadisk.vhd"
+      #     }
+      #
+      # @return [Array]
+      attr_accessor :data_disks
+
       # (Optional) Name of the virtual network resource
       #
       # @return [String]
@@ -118,6 +170,7 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :wait_for_destroy
 
+
       def initialize
         @tenant_id = UNSET_VALUE
         @client_id = UNSET_VALUE
@@ -129,8 +182,15 @@ module VagrantPlugins
         @vm_name = UNSET_VALUE
         @vm_password = UNSET_VALUE
         @vm_image_urn = UNSET_VALUE
+        @vm_vhd_uri = UNSET_VALUE
+        @vm_image_reference_id = UNSET_VALUE
+        @vm_operating_system = UNSET_VALUE
+        @vm_managed_image_id = UNSET_VALUE
+        @data_disks = UNSET_VALUE
         @virtual_network_name = UNSET_VALUE
         @subnet_name = UNSET_VALUE
+        @dsn_name = UNSET_VALUE
+        @nsg_name = UNSET_VALUE
         @tcp_endpoints = UNSET_VALUE
         @vm_size = UNSET_VALUE
         @availability_set_name = UNSET_VALUE
@@ -150,15 +210,24 @@ module VagrantPlugins
         @client_id = ENV['AZURE_CLIENT_ID'] if @client_id == UNSET_VALUE
         @client_secret = ENV['AZURE_CLIENT_SECRET'] if @client_secret == UNSET_VALUE
 
-        @vm_name = Haikunator.haikunate(100) if @vm_name == UNSET_VALUE
+
         @resource_group_name = Haikunator.haikunate(100) if @resource_group_name == UNSET_VALUE
+        @vm_name = Haikunator.haikunate(100) if @vm_name == UNSET_VALUE
+        @vm_size = 'Standard_DS2_v2' if @vm_size == UNSET_VALUE
         @vm_password = nil if @vm_password == UNSET_VALUE
         @vm_image_urn = 'canonical:ubuntuserver:16.04.0-LTS:latest' if @vm_image_urn == UNSET_VALUE
+        @vm_vhd_uri = nil if @vm_vhd_uri == UNSET_VALUE
+        @vm_vhd_storage_account_id = nil if @vm_vhd_storage_account_id == UNSET_VALUE
+        @vm_operating_system = nil if @vm_operating_system == UNSET_VALUE
+        @vm_managed_image_id = nil if @vm_managed_image_id == UNSET_VALUE
+        @data_disks = [] if @data_disks == UNSET_VALUE
+
         @location = 'westus' if @location == UNSET_VALUE
         @virtual_network_name = nil if @virtual_network_name == UNSET_VALUE
         @subnet_name = nil if @subnet_name == UNSET_VALUE
+        @dns_name = nil if @dns_name == UNSET_VALUE
+        @nsg_name = nil if @nsg_name == UNSET_VALUE
         @tcp_endpoints = nil if @tcp_endpoints == UNSET_VALUE
-        @vm_size = 'Standard_DS2_v2' if @vm_size == UNSET_VALUE
         @availability_set_name = nil if @availability_set_name == UNSET_VALUE
 
         @instance_ready_timeout = 120 if @instance_ready_timeout == UNSET_VALUE
@@ -167,13 +236,15 @@ module VagrantPlugins
         @admin_username = (ENV['AZURE_VM_ADMIN_USERNAME'] || 'vagrant') if @admin_username == UNSET_VALUE
         @admin_password = (ENV['AZURE_VM_ADMIN_PASSWORD'] || '$Vagrant(0)') if @admin_password == UNSET_VALUE
         @winrm_install_self_signed_cert = true if @winrm_install_self_signed_cert == UNSET_VALUE
-        @deployment_template = nil if @deployment_template == UNSET_VALUE
         @wait_for_destroy = false if @wait_for_destroy == UNSET_VALUE
       end
 
       def validate(machine)
         errors = _detected_errors
 
+        errors << I18n.t("vagrant_azure.custom_image_os_error") if !@vm_vhd_uri.nil? && @vm_operating_system.nil?
+        errors << I18n.t("vagrant_azure.vhd_and_managed_image_error") if !@vm_vhd_uri.nil? && !@vm_managed_image_id.nil?
+        errors << I18n.t("vagrant_azure.manage_image_id_format_error") if !@vm_managed_image_id.nil? && !valid_image_id?(@vm_managed_image_id)
         # Azure connection properties related validation.
         errors << I18n.t('vagrant_azure.subscription_id.required') if @subscription_id.nil?
         errors << I18n.t('vagrant_azure.mgmt_endpoint.required') if @endpoint.nil?

data/lib/vagrant-azure/util/machine_id_helper.rb

@@ -1,3 +1,7 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License in the project root for license information.
+
 module VagrantPlugins
   module Azure
     module Util

data/lib/vagrant-azure/util/managed_image_helper.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License in the project root for license information.
+
+module VagrantPlugins
+  module Azure
+    module Util
+      module ManagedImagedHelper
+        ID_REGEX = /\/subscriptions\/(.+?)\/resourceGroups\/(.+?)\/providers\/Microsoft.Compute\/images\/(.+)/i
+
+        def image_id_matches(image_id)
+          image_id.match(ID_REGEX)
+        end
+
+        def image_id_captures(image_id)
+          image_id_matches(image_id).captures
+        end
+
+        def valid_image_id?(image_id)
+          match = image_id_matches(image_id)
+          match && match.captures.count == 3 && !match.captures.any?(&:nil?)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-azure/util/template_renderer.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License in the project root for license information.
+
+require "erb"
+
+module VagrantPlugins
+  module Azure
+    module Util
+      class TemplateRenderer
+        class << self
+          # Render a given template and return the result. This method optionally
+          # takes a block which will be passed the renderer prior to rendering, which
+          # allows the caller to set any view variables within the renderer itself.
+          #
+          # @return [String] Rendered template
+          def render(*args)
+            render_with(:render, *args)
+          end
+
+          # Method used internally to DRY out the other renderers. This method
+          # creates and sets up the renderer before calling a specified method on it.
+          def render_with(method, template, data = {})
+            renderer = new(template, data)
+            yield renderer if block_given?
+            renderer.send(method.to_sym)
+          end
+        end
+
+        def initialize(template, data = {})
+          @data = data
+          @template = template
+        end
+
+        def render
+          str = File.read(full_template_path)
+          ERB.new(str).result(OpenStruct.new(@data).instance_eval { binding })
+        end
+
+        # Returns the full path to the template, taking into accoun the gem directory
+        # and adding the `.erb` extension to the end.
+        #
+        # @return [String]
+        def full_template_path
+          template_root.join("#{@template}.erb").to_s.squeeze("/")
+        end
+
+        def template_root
+          Azure.source_root.join("templates")
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-azure/util/timer.rb

@@ -1,3 +1,7 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License in the project root for license information.
+
 module VagrantPlugins
   module Azure
     module Util

data/lib/vagrant-azure/util/vm_await.rb

@@ -1,3 +1,7 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License in the project root for license information.
+
 module VagrantPlugins
   module Azure
     module Util

data/lib/vagrant-azure/util/vm_status_translator.rb

@@ -1,3 +1,7 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License in the project root for license information.
+
 module VagrantPlugins
   module Azure
     module Util

data/lib/vagrant-azure/version.rb

@@ -4,6 +4,6 @@
 
 module VagrantPlugins
   module Azure
-    VERSION = '2.0.0.pre7'.freeze
+    VERSION = '2.0.0.pre8'.freeze
   end
 end

data/locales/en.yml

@@ -114,3 +114,9 @@ en:
       Waiting for instance to become "ready"...
     waiting_for_stop: |-
       Waiting for instance to become "stopped"...
+    custom_image_os_error:
+      If you provide a custom image, you must provide the operating system for the image (vm_operating_system).
+    vhd_and_managed_image_error:
+      Specifying both vm_vhd_uri and vm_managed_image_id is not supported. Please specify one or the other.
+    manage_image_id_format_error:
+      The vm_managed_image_id doesn't fit the expected format, plese verify it looks like '/subscriptions/{sub_id}/resourceGroups/{group_name}/providers/Microsoft.Compute/images/{image_name}'

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License in the project root for license information.
+
 require 'vagrant-azure'
 
 # import all the support files

data/spec/templates/arm/deployment_spec.rb

@@ -0,0 +1,169 @@
+# encoding: utf-8
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License in the project root for license information.
+
+require "spec_helper"
+require "vagrant-azure/util/template_renderer"
+
+module VagrantPlugins
+  module Azure
+    describe "deployment template" do
+
+      let(:options) {
+        {
+            operating_system: "linux",
+            location: "location",
+            endpoints: [22],
+            data_disks: []
+        }
+      }
+
+      describe "the basics" do
+        let(:subject) {
+          render(options)
+        }
+
+        it "should specify schema" do
+          expect(subject["$schema"]).to eq("http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json")
+        end
+
+        it "should specify content version" do
+          expect(subject["contentVersion"]).to eq("1.0.0.0")
+        end
+
+        it "should have 10 parameters" do
+          expect(subject["parameters"].count).to eq(10)
+        end
+
+        it "should have 14 variables" do
+          expect(subject["variables"].count).to eq(14)
+        end
+
+        it "should have 5 resources" do
+          expect(subject["resources"].count).to eq(5)
+        end
+      end
+
+      describe "resources" do
+        describe "virtual machine" do
+          let(:subject) {
+            render(options)["resources"].detect {|vm| vm["type"] == "Microsoft.Compute/virtualMachines"}
+          }
+
+          it "should depend on 1 resources without an AV Set" do
+            expect(subject["dependsOn"].count).to eq(1)
+          end
+
+          describe "with AV Set" do
+            let(:subject) {
+              template = render(options.merge(availability_set_name: "avSet"))
+              template["resources"].detect {|vm| vm["type"] == "Microsoft.Compute/virtualMachines"}
+            }
+
+            it "should depend on 2 resources with an AV Set" do
+              expect(subject["dependsOn"].count).to eq(2)
+            end
+          end
+
+          describe "with managed disk reference" do
+            let(:subject) {
+              template = render(options.merge(vm_managed_image_id: "image_id"))
+              template["resources"].detect {|vm| vm["type"] == "Microsoft.Compute/virtualMachines"}
+            }
+
+            it "should have an image reference id set to image_id" do
+              expect(subject["properties"]["storageProfile"]["imageReference"]["id"]).to eq("image_id")
+            end
+          end
+        end
+
+        describe "managed image" do
+          let(:subject) {
+            render(options)["resources"].detect {|vm| vm["type"] == "Microsoft.Compute/images"}
+          }
+          describe "with custom vhd" do
+            let(:vhd_uri_options) {
+              options.merge(
+                  vhd_uri: "https://my_image.vhd",
+                  operating_system: "Foo"
+              )
+            }
+            let(:subject) {
+              render(vhd_uri_options)["resources"].detect {|vm| vm["type"] == "Microsoft.Compute/images"}
+            }
+
+            it "should exist" do
+              expect(subject).not_to be_nil
+            end
+
+            it "should set the blob_uri" do
+              expect(subject["properties"]["storageProfile"]["osDisk"]["blobUri"]).to eq(vhd_uri_options[:vhd_uri])
+            end
+
+            it "should set the osType" do
+              expect(subject["properties"]["storageProfile"]["osDisk"]["osType"]).to eq(vhd_uri_options[:operating_system])
+            end
+          end
+
+          it "should not exist" do
+            expect(subject).to be_nil
+          end
+        end
+      end
+
+      describe "parameters" do
+        let(:base_keys) {
+          %w( storageAccountType adminUserName dnsLabelPrefix nsgLabelPrefix vmSize vmName subnetName virtualNetworkName
+              winRmPort )
+        }
+
+        let(:nix_keys) {
+          base_keys + ["sshKeyData"]
+        }
+
+        let(:subject) {
+          render(options)["parameters"]
+        }
+
+        it "should include all the *nix parameter keys" do
+          expect(subject.keys).to contain_exactly(*nix_keys)
+        end
+
+        describe "with Windows" do
+          let(:subject) {
+            render(options.merge(operating_system: "Windows"))["parameters"]
+          }
+
+          let(:win_keys) {
+            base_keys + ["adminPassword"]
+          }
+
+          it "should include all the windows parameter keys" do
+            expect(subject.keys).to contain_exactly(*win_keys)
+          end
+        end
+      end
+
+      describe "variables" do
+        let(:keys) {
+          %w(location addressPrefix subnetPrefix nicName publicIPAddressName publicIPAddressType
+              networkSecurityGroupName sshKeyPath vnetID subnetRef apiVersion
+              singleQuote doubleQuote managedImageName)
+        }
+
+        let(:subject) {
+          render(options)["variables"]
+        }
+
+        it "should include all the windows parameter keys" do
+          expect(subject.keys).to contain_exactly(*keys)
+        end
+      end
+
+
+      def render(options)
+        JSON.parse(VagrantPlugins::Azure::Util::TemplateRenderer.render("arm/deployment.json", options))
+      end
+    end
+  end
+end