From b24ec55e970e3682fceb84210e78248d63d74e4f Mon Sep 17 00:00:00 2001 From: Alexander Apalikov Date: Thu, 26 Sep 2019 17:28:41 +0300 Subject: [PATCH] Add SDK server HTTP API test Add conformance test for Rest API SDK server port 59358. Does not contain swagger pregenerated files. Switched Go file to other file extension, because it is not possible to exclude one file from GolangCI linter run. --- build/build-sdk-images/restapi/Dockerfile | 39 ++++++ .../restapi/build-sdk-test.sh | 20 ++++ build/build-sdk-images/restapi/clean.sh | 19 +++ build/build-sdk-images/restapi/sdktest.sh | 21 ++++ build/includes/sdk.mk | 23 ++-- test/sdk/restapi/http-api-test.go.nolint | 111 ++++++++++++++++++ 6 files changed, 225 insertions(+), 8 deletions(-) create mode 100644 build/build-sdk-images/restapi/Dockerfile create mode 100644 build/build-sdk-images/restapi/build-sdk-test.sh create mode 100644 build/build-sdk-images/restapi/clean.sh create mode 100644 build/build-sdk-images/restapi/sdktest.sh create mode 100644 test/sdk/restapi/http-api-test.go.nolint diff --git a/build/build-sdk-images/restapi/Dockerfile b/build/build-sdk-images/restapi/Dockerfile new file mode 100644 index 0000000000..2264434eeb --- /dev/null +++ b/build/build-sdk-images/restapi/Dockerfile @@ -0,0 +1,39 @@ +# Copyright 2019 Google LLC All Rights Reserved. +# +# 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. +ARG BASE_IMAGE=agones-build-sdk-base:latest +FROM $BASE_IMAGE + +RUN apt-get update && \ + apt-get install -y wget jq && \ + apt-get clean + +# install go +WORKDIR /usr/local +ENV GO_VERSION=1.12 +ENV GO111MODULE=on +ENV GOPATH /go +RUN wget -q https://dl.google.com/go/go${GO_VERSION}.linux-amd64.tar.gz && \ + tar -xzf go${GO_VERSION}.linux-amd64.tar.gz && rm go${GO_VERSION}.linux-amd64.tar.gz && mkdir -p ${GOPATH} + +RUN curl -sL https://deb.nodesource.com/setup_11.x | bash - && \ + apt-get install -y nodejs + +RUN apt-get install -y openjdk-8-jre + +ENV PATH /usr/local/go/bin:/go/bin:$PATH + + +# code generation scripts +COPY *.sh /root/ +RUN chmod +x /root/*.sh \ No newline at end of file diff --git a/build/build-sdk-images/restapi/build-sdk-test.sh b/build/build-sdk-images/restapi/build-sdk-test.sh new file mode 100644 index 0000000000..e17326a235 --- /dev/null +++ b/build/build-sdk-images/restapi/build-sdk-test.sh @@ -0,0 +1,20 @@ +#!/usr/bin/env bash + +# Copyright 2019 Google LLC All Rights Reserved. +# +# 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. + + +mkdir /go/src/agones.dev/agones/swagger +wget -q http://central.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.8/swagger-codegen-cli-2.4.8.jar -O /tmp/swagger-codegen-cli.jar +java -jar /tmp/swagger-codegen-cli.jar generate -i /go/src/agones.dev/agones/sdk.swagger.json -l go -o /go/src/agones.dev/agones/test/sdk/restapi/swagger diff --git a/build/build-sdk-images/restapi/clean.sh b/build/build-sdk-images/restapi/clean.sh new file mode 100644 index 0000000000..a9f326579c --- /dev/null +++ b/build/build-sdk-images/restapi/clean.sh @@ -0,0 +1,19 @@ +#!/usr/bin/env bash + +# Copyright 2019 Google LLC All Rights Reserved. +# +# 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. + +set -ex +rm -rf /go/src/agones.dev/agones/test/sdk/restapi/swagger +rm /go/src/agones.dev/agones/test/sdk/restapi/http-api-test.go diff --git a/build/build-sdk-images/restapi/sdktest.sh b/build/build-sdk-images/restapi/sdktest.sh new file mode 100644 index 0000000000..42cf5e7b0c --- /dev/null +++ b/build/build-sdk-images/restapi/sdktest.sh @@ -0,0 +1,21 @@ +#!/usr/bin/env bash + +# Copyright 2019 Google LLC All Rights Reserved. +# +# 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. + +set -ex +GO111MODULE=on +cd /go/src/agones.dev/agones/test/sdk/restapi +cp ./http-api-test.go.nolint ./http-api-test.go +go run http-api-test.go \ No newline at end of file diff --git a/build/includes/sdk.mk b/build/includes/sdk.mk index 872f4d4d67..d3c2a839c5 100644 --- a/build/includes/sdk.mk +++ b/build/includes/sdk.mk @@ -61,7 +61,7 @@ gen-sdk-grpc: COMMAND := gen gen-sdk-grpc: run-sdk-command # Runs a command on all supported languages, use COMMAND variable to select which command. -run-all-sdk-command: run-sdk-command-go run-sdk-command-rust run-sdk-command-cpp run-sdk-command-node +run-all-sdk-command: run-sdk-command-go run-sdk-command-rust run-sdk-command-cpp run-sdk-command-node run-sdk-command-restapi run-sdk-command-node: $(MAKE) run-sdk-command COMMAND=$(COMMAND) SDK_FOLDER=node @@ -75,6 +75,10 @@ run-sdk-command-rust: run-sdk-command-go: $(MAKE) run-sdk-command COMMAND=$(COMMAND) SDK_FOLDER=go +run-sdk-command-restapi: + $(MAKE) run-sdk-command COMMAND=$(COMMAND) SDK_FOLDER=restapi + + # Runs a command for a specific SDK if it exists. run-sdk-command: cd $(sdk_build_folder); \ @@ -117,9 +121,9 @@ ensure-build-sdk-image: # Run SDK conformance Sidecar server in docker in order to run # SDK client test against it. Useful for test development run-sdk-conformance-local: TIMEOUT ?= 30 -run-sdk-conformance-local: TESTS ?= ready,allocate,setlabel,setannotation,gameserver,health,shutdown,watch +run-sdk-conformance-local: TESTS ?= ready,allocate,setlabel,setannotation,gameserver,health,shutdown,watch,reserve run-sdk-conformance-local: ensure-agones-sdk-image - docker run -e "ADDRESS=" -p 59357:59357 \ + docker run -e "ADDRESS=" -p 59357:59357 -p 59358:59358 \ -e "TEST=$(TESTS)" -e "TIMEOUT=$(TIMEOUT)" $(sidecar_tag) # Run SDK conformance test, previously built, for a specific SDK_FOLDER @@ -128,12 +132,13 @@ run-sdk-conformance-no-build: TIMEOUT ?= 30 run-sdk-conformance-no-build: RANDOM := $(shell bash -c 'echo $$RANDOM') run-sdk-conformance-no-build: DELAY ?= $(shell bash -c "echo $$[ ($(RANDOM) % 5 ) + 1 ]") run-sdk-conformance-no-build: TESTS ?= ready,allocate,setlabel,setannotation,gameserver,health,shutdown,watch,reserve -run-sdk-conformance-no-build: PORT ?= 59357 +run-sdk-conformance-no-build: GRPC_PORT ?= 59357 +run-sdk-conformance-no-build: HTTP_PORT ?= 59358 run-sdk-conformance-no-build: ensure-agones-sdk-image run-sdk-conformance-no-build: ensure-build-sdk-image - DOCKER_RUN_ARGS="--net host -e AGONES_SDK_GRPC_PORT=$(PORT) $(DOCKER_RUN_ARGS)" COMMAND=sdktest $(MAKE) run-sdk-command & \ - docker run -p $(PORT):$(PORT) -e "ADDRESS=" -e "TEST=$(TESTS)" -e "TIMEOUT=$(TIMEOUT)" -e "DELAY=$(DELAY)" \ - --net=host $(sidecar_tag) --grpc-port $(PORT) + DOCKER_RUN_ARGS="--net host -e AGONES_SDK_GRPC_PORT=$(GRPC_PORT) -e AGONES_SDK_HTTP_PORT=$(HTTP_PORT) $(DOCKER_RUN_ARGS)" COMMAND=sdktest $(MAKE) run-sdk-command & \ + docker run -p $(GRPC_PORT):$(GRPC_PORT) -p $(HTTP_PORT):$(HTTP_PORT) -e "ADDRESS=" -e "TEST=$(TESTS)" -e "TIMEOUT=$(TIMEOUT)" -e "DELAY=$(DELAY)" \ + --net=host $(sidecar_tag) --grpc-port $(GRPC_PORT) --http-port $(HTTP_PORT) # Run SDK conformance test for a specific SDK_FOLDER run-sdk-conformance-test: ensure-agones-sdk-image @@ -143,9 +148,11 @@ run-sdk-conformance-test: ensure-build-sdk-image # Run a conformance test for all SDKs supported run-sdk-conformance-tests: + $(MAKE) run-sdk-conformance-test SDK_FOLDER=restapi HTTP_PORT=9050 $(MAKE) run-sdk-conformance-test SDK_FOLDER=node - $(MAKE) run-sdk-conformance-test SDK_FOLDER=go PORT=9001 + $(MAKE) run-sdk-conformance-test SDK_FOLDER=go GRPC_PORT=9001 $(MAKE) run-sdk-conformance-test SDK_FOLDER=rust + $(MAKE) run-sdk-command COMMAND=clean SDK_FOLDER=restapi # Clean package directories and binary files left # after building conformance tests for all SDKs supported diff --git a/test/sdk/restapi/http-api-test.go.nolint b/test/sdk/restapi/http-api-test.go.nolint new file mode 100644 index 0000000000..88849daf0d --- /dev/null +++ b/test/sdk/restapi/http-api-test.go.nolint @@ -0,0 +1,111 @@ +// Copyright 2019 Google LLC All Rights Reserved. +// +// 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 main + +import ( + "log" + "os" + "time" + + "agones.dev/agones/test/sdk/restapi/swagger" + "golang.org/x/net/context" +) + +func main() { + log.Println("Client is starting") + time.Sleep(1 * time.Second) + conf := swagger.NewConfiguration() + portStr := os.Getenv("AGONES_SDK_HTTP_PORT") + conf.BasePath = "http://localhost:" + portStr + cli := swagger.NewAPIClient(conf) + + ctx := context.Background() + + // Wait for SDK server to start (5 seconds) + for c := 0 ; c < 5; c++ { + _, _, err := cli.SDKApi.Ready(ctx, swagger.SdkEmpty{}) + if err == nil { + break + } else { + log.Printf("Could not send Ready: %v\n", err) + } + time.Sleep(1*time.Second) + } + + c := make(chan string) + + once := true + go func() { + gs, _, err := cli.SDKApi.WatchGameServer(ctx) + log.Printf("Watch response: %+v", gs) + if err != nil { + log.Printf("Error in WatchGameServer: %v\n", err) + } else { + if gs.ObjectMeta != nil { + uid := gs.ObjectMeta.Uid + if once { + c <- uid + once = false + } + } else { + log.Printf("Could not parse GS\n") + } + } + }() + + _, _, err := cli.SDKApi.Health(ctx, swagger.SdkEmpty{}) + if err != nil { + log.Fatalf("Could not send health check: %v\n", err) + } + + _, _, err = cli.SDKApi.Reserve(ctx, swagger.SdkDuration{"5"}) + if err != nil { + log.Fatalf("Could not send Reserve: %v\n", err) + } + + _, _, err = cli.SDKApi.Allocate(ctx, swagger.SdkEmpty{}) + if err != nil { + log.Fatalf("Could not send Allocate: %v\n", err) + } + + gs, _, err := cli.SDKApi.GetGameServer(ctx) + if err != nil { + log.Fatalf("Could not GetGameserver: %v\n", err) + } + + creationTS := gs.ObjectMeta.CreationTimestamp + + _, _, err = cli.SDKApi.SetLabel(ctx, swagger.SdkKeyValue{"creationTimestamp", creationTS}) + if err != nil { + log.Fatalf("Could not SetLabel: %v\n", err) + } + + // TODO: fix WatchGameServer() HTTP API Swagger definition and remove the following lines + go func() { + c <- gs.ObjectMeta.Uid + }() + + uid := <-c + _, _, err = cli.SDKApi.SetAnnotation(ctx, swagger.SdkKeyValue{"UID", uid}) + if err != nil { + log.Fatalf("Could not SetAnnotation: %v\n", err) + } + + _, _, err = cli.SDKApi.Shutdown(ctx, swagger.SdkEmpty{}) + if err != nil { + log.Fatalf("Could not GetGameserver: %v\n", err) + } + log.Println("REST API test finished, all queries were performed") +}