mirror of
https://github.com/superseriousbusiness/gotosocial.git
synced 2025-11-04 00:42:24 -06:00
5e2bf0bdca* [chore] Remove years from all license headers Years or year ranges aren't required in license headers. Many projects have removed them in recent years and it avoids a bit of yearly toil. In many cases our copyright claim was also a bit dodgy since we added the 2021-2023 header to files created after 2021 but you can't claim copyright into the past that way. * [chore] Add license header check This ensures a license header is always added to any new file. This avoids maintainers/reviewers needing to remember to check for and ask for it in case a contribution doesn't include it. * [chore] Add missing license headers * [chore] Further updates to license header * Use the more common // indentend comment format * Remove the hack we had for the linter now that we use the // format * Add SPDX license identifier
384 lines
14 KiB
Go
384 lines
14 KiB
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 media_test
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"crypto/rand"
|
|
"encoding/base64"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/suite"
|
|
mediamodule "github.com/superseriousbusiness/gotosocial/internal/api/client/media"
|
|
apimodel "github.com/superseriousbusiness/gotosocial/internal/api/model"
|
|
"github.com/superseriousbusiness/gotosocial/internal/config"
|
|
"github.com/superseriousbusiness/gotosocial/internal/db"
|
|
"github.com/superseriousbusiness/gotosocial/internal/email"
|
|
"github.com/superseriousbusiness/gotosocial/internal/federation"
|
|
"github.com/superseriousbusiness/gotosocial/internal/gtsmodel"
|
|
"github.com/superseriousbusiness/gotosocial/internal/log"
|
|
"github.com/superseriousbusiness/gotosocial/internal/media"
|
|
"github.com/superseriousbusiness/gotosocial/internal/oauth"
|
|
"github.com/superseriousbusiness/gotosocial/internal/processing"
|
|
"github.com/superseriousbusiness/gotosocial/internal/state"
|
|
"github.com/superseriousbusiness/gotosocial/internal/storage"
|
|
"github.com/superseriousbusiness/gotosocial/internal/typeutils"
|
|
"github.com/superseriousbusiness/gotosocial/testrig"
|
|
)
|
|
|
|
type MediaCreateTestSuite struct {
|
|
// standard suite interfaces
|
|
suite.Suite
|
|
db db.DB
|
|
storage *storage.Driver
|
|
mediaManager media.Manager
|
|
federator federation.Federator
|
|
tc typeutils.TypeConverter
|
|
oauthServer oauth.Server
|
|
emailSender email.Sender
|
|
processor *processing.Processor
|
|
state state.State
|
|
|
|
// standard suite models
|
|
testTokens map[string]*gtsmodel.Token
|
|
testClients map[string]*gtsmodel.Client
|
|
testApplications map[string]*gtsmodel.Application
|
|
testUsers map[string]*gtsmodel.User
|
|
testAccounts map[string]*gtsmodel.Account
|
|
testAttachments map[string]*gtsmodel.MediaAttachment
|
|
|
|
// item being tested
|
|
mediaModule *mediamodule.Module
|
|
}
|
|
|
|
/*
|
|
TEST INFRASTRUCTURE
|
|
*/
|
|
|
|
func (suite *MediaCreateTestSuite) SetupSuite() {
|
|
suite.state.Caches.Init()
|
|
testrig.StartWorkers(&suite.state)
|
|
|
|
// setup standard items
|
|
testrig.InitTestConfig()
|
|
testrig.InitTestLog()
|
|
|
|
suite.db = testrig.NewTestDB(&suite.state)
|
|
suite.state.DB = suite.db
|
|
suite.storage = testrig.NewInMemoryStorage()
|
|
suite.state.Storage = suite.storage
|
|
|
|
suite.tc = testrig.NewTestTypeConverter(suite.db)
|
|
suite.mediaManager = testrig.NewTestMediaManager(&suite.state)
|
|
suite.oauthServer = testrig.NewTestOauthServer(suite.db)
|
|
suite.federator = testrig.NewTestFederator(&suite.state, testrig.NewTestTransportController(&suite.state, testrig.NewMockHTTPClient(nil, "../../../../testrig/media")), suite.mediaManager)
|
|
suite.emailSender = testrig.NewEmailSender("../../../../web/template/", nil)
|
|
suite.processor = testrig.NewTestProcessor(&suite.state, suite.federator, suite.emailSender, suite.mediaManager)
|
|
|
|
// setup module being tested
|
|
suite.mediaModule = mediamodule.New(suite.processor)
|
|
}
|
|
|
|
func (suite *MediaCreateTestSuite) TearDownSuite() {
|
|
if err := suite.db.Stop(context.Background()); err != nil {
|
|
log.Panicf(nil, "error closing db connection: %s", err)
|
|
}
|
|
testrig.StopWorkers(&suite.state)
|
|
}
|
|
|
|
func (suite *MediaCreateTestSuite) SetupTest() {
|
|
suite.state.Caches.Init()
|
|
|
|
testrig.StandardDBSetup(suite.db, nil)
|
|
testrig.StandardStorageSetup(suite.storage, "../../../../testrig/media")
|
|
|
|
suite.testTokens = testrig.NewTestTokens()
|
|
suite.testClients = testrig.NewTestClients()
|
|
suite.testApplications = testrig.NewTestApplications()
|
|
suite.testUsers = testrig.NewTestUsers()
|
|
suite.testAccounts = testrig.NewTestAccounts()
|
|
suite.testAttachments = testrig.NewTestAttachments()
|
|
}
|
|
|
|
func (suite *MediaCreateTestSuite) TearDownTest() {
|
|
testrig.StandardDBTeardown(suite.db)
|
|
testrig.StandardStorageTeardown(suite.storage)
|
|
}
|
|
|
|
/*
|
|
ACTUAL TESTS
|
|
*/
|
|
|
|
func (suite *MediaCreateTestSuite) TestMediaCreateSuccessful() {
|
|
// set up the context for the request
|
|
t := suite.testTokens["local_account_1"]
|
|
oauthToken := oauth.DBTokenToToken(t)
|
|
recorder := httptest.NewRecorder()
|
|
ctx, _ := testrig.CreateGinTestContext(recorder, nil)
|
|
ctx.Set(oauth.SessionAuthorizedApplication, suite.testApplications["application_1"])
|
|
ctx.Set(oauth.SessionAuthorizedToken, oauthToken)
|
|
ctx.Set(oauth.SessionAuthorizedUser, suite.testUsers["local_account_1"])
|
|
ctx.Set(oauth.SessionAuthorizedAccount, suite.testAccounts["local_account_1"])
|
|
|
|
// see what's in storage *before* the request
|
|
var storageKeysBeforeRequest []string
|
|
if err := suite.storage.WalkKeys(ctx, func(ctx context.Context, key string) error {
|
|
storageKeysBeforeRequest = append(storageKeysBeforeRequest, key)
|
|
return nil
|
|
}); err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
// create the request
|
|
buf, w, err := testrig.CreateMultipartFormData("file", "../../../../testrig/media/test-jpeg.jpg", map[string]string{
|
|
"description": "this is a test image -- a cool background from somewhere",
|
|
"focus": "-0.5,0.5",
|
|
})
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
ctx.Request = httptest.NewRequest(http.MethodPost, "http://localhost:8080/api/v1/media", bytes.NewReader(buf.Bytes())) // the endpoint we're hitting
|
|
ctx.Request.Header.Set("Content-Type", w.FormDataContentType())
|
|
ctx.Request.Header.Set("accept", "application/json")
|
|
ctx.AddParam(mediamodule.APIVersionKey, mediamodule.APIv1)
|
|
|
|
// do the actual request
|
|
suite.mediaModule.MediaCreatePOSTHandler(ctx)
|
|
|
|
// check what's in storage *after* the request
|
|
var storageKeysAfterRequest []string
|
|
if err := suite.storage.WalkKeys(ctx, func(ctx context.Context, key string) error {
|
|
storageKeysAfterRequest = append(storageKeysAfterRequest, key)
|
|
return nil
|
|
}); err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
// check response
|
|
suite.EqualValues(http.StatusOK, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
b, err := ioutil.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
fmt.Println(string(b))
|
|
|
|
attachmentReply := &apimodel.Attachment{}
|
|
err = json.Unmarshal(b, attachmentReply)
|
|
suite.NoError(err)
|
|
|
|
suite.Equal("this is a test image -- a cool background from somewhere", *attachmentReply.Description)
|
|
suite.Equal("image", attachmentReply.Type)
|
|
suite.EqualValues(apimodel.MediaMeta{
|
|
Original: apimodel.MediaDimensions{
|
|
Width: 1920,
|
|
Height: 1080,
|
|
Size: "1920x1080",
|
|
Aspect: 1.7777778,
|
|
},
|
|
Small: apimodel.MediaDimensions{
|
|
Width: 512,
|
|
Height: 288,
|
|
Size: "512x288",
|
|
Aspect: 1.7777778,
|
|
},
|
|
Focus: &apimodel.MediaFocus{
|
|
X: -0.5,
|
|
Y: 0.5,
|
|
},
|
|
}, attachmentReply.Meta)
|
|
suite.Equal("LiBzRk#6V[WF_NvzV@WY_3rqV@a$", attachmentReply.Blurhash)
|
|
suite.NotEmpty(attachmentReply.ID)
|
|
suite.NotEmpty(attachmentReply.URL)
|
|
suite.NotEmpty(attachmentReply.PreviewURL)
|
|
suite.Equal(len(storageKeysBeforeRequest)+2, len(storageKeysAfterRequest)) // 2 images should be added to storage: the original and the thumbnail
|
|
}
|
|
|
|
func (suite *MediaCreateTestSuite) TestMediaCreateSuccessfulV2() {
|
|
// set up the context for the request
|
|
t := suite.testTokens["local_account_1"]
|
|
oauthToken := oauth.DBTokenToToken(t)
|
|
recorder := httptest.NewRecorder()
|
|
ctx, _ := testrig.CreateGinTestContext(recorder, nil)
|
|
ctx.Set(oauth.SessionAuthorizedApplication, suite.testApplications["application_1"])
|
|
ctx.Set(oauth.SessionAuthorizedToken, oauthToken)
|
|
ctx.Set(oauth.SessionAuthorizedUser, suite.testUsers["local_account_1"])
|
|
ctx.Set(oauth.SessionAuthorizedAccount, suite.testAccounts["local_account_1"])
|
|
|
|
// see what's in storage *before* the request
|
|
var storageKeysBeforeRequest []string
|
|
if err := suite.storage.WalkKeys(ctx, func(ctx context.Context, key string) error {
|
|
storageKeysBeforeRequest = append(storageKeysBeforeRequest, key)
|
|
return nil
|
|
}); err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
// create the request
|
|
buf, w, err := testrig.CreateMultipartFormData("file", "../../../../testrig/media/test-jpeg.jpg", map[string]string{
|
|
"description": "this is a test image -- a cool background from somewhere",
|
|
"focus": "-0.5,0.5",
|
|
})
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
ctx.Request = httptest.NewRequest(http.MethodPost, "http://localhost:8080/api/v2/media", bytes.NewReader(buf.Bytes())) // the endpoint we're hitting
|
|
ctx.Request.Header.Set("Content-Type", w.FormDataContentType())
|
|
ctx.Request.Header.Set("accept", "application/json")
|
|
ctx.AddParam(mediamodule.APIVersionKey, mediamodule.APIv2)
|
|
|
|
// do the actual request
|
|
suite.mediaModule.MediaCreatePOSTHandler(ctx)
|
|
|
|
// check what's in storage *after* the request
|
|
var storageKeysAfterRequest []string
|
|
if err := suite.storage.WalkKeys(ctx, func(ctx context.Context, key string) error {
|
|
storageKeysAfterRequest = append(storageKeysAfterRequest, key)
|
|
return nil
|
|
}); err != nil {
|
|
panic(err)
|
|
}
|
|
|
|
// check response
|
|
suite.EqualValues(http.StatusOK, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
b, err := ioutil.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
fmt.Println(string(b))
|
|
|
|
attachmentReply := &apimodel.Attachment{}
|
|
err = json.Unmarshal(b, attachmentReply)
|
|
suite.NoError(err)
|
|
|
|
suite.Equal("this is a test image -- a cool background from somewhere", *attachmentReply.Description)
|
|
suite.Equal("image", attachmentReply.Type)
|
|
suite.EqualValues(apimodel.MediaMeta{
|
|
Original: apimodel.MediaDimensions{
|
|
Width: 1920,
|
|
Height: 1080,
|
|
Size: "1920x1080",
|
|
Aspect: 1.7777778,
|
|
},
|
|
Small: apimodel.MediaDimensions{
|
|
Width: 512,
|
|
Height: 288,
|
|
Size: "512x288",
|
|
Aspect: 1.7777778,
|
|
},
|
|
Focus: &apimodel.MediaFocus{
|
|
X: -0.5,
|
|
Y: 0.5,
|
|
},
|
|
}, attachmentReply.Meta)
|
|
suite.Equal("LiBzRk#6V[WF_NvzV@WY_3rqV@a$", attachmentReply.Blurhash)
|
|
suite.NotEmpty(attachmentReply.ID)
|
|
suite.Nil(attachmentReply.URL)
|
|
suite.NotEmpty(attachmentReply.PreviewURL)
|
|
suite.Equal(len(storageKeysBeforeRequest)+2, len(storageKeysAfterRequest)) // 2 images should be added to storage: the original and the thumbnail
|
|
}
|
|
|
|
func (suite *MediaCreateTestSuite) TestMediaCreateLongDescription() {
|
|
// set up the context for the request
|
|
t := suite.testTokens["local_account_1"]
|
|
oauthToken := oauth.DBTokenToToken(t)
|
|
recorder := httptest.NewRecorder()
|
|
ctx, _ := testrig.CreateGinTestContext(recorder, nil)
|
|
ctx.Set(oauth.SessionAuthorizedApplication, suite.testApplications["application_1"])
|
|
ctx.Set(oauth.SessionAuthorizedToken, oauthToken)
|
|
ctx.Set(oauth.SessionAuthorizedUser, suite.testUsers["local_account_1"])
|
|
ctx.Set(oauth.SessionAuthorizedAccount, suite.testAccounts["local_account_1"])
|
|
|
|
// read a random string of a really long description
|
|
descriptionBytes := make([]byte, 5000)
|
|
if _, err := rand.Read(descriptionBytes); err != nil {
|
|
panic(err)
|
|
}
|
|
description := base64.RawStdEncoding.EncodeToString(descriptionBytes)
|
|
|
|
// create the request
|
|
buf, w, err := testrig.CreateMultipartFormData("file", "../../../../testrig/media/test-jpeg.jpg", map[string]string{
|
|
"description": description,
|
|
"focus": "-0.5,0.5",
|
|
})
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
ctx.Request = httptest.NewRequest(http.MethodPost, "http://localhost:8080/api/v1/media", bytes.NewReader(buf.Bytes())) // the endpoint we're hitting
|
|
ctx.Request.Header.Set("Content-Type", w.FormDataContentType())
|
|
ctx.Request.Header.Set("accept", "application/json")
|
|
ctx.AddParam(mediamodule.APIVersionKey, mediamodule.APIv1)
|
|
|
|
// do the actual request
|
|
suite.mediaModule.MediaCreatePOSTHandler(ctx)
|
|
|
|
// check response
|
|
suite.EqualValues(http.StatusBadRequest, recorder.Code)
|
|
|
|
result := recorder.Result()
|
|
defer result.Body.Close()
|
|
b, err := ioutil.ReadAll(result.Body)
|
|
suite.NoError(err)
|
|
|
|
suite.Equal(`{"error":"Bad Request: image description length must be between 0 and 500 characters (inclusive), but provided image description was 6667 chars"}`, string(b))
|
|
}
|
|
|
|
func (suite *MediaCreateTestSuite) TestMediaCreateTooShortDescription() {
|
|
// set the min description length
|
|
config.SetMediaDescriptionMinChars(500)
|
|
|
|
// set up the context for the request
|
|
t := suite.testTokens["local_account_1"]
|
|
oauthToken := oauth.DBTokenToToken(t)
|
|
recorder := httptest.NewRecorder()
|
|
ctx, _ := testrig.CreateGinTestContext(recorder, nil)
|
|
ctx.Set(oauth.SessionAuthorizedApplication, suite.testApplications["application_1"])
|
|
ctx.Set(oauth.SessionAuthorizedToken, oauthToken)
|
|
ctx.Set(oauth.SessionAuthorizedUser, suite.testUsers["local_account_1"])
|
|
ctx.Set(oauth.SessionAuthorizedAccount, suite.testAccounts["local_account_1"])
|
|
|
|
// create the request
|
|
buf, w, err := testrig.CreateMultipartFormData("file", "../../../../testrig/media/test-jpeg.jpg", map[string]string{
|
|
"description": "", // provide an empty description
|
|
"focus": "-0.5,0.5",
|
|
})
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
ctx.Request = httptest.NewRequest(http.MethodPost, "http://localhost:8080/api/v1/media", bytes.NewReader(buf.Bytes())) // the endpoint we're hitting
|
|
ctx.Request.Header.Set("Content-Type", w.FormDataContentType())
|
|
ctx.Request.Header.Set("accept", "application/json")
|
|
ctx.AddParam(mediamodule.APIVersionKey, mediamodule.APIv1)
|
|
|
|
// do the actual request
|
|
suite.mediaModule.MediaCreatePOSTHandler(ctx)
|
|
|
|
// check response -- there should be no error because minimum description length is checked on *UPDATE*, not initial upload
|
|
suite.EqualValues(http.StatusOK, recorder.Code)
|
|
}
|
|
|
|
func TestMediaCreateTestSuite(t *testing.T) {
|
|
suite.Run(t, new(MediaCreateTestSuite))
|
|
}
|