bbrowning-deltacloud-client 0.0.6.1

data/lib/documentation.rb

@@ -0,0 +1,97 @@
+require 'lib/deltacloud'
+
+skip_methods = [ "id=", "uri=" ]
+
+begin
+  @dc=DeltaCloud.new('mockuser', 'mockpassword', 'http://localhost:3001/api')
+rescue
+  puts "Please make sure that Deltacloud API is running with Mock driver"
+  exit(1)
+end
+
+@dc.entry_points.keys.each do |ep|
+  @dc.send(ep)
+end
+class_list = @dc.classes
+
+def read_method_description(c, method)
+  if method =~ /es$/
+    "    # Read #{c.downcase} collection from Deltacloud API"
+  else
+    case method
+      when "uri"
+        "    # Return URI to API for this object"
+      when "action_urls"
+        "    # Return available actions API URL"
+      when "client"
+        "    # Return instance of API client"
+      else
+        "    # Get #{method} attribute value from #{c.downcase}"
+    end
+  end
+end
+
+def read_parameters(c, method)
+  out = []
+  if method =~ /es$/
+    out << "    # @param [String, #id] Filter by ID"
+  end
+  out.join("\n")
+end
+
+def read_return_value(c, method)
+  if method =~ /es$/
+    rt = "Array"
+  else
+    rt = "String"
+  end
+  "    # @return [String] Value of #{method}"
+end
+
+out = []
+
+class_list.each do |c|
+  class_name = "#{c}".gsub(/^DeltaCloud::/, '')
+  out << "module DeltaCloud"
+  out << "  class API"
+  @dc.entry_points.keys.each do |ep|
+    out << "# Return #{ep.to_s.classify} object with given id\n"
+    out << "# "
+    out << "# *#{@dc.documentation(ep.to_s).description}*"
+    out << "# @return [#{ep.to_s.classify}]"
+    out << "def #{ep.to_s.gsub(/s$/, '')}"
+    out << "end"
+    out << "# Return collection of #{ep.to_s.classify} objects"
+    out << "# "
+    out << "# *#{@dc.documentation(ep.to_s).description}*"
+    @dc.documentation(ep.to_s, 'index').params.each do |p|
+      out << p.to_comment
+    end
+    out << "# @return [Array] [#{ep.to_s.classify}]"
+    out << "def #{ep}(opts={})"
+    out << "end"
+  end
+  out << "  end"
+  out << "  class #{class_name}"
+  c.instance_methods(false).each do |method|
+    next if skip_methods.include?(method)
+    params = read_parameters(class_name, method)
+    retval = read_return_value(class_name, method)
+    out << read_method_description(class_name, method)
+    out << params if params
+    out << retval if retval
+    out << "    def #{method}"
+    out << "      # This method was generated dynamically from API"
+    out << "    end\n"
+  end
+  out << "  end"
+  out << "end"
+end
+
+FileUtils.rm_r('doc') rescue nil
+FileUtils.mkdir_p('doc')
+File.open('doc/deltacloud.rb', 'w') do |f|
+  f.puts(out.join("\n"))
+end
+system("yardoc -m markdown --readme README --title 'Deltacloud Client Library' 'lib/*.rb' 'doc/deltacloud.rb' --verbose")
+FileUtils.rm('doc/deltacloud.rb')

data/lib/plain_formatter.rb

