Add a simple helm test (googleforgames#1449)

* Add a simple helm test

This could be useful for Terraform configs check that installation
was completed, for example after switching to a new cluster.

* Add docs, import cleanup.

Described `helm test` command. Updated `crd-client` docs and version in
yaml of example Job which creates a GameServer and also used by the test.
Bump version of Agones in go.mod.

Co-authored-by: Mark Mandel <[email protected]>

examples/crd-client/Makefile

@@ -25,7 +25,7 @@
 
 REPOSITORY ?= gcr.io/agones-images
 
-server_tag = $(REPOSITORY)/crd-client:0.2
+server_tag = $(REPOSITORY)/crd-client:0.3
 
 #   _____                    _
 #  |_   _|_ _ _ __ __ _  ___| |_ ___

examples/crd-client/create-gs.yaml

@@ -24,7 +24,7 @@ spec:
       serviceAccountName: agones-controller
       containers:
       - name: create-gameserver
-        image: gcr.io/agones-images/crd-client:0.2
+        image: gcr.io/agones-images/crd-client:0.3
         imagePullPolicy: Always
         env:
         - name: GAMESERVER_IMAGE

examples/crd-client/go.mod

@@ -3,20 +3,18 @@ module agones.dev/agones/examples/crd-client
 go 1.13
 
 require (
-	agones.dev/agones v1.2.0
+	agones.dev/agones v1.5.0
 	github.com/gogo/protobuf v1.3.1 // indirect
 	github.com/googleapis/gnostic v0.3.1 // indirect
-	github.com/gregjones/httpcache v0.0.0-20190611155906-901d90724c79 // indirect
 	github.com/json-iterator/go v1.1.8 // indirect
 	github.com/modern-go/reflect2 v1.0.1 // indirect
-	github.com/spf13/afero v1.2.2 // indirect
+	github.com/sirupsen/logrus v1.2.0
 	github.com/spf13/pflag v1.0.3
 	github.com/spf13/viper v1.3.1
 	golang.org/x/net v0.0.0-20191209160850-c0dbc17a3553 // indirect
 	golang.org/x/oauth2 v0.0.0-20191202225959-858c2ad4c8b6 // indirect
 	golang.org/x/time v0.0.0-20191024005414-555d28b269f0 // indirect
-	k8s.io/api v0.0.0-20191004102255-dacd7df5a50b // kubernetes-1.13.12
-	k8s.io/apimachinery v0.0.0-20191004074956-01f8b7d1121a // kubernetes-1.13.12
-	k8s.io/client-go v9.0.0+incompatible // kubernetes-1.13.12
-	k8s.io/klog v0.3.0 // indirect
+	k8s.io/api v0.0.0-20191004102349-159aefb8556b // kubernetes-1.14.10
+	k8s.io/apimachinery v0.0.0-20191004074956-c5d2f014d689 // kubernetes-1.14.10
+	k8s.io/client-go v11.0.1-0.20191029005444-8e4128053008+incompatible // kubernetes-1.14.10
 )

examples/crd-client/main.go

@@ -15,34 +15,50 @@
 package main
 
 import (
-	"fmt"
 	"strings"
+	"time"
 
 	agonesv1 "agones.dev/agones/pkg/apis/agones/v1"
 	"agones.dev/agones/pkg/client/clientset/versioned"
 	"agones.dev/agones/pkg/util/runtime"
+	"github.com/sirupsen/logrus"
 	"github.com/spf13/pflag"
 	"github.com/spf13/viper"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+	"k8s.io/apimachinery/pkg/util/wait"
 	"k8s.io/client-go/kubernetes"
 	"k8s.io/client-go/rest"
 )
 
 const (
-	gameServerImage = "GAMESERVER_IMAGE"
+	gameServerImage      = "GAMESERVER_IMAGE"
+	isHelmTest           = "IS_HELM_TEST"
+	gameserversNamespace = "GAMESERVERS_NAMESPACE"
 
-	defaultImage = "gcr.io/agones-images/udp-server:0.19"
+	defaultNs = "default"
 )
 
 func main() {
 	viper.AllowEmptyEnv(true)
 	viper.SetEnvKeyReplacer(strings.NewReplacer("-", "_"))
 
-	pflag.String(gameServerImage, viper.GetString(gameServerImage), "The Address to bind the server grpcPort to. Defaults to 'localhost'")
-	viper.SetDefault(gameServerImage, defaultImage)
+	pflag.String(gameServerImage, "", "The Address to bind the server grpcPort to. Defaults to 'localhost'")
+	viper.SetDefault(gameServerImage, "")
 	runtime.Must(viper.BindEnv(gameServerImage))
-	viper.GetString(gameServerImage)
+
+	pflag.Bool(isHelmTest, false,
+		"Is Helm test - defines whether GameServer should be shut down at the end of the test or not. Defaults to false")
+	viper.SetDefault(isHelmTest, false)
+	runtime.Must(viper.BindEnv(isHelmTest))
+
+	pflag.String(gameserversNamespace, defaultNs, "Namespace where GameServers are created. Defaults to default")
+	viper.SetDefault(gameserversNamespace, defaultNs)
+	runtime.Must(viper.BindEnv(gameserversNamespace))
+
+	pflag.Parse()
+	runtime.Must(viper.BindPFlags(pflag.CommandLine))
+
 	config, err := rest.InClusterConfig()
 	logger := runtime.NewLoggerWithSource("main")
 	if err != nil {
@@ -67,7 +83,11 @@ func main() {
 	}
 
 	// Create a GameServer
-	gs := &agonesv1.GameServer{ObjectMeta: metav1.ObjectMeta{GenerateName: "udp-server", Namespace: "default"},
+	gs := &agonesv1.GameServer{
+		ObjectMeta: metav1.ObjectMeta{
+			GenerateName: "helm-test-server-",
+			Namespace:    viper.GetString(gameserversNamespace),
+		},
 		Spec: agonesv1.GameServerSpec{
 			Container: "udp-server",
 			Ports: []agonesv1.GameServerPort{{
@@ -79,15 +99,49 @@ func main() {
 			}},
 			Template: corev1.PodTemplateSpec{
 				Spec: corev1.PodSpec{
-					Containers: []corev1.Container{{Name: "udp-server", Image: viper.GetString(gameServerImage)}},
+					Containers: []corev1.Container{
+						{
+							Name:  "udp-server",
+							Image: viper.GetString(gameServerImage),
+						},
+					},
 				},
 			},
 		},
 	}
-	newGS, err := agonesClient.AgonesV1().GameServers("default").Create(gs)
+	newGS, err := agonesClient.AgonesV1().GameServers(gs.Namespace).Create(gs)
 	if err != nil {
-		panic(err)
+		logrus.Fatal("Unable to create GameServer: %v", err)
 	}
+	logrus.Infof("New GameServer name is: %s", newGS.ObjectMeta.Name)
+
+	if viper.GetBool(isHelmTest) {
+		err = wait.PollImmediate(1*time.Second, 60*time.Second, func() (bool, error) {
+			checkGs, err := agonesClient.AgonesV1().GameServers(gs.Namespace).Get(newGS.Name, metav1.GetOptions{})
 
-	fmt.Printf("New game servers' name is: %s", newGS.ObjectMeta.Name)
+			if err != nil {
+				logrus.WithError(err).Warn("error retrieving gameserver")
+				return false, nil
+			}
+
+			state := agonesv1.GameServerStateReady
+			logger.WithField("gs", checkGs.ObjectMeta.Name).
+				WithField("currentState", checkGs.Status.State).
+				WithField("awaitingState", state).Info("Waiting for states to match")
+
+			if checkGs.Status.State == state {
+				return true, nil
+			}
+
+			return false, nil
+		})
+		if err != nil {
+			logrus.Fatalf("Wait GameServer to become Ready failed: %v", err)
+		}
+
+		err = agonesClient.AgonesV1().GameServers(gs.Namespace).Delete(newGS.ObjectMeta.Name, nil)
+		if err != nil {
+			logrus.Fatalf("Unable to delete GameServer: %v", err)
+		}
+	}
 }

install/helm/agones/templates/tests/test-runner.yaml

@@ -0,0 +1,36 @@
+# Copyright 2020 Google LLC All Rights Reserved.
+#
+# 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.
+
+apiVersion: v1
+kind: Pod
+metadata:
+  name: "{{ .Release.Name }}-test"
+  namespace: agones-system
+  annotations:
+    "helm.sh/hook": test-success
+    "helm.sh/hook-delete-policy": hook-succeeded
+spec:
+  serviceAccountName: agones-controller
+  containers:
+  - name: create-gameserver
+    image: gcr.io/agones-images/crd-client:0.3
+    imagePullPolicy: Always
+    env:
+    - name: GAMESERVER_IMAGE
+      value: "gcr.io/agones-images/udp-server:0.19"
+    - name: IS_HELM_TEST
+      value: "true"
+    - name: GAMESERVERS_NAMESPACE
+      value: "{{ index .Values.gameservers.namespaces 0 }}"
+  restartPolicy: Never

install/yaml/install.yaml

@@ -1321,6 +1321,45 @@ metadata:
 data:
   tls-ca.crt: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUM0akNDQWNxZ0F3SUJBZ0lSQU9lTWcwK1JKaFBJbks5ekFpMnpoUjR3RFFZSktvWklodmNOQVFFTEJRQXcKR0RFV01CUUdBMVVFQXhNTllXeHNiMk5oZEdsdmJpMWpZVEFlRncweE9UQTJNVGt4T0RRek5UVmFGdzB5T1RBMgpNVFl4T0RRek5UVmFNQUF3Z2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRRDZMSm5DCmk5RmZnc0Z4MVQremNScm5FNEZRNUNQVUVQOEdrUHNxSE1ic21EelArMEIrVWtFK3k1cGpWbGcrdThxbHNkQ24KenRRVlU1OC9sejJTUDdBZnNIMTNISUpzaTZ4azc3M1hSRVE0NlhxSnBvblg3NjRSajJ5Zjd4T25KMDRidGxUSgp0M3E4U0IvUFk3c2tXdHlRTjJQRDN4QVN0REVXbnUvdzNHMUxNNzYyWGJ3a1o3VlJUY1hFdEpUaTY3dWlwdy96CmhVaU9NcFplT1YxV09neit4cjJQZTZmK0NObTNYUzNVblhjUzhKYmlxajhXQmM4bzdaS2VyRnJlNGFMRElldFkKK3g5M1lYWDZYNjNCZDNvZ3JlR3BmeFdRU3hBYTBHUEtLa1dvaHNESWZRREYwZ0pKcjZSc0prOVVOWEZyaHJqMApUSTRzTGRMbCthdlJMSjFQQWdNQkFBR2pQekE5TUE0R0ExVWREd0VCL3dRRUF3SUZvREFkQmdOVkhTVUVGakFVCkJnZ3JCZ0VGQlFjREFRWUlLd1lCQlFVSEF3SXdEQVlEVlIwVEFRSC9CQUl3QURBTkJna3Foa2lHOXcwQkFRc0YKQUFPQ0FRRUFKZ1ErVzZlYTdKZjhldmp0cWNmRC9EZUVMYzRLcFFwdk9NR0ZGVDkzQTM4bWFzeFNxVXluOGk4RgppaEplNDZFZnFkREQvcWRWSDh4TkJId2NIcjgyVDVLcFkzTWc1amJPWG1iMEoxZEdSTFRHSmdGd0ZpUXdsM3J3CmZ4dWhlYnZvaTJkcVhQbGc3L2ZZZmVqN2RkbTAxMTdhRCtwUExCN0NNUGVLdk5QSHF2N0VBRlowOU8rRjM3cjkKNTBPZEMrSk1VK0FNczRVMzVVeEZGZjRVRHVIbWM4U0l0bTJra1U3Vk1TcDFaV1VuRVZFUExaU09SZ3dZdWFNcQo3WTgzOVpXVmtyRGZMUEJrS09Ec1BVMDI3NGdmbXBpTmNyVElYREhPY2hhcFByWG53eDhxLzcrZERYYlhoUk84ClFDK2lZWVY0MVlTSGt1djNiYUtrYXlYamV0czc3Zz09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K
 
+---
+# Source: agones/templates/tests/test-runner.yaml
+# Copyright 2020 Google LLC All Rights Reserved.
+#
+# 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.
+
+apiVersion: v1
+kind: Pod
+metadata:
+  name: "agones-manual-test"
+  namespace: agones-system
+  annotations:
+    "helm.sh/hook": test-success
+    "helm.sh/hook-delete-policy": hook-succeeded
+spec:
+  serviceAccountName: agones-controller
+  containers:
+  - name: create-gameserver
+    image: gcr.io/agones-images/crd-client:0.3
+    imagePullPolicy: Always
+    env:
+    - name: GAMESERVER_IMAGE
+      value: "gcr.io/agones-images/udp-server:0.19"
+    - name: IS_HELM_TEST
+      value: "true"
+    - name: GAMESERVERS_NAMESPACE
+      value: "default"
+  restartPolicy: Never
+
 ---
 # Source: agones/templates/controller.yaml
 # Copyright 2018 Google LLC All Rights Reserved.

site/content/en/docs/Guides/access-api.md

@@ -116,13 +116,14 @@ func main() {
 }
 ```
 In order to create GS using provided example, you can run it as a Kubernetes Job:
-```
+```bash
 $ kubectl create -f https://raw.githubusercontent.com/googleforgames/agones/{{< release-branch >}}/examples/crd-client/create-gs.yaml --namespace agones-system
 $ kubectl get pods --namespace agones-system
 NAME                                 READY   STATUS      RESTARTS   AGE
-pi-with-timeout-8qvfj                0/1     Completed   0          6s
-$ kubectl logs pi-with-timeout-8qvfj  --namespace agones-syste
-{"message":"\u0026{0xc000243e00 default}","severity":"info","source":"main","time":"2019-12-06T14:36:54.265857671Z"}
+create-gs-6wz86-7qsm5                0/1     Completed   0          6s
+$ kubectl logs create-gs-6wz86-7qsm5  --namespace agones-system
+{"message":"\u0026{0xc0001dde00 default}","severity":"info","source":"main","time":"2020-04-21T11:14:00.477576428Z"}
+{"message":"New GameServer name is: helm-test-server-fxfgg","severity":"info","time":"2020-04-21T11:14:00.516024697Z"}
 ```
 You have just created a GameServer using Kubernetes Go Client.
 

site/content/en/docs/Installation/Install Agones/helm.md

@@ -207,6 +207,28 @@ $ helm install --name my-release --namespace agones-system -f values.yaml agones
 You can use the default {{< ghlink href="install/helm/agones/values.yaml" >}}values.yaml{{< /ghlink >}}
 {{< /alert >}}
 
+{{% feature publishVersion="1.6.0" %}}
+Check the Agones installation by running the following command:
+```bash
+$ helm test my-release --cleanup                     
+RUNNING: agones-test
+PASSED: agones-test
+```
+
+This test would create a `GameServer` resource and delete it afterwards.
+
+{{< alert title="Tip" color="info">}}
+If you receive the following error:
+```
+RUNNING: agones-test
+ERROR: pods "agones-test" already exists
+Error: 1 test(s) failed
+```
+That mean that you skiped `--cleanup` flag and you should either delete `agones-test` pod manually or run with the same test `helm test my-release --cleanup` two more times.
+{{< /alert >}}
+
+{{% /feature %}}
+
 ## TLS Certificates
 
 By default agones chart generates tls certificates used by the admission controller, while this is handy, it requires the agones controller to restart on each `helm upgrade` command.