saklient 0.0.1

data/lib/saklient/util.rb

@@ -0,0 +1,121 @@
+# -*- encoding: UTF-8 -*-
+
+require_relative 'errors/saklient_exception'
+require 'uri'
+
+module Saklient
+
+  # @private
+  class Util
+
+    # @param [any] obj
+    # @param [String] path
+    # @return [any]
+    def self.exists_path(obj, path)
+      aPath = path.split('.')
+      for seg in aPath
+        return false if (obj).nil?
+        return false if !obj.is_a?(Hash)
+        next if seg == ''
+        return false if !(!obj.nil? && obj.key?(seg.to_sym))
+        obj = obj[seg.to_sym]
+      end
+      return true
+    end
+
+    # @param [any] obj
+    # @param [String] path
+    # @return [any]
+    def self.get_by_path(obj, path)
+      aPath = path.split('.')
+      for seg in aPath
+        return nil if (obj).nil?
+        return nil if !obj.is_a?(Hash)
+        next if seg == ''
+        return nil if !(!obj.nil? && obj.key?(seg.to_sym))
+        obj = obj[seg.to_sym]
+      end
+      return obj
+    end
+
+    # @todo array support
+    # @todo overwriting
+    # @todo writing into children of non-object
+    # @param [any] obj
+    # @param [any] value
+    # @param [String] path
+    # @return [void]
+    def self.set_by_path(obj, path, value)
+      aPath = path.split('.')
+      key = aPath.pop
+      for seg in aPath
+        next if seg == ''
+        obj[seg.to_sym] = {} if !(!obj.nil? && obj.key?(seg.to_sym))
+        obj = obj[seg.to_sym]
+      end
+      obj[key.to_sym] = value
+    end
+
+    # @param [String] classPath
+    # @param [Array] args
+    # @return [any]
+    def self.create_class_instance(classPath, args)
+      ret = nil
+      if !(classPath).nil?
+        apath = classPath.split('.')
+        ret = apath.inject(Object) { |obj, name| obj.const_get(name[0].upcase + name[1..-1]) }.new(*args)
+      end
+      raise Exception.new('Could not create class instance of ' + classPath) if (ret).nil?
+      return ret
+    end
+
+    # @param [String] s
+    # @return [NativeDate]
+    def self.str2date(s)
+      return nil if (s).nil?
+      return DateTime.parse(s)
+    end
+
+    # @param [NativeDate] d
+    # @return [String]
+    def self.date2str(d)
+      return nil if (d).nil?
+      return d.to_s
+    end
+
+    # @param [String] s
+    # @return [String]
+    def self.url_encode(s)
+      return URI.encode(s)
+    end
+
+    # @param [Integer] sec
+    # @return [void]
+    def self.sleep(sec)
+      super self
+    end
+
+    # @param [any] value
+    # @param [String] typeName
+    # @return [void]
+    def self.validate_type(value, typeName, force=false)
+      isOk = false
+      if !force then
+        return if typeName=="any" || typeName=="void" || value.nil?
+        clazz = value.class.to_s
+        if typeName=="bool"
+          isOk = clazz=="TrueClass" || clazz=="FalseClass"
+        elsif typeName=="Float"
+          isOk = clazz=="Fixnum" || clazz=="Float"
+        elsif typeName=="String"
+          isOk = clazz=="Fixnum" || clazz=="Float" || clazz=="String"
+        else
+          isOk = value.is_a?(Object.const_get(typeName))
+        end
+      end
+      raise Saklient::Errors::SaklientException.new('argument_type_mismatch', 'Argument type mismatch (expected '+typeName+' but got '+clazz+')') unless isOk
+    end
+
+  end
+
+end

data/lib/saklient/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding: UTF-8 -*-
+
+module Saklient
+  VERSION = "0.0.1"
+end

