kubeclient 4.2.1 → 4.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 899369e46efd1bf4032090102865ed5cdac2a345e16ee61ac1aef5f4155edec4
-  data.tar.gz: 00a58a06ec28e4c61483f728df95bdf7c687aa0a3ed82814461121d74a196633
+  metadata.gz: 9e11771dcb8f222f6c3a3bb4fb1c8b3db8cc745a9d2dbe8b2ff3edfe02382f3d
+  data.tar.gz: a5edd9efc28428fd2e5d232a1bdce0a1f5d0bd56fad06cff4d10e82e03bdc3f6
 SHA512:
-  metadata.gz: d8483af344834c6dd7b8040776fb1ef6a31688c5520a414eef5c47719f541c47db96402b0da6fd5a7b675e2d76d166ee90acfdc0ba36f8c6dd4c3363cf8fb216
-  data.tar.gz: f59b9016c41784d2bc5c6e23d294b4f6dfa00907d535bda173ac6d9b3d07ab106e6811b1a22741b7a40ff1cef3972f471cc0bdb9034846313e6b8959ac2731e3
+  metadata.gz: 17cdfd31bf3df9292a2edf052071e99b30e62ee6ebfd05bce7b710623cc7c0ae57acb1c469787cee49bd472dc1661d687908acbb364cc8d36723f7ee4b07d273
+  data.tar.gz: f739a8fc768a688853e2f6e55232087bdfbdc31b26a86ca6ffe6ecc87996b72906a2d60d674c5aae3d5023d578b5cc9d20611a349f1cfc0d2ee1d2511e4f4c7c

data/.gitignore

@@ -13,3 +13,4 @@
 *.a
 mkmf.log
 *.idea*
+/Gemfile.dev.rb

data/.rubocop.yml

@@ -19,9 +19,11 @@ Metrics/ModuleLength:
 Style/MethodCallWithArgsParentheses:
   Enabled: true
   IgnoredMethods: [require, raise, include, attr_reader, refute, assert]
-  Exclude: [Gemfile, Rakefile, kubeclient.gemspec]
+  Exclude: [Gemfile, Rakefile, kubeclient.gemspec, Gemfile.dev.rb]
 Security/MarshalLoad:
   Exclude: [test/**/*]
+Style/FileName:
+  Exclude: [Gemfile, Rakefile, Gemfile.dev.rb]
 Style/MethodCallWithArgsParentheses:
   IgnoredMethods:
   - require_relative

data/CHANGELOG.md

@@ -4,6 +4,14 @@ 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/).
 
