Counters and Lists: Remove Bool Returns (#3738)

Counters and Lists Methods: Remove Boolean Returns

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.28
+GS_TEST_IMAGE ?= us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30
 
 # 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&Example=true"

build/scripts/bump-image/main.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package main implements a program to increment the new tag for the given examples image. Run this script using `make bump-image IMAGENAME=<imageName> VERSION=<version>`
+// Package main implements a program to increment the new tag for the given examples image. Run this script using `make bump-image IMAGENAME=<imageName> VERSION=<current-version>`
 package main
 
 import (

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.28
+ value: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30
  restartPolicy: Never

examples/fleet.yaml

@@ -114,4 +114,4 @@ spec:
  spec:
  containers:
  - name: simple-game-server
- image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.28
+ image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30

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.28
+ image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30
  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

@@ -38,7 +38,7 @@ WITH_ARM64 ?= 1
 
 mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
 project_path := $(dir $(mkfile_path))
-version := 0.28
+version := 0.30
 ifeq ($(REPOSITORY),)
  server_tag := simple-game-server:$(version)
 else

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.28
+ image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30

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.28
+ image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30
  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.28
+ image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30
  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.28
+ image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30
  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.28
+ image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30
  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.28
+ image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30
  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.28
+ image: us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30
  resources:
  requests:
  memory: 64Mi

examples/simple-game-server/main.go

@@ -192,6 +192,7 @@ func handleResponse(txt string, s *sdk.SDK, cancel context.CancelFunc) (response
  response = txt
  addACK = true
  responseError = nil
+ var err error
 
  switch parts[0] {
  // shuts down the gameserver
@@ -322,7 +323,7 @@ func handleResponse(txt string, s *sdk.SDK, cancel context.CancelFunc) (response
  responseError = fmt.Errorf("Invalid INCREMENT_COUNTER, should have 2 arguments")
  return
  }
- response, responseError = incrementCounter(s, parts[1], parts[2])
+ response, err = incrementCounter(s, parts[1], parts[2])
  addACK = false
 
  case "DECREMENT_COUNTER":
@@ -331,7 +332,7 @@ func handleResponse(txt string, s *sdk.SDK, cancel context.CancelFunc) (response
  responseError = fmt.Errorf("Invalid DECREMENT_COUNTER, should have 2 arguments")
  return
  }
- response, responseError = decrementCounter(s, parts[1], parts[2])
+ response, err = decrementCounter(s, parts[1], parts[2])
  addACK = false
 
  case "SET_COUNTER_COUNT":
@@ -340,7 +341,7 @@ func handleResponse(txt string, s *sdk.SDK, cancel context.CancelFunc) (response
  responseError = fmt.Errorf("Invalid SET_COUNTER_COUNT, should have 2 arguments")
  return
  }
- response, responseError = setCounterCount(s, parts[1], parts[2])
+ response, err = setCounterCount(s, parts[1], parts[2])
  addACK = false
 
  case "GET_COUNTER_CAPACITY":
@@ -358,7 +359,7 @@ func handleResponse(txt string, s *sdk.SDK, cancel context.CancelFunc) (response
  responseError = fmt.Errorf("Invalid SET_COUNTER_CAPACITY, should have 2 arguments")
  return
  }
- response, responseError = setCounterCapacity(s, parts[1], parts[2])
+ response, err = setCounterCapacity(s, parts[1], parts[2])
  addACK = false
 
  case "GET_LIST_CAPACITY":
@@ -376,7 +377,7 @@ func handleResponse(txt string, s *sdk.SDK, cancel context.CancelFunc) (response
  responseError = fmt.Errorf("Invalid SET_LIST_CAPACITY, should have 2 arguments")
  return
  }
- response, responseError = setListCapacity(s, parts[1], parts[2])
+ response, err = setListCapacity(s, parts[1], parts[2])
  addACK = false
 
  case "LIST_CONTAINS":
@@ -412,7 +413,7 @@ func handleResponse(txt string, s *sdk.SDK, cancel context.CancelFunc) (response
  responseError = fmt.Errorf("Invalid APPEND_LIST_VALUE, should have 2 arguments")
  return
  }
- response, responseError = appendListValue(s, parts[1], parts[2])
+ response, err = appendListValue(s, parts[1], parts[2])
  addACK = false
 
  case "DELETE_LIST_VALUE":
@@ -421,9 +422,14 @@ func handleResponse(txt string, s *sdk.SDK, cancel context.CancelFunc) (response
  responseError = fmt.Errorf("Invalid DELETE_LIST_VALUE, should have 2 arguments")
  return
  }
- response, responseError = deleteListValue(s, parts[1], parts[2])
+ response, err = deleteListValue(s, parts[1], parts[2])
  addACK = false
  }
+
+ if err != nil {
+ return err.Error(), addACK, err
+ }
+
  return
 }
 
@@ -692,49 +698,49 @@ func getCounterCount(s *sdk.SDK, counterName string) (string, error) {
  return "COUNTER: " + strconv.FormatInt(count, 10) + "\n", nil
 }
 
-// incrementCounter returns the if the Counter Count was incremented successfully (true) or not (false)
+// incrementCounter returns the if the Counter Count was incremented successfully or not
 func incrementCounter(s *sdk.SDK, counterName string, amount string) (string, error) {
  amountInt, err := strconv.ParseInt(amount, 10, 64)
  if err != nil {
- return "false", fmt.Errorf("could not increment Counter %s by unparseable amount %s: %s", counterName, amount, err)
+ return "", fmt.Errorf("Could not increment Counter %s by unparseable amount %s: %s", counterName, amount, err)
  }
  log.Printf("Incrementing Counter %s Count by amount %d", counterName, amountInt)
- ok, err := s.Alpha().IncrementCounter(counterName, amountInt)
+ 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 "", err
  }
- return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
+ return "SUCCESS\n", nil
 }
 
-// decrementCounter returns the if the Counter Count was decremented successfully (true) or not (false)
+// decrementCounter returns if the Counter Count was decremented successfully or not
 func decrementCounter(s *sdk.SDK, counterName string, amount string) (string, error) {
  amountInt, err := strconv.ParseInt(amount, 10, 64)
  if err != nil {
- return "false", fmt.Errorf("could not decrement Counter %s by unparseable amount %s: %s", counterName, amount, err)
+ return "", fmt.Errorf("could not decrement Counter %s by unparseable amount %s: %s", counterName, amount, err)
  }
  log.Printf("Decrementing Counter %s Count by amount %d", counterName, amountInt)
- ok, err := s.Alpha().DecrementCounter(counterName, amountInt)
+ 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 "", err
  }
- return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
+ return "SUCCESS\n", nil
 }
 
