| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321 |
- package toc
- import (
- "context"
- "encoding/hex"
- "io"
- "log/slog"
- "testing"
- "github.com/google/uuid"
- "github.com/stretchr/testify/assert"
- "github.com/stretchr/testify/mock"
- "golang.org/x/sync/errgroup"
- "github.com/mk6i/retro-aim-server/state"
- "github.com/mk6i/retro-aim-server/wire"
- )
- func TestOSCARProxy_RecvClientCmd_AddBuddy(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully add buddies",
- me: newTestSession("me"),
- givenCmd: []byte("toc_add_buddy friend1 friend2 friend3"),
- mockParams: mockParams{
- buddyParams: buddyParams{
- addBuddiesParams: addBuddiesParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x03_0x04_BuddyAddBuddies{
- Buddies: []struct {
- ScreenName string `oscar:"len_prefix=uint8"`
- }{
- {ScreenName: "friend1"},
- {ScreenName: "friend2"},
- {ScreenName: "friend3"},
- },
- },
- },
- },
- },
- },
- },
- {
- name: "add buddies with empty list",
- me: newTestSession("me"),
- givenCmd: []byte("toc_add_buddy"),
- mockParams: mockParams{
- buddyParams: buddyParams{
- addBuddiesParams: addBuddiesParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x03_0x04_BuddyAddBuddies{},
- },
- },
- },
- },
- },
- {
- name: "add buddies, receive error from buddy service",
- me: newTestSession("me"),
- givenCmd: []byte("toc_add_buddy friend1"),
- mockParams: mockParams{
- buddyParams: buddyParams{
- addBuddiesParams: addBuddiesParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x03_0x04_BuddyAddBuddies{
- Buddies: []struct {
- ScreenName string `oscar:"len_prefix=uint8"`
- }{
- {ScreenName: "friend1"},
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- buddySvc := newMockBuddyService(t)
- for _, params := range tc.mockParams.addBuddiesParams {
- buddySvc.EXPECT().
- AddBuddies(ctx, matchSession(params.me), params.inBody).
- Return(params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- BuddyService: buddySvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_AddPermit(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully permit buddies",
- me: newTestSession("me"),
- givenCmd: []byte("toc_add_permit friend1 friend2 friend3"),
- mockParams: mockParams{
- permitDenyParams: permitDenyParams{
- addPermListEntriesParams: addPermListEntriesParams{
- {
- me: state.NewIdentScreenName("me"),
- body: wire.SNAC_0x09_0x05_PermitDenyAddPermListEntries{
- Users: []struct {
- ScreenName string `oscar:"len_prefix=uint8"`
- }{
- {ScreenName: "friend1"},
- {ScreenName: "friend2"},
- {ScreenName: "friend3"},
- },
- },
- },
- },
- },
- },
- },
- {
- name: "permit buddies, receive error from buddy service",
- me: newTestSession("me"),
- givenCmd: []byte("toc_add_permit friend1"),
- mockParams: mockParams{
- permitDenyParams: permitDenyParams{
- addPermListEntriesParams: addPermListEntriesParams{
- {
- me: state.NewIdentScreenName("me"),
- body: wire.SNAC_0x09_0x05_PermitDenyAddPermListEntries{
- Users: []struct {
- ScreenName string `oscar:"len_prefix=uint8"`
- }{
- {ScreenName: "friend1"},
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "permit buddies with empty list",
- me: newTestSession("me"),
- givenCmd: []byte("toc_add_permit"),
- mockParams: mockParams{
- permitDenyParams: permitDenyParams{
- addPermListEntriesParams: addPermListEntriesParams{
- {
- me: state.NewIdentScreenName("me"),
- body: wire.SNAC_0x09_0x05_PermitDenyAddPermListEntries{},
- },
- },
- },
- },
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- pdSvc := newMockPermitDenyService(t)
- for _, params := range tc.mockParams.addPermListEntriesParams {
- pdSvc.EXPECT().
- AddPermListEntries(ctx, matchSession(params.me), params.body).
- Return(params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- PermitDenyService: pdSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_AddDeny(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully deny buddies",
- me: newTestSession("me"),
- givenCmd: []byte("toc_add_deny friend1 friend2 friend3"),
- mockParams: mockParams{
- permitDenyParams: permitDenyParams{
- addDenyListEntriesParams: addDenyListEntriesParams{
- {
- me: state.NewIdentScreenName("me"),
- body: wire.SNAC_0x09_0x07_PermitDenyAddDenyListEntries{
- Users: []struct {
- ScreenName string `oscar:"len_prefix=uint8"`
- }{
- {ScreenName: "friend1"},
- {ScreenName: "friend2"},
- {ScreenName: "friend3"},
- },
- },
- },
- },
- },
- },
- },
- {
- name: "deny buddies, receive error from buddy service",
- me: newTestSession("me"),
- givenCmd: []byte("toc_add_deny friend1"),
- mockParams: mockParams{
- permitDenyParams: permitDenyParams{
- addDenyListEntriesParams: addDenyListEntriesParams{
- {
- me: state.NewIdentScreenName("me"),
- body: wire.SNAC_0x09_0x07_PermitDenyAddDenyListEntries{
- Users: []struct {
- ScreenName string `oscar:"len_prefix=uint8"`
- }{
- {ScreenName: "friend1"},
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "deny buddies with empty list",
- me: newTestSession("me"),
- givenCmd: []byte("toc_add_deny"),
- mockParams: mockParams{
- permitDenyParams: permitDenyParams{
- addDenyListEntriesParams: addDenyListEntriesParams{
- {
- me: state.NewIdentScreenName("me"),
- body: wire.SNAC_0x09_0x07_PermitDenyAddDenyListEntries{},
- },
- },
- },
- },
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- pdSvc := newMockPermitDenyService(t)
- for _, params := range tc.mockParams.addDenyListEntriesParams {
- pdSvc.EXPECT().
- AddDenyListEntries(ctx, matchSession(params.me), params.body).
- Return(params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- PermitDenyService: pdSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_FormatNickname(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully change screen name format",
- me: newTestSession("myScreenName"),
- givenCmd: []byte("toc_format_nickname mYsCrEeNnAmE"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("myScreenName"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVScreenNameFormatted, "mYsCrEeNnAmE"),
- },
- },
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x07_0x05_AdminChangeReply{
- Permissions: wire.AdminInfoPermissionsReadWrite,
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVScreenNameFormatted, "mYsCrEeNnAmE"),
- },
- },
- },
- },
- },
- },
- },
- },
- wantMsg: "ADMIN_NICK_STATUS:0",
- },
- {
- name: "format nickname - invalid length",
- me: newTestSession("sn"),
- givenCmd: []byte("toc_format_nickname sN"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("sn"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVScreenNameFormatted, "sN"),
- },
- },
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x07_0x05_AdminChangeReply{
- Permissions: wire.AdminInfoPermissionsReadWrite,
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVErrorCode, wire.AdminInfoErrorInvalidNickNameLength),
- wire.NewTLVBE(wire.AdminTLVUrl, ""),
- },
- },
- },
- },
- },
- },
- },
- },
- wantMsg: "ERROR:911",
- },
- {
- name: "format nickname - invalid screen name",
- me: newTestSession("sn"),
- givenCmd: []byte("toc_format_nickname sN"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("sn"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVScreenNameFormatted, "sN"),
- },
- },
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x07_0x05_AdminChangeReply{
- Permissions: wire.AdminInfoPermissionsReadWrite,
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVErrorCode, wire.AdminInfoErrorInvalidNickName),
- wire.NewTLVBE(wire.AdminTLVUrl, ""),
- },
- },
- },
- },
- },
- },
- },
- },
- wantMsg: "ERROR:911",
- },
- {
- name: "format nickname - catch-all error",
- me: newTestSession("sn"),
- givenCmd: []byte("toc_format_nickname sN"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("sn"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVScreenNameFormatted, "sN"),
- },
- },
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x07_0x05_AdminChangeReply{
- Permissions: wire.AdminInfoPermissionsReadWrite,
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVErrorCode, wire.AdminInfoErrorValidateNickName),
- wire.NewTLVBE(wire.AdminTLVUrl, ""),
- },
- },
- },
- },
- },
- },
- },
- },
- wantMsg: "ERROR:913",
- },
- {
- name: "format nickname - runtime error from admin svc",
- me: newTestSession("myScreenName"),
- givenCmd: []byte("toc_format_nickname mYsCrEeNnAmE"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("myScreenName"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVScreenNameFormatted, "mYsCrEeNnAmE"),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "change password - unexpected response from admin svc",
- me: newTestSession("myScreenName"),
- givenCmd: []byte("toc_format_nickname mYsCrEeNnAmE"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("myScreenName"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVScreenNameFormatted, "mYsCrEeNnAmE"),
- },
- },
- },
- msg: wire.SNACMessage{
- Body: wire.SNACError{},
- },
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_format_nickname`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- adminSvc := newMockAdminService(t)
- for _, params := range tc.mockParams.infoChangeRequestParams {
- adminSvc.EXPECT().
- InfoChangeRequest(ctx, matchSession(params.me), wire.SNACFrame{}, params.inBody).
- Return(params.msg, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- AdminService: adminSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_ChatAccept(t *testing.T) {
- fnNewChatNavParams := func(err error) chatNavParams {
- ret := chatNavParams{
- requestRoomInfoParams: requestRoomInfoParams{
- {
- inBody: wire.SNAC_0x0D_0x04_ChatNavRequestRoomInfo{
- Cookie: "the-cookie",
- Exchange: 4,
- InstanceNumber: 0,
- },
- },
- },
- }
- if err != nil {
- ret.requestRoomInfoParams[0].err = err
- } else {
- ret.requestRoomInfoParams[0].msg = wire.SNACMessage{
- Body: wire.SNAC_0x0D_0x09_ChatNavNavInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatNavTLVRoomInfo, wire.SNAC_0x0E_0x02_ChatRoomInfoUpdate{
- Cookie: "the-cookie",
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatRoomTLVRoomName, "cool room"),
- },
- },
- }),
- },
- },
- },
- }
- }
- return ret
- }
- fnNewOServiceBOSParams := func(err error) oServiceParams {
- ret := oServiceParams{
- serviceRequestParams: serviceRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- bodyIn: wire.SNAC_0x01_0x04_OServiceServiceRequest{
- FoodGroup: wire.Chat,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(0x01, wire.SNAC_0x01_0x04_TLVRoomInfo{
- Cookie: "the-cookie",
- }),
- },
- },
- },
- },
- },
- }
- if err != nil {
- ret.serviceRequestParams[0].err = err
- } else {
- ret.serviceRequestParams[0].msg = wire.SNACMessage{
- Body: wire.SNAC_0x01_0x05_OServiceServiceResponse{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, "chat-auth-cookie"),
- },
- },
- },
- }
- }
- return ret
- }
- fnNewAuthParams := func(err error) authParams {
- ret := authParams{
- registerChatSessionParams: registerChatSessionParams{
- {
- authCookie: []byte("chat-auth-cookie"),
- },
- },
- }
- if err != nil {
- ret.registerChatSessionParams[0].err = err
- } else {
- ret.registerChatSessionParams[0].sess = newTestSession("me-chat")
- }
- return ret
- }
- fnNewOServiceChatParams := func(err error) oServiceParams {
- ret := oServiceParams{
- clientOnlineParams: clientOnlineParams{
- {
- body: wire.SNAC_0x01_0x02_OServiceClientOnline{},
- me: state.NewIdentScreenName("me-chat"),
- },
- },
- }
- if err != nil {
- ret.clientOnlineParams[0].err = err
- }
- return ret
- }
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // givenChatRegistry is the chat registry passed to the function
- givenChatRegistry *ChatRegistry
- // wantMsg is the expected TOC response
- wantMsg string
- // expectChatSession indicates whether a chat session should be present
- // in the chat registry
- expectChatSession bool
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully accept chat",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_accept 0`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.Add(wire.ICBMRoomInfo{
- Cookie: "the-cookie",
- Exchange: 4,
- Instance: 0,
- })
- return reg
- }(),
- mockParams: mockParams{
- chatNavParams: fnNewChatNavParams(nil),
- oServiceBOSParams: fnNewOServiceBOSParams(nil),
- authParams: fnNewAuthParams(nil),
- oServiceChatParams: fnNewOServiceChatParams(nil),
- },
- wantMsg: "CHAT_JOIN:0:cool room",
- expectChatSession: true,
- },
- {
- name: "accept chat, receive error from chat oservice svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_accept 0`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.Add(wire.ICBMRoomInfo{
- Cookie: "the-cookie",
- Exchange: 4,
- Instance: 0,
- })
- return reg
- }(),
- mockParams: mockParams{
- chatNavParams: fnNewChatNavParams(nil),
- oServiceBOSParams: fnNewOServiceBOSParams(nil),
- authParams: fnNewAuthParams(nil),
- oServiceChatParams: fnNewOServiceChatParams(io.EOF),
- },
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- {
- name: "accept chat, receive error from auth svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_accept 0`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.Add(wire.ICBMRoomInfo{
- Cookie: "the-cookie",
- Exchange: 4,
- Instance: 0,
- })
- return reg
- }(),
- mockParams: mockParams{
- chatNavParams: fnNewChatNavParams(nil),
- oServiceBOSParams: fnNewOServiceBOSParams(nil),
- authParams: fnNewAuthParams(io.EOF),
- },
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- {
- name: "accept chat, receive error from BOS oservice svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_accept 0`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.Add(wire.ICBMRoomInfo{
- Cookie: "the-cookie",
- Exchange: 4,
- Instance: 0,
- })
- return reg
- }(),
- mockParams: mockParams{
- chatNavParams: fnNewChatNavParams(nil),
- oServiceBOSParams: fnNewOServiceBOSParams(io.EOF),
- },
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- {
- name: "accept chat, receive error from chat nav svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_accept 0`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.Add(wire.ICBMRoomInfo{
- Cookie: "the-cookie",
- Exchange: 4,
- Instance: 0,
- })
- return reg
- }(),
- mockParams: mockParams{
- chatNavParams: fnNewChatNavParams(io.EOF),
- },
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_accept`),
- givenChatRegistry: NewChatRegistry(),
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- {
- name: "bad exchange number",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_accept four`),
- givenChatRegistry: NewChatRegistry(),
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx, cancel := context.WithCancel(context.Background())
- cancel()
- chatNavSvc := newMockChatNavService(t)
- for _, params := range tc.mockParams.requestRoomInfoParams {
- chatNavSvc.EXPECT().
- RequestRoomInfo(ctx, wire.SNACFrame{}, params.inBody).
- Return(params.msg, params.err)
- }
- bosOServiceSvc := newMockOServiceService(t)
- for _, params := range tc.mockParams.oServiceBOSParams.serviceRequestParams {
- bosOServiceSvc.EXPECT().
- ServiceRequest(ctx, matchSession(params.me), wire.SNACFrame{}, params.bodyIn).
- Return(params.msg, params.err)
- }
- chatOServiceSvc := newMockOServiceService(t)
- for _, params := range tc.mockParams.oServiceChatParams.clientOnlineParams {
- chatOServiceSvc.EXPECT().
- ClientOnline(ctx, params.body, matchSession(params.me)).
- Return(params.err)
- }
- authSvc := newMockAuthService(t)
- for _, params := range tc.mockParams.authParams.registerChatSessionParams {
- authSvc.EXPECT().
- RegisterChatSession(ctx, params.authCookie).
- Return(params.sess, params.err)
- }
- svc := OSCARProxy{
- AuthService: authSvc,
- ChatNavService: chatNavSvc,
- Logger: slog.Default(),
- OServiceServiceBOS: bosOServiceSvc,
- OServiceServiceChat: chatOServiceSvc,
- }
- g := &errgroup.Group{}
- tc.me.Close()
- msg := svc.RecvClientCmd(ctx, tc.me, tc.givenChatRegistry, tc.givenCmd, nil, g.Go)
- assert.NoError(t, g.Wait())
- assert.Equal(t, tc.wantMsg, msg)
- assert.Equal(t, tc.expectChatSession, len(tc.givenChatRegistry.Sessions()) == 1)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_ChatInvite(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // givenChatRegistry is the chat registry passed to the function
- givenChatRegistry *ChatRegistry
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully send chat invitation",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_invite 0 "join my chat! :\)" friend1`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.Add(wire.ICBMRoomInfo{
- Exchange: 4,
- Cookie: "the-cookie",
- Instance: 0,
- })
- return reg
- }(),
- mockParams: mockParams{
- icbmParams: icbmParams{
- channelMsgToHostParamsICBM: channelMsgToHostParamsICBM{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelRendezvous,
- ScreenName: "friend1",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(0x05, wire.ICBMCh2Fragment{
- Type: 0,
- Capability: wire.CapChat,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(10, uint16(1)),
- wire.NewTLVBE(12, "join my chat! :)"),
- wire.NewTLVBE(13, "us-ascii"),
- wire.NewTLVBE(14, "en"),
- wire.NewTLVBE(10001, wire.ICBMRoomInfo{
- Exchange: 4,
- Cookie: "the-cookie",
- Instance: 0,
- }),
- },
- },
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "send chat invitation, receive error from ICBM svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_invite 0 "join my chat!" friend1`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.Add(wire.ICBMRoomInfo{
- Exchange: 4,
- Cookie: "the-cookie",
- Instance: 0,
- })
- return reg
- }(),
- mockParams: mockParams{
- icbmParams: icbmParams{
- channelMsgToHostParamsICBM: channelMsgToHostParamsICBM{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelRendezvous,
- ScreenName: "friend1",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(0x05, wire.ICBMCh2Fragment{
- Type: 0,
- Capability: wire.CapChat,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(10, uint16(1)),
- wire.NewTLVBE(12, "join my chat!"),
- wire.NewTLVBE(13, "us-ascii"),
- wire.NewTLVBE(14, "en"),
- wire.NewTLVBE(10001, wire.ICBMRoomInfo{
- Exchange: 4,
- Cookie: "the-cookie",
- Instance: 0,
- }),
- },
- },
- }),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "send chat invitation to non-existent room",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_invite 0 "join my chat!" friend1`),
- givenChatRegistry: NewChatRegistry(),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad chat room ID",
- givenCmd: []byte(`toc_chat_invite zero "join my chat!" friend1`),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_invite`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- icbmSvc := newMockICBMService(t)
- for _, params := range tc.mockParams.channelMsgToHostParamsICBM {
- icbmSvc.EXPECT().
- ChannelMsgToHost(ctx, matchSession(params.sender), wire.SNACFrame{}, params.inBody).
- Return(nil, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- ICBMService: icbmSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, tc.givenChatRegistry, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_ChatJoin(t *testing.T) {
- fnNewChatNavParams := func(err error) chatNavParams {
- ret := chatNavParams{
- createRoomParams: createRoomParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x0E_0x02_ChatRoomInfoUpdate{
- Exchange: 4,
- Cookie: "create",
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatRoomTLVRoomName, "cool room :)"),
- },
- },
- },
- },
- },
- }
- if err != nil {
- ret.createRoomParams[0].err = err
- } else {
- ret.createRoomParams[0].msg = wire.SNACMessage{
- Body: wire.SNAC_0x0D_0x09_ChatNavNavInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatNavTLVRoomInfo, wire.SNAC_0x0E_0x02_ChatRoomInfoUpdate{
- Cookie: "the-cookie",
- }),
- },
- },
- },
- }
- }
- return ret
- }
- fnNewOServiceBOSParams := func(err error) oServiceParams {
- ret := oServiceParams{
- serviceRequestParams: serviceRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- bodyIn: wire.SNAC_0x01_0x04_OServiceServiceRequest{
- FoodGroup: wire.Chat,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(0x01, wire.SNAC_0x01_0x04_TLVRoomInfo{
- Cookie: "the-cookie",
- }),
- },
- },
- },
- },
- },
- }
- if err != nil {
- ret.serviceRequestParams[0].err = err
- } else {
- ret.serviceRequestParams[0].msg = wire.SNACMessage{
- Body: wire.SNAC_0x01_0x05_OServiceServiceResponse{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, "chat-auth-cookie"),
- },
- },
- },
- }
- }
- return ret
- }
- fnNewAuthParams := func(err error) authParams {
- ret := authParams{
- registerChatSessionParams: registerChatSessionParams{
- {
- authCookie: []byte("chat-auth-cookie"),
- },
- },
- }
- if err != nil {
- ret.registerChatSessionParams[0].err = err
- } else {
- ret.registerChatSessionParams[0].sess = newTestSession("me-chat")
- }
- return ret
- }
- fnNewOServiceChatParams := func(err error) oServiceParams {
- ret := oServiceParams{
- clientOnlineParams: clientOnlineParams{
- {
- body: wire.SNAC_0x01_0x02_OServiceClientOnline{},
- me: state.NewIdentScreenName("me-chat"),
- },
- },
- }
- if err != nil {
- ret.clientOnlineParams[0].err = err
- }
- return ret
- }
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // givenChatRegistry is the chat registry passed to the function
- givenChatRegistry *ChatRegistry
- // wantMsg is the expected TOC response
- wantMsg string
- // expectChatSession indicates whether a chat session should be present
- // in the chat registry
- expectChatSession bool
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully join chat",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_join 4 "cool room :\)"`),
- givenChatRegistry: NewChatRegistry(),
- mockParams: mockParams{
- chatNavParams: fnNewChatNavParams(nil),
- oServiceBOSParams: fnNewOServiceBOSParams(nil),
- authParams: fnNewAuthParams(nil),
- oServiceChatParams: fnNewOServiceChatParams(nil),
- },
- wantMsg: "CHAT_JOIN:0:cool room :)",
- expectChatSession: true,
- },
- {
- name: "join chat, receive error from chat oservice svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_join 4 "cool room :\)"`),
- givenChatRegistry: NewChatRegistry(),
- mockParams: mockParams{
- chatNavParams: fnNewChatNavParams(nil),
- oServiceBOSParams: fnNewOServiceBOSParams(nil),
- authParams: fnNewAuthParams(nil),
- oServiceChatParams: fnNewOServiceChatParams(io.EOF),
- },
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- {
- name: "join chat, receive error from auth svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_join 4 "cool room :\)"`),
- givenChatRegistry: NewChatRegistry(),
- mockParams: mockParams{
- chatNavParams: fnNewChatNavParams(nil),
- oServiceBOSParams: fnNewOServiceBOSParams(nil),
- authParams: fnNewAuthParams(io.EOF),
- },
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- {
- name: "join chat, receive error from BOS oservice svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_join 4 "cool room :\)"`),
- givenChatRegistry: NewChatRegistry(),
- mockParams: mockParams{
- chatNavParams: fnNewChatNavParams(nil),
- oServiceBOSParams: fnNewOServiceBOSParams(io.EOF),
- },
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- {
- name: "join chat, receive error from chat nav svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_join 4 "cool room :\)"`),
- givenChatRegistry: NewChatRegistry(),
- mockParams: mockParams{
- chatNavParams: fnNewChatNavParams(io.EOF),
- },
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_join`),
- givenChatRegistry: NewChatRegistry(),
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- {
- name: "bad exchange number",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_join four "cool room :\)"`),
- givenChatRegistry: NewChatRegistry(),
- wantMsg: cmdInternalSvcErr,
- expectChatSession: false,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx, cancel := context.WithCancel(context.Background())
- cancel()
- chatNavSvc := newMockChatNavService(t)
- for _, params := range tc.mockParams.createRoomParams {
- chatNavSvc.EXPECT().
- CreateRoom(ctx, matchSession(params.me), wire.SNACFrame{}, params.inBody).
- Return(params.msg, params.err)
- }
- bosOServiceSvc := newMockOServiceService(t)
- for _, params := range tc.mockParams.oServiceBOSParams.serviceRequestParams {
- bosOServiceSvc.EXPECT().
- ServiceRequest(ctx, matchSession(params.me), wire.SNACFrame{}, params.bodyIn).
- Return(params.msg, params.err)
- }
- chatOServiceSvc := newMockOServiceService(t)
- for _, params := range tc.mockParams.oServiceChatParams.clientOnlineParams {
- chatOServiceSvc.EXPECT().
- ClientOnline(ctx, params.body, matchSession(params.me)).
- Return(params.err)
- }
- authSvc := newMockAuthService(t)
- for _, params := range tc.mockParams.authParams.registerChatSessionParams {
- authSvc.EXPECT().
- RegisterChatSession(ctx, params.authCookie).
- Return(params.sess, params.err)
- }
- svc := OSCARProxy{
- AuthService: authSvc,
- ChatNavService: chatNavSvc,
- Logger: slog.Default(),
- OServiceServiceBOS: bosOServiceSvc,
- OServiceServiceChat: chatOServiceSvc,
- }
- g := &errgroup.Group{}
- tc.me.Close()
- msg := svc.RecvClientCmd(ctx, tc.me, tc.givenChatRegistry, tc.givenCmd, nil, g.Go)
- assert.NoError(t, g.Wait())
- assert.Equal(t, tc.wantMsg, msg)
- assert.Equal(t, tc.expectChatSession, len(tc.givenChatRegistry.Sessions()) == 1)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_ChatLeave(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // givenChatRegistry is the chat registry passed to the function
- givenChatRegistry *ChatRegistry
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully leave chat",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_leave 0`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.RegisterSess(0, newTestSession("me"))
- return reg
- }(),
- mockParams: mockParams{
- authParams: authParams{
- signoutChatParams: signoutChatParams{
- {
- me: state.NewIdentScreenName("me"),
- },
- },
- },
- },
- wantMsg: "CHAT_LEFT:0",
- },
- {
- name: "chat room ID with invalid format",
- givenCmd: []byte(`toc_chat_leave zero`),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "missing chat session",
- givenCmd: []byte(`toc_chat_leave 0`),
- givenChatRegistry: NewChatRegistry(),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_leave`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- authSvc := newMockAuthService(t)
- for _, params := range tc.mockParams.signoutChatParams {
- authSvc.EXPECT().SignoutChat(ctx, matchSession(params.me))
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- AuthService: authSvc,
- }
- msg := svc.RecvClientCmd(ctx, nil, tc.givenChatRegistry, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_ChatSend(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // givenChatRegistry is the chat registry passed to the function
- givenChatRegistry *ChatRegistry
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully send chat message",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_send 0 "Hello world! :\)"`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.RegisterSess(0, newTestSession("me"))
- return reg
- }(),
- mockParams: mockParams{
- chatParams: chatParams{
- channelMsgToHostParamsChat: channelMsgToHostParamsChat{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x0E_0x05_ChatChannelMsgToHost{
- Channel: wire.ICBMChannelMIME,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVEnableReflectionFlag, uint8(1)),
- wire.NewTLVBE(wire.ChatTLVSenderInformation, newTestSession("me").TLVUserInfo()),
- wire.NewTLVBE(wire.ChatTLVPublicWhisperFlag, []byte{}),
- wire.NewTLVBE(wire.ChatTLVMessageInfo, wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVMessageInfoText, "Hello world! :)"),
- },
- }),
- },
- },
- },
- result: &wire.SNACMessage{
- Body: wire.SNAC_0x0E_0x06_ChatChannelMsgToClient{
- Channel: wire.ICBMChannelMIME,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVSenderInformation,
- newTestSession("me").TLVUserInfo()),
- wire.NewTLVBE(wire.ChatTLVPublicWhisperFlag, []byte{}),
- wire.NewTLVBE(wire.ChatTLVMessageInfo, wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVMessageInfoText, "Hello world! :)"),
- },
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- wantMsg: "CHAT_IN:0:me:F:Hello world! :)",
- },
- {
- name: "send chat message, receive error from chat svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_send 0 "Hello world!"`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.RegisterSess(0, newTestSession("me"))
- return reg
- }(),
- mockParams: mockParams{
- chatParams: chatParams{
- channelMsgToHostParamsChat: channelMsgToHostParamsChat{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x0E_0x05_ChatChannelMsgToHost{
- Channel: wire.ICBMChannelMIME,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVEnableReflectionFlag, uint8(1)),
- wire.NewTLVBE(wire.ChatTLVSenderInformation, newTestSession("me").TLVUserInfo()),
- wire.NewTLVBE(wire.ChatTLVPublicWhisperFlag, []byte{}),
- wire.NewTLVBE(wire.ChatTLVMessageInfo, wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVMessageInfoText, "Hello world!"),
- },
- }),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "send chat message, receive nil response from chat svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_send 0 "Hello world!"`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.RegisterSess(0, newTestSession("me"))
- return reg
- }(),
- mockParams: mockParams{
- chatParams: chatParams{
- channelMsgToHostParamsChat: channelMsgToHostParamsChat{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x0E_0x05_ChatChannelMsgToHost{
- Channel: wire.ICBMChannelMIME,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVEnableReflectionFlag, uint8(1)),
- wire.NewTLVBE(wire.ChatTLVSenderInformation, newTestSession("me").TLVUserInfo()),
- wire.NewTLVBE(wire.ChatTLVPublicWhisperFlag, []byte{}),
- wire.NewTLVBE(wire.ChatTLVMessageInfo, wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVMessageInfoText, "Hello world!"),
- },
- }),
- },
- },
- },
- result: nil,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "send chat message, receive unexpected response from chat svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_send 0 "Hello world!"`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.RegisterSess(0, newTestSession("me"))
- return reg
- }(),
- mockParams: mockParams{
- chatParams: chatParams{
- channelMsgToHostParamsChat: channelMsgToHostParamsChat{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x0E_0x05_ChatChannelMsgToHost{
- Channel: wire.ICBMChannelMIME,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVEnableReflectionFlag, uint8(1)),
- wire.NewTLVBE(wire.ChatTLVSenderInformation, newTestSession("me").TLVUserInfo()),
- wire.NewTLVBE(wire.ChatTLVPublicWhisperFlag, []byte{}),
- wire.NewTLVBE(wire.ChatTLVMessageInfo, wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVMessageInfoText, "Hello world!"),
- },
- }),
- },
- },
- },
- result: &wire.SNACMessage{
- Body: wire.SNACError{},
- },
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "chat room ID with invalid format",
- givenCmd: []byte(`toc_chat_send zero "Hello world!"`),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "missing chat session",
- givenCmd: []byte(`toc_chat_send 0 "Hello world!"`),
- givenChatRegistry: NewChatRegistry(),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_send`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- chatSvc := newMockChatService(t)
- for _, params := range tc.mockParams.channelMsgToHostParamsChat {
- chatSvc.EXPECT().
- ChannelMsgToHost(ctx, matchSession(params.sender), wire.SNACFrame{}, params.inBody).
- Return(params.result, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- ChatService: chatSvc,
- }
- msg := svc.RecvClientCmd(ctx, nil, tc.givenChatRegistry, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_ChatWhisper(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // givenChatRegistry is the chat registry passed to the function
- givenChatRegistry *ChatRegistry
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully send chat whisper",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_whisper 0 them "Hello world! :\)"`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.RegisterSess(0, newTestSession("me"))
- return reg
- }(),
- mockParams: mockParams{
- chatParams: chatParams{
- channelMsgToHostParamsChat: channelMsgToHostParamsChat{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x0E_0x05_ChatChannelMsgToHost{
- Channel: wire.ICBMChannelMIME,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVSenderInformation, newTestSession("me").TLVUserInfo()),
- wire.NewTLVBE(wire.ChatTLVWhisperToUser, "them"),
- wire.NewTLVBE(wire.ChatTLVMessageInfo, wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVMessageInfoText, "Hello world! :)"),
- },
- }),
- },
- },
- },
- result: nil,
- },
- },
- },
- },
- wantMsg: "",
- },
- {
- name: "send chat whisper, receive error from chat svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_whisper 0 them "Hello world!"`),
- givenChatRegistry: func() *ChatRegistry {
- reg := NewChatRegistry()
- reg.RegisterSess(0, newTestSession("me"))
- return reg
- }(),
- mockParams: mockParams{
- chatParams: chatParams{
- channelMsgToHostParamsChat: channelMsgToHostParamsChat{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x0E_0x05_ChatChannelMsgToHost{
- Channel: wire.ICBMChannelMIME,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVSenderInformation, newTestSession("me").TLVUserInfo()),
- wire.NewTLVBE(wire.ChatTLVWhisperToUser, "them"),
- wire.NewTLVBE(wire.ChatTLVMessageInfo, wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ChatTLVMessageInfoText, "Hello world!"),
- },
- }),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "chat room ID with invalid format",
- givenCmd: []byte(`toc_chat_whisper zero them "Hello world!"`),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "missing chat session",
- givenCmd: []byte(`toc_chat_whisper 0 them "Hello world!"`),
- givenChatRegistry: NewChatRegistry(),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_chat_whisper`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- chatSvc := newMockChatService(t)
- for _, params := range tc.mockParams.channelMsgToHostParamsChat {
- chatSvc.EXPECT().
- ChannelMsgToHost(ctx, matchSession(params.sender), wire.SNACFrame{}, params.inBody).
- Return(params.result, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- ChatService: chatSvc,
- }
- msg := svc.RecvClientCmd(ctx, nil, tc.givenChatRegistry, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_Evil(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully warn normally",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_evil them norm`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- evilRequestParams: evilRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 0,
- ScreenName: "them",
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x04_0x09_ICBMEvilReply{},
- },
- },
- },
- },
- },
- },
- {
- name: "successfully warn anonymously",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_evil them anon`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- evilRequestParams: evilRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 1,
- ScreenName: "them",
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x04_0x09_ICBMEvilReply{},
- },
- },
- },
- },
- },
- },
- {
- name: "warn, receive error from ICBM service",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_evil them anon`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- evilRequestParams: evilRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 1,
- ScreenName: "them",
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "warn, receive snac err",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_evil them anon`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- evilRequestParams: evilRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 1,
- ScreenName: "them",
- },
- msg: wire.SNACMessage{
- Body: wire.SNACError{},
- },
- },
- },
- },
- },
- },
- {
- name: "warn, ICBM svc returns unexpected snac type",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_evil them anon`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- evilRequestParams: evilRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x08_ICBMEvilRequest{
- SendAs: 1,
- ScreenName: "them",
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{},
- },
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "warn with incorrect type",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_evil them blah`),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_evil`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- icbmSvc := newMockICBMService(t)
- for _, params := range tc.mockParams.evilRequestParams {
- icbmSvc.EXPECT().
- EvilRequest(ctx, matchSession(params.me), wire.SNACFrame{}, params.inBody).
- Return(params.msg, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- ICBMService: icbmSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_ChangePassword(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully change password",
- me: newTestSession("me"),
- givenCmd: []byte("toc_change_passwd oldpa\\$\\$ newpa\\$\\$"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVOldPassword, "oldpa$$"),
- wire.NewTLVBE(wire.AdminTLVNewPassword, "newpa$$"),
- },
- },
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x07_0x05_AdminChangeReply{
- Permissions: wire.AdminInfoPermissionsReadWrite,
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVNewPassword, []byte{}),
- },
- },
- },
- },
- },
- },
- },
- },
- wantMsg: "ADMIN_PASSWD_STATUS:0",
- },
- {
- name: "change password - invalid password length",
- me: newTestSession("me"),
- givenCmd: []byte("toc_change_passwd oldpass np"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVOldPassword, "oldpass"),
- wire.NewTLVBE(wire.AdminTLVNewPassword, "np"),
- },
- },
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x07_0x05_AdminChangeReply{
- Permissions: wire.AdminInfoPermissionsReadWrite,
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVNewPassword, []byte{}),
- wire.NewTLVBE(wire.AdminTLVErrorCode, wire.AdminInfoErrorInvalidPasswordLength),
- },
- },
- },
- },
- },
- },
- },
- },
- wantMsg: "ERROR:911",
- },
- {
- name: "change password - incorrect password",
- me: newTestSession("me"),
- givenCmd: []byte("toc_change_passwd oldpass baddpass"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVOldPassword, "oldpass"),
- wire.NewTLVBE(wire.AdminTLVNewPassword, "baddpass"),
- },
- },
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x07_0x05_AdminChangeReply{
- Permissions: wire.AdminInfoPermissionsReadWrite,
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVNewPassword, []byte{}),
- wire.NewTLVBE(wire.AdminTLVErrorCode, wire.AdminInfoErrorValidatePassword),
- },
- },
- },
- },
- },
- },
- },
- },
- wantMsg: "ERROR:912",
- },
- {
- name: "change password - catch-all error response",
- me: newTestSession("me"),
- givenCmd: []byte("toc_change_passwd oldpass baddpass"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVOldPassword, "oldpass"),
- wire.NewTLVBE(wire.AdminTLVNewPassword, "baddpass"),
- },
- },
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x07_0x05_AdminChangeReply{
- Permissions: wire.AdminInfoPermissionsReadWrite,
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVNewPassword, []byte{}),
- wire.NewTLVBE(wire.AdminTLVErrorCode, wire.AdminInfoErrorAllOtherErrors),
- },
- },
- },
- },
- },
- },
- },
- },
- wantMsg: "ERROR:913",
- },
- {
- name: "change password - runtime error from admin svc",
- me: newTestSession("me"),
- givenCmd: []byte("toc_change_passwd oldpass baddpass"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVOldPassword, "oldpass"),
- wire.NewTLVBE(wire.AdminTLVNewPassword, "baddpass"),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "change password - unexpected response from admin svc",
- me: newTestSession("me"),
- givenCmd: []byte("toc_change_passwd oldpass baddpass"),
- mockParams: mockParams{
- adminParams: adminParams{
- infoChangeRequestParams: infoChangeRequestParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x07_0x04_AdminInfoChangeRequest{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.AdminTLVOldPassword, "oldpass"),
- wire.NewTLVBE(wire.AdminTLVNewPassword, "baddpass"),
- },
- },
- },
- msg: wire.SNACMessage{
- Body: wire.SNACError{},
- },
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_change_passwd`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- adminSvc := newMockAdminService(t)
- for _, params := range tc.mockParams.infoChangeRequestParams {
- adminSvc.EXPECT().
- InfoChangeRequest(ctx, matchSession(params.me), wire.SNACFrame{}, params.inBody).
- Return(params.msg, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- AdminService: adminSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_GetDirSearchURL(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully request user info",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_dir_search "first \[name\]":"middle name":"last name":"maiden name":"city":"state":"country":"email"`),
- mockParams: mockParams{
- cookieBakerParams: cookieBakerParams{
- issueParams: issueParams{
- {
- data: []byte("me"),
- returnData: []byte("monster"),
- },
- },
- },
- },
- wantMsg: "GOTO_URL:search results:dir_search?city=city&cookie=6d6f6e73746572&country=country&email=email&first_name=first+%5Bname%5D&last_name=last+name&maiden_name=maiden+name&middle_name=middle+name&state=state",
- },
- {
- name: "successfully request user info by keywords",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_dir_search ::::::::::"searchkw"`),
- mockParams: mockParams{
- cookieBakerParams: cookieBakerParams{
- issueParams: issueParams{
- {
- data: []byte("me"),
- returnData: []byte("monster"),
- },
- },
- },
- },
- wantMsg: "GOTO_URL:search results:dir_search?cookie=6d6f6e73746572&keyword=searchkw",
- },
- {
- name: "request user info with too many params",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_dir_search ::::::::::::::::::::"searchkw"`),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "request user info, get cookie issue error",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_dir_search them`),
- mockParams: mockParams{
- cookieBakerParams: cookieBakerParams{
- issueParams: issueParams{
- {
- data: []byte("me"),
- returnErr: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_dir_search`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- cookieBaker := newMockCookieBaker(t)
- for _, params := range tc.mockParams.issueParams {
- cookieBaker.EXPECT().
- Issue(params.data).
- Return(params.returnData, params.returnErr)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- CookieBaker: cookieBaker,
- SNACRateLimits: wire.DefaultSNACRateLimits(),
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_GetDirURL(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully request user dir info",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_get_dir them`),
- mockParams: mockParams{
- cookieBakerParams: cookieBakerParams{
- issueParams: issueParams{
- {
- data: []byte("me"),
- returnData: []byte("monster"),
- },
- },
- },
- },
- wantMsg: "GOTO_URL:directory info:dir_info?cookie=6d6f6e73746572&user=them",
- },
- {
- name: "request user info, get cookie issue error",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_get_dir them`),
- mockParams: mockParams{
- cookieBakerParams: cookieBakerParams{
- issueParams: issueParams{
- {
- data: []byte("me"),
- returnErr: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_get_dir`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- cookieBaker := newMockCookieBaker(t)
- for _, params := range tc.mockParams.issueParams {
- cookieBaker.EXPECT().
- Issue(params.data).
- Return(params.returnData, params.returnErr)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- CookieBaker: cookieBaker,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_GetInfoURL(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully request user info",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_get_info them`),
- mockParams: mockParams{
- cookieBakerParams: cookieBakerParams{
- issueParams: issueParams{
- {
- data: []byte("me"),
- returnData: []byte("monster"),
- },
- },
- },
- },
- wantMsg: "GOTO_URL:profile:info?cookie=6d6f6e73746572&from=me&user=them",
- },
- {
- name: "request user info, get cookie issue error",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_get_info them`),
- mockParams: mockParams{
- cookieBakerParams: cookieBakerParams{
- issueParams: issueParams{
- {
- data: []byte("me"),
- returnErr: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_get_info`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- cookieBaker := newMockCookieBaker(t)
- for _, params := range tc.mockParams.issueParams {
- cookieBaker.EXPECT().
- Issue(params.data).
- Return(params.returnData, params.returnErr)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- CookieBaker: cookieBaker,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_GetStatus(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully request status",
- me: newTestSession("me"),
- givenCmd: []byte("toc_get_status them"),
- mockParams: mockParams{
- locateParams: locateParams{
- userInfoQueryParams: userInfoQueryParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x05_LocateUserInfoQuery{
- ScreenName: "them",
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x02_0x06_LocateUserInfoReply{
- TLVUserInfo: wire.TLVUserInfo{
- ScreenName: "them",
- WarningLevel: 0,
- TLVBlock: wire.TLVBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.OServiceUserInfoSignonTOD, uint32(1234)),
- wire.NewTLVBE(wire.OServiceUserInfoIdleTime, uint16(5678)),
- },
- },
- },
- },
- },
- },
- },
- },
- },
- wantMsg: "UPDATE_BUDDY:them:T:0:1234:5678: O ",
- },
- {
- name: "request status, receive err from locate svc",
- me: newTestSession("me"),
- givenCmd: []byte("toc_get_status them"),
- mockParams: mockParams{
- locateParams: locateParams{
- userInfoQueryParams: userInfoQueryParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x05_LocateUserInfoQuery{
- ScreenName: "them",
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "request status, user not online",
- me: newTestSession("me"),
- givenCmd: []byte("toc_get_status them"),
- mockParams: mockParams{
- locateParams: locateParams{
- userInfoQueryParams: userInfoQueryParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x05_LocateUserInfoQuery{
- ScreenName: "them",
- },
- msg: wire.SNACMessage{
- Body: wire.SNACError{
- Code: wire.ErrorCodeNotLoggedOn,
- },
- },
- },
- },
- },
- },
- wantMsg: "ERROR:901:them",
- },
- {
- name: "request status, receive unexpected error code",
- me: newTestSession("me"),
- givenCmd: []byte("toc_get_status them"),
- mockParams: mockParams{
- locateParams: locateParams{
- userInfoQueryParams: userInfoQueryParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x05_LocateUserInfoQuery{
- ScreenName: "them",
- },
- msg: wire.SNACMessage{
- Body: wire.SNACError{
- Code: wire.ErrorCodeInvalidSnac,
- },
- },
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "request status, unexpected response from locate svc",
- me: newTestSession("me"),
- givenCmd: []byte("toc_get_status them"),
- mockParams: mockParams{
- locateParams: locateParams{
- userInfoQueryParams: userInfoQueryParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x05_LocateUserInfoQuery{
- ScreenName: "them",
- },
- msg: wire.SNACMessage{
- Body: wire.SNAC_0x0E_0x04_ChatUsersLeft{},
- },
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_get_status`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- locateSvc := newMockLocateService(t)
- for _, params := range tc.mockParams.userInfoQueryParams {
- locateSvc.EXPECT().
- UserInfoQuery(mock.Anything, matchSession(params.me), wire.SNACFrame{}, params.inBody).
- Return(params.msg, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- LocateService: locateSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_InitDone(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully initialize connection",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_init_done`),
- mockParams: mockParams{
- oServiceBOSParams: oServiceParams{
- clientOnlineParams: clientOnlineParams{
- {
- me: state.NewIdentScreenName("me"),
- body: wire.SNAC_0x01_0x02_OServiceClientOnline{},
- },
- },
- },
- },
- },
- {
- name: "initialize connection, receive err from BOS oservice svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_init_done`),
- mockParams: mockParams{
- oServiceBOSParams: oServiceParams{
- clientOnlineParams: clientOnlineParams{
- {
- me: state.NewIdentScreenName("me"),
- body: wire.SNAC_0x01_0x02_OServiceClientOnline{},
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- oSvc := newMockOServiceService(t)
- for _, params := range tc.mockParams.oServiceBOSParams.clientOnlineParams {
- oSvc.EXPECT().
- ClientOnline(ctx, params.body, matchSession(params.me)).
- Return(params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- OServiceServiceBOS: oSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_RemoveBuddy(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully remove buddies",
- me: newTestSession("me"),
- givenCmd: []byte("toc_remove_buddy friend1 friend2 friend3"),
- mockParams: mockParams{
- buddyParams: buddyParams{
- delBuddiesParams: delBuddiesParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x03_0x05_BuddyDelBuddies{
- Buddies: []struct {
- ScreenName string `oscar:"len_prefix=uint8"`
- }{
- {ScreenName: "friend1"},
- {ScreenName: "friend2"},
- {ScreenName: "friend3"},
- },
- },
- },
- },
- },
- },
- },
- {
- name: "remove buddies with empty list",
- me: newTestSession("me"),
- givenCmd: []byte("toc_remove_buddy"),
- mockParams: mockParams{
- buddyParams: buddyParams{
- delBuddiesParams: delBuddiesParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x03_0x05_BuddyDelBuddies{},
- },
- },
- },
- },
- },
- {
- name: "remove buddies, receive error from buddy service",
- me: newTestSession("me"),
- givenCmd: []byte("toc_remove_buddy friend1"),
- mockParams: mockParams{
- buddyParams: buddyParams{
- delBuddiesParams: delBuddiesParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x03_0x05_BuddyDelBuddies{
- Buddies: []struct {
- ScreenName string `oscar:"len_prefix=uint8"`
- }{
- {ScreenName: "friend1"},
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- buddySvc := newMockBuddyService(t)
- for _, params := range tc.mockParams.delBuddiesParams {
- buddySvc.EXPECT().
- DelBuddies(ctx, matchSession(params.me), params.inBody).
- Return(params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- BuddyService: buddySvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_RvousAccept(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully send rendezvous request",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_rvous_accept them aGFoYWhhaGE= 09461343-4C7F-11D1-8222-444553540000`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- channelMsgToHostParamsICBM: channelMsgToHostParamsICBM{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelRendezvous,
- ScreenName: "them",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessageAccept,
- Cookie: [8]byte{'h', 'a', 'h', 'a', 'h', 'a', 'h', 'a'},
- Capability: wire.CapFileTransfer,
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "send rendezvous request, receive error from ICBM service",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_rvous_accept them aGFoYWhhaGE= 09461343-4C7F-11D1-8222-444553540000`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- channelMsgToHostParamsICBM: channelMsgToHostParamsICBM{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelRendezvous,
- ScreenName: "them",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessageAccept,
- Cookie: [8]byte{'h', 'a', 'h', 'a', 'h', 'a', 'h', 'a'},
- Capability: wire.CapFileTransfer,
- }),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_rvous_accept`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- icbmSvc := newMockICBMService(t)
- for _, params := range tc.mockParams.channelMsgToHostParamsICBM {
- icbmSvc.EXPECT().
- ChannelMsgToHost(ctx, matchSession(params.sender), params.inFrame, params.inBody).
- Return(params.result, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- ICBMService: icbmSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_RvousCancel(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully send rendezvous cancellation",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_rvous_cancel them aGFoYWhhaGE= 09461343-4C7F-11D1-8222-444553540000`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- channelMsgToHostParamsICBM: channelMsgToHostParamsICBM{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelRendezvous,
- ScreenName: "them",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessageCancel,
- Cookie: [8]byte{'h', 'a', 'h', 'a', 'h', 'a', 'h', 'a'},
- Capability: wire.CapFileTransfer,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMRdvTLVTagsCancelReason, wire.ICBMRdvCancelReasonsUserCancel),
- },
- },
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "send rendezvous cancellation, receive error from ICBM service",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_rvous_cancel them aGFoYWhhaGE= 09461343-4C7F-11D1-8222-444553540000`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- channelMsgToHostParamsICBM: channelMsgToHostParamsICBM{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelRendezvous,
- ScreenName: "them",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVData, wire.ICBMCh2Fragment{
- Type: wire.ICBMRdvMessageCancel,
- Cookie: [8]byte{'h', 'a', 'h', 'a', 'h', 'a', 'h', 'a'},
- Capability: wire.CapFileTransfer,
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMRdvTLVTagsCancelReason, wire.ICBMRdvCancelReasonsUserCancel),
- },
- },
- }),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_rvous_cancel`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- icbmSvc := newMockICBMService(t)
- for _, params := range tc.mockParams.channelMsgToHostParamsICBM {
- icbmSvc.EXPECT().
- ChannelMsgToHost(ctx, matchSession(params.sender), params.inFrame, params.inBody).
- Return(params.result, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- ICBMService: icbmSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_SendIM(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully send instant message",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_send_im chattingChuck "hello world! :\)"`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- channelMsgToHostParamsICBM: channelMsgToHostParamsICBM{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "chattingChuck",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVAOLIMData, []wire.ICBMCh1Fragment{
- {
- ID: 5,
- Version: 1,
- Payload: []byte{1, 1, 2},
- },
- {
- ID: 1,
- Version: 1,
- Payload: []byte{
- 0x00, 0x00,
- 0x00, 0x00,
- 'h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd', '!', ' ', ':', ')',
- },
- },
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "successfully auto-reply send instant message",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_send_im chattingChuck "hello world!" auto`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- channelMsgToHostParamsICBM: channelMsgToHostParamsICBM{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "chattingChuck",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVAOLIMData, []wire.ICBMCh1Fragment{
- {
- ID: 5,
- Version: 1,
- Payload: []byte{1, 1, 2},
- },
- {
- ID: 1,
- Version: 1,
- Payload: []byte{
- 0x00, 0x00,
- 0x00, 0x00,
- 'h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd', '!',
- },
- },
- }),
- wire.NewTLVBE(wire.ICBMTLVAutoResponse, []byte{}),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "send instant message, receive error from ICBM service",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_send_im chattingChuck "hello world!"`),
- mockParams: mockParams{
- icbmParams: icbmParams{
- channelMsgToHostParamsICBM: channelMsgToHostParamsICBM{
- {
- sender: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x04_0x06_ICBMChannelMsgToHost{
- ChannelID: wire.ICBMChannelIM,
- ScreenName: "chattingChuck",
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ICBMTLVAOLIMData, []wire.ICBMCh1Fragment{
- {
- ID: 5,
- Version: 1,
- Payload: []byte{1, 1, 2},
- },
- {
- ID: 1,
- Version: 1,
- Payload: []byte{
- 0x00, 0x00,
- 0x00, 0x00,
- 'h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd', '!',
- },
- },
- }),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_send_im`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- icbmSvc := newMockICBMService(t)
- for _, params := range tc.mockParams.channelMsgToHostParamsICBM {
- icbmSvc.EXPECT().
- ChannelMsgToHost(ctx, matchSession(params.sender), params.inFrame, params.inBody).
- Return(params.result, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- ICBMService: icbmSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_SetAway(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully set away with message",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_away "I'm away from my computer right now. :\)"`),
- mockParams: mockParams{
- locateParams: locateParams{
- setInfoParams: setInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x04_LocateSetInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LocateTLVTagsInfoUnavailableData, "I'm away from my computer right now. :)"),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "successfully set away without message",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_away`),
- mockParams: mockParams{
- locateParams: locateParams{
- setInfoParams: setInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x04_LocateSetInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LocateTLVTagsInfoUnavailableData, ""),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "set away message, receive error from locate service",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_away "I'm away from my computer right now."`),
- mockParams: mockParams{
- locateParams: locateParams{
- setInfoParams: setInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x04_LocateSetInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LocateTLVTagsInfoUnavailableData, "I'm away from my computer right now."),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- locateSvc := newMockLocateService(t)
- for _, params := range tc.mockParams.setInfoParams {
- locateSvc.EXPECT().
- SetInfo(ctx, matchSession(params.me), params.inBody).
- Return(params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- LocateService: locateSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_SetCaps(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully set capabilities",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_caps 09460000-4C7F-11D1-8222-444553540000 09460001-4C7F-11D1-8222-444553540000`),
- mockParams: mockParams{
- locateParams: locateParams{
- setInfoParams: setInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x04_LocateSetInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LocateTLVTagsInfoCapabilities, []uuid.UUID{
- uuid.MustParse("09460000-4C7F-11D1-8222-444553540000"),
- uuid.MustParse("09460001-4C7F-11D1-8222-444553540000"),
- wire.CapChat,
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "set capabilities with empty list",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_caps`),
- mockParams: mockParams{
- locateParams: locateParams{
- setInfoParams: setInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x04_LocateSetInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LocateTLVTagsInfoCapabilities, []uuid.UUID{
- wire.CapChat,
- }),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "set capability, receive error from locate service",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_caps 09460000-4C7F-11D1-8222-444553540000`),
- mockParams: mockParams{
- locateParams: locateParams{
- setInfoParams: setInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x04_LocateSetInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LocateTLVTagsInfoCapabilities, []uuid.UUID{
- uuid.MustParse("09460000-4C7F-11D1-8222-444553540000"),
- wire.CapChat,
- }),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "set malformed capability UUID",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_caps 09460000-`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- locateSvc := newMockLocateService(t)
- for _, params := range tc.mockParams.setInfoParams {
- locateSvc.EXPECT().
- SetInfo(ctx, matchSession(params.me), params.inBody).
- Return(params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- LocateService: locateSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_SetConfig(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully set permit all config (unquoted)",
- me: newTestSession("me"),
- givenCmd: []byte("toc_set_config {m 1\ng Buddies\nb friend1\nb friend2\n}\n"),
- mockParams: mockParams{
- tocConfigParams: tocConfigParams{
- setTOCConfigParams: setTOCConfigParams{
- {
- user: state.NewIdentScreenName("me"),
- config: "{m 1\ng Buddies\nb friend1\nb friend2\n}\n",
- },
- },
- },
- },
- },
- {
- name: "successfully set permit all config (double-quoted)",
- me: newTestSession("me"),
- givenCmd: []byte("toc_set_config \"{m 1\ng Buddies\nb friend1\nb friend2\n}\n\""),
- mockParams: mockParams{
- tocConfigParams: tocConfigParams{
- setTOCConfigParams: setTOCConfigParams{
- {
- user: state.NewIdentScreenName("me"),
- config: "{m 1\ng Buddies\nb friend1\nb friend2\n}\n",
- },
- },
- },
- },
- },
- {
- name: "successfully set permit all config (single-quoted)",
- me: newTestSession("me"),
- givenCmd: []byte("toc_set_config '{m 1\ng Buddies\nb friend1\nb friend2\n}\n'"),
- mockParams: mockParams{
- tocConfigParams: tocConfigParams{
- setTOCConfigParams: setTOCConfigParams{
- {
- user: state.NewIdentScreenName("me"),
- config: "{m 1\ng Buddies\nb friend1\nb friend2\n}\n",
- },
- },
- },
- },
- },
- {
- name: "successfully set permit all config (double-quoted with spaces)",
- me: newTestSession("me"),
- givenCmd: []byte("toc_set_config \" {m 1\ng Buddies\nb friend1\nb friend2\n}\n \""),
- mockParams: mockParams{
- tocConfigParams: tocConfigParams{
- setTOCConfigParams: setTOCConfigParams{
- {
- user: state.NewIdentScreenName("me"),
- config: "{m 1\ng Buddies\nb friend1\nb friend2\n}\n",
- },
- },
- },
- },
- },
- {
- name: "set config, receive error from toc config store",
- me: newTestSession("me"),
- givenCmd: []byte("toc_set_config {m 1\ng Buddies\nb friend1\nb friend2\n}\n"),
- mockParams: mockParams{
- tocConfigParams: tocConfigParams{
- setTOCConfigParams: setTOCConfigParams{
- {
- user: state.NewIdentScreenName("me"),
- config: "{m 1\ng Buddies\nb friend1\nb friend2\n}\n",
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_config`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- pdSvc := newMockPermitDenyService(t)
- for _, params := range tc.mockParams.addDenyListEntriesParams {
- pdSvc.EXPECT().
- AddDenyListEntries(ctx, matchSession(params.me), params.body).
- Return(params.err)
- }
- for _, params := range tc.mockParams.addPermListEntriesParams {
- pdSvc.EXPECT().
- AddPermListEntries(ctx, matchSession(params.me), params.body).
- Return(params.err)
- }
- buddySvc := newMockBuddyService(t)
- for _, params := range tc.mockParams.addBuddiesParams {
- buddySvc.EXPECT().
- AddBuddies(ctx, matchSession(params.me), params.inBody).
- Return(params.err)
- }
- tocConfigSvc := newMockTOCConfigStore(t)
- for _, params := range tc.mockParams.setTOCConfigParams {
- tocConfigSvc.EXPECT().
- SetTOCConfig(matchContext(), params.user, params.config).
- Return(params.err)
- }
- svc := OSCARProxy{
- BuddyService: buddySvc,
- Logger: slog.Default(),
- PermitDenyService: pdSvc,
- TOCConfigStore: tocConfigSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_SetDir(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully set directory info with quoted fields",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_dir "first name\$":"middle name":"last name":"maiden name":"city":"state":"country":"email":"allow web searches"`),
- mockParams: mockParams{
- locateParams: locateParams{
- setDirInfoParams: setDirInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x09_LocateSetDirInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ODirTLVFirstName, "first name$"),
- wire.NewTLVBE(wire.ODirTLVMiddleName, "middle name"),
- wire.NewTLVBE(wire.ODirTLVLastName, "last name"),
- wire.NewTLVBE(wire.ODirTLVMaidenName, "maiden name"),
- wire.NewTLVBE(wire.ODirTLVCountry, "country"),
- wire.NewTLVBE(wire.ODirTLVState, "state"),
- wire.NewTLVBE(wire.ODirTLVCity, "city"),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "successfully set directory info with some blank fields",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_dir "first name"::"last name"::"city":"state":"country":"email":"allow web searches"`),
- mockParams: mockParams{
- locateParams: locateParams{
- setDirInfoParams: setDirInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x09_LocateSetDirInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ODirTLVFirstName, "first name"),
- wire.NewTLVBE(wire.ODirTLVMiddleName, ""),
- wire.NewTLVBE(wire.ODirTLVLastName, "last name"),
- wire.NewTLVBE(wire.ODirTLVMaidenName, ""),
- wire.NewTLVBE(wire.ODirTLVCountry, "country"),
- wire.NewTLVBE(wire.ODirTLVState, "state"),
- wire.NewTLVBE(wire.ODirTLVCity, "city"),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "successfully set directory info with last two fields absent",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_dir "first name"::"last name"::"city":"state":"country"`),
- mockParams: mockParams{
- locateParams: locateParams{
- setDirInfoParams: setDirInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x09_LocateSetDirInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ODirTLVFirstName, "first name"),
- wire.NewTLVBE(wire.ODirTLVMiddleName, ""),
- wire.NewTLVBE(wire.ODirTLVLastName, "last name"),
- wire.NewTLVBE(wire.ODirTLVMaidenName, ""),
- wire.NewTLVBE(wire.ODirTLVCountry, "country"),
- wire.NewTLVBE(wire.ODirTLVState, "state"),
- wire.NewTLVBE(wire.ODirTLVCity, "city"),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "set directory info, receive error from locate svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_dir "first name":"middle name":"last name":"maiden name":"city":"state":"country":"email":"allow web searches"`),
- mockParams: mockParams{
- locateParams: locateParams{
- setDirInfoParams: setDirInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x09_LocateSetDirInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.ODirTLVFirstName, "first name"),
- wire.NewTLVBE(wire.ODirTLVMiddleName, "middle name"),
- wire.NewTLVBE(wire.ODirTLVLastName, "last name"),
- wire.NewTLVBE(wire.ODirTLVMaidenName, "maiden name"),
- wire.NewTLVBE(wire.ODirTLVCountry, "country"),
- wire.NewTLVBE(wire.ODirTLVState, "state"),
- wire.NewTLVBE(wire.ODirTLVCity, "city"),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "set directory with too many fields present",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_dir "first name"::"last name"::"city":"state":"country":"email":"allow web searches":"extra":"extra"`),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_dir`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- locateSvc := newMockLocateService(t)
- for _, params := range tc.mockParams.setDirInfoParams {
- locateSvc.EXPECT().
- SetDirInfo(ctx, matchSession(params.me), wire.SNACFrame{}, params.inBody).
- Return(params.msg, params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- LocateService: locateSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_SetIdle(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully set idle status",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_idle 10`),
- mockParams: mockParams{
- oServiceBOSParams: oServiceParams{
- idleNotificationParams: idleNotificationParams{
- {
- me: state.NewIdentScreenName("me"),
- bodyIn: wire.SNAC_0x01_0x11_OServiceIdleNotification{
- IdleTime: uint32(10),
- },
- },
- },
- },
- },
- },
- {
- name: "set idle status, receive err from BOS oservice svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_idle 10`),
- mockParams: mockParams{
- oServiceBOSParams: oServiceParams{
- idleNotificationParams: idleNotificationParams{
- {
- me: state.NewIdentScreenName("me"),
- bodyIn: wire.SNAC_0x01_0x11_OServiceIdleNotification{
- IdleTime: uint32(10),
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad secs param",
- givenCmd: []byte(`toc_set_idle zero`),
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_idle`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- oServiceSvc := newMockOServiceService(t)
- for _, params := range tc.mockParams.oServiceBOSParams.idleNotificationParams {
- oServiceSvc.EXPECT().
- IdleNotification(ctx, matchSession(params.me), params.bodyIn).
- Return(params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- OServiceServiceBOS: oServiceSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_SetInfo(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully set profile",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_info "my profile! :\)"`),
- mockParams: mockParams{
- locateParams: locateParams{
- setInfoParams: setInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x04_LocateSetInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LocateTLVTagsInfoSigData, "my profile! :)"),
- },
- },
- },
- },
- },
- },
- },
- },
- {
- name: "set profile, receive error from locate svc",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_info "my profile!"`),
- mockParams: mockParams{
- locateParams: locateParams{
- setInfoParams: setInfoParams{
- {
- me: state.NewIdentScreenName("me"),
- inBody: wire.SNAC_0x02_0x04_LocateSetInfo{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LocateTLVTagsInfoSigData, "my profile!"),
- },
- },
- },
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: cmdInternalSvcErr,
- },
- {
- name: "bad command",
- me: newTestSession("me"),
- givenCmd: []byte(`toc_set_info`),
- wantMsg: cmdInternalSvcErr,
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- locateSvc := newMockLocateService(t)
- for _, params := range tc.mockParams.setInfoParams {
- locateSvc.EXPECT().
- SetInfo(ctx, matchSession(params.me), params.inBody).
- Return(params.err)
- }
- svc := OSCARProxy{
- Logger: slog.Default(),
- LocateService: locateSvc,
- }
- msg := svc.RecvClientCmd(ctx, tc.me, nil, tc.givenCmd, nil, nil)
- assert.Equal(t, tc.wantMsg, msg)
- })
- }
- }
- func TestOSCARProxy_Signon(t *testing.T) {
- roastedPass := wire.RoastTOCPassword([]byte("thepass"))
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenCmd is the TOC command
- givenCmd []byte
- // wantMsg is the expected TOC response
- wantMsg []string
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully login",
- me: newTestSession("me", func(session *state.Session) {
- session.SetCaps([][16]byte{wire.CapChat})
- }),
- givenCmd: []byte(`"" "" me "xx` + hex.EncodeToString(roastedPass) + `"`),
- mockParams: mockParams{
- authParams: authParams{
- flapLoginParams: flapLoginParams{
- {
- frame: wire.FLAPSignonFrame{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LoginTLVTagsScreenName, "me"),
- wire.NewTLVBE(wire.LoginTLVTagsRoastedTOCPassword, roastedPass),
- },
- },
- },
- newUserFn: state.NewStubUser,
- tlv: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, []byte("thecookie")),
- },
- },
- },
- },
- registerBOSSessionParams: registerBOSSessionParams{
- {
- authCookie: []byte("thecookie"),
- sess: newTestSession("me"),
- },
- },
- },
- buddyListRegistryParams: buddyListRegistryParams{
- registerBuddyListParams: registerBuddyListParams{
- {
- user: state.NewIdentScreenName("me"),
- },
- },
- },
- tocConfigParams: tocConfigParams{
- userParams: userParams{
- {
- screenName: state.NewIdentScreenName("me"),
- returnedUser: &state.User{
- TOCConfig: "my-toc-config",
- },
- },
- },
- },
- },
- wantMsg: []string{"SIGN_ON:TOC1.0", "CONFIG:my-toc-config"},
- },
- {
- name: "login, receive error from auth svc FLAP login",
- givenCmd: []byte(`"" "" me "xx` + hex.EncodeToString(roastedPass) + `"`),
- mockParams: mockParams{
- authParams: authParams{
- flapLoginParams: flapLoginParams{
- {
- frame: wire.FLAPSignonFrame{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LoginTLVTagsScreenName, "me"),
- wire.NewTLVBE(wire.LoginTLVTagsRoastedTOCPassword, roastedPass),
- },
- },
- },
- newUserFn: state.NewStubUser,
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: []string{cmdInternalSvcErr},
- },
- {
- name: "login, receive error from auth svc registration",
- givenCmd: []byte(`"" "" me "xx` + hex.EncodeToString(roastedPass) + `"`),
- mockParams: mockParams{
- authParams: authParams{
- flapLoginParams: flapLoginParams{
- {
- frame: wire.FLAPSignonFrame{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LoginTLVTagsScreenName, "me"),
- wire.NewTLVBE(wire.LoginTLVTagsRoastedTOCPassword, roastedPass),
- },
- },
- },
- newUserFn: state.NewStubUser,
- tlv: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, []byte("thecookie")),
- },
- },
- },
- },
- registerBOSSessionParams: registerBOSSessionParams{
- {
- authCookie: []byte("thecookie"),
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: []string{cmdInternalSvcErr},
- },
- {
- name: "login, receive error from buddy list registry",
- givenCmd: []byte(`"" "" me "xx` + hex.EncodeToString(roastedPass) + `"`),
- mockParams: mockParams{
- authParams: authParams{
- flapLoginParams: flapLoginParams{
- {
- frame: wire.FLAPSignonFrame{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LoginTLVTagsScreenName, "me"),
- wire.NewTLVBE(wire.LoginTLVTagsRoastedTOCPassword, roastedPass),
- },
- },
- },
- newUserFn: state.NewStubUser,
- tlv: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, []byte("thecookie")),
- },
- },
- },
- },
- registerBOSSessionParams: registerBOSSessionParams{
- {
- authCookie: []byte("thecookie"),
- sess: newTestSession("me"),
- },
- },
- },
- buddyListRegistryParams: buddyListRegistryParams{
- registerBuddyListParams: registerBuddyListParams{
- {
- user: state.NewIdentScreenName("me"),
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: []string{cmdInternalSvcErr},
- },
- {
- name: "login, receive error from TOC config store",
- givenCmd: []byte(`"" "" me "xx` + hex.EncodeToString(roastedPass) + `"`),
- mockParams: mockParams{
- authParams: authParams{
- flapLoginParams: flapLoginParams{
- {
- frame: wire.FLAPSignonFrame{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LoginTLVTagsScreenName, "me"),
- wire.NewTLVBE(wire.LoginTLVTagsRoastedTOCPassword, roastedPass),
- },
- },
- },
- newUserFn: state.NewStubUser,
- tlv: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, []byte("thecookie")),
- },
- },
- },
- },
- registerBOSSessionParams: registerBOSSessionParams{
- {
- authCookie: []byte("thecookie"),
- sess: newTestSession("me"),
- },
- },
- },
- buddyListRegistryParams: buddyListRegistryParams{
- registerBuddyListParams: registerBuddyListParams{
- {
- user: state.NewIdentScreenName("me"),
- },
- },
- },
- tocConfigParams: tocConfigParams{
- userParams: userParams{
- {
- screenName: state.NewIdentScreenName("me"),
- err: io.EOF,
- },
- },
- },
- },
- wantMsg: []string{cmdInternalSvcErr},
- },
- {
- name: "login, user not found after login",
- givenCmd: []byte(`"" "" me "xx` + hex.EncodeToString(roastedPass) + `"`),
- mockParams: mockParams{
- authParams: authParams{
- flapLoginParams: flapLoginParams{
- {
- frame: wire.FLAPSignonFrame{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LoginTLVTagsScreenName, "me"),
- wire.NewTLVBE(wire.LoginTLVTagsRoastedTOCPassword, roastedPass),
- },
- },
- },
- newUserFn: state.NewStubUser,
- tlv: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.OServiceTLVTagsLoginCookie, []byte("thecookie")),
- },
- },
- },
- },
- registerBOSSessionParams: registerBOSSessionParams{
- {
- authCookie: []byte("thecookie"),
- sess: newTestSession("me"),
- },
- },
- },
- buddyListRegistryParams: buddyListRegistryParams{
- registerBuddyListParams: registerBuddyListParams{
- {
- user: state.NewIdentScreenName("me"),
- },
- },
- },
- tocConfigParams: tocConfigParams{
- userParams: userParams{
- {
- screenName: state.NewIdentScreenName("me"),
- returnedUser: nil,
- },
- },
- },
- },
- wantMsg: []string{cmdInternalSvcErr},
- },
- {
- name: "login with bad credentials",
- givenCmd: []byte(`"" "" me "xx` + hex.EncodeToString(roastedPass) + `"`),
- mockParams: mockParams{
- authParams: authParams{
- flapLoginParams: flapLoginParams{
- {
- frame: wire.FLAPSignonFrame{
- TLVRestBlock: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LoginTLVTagsScreenName, "me"),
- wire.NewTLVBE(wire.LoginTLVTagsRoastedTOCPassword, roastedPass),
- },
- },
- },
- newUserFn: state.NewStubUser,
- tlv: wire.TLVRestBlock{
- TLVList: wire.TLVList{
- wire.NewTLVBE(wire.LoginTLVTagsErrorSubcode, wire.LoginErrInvalidUsernameOrPassword),
- },
- },
- },
- },
- },
- },
- wantMsg: []string{"ERROR:980"},
- },
- {
- name: "bad command",
- givenCmd: []byte(`"" ""`),
- wantMsg: []string{cmdInternalSvcErr},
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- authSvc := newMockAuthService(t)
- for _, params := range tc.mockParams.flapLoginParams {
- authSvc.EXPECT().
- FLAPLogin(matchContext(), params.frame, mock.Anything).
- Return(params.tlv, params.err)
- }
- for _, params := range tc.mockParams.registerBOSSessionParams {
- authSvc.EXPECT().
- RegisterBOSSession(matchContext(), params.authCookie).
- Return(params.sess, params.err)
- }
- buddyRegistry := newMockBuddyListRegistry(t)
- for _, params := range tc.mockParams.registerBuddyListParams {
- buddyRegistry.EXPECT().
- RegisterBuddyList(matchContext(), params.user).
- Return(params.err)
- }
- tocCfg := newMockTOCConfigStore(t)
- for _, params := range tc.mockParams.userParams {
- tocCfg.EXPECT().
- User(matchContext(), params.screenName).
- Return(params.returnedUser, params.err)
- }
- svc := OSCARProxy{
- AuthService: authSvc,
- BuddyListRegistry: buddyRegistry,
- Logger: slog.Default(),
- TOCConfigStore: tocCfg,
- }
- sess, msg := svc.Signon(ctx, tc.givenCmd)
- assert.Equal(t, tc.wantMsg, msg)
- if tc.me == nil {
- assert.Nil(t, sess)
- } else if assert.NotNil(t, sess) {
- assert.Equal(t, tc.me.IdentScreenName(), sess.IdentScreenName())
- assert.Equal(t, tc.me.Caps(), sess.Caps())
- }
- })
- }
- }
- func TestOSCARProxy_Signout(t *testing.T) {
- cases := []struct {
- // name is the unit test name
- name string
- // me is the TOC user session
- me *state.Session
- // givenChatRegistry is the chat registry passed to the function
- chatRegistry *ChatRegistry
- // mockParams is the list of params sent to mocks that satisfy this
- // method's dependencies
- mockParams mockParams
- }{
- {
- name: "successfully sign out",
- me: newTestSession("me"),
- chatRegistry: func() *ChatRegistry {
- cr := NewChatRegistry()
- s1 := state.NewSession()
- s1.SetIdentScreenName(state.NewIdentScreenName("me1"))
- cr.RegisterSess(0, s1)
- s2 := state.NewSession()
- s2.SetIdentScreenName(state.NewIdentScreenName("me2"))
- cr.RegisterSess(1, s2)
- return cr
- }(),
- mockParams: mockParams{
- buddyParams: buddyParams{
- broadcastBuddyDepartedParams: broadcastBuddyDepartedParams{
- {
- me: state.NewIdentScreenName("me"),
- },
- },
- },
- buddyListRegistryParams: buddyListRegistryParams{
- unregisterBuddyListParams: unregisterBuddyListParams{
- {
- user: state.NewIdentScreenName("me"),
- },
- },
- },
- authParams: authParams{
- signoutParams: signoutParams{
- {
- me: state.NewIdentScreenName("me"),
- },
- },
- signoutChatParams: signoutChatParams{
- {
- me: state.NewIdentScreenName("me1"),
- },
- {
- me: state.NewIdentScreenName("me2"),
- },
- },
- },
- },
- },
- {
- name: "sign out, receive error from buddy service",
- me: newTestSession("me"),
- chatRegistry: func() *ChatRegistry {
- return NewChatRegistry()
- }(),
- mockParams: mockParams{
- buddyParams: buddyParams{
- broadcastBuddyDepartedParams: broadcastBuddyDepartedParams{
- {
- me: state.NewIdentScreenName("me"),
- err: io.EOF,
- },
- },
- },
- buddyListRegistryParams: buddyListRegistryParams{
- unregisterBuddyListParams: unregisterBuddyListParams{
- {
- user: state.NewIdentScreenName("me"),
- },
- },
- },
- authParams: authParams{
- signoutParams: signoutParams{
- {
- me: state.NewIdentScreenName("me"),
- },
- },
- },
- },
- },
- {
- name: "sign out, receive error from buddy list registry",
- me: newTestSession("me"),
- chatRegistry: func() *ChatRegistry {
- return NewChatRegistry()
- }(),
- mockParams: mockParams{
- buddyParams: buddyParams{
- broadcastBuddyDepartedParams: broadcastBuddyDepartedParams{
- {
- me: state.NewIdentScreenName("me"),
- },
- },
- },
- buddyListRegistryParams: buddyListRegistryParams{
- unregisterBuddyListParams: unregisterBuddyListParams{
- {
- user: state.NewIdentScreenName("me"),
- err: io.EOF,
- },
- },
- },
- authParams: authParams{
- signoutParams: signoutParams{
- {
- me: state.NewIdentScreenName("me"),
- },
- },
- },
- },
- },
- }
- for _, tc := range cases {
- t.Run(tc.name, func(t *testing.T) {
- ctx := context.Background()
- buddySvc := newMockBuddyService(t)
- for _, params := range tc.mockParams.broadcastBuddyDepartedParams {
- buddySvc.EXPECT().
- BroadcastBuddyDeparted(ctx, matchSession(params.me)).
- Return(params.err)
- }
- buddyListSvc := newMockBuddyListRegistry(t)
- for _, params := range tc.mockParams.unregisterBuddyListParams {
- buddyListSvc.EXPECT().
- UnregisterBuddyList(matchContext(), params.user).
- Return(params.err)
- }
- authSvc := newMockAuthService(t)
- for _, params := range tc.mockParams.signoutParams {
- authSvc.EXPECT().Signout(ctx, matchSession(params.me))
- }
- for _, params := range tc.mockParams.signoutChatParams {
- authSvc.EXPECT().SignoutChat(ctx, matchSession(params.me))
- }
- svc := OSCARProxy{
- AuthService: authSvc,
- BuddyListRegistry: buddyListSvc,
- BuddyService: buddySvc,
- Logger: slog.Default(),
- }
- svc.Signout(ctx, tc.me, tc.chatRegistry)
- })
- }
- }
- func TestOSCARProxy_RecvClientCmd_UnknownCmd(t *testing.T) {
- ctx := context.Background()
- svc := OSCARProxy{
- Logger: slog.Default(),
- }
- cmd := []byte("toc_unknown_cmd")
- msg := svc.RecvClientCmd(ctx, nil, nil, cmd, nil, nil)
- assert.Equal(t, cmdInternalSvcErr, msg)
- }
- func Test_parseArgs(t *testing.T) {
- type testCase struct {
- name string
- givenPayload string
- givenArgs []*string
- wantVarArgs []string
- wantArgs []string
- wantErrMsg string
- }
- tests := []testCase{
- {
- name: "no positional args or varargs",
- givenPayload: ``,
- givenArgs: nil,
- wantVarArgs: []string{},
- },
- {
- name: "positional args with varargs",
- givenPayload: `1234 "Join me!" user1 user2 user3`,
- givenArgs: []*string{new(string), new(string)},
- wantVarArgs: []string{"user1", "user2", "user3"},
- wantArgs: []string{"1234", "Join me!"},
- },
- {
- name: "nil positional argument placeholders should get skipped",
- givenPayload: `1234 "Join me!" user1 user2 user3`,
- givenArgs: []*string{nil, nil}, // still 2 placeholders, both nil
- wantVarArgs: []string{"user1", "user2", "user3"},
- wantArgs: []string{"", ""},
- },
- {
- name: "positional args with no varargs",
- givenPayload: `1234 "Join me!"`,
- givenArgs: []*string{new(string), new(string)}, // roomID + msg
- wantVarArgs: []string{},
- wantArgs: []string{"1234", "Join me!"},
- },
- {
- name: "varargs only",
- givenPayload: `user1 user2 user3`,
- givenArgs: nil,
- wantVarArgs: []string{"user1", "user2", "user3"},
- },
- {
- name: "too many positional arg placeholders",
- givenPayload: `toc_chat_invite`,
- givenArgs: []*string{new(string), new(string)},
- wantVarArgs: []string{},
- wantErrMsg: "command contains fewer arguments than expected",
- },
- {
- name: "CSV parser error",
- givenPayload: ``,
- givenArgs: []*string{nil},
- wantVarArgs: []string{},
- wantErrMsg: "CSV reader error",
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- varArgs, err := parseArgs([]byte(tt.givenPayload), tt.givenArgs...)
- if tt.wantErrMsg != "" {
- assert.ErrorContains(t, err, tt.wantErrMsg)
- return
- }
- assert.NoError(t, err)
- // verify the placeholder pointers got populated
- for i, want := range tt.wantArgs {
- if want == "" {
- assert.Nil(t, tt.givenArgs[i])
- } else {
- got := *tt.givenArgs[i]
- assert.Equal(t, want, got)
- }
- }
- // verify we have the same varargs
- assert.Equal(t, tt.wantVarArgs, varArgs)
- assert.Equal(t, len(tt.wantArgs), len(tt.givenArgs))
- })
- }
- }
- // TestUnescape tests the unescape function
- func TestUnescape(t *testing.T) {
- tests := []struct {
- name string
- input string
- expected string
- }{
- {"No Escapes", "Hello World", "Hello World"},
- {"Escaped Brace", "Hello \\{World\\}", "Hello {World}"},
- {"Escaped Parentheses", "Test\\(123\\)", "Test(123)"},
- {"Escaped Brackets", "\\[List\\]", "[List]"},
- {"Escaped Dollar", "Price: \\$100", "Price: $100"},
- {"Escaped Quote", "She said \\\"Hello\\\"", "She said \"Hello\""},
- {"Multiple Escapes", "One\\, Two\\, Three", "One, Two, Three"},
- {"Consecutive Escapes", "\\\\\\$100", "\\$100"},
- {"Only Escape Character", "\\", ""},
- {"Empty Input", "", ""},
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- result := unescape(tt.input)
- if result != tt.expected {
- t.Errorf("unescape(%q) = %q; want %q", tt.input, result, tt.expected)
- }
- })
- }
- }
|