feat: cds modules

Signed-off-by: Yvonnick Esnault <yvonnick@esnau.lt>

modules/cds/queue/display.go

@@ -0,0 +1,130 @@
+package cdsqueue
+
+import (
+	"fmt"
+	"strings"
+	"time"
+
+	"github.com/ovh/cds/sdk"
+)
+
+func (widget *Widget) display() {
+	widget.TextWidget.Redraw(widget.content)
+}
+
+func (widget *Widget) content() (string, string, bool) {
+	if len(widget.View.GetHighlights()) > 0 {
+		widget.View.ScrollToHighlight()
+	} else {
+		widget.View.ScrollToBeginning()
+	}
+
+	widget.Items = make([]sdk.WorkflowNodeJobRun, 0)
+	filter := widget.currentFilter()
+	_, _, width, _ := widget.View.GetRect()
+
+	str := widget.settings.common.SigilStr(len(widget.filters), widget.Idx, width) + "\n"
+	str += widget.displayQueue(filter)
+
+	title := fmt.Sprintf("%s - %s", widget.CommonSettings().Title, widget.title(filter))
+
+	return title, str, false
+}
+
+func (widget *Widget) title(filter string) string {
+	return fmt.Sprintf(
+		"[%s]%d - %s[white]",
+		widget.settings.common.Colors.TextTheme.Title,
+		widget.maxItems,
+		filter,
+	)
+}
+
+func (widget *Widget) displayQueue(filter string) string {
+	runs, _ := widget.client.QueueWorkflowNodeJobRun(filter)
+
+	widget.SetItemCount(len(runs))
+
+	if len(runs) == 0 {
+		return " [grey]none[white]\n"
+	}
+
+	var content string
+	for idx, job := range runs {
+		content += fmt.Sprintf(`[grey]["%d"]%s`,
+			idx, widget.generateQueueJobLine(job.ID, job.Parameters, job.Job, time.Since(job.Queued), job.BookedBy, job.Status))
+
+		widget.Items = append(widget.Items, job)
+	}
+
+	return content
+}
+
+func (widget *Widget) generateQueueJobLine(id int64, parameters []sdk.Parameter, executedJob sdk.ExecutedJob,
+	duration time.Duration, bookedBy sdk.Service, status string) string {
+	prj := getVarsInPbj("cds.project", parameters)
+	workflow := getVarsInPbj("cds.workflow", parameters)
+	node := getVarsInPbj("cds.node", parameters)
+	run := getVarsInPbj("cds.run", parameters)
+	triggeredBy := getVarsInPbj("cds.triggered_by.username", parameters)
+
+	row := make([]string, 6)
+	row[0] = pad(fmt.Sprintf(sdk.Round(duration, time.Second).String()), 9)
+	row[2] = pad(run, 7)
+	row[3] = fmt.Sprintf("%s", pad(prj+"/"+workflow+"/"+node, 40))
+
+	if status == sdk.StatusBuilding {
+		row[1] = pad(fmt.Sprintf(" %s.%s ", executedJob.WorkerName, executedJob.WorkerID), 27)
+	} else if bookedBy.ID != 0 {
+		row[1] = pad(fmt.Sprintf(" %s.%d ", bookedBy.Name, bookedBy.ID), 27)
+	} else {
+		row[1] = pad("", 27)
+	}
+
+	row[4] = fmt.Sprintf("➤ %s", pad(triggeredBy, 17))
+
+	c := "grey"
+	if status == sdk.StatusWaiting {
+		if duration > 120*time.Second {
+			c = "red"
+		} else if duration > 50*time.Second {
+			c = "yellow"
+		}
+	}
+
+	return fmt.Sprintf("[%s]%s [grey]%s %s %s %s\n", c, row[0], row[1], row[2], row[3], row[4])
+}
+
+func getStatusColor(status string) string {
+	switch status {
+	case sdk.StatusSuccess:
+		return "green"
+	case sdk.StatusBuilding, sdk.StatusWaiting:
+		return "blue"
+	case sdk.StatusFail:
+		return "red"
+	case sdk.StatusStopped:
+		return "red"
+	case sdk.StatusSkipped:
+		return "grey"
+	case sdk.StatusDisabled:
+		return "grey"
+	}
+	return "red"
+}
+
+func pad(t string, size int) string {
+	if len(t) > size {
+		return t[0:size-3] + "..."
+	}
+	return t + strings.Repeat(" ", size-len(t))
+}
+
+func getVarsInPbj(key string, ps []sdk.Parameter) string {
+	for _, p := range ps {
+		if p.Name == key {
+			return p.Value
+		}
+	}
+	return ""
+}

