vagrant-cosmic 0.1.0

data/lib/vagrant-cosmic/service/cosmic_resource_service.rb

@@ -0,0 +1,76 @@
+require 'vagrant-cosmic/exceptions/exceptions'
+
+module VagrantPlugins
+  module Cosmic
+    module Service
+      class CosmicResourceService
+        include VagrantPlugins::Cosmic::Exceptions
+
+        def initialize(cosmic_compute, ui)
+          @cosmic_compute = cosmic_compute
+          @ui                 = ui
+        end
+
+        def sync_resource(resource, api_parameters = {})
+          @resource_details = nil
+          if resource.id.nil? and !(resource.name.nil? || resource.name.empty? )
+            resource.id = name_to_id(resource.name, resource.kind, api_parameters)
+          elsif resource.id
+            resource.name = id_to_name(resource.id, resource.kind, api_parameters)
+          end
+
+          unless resource.is_id_undefined? || resource.is_name_undefined?
+            resource.details = @resource_details
+            @ui.detail("Syncronized resource: #{resource}")
+          end
+        end
+
+        private
+
+        def translate_from_to(resource_type, options)
+          if resource_type == 'public_ip_address'
+            pluralised_type = 'public_ip_addresses'
+          else
+            pluralised_type = "#{resource_type}s"
+          end
+
+          full_response = @cosmic_compute.send("list_#{pluralised_type}".to_sym, options)
+          full_response["list#{pluralised_type.tr('_', '')}response"][resource_type.tr('_', '')]
+        end
+
+        def resourcefield_to_id(resource_type, resource_field, resource_field_value, options={})
+          @ui.info("Fetching UUID for #{resource_type} with #{resource_field} '#{resource_field_value}'")
+          full_response = translate_from_to(resource_type, options)
+          @resource_details = full_response.find {|type| type[resource_field] == resource_field_value } if full_response
+          if @resource_details
+            @resource_details['id']
+          else
+            raise CosmicResourceNotFound.new("No UUID found for #{resource_type} with #{resource_field} '#{resource_field_value}'")
+          end
+        end
+
+        def id_to_resourcefield(resource_id, resource_type, resource_field, options={})
+          @ui.info("Fetching #{resource_field} for #{resource_type} with UUID '#{resource_id}'")
+          options = options.merge({'id' => resource_id})
+          begin
+            full_response = translate_from_to(resource_type, options)
+          rescue Fog::Cosmic::Compute::BadRequest => e
+            raise CosmicResourceNotFound.new("No Name found for #{resource_type} with UUID '#{resource_id}', #{e.class.to_s} reports:\n #{e.message}")
+          end
+          @resource_details = full_response[0]
+          @resource_details[resource_field]
+        end
+
+        def name_to_id(resource_name, resource_type, options={})
+          resource_field = resource_type == 'public_ip_address' ? 'ipaddress' : 'name'
+          resourcefield_to_id(resource_type, resource_field, resource_name, options)
+        end
+
+        def id_to_name(resource_id, resource_type, options={})
+          resource_field = resource_type == 'public_ip_address' ? 'ipaddress' : 'name'
+          id_to_resourcefield(resource_id, resource_type, resource_field, options)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+module VagrantPlugins
+  module Cosmic
+    module Util
+      class Timer
+        # A basic utility method that times the execution of the given
+        # block and returns it.
+        def self.time
+          start_time = Time.now.to_f
+          yield
+          end_time = Time.now.to_f
+
+          end_time - start_time
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-cosmic/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module Cosmic
+    VERSION = '0.1.0'
+  end
+end

data/lib/vagrant-cosmic.rb

@@ -0,0 +1,17 @@
+require "pathname"
+require "vagrant-cosmic/plugin"
+
+module VagrantPlugins
+  module Cosmic
+    lib_path = Pathname.new(File.expand_path("../vagrant-cosmic", __FILE__))
+    autoload :Action, lib_path.join("action")
+    autoload :Errors, lib_path.join("errors")
+
+    # This returns the path to the source of this plugin.
+    #
+    # @return [Pathname]
+    def self.source_root
+      @source_root ||= Pathname.new(File.expand_path("../../", __FILE__))
+    end
+  end
+end

data/locales/en.yml

