Feat/counter and list defaulting order to ascending (#3734)

* feat(counter&list): Defaulting order to ascending in fleet crd

* feat(counter&list): Defaulting order to ascending in gameserverAllocation

* feat(counter&list): Update unit test

* feat(counter&list): Add default sort order in comment for priority

* feat(counter&list): Re-run make test-gen-api-docs to update doc

install/helm/agones/templates/crds/fleet.yaml

@@ -129,6 +129,7 @@ spec:
  order:
  type: string
  description: Ascending or Descending sort order. Default is "Ascending" so remove smaller available capacity first. "Descending" would remove larger available capacity first.
+ default: Ascending
  enum:
  - Ascending
  - Descending

install/yaml/install.yaml

@@ -299,6 +299,7 @@ spec:
  order:
  type: string
  description: Ascending or Descending sort order. Default is "Ascending" so remove smaller available capacity first. "Descending" would remove larger available capacity first.
+ default: Ascending
  enum:
  - Ascending
  - Descending

pkg/apis/agones/v1/common.go

@@ -184,6 +184,7 @@ type Priority struct {
  Key string `json:"key"`
  // Order: Sort by "Ascending" or "Descending". "Descending" a bigger available capacity is preferred.
  // "Ascending" would be smaller available capacity is preferred.
+ // The default sort order is "Ascending"
  Order string `json:"order"`
 }
 

pkg/apis/allocation/v1/gameserverallocation.go

@@ -583,6 +583,12 @@ func (gsa *GameServerAllocation) ApplyDefaults() {
  gsa.Spec.Scheduling = apis.Packed
  }
 
+ for i := range gsa.Spec.Priorities {
+ if len(gsa.Spec.Priorities[i].Order) == 0 {
+ gsa.Spec.Priorities[i].Order = agonesv1.GameServerPriorityAscending
+ }
+ }
+
  if len(gsa.Spec.Selectors) == 0 {
  gsa.Spec.Required.ApplyDefaults()
 

pkg/apis/allocation/v1/gameserverallocation_test.go

@@ -36,9 +36,19 @@ func TestGameServerAllocationApplyDefaults(t *testing.T) {
 
  assert.Equal(t, apis.Packed, gsa.Spec.Scheduling)
 
- gsa = &GameServerAllocation{Spec: GameServerAllocationSpec{Scheduling: apis.Distributed}}
+ priorities := []agonesv1.Priority{
+ {Type: agonesv1.GameServerPriorityList},
+ {Type: agonesv1.GameServerPriorityCounter},
+ }
+ expectedPrioritiesWithDefault := []agonesv1.Priority{
+ {Type: agonesv1.GameServerPriorityList, Order: agonesv1.GameServerPriorityAscending},
+ {Type: agonesv1.GameServerPriorityCounter, Order: agonesv1.GameServerPriorityAscending},
+ }
+
+ gsa = &GameServerAllocation{Spec: GameServerAllocationSpec{Scheduling: apis.Distributed, Priorities: priorities}}
  gsa.ApplyDefaults()
  assert.Equal(t, apis.Distributed, gsa.Spec.Scheduling)
+ assert.Equal(t, expectedPrioritiesWithDefault, gsa.Spec.Priorities)
 
  runtime.FeatureTestMutex.Lock()
  defer runtime.FeatureTestMutex.Unlock()