data/saklient.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'saklient/version'
+
+Gem::Specification.new do |gem|
+  
+  gem.name          = 'saklient'
+  gem.version       = Saklient::VERSION
+  gem.licenses      = ['MIT']
+  gem.authors       = ['townewgokgok']
+  gem.email         = ['dev-support-ml@sakura.ad.jp']
+  gem.description   = %q{An easy interface to control your resources on SAKURA Cloud.}
+  gem.summary       = %q{SAKURA Internet API Client Library for Ruby}
+  gem.homepage      = 'http://sakura-internet.github.io/saklient.doc/'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+  
+  gem.add_development_dependency 'rspec'
+  
+end

data/spec/archive_spec.rb

@@ -0,0 +1,141 @@
+$: << File.dirname(__dir__) + '/lib'
+require 'saklient/cloud/api'
+require 'date'
+require 'SecureRandom'
+require 'tempfile'
+
+describe 'Archive' do
+  
+  
+  
+  before do
+    
+    # load config file
+    root = File.dirname(__dir__)
+    test_ok_file = root + '/testok'
+    expect(File).to exist(test_ok_file)
+    config_file = root + '/config.sh'
+    expect(File).to exist(config_file)
+    @config = {}
+    fh = open(config_file)
+    fh.each {|line|
+      if /^\s*export\s+(\w+)\s*=\s*(.+?)\s*$/.match(line) then
+        key = $1
+        value = $2
+        @config[key.to_sym] = value.gsub(/'([^']*)'|"([^"]*)"|\\(.)|(.)/) {|m|
+          $1 || $2 || $3 || $4
+        }
+      end
+    }
+    fh.close
+    expect(@config[:SACLOUD_TOKEN]).not_to be_empty #'SACLOUD_TOKEN must be defined in config.sh'
+    expect(@config[:SACLOUD_SECRET]).not_to be_empty #'SACLOUD_SECRET must be defined in config.sh'
+    #expect(@config[:SACLOUD_ZONE]).not_to be_empty #'SACLOUD_ZONE must be defined in config.sh'
+    
+    # authorize
+    @api = Saklient::Cloud::API::authorize(@config[:SACLOUD_TOKEN], @config[:SACLOUD_SECRET])
+    @api = @api.in_zone(@config[:SACLOUD_ZONE]) if @config[:SACLOUD_ZONE]
+    expect(@api).to be_an_instance_of Saklient::Cloud::API
+    
+  end
+  
+  
+  
+  it 'should be CRUDed' do
+    name = '!ruby_rspec-' + DateTime.now.strftime('%Y%m%d_%H%M%S') + '-' + SecureRandom.uuid[0, 8]
+    description = 'This instance was created by saklient.ruby rspec'
+    tag = 'saklient-test'
+    
+    archive = @api.archive.create
+    expect(archive).to be_an_instance_of Saklient::Cloud::Resources::Archive 
+    archive.name = name
+    archive.description = description
+    archive.tags = [tag]
+    archive.size_gib = 20
+    archive.save
+    
+    #
+    ftp = archive.ftp_info
+    expect(ftp).to be_an_instance_of Saklient::Cloud::Resources::FtpInfo 
+    expect(ftp.host_name).not_to be_nil
+    expect(ftp.user).not_to be_nil
+    expect(ftp.password).not_to be_nil
+    ftp2 = archive.open_ftp(true).ftp_info
+    expect(ftp2).to be_an_instance_of Saklient::Cloud::Resources::FtpInfo 
+    expect(ftp2.host_name).not_to be_nil
+    expect(ftp2.user).not_to be_nil
+    expect(ftp2.password).not_to be_nil
+    expect(ftp2.password).not_to eq ftp.password
+    
+    #
+    temp = Tempfile.new('saklient-')
+    path = temp.path
+    temp.close!
+    cmd = "dd if=/dev/urandom bs=4096 count=64 > #{path}; ls -l #{path}"
+    puts cmd
+    puts `( #{cmd} ) 2>&1`
+    cmd  = "set ftp:ssl-allow true;"
+    cmd += "set ftp:ssl-force true;"
+    cmd += "set ftp:ssl-protect-data true;"
+    cmd += "set ftp:ssl-protect-list true;"
+    cmd += "put #{path};"
+    cmd += "exit"
+    cmd = "lftp -u #{ftp2.user},#{ftp2.password} -p 21 -e '#{cmd}' #{ftp2.host_name}"
+    puts cmd
+    puts `( #{cmd} ) 2>&1`
+    cmd = "rm -f #{path}"
+    puts cmd
+    puts `( #{cmd} ) 2>&1`
+    
+    archive.close_ftp
+    
+    #
+    archive.destroy
+    
+  end
+  
+  
+  
+  it 'should be copied' do
+    name = '!ruby_rspec-' + DateTime.now.strftime('%Y%m%d_%H%M%S') + '-' + SecureRandom.uuid[0, 8]
+    description = 'This instance was created by saklient.ruby rspec'
+    tag = 'saklient-test'
+    
+    disk = @api.disk.create
+    disk.name = name
+    disk.description = description
+    disk.tags = [tag]
+    disk.size_gib = 20
+    disk.save
+    
+    archive = @api.archive.create
+    archive.name = name
+    archive.description = description
+    archive.tags = [tag]
+    archive.source = disk
+    archive.save
+    
+    fail 'ディスクからアーカイブへのコピーがタイムアウトまたは失敗しました' unless archive.sleep_while_copying
+    
+    disk.destroy
+    
+    ftp = archive.open_ftp.ftp_info
+    expect(ftp).to be_an_instance_of Saklient::Cloud::Resources::FtpInfo
+    expect(ftp.host_name).not_to be_nil
+    expect(ftp.user).not_to be_nil
+    expect(ftp.password).not_to be_nil
+    
+    archive.close_ftp
+    archive.destroy
+  end
+  
+  
+  
+  after do
+    @config = nil
+    @api = nil
+  end
+  
+  
+  
+end