@@ -0,0 +1,86 @@
+module DeltaCloud
+  module PlainFormatter
+    module FormatObject
+
+      class Base
+        def initialize(obj)
+          @obj = obj
+        end
+      end
+
+      class Image < Base
+        def format
+          sprintf("%-10s | %-20s | %-6s | %-20s | %15s",
+              @obj.id[0,10],
+              @obj.name ? @obj.name[0, 20]: 'unknown',
+              @obj.architecture[0,6],
+              @obj.description[0,20],
+              @obj.owner_id[0,15]
+          )
+        end
+      end
+
+      class Realm < Base
+        def format
+          sprintf("%-10s | %-15s | %-5s | %10s GB",
+            @obj.id[0, 10],
+            @obj.name[0, 15],
+            @obj.state[0,5],
+            @obj.limit.to_s[0,10]
+          )
+        end
+      end
+
+      class HardwareProfile < Base
+        def format
+          sprintf("%-15s | %-6s | %10s | %10s ", @obj.id[0, 15],
+            @obj.architecture.value[0,6], @obj.memory.value.to_s[0,10], @obj.storage.value.to_s[0,10])
+        end
+      end
+
+      class Instance < Base
+        def format
+          sprintf("%-15s | %-15s | %-15s | %10s | %32s | %32s",
+            @obj.id ? @obj.id[0,15] : '-',
+            @obj.name ? @obj.name[0,15] : 'unknown',
+            @obj.image.name ? @obj.image.name[0,15] : 'unknown',
+            @obj.state ? @obj.state.to_s[0,10] : 'unknown',
+            @obj.public_addresses.join(',')[0,32],
+            @obj.private_addresses.join(',')[0,32]
+          )
+        end
+      end
+
+      class StorageVolume < Base
+        def format
+          sprintf("%-10s | %15s GB | %-10s | %-10s | %-15s",
+            @obj.id[0,10],
+            @obj.capacity ? @obj.capacity.to_s[0,15] : 'unknown',
+            @obj.device ? @obj.device[0,10] : 'unknown',
+            @obj.respond_to?('state') ? @obj.state[0,10] : 'unknown',
+            @obj.instance ? @obj.instance.name[0,15] : 'unknown'
+          )
+        end
+      end
+
+      class StorageSnapshot < Base
+        def format
+          sprintf("%-10s | %-15s | %-6s | %15s",
+            @obj.id[0,10],
+            @obj.storage_volume.respond_to?('name') ? @obj.storage_volume.name[0, 15] : 'unknown',
+            @obj.state ? @obj.state[0,10] : 'unknown',
+            @obj.created ? @obj.created[0,19] : 'unknown'
+          )
+        end
+      end
+
+    end
+
+    def format(obj)
+      object_name = obj.class.name.classify.gsub(/^DeltaCloud::/, '')
+      format_class = DeltaCloud::PlainFormatter::FormatObject.const_get(object_name)
+      format_class.new(obj).format
+    end
+
+  end
+end

data/specs/fixtures/images/img1.yml

@@ -0,0 +1,4 @@
+:description: Fedora 10
+:owner_id: fedoraproject
+:architecture: x86_64
+:id: img1

data/specs/fixtures/images/img2.yml

@@ -0,0 +1,4 @@
+:description: Fedora 10
+:owner_id: fedoraproject
+:architecture: i386
+:id: img2

data/specs/fixtures/images/img3.yml

@@ -0,0 +1,4 @@
+:description: JBoss
+:owner_id: mockuser
+:architecture: i386
+:id: img3

data/specs/fixtures/instances/inst0.yml

@@ -0,0 +1,16 @@
+---
+:realm_id: us
+:public_addresses:
+- img1.inst0.public.com
+:state: RUNNING
+:name: "Mock Instance With Profile Change"
+:private_addresses:
+- img1.inst0.private.com
+:image_id: img1
+:instance_profile: !ruby/object:InstanceProfile
+  id: m1-large
+  memory: "12288"
+:owner_id: mockuser
+:actions:
+- :reboot
+- :stop

data/specs/fixtures/instances/inst1.yml

@@ -0,0 +1,9 @@
+:name: MockUserInstance
+:state: RUNNING
+:image_id: img3
+:owner_id: mockuser
+:public_addresses: [ img3.inst1.public.com ]
+:private_addresses: [ img3.inst1.private.com ]
+:realm_id: us
+:instance_profile: !ruby/object:InstanceProfile
+  id: m1-small

data/specs/fixtures/instances/inst2.yml

@@ -0,0 +1,9 @@
+:name: AnotherInstance
+:state: RUNNING
+:image_id: img1
+:owner_id: anotheruser
+:public_addresses: [ img1.inst2.public.com ]
+:private_addresses: [ img1.inst2.private.com ]
+:realm_id: us
+:instance_profile: !ruby/object:InstanceProfile
+  id: m1-large

data/specs/fixtures/storage_snapshots/snap1.yml

@@ -0,0 +1,4 @@
+:owner_id: fedoraproject
+:created: Wed Jul 29 18:15:24 UTC 2009
+:state: COMPLETED
+:storage_volume_id: vol1

data/specs/fixtures/storage_snapshots/snap2.yml

@@ -0,0 +1,4 @@
+:owner_id: mockuser
+:created: Wed Jul 29 18:15:24 UTC 2009
+:state: COMPLETED
+:storage_volume_id: vol2

data/specs/fixtures/storage_snapshots/snap3.yml

@@ -0,0 +1,4 @@
+:owner_id: mockuser
+:created: Wed Jul 29 18:15:24 UTC 2009
+:state: COMPLETED
+:storage_volume_id: vol2

data/specs/fixtures/storage_volumes/vol1.yml

@@ -0,0 +1,6 @@
+:owner_id: fedoraproject
+:created: Thu Jul 30 14:35:11 UTC 2009
+:state: AVAILABLE
+:capacity: 1
+:device:
+:instance_id:

data/specs/fixtures/storage_volumes/vol2.yml

@@ -0,0 +1,6 @@
+:owner_id: mockuser
+:created: Thu Jul 30 14:35:11 UTC 2009
+:state: AVAILABLE
+:capacity: 1
+:device:
+:instance_id:

data/specs/fixtures/storage_volumes/vol3.yml