-// setCounterCount returns the if the Counter was set to a new Count successfully (true) or not (false)
+// setCounterCount returns the if the Counter was set to a new Count successfully or not
 func setCounterCount(s *sdk.SDK, counterName string, amount string) (string, error) {
  amountInt, err := strconv.ParseInt(amount, 10, 64)
  if err != nil {
- return "false", fmt.Errorf("could not set Counter %s to unparseable amount %s: %s", counterName, amount, err)
+ return "", fmt.Errorf("could not set Counter %s to unparseable amount %s: %s", counterName, amount, err)
  }
  log.Printf("Setting Counter %s Count to amount %d", counterName, amountInt)
- ok, err := s.Alpha().SetCounterCount(counterName, amountInt)
+ 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 "", err
  }
- return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
+ return "SUCCESS\n", nil
 }
 
 // getCounterCapacity returns the Capacity of the given Counter as a string
@@ -748,19 +754,19 @@ func getCounterCapacity(s *sdk.SDK, counterName string) (string, error) {
  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)
+// setCounterCapacity returns the if the Counter was set to a new Capacity successfully or not
 func setCounterCapacity(s *sdk.SDK, counterName string, amount string) (string, error) {
  amountInt, err := strconv.ParseInt(amount, 10, 64)
  if err != nil {
- return "false", fmt.Errorf("could not set Counter %s to unparseable amount %s: %s", counterName, amount, err)
+ return "", fmt.Errorf("could not set Counter %s to unparseable amount %s: %s", counterName, amount, err)
  }
  log.Printf("Setting Counter %s Capacity to amount %d", counterName, amountInt)
- ok, err := s.Alpha().SetCounterCapacity(counterName, amountInt)
+ 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 "", err
  }
