DevFW-CICD/ingress-nginx-helm
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Move opentracing configuration for location to go (#4965)

Browse source
This commit is contained in:
Manuel Alejandro de Brito Fontes 2020-01-25 21:39:20 -03:00 • committed by GitHub
parent a4f3467f9b
commit 7ff49b25d6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 70 additions and 44 deletions
Download patch file Download diff file Expand all files Collapse all files

32
internal/ingress/controller/template/template.go
View file

@ -173,11 +173,11 @@ var (
"enforceRegexModifier": enforceRegexModifier,
"stripLocationModifer": stripLocationModifer,
"buildCustomErrorDeps": buildCustomErrorDeps,
"opentracingPropagateContext": opentracingPropagateContext,
"buildCustomErrorLocationsPerServer": buildCustomErrorLocationsPerServer,
"shouldLoadModSecurityModule": shouldLoadModSecurityModule,
"buildHTTPListener": buildHTTPListener,
"buildHTTPSListener": buildHTTPSListener,
"buildOpentracingForLocation": buildOpentracingForLocation,
}
)
@ -1064,18 +1064,16 @@ func buildCustomErrorLocationsPerServer(input interface{}) []errorLocation {
return errorLocations
}
func opentracingPropagateContext(loc interface{}) string {
location, ok := loc.(*ingress.Location)
if !ok {
klog.Errorf("expected a '*ingress.Location' type but %T was returned", loc)
return "opentracing_propagate_context"
func opentracingPropagateContext(location *ingress.Location) string {
if location == nil {
return ""
}
if location.BackendProtocol == "GRPC" || location.BackendProtocol == "GRPCS" {
return "opentracing_grpc_propagate_context"
return "opentracing_grpc_propagate_context;"
}
return "opentracing_propagate_context"
return "opentracing_propagate_context;"
}
// shouldLoadModSecurityModule determines whether or not the ModSecurity module needs to be loaded.
@ -1271,3 +1269,21 @@ func httpsListener(addresses []string, co string, tc config.TemplateConfig) []st
return out
}
func buildOpentracingForLocation(isOTEnabled bool, location *ingress.Location) string {
isOTEnabledInLoc := location.Opentracing.Enabled
if isOTEnabled {
if !isOTEnabledInLoc {
return "opentracing off;"
}
return opentracingPropagateContext(location)
}
if isOTEnabledInLoc {
return opentracingPropagateContext(location)
}
return ""
}

41
internal/ingress/controller/template/template_test.go
View file

@ -39,6 +39,7 @@ import (
"k8s.io/ingress-nginx/internal/ingress/annotations/authreq"
"k8s.io/ingress-nginx/internal/ingress/annotations/influxdb"
"k8s.io/ingress-nginx/internal/ingress/annotations/modsecurity"
"k8s.io/ingress-nginx/internal/ingress/annotations/opentracing"
"k8s.io/ingress-nginx/internal/ingress/annotations/ratelimit"
"k8s.io/ingress-nginx/internal/ingress/annotations/rewrite"
"k8s.io/ingress-nginx/internal/ingress/controller/config"
@ -883,14 +884,14 @@ func TestEscapeLiteralDollar(t *testing.T) {
}
func TestOpentracingPropagateContext(t *testing.T) {
tests := map[interface{}]string{
&ingress.Location{BackendProtocol: "HTTP"}: "opentracing_propagate_context",
&ingress.Location{BackendProtocol: "HTTPS"}: "opentracing_propagate_context",
&ingress.Location{BackendProtocol: "GRPC"}: "opentracing_grpc_propagate_context",
&ingress.Location{BackendProtocol: "GRPCS"}: "opentracing_grpc_propagate_context",
&ingress.Location{BackendProtocol: "AJP"}: "opentracing_propagate_context",
&ingress.Location{BackendProtocol: "FCGI"}: "opentracing_propagate_context",
"not a location": "opentracing_propagate_context",
tests := map[*ingress.Location]string{
{BackendProtocol: "HTTP"}: "opentracing_propagate_context;",
{BackendProtocol: "HTTPS"}: "opentracing_propagate_context;",
{BackendProtocol: "GRPC"}: "opentracing_grpc_propagate_context;",
{BackendProtocol: "GRPCS"}: "opentracing_grpc_propagate_context;",
{BackendProtocol: "AJP"}: "opentracing_propagate_context;",
{BackendProtocol: "FCGI"}: "opentracing_propagate_context;",
nil: "",
}
for loc, expectedDirective := range tests {
@ -1280,3 +1281,27 @@ func TestShouldLoadModSecurityModule(t *testing.T) {
t.Errorf("Expected '%v' but returned '%v'", expected, actual)
}
}
func TestOpentracingForLocation(t *testing.T) {
testCases := []struct {
description string
globalOT bool
isOTInLoc bool
expected string
}{
{"globally enabled but not in location", true, false, "opentracing off;"},
{"globally enabled and enabled in location", true, true, "opentracing_propagate_context;"},
{"globally disabled and not enabled in location", false, false, ""},
{"globally disabled but enabled in location", false, true, "opentracing_propagate_context;"},
}
for _, testCase := range testCases {
actual := buildOpentracingForLocation(testCase.globalOT, &ingress.Location{
Opentracing: opentracing.Config{Enabled: testCase.isOTInLoc},
})
if testCase.expected != actual {
t.Errorf("%v: expected '%v' but returned '%v'", testCase.description, testCase.expected, actual)
}
}
}