Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

test: Add mocking #9

Merged
merged 6 commits into from Mar 11, 2024
Merged

test: Add mocking #9

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
00fd4d2
Add mocking
andreaangiolillo Mar 11, 2024
45ec0b1
fixes
andreaangiolillo Mar 11, 2024
65b246d
Addressed PR comments - Part 1
andreaangiolillo Mar 11, 2024
04bb4cd
addressed PR comments - Part 2
andreaangiolillo Mar 11, 2024
11e55d9
lint
andreaangiolillo Mar 11, 2024
4b2fb0b
Update tools/cli/Makefile
andreaangiolillo Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 7 additions & 2 deletions tools/cli/Makefile
View file
Open in desktop
Expand Up @@ -24,15 +24,16 @@ deps: ## Download go module dependencies
.PHONY: devtools
devtools: ## Install dev tools
@echo "==> Installing dev tools..."
go install go.uber.org/mock/mockgen@latest
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell go env GOPATH)/bin $(GOLANGCI_VERSION)

.PHONY: setup
setup: deps devtools ## Set up dev env

.PHONY: fmt
fmt: ### Format all go files with goimports and gofmt
find . -name "*.go" -exec gofmt -w "{}" \;
find . -name "*.go" -exec goimports -l -w "{}" \;
find . -name "*.go" -not -path "./internal/mocks" -exec gofmt -w "{}" \;
find . -name "*.go" -not -path "./internal/mocks" -exec goimports -l -w "{}" \;
andreaangiolillo marked this conversation as resolved.
Show resolved Hide resolved

.PHONY: build
build:
Expand All @@ -57,6 +58,10 @@ fix-lint: ## Fix linting errors
list: ## List all make targets
@${MAKE} -pRrn : -f $(MAKEFILE_LIST) 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | egrep -v -e '^[^[:alnum:]]' -e '^$@$$' | sort

.PHONY: gen-mocks
gen-mocks: ## Generate mocks
@echo "==> Generating mocks"
go generate ./internal...

.PHONY: help
.DEFAULT_GOAL := help
Expand Down
3 changes: 3 additions & 0 deletions tools/cli/go.mod
View file
Open in desktop
Expand Up @@ -4,9 +4,11 @@ go 1.22.1

require (
github.com/getkin/kin-openapi v0.123.0
github.com/spf13/afero v1.11.0
github.com/spf13/cobra v1.8.0
github.com/stretchr/testify v1.9.0
github.com/tufin/oasdiff v1.10.11
go.uber.org/mock v0.4.0
)