@@ -0,0 +1,6 @@
+:owner_id: mockuser
+:created: Thu Jul 30 14:35:11 UTC 2009
+:state: IN-USE
+:capacity: 1
+:device: /dev/sda1
+:instance_id: inst1

data/specs/hardware_profiles_spec.rb

@@ -0,0 +1,72 @@
+#
+# Copyright (C) 2009  Red Hat, Inc.
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+require 'specs/spec_helper'
+
+def prop_check(prop, value_class)
+  if prop.present?
+    prop.value.should_not be_nil
+    prop.value.should be_a(value_class)
+  end
+end
+
+describe "hardware_profiles" do
+
+  it_should_behave_like "all resources"
+
+  it "should allow retrieval of all hardware profiles" do
+    DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
+      hardware_profiles = client.hardware_profiles
+      hardware_profiles.should_not be_empty
+      hardware_profiles.each do |hwp|
+        hwp.uri.should_not be_nil
+        hwp.uri.should be_a(String)
+        prop_check(hwp.architecture, String)
+        prop_check(hwp.storage, Float)
+        prop_check(hwp.memory, Float)
+      end
+    end
+  end
+
+  it "should allow filtering of hardware_profiles by architecture" do
+    DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
+      hardware_profiles = client.hardware_profiles( :architecture=>'i386' )
+      hardware_profiles.should_not be_empty
+      hardware_profiles.size.should eql( 2 )
+      hardware_profiles.first.architecture.value.should eql( 'i386' )
+    end
+  end
+
+  it "should allow fetching a hardware_profile by id" do
+    DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
+      hwp = client.hardware_profile( 'm1-small' )
+      hwp.should_not be_nil
+      hwp.id.should eql( 'm1-small' )
+    end
+  end
+
+  it "should allow fetching a hardware_profile by URI" do
+    DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
+      hwp = client.fetch_hardware_profile( API_URL + '/hardware_profiles/m1-small' )
+      hwp.should_not be_nil
+      hwp.id.should eql( 'm1-small' )
+    end
+  end
+
+end

data/specs/images_spec.rb

@@ -0,0 +1,105 @@
+#
+# Copyright (C) 2009  Red Hat, Inc.
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.  The
+# ASF licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the
+# License.  You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+
+require 'specs/spec_helper'
+
+describe "images" do
+
+  it_should_behave_like "all resources"
+
+  it "should allow retrieval of all images" do
+    DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
+      images = client.images
+      images.should_not be_empty
+      images.size.should eql( 3 )
+      images.each do |image|
+        image.uri.should_not be_nil
+        image.uri.should be_a(String)
+        image.description.should_not be_nil
+        image.description.should be_a(String)
+        image.architecture.should_not be_nil
+        image.architecture.should be_a(String)
+        image.owner_id.should_not be_nil
+        image.owner_id.should be_a(String)
+      end
+    end
+  end
+
+  it "should allow retrieval of my own images" do
+    DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
+      images = client.images( :owner_id=>:self )
+      images.should_not be_empty
+      images.size.should eql( 1 )
+      images.each do |image|
+        image.uri.should_not be_nil
+        image.uri.should be_a(String)
+        image.description.should_not be_nil
+        image.description.should be_a(String)
+        image.architecture.should_not be_nil
+        image.architecture.should be_a(String)
+        image.owner_id.should_not be_nil
+        image.owner_id.should be_a(String)
+      end
+    end
+  end
+
+  it "should allow retrieval of a single image by ID" do
+    DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
+      image = client.image( 'img1' )
+      image.should_not be_nil
+      image.uri.should eql( API_URL + '/images/img1' )
+      image.id.should eql( 'img1' )
+      image.architecture.should eql( 'x86_64' )
+    end
+  end
+
+  it "should allow retrieval of a single image by URI" do
+    DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
+      image = client.fetch_image( API_URL + '/images/img1' )
+      image.should_not be_nil
+      image.uri.should eql( API_URL + '/images/img1' )
+      image.id.should eql( 'img1' )
+      image.architecture.should eql( 'x86_64' )
+    end
+  end
+
+  describe "filtering by architecture" do
+    it "return matching images" do
+      DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
+        images = client.images( :architecture=>'x86_64' )
+        images.should_not be_empty
+        images.each do |image|
+          image.architecture.should eql( 'x86_64' )
+        end
+        images = client.images( :architecture=>'i386' )
+        images.should_not be_empty
+        images.each do |image|
+          image.architecture.should eql( 'i386' )
+        end
+      end
+    end
+
+    it "should return an empty array for no matches" do
+      DeltaCloud.new( API_NAME, API_PASSWORD, API_URL ) do |client|
+        images = client.images( :architecture=>'8088' )
+        images.should be_empty
+      end
+    end
+  end
+end