Changes made in wacth.py to print Empty newlines that are skipped when watching pod logs. #2372

p172913 · 2025-03-09T05:45:44Z

What type of PR is this?
/kind bug

What this PR does / why we need it:
This PRs print Empty newlines that are skipped when watching pod logs. Changed yield login in stream to print only single empty line between the logs.

Which issue(s) this PR fixes:
Fixes #2358

Special notes for your reviewer:
This is my first time contributing, so please let me know if I made the change successfully!

Does this PR introduce a user-facing change?
None

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:
None

Changes made in wacth.py to print Empty newlines that are skipped when watching pod logs.

linux-foundation-easycla · 2025-03-09T05:45:48Z

The committers listed above are authorized under a signed CLA.

✅ login: p172913 / name: Raj Bhargav (d1adc8a, 1268769, 14a2554, 3cee537, b2f9755, f4d0842, d451d2f, f0a73c8, 1e093d0)

k8s-ci-robot · 2025-03-09T05:45:53Z

Welcome @p172913!

It looks like this is your first PR to kubernetes-client/python 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/python has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

p172913 · 2025-03-09T10:02:15Z

@yliaog, @fabianvf Please review my PR and approve.

yliaog · 2025-03-12T18:28:35Z

how did you test it? please add a test to this PR

p172913 · 2025-03-12T20:06:06Z

@yliaog I installed the kubernetes client in editable mode on local, made changes that are mentioned in PR and ran the code given in the issue as an test. It was working fine. And I am seeing output as expected. If needed I can add the test I did in tests...
Here is the screenshot of the output:

This file is to test whether empty line are printed when watch function in the kubernetes python client is used.

p172913 · 2025-03-14T16:44:31Z

@yliaog As per your request I commited a test case. Please review and approve my PR.

yliaog · 2025-03-16T18:38:03Z

thanks for the PR, could you add a unit test in kubernetes/base/watch/watch_test.py ?

p172913 · 2025-03-17T03:52:55Z

@yliaog I added it in kubernetes/test/test_pod_logs.py. If i is needed in kubernetes/base/watch/watch_test.py. I can add it there.

yliaog · 2025-03-17T16:05:41Z

please add a test in kubernetes/base/watch/watch_test.py

Added a unit test name test_pod_log_empty_lines to check if watch is printing empty lines. And made changes in test_watch_with_interspersed_newlines as the watch is also printing empty line. Added a condition to check for empty lines in ogs to avoid the errors.

Deleting file with tests added in test/test_pod_los.py

p172913 · 2025-03-18T08:21:16Z

@yliaog added unit test in kubernetes/base/watch/watch_test.py with name test_pod_log_empty_lines. And made changes in test_watch_with_interspersed_newlines test case to avoid empty line exception.

yliaog · 2025-03-18T21:38:23Z

kubernetes/base/watch/watch.py

+                            yield line  # Normal non-empty line
+                            last_was_empty = False  
+                        elif not last_was_empty:  
+                            yield '/n'  # Only yield one empty line  


should it be '\n' ?

Actually it has to be '' (an empty string) if yield an empty string. We need to change unmarshal_event function also. If needed I can change '/n' to '' and will change unmarshal_event function.

Replace '/n' with '' (empty string) and adjusted unmarshal_event function in watch.py

Changes made in unmarshal_event for not having issues with empty lines.

yliaog · 2025-03-19T17:08:16Z

kubernetes/base/watch/watch_test.py

+
+    def test_pod_log_empty_lines(self):
+        pod_name = "demo-bug"
+        # Manifest with busybax to keep pod engaged for sometiem


typo: sometiem ?

I will adjust

yliaog · 2025-03-19T17:08:46Z

kubernetes/base/watch/watch_test.py

