kubeclient 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 969c44ae3642047678c13559de1790323feffa7e
-  data.tar.gz: 5a19f3d5e8e0c8d764bc2746999f2a78d8fde8bb
+  metadata.gz: 606934d03c5c996609d2b20af68672b4d90df04b
+  data.tar.gz: c70040510e8b0745b427c07c64d172f130ae22fb
 SHA512:
-  metadata.gz: da458497e1dd0590faea0ce5175c10670ba424b074444845f15bca7f122dd3fd460448ac1d385cb762906dc493297967281a9c3d1f432d5d98ffa27f7f0a2100
-  data.tar.gz: 7fb264604c4ba1d5a6405ec51a6ea1eb2d9686bc08bf71cc2b7aa24eec5574d51eeb016bf9cace170e7a08d6a97ff1e6fbe9f47c32df9fefceeab20ec67db13c
+  metadata.gz: 5f45329a666f56582aab3c390a6f16fe45cc3a9cc973792b080fddfc2b6a08303ef65c324c19b571803f9b7357103ec2b27404be2a9a96b41ddea7ed75ac8eb3
+  data.tar.gz: c92d77763653279b5302432d74af067f58029138c7592492a2603ed6dc25920e0bf316533d7649a6f110ee250b0cc68f8f8e965a8a653e6c1ebc35a90f1f152b

data/README.md

