k8s-client 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 780d34c7890954d2e54e0b158f94a8d90e9b5bdaaab11e65cf2db86e695f640a
-  data.tar.gz: 40f4843ff19e0b403f906e2f17f9ff7859c5f47413f0354e7ae1758fc5d24377
+  metadata.gz: 767ebc980b6e01f66e4739cc341aa7518245287d88273068460358b88f8b110f
+  data.tar.gz: 73a21392fdf0ad9e56060571aced26e0b53983f6f2c1b727280a16d72dbaa8a1
 SHA512:
-  metadata.gz: 8a5014cf50bd530964fd31c686587288c76bd86aff746bdd5c09b73ec265a82baf4e46d10d297150d48e8984f7d7bc3f0eee25c33511611b7d71e73397675cc0
-  data.tar.gz: fda08120279153fd294f8b7a820acdd052f61d6a96d589733800e90ef3673863e3fe5ef600ae5b46f421c4a32b2994681840da356424c0da5aea650faf96dedf
+  metadata.gz: a2943973befbad7b7f24b6f9aa9aa186a20ca5e970259bcb2a354e8161511af4a42d29aeceb75ab26f9031c414f56d0f7f7cc606723e4f585c637427d4e59e6d
+  data.tar.gz: a8161a1c2b74a027395a33ee3ff39ea4b87554615d861933a5a0c04cac4525086bc84ca91234ab7c62b308b067ec441b7b396c7fb9e3e08493141814a3acf0b2

data/lib/k8s-client.rb

@@ -11,3 +11,4 @@ require 'k8s/resource'
 require 'k8s/resource_client'
 require 'k8s/stack'
 require 'k8s/transport'
+require 'k8s/util'

data/lib/k8s/client.rb

@@ -58,19 +58,22 @@ module K8s
     end
 
     # @param api_versions [Array<String>] defaults to all APIs
+    # @param prefetch_resources [Boolean] prefetch any missing api_resources for each api_version
+    # @param skip_missing [Boolean] return APIClient without api_resources? if 404
     # @return [Array<APIClient>]
-    def apis(api_versions = nil, prefetch_resources: false)
+    def apis(api_versions = nil, prefetch_resources: false, skip_missing: false)
       api_versions ||= ['v1'] + self.api_groups
 
       if prefetch_resources
         # api groups that are missing their api_resources
         api_paths = api_versions
+          .uniq
           .select{|api_version| !api(api_version).api_resources? }
           .map{|api_version| APIClient.path(api_version) }
 
         # load into APIClient.api_resources=
-        @transport.gets(*api_paths, response_class: K8s::API::MetaV1::APIResourceList).each do |api_resource_list|
-          api(api_resource_list.groupVersion).api_resources = api_resource_list.resources
+        @transport.gets(*api_paths, response_class: K8s::API::MetaV1::APIResourceList, skip_missing: skip_missing).each do |api_resource_list|
+          api(api_resource_list.groupVersion).api_resources = api_resource_list.resources if api_resource_list
         end
       end
 
@@ -116,21 +119,32 @@ module K8s
       client_for_resource(resource).get_resource(resource)
     end
 
+    # Returns nils for any resources that do not exist.
+    # This includes custom resources that were not yet defined.
+    #
     # @param resources [Array<K8s::Resource>]
-    # @return [Array<K8s::Resource, nil>]
+    # @return [Array<K8s::Resource, nil>] matching resources array 1:1
     def get_resources(resources)
