Add since_seconds filter when reading pod logs (#136)

* Add since_seconds filter when reading pod logs * Generate docs * Update testcase and changelog file * Add prerelease tag to testtecases --------- Co-authored-by: Ryfczynska Sara <[email protected]> Co-authored-by: DevOps Spiral <[email protected]>
devopsspiral · Nov 19, 2023 · 63c7f80 · 63c7f80
1 parent 9306257
commit 63c7f80
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 44 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## In progress
+- update read_namespaced_pod_log keyword with new optional parameter 'since_seconds'
+
 ## [0.8.6] - 2022-05-27
 ### Added
 - add new keyword to list all namespaced custom objects [#133] (https://github.com/devopsspiral/KubeLibrary/pull/133) by [@kutayy]

diff --git a/docs/index.html b/docs/index.html
diff --git a/src/KubeLibrary/KubeLibrary.py b/src/KubeLibrary/KubeLibrary.py
@@ -69,6 +69,7 @@ class KubeLibrary:
     | Library           KubeLibrary          None    True
 
     """
+
     def __init__(self, kube_config=None, context=None, api_url=None, bearer_token=None,
                  ca_cert=None, incluster=False, cert_validation=True):
         """KubeLibrary can be configured with several optional arguments.
@@ -98,7 +99,8 @@ def __init__(self, kube_config=None, context=None, api_url=None, bearer_token=No
 
     @staticmethod
     def get_proxy():
-        return environ.get('https_proxy') or environ.get('HTTPS_PROXY') or environ.get('http_proxy') or environ.get('HTTP_PROXY')
+        return environ.get('https_proxy') or environ.get('HTTPS_PROXY') or environ.get('http_proxy') or environ.get(
+            'HTTP_PROXY')
 
     @staticmethod
     def get_no_proxy():
@@ -221,7 +223,8 @@ def replace(self, api_version, kind, **kwargs):
         resource = self.get_dynamic_resource(api_version, kind)
         resource.replace(**kwargs)
 
-    def reload_config(self, kube_config=None, context=None, api_url=None, bearer_token=None, ca_cert=None, incluster=False, cert_validation=True):
+    def reload_config(self, kube_config=None, context=None, api_url=None, bearer_token=None, ca_cert=None,
+                      incluster=False, cert_validation=True):
         """Reload the KubeLibrary to be configured with different optional arguments.
            This can be used to connect to a different cluster during the same test.
         - ``kube_config``:
@@ -394,9 +397,11 @@ def get_pods_in_namespace(self, name_pattern, namespace, label_selector=""):
         pods = [item for item in ret.items if r.match(item.metadata.name)]
         return pods
 
-    def read_namespaced_pod_log(self, name, namespace, container):
+    def read_namespaced_pod_log(self, name, namespace, container, since_seconds=None):
         """Gets container logs of given pod in given namespace.
 
+        Can be optionally filtered by time in seconds. e.g. since_seconds=1000.
+
         Returns logs.
 
         - ``name``:
@@ -406,7 +411,8 @@ def read_namespaced_pod_log(self, name, namespace, container):
         - ``container``:
           Container to check
         """
-        pod_logs = self.v1.read_namespaced_pod_log(name=name, namespace=namespace, container=container, follow=False)
+        pod_logs = self.v1.read_namespaced_pod_log(name=name, namespace=namespace, container=container, follow=False,
+                                                   since_seconds=since_seconds)
         return pod_logs
 
     def get_pod_logs(self, name, namespace, container):
@@ -873,7 +879,8 @@ def assert_pod_has_annotations(pod, annotations_json):
             for k, v in annotations.items():
                 if pod.metadata.annotations and k in pod.metadata.annotations:
                     if pod.metadata.annotations[k] != v:
-                        logger.error(f'Annotation "{k}" value "{v}" not matching actual "{pod.metadata.annotations[k]}"')
+                        logger.error(
+                            f'Annotation "{k}" value "{v}" not matching actual "{pod.metadata.annotations[k]}"')
                         return False
                 else:
                     logger.error(f'Annotation "{k}" not found in actual')
@@ -983,7 +990,8 @@ def list_namespaced_horizontal_pod_autoscaler(self, namespace, label_selector=""
         - ``namespace``:
           Namespace to check
         """
-        ret = self.autoscalingv1.list_namespaced_horizontal_pod_autoscaler(namespace, watch=False, label_selector=label_selector)
+        ret = self.autoscalingv1.list_namespaced_horizontal_pod_autoscaler(namespace, watch=False,
+                                                                           label_selector=label_selector)
         return [item for item in ret.items]
 
     def get_hpas_in_namespace(self, namespace, label_selector=""):
@@ -998,7 +1006,8 @@ def get_hpas_in_namespace(self, namespace, label_selector=""):
         - ``namespace``:
           Namespace to check
         """
-        ret = self.autoscalingv1.list_namespaced_horizontal_pod_autoscaler(namespace, watch=False, label_selector=label_selector)
+        ret = self.autoscalingv1.list_namespaced_horizontal_pod_autoscaler(namespace, watch=False,
+                                                                           label_selector=label_selector)
         return [item.metadata.name for item in ret.items]
 
     def read_namespaced_horizontal_pod_autoscaler(self, name, namespace):

diff --git a/test/test_KubeLibrary.py b/test/test_KubeLibrary.py
@@ -19,6 +19,7 @@ class AttributeDict(object):
     allowing you to recurse down nested dicts (like: AttributeDict.attr.attr)
     """
     def __init__(self, entries):
+        self._root = None
         self.add_entries(entries)
 
     def add_entries(self, entries):

diff --git a/testcases/pod/pod.robot b/testcases/pod/pod.robot
@@ -2,18 +2,19 @@
 Resource          ./pod_kw.robot
 
 *** Variables ***
-${KLIB_POD_PATTERN}         %{KLIB_POD_PATTERN}
-${KLIB_POD_NAMESPACE}         %{KLIB_POD_NAMESPACE}
-${KLIB_POD_REPLICAS}         %{KLIB_POD_REPLICAS=1}
-${KLIB_POD_TIMEOUT}         %{KLIB_POD_TIMEOUT=2min}
-${KLIB_POD_RETRY_INTERVAL}  %{KLIB_POD_RETRY_INTERVAL=5sec}
-${KLIB_POD_LABELS}          %{KLIB_POD_LABELS='Labels missing!'}
-${KLIB_POD_ANNOTATIONS}     %{KLIB_POD_ANNOTATIONS='Annotations missing!'}
-${KLIB_RESOURCE_REQUESTS_CPU}     %{KLIB_RESOURCE_REQUESTS_CPU='Resource requests missing!'}
-${KLIB_RESOURCE_REQUESTS_MEMORY}     %{KLIB_RESOURCE_REQUESTS_MEMORY='Resource requests missing!'}
-${KLIB_RESOURCE_LIMITS_CPU}     %{KLIB_RESOURCE_LIMITS_CPU='Resource limits missing!'}
-${KLIB_RESOURCE_LIMITs_MEMORY}     %{KLIB_RESOURCE_LIMITS_MEMORY='Resource limits missing!'}
-${KLIB_ENV_VARS}                   %{KLIB_ENV_VARS='Env vars missing!'}
+${KLIB_POD_PATTERN}                 %{KLIB_POD_PATTERN}
+${KLIB_POD_NAMESPACE}               %{KLIB_POD_NAMESPACE}
+${KLIB_POD_REPLICAS}                %{KLIB_POD_REPLICAS=1}
+${KLIB_POD_TIMEOUT}                 %{KLIB_POD_TIMEOUT=2min}
+${KLIB_POD_RETRY_INTERVAL}          %{KLIB_POD_RETRY_INTERVAL=5sec}
+${KLIB_POD_LABELS}                  %{KLIB_POD_LABELS='Labels missing!'}
+${KLIB_POD_ANNOTATIONS}             %{KLIB_POD_ANNOTATIONS='Annotations missing!'}
+${KLIB_RESOURCE_REQUESTS_CPU}       %{KLIB_RESOURCE_REQUESTS_CPU='Resource requests missing!'}
+${KLIB_RESOURCE_REQUESTS_MEMORY}    %{KLIB_RESOURCE_REQUESTS_MEMORY='Resource requests missing!'}
+${KLIB_RESOURCE_LIMITS_CPU}         %{KLIB_RESOURCE_LIMITS_CPU='Resource limits missing!'}
+${KLIB_RESOURCE_LIMITs_MEMORY}      %{KLIB_RESOURCE_LIMITS_MEMORY='Resource limits missing!'}
+${KLIB_ENV_VARS}                    %{KLIB_ENV_VARS='Env vars missing!'}
+${LOGS_SINCE}                       1000
 
 *** Test Cases ***
 
@@ -68,6 +69,13 @@ Logs of pod are available
     Then logs of pod can be retrived
     And logs contain expected string
 
+Logs of pod since 1000s are available
+    [Tags]    prerelease
+    Given waited for pods matching "${KLIB_POD_PATTERN}" in namespace "${KLIB_POD_NAMESPACE}" to be READY
+    When getting pods matching "${KLIB_POD_PATTERN}" in namespace "${KLIB_POD_NAMESPACE}"
+    Then logs of pod can be retrived since "${LOGS_SINCE}"
+    And logs contain expected string
+
 List pods by label
     [Tags]    other
     Given waited for pods matching "${KLIB_POD_PATTERN}" in namespace "${KLIB_POD_NAMESPACE}" to be READY

diff --git a/testcases/pod/pod_kw.robot b/testcases/pod/pod_kw.robot
@@ -106,5 +106,11 @@ logs of pod can be retrived
     Log  ${pod_logs}  console=True
     Set Test Variable    ${POD_LOGS}    ${pod_logs}
 
+logs of pod can be retrived since "${seconds}"
+    Set Test Variable    ${POD_NAME}    ${namespace_pods[0].metadata.name}
+    ${pod_logs}=  Read namespaced pod log  ${POD_NAME}  ${KLIB_POD_NAMESPACE}  busybox  since_seconds=${seconds}
+    Log  ${pod_logs}  console=True
+    Set Test Variable    ${POD_LOGS}    ${pod_logs}
+
 logs contain expected string
     Should Contain    ${POD_LOGS}    I am