cyoi 0.7.0 → 0.8.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NWU4Y2U2YzZjMjI1ZmI0ZTdlNzM4OTA3ZjBhZmY2NmY2MjVlNGM5ZA==
-  data.tar.gz: !binary |-
-    MDhjN2E4NzE4ODgyOTk5ZDA4ODBhYTgxZWU0MzM4NmZiMjAyMDc3Yg==
+SHA1:
+  metadata.gz: a3fba8bd87ffbf411952d31cf1c8e9cabfcf8cd0
+  data.tar.gz: 55688a09f5dba6f443ed83330eef6c0bc46349f1
 SHA512:
-  metadata.gz: !binary |-
-    NGNjNTU4ZWMzMDA0M2JkMzRlMDRhYWJhYjZlMDFjNDVjYzVmYTIyNmI3NGIy
-    NGJmYTJjN2ZkOGYwOTcyNzYyZTI3NTI4OTVhNmQ1MTFjNzE3NThlNGZlYmMw
-    Yzc2NTExNTdiZWE3MTBiYWJmZmNkNmQ4MzdiYzY0YTcxMDJlODQ=
-  data.tar.gz: !binary |-
-    NTIzZTEyMWRhMjcyZmEyZDExMDM0MjRhMWJlODlkZDNmNzdhNWY3NWE2MTBl
-    NGExMWQ0NDhiYTZkYmQ2NjgyZjc2MjFjOTIxYTlmYWQ2MzhhYjBjZDk2ZTA1
-    ZWZhOTFjMmJkZThkODMzMjIzMDAwOGE0ZjRiOWNlZTcwODVhMDg=
+  metadata.gz: 6e5c897fccb38b5fb9ded020a03bd5bdb1b28346ec41945d5d63fb4d331b4f2fea8fc1d929a05b06c1484c748c1b83faaec41ee8c95568502174f6fa0fc988e8
+  data.tar.gz: 08208b223d39521fa851a1767716c3e6c4b25242aa46917fb6438c1bc2aeb741217a4284d0121e6aef9630e7120e31d4b6169de04c2fc17f846a194407a9a53e

data/ChangeLog.md

@@ -2,6 +2,12 @@
 
 Cyoi (choose-your-own-infrastructure) is a library to ask an end-user to choose an infrastructure (AWS, OpenStack, etc), region, and login credentials.
 
+## v0.8
+
+* openstack - detection of nova vs neutron networking
+* openstack nova - continues to provision a floating IP
+* openstack neutron - asks to select a subnet and then an available IP
+
 ## v0.7
 
 * vsphere provising

data/cyoi.gemspec

@@ -26,8 +26,9 @@ README
   spec.add_dependency "highline", "~> 1.6"
   spec.add_dependency "readwritesettings", "~> 3.0"
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-fire"
   spec.add_development_dependency "aruba"
 end

data/lib/cyoi/cli/provider_addresses/address_cli_openstack.rb

@@ -13,7 +13,12 @@ class Cyoi::Cli::Addresses::AddressCliOpenstack
 
   def perform_and_return_attributes
     unless valid_address?
-      provision_address
+      if networks?
+        subnet = select_subnet
+        choose_address_from_subnet(subnet)
+      else
+        provision_address
+      end
     end
     export_attributes
   end
@@ -39,6 +44,48 @@ class Cyoi::Cli::Addresses::AddressCliOpenstack
     attributes["ip"] = provider_client.provision_public_ip_address
     puts attributes.ip
   end