-      # prefetch api resources
-      apis(resources.map{|resource| resource.apiVersion }.uniq, prefetch_resources: true)
+      # prefetch api resources, skip missing APIs
+      resource_apis = apis(resources.map{ |resource| resource.apiVersion }, prefetch_resources: true, skip_missing: true)
+
+      # map each resource to excon request options, or nil if resource is not (yet) defined
+      requests = resources.zip(resource_apis).map{ |resource, api_client|
+        next nil unless api_client.api_resources?
+
+        resource_client = api_client.client_for_resource(resource)
 
-      resource_clients = resources.map{|resource| client_for_resource(resource) }
-      requests = resources.zip(resource_clients).map{|resource, resource_client|
         {
           method: 'GET',
           path: resource_client.path(resource.metadata.name, namespace: resource.metadata.namespace),
           response_class: resource_client.resource_class,
         }
       }
-      responses = @transport.requests(*requests, skip_missing: true)
+
+      # map non-nil requests to response objects, or nil for nil request options
+      Util.compact_map(requests) { |reqs|
+        @transport.requests(*reqs, skip_missing: true)
+      }
     end
 
     # @param resource [K8s::Resource]

data/lib/k8s/client/version.rb

@@ -1,5 +1,5 @@
 module K8s
   class Client
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/k8s/stack.rb

@@ -124,6 +124,7 @@ module K8s
             client.delete_resource(resource)
           rescue K8s::Error::NotFound
             # assume aliased objects in multiple API groups, like for Deployments
+            # alternatively, a custom resource whose definition was already deleted earlier
           end
         end
       end

data/lib/k8s/transport.rb

@@ -201,19 +201,21 @@ module K8s
     # @param skip_missing [Boolean] return nil for HTTP 404 responses
     # @param retry_errors [Boolean] retry with non-pipelined request for HTTP 503 responses
     # @return [Array<response_class, Hash, nil>]
-    def requests(*options, response_class: nil, skip_missing: false, retry_errors: true)
+    def requests(*options, skip_missing: false, retry_errors: true, **common_options)
       return [] if options.empty? # excon chokes
 
       start = Time.now
       responses = excon.requests(
-        options.map{|options| request_options(**options)}
+        options.map{|options| request_options(**common_options.merge(options))}
       )
       t = Time.now - start
 
       objects = responses.zip(options).map{|response, request_options|
+        response_class = request_options[:response_class] || common_options[:response_class]
+
         begin
           parse_response(response, request_options,
-            response_class: request_options[:response_class] || response_class,
+            response_class: response_class,
           )
         rescue K8s::Error::NotFound
           if skip_missing
@@ -226,7 +228,7 @@ module K8s
             logger.warn { "Retry #{format_request(request_options)} => HTTP #{exc.code} #{exc.reason} in #{'%.3f' % t}s" }
 
             # only retry the failed request, not the entire pipeline
-            request(response_class: response_class, **request_options)
+            request(response_class: response_class, **common_options.merge(request_options))
           else
             raise
           end
@@ -250,13 +252,12 @@ module K8s
     end
 
     # @param *paths [String]
-    def gets(*paths, response_class: nil, **options)
+    def gets(*paths, **options)
       requests(*paths.map{|path| {
           method: 'GET',
           path: self.path(path),
-          **options,
         } },
-        response_class: response_class,
+        **options
       )
     end
   end

data/lib/k8s/util.rb

@@ -0,0 +1,22 @@
+module K8s
+  module Util
+    # Yield with all non-nil args, returning matching array with corresponding return values or nils.
+    #
+    # Args must be usable as hash keys. Duplicate args will all map to the same return value.
+    #
+    # @param args [Array<nil, Object>]
+    # @yield args
+    # @yieldparam args [Array<Object>] omitting any nil values
+    # @return [Array<nil, Object>] matching args array 1:1, containing yielded values for non-nil args
+    def self.compact_map(args)
+      func_args = args.compact
+
+      values = yield func_args
+
+      # Hash{arg => value}
+      value_map = Hash[func_args.zip(values)]
+
+      args.map{|arg| value_map[arg] }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k8s-client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kontena, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-09 00:00:00.000000000 Z
+date: 2018-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -159,6 +159,7 @@ files:
 - lib/k8s/resource_client.rb
 - lib/k8s/stack.rb
 - lib/k8s/transport.rb
+- lib/k8s/util.rb
 homepage: https://github.com/kontena/k8s-client
 licenses:
 - Apache-2.0