- return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
+ return "SUCCESS\n", nil
 }
 
 // getListCapacity returns the Capacity of the given List as a string
@@ -774,19 +780,19 @@ func getListCapacity(s *sdk.SDK, listName string) (string, error) {
  return "CAPACITY: " + strconv.FormatInt(capacity, 10) + "\n", nil
 }
 
-// setListCapacity returns if the List was set to a new Capacity successfully (true) or not (false)
+// setListCapacity returns if the List was set to a new Capacity successfully or not
 func setListCapacity(s *sdk.SDK, listName string, amount string) (string, error) {
  amountInt, err := strconv.ParseInt(amount, 10, 64)
  if err != nil {
- return "false", fmt.Errorf("could not set List %s to unparseable amount %s: %s", listName, amount, err)
+ return "", fmt.Errorf("could not set List %s to unparseable amount %s: %s", listName, amount, err)
  }
  log.Printf("Setting List %s Capacity to amount %d", listName, amountInt)
- ok, err := s.Alpha().SetListCapacity(listName, amountInt)
+ 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 "", err
  }
- return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
+ return "SUCCESS\n", nil
 }
 
 // listContains returns true if the given value is in the given List, false otherwise
@@ -796,8 +802,8 @@ func listContains(s *sdk.SDK, listName string, value string) (string, error) {
  if err != nil {
  log.Printf("Error getting List %s contains value %s: %s", listName, value, err)
  return strconv.FormatBool(ok), err
- } 
- return "FOUND: " + strconv.FormatBool(ok) + "\n", nil
+ }
+ return "FOUND: " + strconv.FormatBool(ok) + "\n", nil
 }
 
 // getListLength returns the length (number of values) of the given List as a string
@@ -820,31 +826,31 @@ func getListValues(s *sdk.SDK, listName string) (string, error) {
  return "INVALID LIST NAME", err
  }
  if len(values) > 0 {
- return "VALUES: " + strings.Join(values, ",") + "\n", nil
- }
- return "VALUES: <none>\n", err
+ return "VALUES: " + strings.Join(values, ",") + "\n", nil
+ }
+ return "VALUES: <none>\n", nil
 }
 
-// appendListValue returns if the given value was successfuly added to the List (true) or not (false)
+// appendListValue returns if the given value was successfuly added to the List or not
 func appendListValue(s *sdk.SDK, listName string, value string) (string, error) {
  log.Printf("Appending Value %s to List %s", value, listName)
- ok, err := s.Alpha().AppendListValue(listName, value)
+ 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 "", err
  }
- return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
+ return "SUCCESS\n", nil
 }
 
-// deleteListValue returns if the given value was successfuly deleted from the List (true) or not (false)
+// deleteListValue returns if the given value was successfuly deleted from the List or not
 func deleteListValue(s *sdk.SDK, listName string, value string) (string, error) {
  log.Printf("Deleting Value %s from List %s", value, listName)
- ok, err := s.Alpha().DeleteListValue(listName, value)
+ 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 "", err
  }
- return "SUCCESS: " + strconv.FormatBool(ok) + "\n", nil
+ return "SUCCESS\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.28"
+ value: "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30"
  - 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.28",
+ "image": "us-docker.pkg.dev/agones-images/examples/simple-game-server:0.30",
  "name": false
  }]
  }