Add unit tests for the removeSSOSettings API method (#78476)

add unit tests for the removeSSOSettings api method
2023-11-22 15:57:12 +02:00
parent 4fd1d92332
commit f0d3e27ea7
3 changed files with 286 additions and 1 deletions
@@ -1,3 +1,149 @@
 package api

-// TODO: add tests when you implement the final version of the API endpoint
+import (
+	"errors"
+	"fmt"
+	"net/http"
+	"testing"
+
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/require"
+
+	"github.com/grafana/grafana/pkg/api/routing"
+	"github.com/grafana/grafana/pkg/infra/log"
+	"github.com/grafana/grafana/pkg/services/accesscontrol"
+	"github.com/grafana/grafana/pkg/services/accesscontrol/acimpl"
+	"github.com/grafana/grafana/pkg/services/org"
+	"github.com/grafana/grafana/pkg/services/ssosettings"
+	"github.com/grafana/grafana/pkg/services/ssosettings/ssosettingstests"
+	"github.com/grafana/grafana/pkg/services/user"
+	"github.com/grafana/grafana/pkg/setting"
+	"github.com/grafana/grafana/pkg/web/webtest"
+)
+
+func TestSSOSettingsAPI_Delete(t *testing.T) {
+	type TestCase struct {
+		desc                string
+		key                 string
+		action              string
+		scope               string
+		expectedError       error
+		expectedServiceCall bool
+		expectedStatusCode  int
+	}
+
+	tests := []TestCase{
+		{
+			desc:                "successfully deletes SSO settings",
+			key:                 "azuread",
+			action:              "settings:write",
+			scope:               "settings:auth.azuread:*",
+			expectedError:       nil,
+			expectedServiceCall: true,
+			expectedStatusCode:  http.StatusNoContent,
+		},
+		{
+			desc:                "fails when action doesn't match",
+			key:                 "azuread",
+			action:              "settings:read",
+			scope:               "settings:auth.azuread:*",
+			expectedError:       nil,
+			expectedServiceCall: false,
+			expectedStatusCode:  http.StatusForbidden,
+		},
+		{
+			desc:                "fails when scope doesn't match",
+			key:                 "azuread",
+			action:              "settings:write",
+			scope:               "settings:auth.azuread:read",
+			expectedError:       nil,
+			expectedServiceCall: false,
+			expectedStatusCode:  http.StatusForbidden,
+		},
+		{
+			desc:                "fails when scope contains another provider",
+			key:                 "azuread",
+			action:              "settings:write",
+			scope:               "settings:auth.github:*",
+			expectedError:       nil,
+			expectedServiceCall: false,
+			expectedStatusCode:  http.StatusForbidden,
+		},
+		{
+			desc:                "fails with not found when key is empty",
+			key:                 "",
+			action:              "settings:write",
+			scope:               "settings:auth.azuread:*",
+			expectedError:       nil,
+			expectedServiceCall: false,
+			expectedStatusCode:  http.StatusNotFound,
+		},
+		{
+			desc:                "fails with not found when key was not found",
+			key:                 "azuread",
+			action:              "settings:write",
+			scope:               "settings:auth.azuread:*",
+			expectedError:       ssosettings.ErrNotFound,
+			expectedServiceCall: true,
+			expectedStatusCode:  http.StatusNotFound,
+		},
+		{
+			desc:                "fails with internal server error when service returns an error",
+			key:                 "azuread",
+			action:              "settings:write",
+			scope:               "settings:auth.azuread:*",
+			expectedError:       errors.New("something went wrong"),
+			expectedServiceCall: true,
+			expectedStatusCode:  http.StatusInternalServerError,
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.desc, func(t *testing.T) {
+			service := ssosettingstests.NewMockService(t)
+			if tt.expectedServiceCall {
+				service.On("Delete", mock.Anything, tt.key).Return(tt.expectedError).Once()
+			}
+			server := setupTests(t, service)
+
+			path := fmt.Sprintf("/api/v1/sso-settings/%s", tt.key)
+			req := server.NewRequest(http.MethodDelete, path, nil)
+			webtest.RequestWithSignedInUser(req, &user.SignedInUser{
+				OrgRole:     org.RoleEditor,
+				OrgID:       1,
+				Permissions: getPermissionsForActionAndScope(tt.action, tt.scope),
+			})
+			res, err := server.SendJSON(req)
+			require.NoError(t, err)
+
+			require.Equal(t, tt.expectedStatusCode, res.StatusCode)
+			require.NoError(t, res.Body.Close())
+		})
+	}
+}
+
+func getPermissionsForActionAndScope(action, scope string) map[int64]map[string][]string {
+	return map[int64]map[string][]string{
+		1: accesscontrol.GroupScopesByAction([]accesscontrol.Permission{{
+			Action: action, Scope: scope,
+		}}),
+	}
+}
+
+func setupTests(t *testing.T, service ssosettings.Service) *webtest.Server {
+	t.Helper()
+
+	cfg := setting.NewCfg()
+	logger := log.NewNopLogger()
+
+	api := &Api{
+		Log:                logger,
+		RouteRegister:      routing.NewRouteRegister(),
+		AccessControl:      acimpl.ProvideAccessControl(cfg),
+		SSOSettingsService: service,
+	}
+
+	api.RegisterAPIEndpoints()
+
+	return webtest.NewServer(t, api.RouteRegister)
+}