From d1c0c10a1a64cdf2bf034091319005a5335fe954 Mon Sep 17 00:00:00 2001 From: Rick <1450685+LinuxSuRen@users.noreply.github.com> Date: Tue, 1 Aug 2023 07:28:53 +0800 Subject: [PATCH] feat: add s3 storage backend extension (#151) * feat: add s3 storage backend extension * test: add unit tests --- .github/workflows/build.yaml | 12 + Dockerfile | 1 + Makefile | 5 +- README.md | 1 + docs/README.md | 26 +++ extensions/store-s3/cmd/root.go | 54 +++++ extensions/store-s3/cmd/root_test.go | 44 ++++ extensions/store-s3/go.mod | 8 + extensions/store-s3/go.sum | 38 +++ extensions/store-s3/main.go | 15 ++ extensions/store-s3/pkg/fake_s3.go | 71 ++++++ extensions/store-s3/pkg/s3_server.go | 268 ++++++++++++++++++++++ extensions/store-s3/pkg/s3_server_test.go | 201 ++++++++++++++++ go.work | 3 +- pkg/testing/parser.go | 8 + pkg/testing/remote/context.go | 4 + pkg/testing/remote/converter.go | 12 +- pkg/testing/remote/converter_test.go | 6 +- pkg/testing/remote/grpc.go | 6 +- sample/kubernetes/default/manifest.yaml | 12 + 20 files changed, 785 insertions(+), 10 deletions(-) create mode 100644 extensions/store-s3/cmd/root.go create mode 100644 extensions/store-s3/cmd/root_test.go create mode 100644 extensions/store-s3/go.mod create mode 100644 extensions/store-s3/go.sum create mode 100644 extensions/store-s3/main.go create mode 100644 extensions/store-s3/pkg/fake_s3.go create mode 100644 extensions/store-s3/pkg/s3_server.go create mode 100644 extensions/store-s3/pkg/s3_server_test.go diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 8b85308..d35ae0c 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -23,6 +23,7 @@ jobs: bash <(curl -Ls https://coverage.codacy.com/get.sh) report --partial --force-coverage-parser go -r coverage.out bash <(curl -Ls https://coverage.codacy.com/get.sh) report --partial --force-coverage-parser go -r collector-coverage.out bash <(curl -Ls https://coverage.codacy.com/get.sh) report --partial --force-coverage-parser go -r store-orm-coverage.out + bash <(curl -Ls https://coverage.codacy.com/get.sh) report --partial --force-coverage-parser go -r store-s3-coverage.out bash <(curl -Ls https://coverage.codacy.com/get.sh) final - name: API Test run: | @@ -48,6 +49,17 @@ jobs: - name: Image run: make build-image + BuildImage: + runs-on: ubuntu-20.04 + steps: + - name: Set up Go + uses: actions/setup-go@v3 + with: + go-version: 1.18.x + - uses: actions/checkout@v3.0.0 + - name: Image + run: make build-image + BuildEmbedUI: runs-on: ubuntu-20.04 steps: diff --git a/Dockerfile b/Dockerfile index 7de42f2..d1f2008 100644 --- a/Dockerfile +++ b/Dockerfile @@ -22,6 +22,7 @@ RUN GOPROXY=${GOPROXY} go mod download RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s -X github.com/linuxsuren/api-testing/pkg/version.version=${VERSION}" -o atest . RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s" -o atest-collector extensions/collector/main.go RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s" -o atest-store-orm extensions/store-orm/main.go +RUN GOPROXY=${GOPROXY} CGO_ENABLED=0 go build -ldflags "-w -s" -o atest-store-s3 extensions/store-s3/main.go FROM node:20-alpine3.17 AS ui diff --git a/Makefile b/Makefile index 1cd5159..9eeb423 100644 --- a/Makefile +++ b/Makefile @@ -45,7 +45,10 @@ test-collector: test-store-orm: go test github.com/linuxsuren/api-testing/extensions/store-orm/./... -cover -v -coverprofile=store-orm-coverage.out go tool cover -func=store-orm-coverage.out -test-all-backend: test test-collector test-store-orm +test-store-s3: + go test github.com/linuxsuren/api-testing/extensions/store-s3/./... -cover -v -coverprofile=store-s3-coverage.out + go tool cover -func=store-s3-coverage.out +test-all-backend: test test-collector test-store-orm test-store-s3 test-all: test-all-backend test-ui install-precheck: diff --git a/README.md b/README.md index 6ea2743..e8b6633 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ This is a API testing tool. * Output reference between TestCase * Run in server mode, and provide the [gRPC](pkg/server/server.proto) and HTTP endpoint * [VS Code extension](https://github.com/LinuxSuRen/vscode-api-testing) support +* Multiple storage backends supported(Local, ORM Database, S3, etc) * [HTTP API record](extensions/collector) ## Get started diff --git a/docs/README.md b/docs/README.md index 29a0753..a13241b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -108,6 +108,32 @@ podman run -p 7071:7071 \ ghcr.io/linuxsuren/api-testing:master atest-store-orm ``` +### ORM S3 Storage +You can use a S3 compatible storage as the storage backend. + +```shell +# The default port is 7072 +podman run --network host \ + ghcr.io/linuxsuren/api-testing:master atest-store-s3 +``` + +See also the expected configuration below: + +```yaml +- name: s3 + url: http://172.11.0.13:30999 # address of the s3 server + kind: + name: s3 + url: localhost:7072 # address of the s3 storage extension + properties: + accessKeyID: 6e03rIMChrsZ6YZl + secretAccessKey: F0xH6o2qRYTyAUyRuXO81B4gj7zUrSaj + disableSSL: true + forcepathstyle: true + bucket: vm1 + region: cn +``` + ## Extensions Developers could have a storage extension. Implement a gRPC server according to [loader.proto](../pkg/testing/remote/loader.proto) is required. diff --git a/extensions/store-s3/cmd/root.go b/extensions/store-s3/cmd/root.go new file mode 100644 index 0000000..df808da --- /dev/null +++ b/extensions/store-s3/cmd/root.go @@ -0,0 +1,54 @@ +package cmd + +import ( + "fmt" + "net" + + "github.com/linuxsuren/api-testing/extensions/store-s3/pkg" + "github.com/linuxsuren/api-testing/pkg/testing/remote" + "github.com/spf13/cobra" + "google.golang.org/grpc" +) + +func NewRootCmd(s3Creator pkg.S3Creator) (cmd *cobra.Command) { + opt := &option{ + S3Creator: s3Creator, + } + cmd = &cobra.Command{ + Use: "store-s3", + Short: "S3 storage extension of api-testing", + RunE: opt.runE, + } + flags := cmd.Flags() + flags.IntVarP(&opt.port, "port", "p", 7072, "The port of gRPC server") + return cmd +} + +func (o *option) runE(cmd *cobra.Command, args []string) (err error) { + removeServer := pkg.NewRemoteServer(o.S3Creator) + + var lis net.Listener + lis, err = net.Listen("tcp", fmt.Sprintf(":%d", o.port)) + if err != nil { + return + } + + gRPCServer := grpc.NewServer() + remote.RegisterLoaderServer(gRPCServer, removeServer) + cmd.Println("S3 storage extension is running at port", o.port) + + go func() { + <-cmd.Context().Done() + gRPCServer.Stop() + }() + + err = gRPCServer.Serve(lis) + return +} + +type option struct { + port int + + // inner fields + S3Creator pkg.S3Creator +} diff --git a/extensions/store-s3/cmd/root_test.go b/extensions/store-s3/cmd/root_test.go new file mode 100644 index 0000000..7df92b1 --- /dev/null +++ b/extensions/store-s3/cmd/root_test.go @@ -0,0 +1,44 @@ +package cmd + +import ( + "context" + "io" + "testing" + "time" + + "github.com/spf13/cobra" + "github.com/stretchr/testify/assert" +) + +func TestNewRootCmd(t *testing.T) { + t.Run("not run", func(t *testing.T) { + cmd := newRootCmdForTest() + assert.NotNil(t, cmd) + assert.Equal(t, "store-s3", cmd.Use) + assert.Equal(t, "7072", cmd.Flags().Lookup("port").Value.String()) + }) + + t.Run("invalid port", func(t *testing.T) { + cmd := newRootCmdForTest() + cmd.SetArgs([]string{"--port", "-1"}) + err := cmd.Execute() + assert.Error(t, err) + }) + + t.Run("stop the command", func(t *testing.T) { + ctx, cancel := context.WithTimeout(context.TODO(), time.Second) + defer cancel() + + cmd := newRootCmdForTest() + cmd.SetContext(ctx) + cmd.SetArgs([]string{"--port", "0"}) + err := cmd.Execute() + assert.NoError(t, err) + }) +} + +func newRootCmdForTest() *cobra.Command { + cmd := NewRootCmd(nil) + cmd.SetOut(io.Discard) + return cmd +} diff --git a/extensions/store-s3/go.mod b/extensions/store-s3/go.mod new file mode 100644 index 0000000..95f57c5 --- /dev/null +++ b/extensions/store-s3/go.mod @@ -0,0 +1,8 @@ +module github.com/linuxsuren/api-testing/extensions/store-s3 + +go 1.20 + +require ( + github.com/aws/aws-sdk-go v1.44.312 // indirect + github.com/jmespath/go-jmespath v0.4.0 // indirect +) diff --git a/extensions/store-s3/go.sum b/extensions/store-s3/go.sum new file mode 100644 index 0000000..ee9b604 --- /dev/null +++ b/extensions/store-s3/go.sum @@ -0,0 +1,38 @@ +github.com/aws/aws-sdk-go v1.44.312 h1:llrElfzeqG/YOLFFKjg1xNpZCFJ2xraIi3PqSuP+95k= +github.com/aws/aws-sdk-go v1.44.312/go.mod h1:aVsgQcEevwlmQ7qHE9I3h+dtQgpqhFB+i8Phjh7fkwI= +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg= +github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo= +github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U= +github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.1.0/go.mod h1:Cx3nUiGt4eDBEyega/BKRp+/AlGL8hYe7U9odMt2Cco= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI= diff --git a/extensions/store-s3/main.go b/extensions/store-s3/main.go new file mode 100644 index 0000000..89fbce7 --- /dev/null +++ b/extensions/store-s3/main.go @@ -0,0 +1,15 @@ +package main + +import ( + "os" + + "github.com/linuxsuren/api-testing/extensions/store-s3/cmd" + "github.com/linuxsuren/api-testing/extensions/store-s3/pkg" +) + +func main() { + cmd := cmd.NewRootCmd(&pkg.DefaultS3Creator{}) + if err := cmd.Execute(); err != nil { + os.Exit(1) + } +} diff --git a/extensions/store-s3/pkg/fake_s3.go b/extensions/store-s3/pkg/fake_s3.go new file mode 100644 index 0000000..97e7fb1 --- /dev/null +++ b/extensions/store-s3/pkg/fake_s3.go @@ -0,0 +1,71 @@ +package pkg + +import ( + "bytes" + "io" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/s3" +) + +type S3API interface { + ListObjectsWithContext(ctx aws.Context, input *s3.ListObjectsInput, opts ...request.Option) (*s3.ListObjectsOutput, error) + PutObjectWithContext(ctx aws.Context, input *s3.PutObjectInput, opts ...request.Option) (*s3.PutObjectOutput, error) + GetObjectWithContext(ctx aws.Context, input *s3.GetObjectInput, opts ...request.Option) (*s3.GetObjectOutput, error) + DeleteObjectWithContext(ctx aws.Context, input *s3.DeleteObjectInput, opts ...request.Option) (*s3.DeleteObjectOutput, error) +} + +type S3Creator interface { + New(p client.ConfigProvider, cfgs ...*aws.Config) S3API +} + +type DefaultS3Creator struct{} + +func (d *DefaultS3Creator) New(p client.ConfigProvider, cfgs ...*aws.Config) S3API { + return s3.New(p, cfgs...) +} + +type fakeS3 struct { + data map[*string][]byte +} + +func (f *fakeS3) New(p client.ConfigProvider, cfgs ...*aws.Config) S3API { + return f +} + +func (f *fakeS3) ListObjectsWithContext(ctx aws.Context, input *s3.ListObjectsInput, opts ...request.Option) (output *s3.ListObjectsOutput, err error) { + output = &s3.ListObjectsOutput{} + for k := range f.data { + output.Contents = append(output.Contents, &s3.Object{ + Key: k, + }) + } + return +} +func (f *fakeS3) PutObjectWithContext(ctx aws.Context, input *s3.PutObjectInput, opts ...request.Option) (*s3.PutObjectOutput, error) { + data, err := io.ReadAll(input.Body) + f.data[input.Key] = data + return nil, err +} +func (f *fakeS3) GetObjectWithContext(ctx aws.Context, input *s3.GetObjectInput, opts ...request.Option) (output *s3.GetObjectOutput, err error) { + for k := range f.data { + if *input.Key == *k { + output = &s3.GetObjectOutput{ + Body: io.NopCloser(bytes.NewReader(f.data[k])), + } + break + } + } + return +} +func (f *fakeS3) DeleteObjectWithContext(ctx aws.Context, input *s3.DeleteObjectInput, opts ...request.Option) (*s3.DeleteObjectOutput, error) { + for k := range f.data { + if *input.Key == *k { + delete(f.data, k) + break + } + } + return nil, nil +} diff --git a/extensions/store-s3/pkg/s3_server.go b/extensions/store-s3/pkg/s3_server.go new file mode 100644 index 0000000..aaa57d6 --- /dev/null +++ b/extensions/store-s3/pkg/s3_server.go @@ -0,0 +1,268 @@ +package pkg + +import ( + "bytes" + "context" + "errors" + "strings" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/credentials" + "github.com/aws/aws-sdk-go/aws/session" + "github.com/aws/aws-sdk-go/service/s3" + "github.com/linuxsuren/api-testing/pkg/server" + "github.com/linuxsuren/api-testing/pkg/testing" + "github.com/linuxsuren/api-testing/pkg/testing/remote" + "gopkg.in/yaml.v3" +) + +type s3Client struct { + S3Creator S3Creator + remote.UnimplementedLoaderServer +} + +func NewRemoteServer(S3Creator S3Creator) remote.LoaderServer { + return &s3Client{S3Creator: S3Creator} +} + +func (s *s3Client) ListTestSuite(ctx context.Context, _ *server.Empty) (suites *remote.TestSuites, err error) { + suites = &remote.TestSuites{} + var client *s3WithBucket + if client, err = s.getClient(ctx); err != nil || client == nil { + return + } + + var list *s3.ListObjectsOutput + if list, err = client.ListObjectsWithContext(ctx, &s3.ListObjectsInput{ + Bucket: aws.String(client.bucket), + }); err == nil && list != nil { + suites, err = listObjectsOutputToTestSuite(ctx, list, client) + } + return +} +func listObjectsOutputToTestSuite(ctx context.Context, list *s3.ListObjectsOutput, client *s3WithBucket) ( + suites *remote.TestSuites, err error) { + var suite *testing.TestSuite + suites = &remote.TestSuites{} + for _, obj := range list.Contents { + if !strings.HasSuffix(*obj.Key, ".yaml") { + continue + } + + var objOutput *s3.GetObjectOutput + if objOutput, err = client.GetObjectWithContext(ctx, &s3.GetObjectInput{ + Bucket: aws.String(client.bucket), + Key: obj.Key, + }); err == nil { + data := objOutput.Body + if suite, err = testing.ParseFromStream(data); err == nil { + suites.Data = append(suites.Data, remote.ConvertToGRPCTestSuite(suite)) + } + } + } + return +} +func (s *s3Client) CreateTestSuite(ctx context.Context, testSuite *remote.TestSuite) (reply *server.Empty, err error) { + suite := remote.ConvertToNormalTestSuite(testSuite) + reply = &server.Empty{} + + var data []byte + if data, err = yaml.Marshal(suite); err == nil { + var client *s3WithBucket + if client, err = s.getClient(ctx); err == nil { + _, err = client.PutObjectWithContext(ctx, &s3.PutObjectInput{ + Bucket: aws.String(client.bucket), + Key: generateKey(suite.Name), + Body: bytes.NewReader(data), + }) + } + } + + return +} +func (s *s3Client) GetTestSuite(ctx context.Context, suite *remote.TestSuite) (reply *remote.TestSuite, err error) { + reply = &remote.TestSuite{} + var client *s3WithBucket + if client, err = s.getClient(ctx); err == nil && client != nil { + var objOutput *s3.GetObjectOutput + if objOutput, err = client.GetObjectWithContext(ctx, &s3.GetObjectInput{ + Bucket: aws.String(client.bucket), + Key: generateKey(suite.Name), + }); err == nil && objOutput != nil { + data := objOutput.Body + + var suite *testing.TestSuite + if suite, err = testing.ParseFromStream(data); err == nil { + reply = remote.ConvertToGRPCTestSuite(suite) + } + } + } + return +} +func (s *s3Client) UpdateTestSuite(ctx context.Context, suite *remote.TestSuite) (reply *remote.TestSuite, err error) { + reply = &remote.TestSuite{} + var oldSuite *remote.TestSuite + if oldSuite, err = s.GetTestSuite(ctx, suite); err == nil { + suite.Items = oldSuite.Items + _, err = s.CreateTestSuite(ctx, suite) + } + return +} +func (s *s3Client) DeleteTestSuite(ctx context.Context, suite *remote.TestSuite) (reply *server.Empty, err error) { + reply = &server.Empty{} + var client *s3WithBucket + if client, err = s.getClient(ctx); err == nil && client != nil { + _, err = client.DeleteObjectWithContext(ctx, &s3.DeleteObjectInput{ + Bucket: aws.String(client.bucket), + Key: generateKey(suite.Name), + }) + } + return +} +func (s *s3Client) ListTestCases(ctx context.Context, suite *remote.TestSuite) (result *server.TestCases, err error) { + if suite, err = s.GetTestSuite(ctx, suite); err == nil { + result = &server.TestCases{ + Data: suite.Items, + } + } + return +} +func (s *s3Client) CreateTestCase(ctx context.Context, testcase *server.TestCase) (reply *server.Empty, err error) { + reply = &server.Empty{} + + var suite *remote.TestSuite + if suite, err = s.GetTestSuite(ctx, &remote.TestSuite{ + Name: testcase.SuiteName, + }); err == nil { + suite.Items = append(suite.Items, testcase) + _, err = s.CreateTestSuite(ctx, suite) + } + return +} +func (s *s3Client) GetTestCase(ctx context.Context, testcase *server.TestCase) (result *server.TestCase, err error) { + var suite *remote.TestSuite + if suite, err = s.GetTestSuite(ctx, &remote.TestSuite{ + Name: testcase.SuiteName, + }); err == nil { + result = getTestCaseByName(suite, testcase.Name) + } + return +} +func (s *s3Client) UpdateTestCase(ctx context.Context, testcase *server.TestCase) (reply *server.TestCase, err error) { + reply = &server.TestCase{} + var suite *remote.TestSuite + if suite, err = s.GetTestSuite(ctx, &remote.TestSuite{ + Name: testcase.SuiteName, + }); err == nil { + suite = updateTestCase(suite, testcase) + _, err = s.CreateTestSuite(ctx, suite) + } + return +} +func (s *s3Client) DeleteTestCase(ctx context.Context, testcase *server.TestCase) (reply *server.Empty, err error) { + var suite *remote.TestSuite + if suite, err = s.GetTestSuite(ctx, &remote.TestSuite{ + Name: testcase.SuiteName, + }); err == nil { + suite = removeTestCaseByName(suite, testcase.Name) + _, err = s.UpdateTestSuite(ctx, suite) + } + return +} +func (s *s3Client) getClient(ctx context.Context) (db *s3WithBucket, err error) { + store := remote.GetStoreFromContext(ctx) + if store == nil { + err = errors.New("no connect to s3 server") + } else { + var ok bool + if db, ok = clientCache[store.Name]; ok && db != nil { + return + } + + options := mapToS3Options(store.Properties) + cred := credentials.NewStaticCredentials(options.AccessKeyID, options.SecretAccessKey, options.SessionToken) + + config := aws.Config{ + Region: aws.String(options.Region), + Endpoint: aws.String(store.URL), + DisableSSL: aws.Bool(options.DisableSSL), + S3ForcePathStyle: aws.Bool(options.ForcePathStyle), + Credentials: cred, + } + + var sess *session.Session + sess, err = session.NewSession(&config) + if err == nil { + svc := s.S3Creator.New(sess) // s3.New(sess) + db = &s3WithBucket{S3API: svc, bucket: options.Bucket} + clientCache[store.Name] = db + } + } + return +} + +func mapToS3Options(data map[string]string) (opt s3Options) { + opt.AccessKeyID = data["accesskeyid"] + opt.SecretAccessKey = data["secretaccesskey"] + opt.SessionToken = data["sessiontoken"] + opt.Region = data["region"] + opt.DisableSSL = data["disablessl"] == "true" + opt.ForcePathStyle = data["forcepathstyle"] == "true" + opt.Bucket = data["bucket"] + return +} + +func generateKey(name string) *string { + return aws.String(name + ".yaml") +} + +func removeTestCaseByName(suite *remote.TestSuite, name string) *remote.TestSuite { + for i, item := range suite.Items { + if item.Name == name { + suite.Items = append(suite.Items[:i], suite.Items[i+1:]...) + break + } + } + return suite +} + +func updateTestCase(suite *remote.TestSuite, testcase *server.TestCase) *remote.TestSuite { + for i, item := range suite.Items { + if item.Name == testcase.Name { + suite.Items[i] = testcase + break + } + } + return suite +} + +func getTestCaseByName(suite *remote.TestSuite, name string) (result *server.TestCase) { + for _, item := range suite.Items { + if item.Name == name { + result = item + break + } + } + return +} + +type s3Options struct { + // AWS Access key ID + AccessKeyID string `yaml:"accessKeyID"` + // AWS Secret Access Key + SecretAccessKey string `yaml:"secretAccessKey"` + // AWS Session Token + SessionToken string `yaml:"sessionToken"` + // AWS Region + Region string `yaml:"region"` + DisableSSL bool `yaml:"disableSSL"` + ForcePathStyle bool `yaml:"forcePathStyle"` + Bucket string `yaml:"bucket"` +} + +type s3WithBucket struct { + S3API + bucket string +} + +var clientCache map[string]*s3WithBucket = make(map[string]*s3WithBucket) diff --git a/extensions/store-s3/pkg/s3_server_test.go b/extensions/store-s3/pkg/s3_server_test.go new file mode 100644 index 0000000..ba97f68 --- /dev/null +++ b/extensions/store-s3/pkg/s3_server_test.go @@ -0,0 +1,201 @@ +package pkg + +import ( + "context" + "testing" + + "github.com/aws/aws-sdk-go/aws" + "github.com/linuxsuren/api-testing/pkg/server" + atest "github.com/linuxsuren/api-testing/pkg/testing" + "github.com/linuxsuren/api-testing/pkg/testing/remote" + "github.com/stretchr/testify/assert" +) + +func newRemoteServer(t *testing.T) remote.LoaderServer { + remoteServer := NewRemoteServer(&fakeS3{data: map[*string][]byte{ + aws.String("invalid"): []byte("invalid"), + }}) + assert.NotNil(t, remoteServer) + return remoteServer +} + +func TestNewRemoteServer(t *testing.T) { + emptyCtx := context.Background() + defaultCtx := remote.WithIncomingStoreContext(emptyCtx, &atest.Store{}) + + t.Run("ListTestSuite, no required info in context", func(t *testing.T) { + _, err := newRemoteServer(t).ListTestSuite(emptyCtx, nil) + assert.Error(t, err) + }) + + t.Run("ListTestSuite", func(t *testing.T) { + _, err := newRemoteServer(t).ListTestSuite(defaultCtx, nil) + assert.NoError(t, err) + }) + + t.Run("CreateTestSuite", func(t *testing.T) { + server := newRemoteServer(t) + _, err := server.CreateTestSuite(defaultCtx, &remote.TestSuite{ + Name: "fake", + }) + assert.NoError(t, err) + + var suites *remote.TestSuites + suites, err = server.ListTestSuite(defaultCtx, nil) + if assert.NoError(t, err) { + assert.Equal(t, "fake", suites.Data[0].Name) + } + + var suite *remote.TestSuite + suite, err = server.GetTestSuite(defaultCtx, &remote.TestSuite{Name: "fake"}) + if assert.NoError(t, err) { + assert.Equal(t, "fake", suite.Name) + } + }) + + t.Run("GetTestSuite", func(t *testing.T) { + _, err := newRemoteServer(t).GetTestSuite(defaultCtx, &remote.TestSuite{ + Name: "fake", + }) + assert.NoError(t, err) + }) + + t.Run("UpdateTestSuite", func(t *testing.T) { + _, err := newRemoteServer(t).UpdateTestSuite(defaultCtx, &remote.TestSuite{ + Name: "fake", + }) + assert.NoError(t, err) + }) + + t.Run("DeleteTestSuite", func(t *testing.T) { + server := newRemoteServer(t) + _, err := server.CreateTestSuite(defaultCtx, &remote.TestSuite{ + Name: "fake", + }) + assert.NoError(t, err) + + _, err = server.DeleteTestSuite(defaultCtx, &remote.TestSuite{ + Name: "fake", + }) + assert.NoError(t, err) + }) + + t.Run("ListTestCases", func(t *testing.T) { + _, err := newRemoteServer(t).ListTestCases(defaultCtx, &remote.TestSuite{ + Name: "fake", + }) + assert.NoError(t, err) + }) + + t.Run("CreateTestCase", func(t *testing.T) { + _, err := newRemoteServer(t).CreateTestCase(defaultCtx, &server.TestCase{ + Name: "fake", + SuiteName: "fake", + }) + assert.NoError(t, err) + }) + + t.Run("GetTestCase", func(t *testing.T) { + _, err := newRemoteServer(t).GetTestCase(defaultCtx, &server.TestCase{ + Name: "fake", + SuiteName: "fake", + }) + assert.NoError(t, err) + }) + + t.Run("UpdateTestCase", func(t *testing.T) { + _, err := newRemoteServer(t).UpdateTestCase(defaultCtx, &server.TestCase{ + Name: "fake", + SuiteName: "fake", + }) + assert.NoError(t, err) + }) + + t.Run("DeleteTestCase", func(t *testing.T) { + _, err := newRemoteServer(t).DeleteTestCase(defaultCtx, &server.TestCase{ + Name: "fake", + SuiteName: "fake", + }) + assert.NoError(t, err) + }) +} + +func TestCommonFuns(t *testing.T) { + t.Run("generateKey", func(t *testing.T) { + assert.Equal(t, "test.yaml", *generateKey("test")) + }) + + t.Run("mapToS3Options", func(t *testing.T) { + assert.Equal(t, s3Options{ + AccessKeyID: "id", + SecretAccessKey: "secret", + SessionToken: "token", + Region: "region", + DisableSSL: true, + ForcePathStyle: true, + Bucket: "bucket", + }, mapToS3Options(map[string]string{ + "accesskeyid": "id", + "secretaccesskey": "secret", + "sessiontoken": "token", + "region": "region", + "disablessl": "true", + "forcepathstyle": "true", + "bucket": "bucket", + })) + }) + + t.Run("removeTestCaseByName, an empty TestSuite", func(t *testing.T) { + suite := &remote.TestSuite{ + Items: []*server.TestCase{{ + Name: "fake", + }}, + } + + assert.Equal(t, suite, removeTestCaseByName(suite, "test")) + }) + + t.Run("removeTestCaseByName, a normal TestSuite", func(t *testing.T) { + suite := &remote.TestSuite{ + Items: []*server.TestCase{{ + Name: "fake", + }}, + } + + assert.Empty(t, removeTestCaseByName(suite, "fake").Items) + }) + + t.Run("updateTestCase", func(t *testing.T) { + suite := &remote.TestSuite{ + Items: []*server.TestCase{{ + Name: "fake", + Request: &server.Request{ + Method: "GET", + }, + }}, + } + + suite = updateTestCase(suite, &server.TestCase{ + Name: "fake", + Request: &server.Request{ + Method: "POST", + }, + }) + assert.Equal(t, "POST", suite.Items[0].Request.Method) + }) + + t.Run("getTestCaseByName", func(t *testing.T) { + testCase := &server.TestCase{ + Name: "fake", + Request: &server.Request{ + Api: "http://fake.com", + }, + } + sampleTestSuite := &remote.TestSuite{ + Items: []*server.TestCase{testCase}, + } + + testcase := getTestCaseByName(sampleTestSuite, "fake") + assert.Equal(t, testCase, testcase) + }) +} diff --git a/go.work b/go.work index 6a69f9e..fe04969 100644 --- a/go.work +++ b/go.work @@ -3,4 +3,5 @@ go 1.19 use ./ use ./extensions/collector use ./extensions/store-etcd -use ./extensions/store-orm \ No newline at end of file +use ./extensions/store-orm +use ./extensions/store-s3 diff --git a/pkg/testing/parser.go b/pkg/testing/parser.go index 23f84e9..8d3a0db 100644 --- a/pkg/testing/parser.go +++ b/pkg/testing/parser.go @@ -41,6 +41,14 @@ func Parse(data []byte) (testSuite *TestSuite, err error) { return } +func ParseFromStream(stream io.Reader) (testSuite *TestSuite, err error) { + var data []byte + if data, err = io.ReadAll(stream); err == nil { + testSuite, err = ParseFromData(data) + } + return +} + // ParseFromData parses data and returns the test suite func ParseFromData(data []byte) (testSuite *TestSuite, err error) { testSuite = &TestSuite{} diff --git a/pkg/testing/remote/context.go b/pkg/testing/remote/context.go index bf6a169..a2fb937 100644 --- a/pkg/testing/remote/context.go +++ b/pkg/testing/remote/context.go @@ -42,6 +42,10 @@ func GetStoreFromContext(ctx context.Context) (store *testing.Store) { return } +func WithIncomingStoreContext(ctx context.Context, store *testing.Store) context.Context { + return metadata.NewIncomingContext(ctx, metadata.New(store.ToMap())) +} + func MDToStore(md metadata.MD) *testing.Store { data := make(map[string]string) for key, val := range md { diff --git a/pkg/testing/remote/converter.go b/pkg/testing/remote/converter.go index 56351c5..12fd787 100644 --- a/pkg/testing/remote/converter.go +++ b/pkg/testing/remote/converter.go @@ -7,7 +7,7 @@ import ( "github.com/linuxsuren/api-testing/pkg/testing" ) -func convertToNormalTestSuite(suite *TestSuite) (result *testing.TestSuite) { +func ConvertToNormalTestSuite(suite *TestSuite) (result *testing.TestSuite) { result = &testing.TestSuite{ Name: suite.Name, API: suite.Api, @@ -20,10 +20,14 @@ func convertToNormalTestSuite(suite *TestSuite) (result *testing.TestSuite) { URL: suite.Spec.Url, } } + + for _, testcase := range suite.Items { + result.Items = append(result.Items, convertToNormalTestCase(testcase)) + } return } -func convertToGRPCTestSuite(suite *testing.TestSuite) (result *TestSuite) { +func ConvertToGRPCTestSuite(suite *testing.TestSuite) (result *TestSuite) { result = &TestSuite{ Name: suite.Name, Api: suite.API, @@ -33,6 +37,10 @@ func convertToGRPCTestSuite(suite *testing.TestSuite) (result *TestSuite) { Url: suite.Spec.URL, }, } + + for _, testcase := range suite.Items { + result.Items = append(result.Items, convertToGRPCTestCase(testcase)) + } return } diff --git a/pkg/testing/remote/converter_test.go b/pkg/testing/remote/converter_test.go index 42f5b62..f667190 100644 --- a/pkg/testing/remote/converter_test.go +++ b/pkg/testing/remote/converter_test.go @@ -12,7 +12,7 @@ func TestConvert(t *testing.T) { t.Run("convertToNormalTestSuite, empty object", func(t *testing.T) { assert.Equal(t, &atest.TestSuite{ Param: map[string]string{}, - }, convertToNormalTestSuite(&TestSuite{})) + }, ConvertToNormalTestSuite(&TestSuite{})) }) t.Run("convertToNormalTestSuite, normal object", func(t *testing.T) { @@ -22,7 +22,7 @@ func TestConvert(t *testing.T) { Kind: "http", URL: "/v1", }, - }, convertToNormalTestSuite(&TestSuite{ + }, ConvertToNormalTestSuite(&TestSuite{ Param: defaultPairs, Spec: &server.APISpec{ Url: "/v1", @@ -32,7 +32,7 @@ func TestConvert(t *testing.T) { }) t.Run("convertToGRPCTestSuite, normal object", func(t *testing.T) { - result := convertToGRPCTestSuite(&atest.TestSuite{ + result := ConvertToGRPCTestSuite(&atest.TestSuite{ API: "v1", Param: defaultMap, }) diff --git a/pkg/testing/remote/grpc.go b/pkg/testing/remote/grpc.go index 8411ab4..6c87725 100644 --- a/pkg/testing/remote/grpc.go +++ b/pkg/testing/remote/grpc.go @@ -116,7 +116,7 @@ func (g *gRPCLoader) ListTestSuite() (suites []testing.TestSuite, err error) { items, err = g.client.ListTestSuite(g.ctx, &server.Empty{}) if err == nil && items != nil { for _, item := range items.Data { - suites = append(suites, *convertToNormalTestSuite(item)) + suites = append(suites, *ConvertToNormalTestSuite(item)) } } return @@ -155,12 +155,12 @@ func (g *gRPCLoader) GetSuite(name string) (reply *testing.TestSuite, _ string, return } - reply = convertToNormalTestSuite(suite) + reply = ConvertToNormalTestSuite(suite) return } func (g *gRPCLoader) UpdateSuite(suite testing.TestSuite) (err error) { - _, err = g.client.UpdateTestSuite(g.ctx, convertToGRPCTestSuite(&suite)) + _, err = g.client.UpdateTestSuite(g.ctx, ConvertToGRPCTestSuite(&suite)) return } diff --git a/sample/kubernetes/default/manifest.yaml b/sample/kubernetes/default/manifest.yaml index 3cb998c..b0c7199 100644 --- a/sample/kubernetes/default/manifest.yaml +++ b/sample/kubernetes/default/manifest.yaml @@ -118,3 +118,15 @@ data: username: root properties: database: test + - name: s3 + url: http://172.11.0.13:30999 # address of the s3 server + kind: + name: s3 + url: localhost:7072 # address of the s3 storage extension + properties: + accessKeyID: 6e03rIMChrsZ6YZl + secretAccessKey: F0xH6o2qRYTyAUyRuXO81B4gj7zUrSaj + disableSSL: true + forcepathstyle: true + bucket: vm1 + region: cn