feat: more robust linting

See coop-cloud/organising#254.

pkg/recipe/recipe.go

@@ -2,6 +2,7 @@ package recipe
 
 import (
 	"fmt"
+	"io/ioutil"
 	"os"
 	"path"
 	"path/filepath"
@@ -18,6 +19,25 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+// Image represents a recipe container image.
+type Image struct {
+	Image  string `json:"image"`
+	Rating string `json:"rating"`
+	Source string `json:"source"`
+	URL    string `json:"url"`
+}
+
+// Features represent what top-level features a recipe supports (e.g. does this recipe support backups?).
+type Features struct {
+	Backups     string `json:"backups"`
+	Email       string `json:"email"`
+	Healthcheck string `json:"healthcheck"`
+	Image       Image  `json:"image"`
+	Status      int    `json:"status"`
+	Tests       string `json:"tests"`
+	SSO         string `json:"sso"`
+}
+
 // Recipe represents a recipe.
 type Recipe struct {
 	Name   string
@@ -333,3 +353,131 @@ func EnsureUpToDate(recipeName string) error {
 
 	return nil
 }
+
+func GetRecipeFeaturesAndCategory(recipeName string) (Features, string, error) {
+	feat := Features{}
+
+	var category string
+
+	readmePath := path.Join(config.RECIPES_DIR, recipeName, "README.md")
+
+	logrus.Debugf("attempting to open %s for recipe metadata parsing", readmePath)
+
+	readmeFS, err := ioutil.ReadFile(readmePath)
+	if err != nil {
+		return feat, category, err
+	}
+
+	readmeMetadata, err := GetStringInBetween( // Find text between delimiters
+		string(readmeFS),
+		"<!-- metadata -->", "<!-- endmetadata -->",
+	)
+	if err != nil {
+		return feat, category, err
+	}
+
+	readmeLines := strings.Split( // Array item from lines
+		strings.ReplaceAll( // Remove \t tabs
+			readmeMetadata, "\t", "",
+		),
+		"\n")
+
+	for _, val := range readmeLines {
+		if strings.Contains(val, "**Category**") {
+			category = strings.TrimSpace(
+				strings.TrimPrefix(val, "* **Category**:"),
+			)
+		}
+		if strings.Contains(val, "**Backups**") {
+			feat.Backups = strings.TrimSpace(
+				strings.TrimPrefix(val, "* **Backups**:"),
+			)
+		}
+		if strings.Contains(val, "**Email**") {
+			feat.Email = strings.TrimSpace(
+				strings.TrimPrefix(val, "* **Email**:"),
+			)
+		}
+		if strings.Contains(val, "**SSO**") {
+			feat.SSO = strings.TrimSpace(
+				strings.TrimPrefix(val, "* **SSO**:"),
+			)
+		}
+		if strings.Contains(val, "**Healthcheck**") {
+			feat.Healthcheck = strings.TrimSpace(
+				strings.TrimPrefix(val, "* **Healthcheck**:"),
+			)
+		}
+		if strings.Contains(val, "**Tests**") {
+			feat.Tests = strings.TrimSpace(
+				strings.TrimPrefix(val, "* **Tests**:"),
+			)
+		}
+		if strings.Contains(val, "**Image**") {
+			imageMetadata, err := GetImageMetadata(strings.TrimSpace(
+				strings.TrimPrefix(val, "* **Image**:"),
+			), recipeName)
+			if err != nil {
+				continue
+			}
+			feat.Image = imageMetadata
+		}
+	}
+
+	return feat, category, nil
+}
+
+func GetImageMetadata(imageRowString, recipeName string) (Image, error) {
+	img := Image{}
+
+	imgFields := strings.Split(imageRowString, ",")
+
+	for i, elem := range imgFields {
+		imgFields[i] = strings.TrimSpace(elem)
+	}
+
+	if len(imgFields) < 3 {
+		if imageRowString != "" {
+			logrus.Warnf("%s image meta has incorrect format: %s", recipeName, imageRowString)
+		} else {
+			logrus.Warnf("%s image meta is empty?", recipeName)
+		}
+		return img, nil
+	}
+
+	img.Rating = imgFields[1]
+	img.Source = imgFields[2]
+
+	imgString := imgFields[0]
+
+	imageName, err := GetStringInBetween(imgString, "[", "]")
+	if err != nil {
+		logrus.Fatal(err)
+	}
+	img.Image = strings.ReplaceAll(imageName, "`", "")
+
+	imageURL, err := GetStringInBetween(imgString, "(", ")")
+	if err != nil {
+		logrus.Fatal(err)
+	}
+	img.URL = imageURL
+
+	return img, nil
+}
+
+// GetStringInBetween returns empty string if no start or end string found
+func GetStringInBetween(str, start, end string) (result string, err error) {
+	s := strings.Index(str, start)
+	if s == -1 {
+		return "", fmt.Errorf("marker string %s not found", start)
+	}
+
+	s += len(start)
+	e := strings.Index(str[s:], end)
+
+	if e == -1 {
+		return "", fmt.Errorf("end marker %s not found", end)
+	}
+
+	return str[s : s+e], nil
+}