+
+  def networks?
+    provider_client.networks?
+  end
+
+  def select_subnet
+    subnets = provider_client.subnets
+    subnet = if subnets.size == 0
+      $stderr.puts "ERROR: Your OpenStack is configured for Neutron networking but you have not yet created any subnets."
+      exit 1
+    elsif subnets.size == 1
+      subnets.first
+    else
+      hl.choose do |menu|
+        menu.prompt = "Choose a subnet: "
+        # menu.choice("AWS") { "aws" }
+        subnets.each do |subnet|
+          menu.choice("#{pretty_subnet_name(subnet)}") { subnet }
+        end
+      end
+    end
+    attributes["subnet_id"] = subnet.id
+    subnet
+  end
+
+  def choose_address_from_subnet(subnet)
+    default_ip = provider_client.next_available_ip_in_subnet(subnet)
+    puts "\n"
+    ip = hl.ask("Choose IP ") { |q| q.default = default_ip }.to_s
+    attributes["ip"] = ip
+  end
+
+  def pretty_ip_pool_ranges(subnet)
+    ranges = subnet.allocation_pools.map do |pool|
+      "#{pool['start']}-#{pool['end']}"
+    end
+    ranges.join(',')
+  end
+
+  def pretty_subnet_name(subnet)
+    "#{subnet.name} (#{subnet.cidr})"
+  end
 end
 
 Cyoi::Cli::Address.register_address_cli("openstack", Cyoi::Cli::Addresses::AddressCliOpenstack)

data/lib/cyoi/providers/clients/openstack_provider_client.rb

@@ -2,17 +2,31 @@
 
 module Cyoi; module Providers; module Clients; end; end; end
 
+require "ipaddr"
 require "cyoi/providers/clients/fog_provider_client"
 require "cyoi/providers/constants/openstack_constants"
 
 class Cyoi::Providers::Clients::OpenStackProviderClient < Cyoi::Providers::Clients::FogProviderClient
+  # @return [boolean] true if target OpenStack running Neutron networks
+  def networks?
+    fog_network
+  end
+
+  def subnets
+    fog_network.subnets
+  end
+
   # @return [String] provisions a new public IP address in target region
-  # TODO nil if none available
   def provision_public_ip_address(options={})
-    pool = fog_compute.addresses.get_address_pools.first
-    address = fog_compute.addresses.create(:pool => pool["name"])
+    pool_name = options.delete("pool_name")
+    pool_name ||= begin
+      pool = fog_compute.addresses.get_address_pools.first
+      pool["name"]
+    end
+    address = fog_compute.addresses.create(:pool => pool_name)
     address.ip
-    # TODO catch error and return nil
+  rescue NoMethodError
+    print "No Public IP Found"
   end
 
   def associate_ip_address_with_server(ip_address, server)
@@ -20,6 +34,36 @@ class Cyoi::Providers::Clients::OpenStackProviderClient < Cyoi::Providers::Clien
     address.server = server
   end
 
+  # @return [Array] of IPs that are not allocated to a server
+  # Defaults to the first address pool unless
+  # "pool_name" is provided in options
+  def unallocated_floating_ip_addresses(options={})
+    pool_name = options.delete("pool_name")
+    pool_name ||= begin
+      pool = fog_compute.addresses.get_address_pools.first
+      pool["name"]
+    end
+    fog_compute.addresses.
+      select { |a| a.pool == pool_name && a.instance_id.nil? }.
+      map(&:ip)
+  end
+
+  # @return [String] IP that is available for a new VM to use
+  # allocation_pools look like:
+  # "allocation_pools" => [{"start"=>"192.168.101.2", "end"=>"192.168.101.254"}]
+  def next_available_ip_in_subnet(subnet)
+    ip = IPAddr.new(subnet.allocation_pools.first["start"])
+    skip_ips = ip_addresses_assigned_to_servers
+    while skip_ips.include?(ip.to_s)
+      ip = ip.succ
+    end
+    ip.to_s
+  end
+
+  def ip_addresses_assigned_to_servers
+    fog_compute.servers.map {|s| s.addresses}.map {|address_hash| address_hash.map {|name, addrs| addrs}}.flatten.map {|addr| addr["addr"]}
+  end
+
   # Hook method for FogProviderClient#create_security_group
   def ip_permissions(sg)
     sg.rules
@@ -59,17 +103,27 @@ class Cyoi::Providers::Clients::OpenStackProviderClient < Cyoi::Providers::Clien
     raise "not implemented yet"
   end
 
-  # Construct a Fog::Compute object
-  # Uses +attributes+ which normally originates from +settings.provider+
-  def setup_fog_connection
+  def configuration
     configuration = Fog.symbolize_credentials(attributes.credentials)
     configuration[:provider] = "OpenStack"
     if attributes.credentials.openstack_region && attributes.credentials.openstack_region.empty?
       configuration.delete(:openstack_region)
     end
