improve github summary feature

Signed-off-by: Markus Blaschke <mblaschke82@gmail.com>

Author: mblaschke

README.md

@@ -357,5 +357,10 @@ or
 
 ```
 
+## Experimental features
+
+| Env var                           | Description                     |
+|-----------------------------------|---------------------------------|
+| `AZURETPL_EXPERIMENTAL_SUMMARY=1` | Post CICD summary (only GitHub) |
 
 PS: some code is borrowed from [Helm](https://github.com/helm/helm)

azuretpl/command.go

@@ -18,6 +18,8 @@ import (
 	"github.com/webdevops/go-common/azuresdk/armclient"
 	"github.com/webdevops/go-common/msgraphsdk/msgraphclient"
 	"go.uber.org/zap"
+
+	"github.com/webdevops/helm-azure-tpl/azuretpl/models"
 )
 
 type (
@@ -28,7 +30,7 @@ type (
 		cache    *cache.Cache
 		cacheTtl time.Duration
 
-		opts Opts
+		opts models.Opts
 
 		UserAgent string
 
@@ -40,21 +42,6 @@ type (
 		LintMode bool
 
 		azureCliAccountInfo map[string]interface{}
-
-		summary map[string][]string
-	}
-
-	Opts struct {
-		Keyvault struct {
-			ExpiryWarning time.Duration `long:"keyvault.expiry.warningduration"   env:"AZURETPL_KEYVAULT_EXPIRY_WARNING_DURATION"   description:"warn before soon expiring Azure KeyVault entries" default:"168h"`
-			IgnoreExpiry  bool          `long:"keyvault.expiry.ignore"            env:"AZURETPL_KEYVAULT_EXPIRY_IGNORE"   description:"ignore expiry date of Azure KeyVault entries and don't fail'"`
-		}
-
-		ValuesFiles  []string `long:"values"  env:"AZURETPL_VALUES" env-delim:":" description:"path to yaml files for .Values"`
-		JSONValues   []string `long:"set-json"                           description:"set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2)"`
-		Values       []string `long:"set"                                description:"set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)"`
-		StringValues []string `long:"set-string"                         description:"set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)"`
-		FileValues   []string `long:"set-file"                           description:"set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)"`
 	}
 )
 
@@ -63,14 +50,13 @@ var (
 	msGraphClient *msgraphclient.MsGraphClient
 )
 
-func New(ctx context.Context, opts Opts, logger *zap.SugaredLogger) *AzureTemplateExecutor {
+func New(ctx context.Context, opts models.Opts, logger *zap.SugaredLogger) *AzureTemplateExecutor {
 	e := &AzureTemplateExecutor{
 		ctx:    ctx,
 		logger: logger,
 		opts:   opts,
 
 		cacheTtl: 15 * time.Minute,
-		summary:  map[string][]string{},
 	}
 	e.init()
 	return e
@@ -338,8 +324,6 @@ func (e *AzureTemplateExecutor) Parse(path string, templateData interface{}, buf
 		return fmt.Errorf(`unable to process template: '%w'`, err)
 	}
 
-	e.postSummary()
-
 	if err = os.Chdir(oldPwd); err != nil {
 		return e.handleCicdError(err)
 	}

azuretpl/models/opts.go

@@ -0,0 +1,20 @@
+package models
+
+import (
+	"time"
+)
+
+type (
+	Opts struct {
+		Keyvault struct {
+			ExpiryWarning time.Duration `long:"keyvault.expiry.warningduration"   env:"AZURETPL_KEYVAULT_EXPIRY_WARNING_DURATION"   description:"warn before soon expiring Azure KeyVault entries" default:"168h"`
+			IgnoreExpiry  bool          `long:"keyvault.expiry.ignore"            env:"AZURETPL_KEYVAULT_EXPIRY_IGNORE"   description:"ignore expiry date of Azure KeyVault entries and don't fail'"`
+		}
+
+		ValuesFiles  []string `long:"values"  env:"AZURETPL_VALUES" env-delim:":" description:"path to yaml files for .Values"`
+		JSONValues   []string `long:"set-json"                           description:"set JSON values on the command line (can specify multiple or separate values with commas: key1=jsonval1,key2=jsonval2)"`
+		Values       []string `long:"set"                                description:"set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)"`
+		StringValues []string `long:"set-string"                         description:"set STRING values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2)"`
+		FileValues   []string `long:"set-file"                           description:"set values from respective files specified via the command line (can specify multiple or separate values with commas: key1=path1,key2=path2)"`
+	}
+)

azuretpl/summary.go

@@ -8,74 +8,99 @@ import (
 
 	"github.com/Azure/azure-sdk-for-go/sdk/security/keyvault/azsecrets"
 	"github.com/webdevops/go-common/utils/to"
+	"go.uber.org/zap"
+
+	"github.com/webdevops/helm-azure-tpl/config"
+)
+
+const (
+	SummaryHeader      = "# helm-azure-tpl summary\n"
+	SummaryValueNotSet = "<n/a>"
+)
+
+var (
+	summary map[string][]string = map[string][]string{}
 )
 
 func (e *AzureTemplateExecutor) addSummaryLine(section, val string) {
-	if _, ok := e.summary[section]; !ok {
-		e.summary[section] = []string{}
+	if _, ok := summary[section]; !ok {
+		summary[section] = []string{}
 	}
 
-	e.summary[section] = append(e.summary[section], val)
+	summary[section] = append(summary[section], val)
 }
 
 func (e *AzureTemplateExecutor) addSummaryKeyvaultSecret(vaultUrl string, secret azsecrets.GetSecretResponse) {
 	section := "Azure Keyvault Secrets"
-	if _, ok := e.summary[section]; !ok {
-		e.summary[section] = []string{
+	if _, ok := summary[section]; !ok {
+		summary[section] = []string{
 			"| KeyVault | Secret | Version | ContentType | Expiry |",
 			"|----------|--------|---------|-------------|--------|",
 		}
 	}
 
-	expiryDate := "<not set>"
+	expiryDate := SummaryValueNotSet
 	if secret.Attributes != nil && secret.Attributes.Expires != nil {
 		expiryDate = secret.Attributes.Expires.Format(time.RFC3339)
 	}
 
+	contentType := to.String(secret.ContentType)
+	if contentType == "" {
+		contentType = SummaryValueNotSet
+	}
+
 	val := fmt.Sprintf(
 		"| %s | %s | %s | %s | %s |",
 		vaultUrl,
 		secret.ID.Name(),
 		secret.ID.Version(),
-		to.String(secret.ContentType),
+		contentType,
 		expiryDate,
 	)
 
-	e.summary[section] = append(e.summary[section], val)
+	summary[section] = append(summary[section], val)
 }
 
-func (e *AzureTemplateExecutor) buildSummary() string {
-	output := []string{
-		"# helm-azure-tpl summary",
+func buildSummary(opts config.Opts) string {
+	output := []string{SummaryHeader}
+
+	output = append(output, "templates:\n")
+	for _, file := range opts.Args.Files {
+		output = append(output, fmt.Sprintf("- %s", file))
 	}
 
-	for section, rows := range e.summary {
+	for section, rows := range summary {
 		output = append(output, fmt.Sprintf("\n### %s\n", section))
 		output = append(output, strings.Join(rows, "\n"))
 	}
 
 	return "\n" + strings.Join(output, "\n") + "\n"
 }
 
-func (e *AzureTemplateExecutor) postSummary() {
+func PostSummary(logger *zap.SugaredLogger, opts config.Opts) {
 	if val := os.Getenv("AZURETPL_EXPERIMENTAL_SUMMARY"); val != "true" && val != "1" {
 		return
 	}
 
+	// skip empty summary
+	if len(summary) == 0 {
+		return
+	}
+
 	// github summary
 	if summaryPath := os.Getenv("GITHUB_STEP_SUMMARY"); summaryPath != "" {
-		content := e.buildSummary()
+		content := buildSummary(opts)
 
 		// If the file doesn't exist, create it, or append to the file
 		f, err := os.OpenFile(summaryPath, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
 		if err != nil {
-			e.logger.Warnf(`unable to post GITHUB step summary: %w`, err)
+			logger.Warnf(`unable to post GITHUB step summary: %w`, err)
 			return
 		}
 		defer f.Close() // nolint: errcheck
 
 		if _, err := f.Write([]byte(content)); err != nil {
-			e.logger.Warnf(`unable to post GITHUB step summary: %w`, err)
+			logger.Warnf(`unable to post GITHUB step summary: %w`, err)
 		}
 	}
 }

config/opts.go

@@ -3,7 +3,7 @@ package config
 import (
 	"encoding/json"
 
-	"github.com/webdevops/helm-azure-tpl/azuretpl"
+	"github.com/webdevops/helm-azure-tpl/azuretpl/models"
 )
 
 type (
@@ -34,7 +34,7 @@ type (
 			FileExt *string `long:"target.fileext"  env:"AZURETPL_TARGET_FILEEXT"  description:"replaces file extension (or adds if empty) with this value (eg. '.yaml')"`
 		}
 
-		AzureTpl azuretpl.Opts
+		AzureTpl models.Opts
 
 		Args struct {
 			Command string   `positional-arg-name:"command" description:"specifies what to do (help, version, lint, apply)" choice:"help" choice:"version" choice:"lint" choice:"apply" required:"yes"` // nolint:staticcheck

process.go

@@ -14,6 +14,8 @@ import (
 	"go.uber.org/zap"
 	yaml "gopkg.in/yaml.v3"
 	"helm.sh/helm/v3/pkg/strvals"
+
+	"github.com/webdevops/helm-azure-tpl/azuretpl"
 )
 
 const (
@@ -91,6 +93,8 @@ func run() {
 			}
 		}
 
+		azuretpl.PostSummary(logger, opts)
+
 		logger.With(zap.Duration("duration", time.Since(startTime))).Info("finished")
 	default:
 		fmt.Printf("invalid command '%v'\n", opts.Args.Command)