kubeclient 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9aaeb2002708298a57d829ccce3530a4233de62
-  data.tar.gz: 4343990defde5ef36719ccbf02936b92e7e1be5c
+  metadata.gz: ad5e0d0d632be2585068c14cf2eb218e20788c83
+  data.tar.gz: f7b002dcb8a7a49381b3bdbe8e6eaf2abdbe1f4d
 SHA512:
-  metadata.gz: 928f8df41783e2eb13c65536de2ad3270f3ed3fcc95459d25fcb21a66a6e86b0f279a9c238cddb7196dc82bd7c9cc7dd42a778f208ee56397e149a4c0f048f3c
-  data.tar.gz: 9a541d45aba922c4ab24196bd3d0cb755a46ae5bd276436510fa66e60cdc6c60056eba4501152036751ec5cd8ec3ec8c0d254687c54b6ba532ac18812634a06b
+  metadata.gz: 0bec0e053d54fa34c6b058c071b55e681d0c97497808ba7e23703dcfde1dff5e86be185a2b3cf0c1c834b50857b11298ff524f14ed42c2145d18d859b85924c5
+  data.tar.gz: 5f2d7cb7770b4e7d3414b468704db641929eafde9452c60a863ab7d542cb3ea9fc1e35f8d2cddb3f85ccf02eb8a1dd078503748822e2ba7db3b9383210788cfe

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - "2.3.0"
   - "2.4.0"
   - "2.5.0"
+  - "2.6.0-preview1"
 sudo: false
 cache: bundler
 script: bundle exec rake $TASK

data/CHANGELOG.md

@@ -2,15 +2,28 @@
 
 Notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
