Revert "Removed Tools support (minio#3467)"

This reverts commit 18e5097.

Author: Karotte128

api/admin_health_info.go

@@ -0,0 +1,153 @@
+// This file is part of MinIO Console Server
+// Copyright (c) 2021 MinIO, Inc.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package api
+
+import (
+	"context"
+	b64 "encoding/base64"
+	"encoding/json"
+	"errors"
+	"fmt"
+	"net/http"
+	"net/url"
+	"os"
+	"time"
+
+	"github.com/minio/console/pkg/logger"
+	"github.com/minio/console/pkg/utils"
+
+	subnet "github.com/minio/console/pkg/subnet"
+	mc "github.com/minio/mc/cmd"
+	"github.com/minio/websocket"
+)
+
+// startHealthInfo starts fetching mc.ServerHealthInfo and
+// sends messages with the corresponding data on the websocket connection
+func startHealthInfo(ctx context.Context, conn WSConn, client MinioAdmin, deadline *time.Duration) error {
+	if deadline == nil {
+		return errors.New("duration can't be nil on startHealthInfo")
+	}
+
+	// Fetch info of all servers (cluster or single server)
+	healthInfo, version, err := client.serverHealthInfo(ctx, *deadline)
+	if err != nil {
+		return err
+	}
+
+	compressedDiag, err := mc.TarGZHealthInfo(healthInfo, version)
+	if err != nil {
+		return err
+	}
+	encodedDiag := b64.StdEncoding.EncodeToString(compressedDiag)
+	type messageReport struct {
+		Encoded          string      `json:"encoded"`
+		ServerHealthInfo interface{} `json:"serverHealthInfo"`
+		SubnetResponse   string      `json:"subnetResponse"`
+	}
+
+	ctx = context.WithValue(ctx, utils.ContextClientIP, conn.remoteAddress())
+	err = sendHealthInfoToSubnet(ctx, compressedDiag, client)
+	report := messageReport{
+		Encoded:          encodedDiag,
+		ServerHealthInfo: healthInfo,
+		SubnetResponse:   mc.SubnetBaseURL() + "/health",
+	}
+	if err != nil {
+		report.SubnetResponse = fmt.Sprintf("Error: %s", err.Error())
+	}
+
+	message, err := json.Marshal(report)
+	if err != nil {
+		return err
+	}
+
+	// Send Message through websocket connection
+	return conn.writeMessage(websocket.TextMessage, message)
+}
+
+// getHealthInfoOptionsFromReq gets duration for startHealthInfo request
+// path come as : `/health-info?deadline=2h`
+func getHealthInfoOptionsFromReq(req *http.Request) (*time.Duration, error) {
+	deadlineDuration, err := time.ParseDuration(req.FormValue("deadline"))
+	if err != nil {
+		return nil, err
+	}
+	return &deadlineDuration, nil
+}
+
+func updateMcGlobals(subnetTokenConfig subnet.LicenseTokenConfig) error {
+	mc.GlobalDevMode = getConsoleDevMode()
+	if len(subnetTokenConfig.Proxy) > 0 {
+		proxyURL, e := url.Parse(subnetTokenConfig.Proxy)
+		if e != nil {
+			return e
+		}
+		mc.GlobalSubnetProxyURL = proxyURL
+	}
+	return nil
+}
+
+func sendHealthInfoToSubnet(ctx context.Context, compressedHealthInfo []byte, client MinioAdmin) error {
+	filename := fmt.Sprintf("health_%d.json.gz", time.Now().Unix())
+	subnetTokenConfig, e := GetSubnetKeyFromMinIOConfig(ctx, client)
+	if e != nil {
+		return e
+	}
+	e = updateMcGlobals(*subnetTokenConfig)
+	if e != nil {
+		return e
+	}
+	var apiKey string
+	if len(subnetTokenConfig.APIKey) != 0 {
+		apiKey = subnetTokenConfig.APIKey
+	} else {
+		apiKey, e = subnet.GetSubnetAPIKeyUsingLicense(subnetTokenConfig.License)
+		if e != nil {
+			return e
+		}
+	}
+	e = os.WriteFile(filename, compressedHealthInfo, 0o666)
+	if e != nil {
+		return e
+	}
+	headers := mc.SubnetAPIKeyAuthHeaders(apiKey)
+	resp, e := (&mc.SubnetFileUploader{
+		FilePath:          filename,
+		ReqURL:            mc.SubnetUploadURL("health"),
+		Headers:           headers,
+		DeleteAfterUpload: true,
+	}).UploadFileToSubnet()
+	if e != nil {
+		// file gets deleted only if upload is successful
+		// so we delete explicitly here as we already have the bytes
+		logger.LogIf(ctx, os.Remove(filename))
+		return e
+	}
+
+	type SubnetResponse struct {
+		LicenseV2 string `json:"license_v2,omitempty"`
+		APIKey    string `json:"api_key,omitempty"`
+	}
+
+	var subnetResp SubnetResponse
+	e = json.Unmarshal([]byte(resp), &subnetResp)
+	if e != nil {
+		return e
+	}
+
+	return nil
+}

