Merge pull request #629 from k1LoW/coverage-json

cmd/coverage.go

@@ -23,6 +23,7 @@ package cmd
 
 import (
 	"context"
+	"encoding/json"
 	"fmt"
 	"net/http"
 	"os"
@@ -83,6 +84,16 @@ var coverageCmd = &cobra.Command{
 		if err != nil {
 			return err
 		}
+
+		if flgs.Format == "json" {
+			b, err := json.MarshalIndent(cov, "", "  ")
+			if err != nil {
+				return err
+			}
+			_, _ = fmt.Println(string(b))
+			return nil
+		}
+
 		table := tablewriter.NewWriter(os.Stdout)
 		ct := "Coverage"
 		if flgs.Long {
@@ -159,5 +170,6 @@ func init() {
 	coverageCmd.Flags().StringSliceVarP(&flgs.GRPCProtos, "grpc-proto", "", []string{}, flgs.Usage("GRPCProtos"))
 	coverageCmd.Flags().StringSliceVarP(&flgs.GRPCImportPaths, "grpc-import-path", "", []string{}, flgs.Usage("GRPCImportPaths"))
 	coverageCmd.Flags().StringVarP(&flgs.CacheDir, "cache-dir", "", "", flgs.Usage("CacheDir"))
+	coverageCmd.Flags().StringVarP(&flgs.Format, "format", "", "", flgs.Usage("Format"))
 	coverageCmd.Flags().BoolVarP(&flgs.RetainCacheDir, "retain-cache-dir", "", false, flgs.Usage("RetainCacheDir"))
 }

coverage.go

@@ -16,17 +16,19 @@ import (
 var varRep = regexp.MustCompile(`\{\{([^}]+)\}\}`)
 var qRep = regexp.MustCompile(`\?.+$`)
 
-type coverage struct {
-	Specs []*specCoverage `json:"specs"`
+// Coverage is a coverage of runbooks
+type Coverage struct {
+	Specs []*SpecCoverage `json:"specs"`
 }
 
-type specCoverage struct {
+// SpecCoverage is a coverage of spec (e.g. OpenAPI Document, servive of protocol buffers)
+type SpecCoverage struct {
 	Key       string         `json:"key"`
 	Coverages map[string]int `json:"coverages"`
 }
 
-func (o *operator) collectCoverage(ctx context.Context) (*coverage, error) {
-	cov := &coverage{}
+func (o *operator) collectCoverage(ctx context.Context) (*Coverage, error) {
+	cov := &Coverage{}
 	// Collect coverage for openapi3
 	for name, r := range o.httpRunners {
 		ov, ok := r.validator.(*openApi3Validator)
@@ -35,11 +37,11 @@ func (o *operator) collectCoverage(ctx context.Context) (*coverage, error) {
 			continue
 		}
 		key := fmt.Sprintf("%s:%s", ov.doc.Info.Title, ov.doc.Info.Version)
-		scov, ok := lo.Find(cov.Specs, func(scov *specCoverage) bool {
+		scov, ok := lo.Find(cov.Specs, func(scov *SpecCoverage) bool {
 			return scov.Key == key
 		})
 		if !ok {
-			scov = &specCoverage{
+			scov = &SpecCoverage{
 				Key:       key,
 				Coverages: map[string]int{},
 			}
@@ -120,11 +122,11 @@ func (o *operator) collectCoverage(ctx context.Context) (*coverage, error) {
 			sm := strings.Split(k, "/")
 			service := sm[0]
 			method := sm[1]
-			scov, ok := lo.Find(cov.Specs, func(scov *specCoverage) bool {
+			scov, ok := lo.Find(cov.Specs, func(scov *SpecCoverage) bool {
 				return scov.Key == service
 			})
 			if !ok {
-				scov = &specCoverage{
+				scov = &SpecCoverage{
 					Key:       service,
 					Coverages: map[string]int{},
 				}
@@ -140,7 +142,7 @@ func (o *operator) collectCoverage(ctx context.Context) (*coverage, error) {
 				sm := strings.Split(k, "/")
 				service := sm[0]
 				method := sm[1]
-				scov, ok := lo.Find(cov.Specs, func(scov *specCoverage) bool {
+				scov, ok := lo.Find(cov.Specs, func(scov *SpecCoverage) bool {
 					return scov.Key == service
 				})
 				if !ok {

operator.go

@@ -1341,16 +1341,16 @@ func (ops *operators) SelectedOperators() ([]*operator, error) {
 	return tops, nil
 }
 
-func (ops *operators) CollectCoverage(ctx context.Context) (*coverage, error) {
-	cov := &coverage{}
+func (ops *operators) CollectCoverage(ctx context.Context) (*Coverage, error) {
+	cov := &Coverage{}
 	for _, o := range ops.ops {
 		c, err := o.collectCoverage(ctx)
 		if err != nil {
 			return nil, err
 		}
 		// Merge coverage
 		for _, sc := range c.Specs {
-			spec, ok := lo.Find(cov.Specs, func(i *specCoverage) bool {
+			spec, ok := lo.Find(cov.Specs, func(i *SpecCoverage) bool {
 				return sc.Key == i.Key
 			})
 			if !ok {