@@ -6,7 +6,7 @@
 [![Dependency Status](https://gemnasium.com/abonas/kubeclient.svg)](https://gemnasium.com/abonas/kubeclient)
 
 A Ruby client for Kubernetes REST api.
-The client supports GET, POST, PUT, DELETE on nodes, pods, services, replication controllers and namespaces.
+The client supports GET, POST, PUT, DELETE on nodes, pods, services, replication controllers, namespaces and endpoints.
 The client currently supports Kubernetes REST api version v1beta3.
 
 ## Installation
@@ -61,16 +61,20 @@ Examples:
 <br>
 `pods = client.get_pods`
 <br>
-You can get entities which have specific labels by specifying input parameter named `label-selector`: <br>
+You can get entities which have specific labels by specifying a parameter named `label_selector` (named `labelSelector` in Kubernetes server): <br>
 `pods = client.get_pods(label_selector: 'name=redis-master')` <br>
-You can specify multiple labels and that returns entities which have both labels:  <br>
+You can specify multiple labels (that option will return entities which have both labels:  <br>
 `pods = client.get_pods(label_selector: 'name=redis-master,app=redis')`
 
-2. Get a specific node (and respectively: get_service "service id" , get_pod "pod id" , get_replication_controller "rc id" )
+2. Get a specific node (and respectively: get_service "service name" , get_pod "pod name" , get_replication_controller "rc name" )
 <br>
-`node1 = client.get_node "127.0.0.1"`
+The GET request should include the namespace name, except for nodes and namespaces entities.
 <br>
-Note - Kubernetes doesn't work with the uid, but rather with the 'id' property.
+`node = client.get_node "127.0.0.1"`
+<br>
+`service = client.get_service "guestbook", 'development'`
+<br>
+Note - Kubernetes doesn't work with the uid, but rather with the 'name' property.
 Querying with uid causes 404.
 
 3. Delete a service (and respectively delete_pod "pod id" , delete_replication_controller "rc id", delete node "node id") <br>

data/lib/kubeclient.rb

@@ -41,7 +41,7 @@ module Kubeclient
 
     def api
       response = handle_exception do
-        RestClient::Resource.new(@api_endpoint.to_s).get
+        create_rest_client.get
       end
       JSON.parse(response)
     end

data/lib/kubeclient/common.rb

@@ -8,10 +8,11 @@ module Kubeclient
         yield
       rescue RestClient::Exception => e
         begin
-          err_message = JSON.parse(e.response)['message']
+          json_error_msg = JSON.parse(e.response || '') || {}
         rescue JSON::ParserError
-          err_message = e.message
+          json_error_msg = {}
         end
+        err_message = json_error_msg['message'] || e.message
         raise KubeException.new(e.http_code, err_message)
       end
 
@@ -22,6 +23,10 @@ module Kubeclient
                            if @api_endpoint.path.end_with? '/'
       end
 
+      def build_namespace_prefix(namespace)
+        namespace.to_s.empty? ? '' : "namespaces/#{namespace}/"
+      end
+
       public
 
       def self.define_entity_methods(entity_types)
@@ -41,8 +46,8 @@ module Kubeclient
           end
 
           # get a single entity of a specific type by name
-          define_method("get_#{entity_name}") do |name|
-            get_entity(entity_type, klass, name)
+          define_method("get_#{entity_name}") do |name, namespace = nil|
+            get_entity(entity_type, klass, name, namespace)
           end
 
           define_method("delete_#{entity_name}") do |name|
@@ -50,7 +55,7 @@ module Kubeclient
           end
 
           define_method("create_#{entity_name}") do |entity_config|
-            create_entity(entity_type, entity_config)
+            create_entity(entity_type, entity_config, klass)
           end
 
           define_method("update_#{entity_name}") do |entity_config|
@@ -59,22 +64,25 @@ module Kubeclient
         end
       end
 
+      def create_rest_client(path = nil)
+        path ||= @api_endpoint.path
+        options = {
+          ssl_ca_file: @ssl_options[:ca_file],
+          verify_ssl: @ssl_options[:verify_ssl],
+          ssl_client_cert: @ssl_options[:client_cert],
+          ssl_client_key: @ssl_options[:client_key]
+        }
+        RestClient::Resource.new(@api_endpoint.merge(path).to_s, options)
+      end
+
       def rest_client
         @rest_client ||= begin
-          options = {
-            ssl_ca_file: @ssl_options[:ca_file],
-            verify_ssl: @ssl_options[:verify_ssl],
-            ssl_client_cert: @ssl_options[:client_cert],
-            ssl_client_key: @ssl_options[:client_key]
-          }
-          endpoint_with_ver = @api_endpoint
-                              .merge("#{@api_endpoint.path}/#{@api_version}")
-          RestClient::Resource.new(endpoint_with_ver, options)
+          create_rest_client("#{@api_endpoint.path}/#{@api_version}")
         end
       end
 
       def watch_entities(entity_type, resource_version = nil)
-        resource = get_resource_name(entity_type.to_s)
+        resource = resource_name(entity_type.to_s)
 
         uri = @api_endpoint
               .merge("#{@api_endpoint.path}/#{@api_version}/watch/#{resource}")
@@ -99,12 +107,12 @@ module Kubeclient
       def get_entities(entity_type, klass, options)
         params = {}
         if options[:label_selector]
-          params['label-selector'] = options[:label_selector]
+          params['labelSelector'] = options[:label_selector]
         end
 
         # TODO: namespace support?
         response = handle_exception do
-          rest_client[get_resource_name(entity_type)].get(params: params)
+          rest_client[resource_name(entity_type)].get(params: params)
         end
 
         result = JSON.parse(response)
@@ -120,9 +128,10 @@ module Kubeclient
         EntityList.new(entity_type, resource_version, collection)
       end
 
-      def get_entity(entity_type, klass, name)
+      def get_entity(entity_type, klass, name, namespace = nil)
+        ns_prefix = build_namespace_prefix(namespace)
         response = handle_exception do
-          rest_client[get_resource_name(entity_type) + "/#{name}"].get
+          rest_client[ns_prefix + resource_name(entity_type) + "/#{name}"].get
         end
         result = JSON.parse(response)
         new_entity(result, klass)
@@ -130,22 +139,27 @@ module Kubeclient
 
       def delete_entity(entity_type, name)
         handle_exception do
-          rest_client[get_resource_name(entity_type) + "/#{name}"].delete
+          rest_client[resource_name(entity_type) + "/#{name}"].delete
         end
       end
 
-      def create_entity(entity_type, entity_config)
+      def create_entity(entity_type, entity_config, klass)
         # to_hash should be called because of issue #9 in recursive open
         # struct
         hash = entity_config.to_hash
+
+        ns_prefix = build_namespace_prefix(entity_config.metadata.namespace)
+
         # TODO: temporary solution to add "kind" and apiVersion to request
         # until this issue is solved
         # https://github.com/GoogleCloudPlatform/kubernetes/issues/6439
         hash['kind'] = entity_type
         hash['apiVersion'] = @api_version
-        handle_exception do
-          rest_client[get_resource_name(entity_type)].post(hash.to_json)
+        response = handle_exception do
+          rest_client[ns_prefix + resource_name(entity_type)].post(hash.to_json)
         end
+        result = JSON.parse(response)
+        new_entity(result, klass)
       end
 
       def update_entity(entity_type, entity_config)
@@ -153,11 +167,9 @@ module Kubeclient
         # to_hash should be called because of issue #9 in recursive open
         # struct
         hash = entity_config.to_hash
-        # TODO: temporary solution to delete id till this issue is solved
-        # https://github.com/GoogleCloudPlatform/kubernetes/issues/3085
-        hash.delete(:id)
+        ns_prefix = build_namespace_prefix(entity_config.metadata.namespace)
         handle_exception do
-          rest_client[get_resource_name(entity_type) + "/#{name}"]
+          rest_client[ns_prefix + resource_name(entity_type) + "/#{name}"]
             .put(hash.to_json)
         end
       end
@@ -176,7 +188,7 @@ module Kubeclient
         end
       end
 
-      def get_resource_name(entity_type)
+      def resource_name(entity_type)
         if @api_version == 'v1beta1'
           entity_type.pluralize.camelize(:lower)
         else

data/lib/kubeclient/version.rb

@@ -1,4 +1,4 @@
 # Kubernetes REST-API Client
 module Kubeclient
-  VERSION = '0.1.11'
+  VERSION = '0.1.12'
 end

data/test/json/created_namespace_b3.json

@@ -0,0 +1,20 @@
+{
+"kind": "Namespace",
+"apiVersion": "v1beta3",
+"metadata": {
+"name": "development",
+"selfLink": "/api/v1beta3/namespaces/development",
+"uid": "13d820d6-df5b-11e4-bd42-f8b156af4ae1",
+"resourceVersion": "2533",
+"creationTimestamp": "2015-04-10T08:24:59Z"
+},
+"spec": {
+"finalizers": [
+"kubernetes"
+]
+},
+"status": {
+"phase": "Active"
+}
+}
+

data/test/json/created_service_b3.json

@@ -0,0 +1,31 @@
+{
+    "kind": "Service",
+    "apiVersion": "v1beta3",
+    "metadata": {
+        "name": "guestbook",
+        "namespace": "staging",
+        "selfLink": "/api/v1beta3/namespaces/staging/services/guestbook",
+        "uid": "29885239-df58-11e4-bd42-f8b156af4ae1",
+        "resourceVersion": "1908",
+        "creationTimestamp": "2015-04-10T08:04:07Z",
+        "labels": {
+            "name": "guestbook"
+        }
+    },
+    "spec": {
+        "ports": [
+            {
+                "name": "",
+                "protocol": "TCP",
+                "port": 3000,
+                "targetPort": "http-server"
+            }
+        ],
+        "selector": {
+            "name": "guestbook"
+        },
+        "portalIP": "10.0.0.99",
+        "sessionAffinity": "None"
+    },
+    "status": {}
+}

data/test/test_kubeclient.rb

@@ -48,12 +48,14 @@ class KubeClientTest < MiniTest::Test
                  status: 409)
 
     service = Kubeclient::Service.new
-    service.name = 'redisslave'
-    service.port = 80
-    service.container_port = 6379
-    service.protocol = 'TCP'
+    service.metadata = {}
+    service.metadata.name = 'redisslave'
+    service.metadata.namespace = 'default'
+    # service.port = 80
+    # service.container_port = 6379
+    # service.protocol = 'TCP'
 
-    client = Kubeclient::Client.new 'http://localhost:8080/api/', 'v1beta3'
+    client = Kubeclient::Client.new 'http://localhost:8080/api/'
 
     exception = assert_raises(KubeException) do
       service = client.create_service service
@@ -74,6 +76,18 @@ class KubeClientTest < MiniTest::Test
     assert_includes(response, 'versions')
   end
 
+  def test_api_ssl_failure
+    error_message = 'certificate verify failed'
+
+    stub_request(:get, 'http://localhost:8080/api')
+      .to_raise(OpenSSL::SSL::SSLError.new(error_message))
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/'
+
+    exception = assert_raises(KubeException) { client.api }
+    assert_equal(error_message, exception.message)
+  end
+
   def test_api_valid
     stub_request(:get, 'http://localhost:8080/api')
       .to_return(status: 200, body: open_test_json_file('versions_list.json'))

data/test/test_namespace.rb

@@ -27,4 +27,19 @@ class TestNamespace < MiniTest::Test
     client = Kubeclient::Client.new 'http://localhost:8080/api/', 'v1beta3'
     client.delete_namespace our_namespace.name
   end
+
+  def test_create_namespace
+    stub_request(:post, %r{/namespaces})
+      .to_return(body: open_test_json_file('created_namespace_b3.json'),
+                 status: 201)
+
+    namespace = Kubeclient::Namespace.new
+    namespace.metadata = {}
+    namespace.metadata.name = 'development'
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/'
+    created_namespace = client.create_namespace namespace
+    assert_instance_of(Kubeclient::Namespace, created_namespace)
+    assert_equal(namespace.metadata.name, created_namespace.metadata.name)
+  end
 end

data/test/test_service.rb

@@ -4,18 +4,35 @@ require 'test_helper'
 class TestService < MiniTest::Test
   def test_construct_our_own_service
     our_service = Kubeclient::Service.new
-    our_service.name = 'redis-service'
-    # TODO, new ports assignment to be added
-    our_service.labels = {}
-    our_service.labels.component = 'apiserver'
-    our_service.labels.provider = 'kubernetes'
+    our_service.metadata = {}
+    our_service.metadata.name = 'guestbook'
+    our_service.metadata.namespace = 'staging'
+    our_service.metadata.labels = {}
+    our_service.metadata.labels.name = 'guestbook'
+
+    our_service.spec = {}
+    our_service.spec.ports = [{ 'port' => 3000,
+                                'targetPort' => 'http-server',
+                                'protocol' => 'TCP'
+    }]
 
-    assert_equal('kubernetes', our_service.labels.provider)
-    assert_equal('apiserver', our_service.labels.component)
+    assert_equal('guestbook', our_service.metadata.labels.name)
 
     hash = our_service.to_h
 
-    assert_equal our_service.labels.provider, hash[:labels][:provider]
+    assert_equal our_service.metadata.labels.name,
+                 hash[:metadata][:labels][:name]
+
+    stub_request(:post, %r{namespaces/staging/services})
+      .to_return(body: open_test_json_file('created_service_b3.json'),
+                 status: 201)
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/'
+    created = client.create_service our_service
+
+    assert_instance_of(Kubeclient::Service, created)
+    assert_equal(created.metadata.name, our_service.metadata.name)
+    assert_equal(created.spec.ports.size, our_service.spec.ports.size)
   end
 
   def test_conversion_from_json_v3
@@ -56,4 +73,28 @@ class TestService < MiniTest::Test
     client = Kubeclient::Client.new 'http://localhost:8080/api/', 'v1beta3'
     client.delete_service our_service.id
   end
+
+  def test_get_service_no_ns
+    # when not specifying namespace for entities which
+    # are not node or namespace, the request will fail
+    stub_request(:get, %r{/services/redis-slave})
+      .to_return(status: 404)
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/'
+
+    exception = assert_raises(KubeException) do
+      client.get_service 'redis-slave'
+    end
+    assert_equal(404, exception.error_code)
+  end
+
+  def test_get_service
+    stub_request(:get, %r{/namespaces/development/services/redis-slave})
+      .to_return(body: open_test_json_file('service_b3.json'),
+                 status: 200)
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/'
+    service = client.get_service 'redis-slave', 'development'
+    assert_equal('redis-slave', service.metadata.name)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubeclient
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Alissa Bonas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2015-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -158,6 +158,8 @@ files:
 - lib/kubeclient/version.rb
 - lib/kubeclient/watch_notice.rb
 - lib/kubeclient/watch_stream.rb
+- test/json/created_namespace_b3.json
+- test/json/created_service_b3.json
 - test/json/empty_pod_list_b3.json
 - test/json/endpoint_list_b3.json
 - test/json/entity_list_b3.json
@@ -209,6 +211,8 @@ signing_key:
 specification_version: 4
 summary: A client for Kubernetes REST api
 test_files:
+- test/json/created_namespace_b3.json
+- test/json/created_service_b3.json
 - test/json/empty_pod_list_b3.json
 - test/json/endpoint_list_b3.json
 - test/json/entity_list_b3.json