kubeclient 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8b9d95f0fd01cbb76accf474c6526a663f9c579
-  data.tar.gz: d2304b7eff799c416993399a15f99de3e2e0a6c2
+  metadata.gz: cef89055e5f58a17421b6a66f2ad2f3d099a2f76
+  data.tar.gz: 01dcd7211472e9cf10df4ce73ea4eef569c24481
 SHA512:
-  metadata.gz: d42a19e312327a1cfa9ade3a6a25a32f9fca63ddcfabcc66d5a888b528316aad59a014481198762eedd4499cbb57849dbbaddc3f68ef8044ed1851199072b9e5
-  data.tar.gz: a1e5288ffbf0268e33b5494393b1f77274e8755a580c63c219b9cf57cf5c5a31b4415cff201e4aa0d4dbeac418b0d69b2c69c36791d7d57b37c73d479ab0a65e
+  metadata.gz: fff797cb134a26fd50e3265b1ba303fb5b22d7d02086b1c20c292e8277923f5fe0d3e74a824767bf2315a9644dc46b19da31929e5c04e866e9929b1b0f4d203d
+  data.tar.gz: c5c57ca8ffa4da1ca041053ba43191716caf17e2aa7307559c3406c3abacc85dfaf07102e0368adf8dbf8558e6bbd6177e474db52f572b259b879f10bf00f94c

data/.rubocop.yml

@@ -4,3 +4,5 @@ ClassLength:
   Enabled: false
 Metrics/AbcSize:
   Enabled: false
+Metrics/LineLength:
+  Max: 100

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, secrets, services, replication controllers, namespaces and endpoints.
+The client supports GET, POST, PUT, DELETE on nodes, pods, secrets, services, replication controllers, namespaces, resource quotas, limit ranges and endpoints.
 The client currently supports Kubernetes REST api version v1beta3.
 
 ## Installation
@@ -118,7 +118,7 @@ client = Kubeclient::Client.new 'https://localhost:8443/api/' , 'v1beta3',
 ## Examples:
 
 #### Get all instances of a specific entity type
-Such as: `get_pods`, `get_secrets`, `get_services`, `get_nodes`, `get_replication_controllers`
+Such as: `get_pods`, `get_secrets`, `get_services`, `get_nodes`, `get_replication_controllers`, `get_resource_quotas`, `get_limit_ranges`
 
 ```ruby
 pods = client.get_pods
@@ -134,7 +134,7 @@ pods = client.get_pods(label_selector: 'name=redis-master,app=redis')
 ```
 
 #### Get a specific instance of an entity (by name)
-Such as: `get_service "service name"` , `get_pod "pod name"` , `get_replication_controller "rc name"`, `get_secret "secret name"`
+Such as: `get_service "service name"` , `get_pod "pod name"` , `get_replication_controller "rc name"`, `get_secret "secret name"`, `get_resource_quota "resource quota name"`, `get_limit_range "limit range name"`
 
 The GET request should include the namespace name, except for nodes and namespaces entities.
 
@@ -159,7 +159,7 @@ client.delete_service "redis-service"
 ```
 
 #### Create an entity
-For example: `create_pod pod_object`, `create_replication_controller rc_obj`, `create_secret secret_object`
+For example: `create_pod pod_object`, `create_replication_controller rc_obj`, `create_secret secret_object`, `create_resource_quota resource_quota_object`, `create_limit_range limit_range_object`
 
 Input parameter - object of type `Service`, `Pod`, `ReplicationController`.
 
@@ -177,9 +177,9 @@ client.create_service service`
 ```
 
 #### Update an entity
-For example: `update_pod`, `update_service`, `update_replication_controller`, `update_secret`
+For example: `update_pod`, `update_service`, `update_replication_controller`, `update_secret`, `update_resource_quota`, `update_limit_range`
 
-Input parameter - object of type `Service`, `Pod`, `ReplicationController`
+Input parameter - object of type `Pod`, `Service`, `ReplicationController` etc.
 
 The below example is for v1beta3
 
@@ -188,7 +188,7 @@ client.update_service service1
 ```
 
 #### Get all entities of all types : all_entities
-Returns a hash with 8 keys (node, secret, service, pod, replication_controller, namespace, endpoint and event). Each key points to an EntityList of same type.
+Returns a hash with 10 keys (node, secret, service, pod, replication_controller, namespace, resource_quota, limit_range, endpoint and event). Each key points to an EntityList of same type.
 
 This method is a convenience method instead of calling each entity's get method separately.
 

data/lib/kubeclient.rb

@@ -12,14 +12,13 @@ module Kubeclient
   # Kubernetes Client
   class Client < Common::Client
     attr_reader :api_endpoint