@@ -0,0 +1,131 @@
+en:
+  vagrant_cosmic:
+    already_status: |-
+      The machine is already %{status}.
+    basic_network: |-
+      Network name or id defined but zone %{zone_name} is of network type 'Basic'
+      Network name or id will be ignored
+    launching_instance: |-
+      Launching an instance with the following settings...
+    launch_no_keypair_no_sshkey: |-
+      No keypair or ssh_key specified to launch your instance with.
+      Generating a temporary keypair for this instance...
+    launch_vpc_warning: |-
+      Warning! You're launching this instance into a VPC without an
+      elastic IP. Please verify you're properly connected to a VPN so
+      you can access this machine, otherwise Vagrant will not be able
+      to SSH into it.
+    not_created: |-
+      Instance is not created. Please run `vagrant up` first.
+    ready: |-
+      Machine is booted and ready for use!
+    rsync_not_found_warning: |-
+      Warning! Folder sync disabled because the rsync binary is missing.
+      Make sure rsync is installed and the binary can be found in the PATH.
+    rsync_folder: |-
+      Rsyncing folder: %{hostpath} => %{guestpath}
+    security_groups_disabled: |-
+      Security groups defined but not supported in the zone %{zone_name}
+      Defined security groups will be ignored
+    ssh_key_pair_creating: |-
+      Creating an SSH keypair in Cosmic...
+    ssh_key_pair_removing: |-
+      Deleting the SSH keypair in Cosmic...
+    ssh_key_pair_no_success_removing: |-
+      Removing SSH keypair returned unsuccesful (keypair name: %{name})
+    starting: |-
+      Starting the instance...
+    stopping: |-
+      Stopping the instance...
+    terminating: |-
+      Terminating the instance...
+    terminateinstance_done: |-
+      Done removing resources
+    waiting_for_ready: |-
+      Waiting for instance to become "ready"...
+    waiting_for_communicator: |-
+      Waiting for %{communicator} to become available...
+    enabling_static_nat: |-
+      Enabling Static NAT for this instance ...
+    disabling_static_nat: |-
+      Disabling Static NAT ...
+    creating_port_forwarding_rule: |-
+      Creating a port forwarding rule for this instance ...
+    deleting_port_forwarding_rule: |-
+      Deleting the port forwarding rule ...
+    deleting_volumes: |-
+      Deleting additional volumes ...
+    delete_volume_failed: |-
+       -- Failed to delete volume: %{volume_id}
+    detach_volume_failed: |-
+       -- Failed to detach volume: %{message}
+    creating_firewall_rule: |-
+      Creating a firewall rule ...
+    deleting_firewall_rule: |-
+      Deleting the firewall rule ...
+    warn_networks: |-
+      Warning! The Cosmic provider doesn't support any of the Vagrant
+      high-level network configurations (`config.vm.network`). They
+      will be silently ignored.
+    will_not_destroy: |-
+      The instance '%{name}' will not be destroyed, since the confirmation
+      was declined.
+    no_instance_found : |-
+      No instance found, already destroyed?
+
+    config:
+      api_key_required: |-
+        An access key ID must be specified via "api_key"
+      template_id_required: |-
+        A template_id  must be configured via "template_id"
+      secret_key_missing: |-
+        The specified secret key for Cosmic could not be found
+
+    errors:
+      fog_error: |-
+        There was an error talking to Cosmic. The error message is shown
+        below:
+
+        %{message}
+      instance_ready_timeout: |-
+        The instance never became "ready" in Cosmic. The timeout currently
+        set waiting for the instance to become ready is %{timeout} seconds.
+        Please verify that the machine properly boots. If you need more time
+        set the `instance_ready_timeout` configuration on the Cosmic provider.
+      rsync_error: |-
+        There was an error when attemping to rsync a share folder.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+      user_data_error: |-
+        The base64 encoded user data length (%{userdataLength}) is greater than 2048.
+
+    states:
+      short_not_created: |-
+        not created
+      long_not_created: |-
+        The instance is not created. Run `vagrant up` to create it.
+
+      short_starting: |-
+        starting
+      long_starting: |-
+        The instance is starting.
+
+      short_stopped: |-
+        stopped
+      long_stopped: |-
+        The instance is stopped. Run `vagrant up` to start it.
+
+      short_stopping: |-
+        stopping
+      long_stopping: |-
+        The instance is stopping. Wait until is completely stopped to 
+        run `vagrant up` and start it.
+
+      short_running: |-
+        running
+      long_running: |-
+        The instance is running. To stop this machine, you can run
+        `vagrant halt`. To destroy the machine, you can run `vagrant destroy`.

data/spec/spec_helper.rb