+## 4.2.2 — 2019-01-09
+
+### Added
+- New `http_max_redirects` option (#374).
+
+### Changed
+- Default max redirects for watch increased from 4 to 10, to match other verbs (#374).
+
 ## 4.2.1 — 2018-12-26
 
 ### Fixed

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
+dev_gemfile = File.expand_path('Gemfile.dev.rb', __dir__)
+eval_gemfile(dev_gemfile) if File.exist?(dev_gemfile)
+
 # Specify your gem's dependencies in kubeclient.gemspec
 gemspec

data/README.md

@@ -218,6 +218,15 @@ client = Kubeclient::Client.new(
 )
 ```
 
+### Redirects
+
+You can optionally not allow redirection with kubeclient. For example:
+
+```ruby
+client = Kubeclient::Client.new(
+  'https://localhost:8443/api/', http_max_redirects: 0
+)
+```
 
 ### Timeouts
 

data/lib/kubeclient/common.rb

@@ -34,6 +34,7 @@ module Kubeclient
     }.freeze
 
     DEFAULT_HTTP_PROXY_URI = nil
+    DEFAULT_HTTP_MAX_REDIRECTS = 10
 
     SEARCH_ARGUMENTS = {
       'labelSelector' => :label_selector,
@@ -52,6 +53,7 @@ module Kubeclient
     attr_reader :ssl_options
     attr_reader :auth_options
     attr_reader :http_proxy_uri
+    attr_reader :http_max_redirects
     attr_reader :headers
     attr_reader :discovered
 
@@ -64,6 +66,7 @@ module Kubeclient
       socket_options: DEFAULT_SOCKET_OPTIONS,
       timeouts: DEFAULT_TIMEOUTS,
       http_proxy_uri: DEFAULT_HTTP_PROXY_URI,
+      http_max_redirects: DEFAULT_HTTP_MAX_REDIRECTS,
       as: :ros
     )
       validate_auth_options(auth_options)
@@ -80,6 +83,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
+      @http_max_redirects = http_max_redirects
       @as = as
 
       if auth_options[:bearer_token]
@@ -253,6 +257,7 @@ module Kubeclient
         ssl_client_cert: @ssl_options[:client_cert],
         ssl_client_key: @ssl_options[:client_key],
         proxy: @http_proxy_uri,
+        max_redirects: @http_max_redirects,
         user: @auth_options[:username],
         password: @auth_options[:password],
         open_timeout: @timeouts[:open],
@@ -573,7 +578,8 @@ module Kubeclient
         basic_auth_user: @auth_options[:username],
         basic_auth_password: @auth_options[:password],
         headers: @headers,
-        http_proxy_uri: @http_proxy_uri
+        http_proxy_uri: @http_proxy_uri,
+        http_max_redirects: http_max_redirects
       }
 
       if uri.scheme == 'https'

data/lib/kubeclient/version.rb

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

data/lib/kubeclient/watch_stream.rb

@@ -8,6 +8,7 @@ module Kubeclient
         @uri = uri
         @http_client = nil
         @http_options = http_options
+        @http_options[:http_max_redirects] ||= Kubeclient::Client::DEFAULT_HTTP_MAX_REDIRECTS
         @formatter = formatter
       end
 
@@ -38,15 +39,31 @@ module Kubeclient
 
       private
 
+      def max_hops
+        @http_options[:http_max_redirects] + 1
+      end
+
+      def follow_option
+        if max_hops > 1
+          { max_hops: max_hops }
+        else
+          # i.e. Do not follow redirects as we have set http_max_redirects to 0
+          # Setting `{ max_hops: 1 }` does not work FWIW
+          false
+        end
+      end
+
       def build_client
+        client = HTTP::Client.new(follow: follow_option)
+
         if @http_options[:basic_auth_user] && @http_options[:basic_auth_password]
-          HTTP.basic_auth(
+          client = client.basic_auth(
             user: @http_options[:basic_auth_user],
             pass: @http_options[:basic_auth_password]
           )
-        else
-          HTTP::Client.new
         end
+
+        client
       end
 
       def using_proxy

data/test/test_kubeclient.rb

@@ -54,6 +54,19 @@ class KubeclientTest < MiniTest::Test
     assert_equal(watch_client.send(:build_client_options)[:proxy][:proxy_port], proxy_uri.port)
   end
 
+  def test_pass_max_redirects
+    max_redirects = 0
+    client = Kubeclient::Client.new('http://localhost:8080/api/', http_max_redirects: max_redirects)
+    rest_client = client.rest_client
+    assert_equal(max_redirects, rest_client.options[:max_redirects])
+
+    stub_request(:get, 'http://localhost:8080/api')
+      .to_return(status: 302, headers: { location: 'http://localhost:1234/api' })
+
+    exception = assert_raises(Kubeclient::HttpError) { client.api }
+    assert_equal(302, exception.error_code)
+  end
+
   def test_exception
     stub_core_api_list
     stub_request(:post, %r{/services})

data/test/test_pod_log.rb

@@ -84,4 +84,40 @@ class TestPodLog < MiniTest::Test
       assert_equal(expected_lines[index], notice)
     end
   end
+
+  def test_watch_pod_log_follow_redirect
+    expected_lines = open_test_file('pod_log.txt').read.split("\n")
+    redirect = 'http://localhost:1234/api/namespaces/default/pods/redis-master-pod/log'
+
+    stub_request(:get, %r{/namespaces/default/pods/[a-z0-9-]+/log\?.*follow})
+      .to_return(status: 302, headers: { location: redirect })
+
+    stub_request(:get, redirect)
+      .to_return(body: open_test_file('pod_log.txt'),
+                 status: 200)
+
+    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
+    stream = client.watch_pod_log('redis-master-pod', 'default')
+    stream.to_enum.with_index do |notice, index|
+      assert_instance_of(String, notice)
+      assert_equal(expected_lines[index], notice)
+    end
+  end
+
+  def test_watch_pod_log_max_redirect
+    redirect = 'http://localhost:1234/api/namespaces/default/pods/redis-master-pod/log'
+
+    stub_request(:get, %r{/namespaces/default/pods/[a-z0-9-]+/log\?.*follow})
+      .to_return(status: 302, headers: { location: redirect })
+
+    stub_request(:get, redirect)
+      .to_return(body: open_test_file('pod_log.txt'),
+                 status: 200)
+
+    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1', http_max_redirects: 0)
+    assert_raises(Kubeclient::HttpError) do
+      client.watch_pod_log('redis-master-pod', 'default').each do
+      end
+    end
+  end
 end

data/test/test_watch.rb

@@ -53,6 +53,45 @@ class TestWatch < MiniTest::Test
     end
   end
 
+  def test_watch_pod_follow_redirect
+    stub_core_api_list
+
+    redirect = 'http://localhost:1234/api/v1/watch/pods'
+    stub_request(:get, %r{/watch/pods})
+      .to_return(status: 302, headers: { location: redirect })
+
+    stub_request(:get, redirect).to_return(
+      body: open_test_file('watch_stream.json'),
+      status: 200
+    )
+
+    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1')
+
+    got = nil
+    client.watch_pods.each { |notice| got = notice }
+    assert_equal('DELETED', got.type)
+  end
+
+  def test_watch_pod_max_redirect
+    stub_core_api_list
+
+    redirect = 'http://localhost:1234/api/v1/watcher/pods'
+    stub_request(:get, %r{/watch/pods})
+      .to_return(status: 302, headers: { location: redirect })
+
+    stub_request(:get, redirect).to_return(
+      body: open_test_file('watch_stream.json'),
+      status: 200
+    )
+
+    client = Kubeclient::Client.new('http://localhost:8080/api/', 'v1', http_max_redirects: 0)
+
+    assert_raises(Kubeclient::HttpError) do
+      client.watch_pods.each do
+      end
+    end
+  end
+
   # Ensure that WatchStream respects a format that's not JSON
   def test_watch_stream_text
     url = 'http://www.example.com/foobar'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kubeclient
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 4.2.2
 platform: ruby
 authors:
 - Alissa Bonas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-26 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler