Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Events in k8s module #1297

Merged
merged 2 commits into from
Jun 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions modules/k8s/event.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package k8s

import (
"context"

"github.com/stretchr/testify/require"

corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"

"github.com/gruntwork-io/terratest/modules/testing"
)

// ListEvents will retrieve the Events in the given namespace that match the given filters and return them. This will fail the
// test if there is an error.
func ListEvents(t testing.TestingT, options *KubectlOptions, filters metav1.ListOptions) []corev1.Event {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will be helpful to have tests for ListEvents to track that in the future function will continue to work

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your review @denis256 . I've done my tests with kubectl and it turns out that the events API doesn't return an error even if you provide the wrong namespace/filters.

That's why I rewrote the current tests to use the ListEvents function and also added a new test which makes sure that ListEventsE returns a nil error. What do you think?

events, err := ListEventsE(t, options, filters)
require.NoError(t, err)
return events
}

// ListEventsE will retrieve the Events that match the given filters and return them.
func ListEventsE(t testing.TestingT, options *KubectlOptions, filters metav1.ListOptions) ([]corev1.Event, error) {
clientset, err := GetKubernetesClientFromOptionsE(t, options)
if err != nil {
return nil, err
}

resp, err := clientset.CoreV1().Events(options.Namespace).List(context.Background(), filters)
if err != nil {
return nil, err
}
return resp.Items, nil
}
50 changes: 50 additions & 0 deletions modules/k8s/event_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
//go:build kubernetes
// +build kubernetes

// NOTE: we have build tags to differentiate kubernetes tests from non-kubernetes tests. This is done because minikube
// is heavy and can interfere with docker related tests in terratest. Specifically, many of the tests start to fail with
// `connection refused` errors from `minikube`. To avoid overloading the system, we run the kubernetes tests and helm
// tests separately from the others. This may not be necessary if you have a sufficiently powerful machine. We
// recommend at least 4 cores and 16GB of RAM if you want to run all the tests together.

package k8s

import (
"testing"

"github.com/stretchr/testify/require"

v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
_ "k8s.io/client-go/plugin/pkg/client/auth"
)

func TestListEventsEReturnsNilErrorWhenListingEvents(t *testing.T) {
t.Parallel()

options := NewKubectlOptions("", "", "kube-system")
events, err := ListEventsE(t, options, v1.ListOptions{})
require.Nil(t, err)
require.Greater(t, len(events), 0)
}

func TestListEventsInNamespace(t *testing.T) {
t.Parallel()

options := NewKubectlOptions("", "", "kube-system")
events := ListEvents(t, options, v1.ListOptions{})
require.Greater(t, len(events), 0)
}

func TestListEventsReturnsZeroEventsIfNoneCreated(t *testing.T) {
t.Parallel()
ns := "test-ns"

options := NewKubectlOptions("", "", "")

defer DeleteNamespace(t, options, ns)
CreateNamespace(t, options, ns)

options.Namespace = ns
events := ListEvents(t, options, v1.ListOptions{})
require.Equal(t, 0, len(events))
}