How to Use Fake Clients for Unit Testing Kubernetes-Integrated Code?

Unit Testing with Fake Client for Kubernetes

When writing tests for code that interacts with Kubernetes, it's beneficial to isolate the test environment from the actual cluster. This can be achieved by leveraging fake clients, which simulate the behavior of Kubernetes API without requiring a live cluster.

Problem

Consider the following method:

<code class="go">import (
  "fmt"
  "k8s.io/api/core/v1"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  fake "k8s.io/client-go/kubernetes/fake"
  "time"
)

func GetNamespaceCreationTime(namespace string) int64 {
  clientset, err := kubernetes.NewForConfig(rest.InClusterConfig())
  if err != nil {
    panic(err.Error())
  }
  
  ns, err := clientset.CoreV1().Namespaces().Get(namespace, metav1.GetOptions{})
  if err != nil {
    panic(err.Error())
  }
  
  fmt.Printf("%v \n", ns.CreationTimestamp)
  return (ns.GetCreationTimestamp().Unix())
}</code>

The goal is to write a unit test for this method using a fake client.

Solution

To use a fake client, we need to modify the GetNamespaceCreationTime function to accept a kubernetes.Interface as a parameter:

<code class="go">func GetNamespaceCreationTime(kubeClient kubernetes.Interface, namespace string) int64 {
  ns, err := kubeClient.CoreV1().Namespaces().Get(namespace, metav1.GetOptions{})
  if err != nil {
    panic(err.Error())
  }
  
  fmt.Printf("%v \n", ns.CreationTimestamp)
  return (ns.GetCreationTimestamp().Unix())
}</code>

In our test function, we can create a fake clientset and pass it to the GetNamespaceCreationTime method as follows:

<code class="go">func TestGetNamespaceCreationTime(t *testing.T) {
  kubeClient := fake.NewSimpleClientset()
  got := GetNamespaceCreationTime(kubeClient, "default")
  want := int64(1257894000)

  nsMock :=kubeClient.CoreV1().Namespaces()
  nsMock.Create(&v1.Namespace{
    ObjectMeta: metav1.ObjectMeta{
      Name:              "default",
      CreationTimestamp: metav1.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC),
    },
  })

  if got != want {
    t.Errorf("got %q want %q", got, want)
  }
}</code>

Complete Test with In-Cluster Configuration Stubbing

The complete test with stubbing for in-cluster configuration could look like:

<code class="go">import (
  "fmt"
  "k8s.io/api/core/v1"
  metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  fake "k8s.io/client-go/kubernetes/fake"
  "k8s.io/client-go/kubernetes"
  "k8s.io/client-go/rest"
  "time"
)

var getInclusterConfigFunc = rest.InClusterConfig
var getNewKubeClientFunc = dynamic.NewForConfig

func GetNamespaceCreationTime(kubeClient kubernetes.Interface, namespace string) int64 {

  ns, err := kubeClient.CoreV1().Namespaces().Get(namespace, metav1.GetOptions{})
  if err != nil {
    panic(err.Error())
  }

  fmt.Printf("%v \n", ns.CreationTimestamp)
  return (ns.GetCreationTimestamp().Unix())
}

func GetClientSet() kubernetes.Interface {

  config, err := getInclusterConfigFunc()
  if err != nil {
    log.Warnf("Could not get in-cluster config: %s", err)
    return nil, err
  }

  client, err := getNewKubeClientFunc(config)
  if err != nil {
    log.Warnf("Could not connect to in-cluster API server: %s", err)
    return nil, err
  }

  return client, err
}

func TestGetNamespaceCreationTime(t *testing.T) {
  kubeClient := fake.NewSimpleClientset()
  got := GetNamespaceCreationTime(kubeClient, "default")
  want := int64(1257894000)

  nsMock :=kubeClient.CoreV1().Namespaces()
  nsMock.Create(&v1.Namespace{
    ObjectMeta: metav1.ObjectMeta{
      Name:              "default",
      CreationTimestamp: metav1.Date(2009, time.November, 10, 23, 0, 0, 0, time.UTC),
    },
  })

  if got != want {
    t.Errorf("got %q want %q", got, want)
  }
}

func fakeGetInclusterConfig() (*rest.Config, error) {
  return nil, nil
}

func fakeGetInclusterConfigWithError() (*rest.Config, error) {
  return nil, errors.New("fake error getting in-cluster config")
}

func TestGetInclusterKubeClient(t *testing.T) {
  origGetInclusterConfig := getInclusterConfigFunc
  getInclusterConfigFunc = fakeGetInclusterConfig
  origGetNewKubeClient := getNewKubeClientFunc
  getNewKubeClientFunc = fakeGetNewKubeClient

  defer func() {
    getInclusterConfigFunc = origGetInclusterConfig
    getNewKubeClientFunc = origGetNewKubeClient
  }()

  client, err := GetClientSet()
  assert.Nil(t, client, "Client is not nil")
  assert.Nil(t, err, "error is not nil")
}

func TestGetInclusterKubeClient_ConfigError(t *testing.T) {
  origGetInclusterConfig := getInclusterConfigFunc
  getInclusterConfigFunc = fakeGetInclusterConfigWithError

  defer func() {
    getInclusterConfigFunc = origGetInclusterConfig
  }()

  client, err := GetClientSet()
  assert.Nil(t, client, "Client is not nil")
  assert.NotNil(t, err, "error is nil")
}</code>

The above is the detailed content of How to Use Fake Clients for Unit Testing Kubernetes-Integrated Code?. For more information, please follow other related articles on the PHP Chinese website!