@@ -0,0 +1,53 @@
+require 'simplecov'
+require 'coveralls'
+require 'rspec/its'
+require 'i18n'
+
+Dir["#{__dir__}/vagrant-cosmic/support/**/*.rb"].each { |f| require f }
+
+SimpleCov.start
+Coveralls.wear!
+
+ZONE_NAME = 'Zone Name'.freeze
+ZONE_ID = 'Zone UUID'.freeze
+SERVICE_OFFERING_NAME = 'Service Offering Name'.freeze
+SERVICE_OFFERING_ID = 'Service Offering UUID'.freeze
+TEMPLATE_NAME = 'Template Name'.freeze
+TEMPLATE_ID = 'Template UUID'.freeze
+NETWORK_NAME = 'Network Name'.freeze
+NETWORK_ID = 'Network UUID'.freeze
+VPC_ID = 'VPC UUID'.freeze
+DISPLAY_NAME = 'Display Name'.freeze
+DISK_OFFERING_NAME = 'Disk Offering Name'.freeze
+DISK_OFFERING_ID = 'Disk Offering UUID'.freeze
+
+SERVER_ID = 'Server UUID'.freeze
+NETWORK_TYPE_ADVANCED = 'Advanced'.freeze
+NETWORK_TYPE_BASIC = 'Basic'.freeze
+SECURITY_GROUPS_ENABLED = true
+SECURITY_GROUPS_DISABLED = false
+SECURITY_GROUP_ID   = 'UUID of Security Group'.freeze
+SECURITY_GROUP_NAME = 'Name of Security Group'.freeze
+SECURITY_GROUP_DESC = 'Description of Security Group'.freeze
+
+PF_IP_ADDRESS = 'Public IP for port forwarding'.freeze
+PF_IP_ADDRESS_ID = 'UUID of Public IP for port forwarding'.freeze
+PF_TRUSTED_NETWORKS = 'IP Ranges to allow public access from'.freeze
+PF_RANDOM_START = 49_152
+GUEST_PORT_SSH = 22
+GUEST_PORT_WINRM = 5985
+GUEST_PORT_RDP = 3389
+
+COMMUNICATOR_SSH = 'VagrantPlugins::CommunicatorSSH::Communicator'.freeze
+COMMUNICATOR_WINRM = 'VagrantPlugins::CommunicatorWinRM::Communicator'.freeze
+
+SSH_GENERATED_PRIVATE_KEY = '-----BEGIN RSA PRIVATE KEY-----\nMIICWwIBA==\n-----END RSA PRIVATE KEY-----'.freeze
+SSH_GENERATED_KEY_NAME = 'SSH Generated Key Name'.freeze
+JOB_ID = 'UUID of a Job'.freeze
+PORT_FORWARDING_RULE_ID = 'UUID of port forwarding rule'.freeze
+ACL_ID = 'UUID of an ACL'.freeze
+GENERATED_PASSWORD = 'Generated password'.freeze
+VOLUME_ID = 'UUID of volume'.freeze
+
+I18n.load_path << File.expand_path('../../locales/en.yml', __FILE__)
+I18n.reload!

data/spec/vagrant-cosmic/action/read_ssh_info_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require 'vagrant-cosmic/action/read_ssh_info'
+require 'vagrant-cosmic/config'
+
+describe VagrantPlugins::Cosmic::Action::ReadSSHInfo do
+  let(:action) { VagrantPlugins::Cosmic::Action::ReadSSHInfo.new(nil, nil) }
+
+  describe "#fetch_nic_ip_address" do
+    subject { action.fetch_nic_ip_address(nics, domain_config) }
+
+    let(:nics) do
+      [
+        { "networkid" => "networkid1", "networkname" => "networkname1", "ipaddress" => "127.0.0.1" },
+        { "networkid" => "networkid2", "networkname" => "networkname2", "ipaddress" => "127.0.0.2" },
+        { "networkid" => "networkid3", "networkname" => "networkname3", "ipaddress" => "127.0.0.3" },
+      ]
+    end
+
+    let(:ssh_network_id)   { Vagrant::Plugin::V2::Config::UNSET_VALUE }
+    let(:ssh_network_name) { Vagrant::Plugin::V2::Config::UNSET_VALUE }
+
+    let(:domain_config) do
+      config = VagrantPlugins::Cosmic::Config.new
+      config.domain_config :cosmic do |cosmic|
+        cosmic.ssh_network_id   = ssh_network_id
+        cosmic.ssh_network_name = ssh_network_name
+      end
+      config.finalize!
+      config.get_domain_config(:cosmic)
+    end
+
+    context "without neither ssh_network_id and ssh_network_name" do
+      it { should eq "127.0.0.1" }
+    end
+
+    context "with ssh_network_id" do
+      context "when exists in nics" do
+        let(:ssh_network_id) { "networkid2" }
+
+        it { should eq "127.0.0.2" }
+      end
+
+      context "when not exists in nics" do
+        let(:ssh_network_id) { "unknown" }
+
+        it { should eq "127.0.0.1" }
+      end
+    end
+
+    context "with ssh_network_id" do
+      context "when exists in nics" do
+        let(:ssh_network_name) { "networkname3" }
+
+        it { should eq "127.0.0.3" }
+      end
+
+      context "when not exists in nics" do
+        let(:ssh_network_name) { "unknown" }
+
+        it { should eq "127.0.0.1" }
+      end
+    end
+
+    context "with both ssh_network_id and ssh_network_name" do
+      context "when exists in nics" do
+        let(:ssh_network_id)   { "networkid2" }
+        let(:ssh_network_name) { "networkname3" }
+
+        it { should eq "127.0.0.2" }
+      end
+
+      context "when not exists in nics" do
+        let(:ssh_network_id)   { "unknown" }
+        let(:ssh_network_name) { "unknown" }
+
+        it { should eq "127.0.0.1" }
+      end
+    end
+  end
+end

