Skip to content

Commit

Permalink
[API Gateway] Add stub acceptance test
Browse files Browse the repository at this point in the history
  • Loading branch information
Andrew Stucki committed May 26, 2023
1 parent eac1df8 commit 583d51e
Show file tree
Hide file tree
Showing 2 changed files with 101 additions and 0 deletions.
64 changes: 64 additions & 0 deletions acceptance/tests/api-gateway/example_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

// Rename package to your test package.
package example

import (
"context"
"testing"

"github.com/hashicorp/consul-k8s/acceptance/framework/consul"
"github.com/hashicorp/consul-k8s/acceptance/framework/helpers"
"github.com/hashicorp/consul-k8s/acceptance/framework/k8s"
"github.com/stretchr/testify/require"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func TestExample(t *testing.T) {
// Get test configuration.
cfg := suite.Config()

// Get the default context.
ctx := suite.Environment().DefaultContext(t)

// Create Helm values for the Helm install.
helmValues := map[string]string{
"exampleFeature.enabled": "true",
}

// Generate a random name for this test.
releaseName := helpers.RandomName()

// Create a new Consul cluster object.
consulCluster := consul.NewHelmCluster(t, helmValues, ctx, cfg, releaseName)

// Create the Consul cluster with Helm.
consulCluster.Create(t)

// Make test assertions.

// To run kubectl commands, you need to get KubectlOptions from the test context.
// There are a number of kubectl commands available in the helpers/kubectl.go file.
// For example, to call 'kubectl apply' from the test write the following:
k8s.KubectlApply(t, ctx.KubectlOptions(t), "path/to/config")

// Clean up any Kubernetes resources you have created
helpers.Cleanup(t, cfg.NoCleanupOnFailure, func() {
k8s.KubectlDelete(t, ctx.KubectlOptions(t), "path/to/config")
})

// Similarly, you can obtain Kubernetes client from your test context.
// You can use it to, for example, read all services in a namespace:
k8sClient := ctx.KubernetesClient(t)
services, err := k8sClient.CoreV1().Services(ctx.KubectlOptions(t).Namespace).List(context.Background(), metav1.ListOptions{})
require.NoError(t, err)
require.NotNil(t, services.Items)

// To make Consul API calls, you can get the Consul client from the consulCluster object,
// indicating whether the client needs to be secure or not (i.e. whether TLS and ACLs are enabled on the Consul cluster):
consulClient, _ := consulCluster.SetupConsulClient(t, true)
consulServices, _, err := consulClient.Catalog().Services(nil)
require.NoError(t, err)
require.NotNil(t, consulServices)
}
37 changes: 37 additions & 0 deletions acceptance/tests/api-gateway/main_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

// Rename package to your test package.
package example

import (
"testing"

testsuite "github.com/hashicorp/consul-k8s/acceptance/framework/suite"
)

var suite testsuite.Suite

func TestMain(m *testing.M) {
// First, uncomment the line below to create a new suite so that all flags are parsed.
/*
suite = framework.NewSuite(m)
*/

// If the test suite needs to run only when certain test flags are passed,
// you need to handle that in the TestMain function.
// Uncomment and modify example code below if that is the case.
/*
if suite.Config().EnableExampleFeature {
os.Exit(suite.Run())
} else {
fmt.Println("Skipping example feature tests because -enable-example-feature is not set")
os.Exit(0)
}
*/

// If the test suite should run in every case, uncomment the line below.
/*
os.Exit(suite.Run())
*/
}

0 comments on commit 583d51e

Please sign in to comment.