+    def test_pod_log_empty_lines(self):
+        pod_name = "demo-bug"
+        # Manifest with busybax to keep pod engaged for sometiem
+        pod_manifest = {


where is pod_manifest used?

I used minikube before replacing it with mock function. After checking locally forgot to delete it

Just deleted pod_manifest from watch_test.py.

Removed pod_manifest from watch_test.py.

yliaog · 2025-03-19T19:30:32Z

kubernetes/base/watch/watch_test.py

+            # Print outputs
+            print(f"Captured logs: {log_output}") 
+            # self.assertTrue(any("Hello from Docker" in line for line in log_output))
+            self.assertTrue(any(line.strip() == "" for line in log_output), "No empty lines found in logs")


could you add an assertion that ensures the log_output has exactly what is expected, the whole log?

Changed assertive statement to make sure entire output logs are verified.

Changes made to check whether entire log is printed or not.

yliaog · 2025-03-19T20:50:32Z

kubernetes/base/watch/watch_test.py

+            #Mock logs used for this test
+            w.stream = Mock(return_value=[
+                        "Hello from Docker",
+                        "",  # Empty line


add another empty line here?

Added few empty lines to the test case.

Changes made in watch.py to print multiple empty line if necessary.

As per request added few empty lines to test case in watch_test.py

kubernetes/base/watch/watch_test.py

yliaog · 2025-03-21T17:54:34Z

/lgtm
/approve

k8s-ci-robot · 2025-03-21T17:54:39Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: p172913, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~kubernetes/base/OWNERS~~ [yliaog]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

yliaog · 2025-03-21T17:54:52Z

/release-note-none

Changes for issue 2358

d1adc8a

Changes made in wacth.py to print Empty newlines that are skipped when watching pod logs.

k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Mar 9, 2025

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 9, 2025

k8s-ci-robot requested review from fabianvf and yliaog March 9, 2025 05:45

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Mar 9, 2025

Create test_pod_logs.py

b2f9755

This file is to test whether empty line are printed when watch function in the kubernetes python client is used.

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Mar 13, 2025

Update watch_test.py

3cee537

Added a unit test name test_pod_log_empty_lines to check if watch is printing empty lines. And made changes in test_watch_with_interspersed_newlines as the watch is also printing empty line. Added a condition to check for empty lines in ogs to avoid the errors.

k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 18, 2025

Delete kubernetes/test/test_pod_logs.py

14a2554

Deleting file with tests added in test/test_pod_los.py

yliaog reviewed Mar 18, 2025

View reviewed changes

Update watch.py

f0a73c8

Changes made in unmarshal_event for not having issues with empty lines.

yliaog reviewed Mar 19, 2025

View reviewed changes

Update watch_test.py

1268769

Removed pod_manifest from watch_test.py.

yliaog reviewed Mar 19, 2025

View reviewed changes

Update watch_test.py

1e093d0

Changes made to check whether entire log is printed or not.

yliaog reviewed Mar 19, 2025

View reviewed changes

p172913 added 2 commits March 20, 2025 11:21

Update watch.py

f4d0842

Changes made in watch.py to print multiple empty line if necessary.

Update watch_test.py

d451d2f

As per request added few empty lines to test case in watch_test.py

yliaog reviewed Mar 20, 2025

View reviewed changes

kubernetes/base/watch/watch_test.py Show resolved Hide resolved

k8s-ci-robot assigned yliaog Mar 21, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 21, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Mar 21, 2025

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Mar 21, 2025

k8s-ci-robot merged commit bd32360 into kubernetes-client:master Mar 21, 2025
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changes made in wacth.py to print Empty newlines that are skipped when watching pod logs. #2372

Changes made in wacth.py to print Empty newlines that are skipped when watching pod logs. #2372

p172913 commented Mar 9, 2025

linux-foundation-easycla bot commented Mar 9, 2025 •

edited

Loading

k8s-ci-robot commented Mar 9, 2025

p172913 commented Mar 9, 2025

yliaog commented Mar 12, 2025

p172913 commented Mar 12, 2025 •

edited

Loading

p172913 commented Mar 14, 2025

yliaog commented Mar 16, 2025

p172913 commented Mar 17, 2025

yliaog commented Mar 17, 2025

p172913 commented Mar 18, 2025

yliaog Mar 18, 2025

p172913 Mar 19, 2025

p172913 Mar 19, 2025

yliaog Mar 19, 2025

p172913 Mar 19, 2025

yliaog Mar 19, 2025

p172913 Mar 19, 2025 •

edited

Loading

p172913 Mar 19, 2025

yliaog Mar 19, 2025

p172913 Mar 19, 2025

yliaog Mar 19, 2025

p172913 Mar 20, 2025

yliaog commented Mar 21, 2025

k8s-ci-robot commented Mar 21, 2025

yliaog commented Mar 21, 2025

Changes made in wacth.py to print Empty newlines that are skipped when watching pod logs. #2372

Changes made in wacth.py to print Empty newlines that are skipped when watching pod logs. #2372

Conversation

p172913 commented Mar 9, 2025

linux-foundation-easycla bot commented Mar 9, 2025 • edited Loading

k8s-ci-robot commented Mar 9, 2025

p172913 commented Mar 9, 2025

yliaog commented Mar 12, 2025

p172913 commented Mar 12, 2025 • edited Loading

p172913 commented Mar 14, 2025

yliaog commented Mar 16, 2025

p172913 commented Mar 17, 2025

yliaog commented Mar 17, 2025

p172913 commented Mar 18, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

p172913 Mar 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yliaog commented Mar 21, 2025

k8s-ci-robot commented Mar 21, 2025

yliaog commented Mar 21, 2025

linux-foundation-easycla bot commented Mar 9, 2025 •

edited

Loading

p172913 commented Mar 12, 2025 •

edited

Loading

p172913 Mar 19, 2025 •

edited

Loading