Adding tests for Liveness probes

pkg/testing/v1/service.go

@@ -415,6 +415,14 @@ func WithReadinessProbe(p *corev1.Probe) ServiceOption {
 	}
 }
 
+// WithLivenessProbe sets the provided probe to be the liveness
+// probe on the service.
+func WithLivenessProbe(p *corev1.Probe) ServiceOption {
+	return func(s *v1.Service) {
+		s.Spec.Template.Spec.Containers[0].LivenessProbe = p
+	}
+}
+
 // MarkConfigurationNotReconciled calls the function of the same name on the Service's status.
 func MarkConfigurationNotReconciled(service *v1.Service) {
 	service.Status.MarkConfigurationNotReconciled()

test/conformance.go

@@ -47,7 +47,7 @@ const (
 	PizzaPlanet1        = "pizzaplanetv1"
 	PizzaPlanet2        = "pizzaplanetv2"
 	Protocols           = "protocols"
-	Readiness           = "readiness"
+	HealthProbes        = "healthprobes"
 	Runtime             = "runtime"
 	ServingContainer    = "servingcontainer"
 	SidecarContainer    = "sidecarcontainer"

test/conformance/runtime/liveness_probe_test.go

@@ -0,0 +1,117 @@
+//go:build e2e
+// +build e2e
+
+/*
+Copyright 2022 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 runtime
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	corev1 "k8s.io/api/core/v1"
+	pkgtest "knative.dev/pkg/test"
+	"knative.dev/pkg/test/spoof"
+	revisionresourcenames "knative.dev/serving/pkg/reconciler/revision/resources/names"
+	v1opts "knative.dev/serving/pkg/testing/v1"
+	"knative.dev/serving/test"
+	"knative.dev/serving/test/conformance/api/shared"
+	v1test "knative.dev/serving/test/v1"
+)
+
+const livenessPath = "/healthz/liveness"
+
+func TestLiveness(t *testing.T) {
+	t.Parallel()
+	if test.ServingFlags.DisableOptionalAPI {
+		t.Skip("Container.livenessProbe is not required by Knative Serving API Specification")
+	}
+	clients := test.Setup(t)
+
+	var testCases = []struct {
+		// name of the test case, which will be inserted in names of routes, configurations, etc.
+		// Use a short name here to avoid hitting the 63-character limit in names
+		// (e.g., "service-to-service-call-svc-cluster-local-uagkdshh-frkml-service" is too long.)
+		name    string
+		handler corev1.Handler
+		sleep   bool
+	}{{
+		name: "httpGet",
+		handler: corev1.Handler{
+			HTTPGet: &corev1.HTTPGetAction{
+				Path: livenessPath,
+			},
+		},
+	}, {
+		name: "httpGetAfterFirstProbe",
+		handler: corev1.Handler{
+			HTTPGet: &corev1.HTTPGetAction{
+				Path: livenessPath,
+			},
+		},
+		sleep: true,
+	}}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			t.Parallel()
+			names := test.ResourceNames{
+				Service: test.ObjectNameForTest(t),
+				Image:   test.HealthProbes,
+			}
+
+			test.EnsureTearDown(t, clients, &names)
+
+			t.Log("Creating a new Service")
+			resources, err := v1test.CreateServiceReady(t, clients, &names,
+				v1opts.WithLivenessProbe(
+					&corev1.Probe{
+						Handler:          tc.handler,
+						PeriodSeconds:    10,
+						FailureThreshold: 1,
+					}))
+			if err != nil {
+				t.Fatalf("Failed to create initial Service: %v: %v", names.Service, err)
+			}
+
+			// If true sleeping till the first kubelet probe check.
+			if tc.sleep {
+				time.Sleep(15 * time.Second)
+			}
+			url := resources.Route.Status.URL.URL()
+			url.Path = livenessPath
+			if _, err = pkgtest.CheckEndpointState(
+				context.Background(),
+				clients.KubeClient,
+				t.Logf,
+				url,
+				spoof.MatchesAllOf(spoof.IsStatusOK, spoof.MatchesBody(test.HelloWorldText)),
+				"livenessIsReady",
+				test.ServingFlags.ResolvableDomain,
+				test.AddRootCAtoTransport(context.Background(), t.Logf, clients, test.ServingFlags.HTTPS),
+			); err != nil {
+				t.Fatalf("The endpoint for Route %s at %s didn't return success: %v", names.Route, url, err)
+			}
+			// Check if scaling down works even if access from liveness probe exists.
+			if err := shared.WaitForScaleToZero(t, revisionresourcenames.Deployment(resources.Revision), clients); err != nil {
+				t.Fatal("Could not scale to zero:", err)
+			}
+		})
+
+	}
+}

test/conformance/runtime/readiness_probe_test.go

@@ -40,12 +40,16 @@ import (
 	v1test "knative.dev/serving/test/v1"
 )
 
-// readinessPropagationTime is how long to poll to allow for readiness probe
-// changes to propagate to ingresses/activator.
-// This is based on the default scaleToZeroGracePeriod.
-const readinessPropagationTime = 30 * time.Second
+const (
+	// readinessPropagationTime is how long to poll to allow for readiness probe
+	// changes to propagate to ingresses/activator.
+	// This is based on the default scaleToZeroGracePeriod.
+	readinessPropagationTime = 30 * time.Second
 
-func TestProbeRuntime(t *testing.T) {
+	readinessPath = "/healthz/readiness"
+)
+
+func TestReadiness(t *testing.T) {
 	t.Parallel()
 	if test.ServingFlags.DisableOptionalAPI {
 		t.Skip("Container.readinessProbe is not required by Knative Serving API Specification")
@@ -67,7 +71,7 @@ func TestProbeRuntime(t *testing.T) {
 		}},
 		handler: corev1.Handler{
 			HTTPGet: &corev1.HTTPGetAction{
-				Path: "/healthz",
+				Path: readinessPath,
 			},
 		},
 	}, {
@@ -87,7 +91,7 @@ func TestProbeRuntime(t *testing.T) {
 		}},
 		handler: corev1.Handler{
 			Exec: &corev1.ExecAction{
-				Command: []string{"/ko-app/readiness", "probe"},
+				Command: []string{"/ko-app/healthprobes", "probe"},
 			},
 		},
 	}}
@@ -106,7 +110,7 @@ func TestProbeRuntime(t *testing.T) {
 				t.Parallel()
 				names := test.ResourceNames{
 					Service: test.ObjectNameForTest(t),
-					Image:   test.Readiness,
+					Image:   test.HealthProbes,
 				}
 
 				test.EnsureTearDown(t, clients, &names)
@@ -125,7 +129,7 @@ func TestProbeRuntime(t *testing.T) {
 
 				// Once the service reports ready we should immediately be able to curl it.
 				url := resources.Route.Status.URL.URL()
-				url.Path = "/healthz"
+				url.Path = readinessPath
 				if _, err = pkgtest.CheckEndpointState(
 					context.Background(),
 					clients.KubeClient,
@@ -155,7 +159,7 @@ func TestProbeRuntime(t *testing.T) {
 // The goal of this test is largely to describe the current behaviour, so that
 // we can confidently change it.
 // See https://github.com/knative/serving/issues/10765.
-func TestProbeRuntimeAfterStartup(t *testing.T) {
+func TestReadinessAfterStartup(t *testing.T) {
 	t.Parallel()
 	if test.ServingFlags.DisableOptionalAPI {
 		t.Skip("Container.readinessProbe behaviour after startup is not defined by Knative Serving API Specification")
@@ -166,7 +170,7 @@ func TestProbeRuntimeAfterStartup(t *testing.T) {
 		t.Run(fmt.Sprintf("periodSeconds=%d", period), func(t *testing.T) {
 			t.Parallel()
 			clients := test.Setup(t)
-			names := test.ResourceNames{Service: test.ObjectNameForTest(t), Image: test.Readiness}
+			names := test.ResourceNames{Service: test.ObjectNameForTest(t), Image: test.HealthProbes}
 			test.EnsureTearDown(t, clients, &names)
 
 			url, client := waitReadyThenStartFailing(t, clients, names, period)
@@ -216,7 +220,7 @@ func waitReadyThenStartFailing(t *testing.T, clients *test.Clients, names test.R
 			PeriodSeconds: probePeriod,
 			Handler: corev1.Handler{
 				HTTPGet: &corev1.HTTPGetAction{
-					Path: "/healthz",
+					Path: readinessPath,
 				},
 			},
 		}))
@@ -230,7 +234,7 @@ func waitReadyThenStartFailing(t *testing.T, clients *test.Clients, names test.R
 	// Ref: https://github.com/knative/serving/issues/11404
 	t.Log("Wait for initial readiness")
 	url := resources.Route.Status.URL.URL()
-	url.Path = "/healthz"
+	url.Path = readinessPath
 	if _, err = pkgtest.CheckEndpointState(
 		context.Background(),
 		clients.KubeClient,

test/test_images/readiness/README.md → test/test_images/healthprobes/README.md

@@ -1,11 +1,11 @@
 # Ready test image
 
 This directory contains the test image used to simulate an image that responds
-to various types of readiness probe.
+to various types of readiness and liveness probes.
 
-The image provides a /healthz endpoint which will reply with a 200 status code
-and the Hello World text only after the delay requested by the STARTUP_DELAY
-environment variable has elapsed.
+The image provides a `/healthz/readiness` and a `/healthz/liveness` endpoint which
+will reply with a 200 status code and the Hello World text only after the delay
+requested by the STARTUP_DELAY environment variable has elapsed.
 
 The image also contains an exec probe when run with "probe" as its only argument.
 

test/test_images/readiness/readiness.go → test/test_images/healthprobes/health_probes.go

@@ -54,7 +54,7 @@ func main() {
 		}()
 	}
 
-	http.HandleFunc("/healthz", func(w http.ResponseWriter, _ *http.Request) {
+	http.HandleFunc("/healthz/readiness", func(w http.ResponseWriter, _ *http.Request) {
 		mu.Lock()
 		defer mu.Unlock()
 
@@ -66,6 +66,11 @@ func main() {
 		fmt.Fprint(w, test.HelloWorldText)
 	})
 
+	http.HandleFunc("/healthz/liveness", func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusOK)
+		fmt.Fprint(w, test.HelloWorldText)
+	})
+
 	http.HandleFunc("/start-failing", func(w http.ResponseWriter, _ *http.Request) {
 		mu.Lock()
 		defer mu.Unlock()
@@ -91,7 +96,7 @@ func main() {
 }
 
 func execProbeMain() {
-	resp, err := http.Get(os.ExpandEnv("http://localhost:$PORT/healthz"))
+	resp, err := http.Get(os.ExpandEnv("http://localhost:$PORT/healthz/readiness"))
 	if err != nil {
 		log.Fatal("Failed to probe: ", err)
 	}

test/test_images/readiness/service.yaml → test/test_images/healthprobes/service.yaml

@@ -1,10 +1,10 @@
 apiVersion: serving.knative.dev/v1
 kind: Service
 metadata:
-  name: readiness-test-image
+  name: healthprobes-test-image
   namespace: default
 spec:
   template:
     spec:
       containers:
-      - image: ko://knative.dev/serving/test/test_images/readiness
+      - image: ko://knative.dev/serving/test/test_images/healthprobes