datasources: apiserver: do not enable extra methods by default (#113395)

pkg/registry/apis/datasource/sub_health.go

@@ -10,6 +10,8 @@ import (
 	"k8s.io/apiserver/pkg/registry/rest"
 
 	datasource "github.com/grafana/grafana/pkg/apis/datasource/v0alpha1"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
 type subHealthREST struct {
@@ -44,7 +46,19 @@ func (r *subHealthREST) NewConnectOptions() (runtime.Object, bool, string) {
 	return nil, false, ""
 }
 
+// FIXME: this endpoint has not been tested yet, so it is not enabled by default.
+var healthEnabled = false
+
 func (r *subHealthREST) Connect(ctx context.Context, name string, opts runtime.Object, responder rest.Responder) (http.Handler, error) {
+	if !healthEnabled {
+		return nil, &apierrors.StatusError{
+			ErrStatus: metav1.Status{
+				Status: metav1.StatusFailure,
+				Code:   http.StatusNotImplemented,
+			},
+		}
+	}
+
 	pluginCtx, err := r.builder.getPluginContext(ctx, name)
 	if err != nil {
 		return nil, err

pkg/registry/apis/datasource/sub_resource.go

@@ -8,6 +8,7 @@ import (
 	"net/url"
 	"strings"
 
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 	"k8s.io/apiserver/pkg/registry/rest"
@@ -46,7 +47,21 @@ func (r *subResourceREST) NewConnectOptions() (runtime.Object, bool, string) {
 	return nil, true, ""
 }
 
+// FIXME: this endpoint has not been tested yet, so it is not enabled by default.
+// It is especially important to make sure the `ClearAuthHeadersMiddleware` is active,
+// when using this endpoint.
+var resourceEnabled = false
+
 func (r *subResourceREST) Connect(ctx context.Context, name string, opts runtime.Object, responder rest.Responder) (http.Handler, error) {
+	if !resourceEnabled {
+		return nil, &apierrors.StatusError{
+			ErrStatus: metav1.Status{
+				Status: metav1.StatusFailure,
+				Code:   http.StatusNotImplemented,
+			},
+		}
+	}
+
 	pluginCtx, err := r.builder.getPluginContext(ctx, name)
 	if err != nil {
 		return nil, err

pkg/tests/apis/datasource/testdata_test.go

@@ -3,10 +3,12 @@ package dashboards
 import (
 	"context"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"testing"
 
 	"github.com/stretchr/testify/require"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
 	"k8s.io/apimachinery/pkg/runtime/schema"
@@ -101,19 +103,26 @@ func TestIntegrationTestDatasource(t *testing.T) {
 		require.Len(t, list.Items, 1, "expected a single connection")
 		require.Equal(t, "test", list.Items[0].GetName(), "with the test uid")
 
-		rsp, err := client.Get(ctx, "test", metav1.GetOptions{}, "health")
-		require.NoError(t, err)
-		body, err := rsp.MarshalJSON()
-		require.NoError(t, err)
-		//fmt.Printf("GOT: %v\n", string(body))
-		require.JSONEq(t, `{
-			"apiVersion": "testdata.datasource.grafana.app/v0alpha1",
-			"code": 1,
-			"kind": "HealthCheckResult",
-			"message": "Data source is working",
-			"status": "OK"
-		  }
-		`, string(body))
+		_, err = client.Get(ctx, "test", metav1.GetOptions{}, "health")
+		// endpoint is disabled currently because it has not been
+		// sufficiently tested.
+		// for more info see pkg/registry/apis/datasource/sub_health.go
+		require.Error(t, err)
+		var statusErr *apierrors.StatusError
+		require.True(t, errors.As(err, &statusErr))
+		require.Equal(t, int32(501), statusErr.ErrStatus.Code)
+		// require.NoError(t, err)
+		// body, err := rsp.MarshalJSON()
+		// require.NoError(t, err)
+		// //fmt.Printf("GOT: %v\n", string(body))
+		// require.JSONEq(t, `{
+		// 	"apiVersion": "testdata.datasource.grafana.app/v0alpha1",
+		// 	"code": 1,
+		// 	"kind": "HealthCheckResult",
+		// 	"message": "Data source is working",
+		// 	"status": "OK"
+		//   }
+		// `, string(body))
 
 		// Test connecting to non-JSON marshaled data
 		raw := apis.DoRequest[any](helper, apis.RequestParams{
@@ -121,6 +130,10 @@ func TestIntegrationTestDatasource(t *testing.T) {
 			Method: "GET",
 			Path:   "/apis/testdata.datasource.grafana.app/v0alpha1/namespaces/default/datasources/test/resource",
 		}, nil)
-		require.Equal(t, `Hello world from test datasource!`, string(raw.Body))
+		// endpoint is disabled currently because it has not been
+		// sufficiently tested.
+		// for more info see pkg/registry/apis/datasource/sub_resource.go
+		require.Equal(t, int32(501), raw.Status.Code)
+		// require.Equal(t, `Hello world from test datasource!`, string(raw.Body))
 	})
 }