Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moved and renamed all Predicate names and Filter names for consistency and ease of use #1828

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions dataclients/kubernetes/ingress.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ import (
log "github.com/sirupsen/logrus"
"github.com/zalando/skipper/dataclients/kubernetes/definitions"
"github.com/zalando/skipper/eskip"
"github.com/zalando/skipper/predicates/primitive"
"github.com/zalando/skipper/predicates/traffic"
"github.com/zalando/skipper/predicates"
)

const (
Expand Down Expand Up @@ -249,14 +248,14 @@ func setTraffic(r *eskip.Route, svcName string, weight float64, noopCount int) {
// add traffic predicate if traffic weight is between 0.0 and 1.0
if 0.0 < weight && weight < 1.0 {
r.Predicates = append([]*eskip.Predicate{{
Name: traffic.PredicateName,
Name: predicates.TrafficName,
Args: []interface{}{weight},
}}, r.Predicates...)
log.Debugf("Traffic weight %.2f for backend '%s'", weight, svcName)
}
for i := 0; i < noopCount; i++ {
r.Predicates = append([]*eskip.Predicate{{
Name: primitive.NameTrue,
Name: predicates.TrueName,
Args: []interface{}{},
}}, r.Predicates...)
}
Expand Down
17 changes: 8 additions & 9 deletions dataclients/kubernetes/kube.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,8 @@ import (

log "github.com/sirupsen/logrus"
"github.com/zalando/skipper/eskip"
"github.com/zalando/skipper/filters/accesslog"
"github.com/zalando/skipper/filters/builtin"
"github.com/zalando/skipper/predicates/source"
"github.com/zalando/skipper/filters"
"github.com/zalando/skipper/predicates"
)

const (
Expand Down Expand Up @@ -359,11 +358,11 @@ func (c *Client) loadAndConvert() ([]*eskip.Route, error) {
func shuntRoute(r *eskip.Route) {
r.Filters = []*eskip.Filter{
{
Name: builtin.StatusName,
Name: filters.StatusName,
Args: []interface{}{502.0},
},
{
Name: builtin.InlineContentName,
Name: filters.InlineContentName,
Args: []interface{}{"no endpoints"},
},
}
Expand All @@ -373,7 +372,7 @@ func shuntRoute(r *eskip.Route) {

func healthcheckRoute(healthy, reverseSourcePredicate bool) *eskip.Route {
logFilters := []*eskip.Filter{{
Name: builtin.StatusName,
Name: filters.StatusName,
Args: []interface{}{http.StatusOK}},
}
if !healthy {
Expand All @@ -382,20 +381,20 @@ func healthcheckRoute(healthy, reverseSourcePredicate bool) *eskip.Route {
// log if unhealthy or a debug loglevel
if healthy && !log.IsLevelEnabled(log.DebugLevel) {
logFilters = append(logFilters, &eskip.Filter{
Name: accesslog.DisableAccessLogName,
Name: filters.DisableAccessLogName,
Args: []interface{}{200},
})
}

var p []*eskip.Predicate
if reverseSourcePredicate {
p = []*eskip.Predicate{{
Name: source.NameLast,
Name: predicates.SourceFromLastName,
Args: internalIPs,
}}
} else {
p = []*eskip.Predicate{{
Name: source.Name,
Name: predicates.SourceName,
Args: internalIPs,
}}
}
Expand Down
10 changes: 5 additions & 5 deletions dataclients/kubernetes/kube_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ import (

"github.com/zalando/skipper/dataclients/kubernetes/definitions"
"github.com/zalando/skipper/eskip"
"github.com/zalando/skipper/filters/builtin"
"github.com/zalando/skipper/predicates/source"
"github.com/zalando/skipper/filters"
"github.com/zalando/skipper/predicates"
)

type testAPI struct {
Expand Down Expand Up @@ -364,10 +364,10 @@ func checkHealthcheck(t *testing.T, got []*eskip.Route, expected, healthy, rever

var found bool
for _, p := range r.Predicates {
if reversed && p.Name != source.NameLast {
if reversed && p.Name != predicates.SourceFromLastName {
continue
}
if !reversed && p.Name != source.Name {
if !reversed && p.Name != predicates.SourceName {
continue
}

Expand Down Expand Up @@ -398,7 +398,7 @@ func checkHealthcheck(t *testing.T, got []*eskip.Route, expected, healthy, rever
}

for _, f := range r.Filters {
if f.Name != builtin.StatusName {
if f.Name != filters.StatusName {
continue
}

Expand Down
6 changes: 3 additions & 3 deletions dataclients/kubernetes/redirect.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
log "github.com/sirupsen/logrus"
"github.com/zalando/skipper/dataclients/kubernetes/definitions"
"github.com/zalando/skipper/eskip"
"github.com/zalando/skipper/routing"
"github.com/zalando/skipper/predicates"
)

const (
Expand Down Expand Up @@ -91,7 +91,7 @@ func initRedirectRoute(r *eskip.Route, code int) {

// Give this route a higher weight so that it will get precedence over existing routes
r.Predicates = append([]*eskip.Predicate{{
Name: routing.WeightPredicateName,
Name: predicates.WeightName,
Args: []interface{}{float64(1000)},
}}, r.Predicates...)

Expand All @@ -112,7 +112,7 @@ func initDisableRedirectRoute(r *eskip.Route) {

// Give this route a higher weight so that it will get precedence over existing routes
r.Predicates = append([]*eskip.Predicate{{
Name: routing.WeightPredicateName,
Name: predicates.WeightName,
Args: []interface{}{float64(1000)},
}}, r.Predicates...)
}
Expand Down
12 changes: 6 additions & 6 deletions filters/accesslog/control.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ package accesslog
import "github.com/zalando/skipper/filters"

const (
// DisableAccessLogName is the filter name seen by the user
DisableAccessLogName = "disableAccessLog"
// Deprecated, use filters.DisableAccessLogName instead
DisableAccessLogName = filters.DisableAccessLogName

// EnableAccessLogName is the filter name seen by the user
EnableAccessLogName = "enableAccessLog"
// Deprecated, use filters.EnableAccessLogName instead
EnableAccessLogName = filters.EnableAccessLogName

// AccessLogEnabledKey is the key used in the state bag to pass the access log state to the proxy.
AccessLogEnabledKey = "statebag:access_log:proxy:enabled"
Expand Down Expand Up @@ -64,7 +64,7 @@ func NewDisableAccessLog() filters.Spec {
return &disableAccessLog{}
}

func (*disableAccessLog) Name() string { return DisableAccessLogName }
func (*disableAccessLog) Name() string { return filters.DisableAccessLogName }

func (al *disableAccessLog) CreateFilter(args []interface{}) (filters.Filter, error) {
return extractFilterValues(args, false)
Expand All @@ -82,7 +82,7 @@ func NewEnableAccessLog() filters.Spec {
return &enableAccessLog{}
}

func (*enableAccessLog) Name() string { return EnableAccessLogName }
func (*enableAccessLog) Name() string { return filters.EnableAccessLogName }

func (al *enableAccessLog) CreateFilter(args []interface{}) (filters.Filter, error) {
return extractFilterValues(args, true)
Expand Down
2 changes: 1 addition & 1 deletion filters/accesslog/disable.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
)

const (
// AccessLogDisabledName is the filter name seen by the user
// Deprecated: use DisableAccessLogName or EnableAccessLogName
AccessLogDisabledName = "accessLogDisabled"
)

Expand Down
2 changes: 1 addition & 1 deletion filters/apiusagemonitoring/filter.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const (
)

const (
stateBagKey = "filter." + Name
stateBagKey = "filter." + filters.ApiUsageMonitoringName
)

const (
Expand Down
2 changes: 1 addition & 1 deletion filters/apiusagemonitoring/noop.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ type noopSpec struct {
}

func (*noopSpec) Name() string {
return Name
return filters.ApiUsageMonitoringName
}

func (s *noopSpec) CreateFilter(config []interface{}) (filters.Filter, error) {
Expand Down
9 changes: 5 additions & 4 deletions filters/apiusagemonitoring/spec.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,16 @@ import (
)

const (
Name = "apiUsageMonitoring"
// Deprecated, use filters.ApiUsageMonitoringName instead
Name = filters.ApiUsageMonitoringName

unknownPlaceholder = "{unknown}"
noMatchPlaceholder = "{no-match}"
noTagPlaceholder = "{no-tag}"
)

var (
log = logrus.WithField("filter", Name)
log = logrus.WithField("filter", filters.ApiUsageMonitoringName)
regCache = sync.Map{}
)

Expand All @@ -47,7 +48,7 @@ func NewApiUsageMonitoring(
realmsTrackingPattern string,
) filters.Spec {
if !enabled {
log.Debugf("filter %q is not enabled. spec returns `noop` filters.", Name)
log.Debugf("filter %q is not enabled. spec returns `noop` filters.", filters.ApiUsageMonitoringName)
return &noopSpec{&noopFilter{}}
}

Expand Down Expand Up @@ -122,7 +123,7 @@ type apiUsageMonitoringSpec struct {
}

func (s *apiUsageMonitoringSpec) Name() string {
return Name
return filters.ApiUsageMonitoringName
}

func (s *apiUsageMonitoringSpec) CreateFilter(args []interface{}) (filter filters.Filter, err error) {
Expand Down
6 changes: 4 additions & 2 deletions filters/auth/basic.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ import (
)

const (
Name = "basicAuth"
// Deprecated, use filters.BasicAuthName instead
Name = filters.BasicAuthName

ForceBasicAuthHeaderName = "WWW-Authenticate"
ForceBasicAuthHeaderValue = "Basic realm="
DefaultRealmName = "Basic Realm"
Expand Down Expand Up @@ -72,4 +74,4 @@ func (spec *basicSpec) CreateFilter(config []interface{}) (filters.Filter, error
}, nil
}

func (spec *basicSpec) Name() string { return Name }
func (spec *basicSpec) Name() string { return filters.BasicAuthName }
5 changes: 3 additions & 2 deletions filters/auth/bearer.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import (
)

const (
BearerInjectorName = "bearerinjector"
// Deprecated, use filters.BearerInjectorName instead
BearerInjectorName = filters.BearerInjectorName
)

type (
Expand All @@ -26,7 +27,7 @@ func NewBearerInjector(sr secrets.SecretsReader) filters.Spec {
}

func (*bearerInjectorSpec) Name() string {
return BearerInjectorName
return filters.BearerInjectorName
}

func (b *bearerInjectorSpec) CreateFilter(args []interface{}) (filters.Filter, error) {
Expand Down
4 changes: 2 additions & 2 deletions filters/auth/bearer_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ import (

func Test_bearerInjectorSpec_Name(t *testing.T) {
b := &bearerInjectorSpec{}
if got := b.Name(); got != BearerInjectorName {
t.Errorf("bearerInjectorSpec.Name() = %v, want %v", got, BearerInjectorName)
if got := b.Name(); got != filters.BearerInjectorName {
t.Errorf("bearerInjectorSpec.Name() = %v, want %v", got, filters.BearerInjectorName)
}
}

Expand Down
5 changes: 3 additions & 2 deletions filters/auth/forwardtoken.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ import (
)

const (
ForwardTokenName = "forwardToken"
// Deprecated, use filters.ForwardTokenName instead
ForwardTokenName = filters.ForwardTokenName
)

type (
Expand All @@ -28,7 +29,7 @@ func NewForwardToken() filters.Spec {
}

func (s *forwardTokenSpec) Name() string {
return ForwardTokenName
return filters.ForwardTokenName
}

func (*forwardTokenSpec) CreateFilter(args []interface{}) (filters.Filter, error) {
Expand Down
5 changes: 3 additions & 2 deletions filters/auth/grant.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ import (
)

const (
OAuthGrantName = "oauthGrant"
// Deprecated, use filters.OAuthGrantName instead
OAuthGrantName = filters.OAuthGrantName

secretsRefreshInternal = time.Minute
tokenWasRefreshed = "oauth-did-refresh"
Expand All @@ -31,7 +32,7 @@ type grantFilter struct {
config OAuthConfig
}

func (s *grantSpec) Name() string { return OAuthGrantName }
func (s *grantSpec) Name() string { return filters.OAuthGrantName }

func (s *grantSpec) CreateFilter([]interface{}) (filters.Filter, error) {
return &grantFilter{
Expand Down
5 changes: 3 additions & 2 deletions filters/auth/grant_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"time"

"github.com/zalando/skipper/eskip"
"github.com/zalando/skipper/filters"
"github.com/zalando/skipper/filters/auth"
"github.com/zalando/skipper/filters/builtin"
"github.com/zalando/skipper/proxy/proxytest"
Expand Down Expand Up @@ -178,8 +179,8 @@ func newAuthProxy(config *auth.OAuthConfig, routes ...*eskip.Route) (*proxytest.
func newSimpleGrantAuthProxy(t *testing.T, config *auth.OAuthConfig) *proxytest.TestProxy {
proxy, err := newAuthProxy(config, &eskip.Route{
Filters: []*eskip.Filter{
{Name: auth.OAuthGrantName},
{Name: "status", Args: []interface{}{http.StatusNoContent}},
{Name: filters.OAuthGrantName},
{Name: filters.StatusName, Args: []interface{}{http.StatusNoContent}},
},
BackendType: eskip.ShuntBackend,
})
Expand Down
6 changes: 4 additions & 2 deletions filters/auth/grantcallback.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ import (
"golang.org/x/oauth2"
)

const GrantCallbackName = "grantCallback"
// GrantCallbackName is the filter name
// Deprecated, use filters.GrantCallbackName instead
const GrantCallbackName = filters.GrantCallbackName

type grantCallbackSpec struct {
config OAuthConfig
Expand All @@ -18,7 +20,7 @@ type grantCallbackFilter struct {
config OAuthConfig
}

func (*grantCallbackSpec) Name() string { return GrantCallbackName }
func (*grantCallbackSpec) Name() string { return filters.GrantCallbackName }

func (s *grantCallbackSpec) CreateFilter([]interface{}) (filters.Filter, error) {
return &grantCallbackFilter{
Expand Down
6 changes: 4 additions & 2 deletions filters/auth/grantclaimsquery.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,16 @@ package auth

import "github.com/zalando/skipper/filters"

const GrantClaimsQueryName = "grantClaimsQuery"
// GrantClaimsQueryName is the filter name
// Deprecated, use filters.GrantClaimsQueryName instead
const GrantClaimsQueryName = filters.GrantClaimsQueryName

type grantClaimsQuerySpec struct {
oidcSpec oidcIntrospectionSpec
}

func (s *grantClaimsQuerySpec) Name() string {
return GrantClaimsQueryName
return filters.GrantClaimsQueryName
}

func (s *grantClaimsQuerySpec) CreateFilter(args []interface{}) (filters.Filter, error) {
Expand Down
Loading