consider initContainers when calculating a pod's requests (#203)

This commit also:
 - Standardises uses of resource.Quantity
 - Adds expectedNodeDelta to scale up tests

fixes #202

pkg/controller/controller_scale_node_group_test.go

@@ -4,14 +4,14 @@ import (
  "testing"
  duration "time"
 
+ "github.com/atlassian/escalator/pkg/k8s/resource"
  "github.com/atlassian/escalator/pkg/test"
  "github.com/pkg/errors"
  log "github.com/sirupsen/logrus"
  time "github.com/stephanos/clock"
  "github.com/stretchr/testify/assert"
  "github.com/stretchr/testify/require"
  v1 "k8s.io/api/core/v1"
- "k8s.io/apimachinery/pkg/api/resource"
 )
 
 type ListerOptions struct {
@@ -215,9 +215,10 @@ func TestScaleNodeGroup(t *testing.T) {
  }
 
  tests := []struct {
- name string
- args args
- err error
+ name string
+ args args
+ expectedNodeDelta int
+ err error
  }{
  {
  "100% cpu, 50% threshold",
@@ -233,6 +234,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 10,
  nil,
  },
  {
@@ -249,6 +251,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 10,
  nil,
  },
  {
@@ -265,6 +268,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 5,
  nil,
  },
  {
@@ -281,6 +285,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 12,
  nil,
  },
  {
@@ -297,6 +302,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 0,
  nil,
  },
  {
@@ -313,6 +319,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 1,
  nil,
  },
  {
@@ -327,6 +334,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 0,
  errors.New("node count less than the minimum"),
  },
  {
@@ -341,6 +349,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 0,
  errors.New("node count larger than the maximum"),
  },
  {
@@ -356,6 +365,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 0,
  errors.New("cannot divide by zero in percent calculation"),
  },
  {
@@ -371,6 +381,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 0,
  errors.New("cannot divide by zero in percent calculation"),
  },
  {
@@ -386,6 +397,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 0,
  errors.New("cannot divide by zero in percent calculation"),
  },
  {
@@ -406,6 +418,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  },
  },
+ 0,
  errors.New("unable to list pods"),
  },
  {
@@ -426,6 +439,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  },
  },
+ 0,
  errors.New("unable to list nodes"),
  },
  {
@@ -442,6 +456,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 0,
  nil,
  },
  {
@@ -458,6 +473,7 @@ func TestScaleNodeGroup(t *testing.T) {
  },
  ListerOptions{},
  },
+ 38,
  nil,
  },
  }
@@ -507,6 +523,7 @@ func TestScaleNodeGroup(t *testing.T) {
  require.EqualError(t, tt.err, err.Error())
  }
 
+ assert.Equal(t, tt.expectedNodeDelta, nodesDelta)
  if nodesDelta <= 0 {
  return
  }
@@ -542,7 +559,7 @@ func TestScaleNodeGroup_MultipleRuns(t *testing.T) {
  nodeGroupOptions NodeGroupOptions
  listerOptions ListerOptions
  }
