Skip to content

Commit

Permalink
chore: rename TranslateXXNotStrictly to GenerateXXDeleteMark (#1490)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ronething
ronething authored Dec 30, 2022
1 parent b62be90 commit 486b46a
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 40 deletions.
4 changes: 2 additions & 2 deletions pkg/providers/apisix/apisix_plugin_config.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ func (c *apisixPluginConfigController) sync(ctx context.Context, ev *types.Event
if ev.Type != types.EventDelete {
tctx, err = c.translator.TranslatePluginConfigV2beta3(apc.V2beta3())
} else {
tctx, err = c.translator.TranslatePluginConfigV2beta3NotStrictly(apc.V2beta3())
tctx, err = c.translator.GeneratePluginConfigV2beta3DeleteMark(apc.V2beta3())
}
if err != nil {
log.Errorw("failed to translate ApisixPluginConfig v2beta3",
Expand All @@ -153,7 +153,7 @@ func (c *apisixPluginConfigController) sync(ctx context.Context, ev *types.Event
if ev.Type != types.EventDelete {
tctx, err = c.translator.TranslatePluginConfigV2(apc.V2())
} else {
tctx, err = c.translator.TranslatePluginConfigV2NotStrictly(apc.V2())
tctx, err = c.translator.GeneratePluginConfigV2DeleteMark(apc.V2())
}
if err != nil {
log.Errorw("failed to translate ApisixPluginConfig v2",
Expand Down
4 changes: 2 additions & 2 deletions pkg/providers/apisix/apisix_route.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,7 @@ func (c *apisixRouteController) sync(ctx context.Context, ev *types.Event) error
tctx, err = c.translator.TranslateRouteV2beta3(ar.V2beta3())
}
} else {
tctx, err = c.translator.TranslateRouteV2beta3NotStrictly(ar.V2beta3())
tctx, err = c.translator.GenerateRouteV2beta3DeleteMark(ar.V2beta3())
}
if err != nil {
log.Errorw("failed to translate ApisixRoute v2beta3",
Expand All @@ -357,7 +357,7 @@ func (c *apisixRouteController) sync(ctx context.Context, ev *types.Event) error
tctx, err = c.translator.TranslateRouteV2(ar.V2())
}
} else {
tctx, err = c.translator.TranslateRouteV2NotStrictly(ar.V2())
tctx, err = c.translator.GenerateRouteV2DeleteMark(ar.V2())
}
if err != nil {
log.Errorw("failed to translate ApisixRoute v2",
Expand Down
4 changes: 2 additions & 2 deletions pkg/providers/apisix/provider_init.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ func (p *apisixProvider) Init(ctx context.Context) error {
ctx.Done()
} else {
for _, r := range retRoutes {
tc, err := p.apisixTranslator.TranslateRouteV2beta3NotStrictly(r)
tc, err := p.apisixTranslator.GenerateRouteV2beta3DeleteMark(r)
if err != nil {
log.Error(err.Error())
ctx.Done()
Expand Down Expand Up @@ -99,7 +99,7 @@ func (p *apisixProvider) Init(ctx context.Context) error {
ctx.Done()
} else {
for _, r := range retRoutes {
tc, err := p.apisixTranslator.TranslateRouteV2NotStrictly(r)
tc, err := p.apisixTranslator.GenerateRouteV2DeleteMark(r)
if err != nil {
log.Error(err.Error())
ctx.Done()
Expand Down
4 changes: 2 additions & 2 deletions pkg/providers/apisix/translation/apisix_pluginconfig.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ func (t *translator) TranslatePluginConfigV2beta3(config *configv2beta3.ApisixPl
return ctx, nil
}

func (t *translator) TranslatePluginConfigV2beta3NotStrictly(config *configv2beta3.ApisixPluginConfig) (*translation.TranslateContext, error) {
func (t *translator) GeneratePluginConfigV2beta3DeleteMark(config *configv2beta3.ApisixPluginConfig) (*translation.TranslateContext, error) {
ctx := translation.DefaultEmptyTranslateContext()
pc := apisixv1.NewDefaultPluginConfig()
pc.Name = apisixv1.ComposePluginConfigName(config.Namespace, config.Name)
Expand Down Expand Up @@ -111,7 +111,7 @@ func (t *translator) TranslatePluginConfigV2(config *configv2.ApisixPluginConfig
return ctx, nil
}

func (t *translator) TranslatePluginConfigV2NotStrictly(config *configv2.ApisixPluginConfig) (*translation.TranslateContext, error) {
func (t *translator) GeneratePluginConfigV2DeleteMark(config *configv2.ApisixPluginConfig) (*translation.TranslateContext, error) {
ctx := translation.DefaultEmptyTranslateContext()
pc := apisixv1.NewDefaultPluginConfig()
pc.Name = apisixv1.ComposePluginConfigName(config.Namespace, config.Name)
Expand Down
4 changes: 2 additions & 2 deletions pkg/providers/apisix/translation/apisix_pluginconfig_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func TestTranslatePluginConfigV2beta3(t *testing.T) {
assert.Len(t, ctx.PluginConfigs[0].Plugins, 2)
}

func TestTranslatePluginConfigV2beta3NotStrictly(t *testing.T) {
func TestGeneratePluginConfigV2beta3DeleteMark(t *testing.T) {
apc := &configv2beta3.ApisixPluginConfig{
ObjectMeta: metav1.ObjectMeta{
Name: "apc",
Expand Down Expand Up @@ -107,7 +107,7 @@ func TestTranslatePluginConfigV2beta3NotStrictly(t *testing.T) {
},
}
trans := &translator{}
ctx, err := trans.TranslatePluginConfigV2beta3NotStrictly(apc)
ctx, err := trans.GeneratePluginConfigV2beta3DeleteMark(apc)
assert.NoError(t, err)
assert.Len(t, ctx.PluginConfigs, 1)
assert.Len(t, ctx.PluginConfigs[0].Plugins, 0)
Expand Down
36 changes: 18 additions & 18 deletions pkg/providers/apisix/translation/apisix_route.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,13 @@ func (t *translator) TranslateRouteV2beta3(ar *configv2beta3.ApisixRoute) (*tran
return ctx, nil
}

func (t *translator) TranslateRouteV2beta3NotStrictly(ar *configv2beta3.ApisixRoute) (*translation.TranslateContext, error) {
func (t *translator) GenerateRouteV2beta3DeleteMark(ar *configv2beta3.ApisixRoute) (*translation.TranslateContext, error) {
ctx := translation.DefaultEmptyTranslateContext()

if err := t.translateHTTPRouteV2beta3NotStrictly(ctx, ar); err != nil {
if err := t.generateHTTPRouteV2beta3DeleteMark(ctx, ar); err != nil {
return nil, err
}
if err := t.translateStreamRouteNotStrictlyV2beta3(ctx, ar); err != nil {
if err := t.generateStreamRouteDeleteMarkV2beta3(ctx, ar); err != nil {
return nil, err
}
return ctx, nil
Expand All @@ -71,13 +71,13 @@ func (t *translator) TranslateRouteV2(ar *configv2.ApisixRoute) (*translation.Tr
return ctx, nil
}

func (t *translator) TranslateRouteV2NotStrictly(ar *configv2.ApisixRoute) (*translation.TranslateContext, error) {
func (t *translator) GenerateRouteV2DeleteMark(ar *configv2.ApisixRoute) (*translation.TranslateContext, error) {
ctx := translation.DefaultEmptyTranslateContext()

if err := t.translateHTTPRouteV2NotStrictly(ctx, ar); err != nil {
if err := t.generateHTTPRouteV2DeleteMark(ctx, ar); err != nil {
return nil, err
}
if err := t.translateStreamRouteNotStrictlyV2(ctx, ar); err != nil {
if err := t.generateStreamRouteDeleteMarkV2(ctx, ar); err != nil {
return nil, err
}
return ctx, nil
Expand Down Expand Up @@ -579,8 +579,8 @@ func (t *translator) TranslateRouteMatchExprs(nginxVars []configv2.ApisixRouteHT
return vars, nil
}

// translateHTTPRouteV2beta3NotStrictly translates http route with a loose way, only generate ID and Name for delete Event.
func (t *translator) translateHTTPRouteV2beta3NotStrictly(ctx *translation.TranslateContext, ar *configv2beta3.ApisixRoute) error {
// generateHTTPRouteV2beta3DeleteMark translates http route with a loose way, only generate ID and Name for delete Event.
func (t *translator) generateHTTPRouteV2beta3DeleteMark(ctx *translation.TranslateContext, ar *configv2beta3.ApisixRoute) error {
for _, part := range ar.Spec.HTTP {
backends := part.Backends
// Use the first backend as the default backend in Route,
Expand Down Expand Up @@ -628,7 +628,7 @@ func (t *translator) translateHTTPRouteV2beta3NotStrictly(ctx *translation.Trans

ctx.AddRoute(route)
if !ctx.CheckUpstreamExist(upstreamName) {
ups, err := t.translateUpstreamNotStrictly(ar.Namespace, backend.ServiceName, backend.Subset, backend.ServicePort.IntVal, backend.ResolveGranularity)
ups, err := t.generateUpstreamDeleteMark(ar.Namespace, backend.ServiceName, backend.Subset, backend.ServicePort.IntVal, backend.ResolveGranularity)
if err != nil {
return err
}
Expand All @@ -638,8 +638,8 @@ func (t *translator) translateHTTPRouteV2beta3NotStrictly(ctx *translation.Trans
return nil
}

// translateHTTPRouteV2NotStrictly translates http route with a loose way, only generate ID and Name for delete Event.
func (t *translator) translateHTTPRouteV2NotStrictly(ctx *translation.TranslateContext, ar *configv2.ApisixRoute) error {
// generateHTTPRouteV2DeleteMark translates http route with a loose way, only generate ID and Name for delete Event.
func (t *translator) generateHTTPRouteV2DeleteMark(ctx *translation.TranslateContext, ar *configv2.ApisixRoute) error {
for _, part := range ar.Spec.HTTP {
pluginMap := make(apisixv1.Plugins)
// add route plugins
Expand Down Expand Up @@ -689,7 +689,7 @@ func (t *translator) translateHTTPRouteV2NotStrictly(ctx *translation.TranslateC

upstreamName := apisixv1.ComposeUpstreamName(ar.Namespace, backend.ServiceName, backend.Subset, backend.ServicePort.IntVal, backend.ResolveGranularity)
if !ctx.CheckUpstreamExist(upstreamName) {
ups, err := t.translateUpstreamNotStrictly(ar.Namespace, backend.ServiceName, backend.Subset, backend.ServicePort.IntVal, backend.ResolveGranularity)
ups, err := t.generateUpstreamDeleteMark(ar.Namespace, backend.ServiceName, backend.Subset, backend.ServicePort.IntVal, backend.ResolveGranularity)
if err != nil {
return err
}
Expand Down Expand Up @@ -813,15 +813,15 @@ func (t *translator) translateStreamRouteV2(ctx *translation.TranslateContext, a
return nil
}

// translateStreamRouteNotStrictlyV2beta3 translates tcp route with a loose way, only generate ID and Name for delete Event.
func (t *translator) translateStreamRouteNotStrictlyV2beta3(ctx *translation.TranslateContext, ar *configv2beta3.ApisixRoute) error {
// generateStreamRouteDeleteMarkV2beta3 translates tcp route with a loose way, only generate ID and Name for delete Event.
func (t *translator) generateStreamRouteDeleteMarkV2beta3(ctx *translation.TranslateContext, ar *configv2beta3.ApisixRoute) error {
for _, part := range ar.Spec.Stream {
backend := &part.Backend
sr := apisixv1.NewDefaultStreamRoute()
name := apisixv1.ComposeStreamRouteName(ar.Namespace, ar.Name, part.Name)
sr.ID = id.GenID(name)
sr.ServerPort = part.Match.IngressPort
ups, err := t.translateUpstreamNotStrictly(ar.Namespace, backend.ServiceName, backend.Subset, backend.ServicePort.IntVal, backend.ResolveGranularity)
ups, err := t.generateUpstreamDeleteMark(ar.Namespace, backend.ServiceName, backend.Subset, backend.ServicePort.IntVal, backend.ResolveGranularity)
if err != nil {
return err
}
Expand All @@ -834,16 +834,16 @@ func (t *translator) translateStreamRouteNotStrictlyV2beta3(ctx *translation.Tra
return nil
}

// translateStreamRouteNotStrictlyV2 translates tcp route with a loose way, only generate ID and Name for delete Event.
func (t *translator) translateStreamRouteNotStrictlyV2(ctx *translation.TranslateContext, ar *configv2.ApisixRoute) error {
// generateStreamRouteDeleteMarkV2 translates tcp route with a loose way, only generate ID and Name for delete Event.
func (t *translator) generateStreamRouteDeleteMarkV2(ctx *translation.TranslateContext, ar *configv2.ApisixRoute) error {
for _, part := range ar.Spec.Stream {
backend := &part.Backend
sr := apisixv1.NewDefaultStreamRoute()
name := apisixv1.ComposeStreamRouteName(ar.Namespace, ar.Name, part.Name)
sr.ID = id.GenID(name)
sr.ServerPort = part.Match.IngressPort
sr.SNI = part.Match.Host
ups, err := t.translateUpstreamNotStrictly(ar.Namespace, backend.ServiceName, backend.Subset, backend.ServicePort.IntVal, backend.ResolveGranularity)
ups, err := t.generateUpstreamDeleteMark(ar.Namespace, backend.ServiceName, backend.Subset, backend.ServicePort.IntVal, backend.ResolveGranularity)
if err != nil {
return err
}
Expand Down
4 changes: 2 additions & 2 deletions pkg/providers/apisix/translation/apisix_route_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -419,7 +419,7 @@ func TestTranslateApisixRouteV2beta3WithEmptyPluginConfigName(t *testing.T) {
assert.Equal(t, "", res.Routes[2].PluginConfigId)
}

func TestTranslateApisixRouteV2beta3NotStrictly(t *testing.T) {
func TestGenerateApisixRouteV2beta3DeleteMark(t *testing.T) {
tr := &translator{
&TranslatorOptions{},
translation.NewTranslator(nil),
Expand Down Expand Up @@ -478,7 +478,7 @@ func TestTranslateApisixRouteV2beta3NotStrictly(t *testing.T) {
},
}

tx, err := tr.TranslateRouteV2beta3NotStrictly(ar)
tx, err := tr.GenerateRouteV2beta3DeleteMark(ar)
fmt.Println(tx)
assert.NoError(t, err, "translateRoute not strictly should be no error")
assert.Equal(t, 2, len(tx.Routes), "There should be 2 routes")
Expand Down
4 changes: 2 additions & 2 deletions pkg/providers/apisix/translation/apisix_upstream.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ import (
apisixv1 "github.com/apache/apisix-ingress-controller/pkg/types/apisix/v1"
)

// translateUpstreamNotStrictly translates Upstream nodes with a loose way, only generate ID and Name for delete Event.
func (t *translator) translateUpstreamNotStrictly(namespace, svcName, subset string, svcPort int32, resolveGranularity string) (*apisixv1.Upstream, error) {
// generateUpstreamDeleteMark translates Upstream nodes with a loose way, only generate ID and Name for delete Event.
func (t *translator) generateUpstreamDeleteMark(namespace, svcName, subset string, svcPort int32, resolveGranularity string) (*apisixv1.Upstream, error) {
ups := &apisixv1.Upstream{}
ups.Name = apisixv1.ComposeUpstreamName(namespace, svcName, subset, svcPort, resolveGranularity)
ups.ID = id.GenID(ups.Name)
Expand Down
16 changes: 8 additions & 8 deletions pkg/providers/apisix/translation/translator.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,15 @@ type ApisixTranslator interface {
// TranslateRouteV2beta3 translates the configv2beta3.ApisixRoute object into several Route,
// Upstream and PluginConfig resources.
TranslateRouteV2beta3(*configv2beta3.ApisixRoute) (*translation.TranslateContext, error)
// TranslateRouteV2beta3NotStrictly translates the configv2beta3.ApisixRoute object into several Route,
// GenerateRouteV2beta3DeleteMark translates the configv2beta3.ApisixRoute object into several Route,
// Upstream and PluginConfig resources not strictly, only used for delete event.
TranslateRouteV2beta3NotStrictly(*configv2beta3.ApisixRoute) (*translation.TranslateContext, error)
GenerateRouteV2beta3DeleteMark(*configv2beta3.ApisixRoute) (*translation.TranslateContext, error)
// TranslateRouteV2 translates the configv2.ApisixRoute object into several Route,
// Upstream and PluginConfig resources.
TranslateRouteV2(*configv2.ApisixRoute) (*translation.TranslateContext, error)
// TranslateRouteV2NotStrictly translates the configv2.ApisixRoute object into several Route,
// GenerateRouteV2DeleteMark translates the configv2.ApisixRoute object into several Route,
// Upstream and PluginConfig resources not strictly, only used for delete event.
TranslateRouteV2NotStrictly(*configv2.ApisixRoute) (*translation.TranslateContext, error)
GenerateRouteV2DeleteMark(*configv2.ApisixRoute) (*translation.TranslateContext, error)
// TranslateOldRoute get route and stream_route objects from cache
// Build upstream and plugin_config through route and stream_route
TranslateOldRoute(kube.ApisixRoute) (*translation.TranslateContext, error)
Expand All @@ -78,15 +78,15 @@ type ApisixTranslator interface {
// TranslatePluginConfigV2beta3 translates the configv2.ApisixPluginConfig object into several PluginConfig
// resources.
TranslatePluginConfigV2beta3(*configv2beta3.ApisixPluginConfig) (*translation.TranslateContext, error)
// TranslatePluginConfigV2beta3NotStrictly translates the configv2beta3.ApisixPluginConfig object into several PluginConfig
// GeneratePluginConfigV2beta3DeleteMark translates the configv2beta3.ApisixPluginConfig object into several PluginConfig
// resources not strictly, only used for delete event.
TranslatePluginConfigV2beta3NotStrictly(*configv2beta3.ApisixPluginConfig) (*translation.TranslateContext, error)
GeneratePluginConfigV2beta3DeleteMark(*configv2beta3.ApisixPluginConfig) (*translation.TranslateContext, error)
// TranslatePluginConfigV2 translates the configv2.ApisixPluginConfig object into several PluginConfig
// resources.
TranslatePluginConfigV2(*configv2.ApisixPluginConfig) (*translation.TranslateContext, error)
// TranslatePluginConfigV2NotStrictly translates the configv2.ApisixPluginConfig object into several PluginConfig
// GeneratePluginConfigV2DeleteMark translates the configv2.ApisixPluginConfig object into several PluginConfig
// resources not strictly, only used for delete event.
TranslatePluginConfigV2NotStrictly(*configv2.ApisixPluginConfig) (*translation.TranslateContext, error)
GeneratePluginConfigV2DeleteMark(*configv2.ApisixPluginConfig) (*translation.TranslateContext, error)

TranslateRouteMatchExprs(nginxVars []configv2.ApisixRouteHTTPMatchExpr) ([][]apisixv1.StringOrSlice, error)

Expand Down

0 comments on commit 486b46a

Please sign in to comment.