Files
onepanel/pkg/workflow_template.go

761 lines
21 KiB
Go

package v1
import (
"database/sql"
"errors"
"fmt"
"github.com/onepanelio/core/pkg/util/pagination"
uid2 "github.com/onepanelio/core/pkg/util/uid"
"strconv"
"time"
sq "github.com/Masterminds/squirrel"
"github.com/argoproj/argo/pkg/apis/workflow/v1alpha1"
argojson "github.com/argoproj/pkg/json"
"github.com/ghodss/yaml"
"github.com/onepanelio/core/pkg/util"
"github.com/onepanelio/core/pkg/util/label"
log "github.com/sirupsen/logrus"
"google.golang.org/grpc/codes"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
func (c *Client) createWorkflowTemplate(namespace string, workflowTemplate *WorkflowTemplate) (*WorkflowTemplate, *WorkflowTemplateVersion, error) {
uid, err := uid2.GenerateUID(workflowTemplate.Name)
if err != nil {
return nil, nil, err
}
workflowTemplate.UID = uid
tx, err := c.DB.Begin()
if err != nil {
return nil, nil, err
}
defer tx.Rollback()
versionUnix := time.Now().Unix()
err = sb.Insert("workflow_templates").
SetMap(sq.Eq{
"uid": uid,
"name": workflowTemplate.Name,
"namespace": namespace,
"is_system": workflowTemplate.IsSystem,
}).
Suffix("RETURNING id").
RunWith(tx).
QueryRow().Scan(&workflowTemplate.ID)
if err != nil {
return nil, nil, err
}
versionUID := strconv.FormatInt(versionUnix, 10)
workflowTemplateVersion := &WorkflowTemplateVersion{}
err = sb.Insert("workflow_template_versions").
SetMap(sq.Eq{
"uid": versionUID,
"workflow_template_id": workflowTemplate.ID,
"version": versionUnix,
"is_latest": true,
"manifest": workflowTemplate.Manifest,
}).
Suffix("RETURNING id").
RunWith(tx).
QueryRow().
Scan(&workflowTemplateVersion.ID)
if err != nil {
return nil, nil, err
}
if len(workflowTemplate.Labels) > 0 {
_, err = c.InsertLabelsBuilder(TypeWorkflowTemplateVersion, workflowTemplateVersion.ID, workflowTemplate.Labels).
RunWith(tx).
Exec()
if err != nil {
return nil, nil, err
}
}
argoWft, err := createArgoWorkflowTemplate(workflowTemplate, versionUnix)
if err != nil {
return nil, nil, err
}
argoWft.Labels[label.WorkflowTemplateVersionUid] = versionUID
if workflowTemplate.Resource != nil && workflowTemplate.ResourceUID != nil {
if *workflowTemplate.Resource == TypeWorkspaceTemplate {
argoWft.Labels[label.WorkspaceTemplateVersionUid] = *workflowTemplate.ResourceUID
}
}
argoWft, err = c.ArgoprojV1alpha1().WorkflowTemplates(namespace).Create(argoWft)
if err != nil {
return nil, nil, err
}
if err = tx.Commit(); err != nil {
if err := c.ArgoprojV1alpha1().WorkflowTemplates(namespace).Delete(argoWft.Name, &v1.DeleteOptions{}); err != nil {
log.Printf("Unable to delete argo workflow template")
}
return nil, nil, err
}
workflowTemplate.Version = versionUnix
return workflowTemplate, workflowTemplateVersion, nil
}
func (c *Client) workflowTemplatesSelectBuilder(namespace string) sq.SelectBuilder {
sb := sb.Select("wt.id", "wt.created_at", "wt.uid", "wt.name", "wt.is_archived").
From("workflow_templates wt").
Where(sq.Eq{
"wt.namespace": namespace,
})
return sb
}
func (c *Client) workflowTemplatesVersionSelectBuilder(namespace string) sq.SelectBuilder {
sb := sb.Select("wtv.id", "wtv.uid", "wtv.version", "wtv.is_latest", "wtv.manifest", "wtv.created_at").
From("workflow_template_versions wtv").
Join("workflow_templates wt ON wt.id = wtv.workflow_template_id").
Where(sq.Eq{
"wt.namespace": namespace,
})
return sb
}
func (c *Client) GetWorkflowTemplateDb(namespace, name string) (workflowTemplate *WorkflowTemplate, err error) {
query, args, err := c.workflowTemplatesSelectBuilder(namespace).
Where(sq.Eq{
"name": name,
}).
ToSql()
if err != nil {
return nil, err
}
if err := c.DB.Get(workflowTemplate, query, args...); err != nil {
return nil, err
}
return
}
// "latest" will get you the latest version
func (c *Client) GetWorkflowTemplateVersionDb(namespace, name, version string) (workflowTemplateVersion *WorkflowTemplateVersion, err error) {
whereMap := sq.Eq{
"wt.name": name,
}
if version == "latest" {
whereMap["wtv.is_latest"] = "true"
} else {
whereMap["wtv.version"] = version
}
query, args, err := c.workflowTemplatesVersionSelectBuilder(namespace).
Where(whereMap).
ToSql()
if err != nil {
return nil, err
}
if err := c.DB.Get(workflowTemplateVersion, query, args...); err != nil {
return nil, err
}
return
}
func (c *Client) getWorkflowTemplateById(id uint64) (workflowTemplate *WorkflowTemplate, err error) {
workflowTemplate = &WorkflowTemplate{}
query, args, err := sb.Select(getWorkflowTemplateColumns("wt", "")...).
From("workflow_templates wt").
Where(sq.Eq{"id": id}).
ToSql()
if err != nil {
return nil, err
}
err = c.DB.Get(workflowTemplate, query, args...)
return
}
// @todo remove argoworkflow template here
func (c *Client) getWorkflowTemplate(namespace, uid string, version int64) (workflowTemplate *WorkflowTemplate, err error) {
workflowTemplate = &WorkflowTemplate{
WorkflowExecutionStatisticReport: &WorkflowExecutionStatisticReport{},
}
sb := c.workflowTemplatesSelectBuilder(namespace).
Columns("wtv.manifest", "wtv.version", "wtv.id workflow_template_version_id").
Join("workflow_template_versions wtv ON wt.id = wtv.workflow_template_id").
Where(sq.Eq{"wt.uid": uid})
if version == 0 {
sb = sb.Where(sq.Eq{"wtv.is_latest": true})
} else {
sb = sb.Where(sq.Eq{"wtv.version": version})
}
query, args, err := sb.ToSql()
if err != nil {
return
}
if err = c.DB.Get(workflowTemplate, query, args...); err == sql.ErrNoRows {
return nil, nil
}
versionAsString := "latest"
if version != 0 {
versionAsString = fmt.Sprintf("%v", version)
}
argoWft, err := c.getArgoWorkflowTemplate(namespace, uid, versionAsString)
if err != nil {
return nil, err
}
workflowTemplate.ArgoWorkflowTemplate = argoWft
templateVersion, err := strconv.ParseInt(argoWft.Labels[label.Version], 10, 64)
if err != nil {
return nil, err
}
workflowTemplate.Version = templateVersion
labelsMap, err := c.GetDbLabelsMapped(TypeWorkflowTemplateVersion, workflowTemplate.WorkflowTemplateVersionId)
if err != nil {
return workflowTemplate, err
}
workflowTemplate.Labels = labelsMap[workflowTemplate.WorkflowTemplateVersionId]
return workflowTemplate, nil
}
func (c *Client) getWorkflowTemplateByName(namespace, name string, version int64) (workflowTemplate *WorkflowTemplate, err error) {
workflowTemplate = &WorkflowTemplate{}
sb := c.workflowTemplatesSelectBuilder(namespace).Where(sq.Eq{"wt.name": name}).
Columns("wtv.manifest").
OrderBy("wtv.version desc").
Limit(1)
if version != 0 {
sb = sb.Where(sq.Eq{"wtv.version": version})
}
query, args, err := sb.ToSql()
if err != nil {
return
}
if err = c.DB.Get(workflowTemplate, query, args...); err == sql.ErrNoRows {
err = nil
workflowTemplate = nil
}
return
}
func (c *Client) listWorkflowTemplateVersions(namespace, uid string) (workflowTemplateVersions []*WorkflowTemplate, err error) {
dbVersions, err := c.listDbWorkflowTemplateVersions(namespace, uid)
if err != nil {
return nil, err
}
labelsMap, err := c.GetDbLabelsMapped(TypeWorkflowTemplateVersion, WorkflowTemplateVersionsToIds(dbVersions)...)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"Error": err.Error(),
}).Error("Unable to get Workflow Template Version Labels")
return nil, err
}
for _, version := range dbVersions {
version.Labels = labelsMap[version.ID]
newItem := WorkflowTemplate{
ID: version.WorkflowTemplate.ID,
CreatedAt: version.CreatedAt.UTC(),
UID: version.UID,
Name: version.WorkflowTemplate.Name,
Manifest: version.Manifest,
Version: version.Version,
IsLatest: version.IsLatest,
IsArchived: version.WorkflowTemplate.IsArchived,
Labels: version.Labels,
}
workflowTemplateVersions = append(workflowTemplateVersions, &newItem)
}
return
}
func (c *Client) listWorkflowTemplates(namespace string, paginator *pagination.PaginationRequest) (workflowTemplateVersions []*WorkflowTemplate, err error) {
workflowTemplateVersions = []*WorkflowTemplate{}
sb := c.workflowTemplatesSelectBuilder(namespace).
Column("COUNT(wtv.*) versions, MAX(wtv.id) workflow_template_version_id").
Join("workflow_template_versions wtv ON wtv.workflow_template_id = wt.id").
GroupBy("wt.id", "wt.created_at", "wt.uid", "wt.name", "wt.is_archived").
Where(sq.Eq{
"wt.is_archived": false,
"wt.is_system": false,
}).
OrderBy("wt.created_at DESC")
sb = *paginator.ApplyToSelect(&sb)
query, args, err := sb.ToSql()
if err != nil {
return
}
err = c.DB.Select(&workflowTemplateVersions, query, args...)
return
}
func (c *Client) CountWorkflowTemplates(namespace string) (count int, err error) {
err = sb.Select("COUNT( DISTINCT( wt.id ))").
From("workflow_templates wt").
Join("workflow_template_versions wtv ON wtv.workflow_template_id = wt.id").
Where(sq.Eq{
"wt.namespace": namespace,
"wt.is_archived": false,
}).
RunWith(c.DB.DB).
QueryRow().
Scan(&count)
return
}
func (c *Client) archiveWorkflowTemplate(namespace, uid string) (bool, error) {
query, args, err := sb.Update("workflow_templates").
Set("is_archived", true).
Where(sq.Eq{
"uid": uid,
"namespace": namespace,
}).
ToSql()
if err != nil {
return false, err
}
if _, err := c.DB.Exec(query, args...); err != nil {
return false, err
}
return true, nil
}
func (c *Client) validateWorkflowTemplate(namespace string, workflowTemplate *WorkflowTemplate) (err error) {
// validate workflow template
finalBytes, err := workflowTemplate.WrapSpec()
if err != nil {
return
}
err = c.ValidateWorkflowExecution(namespace, finalBytes)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"WorkflowTemplate": workflowTemplate,
"Error": err.Error(),
}).Error("Workflow could not be validated.")
}
return
}
func (c *Client) CreateWorkflowTemplate(namespace string, workflowTemplate *WorkflowTemplate) (*WorkflowTemplate, error) {
// validate workflow template
if err := c.validateWorkflowTemplate(namespace, workflowTemplate); err != nil {
return nil, util.NewUserError(codes.InvalidArgument, err.Error())
}
workflowTemplate, _, err := c.createWorkflowTemplate(namespace, workflowTemplate)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"WorkflowTemplate": workflowTemplate,
"Error": err.Error(),
}).Error("Could not create workflow template.")
return nil, util.NewUserErrorWrap(err, "Workflow template")
}
return workflowTemplate, nil
}
func (c *Client) CreateWorkflowTemplateVersion(namespace string, workflowTemplate *WorkflowTemplate) (*WorkflowTemplate, error) {
if workflowTemplate.UID == "" {
return nil, fmt.Errorf("uid required for CreateWorkflowTemplateVersion")
}
// validate workflow template
if err := c.validateWorkflowTemplate(namespace, workflowTemplate); err != nil {
return nil, util.NewUserError(codes.InvalidArgument, err.Error())
}
versionUnix := time.Now().Unix()
tx, err := c.DB.Begin()
if err != nil {
return nil, err
}
defer tx.Rollback()
wftSb := c.workflowTemplatesSelectBuilder(namespace).Where(sq.Eq{"wt.uid": workflowTemplate.UID})
query, args, err := wftSb.ToSql()
if err != nil {
return nil, err
}
workflowTemplateDb := &WorkflowTemplate{}
if err = c.DB.Get(workflowTemplateDb, query, args...); err != nil {
return nil, err
}
_, err = sb.Update("workflow_template_versions").
Set("is_latest", false).
Where(sq.Eq{
"workflow_template_id": workflowTemplateDb.ID,
}).
RunWith(tx).
Exec()
if err != nil {
return nil, err
}
uid := strconv.FormatInt(versionUnix, 10)
workflowTemplateVersionId := uint64(0)
err = sb.Insert("workflow_template_versions").
SetMap(sq.Eq{
"workflow_template_id": workflowTemplateDb.ID,
"uid": uid,
"version": versionUnix,
"is_latest": true,
"manifest": workflowTemplate.Manifest,
}).
Suffix("RETURNING id").
RunWith(tx).
QueryRow().
Scan(&workflowTemplateVersionId)
if err != nil {
return nil, err
}
latest, err := c.getArgoWorkflowTemplate(namespace, workflowTemplate.UID, "latest")
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"WorkflowTemplate": workflowTemplate,
"Error": err.Error(),
}).Error("Could not get latest argo workflow template")
return nil, err
}
delete(latest.Labels, label.VersionLatest)
latest, err = c.ArgoprojV1alpha1().WorkflowTemplates(namespace).Update(latest)
if err != nil {
return nil, err
}
updatedTemplate, err := createArgoWorkflowTemplate(workflowTemplate, versionUnix)
if err != nil {
latest.Labels[label.VersionLatest] = "true"
if _, err := c.ArgoprojV1alpha1().WorkflowTemplates(namespace).Update(latest); err != nil {
return nil, err
}
return nil, err
}
updatedTemplate.TypeMeta = v1.TypeMeta{}
updatedTemplate.ObjectMeta.ResourceVersion = ""
updatedTemplate.ObjectMeta.SetSelfLink("")
updatedTemplate.Labels[label.WorkflowTemplateVersionUid] = uid
parametersMap, err := workflowTemplate.GetParametersKeyString()
if err != nil {
return nil, err
}
if updatedTemplate.Annotations == nil {
updatedTemplate.Annotations = make(map[string]string)
}
for key, value := range parametersMap {
updatedTemplate.Annotations[key] = value
}
if _, err := c.ArgoprojV1alpha1().WorkflowTemplates(namespace).Create(updatedTemplate); err != nil {
return nil, err
}
if err := tx.Commit(); err != nil {
return nil, err
}
workflowTemplate.Version = versionUnix
return workflowTemplate, nil
}
// If version is 0, it returns the latest.
func (c *Client) GetWorkflowTemplate(namespace, uid string, version int64) (workflowTemplate *WorkflowTemplate, err error) {
workflowTemplate, err = c.getWorkflowTemplate(namespace, uid, version)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"WorkflowTemplate": workflowTemplate,
"Error": err.Error(),
}).Error("Get Workflow Template failed.")
return nil, util.NewUserError(codes.Unknown, "Unknown error.")
}
if workflowTemplate == nil {
return nil, util.NewUserError(codes.NotFound, "Workflow template not found.")
}
return
}
func (c *Client) GetWorkflowTemplateByName(namespace, name string, version int64) (workflowTemplate *WorkflowTemplate, err error) {
workflowTemplate, err = c.getWorkflowTemplateByName(namespace, name, version)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"WorkflowTemplate": workflowTemplate,
"Error": err.Error(),
}).Error("Get Workflow Template failed.")
return nil, util.NewUserError(codes.Unknown, "Unknown error.")
}
if workflowTemplate == nil {
return nil, util.NewUserError(codes.NotFound, "Workflow template not found.")
}
return
}
func (c *Client) ListWorkflowTemplateVersions(namespace, uid string) (workflowTemplateVersions []*WorkflowTemplate, err error) {
workflowTemplateVersions, err = c.listWorkflowTemplateVersions(namespace, uid)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"UID": uid,
"Error": err.Error(),
}).Error("Workflow template versions not found.")
return nil, util.NewUserError(codes.NotFound, "Workflow template versions not found.")
}
return
}
func (c *Client) ListWorkflowTemplates(namespace string, paginator *pagination.PaginationRequest) (workflowTemplateVersions []*WorkflowTemplate, err error) {
workflowTemplateVersions, err = c.listWorkflowTemplates(namespace, paginator)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"Error": err.Error(),
}).Error("Workflow templates not found.")
return nil, util.NewUserError(codes.NotFound, "Workflow templates not found.")
}
err = c.GetWorkflowExecutionStatisticsForTemplates(workflowTemplateVersions...)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"Error": err.Error(),
}).Error("Unable to get Workflow Execution Statistic for Templates.")
return nil, util.NewUserError(codes.NotFound, "Unable to get Workflow Execution Statistic for Templates.")
}
err = c.GetCronWorkflowStatisticsForTemplates(workflowTemplateVersions...)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"Error": err.Error(),
}).Error("Unable to get Cron Workflow Statistic for Templates.")
return nil, util.NewUserError(codes.NotFound, "Unable to get Cron Workflow Statistic for Templates.")
}
labelsMap, err := c.GetDbLabelsMapped(TypeWorkflowTemplateVersion, WorkflowTemplatesToVersionIds(workflowTemplateVersions)...)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"Error": err.Error(),
}).Error("Unable to get Workflow Template Labels")
return nil, err
}
for _, workflowTemplate := range workflowTemplateVersions {
workflowTemplate.Labels = labelsMap[workflowTemplate.WorkflowTemplateVersionId]
}
return
}
func (c *Client) ArchiveWorkflowTemplate(namespace, uid string) (archived bool, err error) {
workflowTemplate, err := c.getWorkflowTemplate(namespace, uid, 0)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"UID": uid,
"Error": err.Error(),
}).Error("Get Workflow Template failed.")
return false, util.NewUserError(codes.Unknown, "Unable to archive workflow template.")
}
if workflowTemplate == nil {
return false, util.NewUserError(codes.NotFound, "Workflow template not found.")
}
archived, err = c.archiveWorkflowTemplate(namespace, uid)
if !archived || err != nil {
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"UID": uid,
"Error": err.Error(),
}).Error("Archive Workflow Template failed.")
}
return false, util.NewUserError(codes.Unknown, "Unable to archive workflow template.")
}
return
}
func createArgoWorkflowTemplate(workflowTemplate *WorkflowTemplate, version int64) (*v1alpha1.WorkflowTemplate, error) {
var argoWft *v1alpha1.WorkflowTemplate
var jsonOpts []argojson.JSONOpt
jsonOpts = append(jsonOpts, argojson.DisallowUnknownFields)
finalBytes, err := workflowTemplate.WrapSpec()
if err != nil {
return nil, err
}
err = yaml.Unmarshal(finalBytes, &argoWft)
if err != nil {
return nil, err
}
worfklowTemplateName, err := uid2.GenerateUID(workflowTemplate.Name)
if err != nil {
return nil, err
}
argoWft.Name = fmt.Sprintf("%v-v%v", worfklowTemplateName, version)
labels := map[string]string{
label.WorkflowTemplate: worfklowTemplateName,
label.WorkflowTemplateUid: workflowTemplate.UID,
label.Version: fmt.Sprintf("%v", version),
label.VersionLatest: "true",
}
label.MergeLabelsPrefix(labels, workflowTemplate.Labels, label.TagPrefix)
argoWft.Labels = labels
return argoWft, nil
}
// version "latest" will get the latest version.
func (c *Client) getArgoWorkflowTemplate(namespace, workflowTemplateUid, version string) (*v1alpha1.WorkflowTemplate, error) {
labelSelect := fmt.Sprintf("%v=%v", label.WorkflowTemplateUid, workflowTemplateUid)
if version == "latest" {
labelSelect += "," + label.VersionLatest + "=true"
} else {
labelSelect += fmt.Sprintf(",%v=%v", label.Version, version)
}
workflowTemplates, err := c.ArgoprojV1alpha1().WorkflowTemplates(namespace).List(v1.ListOptions{
LabelSelector: labelSelect,
})
if err != nil {
return nil, err
}
templates := workflowTemplates.Items
if templates.Len() == 0 {
return nil, errors.New("not found")
}
if templates.Len() > 1 {
return nil, errors.New("not unique result")
}
return &templates[0], nil
}
func (c *Client) listArgoWorkflowTemplates(namespace, workflowTemplateUid string) (*[]v1alpha1.WorkflowTemplate, error) {
labelSelect := fmt.Sprintf("%v=%v", label.WorkflowTemplateUid, workflowTemplateUid)
workflowTemplates, err := c.ArgoprojV1alpha1().WorkflowTemplates(namespace).List(v1.ListOptions{
LabelSelector: labelSelect,
})
if err != nil {
return nil, err
}
templates := []v1alpha1.WorkflowTemplate(workflowTemplates.Items)
return &templates, nil
}
func (c *Client) listDbWorkflowTemplateVersions(namespace, workflowTemplateUid string) ([]*WorkflowTemplateVersion, error) {
versions := make([]*WorkflowTemplateVersion, 0)
sb := c.workflowTemplatesVersionSelectBuilder(namespace).
Columns(`wt.id "workflow_template.id"`, `wt.created_at "workflow_template.created_at"`).
Columns(`wt.name "workflow_template.name"`, `wt.is_archived "workflow_template.is_archived"`).
Where(sq.Eq{"wt.uid": workflowTemplateUid}).
OrderBy("wtv.created_at DESC")
query, args, err := sb.ToSql()
if err != nil {
return versions, err
}
if err := c.DB.Select(&versions, query, args...); err != nil {
return versions, err
}
return versions, nil
}
// prefix is the label prefix.
// e.g. prefix/my-label-key: my-label-value
// if version is 0, latest is used.
func (c *Client) GetWorkflowTemplateLabels(namespace, name, prefix string, version int64) (labels map[string]string, err error) {
versionAsString := "latest"
if version != 0 {
versionAsString = fmt.Sprintf("%v", version)
}
wf, err := c.getArgoWorkflowTemplate(namespace, name, versionAsString)
if err != nil {
log.WithFields(log.Fields{
"Namespace": namespace,
"Name": name,
"Error": err.Error(),
}).Error("Workflow Template not found.")
return nil, util.NewUserError(codes.NotFound, "Workflow Template not found.")
}
labels = label.FilterByPrefix(prefix, wf.Labels)
labels = label.RemovePrefix(prefix, labels)
return
}