minscale_readiness_test.go

// +build e2e

/*
Copyright 2019 The Knative Authors

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 e2e

import (
	"strconv"
	"time"

	"testing"

	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/util/wait"
	"knative.dev/pkg/test/logstream"
	"knative.dev/serving/pkg/apis/autoscaling"
	"knative.dev/serving/pkg/apis/serving/v1alpha1"
	"knative.dev/serving/test"
	v1a1test "knative.dev/serving/test/v1alpha1"
)

func TestMinScale(t *testing.T) {
	t.Parallel()
	cancel := logstream.Start(t)
	defer cancel()

	const minScale = 4

	clients := Setup(t)

	name := test.ObjectNameForTest(t)

	names := test.ResourceNames{
		Config: name,
		Route:  name,
		Image:  "helloworld",
	}

	t.Log("Creating configuration")
	if _, err := v1a1test.CreateConfiguration(t, clients, names, withMinScale(minScale)); err != nil {
		t.Fatalf("Failed to create Configuration: %v", err)
	}

	test.CleanupOnInterrupt(func() { test.TearDown(clients, names) })
	defer test.TearDown(clients, names)

	revName := latestRevisionName(t, clients, names.Config)
	deploymentName := revName + "-deployment"

	// Before becoming ready, observe minScale
	t.Log("Waiting for revision to scale to minScale before becoming ready")
	if err := waitForDesiredScale(t, clients, deploymentName, gte(minScale)); err != nil {
		t.Fatalf("The deployment %q did not scale >= %d before becoming ready: %v", deploymentName, minScale, err)
	}

	// Revision becomes ready
	if err := v1a1test.WaitForRevisionState(
		clients.ServingAlphaClient, revName, v1a1test.IsRevisionReady, "RevisionIsReady",
	); err != nil {
		t.Fatalf("The Revision %q did not become ready: %v", revName, err)
	}

	// Without a route, ignore minScale
	t.Log("Waiting for revision to scale below minScale after becoming ready")
	if err := waitForDesiredScale(t, clients, deploymentName, lt(minScale)); err != nil {
		t.Fatalf("The deployment %q did not scale < minScale after becoming ready: %v", deploymentName, err)
	}

	// Create route
	t.Log("Creating route")
	if _, err := v1a1test.CreateRoute(t, clients, names); err != nil {
		t.Fatalf("Failed to create Route: %v", err)
	}

	// Route becomes ready
	if err := v1a1test.WaitForRouteState(
		clients.ServingAlphaClient, names.Route, v1a1test.IsRouteReady, "RouteIsReady",
	); err != nil {
		t.Fatalf("The Route %q is not ready: %v", names.Route, err)
	}

	// With a route, observe minScale
	t.Log("Waiting for revision to scale to minScale after creating route")
	if err := waitForDesiredScale(t, clients, deploymentName, gte(minScale)); err != nil {
		t.Fatalf("The deployment %q did not scale >= %d after creating route: %v", deploymentName, minScale, err)
	}
}

func gte(m int) func(int32) bool {
	return func(n int32) bool {
		return n >= int32(m)
	}
}

func lt(m int) func(int32) bool {
	return func(n int32) bool {
		return n < int32(m)
	}
}

func withMinScale(minScale int) func(cfg *v1alpha1.Configuration) {
	return func(cfg *v1alpha1.Configuration) {
		if cfg.Spec.Template.Annotations == nil {
			cfg.Spec.Template.Annotations = make(map[string]string)
		}
		cfg.Spec.Template.Annotations[autoscaling.MinScaleAnnotationKey] = strconv.Itoa(minScale)
	}
}

func latestRevisionName(t *testing.T, clients *test.Clients, configName string) string {
	// Wait for the Config have a LatestCreatedRevisionName
	if err := v1a1test.WaitForConfigurationState(
		clients.ServingAlphaClient, configName,
		v1a1test.ConfigurationHasCreatedRevision, "ConfigurationHasCreatedRevision",
	); err != nil {
		t.Fatalf("The Configuration %q does not have a LatestCreatedRevisionName: %v", configName, err)
	}

	config, err := clients.ServingAlphaClient.Configs.Get(configName, metav1.GetOptions{})
	if err != nil {
		t.Fatalf("Failed to get Configuration after it was seen to be live: %v", err)
	}

	return config.Status.LatestCreatedRevisionName
}

func waitForDesiredScale(t *testing.T, clients *test.Clients, deploymentName string, cond func(int32) bool) error {
	deployments := clients.KubeClient.Kube.AppsV1().Deployments(test.ServingNamespace)

	return wait.PollImmediate(time.Second, 1*time.Minute, func() (bool, error) {
		deployment, err := deployments.Get(deploymentName, metav1.GetOptions{})
		if err != nil {
			return false, nil
		}

		return cond(*deployment.Spec.Replicas), nil
	})
}