+Kubeclient release versioning follows [SemVer](https://semver.org/).
 
-## 3.0.0 - 2018-02-01
+## 3.1.0 - 2018-05-27
+
+### Fixed
+- Fixed watch `.finish` sometimes caused `HTTP::ConnectionError` exception from the reading loop (#315).
+
+### Added
+- `get_pod_log` now has `timestamps`, `since_time` (#319) and `tail_lines` (#326) params.
+- `Kubeclient::Config::Context#namespace` now set, if present in kubeconfig file (#308).
+- Improved README directions for authenticating within a kubernetes cluster (#316).
+- `Kubeclient::GoogleApplicationDefaultCredentials` helper for Google application default credentials (#213). Needs `googleauth` gem.
+- New `as: :parsed` and `as: :parsed_symbolized` formats (#306).
+- Allow setting default `as:` format for the whole client (#299, #305).
+- Relaxed `recursive-open-struct` dependency to allow 1.1+ as well (#313).
+
+## 3.0.0 - 2018-02-04
 ### Removed
 - Dropped entity classes (`Kubeclient::Pod` etc.), only `Kubeclient::Resource` exists now (#292, #288).
 - Ruby 2.0, 2.1 no longer supported (#253, #291).
 
 ### Fixed
-- Watch results are now `RecursiveOpenStruct` inside arrays too (#279).
-- Fixed watch `.finish` sometimes caused `Errno::EBADF` exception from the reading loop (#280).
 - Added missing singular `get_security_context_constraint`, fixed `get_security_context_constraints` to mean plural (#261).
 - Fixed `@http_proxy_uri` undefined warning (#261).
 - Documentation fixes & improvements (#225, #229, #243, #296).
@@ -28,6 +41,11 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - `update_*`, `delete_*`, `patch_*` now all return `RecursiveOpenStruct` consistently (#290).
 - Many dependencies bumped (#204, #231, #253, #269).
 
+## 2.5.2 - 2018-02-04
+- Watch results are now `RecursiveOpenStruct` inside arrays too (#279).
+- Fixed watch `.finish` sometimes caused `Errno::EBADF` exception from the reading loop (#280).
+- Easing dependency version (#287, #301)
+
 ## 2.5.1 - 2017-10-12
 No changes since 2.5.0, fixed packaging mistake.
 

data/README.md

@@ -134,23 +134,61 @@ client = Kubeclient::Client.new(
 )
 ```
 
-If you are running your app using kubeclient inside a Kubernetes cluster, then you can have a bearer token file
-mounted inside your pod by using a
-[Service Account](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/design/service_accounts.md). This
-will mount a bearer token [secret](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/design/secrets.md)
-a/ `/var/run/secrets/kubernetes.io/serviceaccount/token` (see [here](https://github.com/GoogleCloudPlatform/kubernetes/pull/7101)
-for more details). For example:
+#### Inside a Kubernetes cluster
+
+The [recommended way to locate the API server](https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod) within the pod is with the `kubernetes.default.svc` DNS name, which resolves to a Service IP which in turn will be routed to an API server.
+
+The recommended way to authenticate to the API server is with a [service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/). kube-system associates a pod with a service account and a bearer token for that service account is placed into the filesystem tree of each container in that pod at `/var/run/secrets/kubernetes.io/serviceaccount/token`.
+
+If available, a certificate bundle is placed into the filesystem tree of each container at `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt`, and should be used to verify the serving certificate of the API server.
+
+For example:
 
 ```ruby
 auth_options = {
   bearer_token_file: '/var/run/secrets/kubernetes.io/serviceaccount/token'
 }
+ssl_options = {}
+if File.exist?("/var/run/secrets/kubernetes.io/serviceaccount/ca.crt")
+  ssl_options[:ca_file] = "/var/run/secrets/kubernetes.io/serviceaccount/ca.crt"
+end
+client = Kubeclient::Client.new(
+  'https://kubernetes.default.svc',
+  'v1',
+  auth_options: auth_options,
+  ssl_options:  ssl_options
+)
+```
+
+Finally, the default namespace to be used for namespaced API operations is placed in a file at `/var/run/secrets/kubernetes.io/serviceaccount/namespace` in each container. It is recommended that you use this namespace when issuing API commands below.
+
+```ruby
+namespace = File.read('/var/run/secrets/kubernetes.io/serviceaccount/namespace')
+```
+You can find information about tokens in [this guide](https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod) and in [this reference](http://kubernetes.io/docs/admin/authentication/).
+
+#### Google's Application Default Credentials
+
+On Google Compute Engine, Google App Engine, or Google Cloud Functions, as well as `gcloud`-configured systems
+with [application default credentials](https://developers.google.com/identity/protocols/application-default-credentials), 
+you can use the token provider to authorize `kubeclient`.
+
+This requires the [`googleauth` gem](https://github.com/google/google-auth-library-ruby) that is _not_ included in 
+`kubeclient` dependencies so you should add it to your bundle.
+
+```ruby
+require 'googleauth'
+
+auth_options = {
+  bearer_token: Kubeclient::GoogleApplicationDefaultCredentials.token
+}
 client = Kubeclient::Client.new(
   'https://localhost:8443/api/', 'v1', auth_options: auth_options
 )
 ```
 
-You can find information about tokens in [this guide](http://kubernetes.io/docs/user-guide/accessing-the-cluster/) and in [this reference](http://kubernetes.io/docs/admin/authentication/).
+Note that this token is good for one hour. If your code runs for longer than that, you should plan to 
+acquire a new one.
 
 ### Non-blocking IO
 
@@ -249,6 +287,18 @@ You can also load your JSONified config in from an ENV variable (e.g. `KUBE_CONF
 Kubeclient::Config.new(JSON.parse(ENV['KUBE_CONFIG']), nil)
 ```
 
+#### namespace
+
+Additionally, the `config.context` object will contain a `namespace` attribute, if it was defined in the file.
+It is recommended that you use this namespace when issuing API commands below.
+This is the same behavior that is implemented by `kubectl` command.
+
+You can read it as follows:
+
+```ruby
+puts config.context.namespace
+```
+
 ### Supported kubernetes versions
 
 For 1.1 only the core api v1 is supported, all api groups are supported in later versions.
@@ -297,13 +347,26 @@ Note - Kubernetes doesn't work with the uid, but rather with the 'name' property
 Querying with uid causes 404.
 
 #### Getting raw responses
-By passing `as: :raw`, the response from the client is given as a string, which is the raw JSON body from openshift:
+
+To avoid overhead from parsing and building `RecursiveOpenStruct` objects for each reply, pass the `as: :raw` option when initializing `Kubeclient::Client` or when calling `get_` / `watch_` methods.
+The result can then be printed, or searched with a regex, or parsed via `JSON.parse(r)`.
+
+```ruby
+client = Kubeclient::Client.new(as: :raw)
+```
+
+or
 
 ```ruby
 pods = client.get_pods as: :raw
 node = client.get_node "127.0.0.1", as: :raw
 ```
 
+Other formats are:
+ - `:ros` (default) for `RecursiveOpenStruct`  
+ - `:parsed` for `JSON.parse` 
+ - `:parsed_symbolized` for `JSON.parse(..., symbolize_names: true)`
+
 #### Delete an entity (by name)
 
 For example: `delete_pod "pod name"` , `delete_replication_controller "rc name"`, `delete_node "node name"`, `delete_secret "secret name"`
@@ -402,8 +465,6 @@ It is possible to interrupt the watcher from another thread with:
 watcher.finish
 ```
 
-Pass `as: :raw` to `watch_*` get raw replies.
-
 #### Watch events for a particular object
 You can use the `field_selector` option as part of the watch methods.
 
@@ -453,6 +514,19 @@ client.get_pod_log('pod-name', 'default', previous: true)
 # => "..."
 ```
 
+Kubernetes can add timestamps to every log line or filter by lines time:
+```ruby
+client.get_pod_log('pod-name', 'default', timestamps: true, since_time: '2018-04-27T18:30:17.480321984Z')
+# => "..."
+```
+`since_time` can be a a `Time`, `DateTime` or `String` formatted according to RFC3339
+
+Kubernetes can fetch a specific number of lines from the end of the logs:
+```ruby
+client.get_pod_log('pod-name', 'default', tail_lines: 10)
+# => "..."
+```
+
 You can also watch the logs of a pod to get a stream of data:
 
 ```ruby
@@ -476,6 +550,7 @@ client.process_template template
 
 ## Upgrading
 
+Kubeclient release versioning follows [SemVer](https://semver.org/).
 See [CHANGELOG.md](CHANGELOG.md) for full changelog.
 
 #### past version 3.0

data/kubeclient.gemspec

@@ -27,7 +27,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '~> 3.0.1'
   spec.add_development_dependency 'vcr'
   spec.add_development_dependency 'rubocop', '= 0.49.1'
+  spec.add_development_dependency 'googleauth', '~> 0.5.1'
+
   spec.add_dependency 'rest-client', '~> 2.0'
-  spec.add_dependency 'recursive-open-struct', '~> 1.0.4'
+  spec.add_dependency 'recursive-open-struct', '~> 1.0', '>= 1.0.4'
   spec.add_dependency 'http', '~> 2.2.2'
 end

data/lib/kubeclient.rb

@@ -4,12 +4,12 @@ require 'rest-client'
 require 'kubeclient/common'
 require 'kubeclient/config'
 require 'kubeclient/entity_list'
+require 'kubeclient/google_application_default_credentials'
 require 'kubeclient/http_error'
 require 'kubeclient/missing_kind_compatibility'
 require 'kubeclient/resource'
 require 'kubeclient/resource_not_found_error'
 require 'kubeclient/version'
-require 'kubeclient/watch_notice'
 require 'kubeclient/watch_stream'
 
 module Kubeclient

data/lib/kubeclient/common.rb

@@ -1,5 +1,6 @@
 require 'json'
 require 'rest-client'
+
 module Kubeclient
   # Common methods
   # this is mixed in by other gems
@@ -56,7 +57,8 @@ module Kubeclient
       auth_options: DEFAULT_AUTH_OPTIONS,
       socket_options: DEFAULT_SOCKET_OPTIONS,
       timeouts: DEFAULT_TIMEOUTS,
-      http_proxy_uri: DEFAULT_HTTP_PROXY_URI
+      http_proxy_uri: DEFAULT_HTTP_PROXY_URI,
+      as: :ros
     )
       validate_auth_options(auth_options)
       handle_uri(uri, path)
@@ -72,6 +74,7 @@ module Kubeclient
       # @timeouts[:foo] == nil resulting in infinite timeout.
       @timeouts = DEFAULT_TIMEOUTS.merge(timeouts)
       @http_proxy_uri = http_proxy_uri ? http_proxy_uri.to_s : nil
+      @as = as
 
       if auth_options[:bearer_token]
         bearer_token(@auth_options[:bearer_token])
@@ -242,7 +245,11 @@ module Kubeclient
       WATCH_ARGUMENTS.each { |k, v| params[k] = options[v] if options[v] }
       uri.query = URI.encode_www_form(params) if params.any?
 
-      Kubeclient::Common::WatchStream.new(uri, http_options(uri), as: options[:as] || :ros)
+      Kubeclient::Common::WatchStream.new(
+        uri,
+        http_options(uri),
+        formatter: ->(value) { format_response(options[:as] || @as, value) }
+      )
     end
 
     # Accepts the following options:
@@ -261,19 +268,7 @@ module Kubeclient
         rest_client[ns_prefix + resource_name]
           .get({ 'params' => params }.merge(@headers))
       end
-      return response.body if options[:as] == :raw
-
-      result = JSON.parse(response)
-
-      resource_version =
-        result.fetch('resourceVersion') do
-          result.fetch('metadata', {}).fetch('resourceVersion', nil)
-        end
-
-      # result['items'] might be nil due to https://github.com/kubernetes/kubernetes/issues/13096
-      collection = result['items'].to_a.map { |item| Kubeclient::Resource.new(item) }
-
-      Kubeclient::Common::EntityList.new(entity_type, resource_version, collection)
+      format_response(options[:as] || @as, response.body, entity_type)
     end
 
     # Accepts the following options:
@@ -286,7 +281,7 @@ module Kubeclient
         rest_client[ns_prefix + resource_name + "/#{name}"]
           .get(@headers)
       end
-      format_response(options[:as], response)
+      format_response(options[:as] || @as, response.body)
     end
 
     # delete_options are passed as a JSON payload in the delete request
@@ -305,7 +300,7 @@ module Kubeclient
           )
         )
       end
-      format_response(:ros, response)
+      format_response(@as, response.body)
     end
 
     def create_entity(entity_type, resource_name, entity_config)
@@ -326,7 +321,7 @@ module Kubeclient
         rest_client[ns_prefix + resource_name]
           .post(hash.to_json, { 'Content-Type' => 'application/json' }.merge(@headers))
       end
-      format_response(:ros, response)
+      format_response(@as, response.body)
     end
 
     def update_entity(resource_name, entity_config)
@@ -336,7 +331,7 @@ module Kubeclient
         rest_client[ns_prefix + resource_name + "/#{name}"]
           .put(entity_config.to_h.to_json, { 'Content-Type' => 'application/json' }.merge(@headers))
       end
-      format_response(:ros, response)
+      format_response(@as, response.body)
     end
 
     def patch_entity(resource_name, name, patch, namespace = nil)
@@ -348,7 +343,7 @@ module Kubeclient
             { 'Content-Type' => 'application/strategic-merge-patch+json' }.merge(@headers)
           )
       end
-      format_response(:ros, response)
+      format_response(@as, response.body)
     end
 
     def all_entities(options = {})
@@ -365,10 +360,15 @@ module Kubeclient
       end
     end
 
-    def get_pod_log(pod_name, namespace, container: nil, previous: false)
+    def get_pod_log(pod_name, namespace,
+                    container: nil, previous: false,
+                    timestamps: false, since_time: nil, tail_lines: nil)
       params = {}
       params[:previous] = true if previous
       params[:container] = container if container
+      params[:timestamps] = timestamps if timestamps
+      params[:sinceTime] = format_datetime(since_time) if since_time
+      params[:tailLines] = tail_lines if tail_lines
 
       ns = build_namespace_prefix(namespace)
       handle_exception do
@@ -389,7 +389,7 @@ module Kubeclient
       uri.path += "/#{@api_version}/#{ns}pods/#{pod_name}/log"
       uri.query = URI.encode_www_form(params)
 
-      Kubeclient::Common::WatchStream.new(uri, http_options(uri), as: :raw)
+      Kubeclient::Common::WatchStream.new(uri, http_options(uri), formatter: ->(value) { value })
     end
 
     def proxy_url(kind, name, port, namespace = '')
@@ -432,11 +432,45 @@ module Kubeclient
 
     private
 
-    def format_response(as, response)
-      return response.body if as == :raw
+    # Format ditetime according to RFC3339
+    def format_datetime(value)
+      case value
+      when DateTime, Time
+        value.strftime('%FT%T.%9N%:z')
+      when String
+        value
+      else
+        raise ArgumentError, "unsupported type '#{value.class}' of time value '#{value}'"
+      end
+    end
+
+    def format_response(as, body, list_type = nil)
+      case as
+      when :raw
+        body
+      when :parsed
+        JSON.parse(body)
+      when :parsed_symbolized
+        JSON.parse(body, symbolize_names: true)
+      when :ros
+        result = JSON.parse(body)
+
+        if list_type
+          resource_version =
+            result.fetch('resourceVersion') do
+              result.fetch('metadata', {}).fetch('resourceVersion', nil)
+            end
+
+          # result['items'] might be nil due to https://github.com/kubernetes/kubernetes/issues/13096
+          collection = result['items'].to_a.map { |item| Kubeclient::Resource.new(item) }
 
-      result = JSON.parse(response)
-      Kubeclient::Resource.new(result)
+          Kubeclient::Common::EntityList.new(list_type, resource_version, collection)
+        else
+          Kubeclient::Resource.new(result)
+        end
+      else
+        raise ArgumentError, "Unsupported format #{as.inspect}"
+      end
     end
 
     def load_entities

data/lib/kubeclient/config.rb

@@ -7,13 +7,14 @@ module Kubeclient
   class Config
     # Kubernetes client configuration context class
     class Context
-      attr_reader :api_endpoint, :api_version, :ssl_options, :auth_options
+      attr_reader :api_endpoint, :api_version, :ssl_options, :auth_options, :namespace
 
-      def initialize(api_endpoint, api_version, ssl_options, auth_options)
+      def initialize(api_endpoint, api_version, ssl_options, auth_options, namespace)
         @api_endpoint = api_endpoint
         @api_version = api_version
         @ssl_options = ssl_options
         @auth_options = auth_options
+        @namespace = namespace
       end
     end
 
@@ -32,7 +33,7 @@ module Kubeclient
     end
 
     def context(context_name = nil)
-      cluster, user = fetch_context(context_name || @kcfg['current-context'])
+      cluster, user, namespace = fetch_context(context_name || @kcfg['current-context'])
 
       ca_cert_data     = fetch_cluster_ca_data(cluster)
       client_cert_data = fetch_user_cert_data(user)
@@ -58,7 +59,7 @@ module Kubeclient
         ssl_options[:client_key] = OpenSSL::PKey.read(client_key_data)
       end
 
-      Context.new(cluster['server'], @kcfg['apiVersion'], ssl_options, auth_options)
+      Context.new(cluster['server'], @kcfg['apiVersion'], ssl_options, auth_options, namespace)
     end
 
     private
@@ -84,7 +85,9 @@ module Kubeclient
         break x['user'] if x['name'] == context['user']
       end || {}
 
-      [cluster, user]
+      namespace = context['namespace']
+
+      [cluster, user, namespace]
     end
 
     def fetch_cluster_ca_data(cluster)

data/lib/kubeclient/google_application_default_credentials.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Kubeclient
+  # Get a bearer token from the Google's application default credentials.
+  class GoogleApplicationDefaultCredentials
+    class << self
+      def token
+        require 'googleauth'
+        scopes = ['https://www.googleapis.com/auth/cloud-platform']
+        authorization = Google::Auth.get_application_default(scopes)
+        authorization.apply({})
+        authorization.access_token
+      end
+    end
+  end
+end

data/lib/kubeclient/version.rb

@@ -1,4 +1,4 @@
 # Kubernetes REST-API Client
 module Kubeclient
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/lib/kubeclient/watch_stream.rb

@@ -4,11 +4,11 @@ module Kubeclient
   module Common
     # HTTP Stream used to watch changes on entities
     class WatchStream
-      def initialize(uri, http_options, as:)
+      def initialize(uri, http_options, formatter:)
         @uri = uri
         @http_client = nil
         @http_options = http_options
-        @as = as
+        @formatter = formatter
       end
 
       def each
@@ -24,16 +24,10 @@ module Kubeclient
         response.body.each do |chunk|
           buffer << chunk
           while (line = buffer.slice!(/.+\n/))
-            result =
-              case @as
-              when :ros then WatchNotice.new(JSON.parse(line))
-              when :raw then line.chomp
-              else raise NotImplementedError, "Unsupported as #{@as.inspect}"
-              end
-            yield(result)
+            yield @formatter.call(line.chomp)
           end
         end
-      rescue IOError, Errno::EBADF
+      rescue StandardError
         raise unless @finished
       end
 

data/test/test_common.rb

@@ -2,6 +2,14 @@ require_relative 'test_helper'
 
 # Unit tests for the common module
 class CommonTest < MiniTest::Test
+  class ClientStub
+    include Kubeclient::ClientMixin
+  end
+
+  def client
+    @client ||= ClientStub.new
+  end
+
   def test_underscore_entity
     %w[
       Pod pod
@@ -29,4 +37,22 @@ class CommonTest < MiniTest::Test
       assert_equal(Kubeclient::ClientMixin.underscore_entity(singular), plural)
     end
   end
+
+  def test_format_datetime_with_string
+    value = '2018-04-27T18:30:17.480321984Z'
+    formatted = client.send(:format_datetime, value)
+    assert_equal(formatted, value)
+  end
+
+  def test_format_datetime_with_datetime
+    value = DateTime.new(2018, 4, 30, 19, 20, 33)
+    formatted = client.send(:format_datetime, value)
+    assert_equal(formatted, '2018-04-30T19:20:33.000000000+00:00')
+  end
+
+  def test_format_datetime_with_time
+    value = Time.new(2018, 4, 30, 19, 20, 33, 0)
+    formatted = client.send(:format_datetime, value)
+    assert_equal(formatted, '2018-04-30T19:20:33.000000000+00:00')
+  end
 end

data/test/test_config.rb

@@ -44,6 +44,7 @@ class KubeclientConfigTest < MiniTest::Test
   def check_context(context, ssl: true)
     assert_equal('https://localhost:8443', context.api_endpoint)
     assert_equal('v1', context.api_version)
+    assert_equal('default', context.namespace)
     if ssl
       assert_equal(OpenSSL::SSL::VERIFY_PEER, context.ssl_options[:verify_ssl])
       assert_kind_of(OpenSSL::X509::Store, context.ssl_options[:cert_store])

data/test/test_google_application_default_credentials.rb

@@ -0,0 +1,15 @@
+require_relative 'test_helper'
+require 'googleauth'
+
+# Unit tests for the ApplicationDefaultCredentials token provider
+class GoogleApplicationDefaultCredentialsTest < MiniTest::Test
+  def test_token
+    auth = Minitest::Mock.new
+    auth.expect(:apply, nil, [{}])
+    auth.expect(:access_token, 'valid_token')
+
+    Google::Auth.stub(:get_application_default, auth) do
+      assert_equal('valid_token', Kubeclient::GoogleApplicationDefaultCredentials.token)
+    end
+  end
+end

data/test/test_kubeclient.rb

@@ -43,8 +43,7 @@ class KubeclientTest < MiniTest::Test
   def test_pass_proxy
     uri = URI::HTTP.build(host: 'localhost', port: 8080)
     proxy_uri = URI::HTTP.build(host: 'myproxyhost', port: 8888)
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
 
     client = Kubeclient::Client.new(uri, http_proxy_uri: proxy_uri)
     rest_client = client.rest_client
@@ -56,8 +55,7 @@ class KubeclientTest < MiniTest::Test
   end
 
   def test_exception
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
     stub_request(:post, %r{/services})
       .to_return(body: open_test_file('namespace_exception.json'), status: 409)
 
@@ -99,7 +97,6 @@ class KubeclientTest < MiniTest::Test
     stub_request(:get, 'http://localhost:8080/api')
       .to_return(status: 200, body: open_test_file('versions_list.json'))
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
     response = client.api
     assert_includes(response, 'versions')
   end
@@ -178,13 +175,10 @@ class KubeclientTest < MiniTest::Test
   end
 
   def test_nonjson_exception
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
     stub_request(:get, %r{/servic})
       .to_return(body: open_test_file('service_illegal_json_404.json'), status: 404)
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
-
     exception = assert_raises(Kubeclient::ResourceNotFoundError) do
       client.get_services
     end
@@ -194,13 +188,10 @@ class KubeclientTest < MiniTest::Test
   end
 
   def test_nonjson_exception_raw
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
     stub_request(:get, %r{/servic})
       .to_return(body: open_test_file('service_illegal_json_404.json'), status: 404)
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
-
     exception = assert_raises(Kubeclient::ResourceNotFoundError) do
       client.get_services(as: :raw)
     end
@@ -210,12 +201,9 @@ class KubeclientTest < MiniTest::Test
   end
 
   def test_entity_list
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
-    stub_request(:get, %r{/services})
-      .to_return(body: open_test_file('entity_list.json'), status: 200)
+    stub_core_api_list
+    stub_get_services
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
     services = client.get_services
 
     refute_empty(services)
@@ -229,12 +217,9 @@ class KubeclientTest < MiniTest::Test
   end
 
   def test_entity_list_raw
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
-    stub_request(:get, %r{/services})
-      .to_return(body: open_test_file('entity_list.json'), status: 200)
+    stub_core_api_list
+    stub_get_services
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
     response = client.get_services(as: :raw)
 
     refute_empty(response)
@@ -243,14 +228,37 @@ class KubeclientTest < MiniTest::Test
     assert_requested(:get, 'http://localhost:8080/api/v1/services', times: 1)
   end
 
+  def test_entity_list_parsed
+    stub_core_api_list
+    stub_get_services
+
+    response = client.get_services(as: :parsed)
+    assert_equal Hash, response.class
+    assert_equal %w[metadata spec status], response['items'].first.keys
+  end
+
+  def test_entity_list_parsed_symbolized
+    stub_core_api_list
+    stub_get_services
+
+    response = client.get_services(as: :parsed_symbolized)
+    assert_equal Hash, response.class
+    assert_equal %i[metadata spec status], response[:items].first.keys
+  end
+
+  def test_entity_list_unknown
+    stub_core_api_list
+    stub_get_services
+
+    e = assert_raises(ArgumentError) { client.get_services(as: :whoops) }
+    assert_equal 'Unsupported format :whoops', e.message
+  end
+
   def test_entity_list_raw_failure
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
     stub_request(:get, %r{/services})
       .to_return(body: open_test_file('entity_list.json'), status: 500)
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
-
     exception = assert_raises(Kubeclient::HttpError) { client.get_services(as: :raw) }
     assert_equal('500 Internal Server Error', exception.message)
     assert_equal(500, exception.error_code)
@@ -259,12 +267,9 @@ class KubeclientTest < MiniTest::Test
   def test_entities_with_label_selector
     selector = 'component=apiserver'
 
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
-    stub_request(:get, %r{/services})
-      .to_return(body: open_test_file('entity_list.json'), status: 200)
+    stub_core_api_list
+    stub_get_services
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
     services = client.get_services(label_selector: selector)
 
     assert_instance_of(Kubeclient::Common::EntityList, services)
@@ -278,12 +283,9 @@ class KubeclientTest < MiniTest::Test
   def test_entities_with_field_selector
     selector = 'involvedObject.name=redis-master'
 
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
-    stub_request(:get, %r{/services})
-      .to_return(body: open_test_file('entity_list.json'), status: 200)
+    stub_core_api_list
+    stub_get_services
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
     services = client.get_services(field_selector: selector)
 
     assert_instance_of(Kubeclient::Common::EntityList, services)
@@ -295,20 +297,17 @@ class KubeclientTest < MiniTest::Test
   end
 
   def test_empty_list
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
     stub_request(:get, %r{/pods})
       .to_return(body: open_test_file('empty_pod_list.json'), status: 200)
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
     pods = client.get_pods
     assert_instance_of(Kubeclient::Common::EntityList, pods)
     assert_equal(0, pods.size)
   end
 
   def test_get_all
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
 
     stub_request(:get, %r{/bindings})
       .to_return(body: open_test_file('bindings_list.json'), status: 404)
@@ -361,7 +360,6 @@ class KubeclientTest < MiniTest::Test
     stub_request(:get, %r{/serviceaccounts})
       .to_return(body: open_test_file('service_account_list.json'), status: 200)
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
     result = client.all_entities
     assert_equal(16, result.keys.size)
     assert_instance_of(Kubeclient::Common::EntityList, result['node'])
@@ -386,8 +384,7 @@ class KubeclientTest < MiniTest::Test
   end
 
   def test_get_all_raw
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
 
     stub_request(:get, %r{/bindings})
       .to_return(body: open_test_file('bindings_list.json'), status: 404)
@@ -440,7 +437,6 @@ class KubeclientTest < MiniTest::Test
     stub_request(:get, %r{/serviceaccounts})
       .to_return(body: open_test_file('service_account_list.json'), status: 200)
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
     result = client.all_entities(as: :raw)
     assert_equal(16, result.keys.size)
 
@@ -655,13 +651,13 @@ class KubeclientTest < MiniTest::Test
     assert_equal(expected_msg, exception.message)
   end
 
-  def test_init_user_and_bearer_token
+  def test_init_username_and_bearer_token_file
     expected_msg = 'Invalid auth options: specify only one of username/password,' \
       ' bearer_token or bearer_token_file'
     exception = assert_raises(ArgumentError) do
       Kubeclient::Client.new(
         'http://localhost:8080',
-        auth_options: { username: 'username', bearer_token: 'token' }
+        auth_options: { username: 'username', bearer_token_file: 'token-file' }
       )
     end
     assert_equal(expected_msg, exception.message)
@@ -692,8 +688,7 @@ class KubeclientTest < MiniTest::Test
   end
 
   def test_api_bearer_token_file_success
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
     stub_request(:get, 'http://localhost:8080/api/v1/pods')
       .with(headers: { Authorization: 'Bearer valid_token' })
       .to_return(body: open_test_file('pod_list.json'), status: 200)
@@ -711,8 +706,7 @@ class KubeclientTest < MiniTest::Test
   end
 
   def test_proxy_url
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
 
     client = Kubeclient::Client.new('http://host:8080', 'v1')
     assert_equal(
@@ -772,12 +766,10 @@ class KubeclientTest < MiniTest::Test
 
   def test_nil_items
     # handle https://github.com/kubernetes/kubernetes/issues/13096
-    stub_request(:get, %r{/api/v1$})
-      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+    stub_core_api_list
     stub_request(:get, %r{/persistentvolumeclaims})
       .to_return(body: open_test_file('persistent_volume_claims_nil_items.json'), status: 200)
 
-    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
     client.get_persistent_volume_claims
   end
 
@@ -842,6 +834,20 @@ class KubeclientTest < MiniTest::Test
 
   private
 
+  def stub_get_services
+    stub_request(:get, %r{/services})
+      .to_return(body: open_test_file('entity_list.json'), status: 200)
+  end
+
+  def stub_core_api_list
+    stub_request(:get, %r{/api/v1$})
+      .to_return(body: open_test_file('core_api_resource_list.json'), status: 200)
+  end
+
+  def client
+    @client ||= Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
+  end
+
   # dup method creates a shallow copy which is not good in this case
   # since rename_keys changes the input hash
   # hence need to create a deep_copy

data/test/test_pod_log.rb

@@ -32,6 +32,43 @@ class TestPodLog < MiniTest::Test
                      times: 1)
   end
 
+  def test_get_pod_log_since_time
+    stub_request(:get, %r{/namespaces/default/pods/[a-z0-9-]+/log})
+      .to_return(body: open_test_file('pod_log.txt'),
+                 status: 200)
+
+    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
+    retrieved_log = client.get_pod_log('redis-master-pod',
+                                       'default',
+                                       timestamps: true,
+                                       since_time: '2018-04-27T18:30:17.480321984Z')
+
+    assert_equal(open_test_file('pod_log.txt').read, retrieved_log)
+
+    assert_requested(:get,
+                     'http://localhost:8080/api/v1/namespaces/default/pods/redis-master-pod/log?sinceTime=2018-04-27T18:30:17.480321984Z&timestamps=true',
+                     times: 1)
+  end
+
+  def test_get_pod_log_tail_lines
+    selected_lines = open_test_file('pod_log.txt').to_a[-2..1].join
+
+    stub_request(:get, %r{/namespaces/default/pods/[a-z0-9-]+/log})
+      .to_return(body: selected_lines,
+                 status: 200)
+
+    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
+    retrieved_log = client.get_pod_log('redis-master-pod',
+                                       'default',
+                                       tail_lines: 2)
+
+    assert_equal(selected_lines, retrieved_log)
+
+    assert_requested(:get,
+                     'http://localhost:8080/api/v1/namespaces/default/pods/redis-master-pod/log?tailLines=2',
+                     times: 1)
+  end
+
   def test_watch_pod_log
     expected_lines = open_test_file('pod_log.txt').read.split("\n")
 

data/test/test_watch.rb

@@ -18,7 +18,7 @@ class TestWatch < MiniTest::Test
     client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
 
     client.watch_pods.to_enum.with_index do |notice, index|
-      assert_instance_of(Kubeclient::Common::WatchNotice, notice)
+      assert_instance_of(Kubeclient::Resource, notice)
       assert_equal(expected[index]['type'], notice.type)
       assert_equal('Pod', notice.object.kind)
       assert_equal('php', notice.object.metadata.name)
@@ -62,24 +62,13 @@ class TestWatch < MiniTest::Test
       .to_return(body: open_test_file('pod_log.txt'),
                  status: 200)
 
-    stream = Kubeclient::Common::WatchStream.new(URI.parse(url), {}, as: :raw)
+    stream = Kubeclient::Common::WatchStream.new(URI.parse(url), {}, formatter: ->(v) { v })
     stream.to_enum.with_index do |line, index|
       assert_instance_of(String, line)
       assert_equal(expected_lines[index], line)
     end
   end
 
-  # Ensure that WatchStream respects a format that's not JSON
-  def test_watch_stream_unknown
-    url = 'http://www.example.com/foobar'
-    stub_request(:get, url)
-      .to_return(body: open_test_file('pod_log.txt'),
-                 status: 200)
-
-    stream = Kubeclient::Common::WatchStream.new(URI.parse(url), {}, as: :foo)
-    assert_raises(NotImplementedError) { stream.each {} }
-  end
-
   def test_watch_with_resource_version
     api_host = 'http://localhost:8080/api'
     version = '1995'
@@ -143,10 +132,10 @@ class TestWatch < MiniTest::Test
     client = Kubeclient::Client.new(api_host, 'v1')
     watcher = client.watch_events
 
-    # explodes when Errno::EBADF is not caught
+    # explodes when StandardError is not caught
     watcher.each do
       watcher.finish
-      raise Errno::EBADF
+      raise StandardError
     end
 
     assert_requested(:get, "#{api_host}/v1/watch/events", times: 1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubeclient
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Alissa Bonas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-04 00:00:00.000000000 Z
+date: 2018-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.49.1
+- !ruby/object:Gem::Dependency
+  name: googleauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -127,6 +141,9 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.4
   type: :runtime
@@ -134,6 +151,9 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.4
 - !ruby/object:Gem::Dependency
@@ -170,12 +190,12 @@ files:
 - lib/kubeclient/common.rb
 - lib/kubeclient/config.rb
 - lib/kubeclient/entity_list.rb
+- lib/kubeclient/google_application_default_credentials.rb
 - lib/kubeclient/http_error.rb
 - lib/kubeclient/missing_kind_compatibility.rb
 - lib/kubeclient/resource.rb
 - lib/kubeclient/resource_not_found_error.rb
 - lib/kubeclient/version.rb
-- lib/kubeclient/watch_notice.rb
 - lib/kubeclient/watch_stream.rb
 - test/cassettes/kubernetes_guestbook.yml
 - test/config/allinone.kubeconfig
@@ -235,6 +255,7 @@ files:
 - test/test_component_status.rb
 - test/test_config.rb
 - test/test_endpoint.rb
+- test/test_google_application_default_credentials.rb
 - test/test_guestbook_go.rb
 - test/test_helper.rb
 - test/test_kubeclient.rb
@@ -254,7 +275,6 @@ files:
 - test/test_service.rb
 - test/test_service_account.rb
 - test/test_watch.rb
-- test/test_watch_notice.rb
 - test/txt/pod_log.txt
 - test/valid_token_file
 homepage: https://github.com/abonas/kubeclient
@@ -277,7 +297,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: A client for Kubernetes REST api
@@ -340,6 +360,7 @@ test_files:
 - test/test_component_status.rb
 - test/test_config.rb
 - test/test_endpoint.rb
+- test/test_google_application_default_credentials.rb
 - test/test_guestbook_go.rb
 - test/test_helper.rb
 - test/test_kubeclient.rb
@@ -359,6 +380,5 @@ test_files:
 - test/test_service.rb
 - test/test_service_account.rb
 - test/test_watch.rb
-- test/test_watch_notice.rb
 - test/txt/pod_log.txt
 - test/valid_token_file

data/lib/kubeclient/watch_notice.rb

@@ -1,12 +0,0 @@
-require 'recursive_open_struct'
-module Kubeclient
-  module Common
-    # Represents an individual notice received from a Kubernetes watch
-    class WatchNotice < RecursiveOpenStruct
-      def initialize(hash = nil, args = {})
-        args[:recurse_over_arrays] = true
-        super(hash, args)
-      end
-    end
-  end
-end

data/test/test_watch_notice.rb

@@ -1,37 +0,0 @@
-require_relative 'test_helper'
-
-class TestWatchNotice < MiniTest::Test
-  #
-  # Checks that elements of arrays are converted to instances of `RecursiveOpenStruct`, and that the
-  # items can be accessed using the dot notation.
-  #
-  def test_recurse_over_arrays
-    json = JSON.parse(open_test_file('node_notice.json').read)
-    notice = Kubeclient::Common::WatchNotice.new(json)
-    assert_kind_of(Array, notice.object.status.addresses)
-    notice.object.status.addresses.each do |address|
-      assert_kind_of(RecursiveOpenStruct, address)
-    end
-    assert_equal('InternalIP', notice.object.status.addresses[0].type)
-    assert_equal('192.168.122.40', notice.object.status.addresses[0].address)
-    assert_equal('Hostname', notice.object.status.addresses[1].type)
-    assert_equal('openshift.local', notice.object.status.addresses[1].address)
-  end
-
-  #
-  # Checks that even when arrays are converted to instances of `RecursiveOpenStruct` the items can
-  # be accessed using the hash notation.
-  #
-  def test_access_array_items_as_hash
-    json = JSON.parse(open_test_file('node_notice.json').read)
-    notice = Kubeclient::Common::WatchNotice.new(json)
-    assert_kind_of(Array, notice.object.status.addresses)
-    notice.object.status.addresses.each do |address|
-      assert_kind_of(RecursiveOpenStruct, address)
-    end
-    assert_equal('InternalIP', notice.object.status.addresses[0]['type'])
-    assert_equal('192.168.122.40', notice.object.status.addresses[0]['address'])
-    assert_equal('Hostname', notice.object.status.addresses[1]['type'])
-    assert_equal('openshift.local', notice.object.status.addresses[1]['address'])
-  end
-end