Implement SDK SetLabel and SetAnnotation functionality

This implements new functions in the SDK:

- SetLabel(key, value) - that lets you set a label on the backing `GameServer`
- SetAnnotation(key, value) - that lets you set an annotation on the backing
`GameServer`

All keys are prefixed with "stable.agones.dev/sdk-" to maintain isolation.

Closes googleforgames#279

.dockerignore

@@ -0,0 +1,38 @@
+# Copyright 2018 Google Inc. 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.
+
+# project specific
+.*
+.idea
+*.zip
+/release
+bin
+/docs
+*.md
+*.amd64
+
+# Created by .ignore support plugin (hsz.mobi)
+### Go template
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, build with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out

.gitignore

@@ -16,6 +16,7 @@
 !.gitignore
 !.helmignore
 !.gitattributes
+!.dockerignore
 *.iml
 bin
 *.o

build/Makefile

@@ -47,7 +47,7 @@ GCP_CLUSTER_ZONE ?= us-west1-c
 MINIKUBE_PROFILE ?= agones
 
 # Game Server image to use while doing end-to-end tests
-GS_TEST_IMAGE ?= gcr.io/agones-images/udp-server:0.1
+GS_TEST_IMAGE ?= gcr.io/agones-images/udp-server:0.3
 
 # Directory that this Makefile is in.
 mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))

docs/sdk_rest_api.md

