vagrant-conoha 0.1.0

data/lib/vagrant-conoha/logging.rb

@@ -0,0 +1,39 @@
+module VagrantPlugins
+  module ConoHa
+    module Logging
+      # This initializes the logging so that our logs are outputted at
+      # the same level as Vagrant core logs.
+      def self.init
+        # Initialize logging
+        level = nil
+        begin
+          level = Log4r.const_get(ENV['VAGRANT_LOG'].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          begin
+            level = Log4r.const_get(ENV['VAGRANT_OPENSTACK_LOG'].upcase)
+          rescue NameError
+            level = nil
+          end
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil unless level.is_a?(Integer)
+
+        # Set the logging level
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new('vagrant_openstack')
+          out = Log4r::Outputter.stdout
+          out.formatter = Log4r::PatternFormatter.new(pattern: '%d | %5l | %m', date_pattern: '%Y-%m-%d %H:%M')
+          logger.outputters = out
+          logger.level = level
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-conoha/plugin.rb

@@ -0,0 +1,48 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The ConoHa provider must be run within Vagrant.'
+end
+
+require 'vagrant-conoha/version_checker'
+
+# This is a sanity check to make sure no one is attempting to install
+# this into an early Vagrant version.
+if Vagrant::VERSION < '1.4.0'
+  fail 'ConoHa provider is only compatible with Vagrant 1.4+'
+end
+
+module VagrantPlugins
+  module ConoHa
+    class Plugin < Vagrant.plugin('2')
+      name 'ConoHa'
+      description <<-DESC
+      This plugin enables Vagrant to manage machines in ConoHa.
+      DESC
+
+      config(:conoha, :provider) do
+        require_relative 'config'
+        Config
+      end
+
+      provider(:conoha, box_optional: true) do
+        ConoHa.init_i18n
+        ConoHa.init_logging
+        VagrantPlugins::ConoHa.check_version
+
+        # Load the actual provider
+        require_relative 'provider'
+        Provider
+      end
+
+      command('openstack') do
+        ConoHa.init_i18n
+        ConoHa.init_logging
+        VagrantPlugins::ConoHa.check_version
+
+        require_relative 'command/main'
+        Command::Main
+      end
+    end
+  end
+end

data/lib/vagrant-conoha/provider.rb

@@ -0,0 +1,50 @@
+require 'vagrant'
+
+require 'vagrant-conoha/action'
+
+module VagrantPlugins
+  module ConoHa
+    class Provider < Vagrant.plugin('2', :provider)
+      def initialize(machine)
+        @machine = machine
+      end
+
+      def action(name)
+        # Attempt to get the action method from the Action class if it
+        # exists, otherwise return nil to show that we don't support the
+        # given action.
+        action_method = "action_#{name}"
+        return Action.send(action_method) if Action.respond_to?(action_method)
+        nil
+      end
+
+      def ssh_info
+        # Run a custom action called "read_ssh_info" which does what it
+        # says and puts the resulting SSH info into the `:machine_ssh_info`
+        # key in the environment.
+        env = @machine.action('read_ssh_info')
+        env[:machine_ssh_info]
+      end
+
+      def state
+        # Run a custom action we define called "read_state" which does
+        # what it says. It puts the state in the `:machine_state_id`
+        # key in the environment.
+        env = @machine.action('read_state')
+
+        state_id = env[:machine_state_id]
+
+        # Get the short and long description
+        short = I18n.t("vagrant_openstack.states.short_#{state_id}")
+        long  = I18n.t("vagrant_openstack.states.long_#{state_id}")
+
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+
+      def to_s
+        'Vagrant ConoHa provider'
+      end
+    end
+  end
+end

data/lib/vagrant-conoha/utils.rb

@@ -0,0 +1,26 @@
+module VagrantPlugins
+  module ConoHa
+    class Utils
+      def initialize
+        @logger = Log4r::Logger.new('vagrant_openstack::action::config_resolver')
+      end
+
+      def get_ip_address(env)
+        addresses = env[:openstack_client].nova.get_server_details(env, env[:machine].id)['addresses']
+        addresses.each do |_, network|
+          network.each do |network_detail|
+            return network_detail['addr'] if network_detail['OS-EXT-IPS:type'] == 'fixed' && network_detail['version'] == 4
+          end
+        end
+        fail Errors::UnableToResolveIP if addresses.size == 0
+        if addresses.size == 1
+          net_addresses = addresses.first[1]
+        else
+          net_addresses = addresses[env[:machine].provider_config.networks[0]]
+        end
+        fail Errors::UnableToResolveIP if net_addresses.size == 0
+        net_addresses[0]['addr']
+      end
+    end
+  end
+end

data/lib/vagrant-conoha/version.rb

@@ -0,0 +1,15 @@
+module VagrantPlugins
+  module ConoHa
+    #
+    # Stable versions must respect the pattern given
+    # by VagrantPlugins::ConoHa::VERSION_PATTERN
+    #
+    VERSION = '0.1.0'
+
+    #
+    # Stable version must respect the naming convention 'x.y.z'
+    # where x, y and z are integers inside the range [0, 999]
+    #
+    VERSION_PATTERN = /^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$/
+  end
+end

data/lib/vagrant-conoha/version_checker.rb

@@ -0,0 +1,76 @@
+require 'colorize'
+require 'singleton'
+require 'vagrant-conoha/version'
+
+module VagrantPlugins
+  module ConoHa
+    class VersionChecker
+      include Singleton
+
+      #
+      # :latest, :outdated or :unstable
+      #
+      # A version is considered unstable if it does not
+      # respect the pattern or if it is greater than the
+      # latest from rubygem
+      #
+      attr_accessor :status
+
+      def initialize
+        @status = nil
+      end
+
+      #
+      # Check the latest version from rubygem and set the status
+      #
+      def check
+        return @status unless @status.nil?
+        latest  = Gem.latest_spec_for('vagrant-conoha').version.version
+        current = VagrantPlugins::ConoHa::VERSION
+
+        unless current =~ VERSION_PATTERN
+          @status = :unstable
+          print I18n.t('vagrant_openstack.version_unstable')
+          return
+        end
+
+        if latest.eql? current
+          @status = :latest
+          return
+        end
+
+        v_latest = latest.split('.').map(&:to_i)
+        v_current = current.split('.').map(&:to_i)
+
+        i_latest = v_latest[2] + v_latest[1] * 1000 + v_latest[0] * 1_000_000
+        i_current = v_current[2] + v_current[1] * 1000 + v_current[0] * 1_000_000
+
+        if i_current > i_latest
+          @status = :unstable
+          print I18n.t('vagrant_openstack.version_unstable')
+          return
+        end
+
+        @status = :outdated
+        print I18n.t('vagrant_openstack.version_outdated', latest: latest, current: current)
+      end
+
+      private
+
+      def print(message)
+        puts message.yellow
+        puts ''
+      end
+    end
+
+    # rubocop:disable Lint/HandleExceptions
+    def self.check_version
+      timeout(3, Errors::Timeout) do
+        VersionChecker.instance.check
+      end
+    rescue
+      # Do nothing whatever the failure cause
+    end
+    # rubocop:enable Lint/HandleExceptions
+  end
+end

data/locales/en.yml

@@ -0,0 +1,393 @@
+en:
+  vagrant_openstack:
+    global_error: |-
+      An unknown error happened in Vagrant ConoHa plugin
+
+      To easily debug what happened, we recommend to set the environment
+      variable VAGRANT_OPENSTACK_LOG to debug
+
+          $ export VAGRANT_OPENSTACK_LOG=debug
+
+      If doing this does not help fixing your issue, there may be a bug
+      in the provider. Please submit an issue on Github at
+      https://github.com/hironobu-s/vagrant-conoha
+      with the stracktrace and the logs.
+
+      We are looking for feedback, so feel free to ask questions or
+      describe features you would like to see in this provider.
+    version_outdated: |-
+      You're not using the latest version of the 'vagrant-conoha' plugin.
+      The latest version is %{latest}, yours is %{current}. You should update to the latest
+      version running the command :
+
+          $ vagrant plugin update vagrant-conoha
+    version_unstable: |-
+      You're not running a stable version of the 'vagrant-conoha' plugin.
+      Unless you are either developing on vagrant or have deliberatly installed a not
+      stable version, you should uninstall it an install the latest stable version
+      running commands :
+
+          $ vagrant plugin uninstall vagrant-conoha
+          $ vagrant plugin install vagrant-conoha
+    already_created: |-
+      The server is already created.
+    create_stack: |-
+      Creating Heat Stack.
+    delete_stack: |-
+      Deleting Heat Stack.
+    already_suspended: |-
+      The server is already suspended.
+    ongoing_task: |-
+      The server is currently running a task and cannot execute your request.
+    not_suspended: |-
+      The server is not currently "suspended" and cannot be resumed.
+    deleting_server: |-
+      Deleting server...
+    finding_flavor: |-
+      Finding flavor for server...
+    finding_image: |-
+      Finding image for server...
+    finding_networks: |-
+      Finding network(s) for server...
+    finding_volumes: |-
+      Finding volume(s) to attach on server...
+    launching_server: |-
+      Launching a server with the following settings...
+    not_created: |-
+      The server hasn't been created yet. Run `vagrant up` first.
+    ready: |-
+      The server is ready!
+    stopping_server: |-
+      Stopping server...
+    starting_server: |-
+      Starting server...
+    timeout: |-
+      Timeout!
+    trying_authentication: |-
+      Trying authentication...
+    rsync_folder: |-
+      Rsyncing folder: %{hostpath} => %{guestpath}
+    using_floating_ip: |-
+      Using floating IP %{floating_ip}
+    waiting_for_build: |-
+      Waiting for the server to be built...
+    waiting_for_ssh: |-
+      Waiting for SSH to become available...
+    waiting_stop: |-
+      Waiting for the server to stop...
+    waiting_start: |-
+      Waiting for the server to start...
+    waiting_deleted: |-
+      Waiting for the server to be deleted...
+    waiting_for_stack: |-
+      Waiting for Heat Stack to be created...
+    waiting_for_stack_deleted: |-
+      Waiting for Heat Stack to be created...
+    warn_networks: |-
+      Warning! This provider doesn't support any of the Vagrant
+      high-level network configurations (`config.vm.network`). They
+      will be silently ignored.
+    warn_network_identifier_is_assumed_to_be_an_id: |-
+      As Neutron endpoint is not available, the identifier '%{network}' is assumed to be an id (not a name).
+    warn_volume_identifier_is_assumed_to_be_an_id: |-
+      As Cinder endpoint is not available, the identifier '%{volume}' is assumed to be an id (not a name).
+    ssh_disabled_provisioning: |-
+      Provisioning will not be performed because provider config ssh_disabled is set to true
+    ssh_disabled_sync_folders: |-
+      Folders will not be synced because provider config ssh_disabled is set to true
+    disabled_sync_folders: |-
+      Sync folders are disabled in the provider configuration
+
+    config:
+      password_required: |-
+        A password is required.
+      username_required: |-
+        A username is required.
+      tenant_name_required: |-
+        A tenant name is required.
+      invalid_uri: |-
+        The value for %{key} is not a valid URI: %{uri}
+      invalid_stack: |-
+        One of the stacks in the stacks provider configuration is invalid
+        The configuration option should have the following format:
+        os.stacks                = [{
+          name: 'mystack',
+          template: '/path/to/heat_template.yml',
+        }]
+      invalid_endpoint_type: |-
+        endpoint_type must be publicURL, adminURL or internalURL (if not provided, default is publicURL)
+      metadata_must_be_hash: |-
+        Metadata must be a hash.
+      keypair_name_required: |-
+        Warning! You have specified ssh.private_key_path in your Vagrant configuration.
+        but nor keypair_name neither public_key_path are present. This provider
+        will automatically generate a new keypair and your configuration option
+        ssh.private_key_path will be overriden
+      private_key_missing: |-
+        config.ssh.private_key_path is required when either keypair_name or
+        public_key_path is set in Vagrantfile
+      ssh_username_deprecated: |-
+        ssh_username provider config is deprecated for vagrant-conoha.
+        If you are using it, it will continue to work but we recommend to switch to the
+        standard vagrant configuration option `config.ssh.username` instead
+      ssh_username_required: |-
+        vagrant standard configuration option `ssh.username` is required
+      invalid_value_for_parameter: |-
+        Invalid value '%{value}' for parameter '%{parameter}'
+
+    errors:
+      default: |-
+        %{message}
+      timeout: |-
+        Timeout occurred
+      authentication_required: |-
+        Authentication token is missing or no longer valid.
+      floating_ip_already_assigned: |-
+        Floating IP %{floating_ip} already assigned to another server
+      floating_ip_not_available: |-
+        Floating IP %{floating_ip} not available for this tenant
+      authentication_failed: |-
+        Authentication failed.
+      bad_authentication_endpoint: |-
+        Bad authentication endpoint.
+      create_bad_state: |-
+        While creating the server, it transitioned to an unexpected
+        state: '%{state}', instead of properly booting. Run `vagrant status`
+        to find out what can be done about this state, or `vagrant destroy`
+        if you want to start over.
+      no_matching_api_version: |-
+        No matching version found for %{api_name} API
+
+        %{version_list}
+        You must specify the desired %{api_name} API url by setting
+        the provider's property '%{url_property}'.
+      no_matching_flavor: |-
+        No matching flavor was found! Please check your flavor setting
+        to make sure you have a valid flavor chosen.
+      no_matching_image: |-
+        No matching image was found! Please check your image setting to
+        make sure you have a valid image chosen.
+      conflict_boot_volume: |-
+        When booting from an existing volume it is not authorized to specify in your Vagrantfile either 'image' or 'size' or 'delete_on_destroy'.
+        When booting from a newly creating volume it is not authorized to specify in your Vagrantfile either 'id' or 'name'.
+      sync_method_error: |-
+        Value '%{sync_method_value}' is not allowed for 'sync_method' configuration parameter. Valid values are 'rsync' and 'none'
+      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}
+      ssh_unavailble: |-
+        SSH server anavailable on instance %{host}. You should maybe increase the timeout value which currently is %{timeout} second(s).
+      no_arg_required_for_command: |-
+        Command '%{cmd}' does not required any argument.
+      unrecognized_arg_for_command: |-
+        Argument '%{arg}' unrecognized for command '%{cmd}'.
+      unable_to_resolve_floating_ip: |-
+        Vagrant was unable to resolve a floating ip to communicate with your OpenStack instance. Please specify in your Vagrantfile either `floating_ip` or `floating_ip_pool`.
+      unable_to_resolve_ip: |-
+        Vagrant was unable to resolve a valid ip to ssh on your OpenStack instance.
+      unable_to_resolve_ssh_key: |-
+        Vagrant was unable to resolve a valid ssh key to connect to your OpenStack instance. Please specify in your Vagrantfile either `public_key_path` or `keypair_name`.
+      invalid_network_format: |-
+        Network '%{network}' is not valid.
+      unresolved_network: |-
+        No matching network with id or name '%{network}'
+      unresolved_network_id: |-
+        No matching network with id '%{id}'
+      unresolved_network_name: |-
+        No matching network with name '%{name}'
+      conflict_network_name_id: |-
+        One (and only one) of 'id' or 'name' must be specified in network definition : %{network}
+      multiple_network_name: |-
+        More than one network exists with name '%{name}'. In this case you can't use name in network definition. Please, use id instead.
+      invalid_volume_format: |-
+        Volume '%{volume}' is not valid.
+      unresolved_volume: |-
+        No matching volume with id or name '%{volume}'
+      unresolved_volume_id: |-
+        No matching volume with id '%{id}'
+      unresolved_volume_name: |-
+        No matching volume with name '%{name}'
+      conflict_volume_name_id: |-
+        One (and only one) of 'id' or 'name' must be specified in volume definition : %{volume}
+      multiple_volume_name: |-
+        More than one volume exists with name '%{name}'. In this case you can't use name in volume definition. Please, use id instead.
+      missing_boot_option: |-
+        Either 'image' or 'volume_boot' configuration must be provided
+      conflict_boot_option: |-
+        Only one of 'image' and 'volume_boot' configuration must be provided
+      ssh_username_missing: |-
+        Vagrant was unable to resolve which ssh username to use to connect to the machine. Please provide config parameter `ssh.username`
+      instance_not_found: |-
+        Vagrant was unable to find the OpenStack instance used for your vagrant machine.
+        This can happen when the instance has been deleted via OpenStack APIs or OpenStack
+        Dashboard instead of using vagrant commands.
+        We recommend using the command `vagrant openstack reset` to reset
+        vagrant to a clear state
+      stack_not_found: |-
+        Heat stack not found
+      nerwork_service_unavailable: |-
+        Neutron service endpoint is not available, thus there is not way to retrieve
+        network id from its name. You have to provide only ids in your Vagrantfile.
+      volume_service_unavailable: |-
+        Cinder service endpoint is not available, thus there is not way to retrieve
+        volume id from its name. You have to provide only ids in your Vagrantfile.
+      server_status_error: |-
+        Server '%{server}' is in error status.
+      stack_status_error: |-
+        Heat Stack '%{stack}' is in error status.
+      missing_nova_endpoint: |-
+        Nova endpoint must either be present in your keystone service catalog or be
+        specified using the provider's attribute 'openstack_compute_url'
+
+    states:
+      short_active: |-
+        active
+      long_active: |-
+        The server is up and running. Run `vagrant ssh` to access it.
+      short_build: |-
+        building
+      long_build: |-
+        The server is currently being built. You must wait for this to
+        complete before you can access it. You can delete the server, however,
+        by running `vagrant destroy`.
+      short_error: |-
+        error
+      long_error: |-
+        The server is in an erroneous state. Contact your OpenStack administrator
+        or destroy the machine with `vagrant destroy`.
+      short_hard_reboot: |-
+        hard reboot
+      long_hard_reboot: |-
+        The server is hard rebooting. This is equivalent to pulling the power plug
+        on a physical server, plugging it back in, and rebooting it.
+      short_password: |-
+        password reset
+      long_password: |-
+        The password is being reset on the server.
+      short_reboot: |-
+        reboot
+      long_reboot: |-
+        The server is in a soft reboot state. A reboot command was passed to the operating system.
+      short_rebuild: |-
+        rebuild
+      long_rebuild: |-
+        The server is currently being rebuilt from an image.
+      short_rescue: |-
+        rescue
+      long_rescue: |-
+        The server is in rescue mode.
+      short_resize: |-
+        resize
+      long_resize: |-
+         Server is performing the differential copy of data that changed during
+         its initial copy. Server is down for this stage.
+      short_revert_resize: |-
+        revert resize
+      long_revert_resize: |-
+        The resize or migration of a server failed for some reason. The destination
+        server is being cleaned up and the original source server is restarting.
+      short_shutoff: |-
+        shutoff
+      long_shutoff: |-
+        The virtual machine (VM) was powered down by the user, but not through the
+        OpenStack Compute API. For example, the user issued a shutdown -h command
+        from within the server instance. If the OpenStack Compute manager detects
+        that the VM was powered down, it transitions the server instance to the
+        SHUTOFF status. If you use the OpenStack Compute API to restart the instance,
+        the instance might be deleted first, depending on the value in the
+        shutdown_terminate database field on the Instance model.
+      short_suspended: |-
+        suspended
+      long_suspended: |-
+        The server is suspended, either by request or necessity. This status appears
+        for only the following hypervisors: XenServer/XCP, KVM, and ESXi.
+      short_unknown: |-
+        unknown
+      long_unknown: |-
+        The state of the server is unknown. Contact your cloud provider.
+      short_verify_resize: |-
+        verify resize
+      long_verifiy_resize: |-
+        System is awaiting confirmation that the server is operational after a move or resize.
+      short_not_created: |-
+        not created
+      long_not_created: |-
+        The server is not created. Run `vagrant up` to create it.
+      short_suspending: |-
+        suspending
+      long_suspending: |-
+        The server is active and currently suspending, either by request or necessity.
+      short_resuming: |-
+        resuming
+      long_resuming: |-
+        The server is suspended and currently resuming by request.
+      short_spawning: |-
+        spawning
+      long_spawning: |-
+        The server is not created yet but is currently spawning by request.
+      short_scheduling: |-
+        scheduling
+      long_scheduling: |-
+        The server is building and currently scheduling by necessity.
+      short_deleting: |-
+        deleting
+      long_deleting: |-
+        The server is created and currently deleting by request.
+      short_rebooting: |-
+        rebooting
+      long_rebooting: |-
+        The server is currently rebooting, either by request or necessity.
+      short_reboot_pending: |-
+        reboot_pending
+      long_reboot_pending: |-
+        The server reboot is pending by necessity.
+      short_reboot_started: |-
+        reboot_started
+      long_reboot_started: |-
+        The server is starting to reboot, either by request or necessity.
+      short_rebooting_hard: |-
+        rebooting_hard
+      long_rebooting_hard: |-
+        The server is currently hard rebooting, either by request.
+      short_reboot_pending_hard: |-
+        reboot_pending_hard
+      long_reboot_pending_hard: |-
+        The server hard reboot is pending by necessity.
+      short_reboot_started_hard: |-
+        reboot_started_hard
+      long_reboot_started_hard: |-
+        The server is starting to hard reboot by request.
+
+    client:
+      looking_for_available_endpoints: |-
+        Looking for available endpoints...
+      multiple_endpoint: |-
+        %{size} endpoints are available for service '%{type}' but only the first one will be used
+      authentication: |-
+        Authentication on project %{project} with user %{user}
+
+    command:
+      main_synopsis: |-
+        this provider specific commands
+      main_usage : |-
+        Usage: vagrant openstack command
+      available_subcommands: |-
+        Available subcommands:
+      image_list_synopsis : |-
+        List available images
+      flavor_list_synopsis : |-
+        List available flavors
+      network_list_synopsis : |-
+        List private networks in project
+      subnet_list_synopsis : |-
+        List subnets for available networks
+      flaotingip_list_synopsis : |-
+        List floating IP and floating IP pools
+      volume_list_synopsis : |-
+        List existing volumes
+      reset : |-
+        Reset provider to a clear state