Simple Game Server: Add \n to Counters and Lists Response (#3589)

* Simple Game Server: Add \n to Counters and Lists Response

* gofmt

* Changes in functions

* fine tuning

* missing quotes

* Change in listContains and getListValues

* update main.go and gameserver_test.go files

* NO Values for getListValues

* review change

* NO Values when list empty

* update list contains

* modify listContains and getListValues

* Rename success with FOUND

* Review changes

* bump simple-game-server image

* bump simple-game-server image outside example/simple-game-server

* adjust expected value

* update response for counters and lists in fleet_test.go

* modify listContains

* bump simple-game-server

build/Makefile

@@ -61,7 +61,7 @@ KIND_PROFILE ?= agones
 KIND_CONTAINER_NAME=$(KIND_PROFILE)-control-plane
 
 # Game Server image to use while doing end-to-end tests
-GS_TEST_IMAGE ?= us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+GS_TEST_IMAGE ?= us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27
 
 # Enable all alpha feature gates. Keep in sync with `false` (alpha) entries in pkg/util/runtime/features.go:featureDefaults
 ALPHA_FEATURE_GATES ?= "PlayerAllocationFilter=true&PlayerTracking=true&CountsAndLists=true&DisableResyncOnSDKServer=true&Example=true"

examples/crd-client/create-gs.yaml

@@ -38,5 +38,5 @@ spec:
           imagePullPolicy: Always
           env:
             - name: GAMESERVER_IMAGE
-              value: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+              value: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27
       restartPolicy: Never

examples/fleet.yaml

@@ -117,4 +117,4 @@ spec:
         spec:
           containers:
             - name: simple-game-server
-              image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+              image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27

examples/gameserver.yaml

@@ -116,7 +116,7 @@ spec:
     spec:
       containers:
         - name: simple-game-server
-          image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+          image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27
           imagePullPolicy: Always
           # nodeSelector is a label that can be used to tell Kubernetes which host
           # OS to use. For Windows game servers uncomment the nodeSelector

examples/simple-game-server/Makefile

@@ -39,9 +39,9 @@ WITH_ARM64 ?= 1
 mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
 project_path := $(dir $(mkfile_path))
 ifeq ($(REPOSITORY),)
-	server_tag := simple-game-server:0.25
+	server_tag := simple-game-server:0.27
 else
-	server_tag := $(REPOSITORY)/simple-game-server:0.25
+	server_tag := $(REPOSITORY)/simple-game-server:0.27
 endif
 
 ifeq ($(WITH_WINDOWS), 1)

examples/simple-game-server/README.md

@@ -39,12 +39,12 @@ There are some text commands you can send the server to affect its behavior:
 | "GET_COUNTER_CAPACITY" | Returns the Capacity of the given Counter                                                |
 | "SET_COUNTER_CAPACITY" | Sets the Capacity of the given Counter to the given amount                               |
 | "GET_LIST_CAPACITY"    | Returns the Capacity of the given List                                                   |
-| "SET_LIST_CAPACITY     | Returns if the List was set to a new Capacity successfully (true) or not (false)         |
-| "LIST_CONTAINS         | Returns true if the given value is in the given List, false otherwise                    |
-| "GET_LIST_LENGTH       | Returns the length (number of values) of the given List as a string                      |
-| "GET_LIST_VALUES       | Return the values in the given List as a comma delineated string                         |
-| "APPEND_LIST_VALUE     | Returns if the given value was successfuly added to the List (true) or not (false)       |
-| "DELETE_LIST_VALUE     | Rreturns if the given value was successfuly deleted from the List (true) or not (false)  |
+| "SET_LIST_CAPACITY"    | Returns if the List was set to a new Capacity successfully (true) or not (false)         |
+| "LIST_CONTAINS"        | Returns true if the given value is in the given List, false otherwise                    |
+| "GET_LIST_LENGTH"      | Returns the length (number of values) of the given List as a string                      |
+| "GET_LIST_VALUES"      | Return the values in the given List as a comma delineated string                         |
+| "APPEND_LIST_VALUE"    | Returns if the given value was successfuly added to the List (true) or not (false)       |
+| "DELETE_LIST_VALUE"    | Rreturns if the given value was successfuly deleted from the List (true) or not (false)  |
 
 ## Configuration
 

examples/simple-game-server/dev-gameserver.yaml

@@ -31,4 +31,4 @@ spec:
     spec:
       containers:
         - name: simple-game-server
-          image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+          image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27

examples/simple-game-server/fleet-distributed.yaml

@@ -32,7 +32,7 @@ spec:
         spec:
           containers:
             - name: simple-game-server
-              image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+              image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27
               resources:
                 requests:
                   memory: 64Mi

examples/simple-game-server/fleet-tcp.yaml

@@ -28,7 +28,7 @@ spec:
         spec:
           containers:
             - name: simple-game-server
-              image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+              image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27
               env:
                 # Disables the UDP listener (Enabled by default)
                 - name: UDP

examples/simple-game-server/fleet.yaml

@@ -27,7 +27,7 @@ spec:
         spec:
           containers:
             - name: simple-game-server
-              image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+              image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27
               resources:
                 requests:
                   memory: 64Mi

examples/simple-game-server/gameserver-passthrough.yaml

@@ -24,7 +24,7 @@ spec:
     spec:
       containers:
         - name: simple-game-server
-          image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+          image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27
           env:
             - name: PASSTHROUGH
               value: 'TRUE'

examples/simple-game-server/gameserver-windows.yaml

@@ -25,7 +25,7 @@ spec:
     spec:
       containers:
         - name: simple-game-server
-          image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+          image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27
           resources:
             requests:
               memory: 64Mi

examples/simple-game-server/gameserver.yaml

@@ -25,7 +25,7 @@ spec:
     spec:
       containers:
         - name: simple-game-server
-          image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+          image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27
           resources:
             requests:
               memory: 64Mi

examples/simple-game-server/main.go

@@ -687,8 +687,9 @@ func getCounterCount(s *sdk.SDK, counterName string) (string, error) {
 	count, err := s.Alpha().GetCounterCount(counterName)
 	if err != nil {
 		log.Printf("Error getting Counter %s Count: %s", counterName, err)
+		return strconv.FormatInt(count, 10), err
 	}
-	return strconv.FormatInt(count, 10), err
+	return "COUNTER: " + strconv.FormatInt(count, 10) + "\n", nil
 }
 
 // incrementCounter returns the if the Counter Count was incremented successfully (true) or not (false)
@@ -701,8 +702,9 @@ func incrementCounter(s *sdk.SDK, counterName string, amount string) (string, er
 	ok, err := s.Alpha().IncrementCounter(counterName, amountInt)
 	if err != nil {
 		log.Printf("Error incrementing Counter %s Count by amount %d: %s", counterName, amountInt, err)
+		return strconv.FormatBool(ok), err
 	}
-	return strconv.FormatBool(ok), err
+	return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
 }
 
 // decrementCounter returns the if the Counter Count was decremented successfully (true) or not (false)
@@ -715,8 +717,9 @@ func decrementCounter(s *sdk.SDK, counterName string, amount string) (string, er
 	ok, err := s.Alpha().DecrementCounter(counterName, amountInt)
 	if err != nil {
 		log.Printf("Error decrementing Counter %s Count by amount %d: %s", counterName, amountInt, err)
+		return strconv.FormatBool(ok), err
 	}
-	return strconv.FormatBool(ok), err
+	return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
 }
 
 // setCounterCount returns the if the Counter was set to a new Count successfully (true) or not (false)
@@ -729,8 +732,9 @@ func setCounterCount(s *sdk.SDK, counterName string, amount string) (string, err
 	ok, err := s.Alpha().SetCounterCount(counterName, amountInt)
 	if err != nil {
 		log.Printf("Error setting Counter %s Count by amount %d: %s", counterName, amountInt, err)
+		return strconv.FormatBool(ok), err
 	}
-	return strconv.FormatBool(ok), err
+	return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
 }
 
 // getCounterCapacity returns the Capacity of the given Counter as a string
@@ -739,8 +743,9 @@ func getCounterCapacity(s *sdk.SDK, counterName string) (string, error) {
 	count, err := s.Alpha().GetCounterCapacity(counterName)
 	if err != nil {
 		log.Printf("Error getting Counter %s Capacity: %s", counterName, err)
+		return strconv.FormatInt(count, 10), err
 	}
-	return strconv.FormatInt(count, 10), err
+	return "CAPACITY: " + strconv.FormatInt(count, 10) + "\n", nil
 }
 
 // setCounterCapacity returns the if the Counter was set to a new Capacity successfully (true) or not (false)
@@ -753,8 +758,9 @@ func setCounterCapacity(s *sdk.SDK, counterName string, amount string) (string,
 	ok, err := s.Alpha().SetCounterCapacity(counterName, amountInt)
 	if err != nil {
 		log.Printf("Error setting Counter %s Capacity to amount %d: %s", counterName, amountInt, err)
+		return strconv.FormatBool(ok), err
 	}
-	return strconv.FormatBool(ok), err
+	return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
 }
 
 // getListCapacity returns the Capacity of the given List as a string
@@ -763,8 +769,9 @@ func getListCapacity(s *sdk.SDK, listName string) (string, error) {
 	capacity, err := s.Alpha().GetListCapacity(listName)
 	if err != nil {
 		log.Printf("Error getting List %s Capacity: %s", listName, err)
+		return strconv.FormatInt(capacity, 10), err
 	}
-	return strconv.FormatInt(capacity, 10), err
+	return "CAPACITY: " + strconv.FormatInt(capacity, 10) + "\n", nil
 }
 
 // setListCapacity returns if the List was set to a new Capacity successfully (true) or not (false)
@@ -777,8 +784,9 @@ func setListCapacity(s *sdk.SDK, listName string, amount string) (string, error)
 	ok, err := s.Alpha().SetListCapacity(listName, amountInt)
 	if err != nil {
 		log.Printf("Error setting List %s Capacity to amount %d: %s", listName, amountInt, err)
+		return strconv.FormatBool(ok), err
 	}
-	return strconv.FormatBool(ok), err
+	return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
 }
 
 // listContains returns true if the given value is in the given List, false otherwise