@@ -62,6 +62,28 @@ Call when the GameServer session is over and it's time to shut down
 $ curl -d "{}" -H "Content-Type: application/json" -X POST http://localhost:59358/shutdown
 ```
 
+### Set Label
+
+Apply a Label with the prefix "stable.agones.dev/sdk-" to the backing `GameServer` metadata. 
+
+See the SDK [SetLabel](../sdks/README.md#setlabelkey-value) documentation for restrictions.
+
+#### Example
+
+```bash
+$ curl -d '{"key": "foo", "value": "bar"}' -H "Content-Type: application/json" -X PUT http://localhost:59358/metadata/label
+```
+
+### Set Annotation
+
+Apply a Annotation with the prefix "stable.agones.dev/sdk-" to the backing `GameServer` metadata
+
+#### Example
+
+```bash
+$ curl -d '{"key": "foo", "value": "bar"}' -H "Content-Type: application/json" -X PUT http://localhost:59358/metadata/annotation
+```
+
 ### GameServer
 
 Call when you want to retrieve the backing `GameServer` configuration details

examples/cpp-simple/server.cc

@@ -59,8 +59,22 @@ int main() {
     std::thread health (doHealth, sdk);
     std::thread watch (watchUpdates, sdk);
 
+    std::cout << "Setting a label" << std::endl;
+    grpc::Status status = sdk->SetLabel("test-label", "test-value");
+    if (!status.ok()) {
+        std::cout << "Could not run SetLabel(): "+ status.error_message() + ". Exiting!" << std::endl;
+        return -1;
+    }
+
+    std::cout << "Setting an annotation" << std::endl;
+    status = sdk->SetAnnotation("test-annotation", "test value");
+    if (!status.ok()) {
+        std::cout << "Could not run SetAnnotation(): "+ status.error_message() + ". Exiting!" << std::endl;
+        return -1;
+    }
+
     std::cout << "Marking server as ready..." << std::endl;
-    grpc::Status status = sdk->Ready();
+    status = sdk->Ready();
     if (!status.ok()) {
         std::cout << "Could not run Ready(): "+ status.error_message() + ". Exiting!" << std::endl;
         return -1;

examples/simple-udp/main.go

@@ -16,16 +16,18 @@
 package main
 
 import (
+	"encoding/json"
 	"flag"
 	"log"
 	"net"
 	"os"
 	"strings"
 	"time"
 
-	"agones.dev/agones/sdks/go"
-	"encoding/json"
+	"strconv"
+
 	coresdk "agones.dev/agones/pkg/sdk"
+	"agones.dev/agones/sdks/go"
 )
 
 // main starts a UDP server that received 1024 byte sized packets at at time
@@ -85,7 +87,7 @@ func readWriteLoop(conn net.PacketConn, stop chan struct{}, s *sdk.SDK) {
 			}
 			os.Exit(0)
 
-		// turns off the health pings
+			// turns off the health pings
 		case "UNHEALTHY":
 			close(stop)
 
@@ -94,6 +96,21 @@ func readWriteLoop(conn net.PacketConn, stop chan struct{}, s *sdk.SDK) {
 
 		case "WATCH":
 			watchGameServerEvents(s)
+
+		case "LABEL":
+			log.Print("Setting label")
+			// label values can only be alpha, - and .
+			err := s.SetLabel("timestamp", strconv.FormatInt(time.Now().Unix(), 10))
+			if err != nil {
+				log.Fatalf("could not set label: %v", err)
+			}
+
+		case "ANNOTATION":
+			log.Print("Setting annotation")
+			err := s.SetAnnotation("timestamp", time.Now().UTC().String())
+			if err != nil {
+				log.Fatalf("could not set annotation: %v", err)
+			}
 		}
 
 		// echo it back

pkg/gameservers/localsdk.go

@@ -18,6 +18,8 @@ import (
 	"io"
 	"time"
 
+	"sync"
+
 	"agones.dev/agones/pkg/sdk"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
@@ -50,14 +52,30 @@ var (
 // is being run for local development, and doesn't connect to the
 // Kubernetes cluster
 type LocalSDKServer struct {
-	watchPeriod time.Duration
+	watchPeriod     time.Duration
+	update          chan struct{}
+	updateObservers sync.Map
 }
 
 // NewLocalSDKServer returns the default LocalSDKServer
 func NewLocalSDKServer() *LocalSDKServer {
-	return &LocalSDKServer{
-		watchPeriod: 5 * time.Second,
+	l := &LocalSDKServer{
+		watchPeriod:     5 * time.Second,
+		update:          make(chan struct{}),
+		updateObservers: sync.Map{},
 	}
+
+	go func() {
+		for value := range l.update {
+			logrus.Info("gameserver update received")
+			l.updateObservers.Range(func(observer, _ interface{}) bool {
+				observer.(chan struct{}) <- value
+				return true
+			})
+		}
+	}()
+
+	return l
 }
 
 // Ready logs that the Ready request has been received
@@ -87,6 +105,22 @@ func (l *LocalSDKServer) Health(stream sdk.SDK_HealthServer) error {
 	}
 }
 
+// SetLabel applies a Label to the backing GameServer metadata
+func (l *LocalSDKServer) SetLabel(_ context.Context, kv *sdk.KeyValue) (*sdk.Empty, error) {
+	logrus.WithField("values", kv).Info("Setting label")
+	fixture.ObjectMeta.Labels[metadataPrefix+kv.Key] = kv.Value
+	l.update <- struct{}{}
+	return &sdk.Empty{}, nil
+}
+
+// SetAnnotation applies a Annotation to the backing GameServer metadata
+func (l *LocalSDKServer) SetAnnotation(_ context.Context, kv *sdk.KeyValue) (*sdk.Empty, error) {
+	logrus.WithField("values", kv).Info("Setting annotation")
+	fixture.ObjectMeta.Annotations[metadataPrefix+kv.Key] = kv.Value
+	l.update <- struct{}{}
+	return &sdk.Empty{}, nil
+}
+
 // GetGameServer returns a dummy game server.
 func (l *LocalSDKServer) GetGameServer(context.Context, *sdk.Empty) (*sdk.GameServer, error) {
 	logrus.Info("getting GameServer details")
@@ -96,17 +130,32 @@ func (l *LocalSDKServer) GetGameServer(context.Context, *sdk.Empty) (*sdk.GameSe
 // WatchGameServer will return a dummy GameServer (with no changes), 3 times, every 5 seconds
 func (l *LocalSDKServer) WatchGameServer(_ *sdk.Empty, stream sdk.SDK_WatchGameServerServer) error {
 	logrus.Info("connected to watch GameServer...")
-	times := 3
+	observer := make(chan struct{})
+
+	defer func() {
+		l.updateObservers.Delete(observer)
+		close(observer)
+	}()
+
+	l.updateObservers.Store(observer, true)
 
-	for i := 0; i < times; i++ {
-		logrus.Info("Sending watched GameServer!")
+	// on connect, send 3 events, as advertised
+	go func() {
+		times := 3
+
+		for i := 0; i < times; i++ {
+			logrus.Info("Sending watched GameServer!")
+			l.update <- struct{}{}
+			time.Sleep(l.watchPeriod)
+		}
+	}()
+
+	for range observer {
 		err := stream.Send(fixture)
 		if err != nil {
 			logrus.WithError(err).Error("error sending gameserver")
 			return err
 		}
-
-		time.Sleep(l.watchPeriod)
 	}
 
 	return nil

pkg/gameservers/localsdk_test.go

@@ -56,6 +56,60 @@ func TestLocal(t *testing.T) {
 	assert.Equal(t, fixture, gs)
 }
 
+func TestLocalSDKServerSetLabel(t *testing.T) {
+	ctx := context.Background()
+	e := &sdk.Empty{}
+	l := NewLocalSDKServer()
+	kv := &sdk.KeyValue{Key: "foo", Value: "bar"}
+
+	stream := newGameServerMockStream()
+	go func() {
+		err := l.WatchGameServer(e, stream)
+		assert.Nil(t, err)
+	}()
+
+	_, err := l.SetLabel(ctx, kv)
+	assert.Nil(t, err)
+
+	gs, err := l.GetGameServer(ctx, e)
+	assert.Nil(t, err)
+	assert.Equal(t, gs.ObjectMeta.Labels[metadataPrefix+"foo"], "bar")
+
+	select {
+	case msg := <-stream.msgs:
+		assert.Equal(t, msg.ObjectMeta.Labels[metadataPrefix+"foo"], "bar")
+	case <-time.After(2 * l.watchPeriod):
+		assert.FailNow(t, "timeout on receiving messages")
+	}
+}
+
+func TestLocalSDKServerSetAnnotation(t *testing.T) {
+	ctx := context.Background()
+	e := &sdk.Empty{}
+	l := NewLocalSDKServer()
+	kv := &sdk.KeyValue{Key: "bar", Value: "foo"}
+
+	stream := newGameServerMockStream()
+	go func() {
+		err := l.WatchGameServer(e, stream)
+		assert.Nil(t, err)
+	}()
+
+	_, err := l.SetAnnotation(ctx, kv)
+	assert.Nil(t, err)
+
+	gs, err := l.GetGameServer(ctx, e)
+	assert.Nil(t, err)
+	assert.Equal(t, gs.ObjectMeta.Annotations[metadataPrefix+"bar"], "foo")
+
+	select {
+	case msg := <-stream.msgs:
+		assert.Equal(t, msg.ObjectMeta.Annotations[metadataPrefix+"bar"], "foo")
+	case <-time.After(2 * l.watchPeriod):
+		assert.FailNow(t, "timeout on receiving messages")
+	}
+}
+
 func TestLocalSDKServerWatchGameServer(t *testing.T) {
 	t.Parallel()
 
@@ -64,15 +118,17 @@ func TestLocalSDKServerWatchGameServer(t *testing.T) {
 	l.watchPeriod = time.Second
 
 	stream := newGameServerMockStream()
-	err := l.WatchGameServer(e, stream)
-	assert.Nil(t, err)
+	go func() {
+		err := l.WatchGameServer(e, stream)
+		assert.Nil(t, err)
+	}()
 
 	for i := 0; i < 3; i++ {
 		select {
 		case msg := <-stream.msgs:
 			assert.Equal(t, fixture, msg)
 		case <-time.After(2 * l.watchPeriod):
-			assert.FailNow(t, "timeout on receiving messagess")
+			assert.FailNow(t, "timeout on receiving messages")
 		}
 	}
 }

pkg/gameservers/sdk.go

@@ -0,0 +1,20 @@
+// Copyright 2018 Google Inc. 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 gameservers
+
+const (
+	// metadataPrefix prefix for labels and annotations
+	metadataPrefix = "stable.agones.dev/sdk-"
+)