require (
Expand All @@ -24,5 +26,6 @@ require (
github.com/spf13/pflag v1.0.5 // indirect
github.com/ugorji/go/codec v1.2.11 // indirect
github.com/yargevad/filepathx v1.0.0 // indirect
golang.org/x/text v0.14.0 // indirect
gopkg.in/yaml.v3 v3.0.1 // indirect
)
6 changes: 6 additions & 0 deletions tools/cli/go.sum
View file
Open in desktop
Expand Up @@ -36,6 +36,8 @@ github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZN
github.com/rogpeppe/go-internal v1.12.0 h1:exVL4IDcn6na9z1rAb56Vxr+CgyK3nn3O+epU5NdKM8=
github.com/rogpeppe/go-internal v1.12.0/go.mod h1:E+RYuTGaKKdloAfM02xzb0FW3Paa99yedzYV+kq4uf4=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/spf13/afero v1.11.0 h1:WJQKhtpdm3v2IzqG8VMqrr6Rf3UYpEF239Jy9wNepM8=
github.com/spf13/afero v1.11.0/go.mod h1:GH9Y3pIexgf1MTIWtNGyogA5MwRIDXGUr+hbWNoBjkY=
github.com/spf13/cobra v1.8.0 h1:7aJaZx1B85qltLMc546zn58BxxfZdR/W22ej9CFoEf0=
github.com/spf13/cobra v1.8.0/go.mod h1:WXLWApfZ71AjXPya3WOlMsY9yMs7YeiHhFVlvLyhcho=
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
Expand All @@ -48,8 +50,12 @@ github.com/ugorji/go/codec v1.2.11 h1:BMaWp1Bb6fHwEtbplGBGJ498wD+LKlNSl25MjdZY4d
github.com/ugorji/go/codec v1.2.11/go.mod h1:UNopzCgEMSXjBc6AOMqYvWC1ktqTAfzJZUZgYf6w6lg=
github.com/yargevad/filepathx v1.0.0 h1:SYcT+N3tYGi+NvazubCNlvgIPbzAk7i7y2dwg3I5FYc=
github.com/yargevad/filepathx v1.0.0/go.mod h1:BprfX/gpYNJHJfc35GjRRpVcwWXS89gGulUIU5tK3tA=
go.uber.org/mock v0.4.0 h1:VcM4ZOtdbR4f6VXfiOpwpVJDL6lCReaZ6mw31wqh7KU=
go.uber.org/mock v0.4.0/go.mod h1:a6FSlNadKUHUa9IP5Vyt1zh4fC7uAwxMutEAscFbkZc=
golang.org/x/exp v0.0.0-20240119083558-1b970713d09a h1:Q8/wZp0KX97QFTc2ywcOE0YRjZPVIx+MXInMzdvQqcA=
golang.org/x/exp v0.0.0-20240119083558-1b970713d09a/go.mod h1:idGWGoKP1toJGkd5/ig9ZLuPcZBC3ewk7SzmH0uou08=
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c h1:Hei/4ADfdWqJk1ZMxUNpqntNwaWcugrBjAiHlqqRiVk=
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
Expand Down
15 changes: 9 additions & 6 deletions tools/cli/internal/cli/merge/merge.go
View file
Open in desktop
Expand Up @@ -17,11 +17,11 @@ package merge
import (
"fmt"
"log"
"os"

"github.com/mongodb/openapi/tools/cli/internal/cli/flag"
"github.com/mongodb/openapi/tools/cli/internal/cli/usage"
"github.com/mongodb/openapi/tools/cli/internal/openapi"
"github.com/spf13/afero"
"github.com/spf13/cobra"
)

Expand All @@ -31,12 +31,13 @@ const (

type Opts struct {
Merger openapi.Merger
fs afero.Fs
basePath string
outputPath string
externalPaths []string
}

func (o *Opts) Run(_ []string) error {
func (o *Opts) Run() error {
federated, err := o.Merger.MergeOpenAPISpecs(o.externalPaths)
if err != nil {
return err
Expand Down Expand Up @@ -65,7 +66,7 @@ func (o *Opts) PreRunE(_ []string) error {
}

func (o *Opts) saveFile(data []byte) error {
if err := os.WriteFile(o.outputPath, data, 0o600); err != nil {
if err := afero.WriteFile(o.fs, o.outputPath, data, 0o600); err != nil {
return err
}

Expand All @@ -76,7 +77,9 @@ func (o *Opts) saveFile(data []byte) error {
// Builder builds the merge command with the following signature:
// merge -b base-oas -e external-oas-1 -e external-oas-2
func Builder() *cobra.Command {
opts := &Opts{}
opts := &Opts{
fs: afero.NewOsFs(),
}

cmd := &cobra.Command{
Use: "merge -b base-spec [-e spec]...",
Expand All @@ -85,8 +88,8 @@ func Builder() *cobra.Command {
PreRunE: func(_ *cobra.Command, args []string) error {
return opts.PreRunE(args)
},
RunE: func(_ *cobra.Command, args []string) error {
return opts.Run(args)
RunE: func(_ *cobra.Command, _ []string) error {
return opts.Run()
},
}

Expand Down
35 changes: 35 additions & 0 deletions tools/cli/internal/cli/merge/merge_test.go
View file
Open in desktop
Expand Up @@ -17,10 +17,45 @@ package merge
import (
"testing"

"github.com/getkin/kin-openapi/openapi3"
"github.com/mongodb/openapi/tools/cli/internal/cli/flag"
"github.com/mongodb/openapi/tools/cli/internal/cli/validator"
"github.com/mongodb/openapi/tools/cli/internal/openapi"
"github.com/spf13/afero"
"github.com/tufin/oasdiff/load"
"go.uber.org/mock/gomock"
)

func TestSuccessfulMerge_Run(t *testing.T) {
ctrl := gomock.NewController(t)
mockMergerStore := openapi.NewMockMerger(ctrl)
fs := afero.NewMemMapFs()
externalPaths := []string{"external.json"}
opts := &Opts{
Merger: mockMergerStore,
basePath: "base.json",
outputPath: "foas.json",
externalPaths: externalPaths,
fs: fs,
}

response := &load.SpecInfo{
Spec: &openapi3.T{},
Url: "test",
Version: "3.0.1",
}

mockMergerStore.
EXPECT().
MergeOpenAPISpecs(opts.externalPaths).
Return(response, nil).
Times(1)

if err := opts.Run(); err != nil {
t.Fatalf("Run() unexpected error: %v", err)
}
}

func TestCreateBuilder(t *testing.T) {
validator.ValidateSubCommandsAndFlags(
t,
Expand Down
14 changes: 14 additions & 0 deletions tools/cli/internal/openapi/errors/path_conflict_error.go
View file
Open in desktop
@@ -1,3 +1,17 @@
// Copyright 2024 MongoDB Inc
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[q] Not strictly related to this PR but was curious if there are alternatives to having a license header placed in all files, such as a LICENSE file at the root of the project.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for apache should be both

//
// Licensed 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 errors

import "fmt"
Expand Down
93 changes: 93 additions & 0 deletions tools/cli/internal/openapi/mock_openapi.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 14 additions & 42 deletions tools/cli/internal/openapi/oasdiff.go
View file
Open in desktop
@@ -1,8 +1,20 @@
// Copyright 2024 MongoDB Inc
//
// Licensed 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 openapi

import (
"log"

"github.com/mongodb/openapi/tools/cli/internal/openapi/errors"
"github.com/tufin/oasdiff/diff"
"github.com/tufin/oasdiff/load"
Expand All @@ -16,46 +28,6 @@ type OasDiff struct {
parser Parser
}

func NewOasDiff(base string) (*OasDiff, error) {
parser := NewOpenAPI3()
baseSpec, err := parser.CreateOpenAPISpecFromPath(base)
if err != nil {
return nil, err
}

return &OasDiff{
base: baseSpec,
parser: parser,
config: &diff.Config{
IncludePathParams: true,
},
}, nil
}

func (o *OasDiff) MergeOpenAPISpecs(paths []string) (*load.SpecInfo, error) {
for _, p := range paths {
spec, err := o.parser.CreateOpenAPISpecFromPath(p)
if err != nil {
return nil, err
}

specDiff, err := diff.Get(o.config, o.base.Spec, spec.Spec)
if err != nil {
log.Fatalf("error in calculating the diff of the specs: %s", err)
return nil, err
}

o.specDiff = specDiff
o.external = spec
err = o.mergeSpecIntoBase()
if err != nil {
return nil, err
}
}

return o.base, nil
}

func (o OasDiff) mergeSpecIntoBase() error {
return o.mergePaths()
}
Expand Down