add examples support for draft info (#165)

Author: davidgamero

.github/workflows/e2e-info.yml

@@ -0,0 +1,19 @@
+name: Draft Info E2E Test
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Go
+        uses: actions/setup-go@v2
+        with:
+          go-version: 1.18.2
+      - name: make
+        run: make
+      - name: Validate JSON
+        run: |
+          ./test/check_info_schema.sh

.github/workflows/integration-info.yml

@@ -6,4 +6,5 @@ vendor/
 draft
 langtest
 .vscode/
-/pkg/languages/builders
+/pkg/languages/builders
+info.json

.gitignore

@@ -16,6 +16,11 @@ go-generate:
 run-unit-tests:
 	docker build . -t gotest && docker run -t --rm --name draft-test gotest test ./... -buildvcs=false
 
+#TODO: add more e2e tests to the local testing
+.PHONY: run-e2e-tests-local
+run-e2e-tests-local: go-generate vendor build
+	test/check_info_schema.sh;
+
 .PHONY: generate-integrations
 generate-integrations:
 	cd ./test; \

Makefile

@@ -50,25 +50,24 @@ If you plan on deploying your application through your GitHub Action, commit all
 
 ### `draft info`
 The `draft info` command prints information about supported languages and deployment types.
-Example output:
+
+Example output (for brevity, only the first supported language is shown):
 ```
 {
-  "supported_languages": [
-    "php",
-    "python",
-    "rust",
-    "swift",
-    "csharp",
-    "go",
-    "gradle",
-    "javascript",
-    "ruby",
-    "clojure",
-    "erlang",
-    "gomodule",
-    "java"
-  ],
-  "supported_deployment_types": [
+  "supportedLanguages": [
+    {
+      "name": "clojure",
+      "displayName": "Clojure",
+      "variableExampleValues": {
+        "VERSION": [
+          "8-jdk-alpine",
+          "11-jdk-alpine"
+        ]
+      }
+    }
+  ]
+  ...,
+  "supportedDeploymentTypes": [
     "helm",
     "kustomize",
     "manifests"

README.md

@@ -23,9 +23,16 @@ type infoCmd struct {
 	info   *draftInfo
 }
 
+// draftConfigInfo is a struct that contains information about the example usage of variables for a single draft.yaml
+type draftConfigInfo struct {
+	Name                  string              `json:"name"`
+	DisplayName           string              `json:"displayName,omitempty"`
+	VariableExampleValues map[string][]string `json:"variableExampleValues,omitempty"`
+}
+
 type draftInfo struct {
-	SupportedLanguages       []string `json:"supported_languages"`
-	SupportedDeploymentTypes []string `json:"supported_deployment_types"`
+	SupportedLanguages       []draftConfigInfo `json:"supportedLanguages"`
+	SupportedDeploymentTypes []string          `json:"supportedDeploymentTypes"`
 }
 
 func newInfoCmd() *cobra.Command {
@@ -52,8 +59,19 @@ func (ic *infoCmd) run() error {
 	l := languages.CreateLanguagesFromEmbedFS(template.Dockerfiles, "")
 	d := deployments.CreateDeploymentsFromEmbedFS(template.Deployments, "")
 
+	languagesInfo := make([]draftConfigInfo, 0)
+	for _, lang := range l.Names() {
+		langConfig := l.GetConfig(lang)
+		newConfig := draftConfigInfo{
+			Name:                  lang,
+			DisplayName:           langConfig.DisplayName,
+			VariableExampleValues: langConfig.GetVariableExampleValues(),
+		}
+		languagesInfo = append(languagesInfo, newConfig)
+	}
+
 	ic.info = &draftInfo{
-		SupportedLanguages:       l.Names(),
+		SupportedLanguages:       languagesInfo,
 		SupportedDeploymentTypes: d.DeployTypes(),
 	}
 

cmd/info.go

@@ -6,6 +6,7 @@ import (
 
 //TODO: remove Name Overrides since we don't need them anymore
 type DraftConfig struct {
+	DisplayName      string              `yaml:"displayName"`
 	NameOverrides    []FileNameOverride  `yaml:"nameOverrides"`
 	Variables        []BuilderVar        `yaml:"variables"`
 	VariableDefaults []BuilderVarDefault `yaml:"variableDefaults"`
@@ -19,9 +20,10 @@ type FileNameOverride struct {
 }
 
 type BuilderVar struct {
-	Name        string `yaml:"name"`
-	Description string `yaml:"description"`
-	VarType     string `yaml:"type"`
+	Name          string   `yaml:"name"`
+	Description   string   `yaml:"description"`
+	VarType       string   `yaml:"type"`
+	ExampleValues []string `yaml:"exampleValues"`
 }
 
 type BuilderVarDefault struct {
@@ -30,6 +32,16 @@ type BuilderVarDefault struct {
 	ReferenceVar string `yaml:"referenceVar"`
 }
 
+func (d *DraftConfig) GetVariableExampleValues() map[string][]string {
+	variableExampleValues := make(map[string][]string)
+	for _, variable := range d.Variables {
+		if len(variable.ExampleValues) > 0 {
+			variableExampleValues[variable.Name] = variable.ExampleValues
+		}
+	}
+	return variableExampleValues
+}
+
 func (d *DraftConfig) initNameOverrideMap() {
 	d.nameOverrideMap = make(map[string]string)
 	log.Debug("initializing nameOverrideMap")

pkg/config/draftconfig.go

@@ -1,10 +1,12 @@
 language: clojure
+displayName: Clojure
 variables:
   - name: "PORT"
     description: "the port exposed in the application"
     type: int
   - name: "VERSION"
     description: "the version of openjdk that the application uses"
+    exampleValues: ["8-jdk-alpine","11-jdk-alpine"]
 variableDefaults:
   - name: "VERSION"
     value: "8-jdk-alpine"

template/dockerfiles/clojure/draft.yaml

@@ -1,11 +1,13 @@
 language: csharp
+displayName: C#
 variables:
   - name: "PORT"
     description: "the port exposed in the application"
     type: int
   - name: "VERSION"
     description: "the dotnet SDK version"
     type: float
+    exampleValues: ["3.1","4.0","5.0","6.0"]
 variableDefaults:
   - name: "VERSION"
     value: "5.0"

template/dockerfiles/csharp/draft.yaml

@@ -1,4 +1,5 @@
 language: erlang
+displayName: Erlang
 nameOverrides:
   - path: "dockerignore"
     prefix: "."
@@ -8,8 +9,10 @@ variables:
     type: int
   - name: "BUILDERVERSION"
     description: "the version of erlang used during the builder stage to generate the executable"
+    exampleValues: ["24.2-alpine"]
   - name: "VERSION"
     description: "the version of alpine used by the application"
+    exampleValues: ["3.15"]
 variableDefaults:
   - name: "BUILDERVERSION"
     value: "24.2-alpine"