Skip to content

Commit cc3407f

Browse files
very-doge-wowvery-doge-wow
authoredAug 15, 2022
fix: default value rendering and markdown tables (#21)
* fix: default value rendering and markdown tables * fix: render md tables
·
2.2.31.4
1 parent 1fa3f77 commit cc3407f

File tree

4 files changed

+73
-49
lines changed

4 files changed

+73
-49
lines changed
 

‎reader/chart_reader.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ def generate_values_doc(doc: dict, helm_chart_path: str) -> dict:
9898
i = index
9999
# check if the next line still is a comment, if so add it to docstring
100100
while values_lines[i+1].startswith("#"):
101-
doc_string += values_lines[i+1].replace("# ", "").replace("#","") + "\n"
101+
doc_string += values_lines[i+1].replace("# ", "").replace("#", "") + "\n"
102102
i += 1
103103
# this loop starts when no comment is present anymore
104104
while values_lines[i+1].strip() == "":
@@ -122,8 +122,8 @@ def generate_values_doc(doc: dict, helm_chart_path: str) -> dict:
122122
doc["values"].append({
123123
"name": value_name,
124124
"description": doc_string,
125-
"default": values_yaml[value_name],
126-
"example": example
125+
"default": {value_name: values_yaml[value_name]},
126+
"example": example.replace("|", "\\|") # escape pipe symbol to correctly render md table
127127
})
128128
# also add doc entries for values that do not have stella docstrings
129129
for values in values_yaml:
@@ -136,7 +136,7 @@ def generate_values_doc(doc: dict, helm_chart_path: str) -> dict:
136136
doc["values"].append({
137137
"name": values,
138138
"description": "",
139-
"default": values_yaml[values],
139+
"default": {values: values_yaml[values]},
140140
"example": ""
141141
})
142142
return doc

‎reader/chart_reader_test.py

+61-44
Original file line numberDiff line numberDiff line change
@@ -21,47 +21,43 @@ def test_read():
2121
result["objects"] = sorted(result["objects"], key=lambda item: item.get("kind"))
2222
result["templates"] = sorted(result["templates"], key=lambda item: item.get("path"))
2323
assert_that(result, has_entries(
24-
{
25-
'name': 'test-chart',
26-
'appVersion': '1.16.0',
27-
'apiVersion': 'v2',
28-
'version': '0.1.0',
29-
'description': 'A Helm chart for Kubernetes',
30-
'type': 'application',
31-
'dependencies': [
32-
{'name': 'postgresql', 'condition': 'postgresql.enabled', 'version': '1.2.3',
33-
'repository': 'https://lol.de/repo/'},
34-
{'name': 'mysql', 'condition': 'mysql.enabled', 'version': '1.2.3', 'repository': 'https://lol.de/repo/'}
35-
],
36-
'values': [
37-
{'name': 'replicaCount', 'description': 'how many replicas to deploy\n', 'default': 1, 'example': ''},
38-
{'name': 'image', 'description': 'which image to deploy\n', 'default': {'repository': 'nginx', 'pullPolicy': 'IfNotPresent', 'tag': ''}, 'example': '\nimage:\n repository: very-doge-wow/stella\n pullPolicy: IfNotPresent\n tag: "latest"\n'},
39-
{'name': 'imagePullSecrets', 'description': '', 'default': [], 'example': ''},
40-
{'name': 'nameOverride', 'description': '', 'default': '', 'example': ''},
41-
{'name': 'fullnameOverride', 'description': '', 'default': '', 'example': ''},
42-
{'name': 'serviceAccount', 'description': '', 'default': {'create': True, 'annotations': {}, 'name': ''}, 'example': ''}, {'name': 'podAnnotations', 'description': '', 'default': {}, 'example': ''},
43-
{'name': 'podSecurityContext', 'description': '', 'default': {}, 'example': ''},
44-
{'name': 'securityContext', 'description': '', 'default': {}, 'example': ''},
45-
{'name': 'service', 'description': '', 'default': {'type': 'ClusterIP', 'port': 80}, 'example': ''},
46-
{'name': 'ingress', 'description': '', 'default': {'enabled': False, 'className': '', 'annotations': {}, 'hosts': [{'host': 'chart-example.local', 'paths': [{'path': '/', 'pathType': 'ImplementationSpecific'}]}], 'tls': []}, 'example': ''},
47-
{'name': 'resources', 'description': '', 'default': {}, 'example': ''},
48-
{'name': 'autoscaling', 'description': '', 'default': {'enabled': False, 'minReplicas': 1, 'maxReplicas': 100, 'targetCPUUtilizationPercentage': 80}, 'example': ''}, {'name': 'nodeSelector', 'description': '', 'default': {}, 'example': ''},
49-
{'name': 'tolerations', 'description': '', 'default': [], 'example': ''},
50-
{'name': 'affinity', 'description': '', 'default': {}, 'example': ''}],
51-
'templates': [
52-
{'path': 'deployment.yaml'},
53-
{'path': 'hpa.yaml'},
54-
{'path': 'ingress.yaml'},
55-
{'path': 'service.yaml'},
56-
{'path': 'serviceaccount.yaml'}
57-
],
58-
'objects': [
59-
{'kind': 'Deployment', 'from Template': 'deployment.yaml'},
60-
{'kind': 'HorizontalPodAutoscaler', 'from Template': 'hpa.yaml'},
61-
{'kind': 'Ingress', 'from Template': 'ingress.yaml'},
62-
{'kind': 'Service', 'from Template': 'service.yaml'},
63-
{'kind': 'ServiceAccount', 'from Template': 'serviceaccount.yaml'},
64-
],
24+
{'name': 'test-chart', 'appVersion': '1.16.0', 'apiVersion': 'v2', 'version': '0.1.0',
25+
'description': 'A Helm chart for Kubernetes', 'type': 'application', 'dependencies': [
26+
{'name': 'postgresql', 'condition': 'postgresql.enabled', 'version': '1.2.3',
27+
'repository': 'https://lol.de/repo/'},
28+
{'name': 'mysql', 'condition': 'mysql.enabled', 'version': '1.2.3', 'repository': 'https://lol.de/repo/'}],
29+
'values': [
30+
{'name': 'replicaCount', 'description': 'how many replicas to deploy\n', 'default': {'replicaCount': 1},
31+
'example': ''}, {'name': 'image', 'description': 'which image to deploy\n',
32+
'default': {'image': {'repository': 'nginx', 'pullPolicy': 'IfNotPresent', 'tag': ''}},
33+
'example': '\nimage:\n repository: very-doge-wow/stella\n pullPolicy: IfNotPresent\n tag: "latest"\n'},
34+
{'name': 'imagePullSecrets', 'description': '', 'default': {'imagePullSecrets': []}, 'example': ''},
35+
{'name': 'nameOverride', 'description': '', 'default': {'nameOverride': ''}, 'example': ''},
36+
{'name': 'fullnameOverride', 'description': '', 'default': {'fullnameOverride': ''}, 'example': ''},
37+
{'name': 'serviceAccount', 'description': '',
38+
'default': {'serviceAccount': {'create': True, 'annotations': {}, 'name': ''}}, 'example': ''},
39+
{'name': 'podAnnotations', 'description': '', 'default': {'podAnnotations': {}}, 'example': ''},
40+
{'name': 'podSecurityContext', 'description': '', 'default': {'podSecurityContext': {}}, 'example': ''},
41+
{'name': 'securityContext', 'description': '', 'default': {'securityContext': {}}, 'example': ''},
42+
{'name': 'service', 'description': '', 'default': {'service': {'type': 'ClusterIP', 'port': 80}},
43+
'example': ''}, {'name': 'ingress', 'description': '', 'default': {
44+
'ingress': {'enabled': False, 'className': '', 'annotations': {}, 'hosts': [
45+
{'host': 'chart-example.local', 'paths': [{'path': '/', 'pathType': 'ImplementationSpecific'}]}],
46+
'tls': []}}, 'example': ''},
47+
{'name': 'resources', 'description': '', 'default': {'resources': {}}, 'example': ''},
48+
{'name': 'autoscaling', 'description': '', 'default': {
49+
'autoscaling': {'enabled': False, 'minReplicas': 1, 'maxReplicas': 100,
50+
'targetCPUUtilizationPercentage': 80}}, 'example': ''},
51+
{'name': 'nodeSelector', 'description': '', 'default': {'nodeSelector': {}}, 'example': ''},
52+
{'name': 'tolerations', 'description': '', 'default': {'tolerations': []}, 'example': ''},
53+
{'name': 'affinity', 'description': '', 'default': {'affinity': {}}, 'example': ''}],
54+
'templates': [{'path': 'deployment.yaml'}, {'path': 'hpa.yaml'}, {'path': 'ingress.yaml'},
55+
{'path': 'service.yaml'}, {'path': 'serviceaccount.yaml'}],
56+
'objects': [{'kind': 'Deployment', 'from Template': 'deployment.yaml'},
57+
{'kind': 'HorizontalPodAutoscaler', 'from Template': 'hpa.yaml'},
58+
{'kind': 'Ingress', 'from Template': 'ingress.yaml'},
59+
{'kind': 'Service', 'from Template': 'service.yaml'},
60+
{'kind': 'ServiceAccount', 'from Template': 'serviceaccount.yaml'}],
6561
'commands': [{'description': '', 'command': ''}]}
6662
))
6763

@@ -117,12 +113,12 @@ def test_generate_values_doc_and_example():
117113
{
118114
'name': 'replicaCount',
119115
'description': 'how many replicas to deploy\n',
120-
'default': 1, 'example': ''
116+
'default': {'replicaCount': 1}, 'example': ''
121117
},
122118
{
123119
'name': 'image',
124120
'description': 'which image to deploy\n',
125-
'default': {'repository': 'nginx', 'pullPolicy': 'IfNotPresent', 'tag': ''},
121+
'default': {'image': {'repository': 'nginx', 'pullPolicy': 'IfNotPresent', 'tag': ''}},
126122
'example': '\nimage:\n repository: very-doge-wow/stella\n pullPolicy: IfNotPresent\n tag: "latest"\n'
127123
}
128124
))
@@ -147,11 +143,32 @@ def test_generate_values_doc_only():
147143
{
148144
'name': 'replicaCount',
149145
'description': 'how many replicas to deploy\n',
150-
'default': 1, 'example': ''
146+
'default': {'replicaCount': 1}, 'example': ''
151147
}
152148
))
153149

