Merge pull request #93 from grafana/paul/move-helper-apis

Migrate the implementation for pods.exec and jobs.wait to helpers

README.md

@@ -322,14 +322,14 @@ export default function () {
 
 ### (Deprecated) `Client.jobs`
 
-|  Method     |   Description | Example                             |
-| ------------ | ------ | --------------------------------------- |
-| apply         | creates the Kubernetes resource given a YAML configuration    ||
-| create         | creates the Kubernetes resource given an object configuration    | [create-job-wait.js](./examples/create-job-wait.js) |
-| delete         | removes the named Job     |  |
-| get         | returns the named Jobs     | |
-| list         | returns a collection of Jobs     |  |
-| wait         | wait for all Jobs to complete    | [wait-job.js](./examples/wait-job.js)  |
+|  Method     |   Description |
+| ------------ | ------ |
+| apply         | creates the Kubernetes resource given a YAML configuration    |
+| create         | creates the Kubernetes resource given an object configuration    |
+| delete         | removes the named Job     |
+| get         | returns the named Jobs     |
+| list         | returns a collection of Jobs     |
+| wait         | wait for all Jobs to complete    |
 
 ```javascript
 import { Kubernetes } from 'k6/x/kubernetes';

examples/job_operations.js

@@ -52,23 +52,25 @@ export default function () {
     describe('JSON-based resources', () => {
         const name = json.metadata.name
         const ns = json.metadata.namespace
+        const helpers = kubernetes.helpers(ns)
 
         let job
 
-        describe('Create our job using the JSON definition', () => {
+        describe('Create our job using the JSON definition and wait until completed', () => {
             job = kubernetes.create(json)
             expect(job.metadata, 'new job').to.have.property('uid')
-        })
 
-        describe('Retrieve all available jobs', () => {
-            expect(kubernetes.list("Job.batch", ns).length, 'total jobs').to.be.at.least(1)
-        })
+            let timeout = 10
+            expect(helpers.waitJobCompleted(name, timeout), `job completion within ${timeout}s`).to.be.true
 
-        describe('Retrieve our job by name and namespace', () => {
             let fetched = kubernetes.get("Job.batch", name, ns)
             expect(job.metadata.uid, 'created and fetched uids').to.equal(fetched.metadata.uid)
         })
 
+        describe('Retrieve all available jobs', () => {
+            expect(kubernetes.list("Job.batch", ns).length, 'total jobs').to.be.at.least(1)
+        })
+
         describe('Remove our jobs to cleanup', () => {
             kubernetes.delete("Job.batch", name, ns)
         })

examples/pod_operations.js

@@ -58,9 +58,21 @@ export default function () {
             expect(kubernetes.list("Pod", ns).length, 'total pods').to.be.at.least(1)
         })
 
-        describe('Retrieve our pod by name and namespace', () => {
+        describe('Retrieve our pod by name and namespace, then execute a command within the pod', () => {
             let fetched = kubernetes.get("Pod", name, ns)
             expect(pod.metadata.uid, 'created and fetched uids').to.equal(fetched.metadata.uid)
+
+            let greeting = 'hello xk6-kubernetes'
+            let exec = {
+                pod: name,
+                container: fetched.spec.containers[0].name,
+                command: ["echo", greeting]
+            }
+            let result = helpers.executeInPod(exec)
+            const stdout = String.fromCharCode(...result.stdout)
+            const stderr = String.fromCharCode(...result.stderr)
+            expect(stdout, 'execution result').to.contain(greeting)
+            expect(stderr, 'execution error').to.be.empty
         })
 
         describe('Remove our pods to cleanup', () => {

internal/testutils/fake.go

@@ -2,6 +2,7 @@ package testutils
 
 import (
 	"fmt"
+	k8s "k8s.io/client-go/kubernetes"
 
 	"k8s.io/apimachinery/pkg/api/meta"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -10,6 +11,11 @@ import (
 	"k8s.io/client-go/kubernetes/fake"
 )
 
+// NewFakeClientset creates a new instance of a fake Kubernetes clientset
+func NewFakeClientset(objs ...runtime.Object) k8s.Interface {
+	return fake.NewSimpleClientset(objs...)
+}
+
 // NewFakeDynamic creates a new instance of a fake dynamic client with a default scheme
 func NewFakeDynamic(objs ...runtime.Object) (*dynamicfake.FakeDynamicClient, error) {
 	scheme := runtime.NewScheme()

kubernetes.go

@@ -135,8 +135,9 @@ func (mi *ModuleInstance) newClient(c goja.ConstructorCall) *goja.Object {
 	if mi.dynamic == nil {
 		k8s, err := api.NewFromConfig(
 			api.KubernetesConfig{
-				Config:  config,
-				Context: ctx,
+				Clientset: obj.client,
+				Config:    config,
+				Context:   ctx,
 			},
 		)
 		if err != nil {
@@ -147,9 +148,10 @@ func (mi *ModuleInstance) newClient(c goja.ConstructorCall) *goja.Object {
 		// Pre-configured dynamic client and RESTMapper are injected for unit testing
 		k8s, err := api.NewFromConfig(
 			api.KubernetesConfig{
-				Client:  mi.dynamic,
-				Mapper:  mi.mapper,
-				Context: ctx,
+				Clientset: obj.client,
+				Client:    mi.dynamic,
+				Mapper:    mi.mapper,
+				Context:   ctx,
 			},
 		)
 		if err != nil {

kubernetes_test.go

@@ -15,7 +15,6 @@ import (
 	"go.k6.io/k6/lib/testutils"
 	"go.k6.io/k6/metrics"
 	"k8s.io/apimachinery/pkg/runtime"
-	"k8s.io/client-go/kubernetes/fake"
 )
 
 // setupTestEnv should be called from each test to build the execution environment for the test
@@ -49,7 +48,7 @@ func setupTestEnv(t *testing.T, objs ...runtime.Object) *goja.Runtime {
 	require.True(t, ok)
 	require.NoError(t, rt.Set("Kubernetes", m.Exports().Named["Kubernetes"]))
 
-	m.clientset = fake.NewSimpleClientset(objs...)
+	m.clientset = localutils.NewFakeClientset(objs...)
 
 	dynamic, err := localutils.NewFakeDynamic()
 	if err != nil {

pkg/api/api.go

@@ -4,6 +4,7 @@ package api
 
 import (
 	"context"
+	k8s "k8s.io/client-go/kubernetes"
 
 	"github.com/grafana/xk6-kubernetes/pkg/helpers"
 	"github.com/grafana/xk6-kubernetes/pkg/resources"
@@ -30,6 +31,8 @@ type KubernetesConfig struct {
 	Context context.Context
 	// kubernetes rest config
 	Config *rest.Config
+	// Clientset provides access to various API-specific clients
+	Clientset k8s.Interface
 	// Client is a pre-configured dynamic client. If provided, the rest config is not used
 	Client dynamic.Interface
 	// Mapper is a pre-configured RESTMapper. If provided, the rest config is not used
@@ -38,8 +41,10 @@ type KubernetesConfig struct {
 
 // kubernetes holds references to implementation of the Kubernetes interface
 type kubernetes struct {
-	ctx context.Context
+	ctx       context.Context
+	Clientset k8s.Interface
 	*resources.Client
+	Config *rest.Config
 	*restmapper.DeferredDiscoveryRESTMapper
 }
 
@@ -75,8 +80,10 @@ func NewFromConfig(c KubernetesConfig) (Kubernetes, error) {
 	}
 
 	return &kubernetes{
-		ctx:    ctx,
-		Client: client,
+		ctx:       ctx,
+		Clientset: c.Clientset,
+		Client:    client,
+		Config:    c.Config,
 	}, nil
 }
 
@@ -86,7 +93,9 @@ func (k *kubernetes) Helpers(namespace string) helpers.Helpers {
 	}
 	return helpers.NewHelper(
 		k.ctx,
+		k.Clientset,
 		k.Client,
+		k.Config,
 		namespace,
 	)
 }

pkg/helpers/helpers.go

@@ -3,27 +3,34 @@ package helpers
 
 import (
 	"context"
+	k8s "k8s.io/client-go/kubernetes"
 
 	"github.com/grafana/xk6-kubernetes/pkg/resources"
+	"k8s.io/client-go/rest"
 )
 
 // Helpers offers Helper functions grouped by the objects they handle
 type Helpers interface {
+	JobHelper
 	PodHelper
 	ServiceHelper
 }
 
 // helpers struct holds the data required by the helpers
 type helpers struct {
 	client    *resources.Client
+	clientset k8s.Interface
+	config    *rest.Config
 	ctx       context.Context
 	namespace string
 }
 
-// NewHelper creates a set of helper functions on the default namespace
-func NewHelper(ctx context.Context, client *resources.Client, namespace string) Helpers {
+// NewHelper creates a set of helper functions on the specified namespace
+func NewHelper(ctx context.Context, clientset k8s.Interface, client *resources.Client, config *rest.Config, namespace string) Helpers {
 	return &helpers{
 		client:    client,
+		clientset: clientset,
+		config:    config,
 		ctx:       ctx,
 		namespace: namespace,
 	}