api/admin_health_info_test.go

@@ -0,0 +1,147 @@
+// This file is part of MinIO Console Server
+// Copyright (c) 2021 MinIO, Inc.
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+package api
+
+import (
+	"context"
+	"encoding/json"
+	"errors"
+	"reflect"
+	"testing"
+	"time"
+
+	madmin "github.com/minio/madmin-go/v3"
+)
+
+func Test_serverHealthInfo(t *testing.T) {
+	var testReceiver chan madmin.HealthInfo
+
+	ctx, cancel := context.WithCancel(context.Background())
+	defer cancel()
+	client := AdminClientMock{}
+	mockWSConn := mockConn{}
+	deadlineDuration, _ := time.ParseDuration("1h")
+
+	type args struct {
+		deadline     time.Duration
+		wsWriteMock  func(messageType int, data []byte) error
+		mockMessages []madmin.HealthInfo
+	}
+	tests := []struct {
+		test      string
+		args      args
+		wantError error
+	}{
+		{
+			test: "Return simple health info, no errors",
+			args: args{
+				deadline:     deadlineDuration,
+				mockMessages: []madmin.HealthInfo{{}, {}},
+				wsWriteMock: func(_ int, data []byte) error {
+					// mock connection WriteMessage() no error
+					// emulate that receiver gets the message written
+					var t madmin.HealthInfo
+					_ = json.Unmarshal(data, &t)
+					testReceiver <- t
+					return nil
+				},
+			},
+			wantError: nil,
+		},
+		{
+			test: "Return simple health info2, no errors",
+			args: args{
+				deadline:     deadlineDuration,
+				mockMessages: []madmin.HealthInfo{{}},
+				wsWriteMock: func(_ int, data []byte) error {
+					// mock connection WriteMessage() no error
+					// emulate that receiver gets the message written
+					var t madmin.HealthInfo
+					_ = json.Unmarshal(data, &t)
+					testReceiver <- t
+					return nil
+				},
+			},
+			wantError: nil,
+		},
+		{
+			test: "Handle error on ws write",
+			args: args{
+				deadline:     deadlineDuration,
+				mockMessages: []madmin.HealthInfo{{}},
+				wsWriteMock: func(_ int, data []byte) error {
+					// mock connection WriteMessage() no error
+					// emulate that receiver gets the message written
+					var t madmin.HealthInfo
+					_ = json.Unmarshal(data, &t)
+					return errors.New("error on write")
+				},
+			},
+			wantError: errors.New("error on write"),
+		},
+		{
+			test: "Handle error on health function",
+			args: args{
+				deadline: deadlineDuration,
+				mockMessages: []madmin.HealthInfo{
+					{
+						Error: "error on healthInfo",
+					},
+				},
+				wsWriteMock: func(_ int, data []byte) error {
+					// mock connection WriteMessage() no error
+					// emulate that receiver gets the message written
+					var t madmin.HealthInfo
+					_ = json.Unmarshal(data, &t)
+					return nil
+				},
+			},
+			wantError: nil,
+		},
+	}
+	for _, tt := range tests {
+		tt := tt
+		t.Run(tt.test, func(_ *testing.T) {
+			// make testReceiver channel
+			testReceiver = make(chan madmin.HealthInfo, len(tt.args.mockMessages))
+			// mock function same for all tests, changes mockMessages
+			minioServerHealthInfoMock = func(_ context.Context,
+				_ time.Duration,
+			) (interface{}, string, error) {
+				info := tt.args.mockMessages[0]
+				return info, madmin.HealthInfoVersion, nil
+			}
+			connWriteMessageMock = tt.args.wsWriteMock
+			err := startHealthInfo(ctx, mockWSConn, client, &deadlineDuration)
+			// close test mock channel
+			close(testReceiver)
+			// check that the TestReceiver got the same number of data from Console.
+			index := 0
+			for info := range testReceiver {
+				if !reflect.DeepEqual(info, tt.args.mockMessages[index]) {
+					t.Errorf("startHealthInfo() got: %v, want: %v", info, tt.args.mockMessages[index])
+					return
+				}
+				index++
+			}
+			if !reflect.DeepEqual(err, tt.wantError) {
+				t.Errorf("startHealthInfo() error: %v, wantError: %v", err, tt.wantError)
+				return
+			}
+		})
+	}
+}