data/spec/enum_spec.rb

@@ -0,0 +1,24 @@
+$: << File.dirname(__dir__) + '/lib'
+require 'saklient/cloud/enums/eserver_instance_status'
+
+EServerInstanceStatus = Saklient::Cloud::Enums::EServerInstanceStatus
+
+describe 'Enum' do
+  
+  it 'should be defined' do
+    expect(EServerInstanceStatus::up).to eq 'up'
+    expect(EServerInstanceStatus::down).to eq 'down'
+  end
+  
+  it 'should be compared' do
+    expect(EServerInstanceStatus::compare('up', 'up')).to eq 0
+    expect(EServerInstanceStatus::compare('up', 'down')).to eq 1
+    expect(EServerInstanceStatus::compare('down', 'up')).to eq -1
+    expect(EServerInstanceStatus::compare('UNDEFINED-SYMBOL', 'up')).to be_nil
+    expect(EServerInstanceStatus::compare('up', 'UNDEFINED-SYMBOL')).to be_nil
+    expect(EServerInstanceStatus::compare(nil, 'up')).to be_nil
+    expect(EServerInstanceStatus::compare('up', nil)).to be_nil
+    expect(EServerInstanceStatus::compare(nil, nil)).to be_nil
+  end
+  
+end

data/spec/exception_spec.rb

@@ -0,0 +1,25 @@
+$: << File.dirname(__dir__) + '/lib'
+require 'saklient/cloud/errors/exception_factory'
+
+ExceptionFactory = Saklient::Errors::ExceptionFactory
+HttpException = Saklient::Errors::HttpException
+HttpNotFoundException = Saklient::Errors::HttpNotFoundException
+ServerPowerMustBeUpException = Saklient::Cloud::Errors::ServerPowerMustBeUpException
+
+describe 'Exception' do
+  
+  it 'should be created' do
+    
+    x = ExceptionFactory.create(404)
+    expect(x).to be_an_instance_of HttpNotFoundException
+    
+    x = ExceptionFactory.create(409, 'server_power_must_be_up')
+    expect(x).to be_an_instance_of ServerPowerMustBeUpException
+    
+    x = ExceptionFactory.create(666, 'nameless_http_error', 'Ia! Cthulhu Fthagn!')
+    expect(x).to be_an_instance_of HttpException
+    expect(x.message).to eq 'Ia! Cthulhu Fthagn!'
+    
+ 	end
+  
+end