-
     # Dynamically creating classes definitions (class Pod, class Service, etc.),
     # The classes are extending RecursiveOpenStruct.
     # This cancels the need to define the classes
     # manually on every new entity addition,
     # and especially since currently the class body is empty
     ENTITY_TYPES = %w(Pod Service ReplicationController Node Event Endpoint
-                      Namespace Secret).map do |et|
+                      Namespace Secret ResourceQuota LimitRange).map do |et|
       clazz = Class.new(RecursiveOpenStruct) do
         def initialize(hash = nil, args = {})
           args.merge!(recurse_over_arrays: true)
@@ -68,19 +67,6 @@ module Kubeclient
 
     private
 
-    def validate_auth_options(opts)
-      exclusive_keys = [:bearer_token, :bearer_token_file, :user]
-
-      return if exclusive_keys.none? { |s| opts.key?(s) }
-
-      msg = 'Invalid auth options: specify only one of user/password,' \
-            ' bearer_token or bearer_token_file'
-      fail ArgumentError, msg unless exclusive_keys.one? { |s| opts.key?(s)  }
-
-      msg = 'Basic auth requires both user & password'
-      fail ArgumentError, msg if opts.key?(:user) && !opts.key?(:password)
-    end
-
     def validate_bearer_token_file(bearer_token_file)
       msg = "Token file #{bearer_token_file} does not exist"
       fail ArgumentError, msg unless File.file?(bearer_token_file)

data/lib/kubeclient/common.rb

@@ -32,7 +32,7 @@ module Kubeclient
       def self.define_entity_methods(entity_types)
         entity_types.each do |klass, entity_type|
           entity_name = entity_type.underscore
-          entity_name_plural = entity_name.pluralize
+          entity_name_plural = pluralize_entity(entity_name)
 
           # get all entities of a type e.g. get_nodes, get_pods, etc.
           define_method("get_#{entity_name_plural}") do |options = {}|
@@ -64,6 +64,11 @@ module Kubeclient
         end
       end
 
