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

refactor the opt #157

Closed
wants to merge 2 commits into from
Closed
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 controllers/workflowrun_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ import (
"reflect"
"time"

"github.com/kubevela/workflow/pkg/opt"

"github.com/crossplane/crossplane-runtime/pkg/event"
"github.com/pkg/errors"
kerrors "k8s.io/apimachinery/pkg/api/errors"
Expand Down Expand Up @@ -127,11 +129,8 @@ func (r *WorkflowRunReconciler) Reconcile(ctx context.Context, req ctrl.Request)
return r.endWithNegativeCondition(logCtx, run, condition.ErrorCondition(v1alpha1.WorkflowRunConditionType, err))
}
isUpdate := instance.Status.Message != ""
runners, err := generator.GenerateRunners(logCtx, instance, opt.NewStepGeneratorOptions(r.Client, instance, opt.WithPackageDiscover(r.PackageDiscover)))

runners, err := generator.GenerateRunners(logCtx, instance, types.StepGeneratorOptions{
PackageDiscover: r.PackageDiscover,
Client: r.Client,
})
if err != nil {
logCtx.Error(err, "[generate runners]")
r.Recorder.Event(run, event.Warning(v1alpha1.ReasonGenerate, errors.WithMessage(err, v1alpha1.MessageFailedGenerate)))
Expand Down
38 changes: 0 additions & 38 deletions pkg/generator/generator.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,28 +21,18 @@ import (
"encoding/json"
"errors"

metrics2 "github.com/kubevela/workflow/pkg/providers/metrics"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/utils/pointer"
"sigs.k8s.io/controller-runtime/pkg/client"

monitorContext "github.com/kubevela/pkg/monitor/context"
"github.com/kubevela/pkg/util/rand"

"github.com/oam-dev/kubevela/pkg/config/provider"

"github.com/kubevela/workflow/api/v1alpha1"
"github.com/kubevela/workflow/pkg/cue/process"
"github.com/kubevela/workflow/pkg/executor"
"github.com/kubevela/workflow/pkg/monitor/metrics"
"github.com/kubevela/workflow/pkg/providers"
"github.com/kubevela/workflow/pkg/providers/email"
"github.com/kubevela/workflow/pkg/providers/http"
"github.com/kubevela/workflow/pkg/providers/kube"
"github.com/kubevela/workflow/pkg/providers/util"
"github.com/kubevela/workflow/pkg/providers/workspace"
"github.com/kubevela/workflow/pkg/tasks"
"github.com/kubevela/workflow/pkg/tasks/template"
"github.com/kubevela/workflow/pkg/types"
)

Expand All @@ -53,7 +43,6 @@ func GenerateRunners(ctx monitorContext.Context, instance *types.WorkflowInstanc
metrics.GenerateTaskRunnersDurationHistogram.WithLabelValues("workflowrun").Observe(v)
}))
defer subCtx.Commit("finish generate task runners")
options = initStepGeneratorOptions(ctx, instance, options)
taskDiscover := tasks.NewTaskDiscover(ctx, options)
var tasks []types.TaskRunner
for _, step := range instance.Steps {
Expand Down Expand Up @@ -141,33 +130,6 @@ func GenerateWorkflowInstance(ctx context.Context, cli client.Client, run *v1alp
return instance, nil
}

func initStepGeneratorOptions(ctx monitorContext.Context, instance *types.WorkflowInstance, options types.StepGeneratorOptions) types.StepGeneratorOptions {
if options.Providers == nil {
options.Providers = providers.NewProviders()
}
if options.ProcessCtx == nil {
options.ProcessCtx = process.NewContext(generateContextDataFromWorkflowRun(instance))
}
installBuiltinProviders(instance, options.Client, options.Providers, options.ProcessCtx)
if options.TemplateLoader == nil {
options.TemplateLoader = template.NewWorkflowStepTemplateLoader(options.Client)
}
return options
}

func installBuiltinProviders(instance *types.WorkflowInstance, client client.Client, providerHandlers types.Providers, pCtx process.Context) {
workspace.Install(providerHandlers, pCtx)
email.Install(providerHandlers)
util.Install(providerHandlers, pCtx)
http.Install(providerHandlers, client, instance.Namespace)
provider.Install(providerHandlers, client, nil)
metrics2.Install(providerHandlers)
kube.Install(providerHandlers, client, map[string]string{
types.LabelWorkflowRunName: instance.Name,
types.LabelWorkflowRunNamespace: instance.Namespace,
}, nil)
}

func generateTaskRunner(ctx context.Context,
instance *types.WorkflowInstance,
step v1alpha1.WorkflowStep,
Expand Down
7 changes: 4 additions & 3 deletions pkg/generator/generator_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ import (
"strconv"
"time"

"github.com/kubevela/workflow/pkg/opt"

. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
corev1 "k8s.io/api/core/v1"
Expand All @@ -29,7 +31,6 @@ import (
monitorContext "github.com/kubevela/pkg/monitor/context"

"github.com/kubevela/workflow/api/v1alpha1"
"github.com/kubevela/workflow/pkg/types"
)

var _ = Describe("Test workflow step runner generator", func() {
Expand Down Expand Up @@ -86,7 +87,7 @@ var _ = Describe("Test workflow step runner generator", func() {
instance, err := GenerateWorkflowInstance(ctx, k8sClient, wr)
Expect(err).Should(BeNil())
ctx := monitorContext.NewTraceContext(ctx, "test-wr")
runners, err := GenerateRunners(ctx, instance, types.StepGeneratorOptions{Client: k8sClient})
runners, err := GenerateRunners(ctx, instance, opt.NewStepGeneratorOptions(k8sClient, instance))
Expect(err).Should(BeNil())
Expect(len(runners)).Should(BeEquivalentTo(1))
Expect(runners[0].Name()).Should(BeEquivalentTo("step-1"))
Expand Down Expand Up @@ -128,7 +129,7 @@ var _ = Describe("Test workflow step runner generator", func() {
ctx := monitorContext.NewTraceContext(ctx, "test-wr-sub")
instance, err := GenerateWorkflowInstance(ctx, k8sClient, wr)
Expect(err).Should(BeNil())
runners, err := GenerateRunners(ctx, instance, types.StepGeneratorOptions{Client: k8sClient})
runners, err := GenerateRunners(ctx, instance, opt.NewStepGeneratorOptions(k8sClient, instance))
Expect(err).Should(BeNil())
Expect(len(runners)).Should(BeEquivalentTo(1))
Expect(runners[0].Name()).Should(BeEquivalentTo("step-1"))
Expand Down
111 changes: 111 additions & 0 deletions pkg/opt/opt.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
package opt

import (
"github.com/kubevela/workflow/api/v1alpha1"
"github.com/kubevela/workflow/pkg/cue/packages"
"github.com/kubevela/workflow/pkg/cue/process"
"github.com/kubevela/workflow/pkg/providers"
"github.com/kubevela/workflow/pkg/providers/email"
"github.com/kubevela/workflow/pkg/providers/http"
"github.com/kubevela/workflow/pkg/providers/kube"
metrics2 "github.com/kubevela/workflow/pkg/providers/metrics"
"github.com/kubevela/workflow/pkg/providers/util"
"github.com/kubevela/workflow/pkg/providers/workspace"
"github.com/kubevela/workflow/pkg/tasks/template"
"github.com/kubevela/workflow/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"

"github.com/oam-dev/kubevela/pkg/config/provider"
)

type Option func(options *StepGeneratorOptions)

// StepGeneratorOptions is the options for generate step.
type StepGeneratorOptions struct {
providers types.Providers
packageDiscover *packages.PackageDiscover
processCtx process.Context
templateLoader template.Loader
client client.Client
stepConvertor map[string]func(step v1alpha1.WorkflowStep) (v1alpha1.WorkflowStep, error)
logLevel int
}

func NewStepGeneratorOptions(client client.Client, instance *types.WorkflowInstance, opts ...Option) types.StepGeneratorOptions {
o := StepGeneratorOptions{
client: client,
providers: providers.NewProviders(),
templateLoader: template.NewWorkflowStepTemplateLoader(client),
logLevel: 3,
}
for _, opt := range opts {
opt(&o)
}

installBuiltinProviders(instance, client, o.providers, o.processCtx)

return types.StepGeneratorOptions{
Providers: o.providers,
PackageDiscover: o.packageDiscover,
ProcessCtx: o.processCtx,
TemplateLoader: o.templateLoader,
Client: o.client,
StepConvertor: o.stepConvertor,
LogLevel: o.logLevel,
}
}

func WithProviders(providers types.Providers) Option {
return func(o *StepGeneratorOptions) {
o.providers = providers
}
}

func WithPackageDiscover(discover *packages.PackageDiscover) Option {
return func(o *StepGeneratorOptions) {
o.packageDiscover = discover
}
}

func WithProcessCtx(ctx process.Context) Option {
return func(o *StepGeneratorOptions) {
o.processCtx = ctx
}
}

func WithTemplateLoader(loader template.Loader) Option {
return func(o *StepGeneratorOptions) {
o.templateLoader = loader
}
}

func WithClient(c client.Client) Option {
return func(o *StepGeneratorOptions) {
o.client = c
}
}

func WithStepConvertor(convertor map[string]func(step v1alpha1.WorkflowStep) (v1alpha1.WorkflowStep, error)) Option {
return func(o *StepGeneratorOptions) {
o.stepConvertor = convertor
}
}

func WithLogLevel(l int) Option {
return func(o *StepGeneratorOptions) {
o.logLevel = l
}
}

func installBuiltinProviders(instance *types.WorkflowInstance, client client.Client, providerHandlers types.Providers, pCtx process.Context) {
workspace.Install(providerHandlers, pCtx)
email.Install(providerHandlers)
util.Install(providerHandlers, pCtx)
http.Install(providerHandlers, client, instance.Namespace)
provider.Install(providerHandlers, client, nil)
metrics2.Install(providerHandlers)
kube.Install(providerHandlers, client, map[string]string{
types.LabelWorkflowRunName: instance.Name,
types.LabelWorkflowRunNamespace: instance.Namespace,
}, nil)
}