peroxide/pkg/pmapi/labels_test.go

// Copyright (c) 2022 Proton Technologies AG
//
// This file is part of ProtonMail Bridge.
//
// ProtonMail Bridge is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// ProtonMail Bridge 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 General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with ProtonMail Bridge.  If not, see <https://www.gnu.org/licenses/>.

package pmapi

import (
	"bytes"
	"context"
	"encoding/json"
	"fmt"
	"net/http"
	"reflect"
	"testing"

	r "github.com/stretchr/testify/require"
)

const testLabelsBody = `{
    "Labels": [
        {
            "ID": "LLz8ysmVxwr4dF6mWpClePT0SpSWOEvzTdq17RydSl4ndMckvY1K63HeXDzn03BJQwKYvgf-eWT8Qfd9WVuIEQ==",
            "Name": "CroutonMail is awesome :)",
            "Color": "#7272a7",
            "Display": 0,
            "Order": 1,
            "Type": 1
        },
        {
            "ID": "BvbqbySUPo9uWW_eR8tLA13NUsQMz3P4Zhw4UnpvrKqURnrHlE6L2Au0nplHfHlVXFgGz4L4hJ9-BYllOL-L5g==",
            "Name": "Royal sausage",
            "Color": "#cf5858",
            "Display": 1,
            "Order": 2,
            "Type": 1
        }
    ],
    "Code": 1000
}
`

var testLabels = []*Label{
	{ID: "LLz8ysmVxwr4dF6mWpClePT0SpSWOEvzTdq17RydSl4ndMckvY1K63HeXDzn03BJQwKYvgf-eWT8Qfd9WVuIEQ==", Name: "CroutonMail is awesome :)", Color: "#7272a7", Order: 1, Display: 0, Type: LabelTypeMailbox},
	{ID: "BvbqbySUPo9uWW_eR8tLA13NUsQMz3P4Zhw4UnpvrKqURnrHlE6L2Au0nplHfHlVXFgGz4L4hJ9-BYllOL-L5g==", Name: "Royal sausage", Color: "#cf5858", Order: 2, Display: 1, Type: LabelTypeMailbox},
}

var testLabelReq = LabelReq{&Label{
	Name:    "sava",
	Color:   "#c26cc7",
	Display: 1,
}}

const testCreateLabelBody = `{
    "Label": {
        "ID": "otkpEZzG--8dMXvwyLXLQWB72hhBhNGzINjH14rUDfywvOyeN01cDxDrS3Koifxf6asA7Xcwtldm0r_MCmWiAQ==",
        "Name": "sava",
        "Color": "#c26cc7",
        "Display": 1,
        "Order": 3,
        "Type": 1
    },
    "Code": 1000
}
`

var testLabelCreated = &Label{
	ID:      "otkpEZzG--8dMXvwyLXLQWB72hhBhNGzINjH14rUDfywvOyeN01cDxDrS3Koifxf6asA7Xcwtldm0r_MCmWiAQ==",
	Name:    "sava",
	Color:   "#c26cc7",
	Order:   3,
	Display: 1,
	Type:    LabelTypeMailbox,
}

const testDeleteLabelBody = `{
    "Code": 1000
}
`

func TestClient_ListLabels(t *testing.T) {
	s, c := newTestClient(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
		r.NoError(t, checkMethodAndPath(req, "GET", "/labels?Type=1"))

		w.Header().Set("Content-Type", "application/json")
		fmt.Fprint(w, testLabelsBody)
	}))
	defer s.Close()

	labels, err := c.ListLabels(context.Background())
	r.NoError(t, err)
	r.Equal(t, testLabels, labels)
}

func TestClient_CreateLabel(t *testing.T) {
	s, c := newTestClient(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
		r.NoError(t, checkMethodAndPath(req, "POST", "/labels"))

		body := &bytes.Buffer{}
		_, err := body.ReadFrom(req.Body)
		r.NoError(t, err)

		if bytes.Contains(body.Bytes(), []byte("Order")) {
			t.Fatal("Body contains `Order`: ", body.String())
		}

		var labelReq LabelReq
		err = json.NewDecoder(body).Decode(&labelReq)
		r.NoError(t, err)
		r.Equal(t, testLabelReq.Label, labelReq.Label)

		w.Header().Set("Content-Type", "application/json")
		fmt.Fprint(w, testCreateLabelBody)
	}))
	defer s.Close()

	created, err := c.CreateLabel(context.Background(), testLabelReq.Label)
	r.NoError(t, err)

	if !reflect.DeepEqual(created, testLabelCreated) {
		t.Fatalf("Invalid created label: expected %+v, got %+v", testLabelCreated, created)
	}
}

func TestClient_CreateEmptyLabel(t *testing.T) {
	s, c := newTestClient(http.HandlerFunc(func(_ http.ResponseWriter, _ *http.Request) {
		r.Fail(t, "API should not be called")
	}))
	defer s.Close()

	_, err := c.CreateLabel(context.Background(), &Label{})
	r.EqualError(t, err, "name is required")
}

func TestClient_UpdateLabel(t *testing.T) {
	s, c := newTestClient(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
		r.NoError(t, checkMethodAndPath(req, "PUT", "/labels/"+testLabelCreated.ID))

		var labelReq LabelReq
		err := json.NewDecoder(req.Body).Decode(&labelReq)
		r.NoError(t, err)
		r.Equal(t, testLabelCreated, labelReq.Label)

		w.Header().Set("Content-Type", "application/json")
		fmt.Fprint(w, testCreateLabelBody)
	}))
	defer s.Close()

	updated, err := c.UpdateLabel(context.Background(), testLabelCreated)
	r.NoError(t, err)

	if !reflect.DeepEqual(updated, testLabelCreated) {
		t.Fatalf("Invalid updated label: expected %+v, got %+v", testLabelCreated, updated)
	}
}

func TestClient_UpdateLabelToEmptyName(t *testing.T) {
	s, c := newTestClient(http.HandlerFunc(func(_ http.ResponseWriter, _ *http.Request) {
		r.Fail(t, "API should not be called")
	}))
	defer s.Close()

	_, err := c.UpdateLabel(context.Background(), &Label{ID: "label"})
	r.EqualError(t, err, "name is required")
}

func TestClient_DeleteLabel(t *testing.T) {
	s, c := newTestClient(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
		r.NoError(t, checkMethodAndPath(req, "DELETE", "/labels/"+testLabelCreated.ID))

		w.Header().Set("Content-Type", "application/json")
		fmt.Fprint(w, testDeleteLabelBody)
	}))
	defer s.Close()

	err := c.DeleteLabel(context.Background(), testLabelCreated.ID)
	r.NoError(t, err)
}

func TestLeastUsedColor(t *testing.T) {
	// No colors at all, should use first available color
	colors := []string{}
	r.Equal(t, "#7272a7", LeastUsedColor(colors))

	// All colors have same frequency, should use first available color
	colors = []string{"#7272a7", "#cf5858", "#c26cc7", "#7569d1", "#69a9d1", "#5ec7b7", "#72bb75", "#c3d261", "#e6c04c", "#e6984c", "#8989ac", "#cf7e7e", "#c793ca", "#9b94d1", "#a8c4d5", "#97c9c1", "#9db99f", "#c6cd97", "#e7d292", "#dfb286"}
	r.Equal(t, "#7272a7", LeastUsedColor(colors))

	// First three colors already used, but others wasn't. Should use first non-used one.
	colors = []string{"#7272a7", "#cf5858", "#c26cc7"}
	r.Equal(t, "#7569d1", LeastUsedColor(colors))
}