Add : Support outputting the result of 'verify' in YAML format and only outputting the summary of the result of 'verify'

commands/verify/verify.go

@@ -33,16 +33,19 @@ import (
 )
 
 var (
-	query    string
-	actual   string
-	expected string
-	printer  output.Printer
+	query       string
+	actual      string
+	expected    string
+	summaryOnly bool
+	printer     output.Printer
 )
 
 func init() {
 	Verify.Flags().StringVarP(&query, "query", "q", "", "the query to get the actual data, the result of the query should in YAML format")
 	Verify.Flags().StringVarP(&actual, "actual", "a", "", "the actual data file, only YAML file format is supported")
 	Verify.Flags().StringVarP(&expected, "expected", "e", "", "the expected data file, only YAML file format is supported")
+	Verify.Flags().StringVarP(&output.Format, "output", "o", "", "output the verify summary in which format")
+	Verify.Flags().BoolVarP(&summaryOnly, "summary-only", "", false, "")
 }
 
 // Verify verifies that the actual data satisfies the expected data pattern.
@@ -190,15 +193,20 @@ func verifyCasesSerially(verify *config.Verify, verifyInfo *verifyInfo) (err err
 	}
 
 	defer func() {
-		_, errNum, _ := printer.PrintResult(res)
-		if errNum > 0 {
-			err = fmt.Errorf("failed to verify %d case(s)", errNum)
+		if output.Format != "" {
+			output.PrintResult(res)
+		} else {
+			_, errNum, _ := printer.PrintResult(res)
+			if errNum > 0 {
+				err = fmt.Errorf("failed to verify %d case(s)", errNum)
+			}
 		}
 	}()
 
 	for idx := range verify.Cases {
 		printer.Start()
 		v := &verify.Cases[idx]
+		res[idx].CaseName = caseName(v)
 
 		if v.GetExpected() == "" {
 			res[idx].Skip = false
@@ -231,7 +239,7 @@ func verifyCasesSerially(verify *config.Verify, verifyInfo *verifyInfo) (err err
 				}
 				time.Sleep(verifyInfo.interval)
 			} else {
-				res[idx].Msg = fmt.Sprintf("failed to verify %v, retried %d time(s):", caseName(v), current)
+				res[idx].Msg = fmt.Sprintf("failed to verify %v, retried %d time(s)", caseName(v), current)
 				res[idx].Err = e
 				res[idx].Skip = false
 				printer.UpdateText(fmt.Sprintf("failed to verify %v, retry [%d/%d]", caseName(v), current, verifyInfo.retryCount))
@@ -259,6 +267,9 @@ func caseName(v *config.VerifyCase) string {
 
 // DoVerifyAccordingConfig reads cases from the config file and verifies them.
 func DoVerifyAccordingConfig() error {
+	if output.Format != "" && output.FormatIsNotExist() {
+		return fmt.Errorf(" '%s' format doesn't exist", output.Format)
+	}
 	if config.GlobalConfig.Error != nil {
 		return config.GlobalConfig.Error
 	}
@@ -284,11 +295,11 @@ func DoVerifyAccordingConfig() error {
 	concurrency := e2eConfig.Verify.Concurrency
 	if concurrency {
 		// enable batch output mode when concurrency is enabled
-		printer = output.NewPrinter(true)
+		printer = output.NewPrinter(true, false, false)
 		return verifyCasesConcurrently(&e2eConfig.Verify, &VerifyInfo)
 	}
 
-	printer = output.NewPrinter(util.BatchMode)
+	printer = output.NewPrinter(util.BatchMode, output.Format != "", summaryOnly)
 	return verifyCasesSerially(&e2eConfig.Verify, &VerifyInfo)
 }
 

internal/config/globalConfig.go

@@ -20,14 +20,15 @@ package config
 
 import (
 	"fmt"
+	"github.com/apache/skywalking-infra-e2e/pkg/output"
 	"os"
 	"path/filepath"
 
+	"gopkg.in/yaml.v2"
+
 	"github.com/apache/skywalking-infra-e2e/internal/constant"
 	"github.com/apache/skywalking-infra-e2e/internal/logger"
 	"github.com/apache/skywalking-infra-e2e/internal/util"
-
-	"gopkg.in/yaml.v2"
 )
 
 // GlobalE2EConfig stores E2EConfig which can be used globally.
@@ -76,7 +77,9 @@ func ReadGlobalConfigFile() {
 	}
 
 	GlobalConfig.Error = nil
-	logger.Log.Info("load the e2e config successfully")
+	if output.Format == "" {
+		logger.Log.Info("load the e2e config successfully")
+	}
 }
 
 func convertVerify(verify *Verify) error {

pkg/output/output.go

@@ -0,0 +1,71 @@
+//
+// Licensed to Apache Software Foundation (ASF) under one or more contributor
+// license agreements. See the NOTICE file distributed with
+// this work for additional information regarding copyright
+// ownership. Apache Software Foundation (ASF) licenses this file to you under
+// the Apache License, Version 2.0 (the "License"); you may
+// not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+package output
+
+import (
+	"fmt"
+
+	"gopkg.in/yaml.v2"
+)
+
+var (
+	Format  string
+	Formats = []string{"yaml"}
+)
+
+type YamlCaseResult struct {
+	Passed  []string
+	Failed  []string
+	Skipped []string
+}
+
+func FormatIsNotExist() bool {
+	for _, format := range Formats {
+		if Format == format {
+			return false
+		}
+	}
+
+	return true
+}
+
+func PrintResult(caseRes []*CaseResult) {
+	switch Format {
+	case "yaml":
+		PrintResultInYAML(caseRes)
+	}
+}
+
+func PrintResultInYAML(caseRes []*CaseResult) {
+	var yamlCaseResult YamlCaseResult
+	for _, cr := range caseRes {
+		if !cr.Skip {
+			if cr.Err == nil {
+				yamlCaseResult.Passed = append(yamlCaseResult.Passed, cr.CaseName)
+			} else {
+				yamlCaseResult.Failed = append(yamlCaseResult.Failed, cr.CaseName)
+			}
+		} else {
+			yamlCaseResult.Skipped = append(yamlCaseResult.Skipped, cr.CaseName)
+		}
+	}
+
+	yaml, _ := yaml.Marshal(yamlCaseResult)
+	fmt.Print(string(yaml))
+}

pkg/output/printer.go

@@ -19,15 +19,15 @@
 
 import (
 	"fmt"
-
 	"github.com/pterm/pterm"
 )
 
 // CaseResult represents the result of a verification case.
 type CaseResult struct {
-	Msg  string
-	Err  error
-	Skip bool
+	CaseName string
+	Msg      string
+	Err      error
+	Skip     bool
 }
 
 type Printer interface {
@@ -40,59 +40,64 @@
 }
 
 type printer struct {
-	spinner     *pterm.SpinnerPrinter
-	batchOutput bool
+	spinner        *pterm.SpinnerPrinter
+	batchOutput    bool
+	outputInFormat bool
+	summaryOnly    bool
 }
 
 var _ Printer = &printer{}
 
-func NewPrinter(batchOutput bool) Printer {
+func NewPrinter(batchOutput bool, outputInFormat bool, summaryOnly bool) Printer {
 	spinner := pterm.DefaultSpinner.WithShowTimer(false)
 	pterm.Error.Prefix = pterm.Prefix{
 		Text:  "DETAILS",
 		Style: &pterm.ThemeDefault.ErrorPrefixStyle,
 	}
 
 	return &printer{
-		spinner:     spinner,
-		batchOutput: batchOutput,
+		spinner:        spinner,
+		batchOutput:    batchOutput,
+		outputInFormat: outputInFormat,
+		summaryOnly:    summaryOnly,
 	}
 }
 
 func (p *printer) Start(msg ...string) {
-	if p.batchOutput {
+	if p.batchOutput || p.outputInFormat || p.summaryOnly {
 		return
 	}
 
 	p.spinner, _ = p.spinner.Start(msg)
 }
 
 func (p *printer) Success(msg string) {
-	if p.batchOutput {
+
+	if p.batchOutput || p.outputInFormat || p.summaryOnly {
 		return
 	}
 
 	p.spinner.Success(msg)
 }
 
 func (p *printer) Warning(msg string) {
-	if p.batchOutput {
+	if p.batchOutput || p.outputInFormat || p.summaryOnly {
 		return
 	}
 
 	p.spinner.Warning(msg)
 }
 
 func (p *printer) Fail(msg string) {
-	if p.batchOutput {
+	if p.batchOutput || p.outputInFormat || p.summaryOnly {
 		return
 	}
 
 	p.spinner.Fail(msg)
 }
 
 func (p *printer) UpdateText(text string) {
-	if p.batchOutput {
+	if p.batchOutput || p.outputInFormat || p.summaryOnly {
 		return
 	}
 
@@ -116,6 +121,7 @@
 				if p.batchOutput {
 					p.spinner.Warning(cr.Msg)
 					p.spinner.Fail(cr.Err.Error())
+
 				}
 			}
 		} else {