modules/cds/queue/keyboard.go

@@ -0,0 +1,22 @@
+package cdsqueue
+
+import (
+	"github.com/gdamore/tcell"
+)
+
+func (widget *Widget) initializeKeyboardControls() {
+	widget.InitializeCommonControls(widget.Refresh)
+
+	widget.SetKeyboardChar("j", widget.Next, "Select next workflow")
+	widget.SetKeyboardChar("k", widget.Prev, "Select previous workflow")
+	widget.SetKeyboardChar("l", widget.NextSource, "Select next filter")
+	widget.SetKeyboardChar("h", widget.PrevSource, "Select previous filter")
+	widget.SetKeyboardChar("o", widget.openWorkflow, "Open workflow in browser")
+
+	widget.SetKeyboardKey(tcell.KeyDown, widget.Next, "Select next workflow")
+	widget.SetKeyboardKey(tcell.KeyUp, widget.Prev, "Select previous workflow")
+	widget.SetKeyboardKey(tcell.KeyRight, widget.NextSource, "Select next filter")
+	widget.SetKeyboardKey(tcell.KeyLeft, widget.PrevSource, "Select previous filter")
+	widget.SetKeyboardKey(tcell.KeyEnter, widget.openWorkflow, "Open workflow in browser")
+	widget.SetKeyboardKey(tcell.KeyEsc, widget.Unselect, "Clear selection")
+}

modules/cds/queue/settings.go

@@ -0,0 +1,31 @@
+package cdsqueue
+
+import (
+	"os"
+
+	"github.com/olebedev/config"
+	"github.com/wtfutil/wtf/cfg"
+)
+
+const (
+	defaultFocusable = true
+	defaultTitle     = "CDS Queue"
+)
+
+// Settings defines the configuration properties for this module
+type Settings struct {
+	common *cfg.Common
+	token  string `help:"Your CDS API token."`
+	apiURL string `help:"Your CDS API URL."`
+	uiURL  string
+}
+
+// NewSettingsFromYAML creates a new settings instance from a YAML config block
+func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {
+	settings := Settings{
+		common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
+		token:  ymlConfig.UString("token", ymlConfig.UString("token", os.Getenv("CDS_TOKEN"))),
+		apiURL: ymlConfig.UString("apiURL", os.Getenv("CDS_API_URL")),
+	}
+	return &settings
+}

modules/cds/queue/widget.go

