8000 fix new lines in snippets (#4832) · nginx/kubernetes-ingress@879c563 · GitHub
[go: up one dir, main page]
Skip to content

Commit 879c563

Browse files
Jim Ryanpre-commit-ci[bot]
authored and
pdabelf5
committed
fix new lines in snippets (#4832)
* fix new lines in snippets * add test for server snippet new lines * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent b0ee57c commit 879c563

File tree

6 files changed

+20
-16
lines changed

6 files changed

+20
-16
lines changed

‎internal/configs/version2/nginx-plus.transportserver.tmpl‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ upstream {{ $u.Name }} {
1818
{{- end }}
1919

2020
{{- range $snippet := .StreamSnippets }}
21-
{{- $snippet }}
22-
{{ end }}
21+
{{ $snippet }}
22+
{{- end }}
2323

2424
{{ with $m := .Match }}
2525
match {{ $m.Name }} {
@@ -60,7 +60,7 @@ server {
6060
{{- end }}
6161

6262
{{- range $snippet := $s.ServerSnippets }}
63-
{{- $snippet }}
63+
{{ $snippet }}
6464
{{- end }}
6565

6666
proxy_pass {{ $s.ProxyPass }};

‎internal/configs/version2/nginx-plus.virtualserver.tmpl‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ map {{ $m.Source }} {{ $m.Variable }} {
4848
{{- end }}
4949

5050
{{- range $snippet := .HTTPSnippets }}
51-
{{- $snippet }}
51+
{{ $snippet }}
5252
{{- end }}
5353

5454
{{- range $z := .LimitReqZones }}
@@ -286,7 +286,7 @@ server {
286286
{{- end }}
287287

288288
{{- range $snippet := $s.Snippets }}
289-
{{- $snippet }}
289+
{{ $snippet }}
290290
{{- end }}
291291

292292
{{- range $l := $s.InternalRedirectLocations }}
@@ -351,7 +351,7 @@ server {
351351
internal;
352352
{{- end }}
353353
{{- range $snippet := $l.Snippets }}
354-
{{- $snippet }}
354+
{{ $snippet }}
355355
{{- end }}
356356

357357
{{- with $l.PoliciesErrorReturn }}

‎internal/configs/version2/nginx.transportserver.tmpl‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ upstream {{ $u.Name }} {
1414
{{- end }}
1515

1616
{{- range $snippet := .StreamSnippets }}
17-
{{- $snippet }}
17+
{{ $snippet }}
1818
{{- end }}
1919

2020
{{- $s := .Server }}
@@ -42,7 +42,7 @@ server {
4242
{{- end }}
4343

4444
{{- range $snippet := $s.ServerSnippets }}
45-
{{- $snippet }}
45+
{{ $snippet }}
4646
{{- end }}
4747

4848
proxy_pass {{ $s.ProxyPass }};

‎internal/configs/version2/nginx.virtualserver.tmpl‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ map {{ $m.Source }} {{ $m.Variable }} {
3232
{{- end }}
3333

3434
{{- range $snippet := .HTTPSnippets }}
35-
{{- $snippet }}
35+
{{ $snippet }}
3636
{{- end }}
3737

3838
{{- range $z := .LimitReqZones }}
@@ -166,7 +166,7 @@ server {
166166
{{- end }}
167167

168168
{{- range $snippet := $s.Snippets }}
169-
{{- $snippet }}
169+
{{ $snippet }}
170170
{{- end }}
171171

172172
{{- range $l := $s.InternalRedirectLocations }}
@@ -208,7 +208,7 @@ server {
208208
internal;
209209
{{- end }}
210210
{{- range $snippet := $l.Snippets }}
211-
{{- $snippet }}
211+
{{ $snippet }}
212212
{{- end }}
213213

214214
{{- with $l.PoliciesErrorReturn }}

‎tests/data/transport-server/transport-server-snippets.yaml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,10 @@ metadata:
44
name: transport-server
55
spec:
66
streamSnippets: limit_conn_zone $binary_remote_addr zone=addr:10m;
7-
serverSnippets: limit_conn addr 1;
7+
serverSnippets: |
8+
limit_conn addr 1;
9+
# a comment is allowed in snippets
10+
add_header X-test-header "test-value";
811
listener:
912
name: dns-tcp
1013
protocol: TCP

‎tests/suite/test_transport_server.py‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,11 @@ def test_snippets(
5555
transport_server_setup.namespace,
5656
)
5757

58-
assert (
59-
"limit_conn_zone $binary_remote_addr zone=addr:10m;" in conf # stream-snippets
60-
and "limit_conn addr 1;" in conf # server-snippets
61-
)
58+
conf_lines = [line.strip() for line in conf.split("\n")]
59+
assert "limit_conn_zone $binary_remote_addr zone=addr:10m;" in conf_lines # stream-snippets on separate line
60+
assert "limit_conn addr 1;" in conf_lines # server-snippets on separate line
61+
assert "# a comment is allowed in snippets" in conf_lines # comments are allowed in server snippets
62+
assert 'add_header X-test-header "test-value";' in conf_lines # new line in server-snippets on separate line
6263

6364
def test_configurable_timeout_directives(
6465
self, kube_apis, crd_ingress_controller, transport_server_setup, ingress_controller_prerequisites

0 commit comments

Comments
 (0)
0