- var defaultNodeCPUCapaity int64 = 2000
+ var defaultNodeCPUCapacity int64 = 2000
  var defaultNodeMemCapacity int64 = 8000
 
  tests := []struct {
@@ -557,7 +574,7 @@ func TestScaleNodeGroup_MultipleRuns(t *testing.T) {
  {
  "10 nodes, 0 pods, min nodes 5, fast node removal",
  args{
- buildTestNodes(10, defaultNodeCPUCapaity, defaultNodeMemCapacity),
+ buildTestNodes(10, defaultNodeCPUCapacity, defaultNodeMemCapacity),
  buildTestPods(0, 0, 0),
  NodeGroupOptions{
  Name: "default",
@@ -583,7 +600,7 @@ func TestScaleNodeGroup_MultipleRuns(t *testing.T) {
  {
  "10 nodes, 10 pods, slow node removal",
  args{
- buildTestNodes(10, defaultNodeCPUCapaity, defaultNodeMemCapacity),
+ buildTestNodes(10, defaultNodeCPUCapacity, defaultNodeMemCapacity),
  buildTestPods(10, 1000, 1000),
  NodeGroupOptions{
  Name: "default",
@@ -609,7 +626,7 @@ func TestScaleNodeGroup_MultipleRuns(t *testing.T) {
  {
  "4 nodes, 0 pods, min nodes 0, fast node removal to scale down to 0",
  args{
- buildTestNodes(4, defaultNodeCPUCapaity, defaultNodeMemCapacity),
+ buildTestNodes(4, defaultNodeCPUCapacity, defaultNodeMemCapacity),
  buildTestPods(0, 0, 0),
  NodeGroupOptions{
  Name: "default",
@@ -635,7 +652,7 @@ func TestScaleNodeGroup_MultipleRuns(t *testing.T) {
  {
  "0 nodes, 10 pods, min nodes 0, scale up from 0 without cache",
  args{
- buildTestNodes(0, defaultNodeCPUCapaity, defaultNodeMemCapacity),
+ buildTestNodes(0, defaultNodeCPUCapacity, defaultNodeMemCapacity),
  buildTestPods(40, 200, 800),
  NodeGroupOptions{
  Name: "default",
@@ -662,7 +679,7 @@ func TestScaleNodeGroup_MultipleRuns(t *testing.T) {
  {
  "0 nodes, 10 pods, min nodes 0, scale up from 0 with cache",
  args{
- buildTestNodes(0, defaultNodeCPUCapaity, defaultNodeMemCapacity),
+ buildTestNodes(0, defaultNodeCPUCapacity, defaultNodeMemCapacity),
  buildTestPods(40, 200, 800),
  NodeGroupOptions{
  Name: "default",
@@ -717,8 +734,8 @@ func TestScaleNodeGroup_MultipleRuns(t *testing.T) {
  // add cached node allocatable capacity when configured
  if tt.scaleUpWithCachedCapacity {
  defaultNodeGroupState := nodeGroupsState[tt.args.nodeGroupOptions.Name]
- defaultNodeGroupState.cpuCapacity = *resource.NewMilliQuantity(defaultNodeCPUCapaity, resource.DecimalSI)
- defaultNodeGroupState.memCapacity = *resource.NewQuantity(defaultNodeMemCapacity, resource.DecimalSI)
+ defaultNodeGroupState.cpuCapacity = *resource.NewCPUQuantity(defaultNodeCPUCapacity)
+ defaultNodeGroupState.memCapacity = *resource.NewMemoryQuantity(defaultNodeMemCapacity)
  nodeGroupsState[tt.args.nodeGroupOptions.Name] = defaultNodeGroupState
  }
 

pkg/controller/util_test.go

@@ -4,12 +4,12 @@ import (
  "testing"
 
  "github.com/atlassian/escalator/pkg/k8s"
+ "github.com/atlassian/escalator/pkg/k8s/resource"
  "github.com/atlassian/escalator/pkg/test"
  "github.com/pkg/errors"
  "github.com/stretchr/testify/assert"
  "github.com/stretchr/testify/require"
  v1 "k8s.io/api/core/v1"
- "k8s.io/apimachinery/pkg/api/resource"
 )
 
 func TestCalcScaleUpDeltaBelowThreshold(t *testing.T) {
@@ -203,10 +203,10 @@ func calculatePercentageUsage(pods []*v1.Pod, nodes []*v1.Node) (float64, float6
 
 func TestCalcPercentUsage(t *testing.T) {
  type args struct {
- cpuRequest resource.Quantity
- memRequest resource.Quantity
- cpuCapacity resource.Quantity
- memCapacity resource.Quantity
+ cpuRequest int64
+ memRequest int64
+ cpuCapacity int64
+ memCapacity int64
  numberOfUntaintedNodes int64
  }
  tests := []struct {
@@ -219,10 +219,10 @@ func TestCalcPercentUsage(t *testing.T) {
  {
  "basic test",
  args{
- *resource.NewMilliQuantity(50, resource.DecimalSI),
- *resource.NewQuantity(50, resource.DecimalSI),
- *resource.NewMilliQuantity(100, resource.DecimalSI),
- *resource.NewQuantity(100, resource.DecimalSI),
+ 50,
+ 50,
+ 100,
+ 100,
  1,
  },
  50,
@@ -232,10 +232,10 @@ func TestCalcPercentUsage(t *testing.T) {
  {
  "divide by zero test",
  args{
- *resource.NewMilliQuantity(50, resource.DecimalSI),
- *resource.NewQuantity(50, resource.DecimalSI),
- *resource.NewMilliQuantity(0, resource.DecimalSI),
- *resource.NewQuantity(0, resource.DecimalSI),
+ 50,
+ 50,
+ 0,
+ 0,
  10,
  },
  0,
@@ -245,10 +245,10 @@ func TestCalcPercentUsage(t *testing.T) {
  {
  "no pods request while number of nodes is not 0",
  args{
- *resource.NewMilliQuantity(0, resource.DecimalSI),
- *resource.NewQuantity(0, resource.DecimalSI),
- *resource.NewMilliQuantity(0, resource.DecimalSI),
- *resource.NewQuantity(0, resource.DecimalSI),
+ 0,
+ 0,
+ 0,
+ 0,
  1,
  },
  0,
@@ -258,10 +258,10 @@ func TestCalcPercentUsage(t *testing.T) {
  {
  "zero numerator test",
  args{
- *resource.NewMilliQuantity(0, resource.DecimalSI),
- *resource.NewQuantity(0, resource.DecimalSI),
- *resource.NewMilliQuantity(66, resource.DecimalSI),
- *resource.NewQuantity(66, resource.DecimalSI),
+ 0,
+ 0,
+ 66,
+ 66,
  1,
  },
  0,
@@ -271,10 +271,10 @@ func TestCalcPercentUsage(t *testing.T) {
  {
  "zero all test",
  args{
- *resource.NewMilliQuantity(0, resource.DecimalSI),
- *resource.NewQuantity(0, resource.DecimalSI),
- *resource.NewMilliQuantity(0, resource.DecimalSI),
- *resource.NewQuantity(0, resource.DecimalSI),
+ 0,
+ 0,
+ 0,
+ 0,
  0,
  },
  0,
@@ -284,7 +284,12 @@ func TestCalcPercentUsage(t *testing.T) {
  }
  for _, tt := range tests {
  t.Run(tt.name, func(t *testing.T) {
- cpu, mem, err := calcPercentUsage(tt.args.cpuRequest, tt.args.memRequest, tt.args.cpuCapacity, tt.args.memCapacity, tt.args.numberOfUntaintedNodes)
+ cpuRequest := *resource.NewCPUQuantity(tt.args.cpuRequest)
+ cpuCapacity := *resource.NewCPUQuantity(tt.args.cpuCapacity)
+ memRequest := *resource.NewMemoryQuantity(tt.args.memRequest)
+ memCapacity := *resource.NewMemoryQuantity(tt.args.memCapacity)
+
+ cpu, mem, err := calcPercentUsage(cpuRequest, memRequest, cpuCapacity, memCapacity, tt.args.numberOfUntaintedNodes)
  if tt.err == nil {
  require.NoError(t, err)
  } else {

pkg/k8s/resource/quantity.go

@@ -0,0 +1,17 @@
+package resource
+
+import (
+ "k8s.io/apimachinery/pkg/api/resource"
+)
+
+func NewMemoryQuantity(value int64) *resource.Quantity {
+ return resource.NewQuantity(value, resource.BinarySI)
+}
+
+func NewCPUQuantity(value int64) *resource.Quantity {
+ return resource.NewMilliQuantity(value, resource.DecimalSI)
+}
+
+func NewPodQuantity(value int64) *resource.Quantity {
+ return resource.NewQuantity(value, resource.DecimalSI)
+}