+    configuration
+  end
+
+  # Construct a Fog::Compute object
+  # Uses +attributes+ which normally originates from +settings.provider+
+  def setup_fog_connection
     @fog_compute = Fog::Compute.new(configuration)
   end
 
+ def fog_network
+    @fog_network ||= Fog::Network.new(configuration)
+  rescue Fog::Errors::NotFound
+    nil
+  end
+
   def openstack_constants
     Cyoi::Providers::Constants::OpenStackConstants
   end

data/lib/cyoi/version.rb

@@ -1,3 +1,3 @@
 module Cyoi
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/spec/support/rspec-fire.rb

@@ -0,0 +1,9 @@
+require 'rspec/fire'
+
+RSpec.configure do |config|
+  config.include(RSpec::Fire)
+end
+
+RSpec::Fire.configure do |config|
+  config.verify_constant_names = true
+end

data/spec/unit/providers/clients/openstack_provider_client_spec.rb

@@ -0,0 +1,110 @@
+require "fog"
+require "fog/openstack"
+require 'fog/openstack/models/network/subnets'
+require "cyoi/providers"
+
+describe "cyoi address openstack" do
+  before { Fog.mock!; Fog::Mock.reset }
+  let(:provider_attributes) do
+    {
+      "name" => "openstack",
+      "credentials" => {
+        "openstack_username" => "USERNAME",
+        "openstack_api_key" => "PASSWORD",
+        "openstack_tenant" => "TENANT",
+        "openstack_auth_url" => "http://someurl.com/v2/tokens",
+        "openstack_region" => "REGION"
+      }
+    }
+  end
+
+  let(:fog_compute) { instance_double("Fog::Compute::OpenStack::Real") }
+  let(:fog_network_const) { class_double("Fog::Network").as_stubbed_const(:transfer_nested_constants => [:OpenStack]) }
+  let(:fog_network) { instance_double("Fog::Network::OpenStack::Real") }
+  let(:addresses) { instance_double("Fog::Compute::OpenStack::Addresses") }
+  let(:address) { instance_double("Fog::Compute::OpenStack::Address", ip: '1.2.3.4') }
+  let(:unallocated_address) { instance_double("Fog::Compute::OpenStack::Address", ip: '1.2.3.4', instance_id: nil, pool: 'INTERNET') }
+  let(:allocated_address) { instance_double("Fog::Compute::OpenStack::Address", ip: '1.2.3.4', instance_id: 'XXX', pool: 'INTERNET') }
+  let(:subnets) { instance_double("Fog::Network::OpenStack::Subnets") }
+  let(:networks) {}
+
+  subject { Cyoi::Providers.provider_client(provider_attributes) }
+
+  it "is an OpenStack provider" do
+    expect(subject).to be_instance_of(Cyoi::Providers::Clients::OpenStackProviderClient)
+  end
+
+  context "provision_public_ip_address" do
+    it "defaults to pool: 'nova' for nova" do
+      expect(subject).to receive(:fog_compute).exactly(2).times.and_return(fog_compute)
+      expect(fog_compute).to receive(:addresses).exactly(2).times.and_return(addresses)
+      expect(addresses).to receive(:get_address_pools).and_return([{"name"=>"nova"}])
+      expect(addresses).to receive(:create).with(pool: "nova").and_return(address)
+      expect(subject.provision_public_ip_address).to eq('1.2.3.4')
+    end
+
+    it "specify a pool name" do
+      expect(subject).to receive(:fog_compute).and_return(fog_compute)
+      expect(fog_compute).to receive(:addresses).and_return(addresses)
+      expect(addresses).to receive(:create).with(pool: "INTERNET").and_return(address)
+      expect(subject.provision_public_ip_address("pool_name" => "INTERNET")).to eq('1.2.3.4')
+    end
+  end
+
+  it "returns unallocated floating IPs for a pool" do
+    expect(subject).to receive(:fog_compute).and_return(fog_compute)
+    expect(fog_compute).to receive(:addresses).and_return([unallocated_address, allocated_address])
+    expect(subject.unallocated_floating_ip_addresses("pool_name" => "INTERNET")).to eq(['1.2.3.4'])
+  end
+
+  context "networks" do
+    it "has no networks" do
+        expect(subject).to receive(:fog_network).and_return(nil)
+      expect(subject.networks?).to be_nil
+    end
+
+    context "has networks" do
+      before do
+      end
+
+      it "for sure" do
+        expect(subject).to receive(:fog_network).and_return(fog_network)
+        expect(subject.networks?).to_not be_nil
+      end
+
+      it "available subnets" do
+        expect(subject).to receive(:fog_network).and_return(fog_network)
+        expect(fog_network).to receive(:subnets).and_return(subnets)
+        expect(subject.subnets).to eq(subnets)
+      end
+    end
+
+    context 'next_available_ip_in_subnet' do
+      let(:subnet) { Fog::Network::OpenStack::Subnet.new(
+        "cidr" => "192.168.101.0/24",
+        "gateway_ip" => "192.168.101.1",
+        "allocation_pools" => [{"start"=>"192.168.101.2", "end"=>"192.168.101.254"}]
+      ) }
+      it "returns next IP in allocation pools" do
+        expect(subject.next_available_ip_in_subnet(subnet)).to eq("192.168.101.2")
+      end
+
+      it "avoids IP addresses already allocated to other servers" do
+        expect(subject).to receive(:ip_addresses_assigned_to_servers).and_return(["192.168.101.2", "192.168.101.3"])
+        expect(subject.next_available_ip_in_subnet(subnet)).to eq("192.168.101.4")
+      end
+    end
+
+    context 'ip_addresses_assigned_to_servers' do
+      let(:addresses) do
+        {"Internet Access "=>[{"OS-EXT-IPS-MAC:mac_addr"=>"fa:16:3e:c0:4b:b3", "version"=>4, "addr"=>"192.168.101.2", "OS-EXT-IPS:type"=>"fixed"}, {"OS-EXT-IPS-MAC:mac_addr"=>"fa:16:3e:c0:4b:b3", "version"=>4, "addr"=>"174.128.50.11", "OS-EXT-IPS:type"=>"floating"}]}
+      end
+      let(:servers) { [instance_double("Fog::Compute::OpenStack::Server", addresses: addresses)] }
+      it "list of IPs" do
+        expect(subject).to receive(:fog_compute).and_return(fog_compute)
+        expect(fog_compute).to receive(:servers).and_return(servers)
+        expect(subject.ip_addresses_assigned_to_servers).to eq(["192.168.101.2", "174.128.50.11"])
+      end
+    end
+  end
+end