@@ -787,8 +795,9 @@ func listContains(s *sdk.SDK, listName string, value string) (string, error) {
 	ok, err := s.Alpha().ListContains(listName, value)
 	if err != nil {
 		log.Printf("Error getting List %s contains value %s: %s", listName, value, err)
-	}
-	return strconv.FormatBool(ok), err
+		return strconv.FormatBool(ok), err
+	}	
+  return "FOUND: " + strconv.FormatBool(ok) + "\n", nil
 }
 
 // getListLength returns the length (number of values) of the given List as a string
@@ -797,8 +806,9 @@ func getListLength(s *sdk.SDK, listName string) (string, error) {
 	length, err := s.Alpha().GetListLength(listName)
 	if err != nil {
 		log.Printf("Error getting List %s length: %s", listName, err)
+		return strconv.Itoa(length), err
 	}
-	return strconv.Itoa(length), err
+	return "LENGTH: " + strconv.Itoa(length) + "\n", nil
 }
 
 // getListValues return the values in the given List as a comma delineated string
@@ -807,8 +817,12 @@ func getListValues(s *sdk.SDK, listName string) (string, error) {
 	values, err := s.Alpha().GetListValues(listName)
 	if err != nil {
 		log.Printf("Error getting List %s values: %s", listName, err)
+		return "INVALID LIST NAME", err
 	}
-	return strings.Join(values, ",") + "\n", err
+	if len(values) > 0 {
+        return "VALUES: " + strings.Join(values, ",") + "\n", nil
+    }
+	return "VALUES: <none>\n", err
 }
 
 // appendListValue returns if the given value was successfuly added to the List (true) or not (false)