data/spec/iso_image_spec.rb

@@ -0,0 +1,172 @@
+$: << File.dirname(__dir__) + '/lib'
+require 'saklient/cloud/api'
+require 'date'
+require 'SecureRandom'
+require 'tempfile'
+
+describe 'IsoImage' do
+  
+  
+  
+  before do
+    
+    # load config file
+    root = File.dirname(__dir__)
+    test_ok_file = root + '/testok'
+    expect(File).to exist(test_ok_file)
+    config_file = root + '/config.sh'
+    expect(File).to exist(config_file)
+    @config = {}
+    fh = open(config_file)
+    fh.each {|line|
+      if /^\s*export\s+(\w+)\s*=\s*(.+?)\s*$/.match(line) then
+        key = $1
+        value = $2
+        @config[key.to_sym] = value.gsub(/'([^']*)'|"([^"]*)"|\\(.)|(.)/) {|m|
+          $1 || $2 || $3 || $4
+        }
+      end
+    }
+    fh.close
+    expect(@config[:SACLOUD_TOKEN]).not_to be_empty #'SACLOUD_TOKEN must be defined in config.sh'
+    expect(@config[:SACLOUD_SECRET]).not_to be_empty #'SACLOUD_SECRET must be defined in config.sh'
+    #expect(@config[:SACLOUD_ZONE]).not_to be_empty #'SACLOUD_ZONE must be defined in config.sh'
+    
+    # authorize
+    @api = Saklient::Cloud::API::authorize(@config[:SACLOUD_TOKEN], @config[:SACLOUD_SECRET])
+    @api = @api.in_zone(@config[:SACLOUD_ZONE]) if @config[:SACLOUD_ZONE]
+    expect(@api).to be_an_instance_of Saklient::Cloud::API
+    
+  end
+  
+  
+  
+  it 'should be CRUDed' do
+    name = '!ruby_rspec-' + DateTime.now.strftime('%Y%m%d_%H%M%S') + '-' + SecureRandom.uuid[0, 8]
+    description = 'This instance was created by saklient.ruby rspec'
+    tag = 'saklient-test'
+    
+    iso = @api.iso_image.create
+    expect(iso).to be_an_instance_of Saklient::Cloud::Resources::IsoImage
+    iso.name = name
+    iso.description = description
+    iso.tags = [tag]
+    iso.size_mib = 5120
+    iso.save
+    
+    #
+    ftp = iso.ftp_info
+    expect(ftp).to be_an_instance_of Saklient::Cloud::Resources::FtpInfo
+    expect(ftp.host_name).not_to be_nil
+    expect(ftp.user).not_to be_nil
+    expect(ftp.password).not_to be_nil
+    ftp2 = iso.open_ftp(true).ftp_info
+    expect(ftp2).to be_an_instance_of Saklient::Cloud::Resources::FtpInfo
+    expect(ftp2.host_name).not_to be_nil
+    expect(ftp2.user).not_to be_nil
+    expect(ftp2.password).not_to be_nil
+    expect(ftp2.password).not_to eq ftp.password
+    
+    #
+    temp = Tempfile.new('saklient-')
+    path = temp.path
+    temp.close!
+    cmd = "dd if=/dev/urandom bs=4096 count=64 > #{path}; ls -l #{path}"
+    puts cmd
+    puts `( #{cmd} ) 2>&1`
+    cmd  = "set ftp:ssl-allow true;"
+    cmd += "set ftp:ssl-force true;"
+    cmd += "set ftp:ssl-protect-data true;"
+    cmd += "set ftp:ssl-protect-list true;"
+    cmd += "put #{path};"
+    cmd += "exit"
+    cmd = "lftp -u #{ftp2.user},#{ftp2.password} -p 21 -e '#{cmd}' #{ftp2.host_name}"
+    puts cmd
+    puts `( #{cmd} ) 2>&1`
+    cmd = "rm -f #{path}"
+    puts cmd
+    puts `( #{cmd} ) 2>&1`
+    
+    iso.close_ftp
+    
+    #
+    iso.destroy
+    
+  end
+  
+  
+  
+  it 'should be inserted and ejected' do
+    name = '!ruby_rspec-' + DateTime.now.strftime('%Y%m%d_%H%M%S') + '-' + SecureRandom.uuid[0, 8]
+    description = 'This instance was created by saklient.ruby rspec'
+    tag = 'saklient-test'
+    
+    # search iso images
+    puts 'searching iso images...'
+    isos = @api.iso_image.
+      with_name_like('CentOS 6.5 64bit').
+      with_shared_scope.
+      limit(1).
+      find
+    expect(isos.length).to be > 0
+    iso = isos[0]
+    
+    # create a server
+    puts 'creating a server...'
+    server = @api.server.create
+    expect(server).to be_an_instance_of Saklient::Cloud::Resources::Server
+    server.name = name
+    server.description = description
+    server.tags = [tag]
+    server.plan = @api.product.server.get_by_spec(1, 1)
+    server.save
+    
+    # insert iso image while the server is down
+    puts 'inserting an ISO image to the server...'
+    server.insert_iso_image(iso)
+    expect(server.instance.iso_image).to be_an_instance_of Saklient::Cloud::Resources::IsoImage
+    expect(server.instance.iso_image.id).to eq iso.id
+    
+    # eject iso image while the server is down
+    puts 'ejecting the ISO image from the server...'
+    server.eject_iso_image
+    expect(server.instance.iso_image).to be_nil
+    
+    # boot
+    puts 'booting the server...'
+    server.boot
+    sleep 3
+    
+    # insert iso image while the server is up
+    puts 'inserting an ISO image to the server...'
+    server.insert_iso_image(iso)
+    expect(server.instance.iso_image).to be_an_instance_of Saklient::Cloud::Resources::IsoImage
+    expect(server.instance.iso_image.id).to eq iso.id
+    
+    # eject iso image while the server is up
+    puts 'ejecting the ISO image from the server...'
+    server.eject_iso_image
+    expect(server.instance.iso_image).to be_nil
+    
+    # stop
+    sleep 1
+    puts 'stopping the server...'
+    server.stop
+    fail 'サーバが正常に停止しません' unless server.sleep_until_down
+    
+    # delete the server
+    puts 'deleting the server...'
+    server.destroy
+    
+  end
+  
+  
+  
+  after do
+    @config = nil
+    @api = nil
+  end
+  
+  
+  
+end

