feat: update the merge logic to generate an OAS where the fields are in the same order as the Atlas OAS (#35)

Author: andreaangiolillo

tools/cli/internal/cli/merge/merge.go

@@ -15,7 +15,6 @@
 package merge
 
 import (
-	"bytes"
 	"encoding/json"
 	"fmt"
 	"log"
@@ -41,13 +40,14 @@ func (o *Opts) Run() error {
 		return err
 	}
 
-	federatedBytes, err := federated.Spec.MarshalJSON()
+	federatedBytes, err := json.MarshalIndent(*federated, "", "  ")
 	if err != nil {
 		return err
 	}
 
 	if o.outputPath == "" {
-		return prettyPrintJSON(federatedBytes)
+		fmt.Println(string(federatedBytes))
+		return nil
 	}
 
 	return o.saveFile(federatedBytes)
@@ -67,15 +67,6 @@ func (o *Opts) PreRunE(_ []string) error {
 	return err
 }
 
-func prettyPrintJSON(jsonBytes []byte) error {
-	var prettyJSON bytes.Buffer
-	if err := json.Indent(&prettyJSON, jsonBytes, "", "    "); err != nil {
-		return err
-	}
-	fmt.Println(prettyJSON.String())
-	return nil
-}
-
 func (o *Opts) saveFile(data []byte) error {
 	if err := afero.WriteFile(o.fs, o.outputPath, data, 0o600); err != nil {
 		return err

tools/cli/internal/cli/merge/merge_test.go

@@ -23,7 +23,6 @@ import (
 	"github.com/mongodb/openapi/tools/cli/internal/openapi"
 	"github.com/spf13/afero"
 	"github.com/stretchr/testify/require"
-	"github.com/tufin/oasdiff/load"
 	"go.uber.org/mock/gomock"
 )
 
@@ -40,10 +39,11 @@ func TestSuccessfulMerge_Run(t *testing.T) {
 		fs:            fs,
 	}
 
-	response := &load.SpecInfo{
-		Spec:    &openapi3.T{},
-		Url:     "test",
-		Version: "3.0.1",
+	response := &openapi.Spec{
+		OpenAPI: "v3.0.1",
+		Info:    &openapi3.Info{},
+		Servers: nil,
+		Tags:    openapi3.Tags{},
 	}
 
 	mockMergerStore.

tools/cli/internal/openapi/mock_openapi.go

@@ -18,6 +18,7 @@ package openapi
 import (
 	"log"
 
+	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/tufin/oasdiff/diff"
 	"github.com/tufin/oasdiff/load"
 )
@@ -27,10 +28,21 @@ type Parser interface {
 }
 
 type Merger interface {
-	MergeOpenAPISpecs([]string) (*load.SpecInfo, error)
+	MergeOpenAPISpecs([]string) (*Spec, error)
 }
 
-func (o *OasDiff) MergeOpenAPISpecs(paths []string) (*load.SpecInfo, error) {
+type Spec struct {
+	OpenAPI      string                        `json:"openapi" yaml:"openapi"`
+	Security     openapi3.SecurityRequirements `json:"security,omitempty" yaml:"security,omitempty"`
+	Servers      openapi3.Servers              `json:"servers,omitempty" yaml:"servers,omitempty"`
+	Tags         openapi3.Tags                 `json:"tags,omitempty" yaml:"tags,omitempty"`
+	Info         *openapi3.Info                `json:"info" yaml:"info"`
+	Paths        *openapi3.Paths               `json:"paths" yaml:"paths"`
+	Components   *openapi3.Components          `json:"components,omitempty" yaml:"components,omitempty"`
+	ExternalDocs *openapi3.ExternalDocs        `json:"externalDocs,omitempty" yaml:"externalDocs,omitempty"`
+}
+
+func (o *OasDiff) MergeOpenAPISpecs(paths []string) (*Spec, error) {
 	for _, p := range paths {
 		spec, err := o.parser.CreateOpenAPISpecFromPath(p)
 		if err != nil {
@@ -51,7 +63,7 @@ func (o *OasDiff) MergeOpenAPISpecs(paths []string) (*load.SpecInfo, error) {
 		}
 	}
 
-	return o.base, nil
+	return newSpec(o.base), nil
 }
 
 func NewOasDiff(base string) (*OasDiff, error) {
@@ -69,3 +81,16 @@ func NewOasDiff(base string) (*OasDiff, error) {
 		},
 	}, nil
 }
+
+func newSpec(specInfo *load.SpecInfo) *Spec {
+	return &Spec{
+		OpenAPI:      specInfo.Spec.OpenAPI,
+		Components:   specInfo.Spec.Components,
+		Info:         specInfo.Spec.Info,
+		Paths:        specInfo.Spec.Paths,
+		Security:     specInfo.Spec.Security,
+		Servers:      specInfo.Spec.Servers,
+		Tags:         specInfo.Spec.Tags,
+		ExternalDocs: specInfo.Spec.ExternalDocs,
+	}
+}