@@ -817,8 +831,9 @@ func appendListValue(s *sdk.SDK, listName string, value string) (string, error)
 	ok, err := s.Alpha().AppendListValue(listName, value)
 	if err != nil {
 		log.Printf("Error appending Value %s to List %s: %s", value, listName, err)
+		return strconv.FormatBool(ok), err
 	}
-	return strconv.FormatBool(ok), err
+	return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
 }
 
 // deleteListValue returns if the given value was successfuly deleted from the List (true) or not (false)
@@ -827,8 +842,9 @@ func deleteListValue(s *sdk.SDK, listName string, value string) (string, error)
 	ok, err := s.Alpha().DeleteListValue(listName, value)
 	if err != nil {
 		log.Printf("Error deleting Value %s to List %s: %s", value, listName, err)
+		return strconv.FormatBool(ok), err
 	}
-	return strconv.FormatBool(ok), err
+	return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
 }
 
 // doHealth sends the regular Health Pings

install/helm/agones/templates/tests/test-runner.yaml

@@ -29,7 +29,7 @@ spec:
     imagePullPolicy: Always
     env:
     - name: GAMESERVER_IMAGE
-      value: "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25"
+      value: "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27"
     - name: IS_HELM_TEST
       value: "true"
     - name: GAMESERVERS_NAMESPACE

