Merge pull request #319 from holyketzer/extend-pod-logs

Add timestamps and since_time to get_pod_log

Author: cben

README.md

@@ -514,6 +514,13 @@ 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
+
 You can also watch the logs of a pod to get a stream of data:
 
 ```ruby

lib/kubeclient/common.rb

@@ -360,10 +360,13 @@ def all_entities(options = {})
       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)
       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
 
       ns = build_namespace_prefix(namespace)
       handle_exception do
@@ -427,6 +430,18 @@ def api
 
     private
 
+    # 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

test/test_common.rb

@@ -2,6 +2,14 @@
 
 # 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 @@ def test_underscore_entity
       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

test/test_pod_log.rb

@@ -32,6 +32,24 @@ def test_get_pod_log_container
                      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_watch_pod_log
     expected_lines = open_test_file('pod_log.txt').read.split("\n")