154150

151+
def test_generate_values_pipes_in_tables():
152+
doc = {
153+
"name": "",
154+
"appVersion": "",
155+
"apiVersion": "",
156+
"version": "",
157+
"description": "",
158+
"type": "",
159+
"dependencies": [],
160+
"values": [],
161+
"templates": [],
162+
"objects": [],
163+
"commands": [],
164+
}
165+
result = chart_reader.generate_values_doc(doc, "test/values-pipes")
166+
print(result)
167+
assert_that(result["values"], contains_inanyorder(
168+
{'name': 'customObjects', 'description': 'Test for using pipes in examples\n', 'default': {'customObjects': []}, 'example': '\ncustomObjects:\n - \\|\n best-string\n'}
169+
))
170+
171+
155172
def test_generate_requirements():
156173
doc = {
157174
"name": "",

‎test/values-pipes/values.yaml

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# -- stella
2+
# Test for using pipes in examples
3+
# -- example
4+
# customObjects:
5+
# - |
6+
# best-string
7+
customObjects: []

‎writer/doc_writer.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ def translate_list_of_dicts_to_md(list_of_dicts: list) -> str:
145145
if key == "name":
146146
name = value
147147
if type(value) == dict:
148-
value = yaml.safe_dump({name: value})
148+
value = yaml.safe_dump(value).replace("|", "\\|") # escape pipe chars to fix md tables
149149
if (key == "default" or key == "example") and value != "":
150150
# we should put this into a code-block
151151
value = "<pre>" + str(value).lstrip()

0 commit comments

Comments
 (0)
Please sign in to comment.