data/spec/router_spec.rb

@@ -0,0 +1,124 @@
+$: << File.dirname(__dir__) + '/lib'
+require 'saklient/cloud/api'
+require 'date'
+require 'SecureRandom'
+require 'ipaddr'
+
+describe 'Router' do
+  
+  
+  
+  before do
+    
+    # load config file
+    root = File.dirname(__dir__)
+    test_ok_file = root + '/testok'
+    expect(File).to exist(test_ok_file)
+    config_file = root + '/config.sh'
+    expect(File).to exist(config_file)
+    @config = {}
+    fh = open(config_file)
+    fh.each {|line|
+      if /^\s*export\s+(\w+)\s*=\s*(.+?)\s*$/.match(line) then
+        key = $1
+        value = $2
+        @config[key.to_sym] = value.gsub(/'([^']*)'|"([^"]*)"|\\(.)|(.)/) {|m|
+          $1 || $2 || $3 || $4
+        }
+      end
+    }
+    fh.close
+    expect(@config[:SACLOUD_TOKEN]).not_to be_empty #'SACLOUD_TOKEN must be defined in config.sh'
+    expect(@config[:SACLOUD_SECRET]).not_to be_empty #'SACLOUD_SECRET must be defined in config.sh'
+    #expect(@config[:SACLOUD_ZONE]).not_to be_empty #'SACLOUD_ZONE must be defined in config.sh'
+    
+    # authorize
+    @api = Saklient::Cloud::API::authorize(@config[:SACLOUD_TOKEN], @config[:SACLOUD_SECRET])
+    @api = @api.in_zone(@config[:SACLOUD_ZONE]) if @config[:SACLOUD_ZONE]
+    expect(@api).to be_an_instance_of Saklient::Cloud::API
+    
+  end
+  
+  
+  
+  it 'should be CRUDed' do
+    name = '!ruby_rspec-' + DateTime.now.strftime('%Y%m%d_%H%M%S') + '-' + SecureRandom.uuid[0, 8]
+    description = 'This instance was created by saklient.ruby rspec'
+    mask_len = 28
+  
+    #
+    swytch = nil
+    if false then
+      puts 'ルータ＋スイッチの帯域プランを検索しています...'
+      plans = @api.product.router.find
+      min_mbps = 0x7FFFFFFF
+      for plan in plans do
+        expect(plan).to be_an_instance_of Saklient::Cloud::Resources::RouterPlan
+        expect(plan.band_width_mbps).to be > 0
+        min_mbps = [plan.band_width_mbps, min_mbps].min
+      end
+      
+      puts 'ルータ＋スイッチを作成しています...'
+      router = @api.router.create
+      router.name = name
+      router.description = description
+      router.band_width_mbps = min_mbps
+      router.network_mask_len = mask_len
+      router.save
+      
+      puts 'ルータ＋スイッチの作成完了を待機しています...'
+      fail 'ルータが正常に作成されません' unless router.sleep_while_creating
+      swytch = router.get_swytch
+    else
+      puts '既存のルータ＋スイッチを取得しています...'
+      swytches = @api.swytch.with_name_like('saklient-static-1').limit(1).find
+      expect(swytches.length).to eq 1
+      swytch = swytches[0]
+    end
+    
+    expect(swytch).to be_an_instance_of Saklient::Cloud::Resources::Swytch
+    expect(swytch.ipv4_nets.length).to be > 0
+    expect(swytch.ipv4_nets[0]).to be_an_instance_of Saklient::Cloud::Resources::Ipv4Net
+    
+    #
+    puts 'ルータ＋スイッチの帯域プランを変更しています...'
+    router_id_before = swytch.router.id
+    swytch.change_plan(swytch.router.band_width_mbps==100 ? 500 : 100)
+    expect(swytch.router.id).not_to eq router_id_before
+    
+    #
+    if 0 < swytch.ipv6_nets.length then
+      puts 'ルータ＋スイッチからIPv6ネットワークの割当を解除しています...'
+      swytch.remove_ipv6_net
+    end
+    puts 'ルータ＋スイッチにIPv6ネットワークを割り当てています...'
+    v6net = swytch.add_ipv6_net
+    expect(v6net).to be_an_instance_of Saklient::Cloud::Resources::Ipv6Net
+    expect(swytch.ipv6_nets.length).to eq 1
+    
+    #
+    (swytch.ipv4_nets.length - 1).downto(1) do |i|
+      puts 'ルータ＋スイッチからスタティックルートの割当を解除しています...'
+      net = swytch.ipv4_nets[i]
+      swytch.remove_static_route(net)
+    end
+    
+    puts 'ルータ＋スイッチにスタティックルートを割り当てています...'
+    net0 = swytch.ipv4_nets[0]
+    next_hop = IPAddr.new(IPAddr.new(net0.address).to_i + 4, Socket::AF_INET).to_s
+    sroute = swytch.add_static_route(28, next_hop)
+    expect(sroute).to be_an_instance_of Saklient::Cloud::Resources::Ipv4Net
+    expect(swytch.ipv4_nets.length).to eq 2
+    
+  end
+  
+  
+  
+  after do
+    @config = nil
+    @api = nil
+  end
+  
+  
+  
+end