2022-01-30 18:10:53 +03:00
/ *
GoToSocial
Copyright ( C ) 2021 - 2022 GoToSocial Authors admin @ gotosocial . org
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"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/http/httptest"
"testing"
"github.com/gin-gonic/gin"
"github.com/stretchr/testify/suite"
mediamodule "github.com/superseriousbusiness/gotosocial/internal/api/client/media"
"github.com/superseriousbusiness/gotosocial/internal/api/model"
2022-05-15 12:16:43 +03:00
"github.com/superseriousbusiness/gotosocial/internal/concurrency"
2022-01-30 18:10:53 +03:00
"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"
2022-07-19 11:47:55 +03:00
"github.com/superseriousbusiness/gotosocial/internal/log"
2022-01-30 18:10:53 +03:00
"github.com/superseriousbusiness/gotosocial/internal/media"
2022-04-28 15:23:11 +03:00
"github.com/superseriousbusiness/gotosocial/internal/messages"
2022-01-30 18:10:53 +03:00
"github.com/superseriousbusiness/gotosocial/internal/oauth"
"github.com/superseriousbusiness/gotosocial/internal/processing"
2022-07-03 13:08:30 +03:00
"github.com/superseriousbusiness/gotosocial/internal/storage"
2022-01-30 18:10:53 +03:00
"github.com/superseriousbusiness/gotosocial/internal/typeutils"
"github.com/superseriousbusiness/gotosocial/testrig"
)
type MediaUpdateTestSuite struct {
// standard suite interfaces
suite . Suite
db db . DB
2022-11-24 11:35:46 +03:00
storage * storage . Driver
2022-01-30 18:10:53 +03:00
federator federation . Federator
tc typeutils . TypeConverter
2022-02-08 14:17:53 +03:00
mediaManager media . Manager
2022-01-30 18:10:53 +03:00
oauthServer oauth . Server
emailSender email . Sender
processor processing . Processor
// 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 * MediaUpdateTestSuite ) SetupSuite ( ) {
// setup standard items
testrig . InitTestConfig ( )
testrig . InitTestLog ( )
2022-04-28 15:23:11 +03:00
2022-05-15 12:16:43 +03:00
fedWorker := concurrency . NewWorkerPool [ messages . FromFederator ] ( - 1 , - 1 )
clientWorker := concurrency . NewWorkerPool [ messages . FromClientAPI ] ( - 1 , - 1 )
2022-04-28 15:23:11 +03:00
2022-01-30 18:10:53 +03:00
suite . db = testrig . NewTestDB ( )
2022-07-03 13:08:30 +03:00
suite . storage = testrig . NewInMemoryStorage ( )
2022-01-30 18:10:53 +03:00
suite . tc = testrig . NewTestTypeConverter ( suite . db )
2022-02-08 14:17:53 +03:00
suite . mediaManager = testrig . NewTestMediaManager ( suite . db , suite . storage )
2022-01-30 18:10:53 +03:00
suite . oauthServer = testrig . NewTestOauthServer ( suite . db )
2022-06-11 12:01:34 +03:00
suite . federator = testrig . NewTestFederator ( suite . db , testrig . NewTestTransportController ( testrig . NewMockHTTPClient ( nil , "../../../../testrig/media" ) , suite . db , fedWorker ) , suite . storage , suite . mediaManager , fedWorker )
2022-01-30 18:10:53 +03:00
suite . emailSender = testrig . NewEmailSender ( "../../../../web/template/" , nil )
2022-04-28 15:23:11 +03:00
suite . processor = testrig . NewTestProcessor ( suite . db , suite . storage , suite . federator , suite . emailSender , suite . mediaManager , clientWorker , fedWorker )
2022-01-30 18:10:53 +03:00
// setup module being tested
suite . mediaModule = mediamodule . New ( suite . processor ) . ( * mediamodule . Module )
}
func ( suite * MediaUpdateTestSuite ) TearDownSuite ( ) {
if err := suite . db . Stop ( context . Background ( ) ) ; err != nil {
2022-07-19 11:47:55 +03:00
log . Panicf ( "error closing db connection: %s" , err )
2022-01-30 18:10:53 +03:00
}
}
func ( suite * MediaUpdateTestSuite ) SetupTest ( ) {
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 * MediaUpdateTestSuite ) TearDownTest ( ) {
testrig . StandardDBTeardown ( suite . db )
testrig . StandardStorageTeardown ( suite . storage )
}
/ *
ACTUAL TESTS
* /
func ( suite * MediaUpdateTestSuite ) TestUpdateImage ( ) {
toUpdate := suite . testAttachments [ "local_account_1_unattached_1" ]
// set up the context for the request
t := suite . testTokens [ "local_account_1" ]
oauthToken := oauth . DBTokenToToken ( t )
recorder := httptest . NewRecorder ( )
2022-07-12 10:32:20 +03:00
ctx , _ := testrig . CreateGinTestContext ( recorder , nil )
2022-01-30 18:10:53 +03:00
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 ( "" , "" , map [ string ] string {
"id" : toUpdate . ID ,
"description" : "new description!" ,
"focus" : "-0.1,0.3" ,
} )
if err != nil {
panic ( err )
}
2022-07-22 13:48:19 +03:00
ctx . Request = httptest . NewRequest ( http . MethodPut , fmt . Sprintf ( "http://localhost:8080/api/v1/media/%s" , toUpdate . ID ) , bytes . NewReader ( buf . Bytes ( ) ) ) // the endpoint we're hitting
2022-01-30 18:10:53 +03:00
ctx . Request . Header . Set ( "Content-Type" , w . FormDataContentType ( ) )
ctx . Request . Header . Set ( "accept" , "application/json" )
ctx . Params = gin . Params {
gin . Param {
Key : mediamodule . IDKey ,
Value : toUpdate . ID ,
} ,
}
// do the actual request
suite . mediaModule . MediaPUTHandler ( ctx )
// check response
suite . EqualValues ( http . StatusOK , recorder . Code )
result := recorder . Result ( )
defer result . Body . Close ( )
b , err := ioutil . ReadAll ( result . Body )
suite . NoError ( err )
// reply should be an attachment
attachmentReply := & model . Attachment { }
err = json . Unmarshal ( b , attachmentReply )
suite . NoError ( err )
// the reply should contain the updated fields
2022-07-22 13:48:19 +03:00
suite . Equal ( "new description!" , * attachmentReply . Description )
2022-09-04 15:58:58 +03:00
suite . EqualValues ( "image" , attachmentReply . Type )
2022-01-30 18:10:53 +03:00
suite . EqualValues ( model . MediaMeta {
Original : model . MediaDimensions { Width : 800 , Height : 450 , FrameRate : "" , Duration : 0 , Bitrate : 0 , Size : "800x450" , Aspect : 1.7777778 } ,
Small : model . MediaDimensions { Width : 256 , Height : 144 , FrameRate : "" , Duration : 0 , Bitrate : 0 , Size : "256x144" , Aspect : 1.7777778 } ,
Focus : model . MediaFocus { X : - 0.1 , Y : 0.3 } ,
} , attachmentReply . Meta )
suite . Equal ( toUpdate . Blurhash , attachmentReply . Blurhash )
suite . Equal ( toUpdate . ID , attachmentReply . ID )
2022-07-22 13:48:19 +03:00
suite . Equal ( toUpdate . URL , * attachmentReply . URL )
2022-01-30 18:10:53 +03:00
suite . NotEmpty ( toUpdate . Thumbnail . URL , attachmentReply . PreviewURL )
}
func ( suite * MediaUpdateTestSuite ) TestUpdateImageShortDescription ( ) {
// set the min description length
2022-05-30 15:41:24 +03:00
config . SetMediaDescriptionMinChars ( 50 )
2022-01-30 18:10:53 +03:00
toUpdate := suite . testAttachments [ "local_account_1_unattached_1" ]
// set up the context for the request
t := suite . testTokens [ "local_account_1" ]
oauthToken := oauth . DBTokenToToken ( t )
recorder := httptest . NewRecorder ( )
2022-07-12 10:32:20 +03:00
ctx , _ := testrig . CreateGinTestContext ( recorder , nil )
2022-01-30 18:10:53 +03:00
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 ( "" , "" , map [ string ] string {
"id" : toUpdate . ID ,
"description" : "new description!" ,
"focus" : "-0.1,0.3" ,
} )
if err != nil {
panic ( err )
}
2022-07-22 13:48:19 +03:00
ctx . Request = httptest . NewRequest ( http . MethodPut , fmt . Sprintf ( "http://localhost:8080/api/v1/media/%s" , toUpdate . ID ) , bytes . NewReader ( buf . Bytes ( ) ) ) // the endpoint we're hitting
2022-01-30 18:10:53 +03:00
ctx . Request . Header . Set ( "Content-Type" , w . FormDataContentType ( ) )
ctx . Request . Header . Set ( "accept" , "application/json" )
ctx . Params = gin . Params {
gin . Param {
Key : mediamodule . IDKey ,
Value : toUpdate . ID ,
} ,
}
// do the actual request
suite . mediaModule . MediaPUTHandler ( 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 )
// reply should be an error message
2022-06-08 21:38:03 +03:00
suite . Equal ( ` { "error":"Bad Request: image description length must be between 50 and 500 characters (inclusive), but provided image description was 16 chars"} ` , string ( b ) )
2022-01-30 18:10:53 +03:00
}
func TestMediaUpdateTestSuite ( t * testing . T ) {
suite . Run ( t , new ( MediaUpdateTestSuite ) )
}