@@ -0,0 +1,145 @@
+package cdsqueue
+
+import (
+	"fmt"
+	"strconv"
+
+	"github.com/ovh/cds/sdk"
+	"github.com/ovh/cds/sdk/cdsclient"
+	"github.com/rivo/tview"
+	"github.com/wtfutil/wtf/utils"
+	"github.com/wtfutil/wtf/view"
+)
+
+// Widget define wtf widget to register widget later
+type Widget struct {
+	view.MultiSourceWidget
+	view.KeyboardWidget
+	view.TextWidget
+
+	jobs    []sdk.WorkflowNodeJobRun
+	filters []string
+
+	client cdsclient.Interface
+
+	settings *Settings
+	Selected int
+	maxItems int
+	Items    []sdk.WorkflowNodeJobRun
+}
+
+// NewWidget creates a new instance of the widget
+func NewWidget(app *tview.Application, pages *tview.Pages, settings *Settings) *Widget {
+	widget := Widget{
+		KeyboardWidget:    view.NewKeyboardWidget(app, pages, settings.common),
+		MultiSourceWidget: view.NewMultiSourceWidget(settings.common, "workflow", "workflows"),
+		TextWidget:        view.NewTextWidget(app, settings.common),
+
+		settings: settings,
+	}
+
+	widget.initializeKeyboardControls()
+	widget.View.SetRegions(true)
+	widget.View.SetInputCapture(widget.InputCapture)
+	widget.SetDisplayFunction(widget.display)
+
+	widget.Unselect()
+	widget.filters = []string{sdk.StatusWaiting, sdk.StatusBuilding}
+
+	widget.KeyboardWidget.SetView(widget.View)
+
+	widget.client = cdsclient.New(cdsclient.Config{
+		Host:                              settings.apiURL,
+		BuitinConsumerAuthenticationToken: settings.token,
+	})
+
+	config, _ := widget.client.ConfigUser()
+
+	if config.URLUI != "" {
+		widget.settings.uiURL = config.URLUI
+	}
+
+	return &widget
+}
+
+/* -------------------- Exported Functions -------------------- */
+
+// SetItemCount sets the amount of workflows throughout the widgets display creation
+func (widget *Widget) SetItemCount(items int) {
+	widget.maxItems = items
+}
+
+// GetItemCount returns the amount of workflows calculated so far as an int
+func (widget *Widget) GetItemCount() int {
+	return widget.maxItems
+}
+
+// GetSelected returns the index of the currently highlighted item as an int
+func (widget *Widget) GetSelected() int {
+	if widget.Selected < 0 {
+		return 0
+	}
+	return widget.Selected
+}
+
+// Next cycles the currently highlighted text down
+func (widget *Widget) Next() {
+	widget.Selected++
+	if widget.Selected >= widget.maxItems {
+		widget.Selected = 0
+	}
+	widget.View.Highlight(strconv.Itoa(widget.Selected)).ScrollToHighlight()
+}
+
+// Prev cycles the currently highlighted text up
+func (widget *Widget) Prev() {
+	widget.Selected--
+	if widget.Selected < 0 {
+		widget.Selected = widget.maxItems - 1
+	}
+	widget.View.Highlight(strconv.Itoa(widget.Selected)).ScrollToHighlight()
+}
+
+// Unselect stops highlighting the text and jumps the scroll position to the top
+func (widget *Widget) Unselect() {
+	widget.Selected = -1
+	widget.View.Highlight()
+	widget.View.ScrollToBeginning()
+}
+
+// Refresh reloads the data
+func (widget *Widget) Refresh() {
+	widget.display()
+}
+
+// HelpText displays the widgets controls
+func (widget *Widget) HelpText() string {
+	return widget.KeyboardWidget.HelpText()
+}
+
+/* -------------------- Unexported Functions -------------------- */
+
+func (widget *Widget) currentFilter() string {
+	if len(widget.filters) == 0 {
+		return sdk.StatusWaiting
+	}
+
+	if widget.Idx < 0 || widget.Idx >= len(widget.filters) {
+		widget.Idx = 0
+		return sdk.StatusWaiting
+	}
+
+	return widget.filters[widget.Idx]
+}
+
+func (widget *Widget) openWorkflow() {
+	currentSelection := widget.View.GetHighlights()
+	if widget.Selected >= 0 && currentSelection[0] != "" {
+		job := widget.Items[widget.Selected]
+		prj := getVarsInPbj("cds.project", job.Parameters)
+		workflow := getVarsInPbj("cds.workflow", job.Parameters)
+		runNumber := getVarsInPbj("cds.run.number", job.Parameters)
+		url := fmt.Sprintf("%s/project/%s/workflow/%s/run/%s", widget.settings.uiURL, prj, workflow, runNumber)
+		utils.OpenFile(url)
+	}
+}