+      def self.pluralize_entity(entity_name)
+        return entity_name + 's' if entity_name.end_with? 'quota'
+        entity_name.pluralize
+      end
+
       def create_rest_client(path = nil)
         path ||= @api_endpoint.path
         options = {
@@ -192,14 +197,15 @@ module Kubeclient
         entity_types.each_with_object({}) do |(_, entity_type), result_hash|
           # method call for get each entities
           # build hash of entity name to array of the entities
-          method_name = "get_#{entity_type.underscore.pluralize}"
+          entity_name = self.class.pluralize_entity entity_type.underscore
+          method_name = "get_#{entity_name}"
           key_name = entity_type.underscore
           result_hash[key_name] = send(method_name)
         end
       end
 
       def resource_name(entity_type)
-        entity_type.pluralize.downcase
+        self.class.pluralize_entity entity_type.downcase
       end
 
       def api_valid?
@@ -220,6 +226,19 @@ module Kubeclient
         @headers ||= {}
         @headers[:Authorization] = "Bearer #{bearer_token}"
       end
+
+      def validate_auth_options(opts)
+        exclusive_keys = [:bearer_token, :bearer_token_file, :user]
+
+        return if exclusive_keys.none? { |s| opts.key?(s) }
+
+        msg = 'Invalid auth options: specify only one of user/password,' \
+            ' bearer_token or bearer_token_file'
+        fail ArgumentError, msg unless exclusive_keys.one? { |s| opts.key?(s)  }
+
+        msg = 'Basic auth requires both user & password'
+        fail ArgumentError, msg if opts.key?(:user) && !opts.key?(:password)
+      end
     end
   end
 end

data/lib/kubeclient/version.rb

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

data/test/json/limit_range.json

@@ -0,0 +1,23 @@
+{
+  "kind": "LimitRange",
+  "apiVersion": "v1",
+  "metadata": {
+    "name": "limits",
+    "namespace": "quota-example",
+    "selfLink": "/api/v1/namespaces/quota-example/limitranges/limits",
+    "uid": "7a76a44c-3e9d-11e5-8214-0aaeec44370e",
+    "resourceVersion": "103384",
+    "creationTimestamp": "2015-08-09T13:49:39Z"
+  },
+  "spec": {
+    "limits": [
+      {
+        "type": "Container",
+        "default": {
+          "cpu": "100m",
+          "memory": "512Mi"
+        }
+      }
+    ]
+  }
+}

data/test/json/limit_range_list.json

@@ -0,0 +1,31 @@
+{
+  "kind": "LimitRangeList",
+  "apiVersion": "v1",
+  "metadata": {
+    "selfLink": "/api/v1/namespaces/quota-example/limitranges/",
+    "resourceVersion": "103421"
+  },
+  "items": [
+    {
+      "metadata": {
+        "name": "limits",
+        "namespace": "quota-example",
+        "selfLink": "/api/v1/namespaces/quota-example/limitranges/limits",
+        "uid": "7a76a44c-3e9d-11e5-8214-0aaeec44370e",
+        "resourceVersion": "103384",
+        "creationTimestamp": "2015-08-09T13:49:39Z"
+      },
+      "spec": {
+        "limits": [
+          {
+            "type": "Container",
+            "default": {
+              "cpu": "100m",
+              "memory": "512Mi"
+            }
+          }
+        ]
+      }
+    }
+  ]
+}

data/test/json/resource_quota.json

@@ -0,0 +1,46 @@
+{
+  "kind": "ResourceQuota",
+  "apiVersion": "v1",
+  "metadata": {
+    "name": "quota",
+    "namespace": "quota-example",
+    "selfLink": "/api/v1/namespaces/quota-example/resourcequotas/quota",
+    "uid": "ab9f24a4-3c43-11e5-8214-0aaeec44370e",
+    "resourceVersion": "12919",
+    "creationTimestamp": "2015-08-06T14:01:44Z"
+  },
+  "spec": {
+    "hard": {
+      "cpu": "20",
+      "memory": "1Gi",
+      "persistentvolumeclaims": "10",
+      "pods": "10",
+      "replicationcontrollers": "20",
+      "resourcequotas": "1",
+      "secrets": "10",
+      "services": "5"
+    }
+  },
+  "status": {
+    "hard": {
+      "cpu": "20",
+      "memory": "1Gi",
+      "persistentvolumeclaims": "10",
+      "pods": "10",
+      "replicationcontrollers": "20",
+      "resourcequotas": "1",
+      "secrets": "10",
+      "services": "5"
+    },
+    "used": {
+      "cpu": "0",
+      "memory": "0",
+      "persistentvolumeclaims": "0",
+      "pods": "0",
+      "replicationcontrollers": "1",
+      "resourcequotas": "1",
+      "secrets": "9",
+      "services": "0"
+    }
+  }
+}

data/test/json/resource_quota_list.json

@@ -0,0 +1,54 @@
+{
+  "kind": "ResourceQuotaList",
+  "apiVersion": "v1",
+  "metadata": {
+    "selfLink": "/api/v1/namespaces/quota-example/resourcequotas/",
+    "resourceVersion": "102452"
+  },
+  "items": [
+    {
+      "metadata": {
+        "name": "quota",
+        "namespace": "quota-example",
+        "selfLink": "/api/v1/namespaces/quota-example/resourcequotas/quota",
+        "uid": "ab9f24a4-3c43-11e5-8214-0aaeec44370e",
+        "resourceVersion": "12919",
+        "creationTimestamp": "2015-08-06T14:01:44Z"
+      },
+      "spec": {
+        "hard": {
+          "cpu": "20",
+          "memory": "1Gi",
+          "persistentvolumeclaims": "10",
+          "pods": "10",
+          "replicationcontrollers": "20",
+          "resourcequotas": "1",
+          "secrets": "10",
+          "services": "5"
+        }
+      },
+      "status": {
+        "hard": {
+          "cpu": "20",
+          "memory": "1Gi",
+          "persistentvolumeclaims": "10",
+          "pods": "10",
+          "replicationcontrollers": "20",
+          "resourcequotas": "1",
+          "secrets": "10",
+          "services": "5"
+        },
+        "used": {
+          "cpu": "0",
+          "memory": "0",
+          "persistentvolumeclaims": "0",
+          "pods": "0",
+          "replicationcontrollers": "1",
+          "resourcequotas": "1",
+          "secrets": "9",
+          "services": "0"
+        }
+      }
+    }
+  ]
+}

data/test/test_kubeclient.rb

@@ -219,9 +219,17 @@ class KubeClientTest < MiniTest::Test
       .to_return(body: open_test_json_file('secret_list_b3.json'),
                  status: 200)
 
+    stub_request(:get, %r{/resourcequotas})
+      .to_return(body: open_test_json_file('resource_quota_list.json'),
+                 status: 200)
+
+    stub_request(:get, %r{/limitranges})
+      .to_return(body: open_test_json_file('limit_range_list.json'),
+                 status: 200)
+
     client = Kubeclient::Client.new 'http://localhost:8080/api/', 'v1beta3'
     result = client.all_entities
-    assert_equal(8, result.keys.size)
+    assert_equal(10, result.keys.size)
     assert_instance_of(Kubeclient::Common::EntityList, result['node'])
     assert_instance_of(Kubeclient::Common::EntityList, result['service'])
     assert_instance_of(Kubeclient::Common::EntityList,
@@ -236,6 +244,8 @@ class KubeClientTest < MiniTest::Test
     assert_instance_of(Kubeclient::Endpoint, result['endpoint'][0])
     assert_instance_of(Kubeclient::Namespace, result['namespace'][0])
     assert_instance_of(Kubeclient::Secret, result['secret'][0])
+    assert_instance_of(Kubeclient::ResourceQuota, result['resource_quota'][0])
+    assert_instance_of(Kubeclient::LimitRange, result['limit_range'][0])
   end
 
   def test_api_bearer_token_with_params_success

data/test/test_limit_range.rb

@@ -0,0 +1,23 @@
+require 'test_helper'
+
+# LimitRange tests
+class TestLimitRange < MiniTest::Test
+  def test_get_from_json_v3
+    stub_request(:get, %r{/limitranges})
+      .to_return(body: open_test_json_file('limit_range.json'),
+                 status: 200)
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/', 'v1'
+    limit_range = client.get_limit_range 'limits', 'quota-example'
+
+    assert_instance_of(Kubeclient::LimitRange, limit_range)
+    assert_equal('limits', limit_range.metadata.name)
+    assert_equal('Container', limit_range.spec.limits[0].type)
+    assert_equal('100m', limit_range.spec.limits[0].default.cpu)
+    assert_equal('512Mi', limit_range.spec.limits[0].default.memory)
+
+    assert_requested(:get,
+                     'http://localhost:8080/api/v1/namespaces/quota-example/limitranges/limits',
+                     times: 1)
+  end
+end

data/test/test_resource_quota.rb

@@ -0,0 +1,22 @@
+require 'test_helper'
+
+# ResourceQuota tests
+class TestResourceQuota < MiniTest::Test
+  def test_get_from_json_v3
+    stub_request(:get, %r{/resourcequotas})
+      .to_return(body: open_test_json_file('resource_quota.json'),
+                 status: 200)
+
+    client = Kubeclient::Client.new 'http://localhost:8080/api/', 'v1'
+    quota = client.get_resource_quota 'quota', 'quota-example'
+
+    assert_instance_of(Kubeclient::ResourceQuota, quota)
+    assert_equal('quota', quota.metadata.name)
+    assert_equal('20', quota.spec.hard.cpu)
+    assert_equal('10', quota.spec.hard.secrets)
+
+    assert_requested(:get,
+                     'http://localhost:8080/api/v1/namespaces/quota-example/resourcequotas/quota',
+                     times: 1)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubeclient
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alissa Bonas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-28 00:00:00.000000000 Z
+date: 2015-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -165,6 +165,8 @@ files:
 - test/json/endpoint_list_b3.json
 - test/json/entity_list_b3.json
 - test/json/event_list_b3.json
+- test/json/limit_range.json
+- test/json/limit_range_list.json
 - test/json/namespace_b3.json
 - test/json/namespace_exception_b3.json
 - test/json/namespace_list_b3.json
@@ -174,6 +176,8 @@ files:
 - test/json/pod_list_b3.json
 - test/json/replication_controller_b3.json
 - test/json/replication_controller_list_b3.json
+- test/json/resource_quota.json
+- test/json/resource_quota_list.json
 - test/json/secret_list_b3.json
 - test/json/service_b3.json
 - test/json/service_illegal_json_404.json
@@ -183,10 +187,12 @@ files:
 - test/json/watch_stream_b3.json
 - test/test_helper.rb
 - test/test_kubeclient.rb
+- test/test_limit_range.rb
 - test/test_namespace.rb
 - test/test_node.rb
 - test/test_pod.rb
 - test/test_replication_controller.rb
+- test/test_resource_quota.rb
 - test/test_secret.rb
 - test/test_service.rb
 - test/test_watch.rb
@@ -223,6 +229,8 @@ test_files:
 - test/json/endpoint_list_b3.json
 - test/json/entity_list_b3.json
 - test/json/event_list_b3.json
+- test/json/limit_range.json
+- test/json/limit_range_list.json
 - test/json/namespace_b3.json
 - test/json/namespace_exception_b3.json
 - test/json/namespace_list_b3.json
@@ -232,6 +240,8 @@ test_files:
 - test/json/pod_list_b3.json
 - test/json/replication_controller_b3.json
 - test/json/replication_controller_list_b3.json
+- test/json/resource_quota.json
+- test/json/resource_quota_list.json
 - test/json/secret_list_b3.json
 - test/json/service_b3.json
 - test/json/service_illegal_json_404.json
@@ -241,10 +251,12 @@ test_files:
 - test/json/watch_stream_b3.json
 - test/test_helper.rb
 - test/test_kubeclient.rb
+- test/test_limit_range.rb
 - test/test_namespace.rb
 - test/test_node.rb
 - test/test_pod.rb
 - test/test_replication_controller.rb
+- test/test_resource_quota.rb
 - test/test_secret.rb
 - test/test_service.rb
 - test/test_watch.rb