feat: cds modules

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

modules/cds/favorites/display.go

@@ -0,0 +1,92 @@
+package cdsfavorites
+
+import (
+	"fmt"
+
+	"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([]int64, 0)
+
+	workflow := widget.currentCDSWorkflow()
+	if workflow == nil {
+		return "", " Workflow not selected ", false
+	}
+
+	_, _, width, _ := widget.View.GetRect()
+	str := widget.settings.common.SigilStr(len(widget.workflows), widget.Idx, width) + "\n"
+	title := fmt.Sprintf("%s - %s", widget.CommonSettings().Title, widget.title(workflow))
+
+	str += widget.displayWorkflowRuns(workflow)
+
+	return title, str, false
+}
+
+func (widget *Widget) title(workflow *sdk.Workflow) string {
+	return fmt.Sprintf(
+		"[%s]%s/%s[white]",
+		widget.settings.common.Colors.TextTheme.Title,
+		workflow.ProjectKey, workflow.Name,
+	)
+}
+
+func (widget *Widget) displayWorkflowRuns(workflow *sdk.Workflow) string {
+	runs, _ := widget.client.WorkflowRunList(workflow.ProjectKey, workflow.Name, 0, 16)
+
+	widget.SetItemCount(len(runs))
+
+	if len(runs) == 0 {
+		return " [grey]none[white]\n"
+	}
+
+	content := ""
+	for idx, run := range runs {
+		var tags string
+		for _, tag := range run.Tags {
+			toadd := true
+			for _, v := range widget.settings.hideTags {
+				if v == tag.Tag {
+					toadd = false
+					break
+				}
+			}
+			if toadd {
+				tags = fmt.Sprintf("%s%s:%s ", tags, tag.Tag, tag.Value)
+			}
+		}
+		content += fmt.Sprintf(`[%s]["%d"]%d %-6s[""][gray] %s`, getStatusColor(run.Status), idx, run.Number, run.Status, tags)
+		content += "\n"
+		widget.Items = append(widget.Items, run.Number)
+	}
+
+	return content
+}
+
+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"
+}

modules/cds/favorites/keyboard.go

@@ -0,0 +1,22 @@
+package cdsfavorites
+
+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 source")
+	widget.SetKeyboardChar("h", widget.PrevSource, "Select previous source")
+	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 source")
+	widget.SetKeyboardKey(tcell.KeyLeft, widget.PrevSource, "Select previous source")
+	widget.SetKeyboardKey(tcell.KeyEnter, widget.openWorkflow, "Open workflow in browser")
+	widget.SetKeyboardKey(tcell.KeyEsc, widget.Unselect, "Clear selection")
+}

modules/cds/favorites/settings.go

@@ -0,0 +1,34 @@
+package cdsfavorites
+
+import (
+	"os"
+
+	"github.com/olebedev/config"
+	"github.com/wtfutil/wtf/cfg"
+	"github.com/wtfutil/wtf/utils"
+)
+
+const (
+	defaultFocusable = true
+	defaultTitle     = "CDS Favorites"
+)
+
+// 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
+	hideTags []string `help:"Hide some workflow tags."`
+}
+
+// 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")),
+		hideTags: utils.ToStrs(ymlConfig.UList("hideTags")),
+	}
+	return &settings
+}

modules/cds/favorites/widget.go

@@ -0,0 +1,154 @@
+package cdsfavorites
+
+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
+
+	workflows []sdk.Workflow
+
+	client cdsclient.Interface
+
+	settings *Settings
+	Selected int
+	maxItems int
+	Items    []int64
+}
+
+// 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.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
+	}
+
+	widget.workflows = widget.buildWorkflowsCollection()
+	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) buildWorkflowsCollection() []sdk.Workflow {
+	workflows := []sdk.Workflow{}
+	data, _ := widget.client.Navbar()
+	for _, v := range data {
+		if v.Favorite && v.WorkflowName != "" {
+			workflows = append(workflows, sdk.Workflow{ProjectKey: v.Key, Name: v.WorkflowName})
+		}
+	}
+	return workflows
+}
+
+func (widget *Widget) currentCDSWorkflow() *sdk.Workflow {
+	if len(widget.workflows) == 0 {
+		return nil
+	}
+
+	if widget.Idx < 0 || widget.Idx >= len(widget.workflows) {
+		widget.Idx = 0
+		return nil
+	}
+
+	p := widget.workflows[widget.Idx]
+	return &p
+}
+
+func (widget *Widget) openWorkflow() {
+	currentSelection := widget.View.GetHighlights()
+	if widget.Selected >= 0 && currentSelection[0] != "" {
+		wf := widget.currentCDSWorkflow()
+		url := fmt.Sprintf("%s/project/%s/workflow/%s/run/%d",
+			widget.settings.uiURL, wf.ProjectKey, wf.Name, widget.Items[widget.Selected])
+		utils.OpenFile(url)
+	}
+}