metadata

@@ -1,111 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: cyoi
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Dr Nic Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2014-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: readwritesettings
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-fire
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A library to ask an end-user to choose an infrastructure (AWS, OpenStack,
@@ -117,9 +131,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - ChangeLog.md
 - Gemfile
 - Guardfile
@@ -172,11 +186,13 @@ files:
 - spec/integration/cli/provider/provider_aws_spec.rb
 - spec/integration/cli/provider/provider_openstack_spec.rb
 - spec/spec_helper.rb
+- spec/support/rspec-fire.rb
 - spec/support/settings_helper.rb
 - spec/support/stdout_capture.rb
 - spec/unit/.gitkeep
 - spec/unit/cli/image_spec.rb
 - spec/unit/cli/key_pair_spec.rb
+- spec/unit/providers/clients/openstack_provider_client_spec.rb
 homepage: https://github.com/drnic/cyoi
 licenses:
 - MIT
@@ -187,17 +203,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.2
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: A library to ask an end-user to choose an infrastructure (AWS, OpenStack,
@@ -217,8 +233,10 @@ test_files:
 - spec/integration/cli/provider/provider_aws_spec.rb
 - spec/integration/cli/provider/provider_openstack_spec.rb
 - spec/spec_helper.rb
+- spec/support/rspec-fire.rb
 - spec/support/settings_helper.rb
 - spec/support/stdout_capture.rb
 - spec/unit/.gitkeep
 - spec/unit/cli/image_spec.rb
 - spec/unit/cli/key_pair_spec.rb
+- spec/unit/providers/clients/openstack_provider_client_spec.rb