GoToSocial/internal/db/bundb/filterkeyword_test.go

// GoToSocial
// Copyright (C) GoToSocial Authors admin@gotosocial.org
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// 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 bundb_test

import (
	"context"
	"errors"

	"github.com/superseriousbusiness/gotosocial/internal/db"
	"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
	"github.com/superseriousbusiness/gotosocial/internal/util"
)

// TestFilterKeywordCRUD tests CRUD and read-all operations on filter keywords.
func (suite *FilterTestSuite) TestFilterKeywordCRUD() {
	t := suite.T()

	// Create new filter.
	filter := &gtsmodel.Filter{
		ID:            "01HNEJNVZZVXJTRB3FX3K2B1YF",
		AccountID:     "01HNEJXCPRTJVJY9MV0VVHGD47",
		Title:         "foss jail",
		Action:        gtsmodel.FilterActionWarn,
		ContextHome:   util.Ptr(true),
		ContextPublic: util.Ptr(true),
	}

	// Create new cancellable test context.
	ctx := context.Background()
	ctx, cncl := context.WithCancel(ctx)
	defer cncl()

	// Insert the new filter into the DB.
	err := suite.db.PutFilter(ctx, filter)
	if err != nil {
		t.Fatalf("error inserting filter: %v", err)
	}

	// There should be no filter keywords yet.
	all, err := suite.db.GetFilterKeywordsForAccountID(ctx, filter.AccountID)
	if err != nil {
		t.Fatalf("error fetching filter keywords: %v", err)
	}
	suite.Empty(all)

	// Add a filter keyword to it.
	filterKeyword := &gtsmodel.FilterKeyword{
		ID:        "01HNEK4RW5QEAMG9Y4ET6ST0J4",
		AccountID: filter.AccountID,
		FilterID:  filter.ID,
		Keyword:   "GNU/Linux",
	}

	// Insert the new filter keyword into the DB.
	err = suite.db.PutFilterKeyword(ctx, filterKeyword)
	if err != nil {
		t.Fatalf("error inserting filter keyword: %v", err)
	}

	// Try to find it again and ensure it has the fields we expect.
	check, err := suite.db.GetFilterKeywordByID(ctx, filterKeyword.ID)
	if err != nil {
		t.Fatalf("error fetching filter keyword: %v", err)
	}
	suite.Equal(filterKeyword.ID, check.ID)
	suite.NotZero(check.CreatedAt)
	suite.NotZero(check.UpdatedAt)
	suite.Equal(filterKeyword.AccountID, check.AccountID)
	suite.Equal(filterKeyword.FilterID, check.FilterID)
	suite.Equal(filterKeyword.Keyword, check.Keyword)
	suite.Equal(filterKeyword.WholeWord, check.WholeWord)

	// Loading filter keywords by account ID should find the one we inserted.
	all, err = suite.db.GetFilterKeywordsForAccountID(ctx, filter.AccountID)
	if err != nil {
		t.Fatalf("error fetching filter keywords: %v", err)
	}
	suite.Len(all, 1)
	suite.Equal(filterKeyword.ID, all[0].ID)

	// Loading filter keywords by filter ID should also find the one we inserted.
	all, err = suite.db.GetFilterKeywordsForFilterID(ctx, filter.ID)
	if err != nil {
		t.Fatalf("error fetching filter keywords: %v", err)
	}
	suite.Len(all, 1)
	suite.Equal(filterKeyword.ID, all[0].ID)

	// Modify the filter keyword.
	filterKeyword.WholeWord = util.Ptr(true)
	err = suite.db.UpdateFilterKeyword(ctx, filterKeyword)
	if err != nil {
		t.Fatalf("error updating filter keyword: %v", err)
	}

	// Try to find it again and ensure it has the updated fields we expect.
	check, err = suite.db.GetFilterKeywordByID(ctx, filterKeyword.ID)
	if err != nil {
		t.Fatalf("error fetching filter keyword: %v", err)
	}
	suite.Equal(filterKeyword.ID, check.ID)
	suite.NotZero(check.CreatedAt)
	suite.True(check.UpdatedAt.After(check.CreatedAt))
	suite.Equal(filterKeyword.AccountID, check.AccountID)
	suite.Equal(filterKeyword.FilterID, check.FilterID)
	suite.Equal(filterKeyword.Keyword, check.Keyword)
	suite.Equal(filterKeyword.WholeWord, check.WholeWord)

	// Delete the filter keyword from the DB.
	err = suite.db.DeleteFilterKeywordByID(ctx, filter.ID)
	if err != nil {
		t.Fatalf("error deleting filter keyword: %v", err)
	}

	// Ensure we can't refetch it.
	check, err = suite.db.GetFilterKeywordByID(ctx, filter.ID)
	if !errors.Is(err, db.ErrNoEntries) {
		t.Fatalf("fetching deleted filter keyword returned unexpected error: %v", err)
	}
	suite.Nil(check)

	// Ensure the filter itself is still there.
	checkFilter, err := suite.db.GetFilterByID(ctx, filter.ID)
	if err != nil {
		t.Fatalf("error fetching filter: %v", err)
	}
	suite.Equal(filter.ID, checkFilter.ID)
}