Implement setFreeMonitoring stub (#759)

Closes #744.

integration/commands_freemonitoring_test.go

@@ -21,6 +21,7 @@ import (
 	"github.com/stretchr/testify/require"
 	"go.mongodb.org/mongo-driver/bson"
 	"go.mongodb.org/mongo-driver/bson/primitive"
+	"go.mongodb.org/mongo-driver/mongo"
 )
 
 func TestCommandsFreeMonitoringGetFreeMonitoringStatus(t *testing.T) {
@@ -53,3 +54,64 @@ func TestCommandsFreeMonitoringGetFreeMonitoringStatus(t *testing.T) {
 		assert.Equal(t, m[k], item)
 	}
 }
+
+func TestCommandsFreeMonitoringSetFreeMonitoring(t *testing.T) {
+	t.Parallel()
+	ctx, collection := setupWithOpts(t, &setupOpts{
+		databaseName: "admin",
+	})
+
+	for name, tc := range map[string]struct {
+		command bson.D
+		err     *mongo.CommandError
+	}{
+		"Enable": {
+			command: bson.D{{"setFreeMonitoring", 1}, {"action", "enable"}},
+			err: &mongo.CommandError{
+				Code:    50840,
+				Name:    "Location50840",
+				Message: `Free Monitoring has been disabled via the command-line and/or config file`,
+			},
+		},
+		"Disable": {
+			command: bson.D{{"setFreeMonitoring", 1}, {"action", "disable"}},
+			err: &mongo.CommandError{
+				Code:    50840,
+				Name:    "Location50840",
+				Message: `Free Monitoring has been disabled via the command-line and/or config file`,
+			},
+		},
+		"Other": {
+			command: bson.D{{"setFreeMonitoring", 1}, {"action", "foobar"}},
+			err: &mongo.CommandError{
+				Code:    2,
+				Name:    "BadValue",
+				Message: `Enumeration value 'foobar' for field 'setFreeMonitoring.action' is not a valid value.`,
+			},
+		},
+		"Empty": {
+			command: bson.D{{"setFreeMonitoring", 1}, {"action", ""}},
+			err: &mongo.CommandError{
+				Code:    2,
+				Name:    "BadValue",
+				Message: `Enumeration value '' for field 'setFreeMonitoring.action' is not a valid value.`,
+			},
+		},
+	} {
+		name, tc := name, tc
+
+		t.Run(name, func(t *testing.T) {
+			t.Parallel()
+
+			var actual bson.D
+			err := collection.Database().RunCommand(ctx, tc.command).Decode(&actual)
+
+			if tc.err != nil {
+				AssertEqualError(t, *tc.err, err)
+				return
+			}
+
+			require.NoError(t, err)
+		})
+	}
+}

internal/handlers/common/error.go

@@ -80,6 +80,10 @@ const (
 	// while projection document already marked as inclusion.
 	ErrProjectionExIn = ErrorCode(31254) // Location31254
 
+	// ErrFreeMonitoringDisabled indicates that free monitoring is disabled
+	// by command-line or config file.
+	ErrFreeMonitoringDisabled = ErrorCode(50840) // Location50840
+
 	// ErrRegexOptions indicates regex options error.
 	ErrRegexOptions = ErrorCode(51075) // Location51075
 

internal/handlers/common/msg_listcommands.go

@@ -159,6 +159,10 @@ var Commands = map[string]command{
 		Help:    "Returns an overview of the databases state.",
 		Handler: (handlers.Interface).MsgServerStatus,
 	},
+	"setFreeMonitoring": {
+		Help:    "Toggles free monitoring.",
+		Handler: (handlers.Interface).MsgSetFreeMonitoring,
+	},
 	"update": {
 		Help:    "Updates documents that are matched by the query.",
 		Handler: (handlers.Interface).MsgUpdate,

internal/handlers/common/msg_setfreemonitoring.go

@@ -0,0 +1,54 @@
+// Copyright 2021 FerretDB Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package common
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/FerretDB/FerretDB/internal/util/lazyerrors"
+	"github.com/FerretDB/FerretDB/internal/wire"
+)
+
+// MsgSetFreeMonitoring is a common implementation of the setFreeMonitoring command.
+func MsgSetFreeMonitoring(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg, error) {
+	document, err := msg.Document()
+	if err != nil {
+		return nil, lazyerrors.Error(err)
+	}
+
+	command := document.Command()
+	var action string
+	if action, err = GetRequiredParam[string](document, "action"); err != nil {
+		return nil, err
+	}
+
+	switch action {
+	case "enable", "disable":
+		return nil, NewErrorMsg(
+			ErrFreeMonitoringDisabled,
+			"Free Monitoring has been disabled via the command-line and/or config file",
+		)
+	default:
+		return nil, NewErrorMsg(
+			ErrBadValue,
+			fmt.Sprintf(
+				"Enumeration value '%s' for field '%s' is not a valid value.",
+				action,
+				command+".action",
+			),
+		)
+	}
+}

internal/handlers/dummy/msg_setfreemonitoring.go

@@ -0,0 +1,27 @@
+// Copyright 2021 FerretDB Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package dummy
+
+import (
+	"context"
+
+	"github.com/FerretDB/FerretDB/internal/handlers/common"
+	"github.com/FerretDB/FerretDB/internal/wire"
+)
+
+// MsgSetFreeMonitoring implements HandlerInterface.
+func (h *Handler) MsgSetFreeMonitoring(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg, error) {
+	return common.MsgSetFreeMonitoring(ctx, msg)
+}

internal/handlers/handlers.go

@@ -120,6 +120,9 @@ type Interface interface {
 	// MsgServerStatus returns an overview of the databases state.
 	MsgServerStatus(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg, error)
 
+	// MsgSetFreeMonitoring toggles free monitoring.
+	MsgSetFreeMonitoring(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg, error)
+
 	// MsgUpdate updates documents that are matched by the query.
 	MsgUpdate(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg, error)
 

internal/handlers/pg/msg_setfreemonitoring.go

@@ -0,0 +1,27 @@
+// Copyright 2021 FerretDB Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package pg
+
+import (
+	"context"
+
+	"github.com/FerretDB/FerretDB/internal/handlers/common"
+	"github.com/FerretDB/FerretDB/internal/wire"
+)
+
+// MsgSetFreeMonitoring implements HandlerInterface.
+func (h *Handler) MsgSetFreeMonitoring(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg, error) {
+	return common.MsgSetFreeMonitoring(ctx, msg)
+}

internal/handlers/tigris/msg_setfreemonitoring.go

@@ -0,0 +1,27 @@
+// Copyright 2021 FerretDB Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package tigris
+
+import (
+	"context"
+
+	"github.com/FerretDB/FerretDB/internal/handlers/common"
+	"github.com/FerretDB/FerretDB/internal/wire"
+)
+
+// MsgSetFreeMonitoring implements HandlerInterface.
+func (h *Handler) MsgSetFreeMonitoring(ctx context.Context, msg *wire.OpMsg) (*wire.OpMsg, error) {
+	return common.MsgSetFreeMonitoring(ctx, msg)
+}