data/spec/vagrant-cosmic/action/retrieve_public_ip_port_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+require 'vagrant-cosmic/action/read_transport_info'
+require 'vagrant-cosmic/config'
+require 'fog/cosmic'
+
+describe VagrantPlugins::Cosmic::Action::ReadTransportInfo do
+  let(:action) {VagrantPlugins::Cosmic::Action::ReadTransportInfo.new }
+
+  describe '#retrieve_public_ip_port' do
+    subject { action.retrieve_public_ip_port(cosmic_compute, domain_config, machine) }
+
+    let(:cosmic_compute) { double('Fog::Cosmic::Compute') }
+    let(:machine) { double('Vagrant::Machine')}
+
+    let(:data_dir) { double('Pathname') }
+    let(:pf_public_port_file) { double('Pathname') }
+
+    let(:pf_ip_address) { 'ip_address_in_config' }
+    let(:pf_ip_address_from_server) { 'ip_address_from_server' }
+    let(:pf_ip_address_id) { 'ID of ip_address_in_config' }
+    let(:pf_public_port) { 'public_port_in_config' }
+    let(:pf_public_port_from_file) { 'public_port_from_file' }
+
+    let(:domain_config) do
+      config = VagrantPlugins::Cosmic::Config.new
+      config.domain_config :cosmic do |cfg|
+        cfg.pf_ip_address = pf_ip_address
+        cfg.pf_public_port = pf_public_port
+        cfg.pf_ip_address_id = pf_ip_address_id
+      end
+      config.finalize!
+      config.get_domain_config(:cosmic)
+    end
+
+    context 'without both ip address and port in config' do
+      it 'retrieves those configured values' do
+        should eq [pf_ip_address, pf_public_port]
+      end
+    end
+
+    context 'port not configured' do
+      let(:pf_public_port) { nil }
+
+      it 'retrieves the active port stored on filesystem' do
+        expect(machine).to receive(:data_dir).and_return(data_dir)
+        expect(data_dir).to receive(:join).and_return(pf_public_port_file)
+        expect(pf_public_port_file).to receive(:file?).and_return(true)
+        expect(File).to receive(:read).and_return(pf_public_port_from_file)
+
+        expect(subject).to eq [pf_ip_address, pf_public_port_from_file]
+      end
+    end
+
+    context 'only ID of ip address specified (and public port)' do
+      let(:pf_ip_address) { nil }
+
+      it 'resolves, and returns, the ip address from the ID' do
+        response = {
+          'listpublicipaddressesresponse' => {
+            'count' =>1,
+            'publicipaddress' =>[{
+              'id' => pf_ip_address_id,
+              'ipaddress' => pf_ip_address_from_server,
+              'allocated' => '2016-05-06T13:58:04+0200',
+              'zoneid' => 'UUID',
+              'zonename' => 'Name',
+              'issourcenat' =>false,
+              'account' => 'Name',
+              'domainid' => 'UUID',
+              'domain' => 'Name',
+              'forvirtualnetwork' =>true,
+              'isstaticnat' =>false,
+              'issystem' =>false,
+              'associatednetworkid' => 'UUID',
+              'associatednetworkname' => 'Name',
+              'networkid' => 'UUID',
+              'aclid' => 'UUID',
+              'state' => 'Allocated',
+              'physicalnetworkid' => 'UUID',
+              'vpcid' => 'UUID',
+              'tags' =>[],
+              'isportable' =>false
+            }]
+          }
+        }
+        expect(cosmic_compute).to receive(:list_public_ip_addresses)
+          .with(:id => pf_ip_address_id)
+          .and_return(response)
+
+        expect(subject).to eq [pf_ip_address_from_server, pf_public_port]
+      end
+    end
+  end
+end