pkg/util/webhooks/webhooks_test.go

@@ -164,7 +164,7 @@ func TestWebHookFleetValidationHandler(t *testing.T) {
 							"template": {
 								"spec": {
 									"containers": [{
-										"image": "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25",
+										"image": "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27",
 										"name": false
 									}]
 								}

site/config.toml

@@ -100,7 +100,7 @@ dev_eks_example_cluster_version = "1.28"
 dev_minikube_example_cluster_version = "1.27.6"
 
 # example tag
-example_image_tag = "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25"
+example_image_tag = "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27"
 
 # Enable syntax highlighting and copy buttons on code blocks with Prism
 prism_syntax_highlighting = true

site/content/en/docs/Guides/fleet-updates.md

@@ -175,7 +175,7 @@ spec:
         spec:
           containers:
             - name: simple-game-server
-              image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25
+              image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27
 ```
 
 See the [Fleet reference]({{% relref "../Reference/fleet.md" %}}) for more details.

test/e2e/fleet_test.go

@@ -1659,13 +1659,13 @@ func TestFleetAggregatedCounterStatus(t *testing.T) {
 		msg := fmt.Sprintf("SET_COUNTER_CAPACITY games %d", capacity)
 		reply, err := framework.SendGameServerUDP(t, &gs, msg)
 		require.NoError(t, err)
-		assert.Equal(t, "true", reply)
+		assert.Equal(t, "SUCCESS: true\n", reply)
 
 		totalCount += count
 		msg = fmt.Sprintf("SET_COUNTER_COUNT games %d", count)
 		reply, err = framework.SendGameServerUDP(t, &gs, msg)
 		require.NoError(t, err)
-		assert.Equal(t, "true", reply)
+		assert.Equal(t, "SUCCESS: true\n", reply)
 
 		if gs.Status.State == agonesv1.GameServerStateAllocated {
 			allocatedCapacity += capacity
@@ -1742,15 +1742,15 @@ func TestFleetAggregatedListStatus(t *testing.T) {
 		msg := fmt.Sprintf("SET_LIST_CAPACITY gamers %d", capacity)
 		reply, err := framework.SendGameServerUDP(t, &gs, msg)
 		require.NoError(t, err)
-		assert.Equal(t, "true", reply)
+		assert.Equal(t, "SUCCESS: true\n", reply)
 
 		totalCount += count
 		// Each list starts with a count of 2 (Values: []string{"gamer0", "gamer1"})
 		for i := 2; i < count; i++ {
 			msg = fmt.Sprintf("APPEND_LIST_VALUE gamers gamer%d", i)
 			reply, err = framework.SendGameServerUDP(t, &gs, msg)
 			require.NoError(t, err)
-			assert.Equal(t, "true", reply)
+			assert.Equal(t, "SUCCESS: true\n", reply)
 		}
 
 		if gs.Status.State == agonesv1.GameServerStateAllocated {

test/e2e/framework/framework.go

@@ -150,7 +150,7 @@ func NewFromFlags() (*Framework, error) {
 	}
 
 	viper.SetDefault(kubeconfigFlag, filepath.Join(usr.HomeDir, ".kube", "config"))
-	viper.SetDefault(gsimageFlag, "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.25")
+	viper.SetDefault(gsimageFlag, "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.27")
 	viper.SetDefault(pullSecretFlag, "")
 	viper.SetDefault(stressTestLevelFlag, 0)
 	viper.SetDefault(perfOutputDirFlag, "")