Skip to content

Commit 59700fa

Browse files
authored
Remove manifest from str representation (#1148)
When logging/printing `K8sObject`s, the manifest was included which can result in very large strings, containing potential sensitive data. This string would be returned to clients inside an error message (see referenced issue). The name and namespace should be enough, so the manifest is now hidden - same as done already in `K8sSecret`. Fixes: #1127
1 parent d7e58db commit 59700fa

2 files changed

Lines changed: 31 additions & 1 deletion

File tree

components/renku_data_services/k8s/models.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ def __init__(
8585
def __repr__(self) -> str:
8686
return (
8787
f"{self.__class__.__name__}(name={self.name}, namespace={self.namespace}, cluster={self.cluster}, "
88-
f"gvk={self.gvk}, manifest={self.manifest}, user_id={self.user_id})"
88+
f"gvk={self.gvk}, user_id={self.user_id})"
8989
)
9090

9191
def to_api_object(self, api: Api) -> APIObject:
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
"""Tests for the k8s models."""
2+
3+
from ulid import ULID
4+
5+
from renku_data_services.k8s.constants import ClusterId
6+
from renku_data_services.k8s.models import GVK, K8sObject, K8sSecret
7+
8+
9+
def test_k8s_object_not_render_manifest():
10+
obj = K8sObject(
11+
name="hello",
12+
namespace="ns1",
13+
cluster=ClusterId(ULID()),
14+
gvk=GVK(kind="kind", version="version1"),
15+
user_id="abc-user1",
16+
manifest={"not_a_real_manifest": "abd275c11ceb"},
17+
)
18+
sec = K8sSecret(
19+
name="hello",
20+
namespace="ns1",
21+
cluster=ClusterId(ULID()),
22+
gvk=GVK(kind="kind", version="version1"),
23+
user_id="abc-user1",
24+
manifest={"not_a_real_manifest": "abd275c11ceb"},
25+
)
26+
27+
assert "abd275c11ceb" not in str(obj)
28+
assert "abd275c11ceb" not in repr(obj)
29+
assert "abd275c11ceb" not in str(sec)
30+
assert "abd275c11ceb" not in repr(sec)

0 commit comments

Comments
 (0)