Files
onepanel/pkg/cron_workflow.go
2021-01-25 14:31:47 -08:00

620 lines
18 KiB
Go

package v1
import (
"fmt"
sq "github.com/Masterminds/squirrel"
wfv1 "github.com/argoproj/argo/pkg/apis/workflow/v1alpha1"
argojson "github.com/argoproj/pkg/json"
"github.com/onepanelio/core/pkg/util"
"github.com/onepanelio/core/pkg/util/label"
"github.com/onepanelio/core/pkg/util/request/pagination"
uid2 "github.com/onepanelio/core/pkg/util/uid"
log "github.com/sirupsen/logrus"
"google.golang.org/grpc/codes"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"strings"
)
func (c *Client) UpdateCronWorkflow(namespace string, uid string, cronWorkflow *CronWorkflow) (*CronWorkflow, error) {
err := c.cronWorkflowSelectBuilderNoColumns(namespace, cronWorkflow.WorkflowExecution.WorkflowTemplate.UID).
Columns("cw.id").
RunWith(c.DB).
QueryRow().
Scan(&cronWorkflow.ID)
if err != nil {
return nil, err
}
workflow := cronWorkflow.WorkflowExecution
workflowTemplate, err := c.GetWorkflowTemplate(namespace, workflow.WorkflowTemplate.UID, workflow.WorkflowTemplate.Version)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"CronWorkflow": cronWorkflow,
"Error": err.Error(),
}).Error("Error with getting workflow template.")
return nil, util.NewUserError(codes.NotFound, "Error with getting workflow template.")
}
// TODO: Need to pull system parameters from k8s config/secret here, example: HOST
opts := &WorkflowExecutionOptions{}
opts.GenerateName, err = uid2.GenerateUID(workflowTemplate.Name, 63)
if err != nil {
return nil, err
}
opts.GenerateName += "-"
for _, param := range workflow.Parameters {
opts.Parameters = append(opts.Parameters, Parameter{
Name: param.Name,
Value: param.Value,
})
}
if err := workflowTemplate.ReplaceManifestParameters(workflow.Parameters); err != nil {
return nil, err
}
rawCronManifest := cronWorkflow.Manifest
workflowTemplateManifest := workflowTemplate.GetManifestBytes()
if err := cronWorkflow.AddToManifestSpec("workflowSpec", string(workflowTemplateManifest)); err != nil {
return nil, err
}
if opts.Labels == nil {
opts.Labels = map[string]string{}
}
opts.Labels[workflowTemplateUIDLabelKey] = workflowTemplate.UID
opts.Labels[workflowTemplateVersionLabelKey] = fmt.Sprint(workflowTemplate.Version)
var argoCronWorkflow wfv1.CronWorkflow
var argoCronWorkflowSpec wfv1.CronWorkflowSpec
if err := argojson.UnmarshalStrict([]byte(rawCronManifest), &argoCronWorkflowSpec); err != nil {
return nil, err
}
argoCronWorkflow.Spec = argoCronWorkflowSpec
manifestBytes, err := workflowTemplate.GetWorkflowManifestBytes()
if err != nil {
return nil, err
}
workflows, err := UnmarshalWorkflows(manifestBytes, true)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"CronWorkflow": cronWorkflow,
"Error": err.Error(),
}).Error("Error parsing workflow.")
return nil, err
}
if len(workflows) != 1 {
return nil, fmt.Errorf("more than one workflow in spec")
}
wf := workflows[0]
argoCronWorkflow.Spec.WorkflowSpec = wf.Spec
_, err = c.updateCronWorkflow(namespace, uid, &workflowTemplate.ID, &wf, &argoCronWorkflow, opts)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"CronWorkflow": cronWorkflow,
"Error": err.Error(),
}).Error("Error parsing workflow.")
return nil, err
}
cronWorkflow.WorkflowExecution.WorkflowTemplate = workflowTemplate
// Manifests could get big, don't return them in this case.
cronWorkflow.WorkflowExecution.WorkflowTemplate.Manifest = ""
_, err = sb.Update("cron_workflows").
SetMap(sq.Eq{
"manifest": cronWorkflow.Manifest,
"labels": cronWorkflow.Labels,
}).Where(sq.Eq{"id": cronWorkflow.ID}).
RunWith(c.DB).
Exec()
if err != nil {
return nil, err
}
return cronWorkflow, nil
}
func (c *Client) CreateCronWorkflow(namespace string, cronWorkflow *CronWorkflow) (*CronWorkflow, error) {
workflow := cronWorkflow.WorkflowExecution
workflowTemplate, err := c.GetWorkflowTemplate(namespace, workflow.WorkflowTemplate.UID, workflow.WorkflowTemplate.Version)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"CronWorkflow": cronWorkflow,
"Error": err.Error(),
}).Error("Error with getting workflow template.")
return nil, util.NewUserError(codes.NotFound, "Error with getting workflow template.")
}
// TODO: Need to pull system parameters from k8s config/secret here, example: HOST
opts := &WorkflowExecutionOptions{
Labels: make(map[string]string),
}
opts.GenerateName, err = uid2.GenerateUID(workflowTemplate.Name, 63)
if err != nil {
return nil, err
}
opts.GenerateName += "-"
for _, param := range workflow.Parameters {
opts.Parameters = append(opts.Parameters, Parameter{
Name: param.Name,
Value: param.Value,
})
}
if err := workflowTemplate.ReplaceManifestParameters(workflow.Parameters); err != nil {
return nil, err
}
rawCronManifest := cronWorkflow.Manifest
workflowTemplateManifest := workflowTemplate.GetManifestBytes()
if err := cronWorkflow.AddToManifestSpec("workflowSpec", string(workflowTemplateManifest)); err != nil {
return nil, err
}
opts.Labels[workflowTemplateUIDLabelKey] = workflowTemplate.UID
opts.Labels[workflowTemplateVersionLabelKey] = fmt.Sprint(workflowTemplate.Version)
label.MergeLabelsPrefix(opts.Labels, workflow.Labels, label.TagPrefix)
var argoCronWorkflow wfv1.CronWorkflow
var argoCronWorkflowSpec wfv1.CronWorkflowSpec
if err := argojson.UnmarshalStrict([]byte(rawCronManifest), &argoCronWorkflowSpec); err != nil {
return nil, err
}
argoCronWorkflow.Spec = argoCronWorkflowSpec
manifestBytes, err := workflowTemplate.GetWorkflowManifestBytes()
if err != nil {
return nil, err
}
workflows, err := UnmarshalWorkflows(manifestBytes, true)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"CronWorkflow": cronWorkflow,
"Error": err.Error(),
}).Error("Error parsing workflow.")
return nil, err
}
if len(workflows) != 1 {
return nil, fmt.Errorf("more than one workflow in spec")
}
wf := workflows[0]
argoCronWorkflow.Spec.WorkflowSpec = wf.Spec
argoCreatedCronWorkflow, err := c.createCronWorkflow(namespace, &workflowTemplate.ID, &wf, &argoCronWorkflow, opts)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"CronWorkflow": cronWorkflow,
"Error": err.Error(),
}).Error("Error parsing workflow.")
return nil, err
}
cronWorkflow.Name = argoCreatedCronWorkflow.Name
cronWorkflow.CreatedAt = argoCreatedCronWorkflow.CreationTimestamp.UTC()
cronWorkflow.UID, err = uid2.GenerateUID(argoCreatedCronWorkflow.Name, 63)
if err != nil {
return nil, err
}
cronWorkflow.WorkflowExecution.WorkflowTemplate = workflowTemplate
// Manifests could get big, don't return them in this case.
cronWorkflow.WorkflowExecution.WorkflowTemplate.Manifest = ""
err = sb.Insert("cron_workflows").
SetMap(sq.Eq{
"uid": cronWorkflow.UID,
"name": cronWorkflow.Name,
"workflow_template_version_id": workflowTemplate.WorkflowTemplateVersionID,
"manifest": cronWorkflow.Manifest,
"namespace": namespace,
"is_archived": false,
"labels": cronWorkflow.Labels,
}).
Suffix("RETURNING id").
RunWith(c.DB).
QueryRow().
Scan(&cronWorkflow.ID)
if err != nil {
return nil, err
}
return cronWorkflow, nil
}
// GetCronWorkflow gets information about a cron workflow uniquely identified by a namespace/uid
func (c *Client) GetCronWorkflow(namespace, uid string) (cronWorkflow *CronWorkflow, err error) {
cronWorkflow = &CronWorkflow{}
sb := c.cronWorkflowSelectBuilder(namespace, uid)
err = c.Getx(cronWorkflow, sb)
return
}
// prefix is the label prefix.
// e.g. prefix/my-label-key: my-label-value
func (c *Client) GetCronWorkflowLabels(namespace, name, prefix string) (labels map[string]string, err error) {
cwf, err := c.ArgoprojV1alpha1().CronWorkflows(namespace).Get(name, metav1.GetOptions{})
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"Name": name,
"Error": err.Error(),
}).Error("CronWorkflow not found.")
return nil, util.NewUserError(codes.NotFound, "CronWorkflow not found.")
}
labels = label.FilterByPrefix(prefix, cwf.Labels)
labels = label.RemovePrefix(prefix, labels)
return
}
// prefix is the label prefix.
// we delete all labels with that prefix and set the new ones
// e.g. prefix/my-label-key: my-label-value
func (c *Client) SetCronWorkflowLabels(namespace, name, prefix string, keyValues map[string]string, deleteOld bool) (workflowLabels map[string]string, err error) {
cwf, err := c.ArgoprojV1alpha1().CronWorkflows(namespace).Get(name, metav1.GetOptions{})
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"Name": name,
"Error": err.Error(),
}).Error("CronWorkflow not found.")
return nil, util.NewUserError(codes.NotFound, "CronWorkflow not found.")
}
if deleteOld {
label.DeleteWithPrefix(cwf.Labels, prefix)
}
label.MergeLabelsPrefix(cwf.Labels, keyValues, prefix)
cwf, err = c.ArgoprojV1alpha1().CronWorkflows(namespace).Update(cwf)
if err != nil {
return nil, err
}
filteredMap := label.FilterByPrefix(prefix, cwf.Labels)
filteredMap = label.RemovePrefix(prefix, filteredMap)
return filteredMap, nil
}
func (c *Client) DeleteCronWorkflowLabel(namespace, name string, keysToDelete ...string) (labels map[string]string, err error) {
wf, err := c.ArgoprojV1alpha1().CronWorkflows(namespace).Get(name, metav1.GetOptions{})
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"Name": name,
"Error": err.Error(),
}).Error("CronWorkflow not found.")
return nil, util.NewUserError(codes.NotFound, "CronWorkflow not found.")
}
label.Delete(wf.Labels, keysToDelete...)
return wf.Labels, nil
}
// ListCronWorkflows selects all of the cron workflows for the given namespace and workflow template uid
func (c *Client) ListCronWorkflows(namespace, workflowTemplateUID string, pagination *pagination.PaginationRequest) (cronWorkflows []*CronWorkflow, err error) {
sb := c.cronWorkflowSelectBuilder(namespace, workflowTemplateUID).
OrderBy("cw.created_at DESC")
sb = *pagination.ApplyToSelect(&sb)
if err := c.DB.Selectx(&cronWorkflows, sb); err != nil {
return nil, err
}
return
}
func (c *Client) CountCronWorkflows(namespace, workflowTemplateUID string) (count int, err error) {
err = c.cronWorkflowSelectBuilderNoColumns(namespace, workflowTemplateUID).
Columns("COUNT(*)").
RunWith(c.DB).
QueryRow().
Scan(&count)
return
}
func (c *Client) buildCronWorkflowDefinition(namespace string, workflowTemplateId *uint64, wf *wfv1.Workflow, cwf *wfv1.CronWorkflow, opts *WorkflowExecutionOptions) (cronWorkflow *wfv1.CronWorkflow, err error) {
if opts == nil {
opts = &WorkflowExecutionOptions{}
}
if opts.Name != "" {
cwf.ObjectMeta.Name = opts.Name
}
if opts.GenerateName != "" {
cwf.ObjectMeta.GenerateName = opts.GenerateName
}
if opts.Entrypoint != "" {
cwf.Spec.WorkflowSpec.Entrypoint = opts.Entrypoint
}
if opts.ServiceAccount != "" {
cwf.Spec.WorkflowSpec.ServiceAccountName = opts.ServiceAccount
}
if len(opts.Parameters) > 0 {
newParams := make([]wfv1.Parameter, 0)
passedParams := make(map[string]bool)
for _, param := range opts.Parameters {
newParams = append(newParams, wfv1.Parameter{
Name: param.Name,
Value: wfv1.AnyStringPtr(*param.Value),
})
passedParams[param.Name] = true
}
for _, param := range cwf.Spec.WorkflowSpec.Arguments.Parameters {
if _, ok := passedParams[param.Name]; ok {
// this parameter was overridden via command line
continue
}
newParams = append(newParams, param)
}
cwf.Spec.WorkflowSpec.Arguments.Parameters = newParams
wf.Spec.Arguments.Parameters = newParams
}
if opts.Labels != nil {
cwf.ObjectMeta.Labels = opts.Labels
}
err = injectExitHandlerWorkflowExecutionStatistic(wf, workflowTemplateId)
if err != nil {
return nil, err
}
err = injectInitHandlerWorkflowExecutionStatistic(wf, workflowTemplateId)
if err != nil {
return nil, err
}
if err = c.injectAutomatedFields(namespace, wf, opts); err != nil {
return nil, err
}
cwf.Spec.WorkflowSpec = wf.Spec
cwf.Spec.WorkflowMetadata = &wf.ObjectMeta
//merge the labels
mergedLabels := wf.ObjectMeta.Labels
if mergedLabels == nil {
mergedLabels = make(map[string]string)
}
for k, v := range opts.Labels {
mergedLabels[k] = v
}
cwf.Spec.WorkflowMetadata.Labels = mergedLabels
return cwf, nil
}
func (c *Client) updateCronWorkflow(namespace string, uid string, workflowTemplateId *uint64, wf *wfv1.Workflow, cwf *wfv1.CronWorkflow, opts *WorkflowExecutionOptions) (updatedCronWorkflow *wfv1.CronWorkflow, err error) {
//Make sure the CronWorkflow exists before we edit it
toUpdateCWF, err := c.ArgoprojV1alpha1().CronWorkflows(namespace).Get(uid, metav1.GetOptions{})
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"UID": uid,
"Error": err.Error(),
}).Error("CronWorkflow not found.")
return nil, util.NewUserError(codes.NotFound, "CronWorkflow not found.")
}
cwf, err = c.buildCronWorkflowDefinition(namespace, workflowTemplateId, wf, cwf, opts)
if err != nil {
return
}
cwf.Name = uid
cwf.ResourceVersion = toUpdateCWF.ResourceVersion
updatedCronWorkflow, err = c.ArgoprojV1alpha1().CronWorkflows(namespace).Update(cwf)
if err != nil {
return nil, err
}
return
}
func (c *Client) createCronWorkflow(namespace string, workflowTemplateId *uint64, wf *wfv1.Workflow, cwf *wfv1.CronWorkflow, opts *WorkflowExecutionOptions) (createdCronWorkflow *wfv1.CronWorkflow, err error) {
cwf, err = c.buildCronWorkflowDefinition(namespace, workflowTemplateId, wf, cwf, opts)
if err != nil {
return
}
createdCronWorkflow, err = c.ArgoprojV1alpha1().CronWorkflows(namespace).Create(cwf)
if err != nil {
return nil, err
}
return
}
func (c *Client) TerminateCronWorkflow(namespace, uid string) (err error) {
err = c.ArgoprojV1alpha1().CronWorkflows(namespace).Delete(uid, nil)
if err != nil {
if !strings.Contains(err.Error(), "not found") {
return err
}
}
cronWorkflow, err := c.selectCronWorkflowWithWorkflowTemplateVersion(namespace, uid)
if err != nil {
return err
}
//workflow executions
var workflows []*WorkflowExecution
query, args, err := sb.Select().
Columns(getWorkflowExecutionColumns("we")...).
From("workflow_executions we").
Where(sq.Eq{
"cron_workflow_id": cronWorkflow.ID,
}).ToSql()
if err != nil {
return err
}
if err := c.DB.Select(&workflows, query, args...); err != nil {
return err
}
for _, wf := range workflows {
err = c.ArchiveWorkflowExecution(namespace, wf.UID)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"UID": uid,
"Error": err.Error(),
}).Error("Archive Workflow Execution Failed.")
return err
}
}
_, err = sb.Update("cron_workflows").
Set("is_archived", true).
Where(sq.Eq{
"uid": uid,
"namespace": namespace,
}).RunWith(c.DB).Exec()
return
}
func (c *Client) ArchiveCronWorkflow(namespace, uid string) (err error) {
err = c.ArgoprojV1alpha1().CronWorkflows(namespace).Delete(uid, nil)
if err != nil {
if strings.Contains(err.Error(), "not found") {
return nil
}
return err
}
_, err = sb.Update("cron_workflows").
Set("is_archived", true).
Where(sq.Eq{
"uid": uid,
"namespace": namespace,
}).RunWith(c.DB).Exec()
return
}
func (c *Client) cronWorkflowSelectBuilder(namespace string, workflowTemplateUid string) sq.SelectBuilder {
sb := c.cronWorkflowSelectBuilderNoColumns(namespace, workflowTemplateUid).
Columns(getCronWorkflowColumns("cw")...).
Columns("wtv.version")
return sb
}
func (c *Client) cronWorkflowSelectBuilderNoColumns(namespace string, workflowTemplateUID string) sq.SelectBuilder {
sb := sb.Select().
From("cron_workflows cw").
Join("workflow_template_versions wtv ON wtv.id = cw.workflow_template_version_id").
Join("workflow_templates wt ON wt.id = wtv.workflow_template_id").
Where(sq.Eq{
"wt.namespace": namespace,
"wt.uid": workflowTemplateUID,
"cw.is_archived": false,
})
return sb
}
func (c *Client) GetCronWorkflowStatisticsForTemplates(workflowTemplates ...*WorkflowTemplate) (err error) {
if len(workflowTemplates) == 0 {
return nil
}
tx, err := c.DB.Begin()
if err != nil {
return err
}
whereIn := "wtv.workflow_template_id IN (?"
for i := range workflowTemplates {
if i == 0 {
continue
}
whereIn += ",?"
}
whereIn += ")"
ids := make([]interface{}, len(workflowTemplates))
for i, workflowTemplate := range workflowTemplates {
ids[i] = workflowTemplate.ID
}
defer tx.Rollback()
statsSelect := `
workflow_template_id,
COUNT(*) total`
query, args, err := sb.Select(statsSelect).
From("cron_workflows cw").
Join("workflow_template_versions wtv ON wtv.id = cw.workflow_template_version_id").
Where(whereIn, ids...).
GroupBy("wtv.workflow_template_id").
ToSql()
if err != nil {
return err
}
result := make([]*CronWorkflowStatisticReport, 0)
err = c.DB.Select(&result, query, args...)
if err != nil {
return err
}
resultMapping := make(map[uint64]*CronWorkflowStatisticReport)
for i := range result {
report := result[i]
resultMapping[report.WorkflowTemplateId] = report
}
for _, workflowTemplate := range workflowTemplates {
resultMap, ok := resultMapping[workflowTemplate.ID]
if ok {
workflowTemplate.CronWorkflowsStatisticsReport = resultMap
}
}
return
}
func (c *Client) selectCronWorkflowWithWorkflowTemplateVersion(namespace, uid string) (*CronWorkflow, error) {
query, args, err := sb.Select(getCronWorkflowColumns("cw")...).
From("cron_workflows cw").
Join("workflow_template_versions wtv ON wtv.id = cw.workflow_template_version_id").
Join("workflow_templates wt ON wt.id = wtv.workflow_template_id").
Where(sq.Eq{
"wt.namespace": namespace,
"cw.name": uid,
"cw.is_archived": false,
}).
ToSql()
if err != nil {
return nil, err
}
cronWorkflow := &CronWorkflow{}
if err = c.DB.Get(cronWorkflow, query, args...); err != nil {
return nil, err
}
return cronWorkflow, nil
}