1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642 |
- #!/usr/bin/env python3
- # Copyright (c) 2012 The Chromium Authors. All rights reserved.
- # Use of this source code is governed by a BSD-style license that can be
- # found in the LICENSE file.
- import io
- import os.path
- import subprocess
- import unittest
- import PRESUBMIT
- from PRESUBMIT_test_mocks import MockFile, MockAffectedFile
- from PRESUBMIT_test_mocks import MockInputApi, MockOutputApi
- _TEST_DATA_DIR = 'base/test/data/presubmit'
- class VersionControlConflictsTest(unittest.TestCase):
- def testTypicalConflict(self):
- lines = ['<<<<<<< HEAD',
- ' base::ScopedTempDir temp_dir_;',
- '=======',
- ' ScopedTempDir temp_dir_;',
- '>>>>>>> master']
- errors = PRESUBMIT._CheckForVersionControlConflictsInFile(
- MockInputApi(), MockFile('some/path/foo_platform.cc', lines))
- self.assertEqual(3, len(errors))
- self.assertTrue('1' in errors[0])
- self.assertTrue('3' in errors[1])
- self.assertTrue('5' in errors[2])
- def testIgnoresReadmes(self):
- lines = ['A First Level Header',
- '====================',
- '',
- 'A Second Level Header',
- '---------------------']
- errors = PRESUBMIT._CheckForVersionControlConflictsInFile(
- MockInputApi(), MockFile('some/polymer/README.md', lines))
- self.assertEqual(0, len(errors))
- class BadExtensionsTest(unittest.TestCase):
- def testBadRejFile(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('some/path/foo.cc', ''),
- MockFile('some/path/foo.cc.rej', ''),
- MockFile('some/path2/bar.h.rej', ''),
- ]
- results = PRESUBMIT.CheckPatchFiles(mock_input_api, MockOutputApi())
- self.assertEqual(1, len(results))
- self.assertEqual(2, len(results[0].items))
- self.assertTrue('foo.cc.rej' in results[0].items[0])
- self.assertTrue('bar.h.rej' in results[0].items[1])
- def testBadOrigFile(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('other/path/qux.h.orig', ''),
- MockFile('other/path/qux.h', ''),
- MockFile('other/path/qux.cc', ''),
- ]
- results = PRESUBMIT.CheckPatchFiles(mock_input_api, MockOutputApi())
- self.assertEqual(1, len(results))
- self.assertEqual(1, len(results[0].items))
- self.assertTrue('qux.h.orig' in results[0].items[0])
- def testGoodFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('other/path/qux.h', ''),
- MockFile('other/path/qux.cc', ''),
- ]
- results = PRESUBMIT.CheckPatchFiles(mock_input_api, MockOutputApi())
- self.assertEqual(0, len(results))
- class CheckForSuperfluousStlIncludesInHeadersTest(unittest.TestCase):
- def testGoodFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- # The check is not smart enough to figure out which definitions correspond
- # to which header.
- MockFile('other/path/foo.h',
- ['#include <string>',
- 'std::vector']),
- # The check is not smart enough to do IWYU.
- MockFile('other/path/bar.h',
- ['#include "base/check.h"',
- 'std::vector']),
- MockFile('other/path/qux.h',
- ['#include "base/stl_util.h"',
- 'foobar']),
- MockFile('other/path/baz.h',
- ['#include "set/vector.h"',
- 'bazzab']),
- # The check is only for header files.
- MockFile('other/path/not_checked.cc',
- ['#include <vector>',
- 'bazbaz']),
- ]
- results = PRESUBMIT.CheckForSuperfluousStlIncludesInHeaders(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(results))
- def testBadFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('other/path/foo.h',
- ['#include <vector>',
- 'vector']),
- MockFile('other/path/bar.h',
- ['#include <limits>',
- '#include <set>',
- 'no_std_namespace']),
- ]
- results = PRESUBMIT.CheckForSuperfluousStlIncludesInHeaders(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(results))
- self.assertTrue('foo.h: Includes STL' in results[0].message)
- self.assertTrue('bar.h: Includes STL' in results[0].message)
- class CheckSingletonInHeadersTest(unittest.TestCase):
- def testSingletonInArbitraryHeader(self):
- diff_singleton_h = ['base::subtle::AtomicWord '
- 'base::Singleton<Type, Traits, DifferentiatingType>::']
- diff_foo_h = ['// base::Singleton<Foo> in comment.',
- 'friend class base::Singleton<Foo>']
- diff_foo2_h = [' //Foo* bar = base::Singleton<Foo>::get();']
- diff_bad_h = ['Foo* foo = base::Singleton<Foo>::get();']
- mock_input_api = MockInputApi()
- mock_input_api.files = [MockAffectedFile('base/memory/singleton.h',
- diff_singleton_h),
- MockAffectedFile('foo.h', diff_foo_h),
- MockAffectedFile('foo2.h', diff_foo2_h),
- MockAffectedFile('bad.h', diff_bad_h)]
- warnings = PRESUBMIT.CheckSingletonInHeaders(mock_input_api,
- MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertEqual(1, len(warnings[0].items))
- self.assertEqual('error', warnings[0].type)
- self.assertTrue('Found base::Singleton<T>' in warnings[0].message)
- def testSingletonInCC(self):
- diff_cc = ['Foo* foo = base::Singleton<Foo>::get();']
- mock_input_api = MockInputApi()
- mock_input_api.files = [MockAffectedFile('some/path/foo.cc', diff_cc)]
- warnings = PRESUBMIT.CheckSingletonInHeaders(mock_input_api,
- MockOutputApi())
- self.assertEqual(0, len(warnings))
- class DeprecatedOSMacroNamesTest(unittest.TestCase):
- def testDeprecatedOSMacroNames(self):
- lines = ['#if defined(OS_WIN)',
- ' #elif defined(OS_WINDOW)',
- ' # if defined(OS_MAC) || defined(OS_CHROME)']
- errors = PRESUBMIT._CheckForDeprecatedOSMacrosInFile(
- MockInputApi(), MockFile('some/path/foo_platform.cc', lines))
- self.assertEqual(len(lines) + 1, len(errors))
- self.assertTrue(':1: defined(OS_WIN) -> BUILDFLAG(IS_WIN)' in errors[0])
- class InvalidIfDefinedMacroNamesTest(unittest.TestCase):
- def testInvalidIfDefinedMacroNames(self):
- lines = ['#if defined(TARGET_IPHONE_SIMULATOR)',
- '#if !defined(TARGET_IPHONE_SIMULATOR)',
- '#elif defined(TARGET_IPHONE_SIMULATOR)',
- '#ifdef TARGET_IPHONE_SIMULATOR',
- ' # ifdef TARGET_IPHONE_SIMULATOR',
- '# if defined(VALID) || defined(TARGET_IPHONE_SIMULATOR)',
- '# else // defined(TARGET_IPHONE_SIMULATOR)',
- '#endif // defined(TARGET_IPHONE_SIMULATOR)']
- errors = PRESUBMIT._CheckForInvalidIfDefinedMacrosInFile(
- MockInputApi(), MockFile('some/path/source.mm', lines))
- self.assertEqual(len(lines), len(errors))
- def testValidIfDefinedMacroNames(self):
- lines = ['#if defined(FOO)',
- '#ifdef BAR']
- errors = PRESUBMIT._CheckForInvalidIfDefinedMacrosInFile(
- MockInputApi(), MockFile('some/path/source.cc', lines))
- self.assertEqual(0, len(errors))
- class CheckAddedDepsHaveTestApprovalsTest(unittest.TestCase):
- def calculate(self, old_include_rules, old_specific_include_rules,
- new_include_rules, new_specific_include_rules):
- return PRESUBMIT._CalculateAddedDeps(
- os.path, 'include_rules = %r\nspecific_include_rules = %r' % (
- old_include_rules, old_specific_include_rules),
- 'include_rules = %r\nspecific_include_rules = %r' % (
- new_include_rules, new_specific_include_rules))
- def testCalculateAddedDeps(self):
- old_include_rules = [
- '+base',
- '-chrome',
- '+content',
- '-grit',
- '-grit/",',
- '+jni/fooblat.h',
- '!sandbox',
- ]
- old_specific_include_rules = {
- 'compositor\.*': {
- '+cc',
- },
- }
- new_include_rules = [
- '-ash',
- '+base',
- '+chrome',
- '+components',
- '+content',
- '+grit',
- '+grit/generated_resources.h",',
- '+grit/",',
- '+jni/fooblat.h',
- '+policy',
- '+' + os.path.join('third_party', 'WebKit'),
- ]
- new_specific_include_rules = {
- 'compositor\.*': {
- '+cc',
- },
- 'widget\.*': {
- '+gpu',
- },
- }
- expected = set([
- os.path.join('chrome', 'DEPS'),
- os.path.join('gpu', 'DEPS'),
- os.path.join('components', 'DEPS'),
- os.path.join('policy', 'DEPS'),
- os.path.join('third_party', 'WebKit', 'DEPS'),
- ])
- self.assertEqual(
- expected,
- self.calculate(old_include_rules, old_specific_include_rules,
- new_include_rules, new_specific_include_rules))
- def testCalculateAddedDepsIgnoresPermutations(self):
- old_include_rules = [
- '+base',
- '+chrome',
- ]
- new_include_rules = [
- '+chrome',
- '+base',
- ]
- self.assertEqual(set(),
- self.calculate(old_include_rules, {}, new_include_rules,
- {}))
- class JSONParsingTest(unittest.TestCase):
- def testSuccess(self):
- input_api = MockInputApi()
- filename = 'valid_json.json'
- contents = ['// This is a comment.',
- '{',
- ' "key1": ["value1", "value2"],',
- ' "key2": 3 // This is an inline comment.',
- '}'
- ]
- input_api.files = [MockFile(filename, contents)]
- self.assertEqual(None,
- PRESUBMIT._GetJSONParseError(input_api, filename))
- def testFailure(self):
- input_api = MockInputApi()
- test_data = [
- ('invalid_json_1.json',
- ['{ x }'],
- 'Expecting property name'),
- ('invalid_json_2.json',
- ['// Hello world!',
- '{ "hello": "world }'],
- 'Unterminated string starting at:'),
- ('invalid_json_3.json',
- ['{ "a": "b", "c": "d", }'],
- 'Expecting property name'),
- ('invalid_json_4.json',
- ['{ "a": "b" "c": "d" }'],
- "Expecting ',' delimiter:"),
- ]
- input_api.files = [MockFile(filename, contents)
- for (filename, contents, _) in test_data]
- for (filename, _, expected_error) in test_data:
- actual_error = PRESUBMIT._GetJSONParseError(input_api, filename)
- self.assertTrue(expected_error in str(actual_error),
- "'%s' not found in '%s'" % (expected_error, actual_error))
- def testNoEatComments(self):
- input_api = MockInputApi()
- file_with_comments = 'file_with_comments.json'
- contents_with_comments = ['// This is a comment.',
- '{',
- ' "key1": ["value1", "value2"],',
- ' "key2": 3 // This is an inline comment.',
- '}'
- ]
- file_without_comments = 'file_without_comments.json'
- contents_without_comments = ['{',
- ' "key1": ["value1", "value2"],',
- ' "key2": 3',
- '}'
- ]
- input_api.files = [MockFile(file_with_comments, contents_with_comments),
- MockFile(file_without_comments,
- contents_without_comments)]
- self.assertNotEqual(None,
- str(PRESUBMIT._GetJSONParseError(input_api,
- file_with_comments,
- eat_comments=False)))
- self.assertEqual(None,
- PRESUBMIT._GetJSONParseError(input_api,
- file_without_comments,
- eat_comments=False))
- class IDLParsingTest(unittest.TestCase):
- def testSuccess(self):
- input_api = MockInputApi()
- filename = 'valid_idl_basics.idl'
- contents = ['// Tests a valid IDL file.',
- 'namespace idl_basics {',
- ' enum EnumType {',
- ' name1,',
- ' name2',
- ' };',
- '',
- ' dictionary MyType1 {',
- ' DOMString a;',
- ' };',
- '',
- ' callback Callback1 = void();',
- ' callback Callback2 = void(long x);',
- ' callback Callback3 = void(MyType1 arg);',
- ' callback Callback4 = void(EnumType type);',
- '',
- ' interface Functions {',
- ' static void function1();',
- ' static void function2(long x);',
- ' static void function3(MyType1 arg);',
- ' static void function4(Callback1 cb);',
- ' static void function5(Callback2 cb);',
- ' static void function6(Callback3 cb);',
- ' static void function7(Callback4 cb);',
- ' };',
- '',
- ' interface Events {',
- ' static void onFoo1();',
- ' static void onFoo2(long x);',
- ' static void onFoo2(MyType1 arg);',
- ' static void onFoo3(EnumType type);',
- ' };',
- '};'
- ]
- input_api.files = [MockFile(filename, contents)]
- self.assertEqual(None,
- PRESUBMIT._GetIDLParseError(input_api, filename))
- def testFailure(self):
- input_api = MockInputApi()
- test_data = [
- ('invalid_idl_1.idl',
- ['//',
- 'namespace test {',
- ' dictionary {',
- ' DOMString s;',
- ' };',
- '};'],
- 'Unexpected "{" after keyword "dictionary".\n'),
- # TODO(yoz): Disabled because it causes the IDL parser to hang.
- # See crbug.com/363830.
- # ('invalid_idl_2.idl',
- # (['namespace test {',
- # ' dictionary MissingSemicolon {',
- # ' DOMString a',
- # ' DOMString b;',
- # ' };',
- # '};'],
- # 'Unexpected symbol DOMString after symbol a.'),
- ('invalid_idl_3.idl',
- ['//',
- 'namespace test {',
- ' enum MissingComma {',
- ' name1',
- ' name2',
- ' };',
- '};'],
- 'Unexpected symbol name2 after symbol name1.'),
- ('invalid_idl_4.idl',
- ['//',
- 'namespace test {',
- ' enum TrailingComma {',
- ' name1,',
- ' name2,',
- ' };',
- '};'],
- 'Trailing comma in block.'),
- ('invalid_idl_5.idl',
- ['//',
- 'namespace test {',
- ' callback Callback1 = void(;',
- '};'],
- 'Unexpected ";" after "(".'),
- ('invalid_idl_6.idl',
- ['//',
- 'namespace test {',
- ' callback Callback1 = void(long );',
- '};'],
- 'Unexpected ")" after symbol long.'),
- ('invalid_idl_7.idl',
- ['//',
- 'namespace test {',
- ' interace Events {',
- ' static void onFoo1();',
- ' };',
- '};'],
- 'Unexpected symbol Events after symbol interace.'),
- ('invalid_idl_8.idl',
- ['//',
- 'namespace test {',
- ' interface NotEvent {',
- ' static void onFoo1();',
- ' };',
- '};'],
- 'Did not process Interface Interface(NotEvent)'),
- ('invalid_idl_9.idl',
- ['//',
- 'namespace test {',
- ' interface {',
- ' static void function1();',
- ' };',
- '};'],
- 'Interface missing name.'),
- ]
- input_api.files = [MockFile(filename, contents)
- for (filename, contents, _) in test_data]
- for (filename, _, expected_error) in test_data:
- actual_error = PRESUBMIT._GetIDLParseError(input_api, filename)
- self.assertTrue(expected_error in str(actual_error),
- "'%s' not found in '%s'" % (expected_error, actual_error))
- class UserMetricsActionTest(unittest.TestCase):
- def testUserMetricsActionInActions(self):
- input_api = MockInputApi()
- file_with_user_action = 'file_with_user_action.cc'
- contents_with_user_action = [
- 'base::UserMetricsAction("AboutChrome")'
- ]
- input_api.files = [MockFile(file_with_user_action,
- contents_with_user_action)]
- self.assertEqual(
- [], PRESUBMIT.CheckUserActionUpdate(input_api, MockOutputApi()))
- def testUserMetricsActionNotAddedToActions(self):
- input_api = MockInputApi()
- file_with_user_action = 'file_with_user_action.cc'
- contents_with_user_action = [
- 'base::UserMetricsAction("NotInActionsXml")'
- ]
- input_api.files = [MockFile(file_with_user_action,
- contents_with_user_action)]
- output = PRESUBMIT.CheckUserActionUpdate(input_api, MockOutputApi())
- self.assertEqual(
- ('File %s line %d: %s is missing in '
- 'tools/metrics/actions/actions.xml. Please run '
- 'tools/metrics/actions/extract_actions.py to update.'
- % (file_with_user_action, 1, 'NotInActionsXml')),
- output[0].message)
- def testUserMetricsActionInTestFile(self):
- input_api = MockInputApi()
- file_with_user_action = 'file_with_user_action_unittest.cc'
- contents_with_user_action = [
- 'base::UserMetricsAction("NotInActionsXml")'
- ]
- input_api.files = [MockFile(file_with_user_action,
- contents_with_user_action)]
- self.assertEqual(
- [], PRESUBMIT.CheckUserActionUpdate(input_api, MockOutputApi()))
- class PydepsNeedsUpdatingTest(unittest.TestCase):
- class MockPopen:
- def __init__(self, stdout_func):
- self._stdout_func = stdout_func
- def wait(self):
- self.stdout = io.StringIO(self._stdout_func())
- return 0
- class MockSubprocess:
- CalledProcessError = subprocess.CalledProcessError
- PIPE = 0
- def __init__(self):
- self._popen_func = None
- def SetPopenCallback(self, func):
- self._popen_func = func
- def Popen(self, cmd, *args, **kwargs):
- return PydepsNeedsUpdatingTest.MockPopen(lambda: self._popen_func(cmd))
- def _MockParseGclientArgs(self, is_android=True):
- return lambda: {'checkout_android': 'true' if is_android else 'false' }
- def setUp(self):
- mock_all_pydeps = ['A.pydeps', 'B.pydeps', 'D.pydeps']
- self.old_ALL_PYDEPS_FILES = PRESUBMIT._ALL_PYDEPS_FILES
- PRESUBMIT._ALL_PYDEPS_FILES = mock_all_pydeps
- mock_android_pydeps = ['D.pydeps']
- self.old_ANDROID_SPECIFIC_PYDEPS_FILES = (
- PRESUBMIT._ANDROID_SPECIFIC_PYDEPS_FILES)
- PRESUBMIT._ANDROID_SPECIFIC_PYDEPS_FILES = mock_android_pydeps
- self.old_ParseGclientArgs = PRESUBMIT._ParseGclientArgs
- PRESUBMIT._ParseGclientArgs = self._MockParseGclientArgs()
- self.mock_input_api = MockInputApi()
- self.mock_output_api = MockOutputApi()
- self.mock_input_api.subprocess = PydepsNeedsUpdatingTest.MockSubprocess()
- self.checker = PRESUBMIT.PydepsChecker(self.mock_input_api, mock_all_pydeps)
- self.checker._file_cache = {
- 'A.pydeps': '# Generated by:\n# CMD --output A.pydeps A\nA.py\nC.py\n',
- 'B.pydeps': '# Generated by:\n# CMD --output B.pydeps B\nB.py\nC.py\n',
- 'D.pydeps': '# Generated by:\n# CMD --output D.pydeps D\nD.py\n',
- }
- def tearDown(self):
- PRESUBMIT._ALL_PYDEPS_FILES = self.old_ALL_PYDEPS_FILES
- PRESUBMIT._ANDROID_SPECIFIC_PYDEPS_FILES = (
- self.old_ANDROID_SPECIFIC_PYDEPS_FILES)
- PRESUBMIT._ParseGclientArgs = self.old_ParseGclientArgs
- def _RunCheck(self):
- return PRESUBMIT.CheckPydepsNeedsUpdating(self.mock_input_api,
- self.mock_output_api,
- checker_for_tests=self.checker)
- def testAddedPydep(self):
- # PRESUBMIT.CheckPydepsNeedsUpdating is only implemented for Linux.
- if not self.mock_input_api.platform.startswith('linux'):
- return []
- self.mock_input_api.files = [
- MockAffectedFile('new.pydeps', [], action='A'),
- ]
- self.mock_input_api.CreateMockFileInPath(
- [x.LocalPath() for x in self.mock_input_api.AffectedFiles(
- include_deletes=True)])
- results = self._RunCheck()
- self.assertEqual(1, len(results))
- self.assertIn('PYDEPS_FILES', str(results[0]))
- def testPydepNotInSrc(self):
- self.mock_input_api.files = [
- MockAffectedFile('new.pydeps', [], action='A'),
- ]
- self.mock_input_api.CreateMockFileInPath([])
- results = self._RunCheck()
- self.assertEqual(0, len(results))
- def testRemovedPydep(self):
- # PRESUBMIT.CheckPydepsNeedsUpdating is only implemented for Linux.
- if not self.mock_input_api.platform.startswith('linux'):
- return []
- self.mock_input_api.files = [
- MockAffectedFile(PRESUBMIT._ALL_PYDEPS_FILES[0], [], action='D'),
- ]
- self.mock_input_api.CreateMockFileInPath(
- [x.LocalPath() for x in self.mock_input_api.AffectedFiles(
- include_deletes=True)])
- results = self._RunCheck()
- self.assertEqual(1, len(results))
- self.assertIn('PYDEPS_FILES', str(results[0]))
- def testRandomPyIgnored(self):
- # PRESUBMIT.CheckPydepsNeedsUpdating is only implemented for Linux.
- if not self.mock_input_api.platform.startswith('linux'):
- return []
- self.mock_input_api.files = [
- MockAffectedFile('random.py', []),
- ]
- results = self._RunCheck()
- self.assertEqual(0, len(results), 'Unexpected results: %r' % results)
- def testRelevantPyNoChange(self):
- # PRESUBMIT.CheckPydepsNeedsUpdating is only implemented for Linux.
- if not self.mock_input_api.platform.startswith('linux'):
- return []
- self.mock_input_api.files = [
- MockAffectedFile('A.py', []),
- ]
- def popen_callback(cmd):
- self.assertEqual('CMD --output A.pydeps A --output ""', cmd)
- return self.checker._file_cache['A.pydeps']
- self.mock_input_api.subprocess.SetPopenCallback(popen_callback)
- results = self._RunCheck()
- self.assertEqual(0, len(results), 'Unexpected results: %r' % results)
- def testRelevantPyOneChange(self):
- # PRESUBMIT.CheckPydepsNeedsUpdating is only implemented for Linux.
- if not self.mock_input_api.platform.startswith('linux'):
- return []
- self.mock_input_api.files = [
- MockAffectedFile('A.py', []),
- ]
- def popen_callback(cmd):
- self.assertEqual('CMD --output A.pydeps A --output ""', cmd)
- return 'changed data'
- self.mock_input_api.subprocess.SetPopenCallback(popen_callback)
- results = self._RunCheck()
- self.assertEqual(1, len(results))
- # Check that --output "" is not included.
- self.assertNotIn('""', str(results[0]))
- self.assertIn('File is stale', str(results[0]))
- def testRelevantPyTwoChanges(self):
- # PRESUBMIT.CheckPydepsNeedsUpdating is only implemented for Linux.
- if not self.mock_input_api.platform.startswith('linux'):
- return []
- self.mock_input_api.files = [
- MockAffectedFile('C.py', []),
- ]
- def popen_callback(cmd):
- return 'changed data'
- self.mock_input_api.subprocess.SetPopenCallback(popen_callback)
- results = self._RunCheck()
- self.assertEqual(2, len(results))
- self.assertIn('File is stale', str(results[0]))
- self.assertIn('File is stale', str(results[1]))
- def testRelevantAndroidPyInNonAndroidCheckout(self):
- # PRESUBMIT.CheckPydepsNeedsUpdating is only implemented for Linux.
- if not self.mock_input_api.platform.startswith('linux'):
- return []
- self.mock_input_api.files = [
- MockAffectedFile('D.py', []),
- ]
- def popen_callback(cmd):
- self.assertEqual('CMD --output D.pydeps D --output ""', cmd)
- return 'changed data'
- self.mock_input_api.subprocess.SetPopenCallback(popen_callback)
- PRESUBMIT._ParseGclientArgs = self._MockParseGclientArgs(is_android=False)
- results = self._RunCheck()
- self.assertEqual(1, len(results))
- self.assertIn('Android', str(results[0]))
- self.assertIn('D.pydeps', str(results[0]))
- def testGnPathsAndMissingOutputFlag(self):
- # PRESUBMIT.CheckPydepsNeedsUpdating is only implemented for Linux.
- if not self.mock_input_api.platform.startswith('linux'):
- return []
- self.checker._file_cache = {
- 'A.pydeps': '# Generated by:\n# CMD --gn-paths A\n//A.py\n//C.py\n',
- 'B.pydeps': '# Generated by:\n# CMD --gn-paths B\n//B.py\n//C.py\n',
- 'D.pydeps': '# Generated by:\n# CMD --gn-paths D\n//D.py\n',
- }
- self.mock_input_api.files = [
- MockAffectedFile('A.py', []),
- ]
- def popen_callback(cmd):
- self.assertEqual('CMD --gn-paths A --output A.pydeps --output ""', cmd)
- return 'changed data'
- self.mock_input_api.subprocess.SetPopenCallback(popen_callback)
- results = self._RunCheck()
- self.assertEqual(1, len(results))
- self.assertIn('File is stale', str(results[0]))
- class IncludeGuardTest(unittest.TestCase):
- def testIncludeGuardChecks(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('content/browser/thing/foo.h', [
- '// Comment',
- '#ifndef CONTENT_BROWSER_THING_FOO_H_',
- '#define CONTENT_BROWSER_THING_FOO_H_',
- 'struct McBoatFace;',
- '#endif // CONTENT_BROWSER_THING_FOO_H_',
- ]),
- MockAffectedFile('content/browser/thing/bar.h', [
- '#ifndef CONTENT_BROWSER_THING_BAR_H_',
- '#define CONTENT_BROWSER_THING_BAR_H_',
- 'namespace content {',
- '#endif // CONTENT_BROWSER_THING_BAR_H_',
- '} // namespace content',
- ]),
- MockAffectedFile('content/browser/test1.h', [
- 'namespace content {',
- '} // namespace content',
- ]),
- MockAffectedFile('content\\browser\\win.h', [
- '#ifndef CONTENT_BROWSER_WIN_H_',
- '#define CONTENT_BROWSER_WIN_H_',
- 'struct McBoatFace;',
- '#endif // CONTENT_BROWSER_WIN_H_',
- ]),
- MockAffectedFile('content/browser/test2.h', [
- '// Comment',
- '#ifndef CONTENT_BROWSER_TEST2_H_',
- 'struct McBoatFace;',
- '#endif // CONTENT_BROWSER_TEST2_H_',
- ]),
- MockAffectedFile('content/browser/internal.h', [
- '// Comment',
- '#ifndef CONTENT_BROWSER_INTERNAL_H_',
- '#define CONTENT_BROWSER_INTERNAL_H_',
- '// Comment',
- '#ifndef INTERNAL_CONTENT_BROWSER_INTERNAL_H_',
- '#define INTERNAL_CONTENT_BROWSER_INTERNAL_H_',
- 'namespace internal {',
- '} // namespace internal',
- '#endif // INTERNAL_CONTENT_BROWSER_THING_BAR_H_',
- 'namespace content {',
- '} // namespace content',
- '#endif // CONTENT_BROWSER_THING_BAR_H_',
- ]),
- MockAffectedFile('content/browser/thing/foo.cc', [
- '// This is a non-header.',
- ]),
- MockAffectedFile('content/browser/disabled.h', [
- '// no-include-guard-because-multiply-included',
- 'struct McBoatFace;',
- ]),
- # New files don't allow misspelled include guards.
- MockAffectedFile('content/browser/spleling.h', [
- '#ifndef CONTENT_BROWSER_SPLLEING_H_',
- '#define CONTENT_BROWSER_SPLLEING_H_',
- 'struct McBoatFace;',
- '#endif // CONTENT_BROWSER_SPLLEING_H_',
- ]),
- # New files don't allow + in include guards.
- MockAffectedFile('content/browser/foo+bar.h', [
- '#ifndef CONTENT_BROWSER_FOO+BAR_H_',
- '#define CONTENT_BROWSER_FOO+BAR_H_',
- 'struct McBoatFace;',
- '#endif // CONTENT_BROWSER_FOO+BAR_H_',
- ]),
- # Old files allow misspelled include guards (for now).
- MockAffectedFile('chrome/old.h', [
- '// New contents',
- '#ifndef CHROME_ODL_H_',
- '#define CHROME_ODL_H_',
- '#endif // CHROME_ODL_H_',
- ], [
- '// Old contents',
- '#ifndef CHROME_ODL_H_',
- '#define CHROME_ODL_H_',
- '#endif // CHROME_ODL_H_',
- ]),
- # Using a Blink style include guard outside Blink is wrong.
- MockAffectedFile('content/NotInBlink.h', [
- '#ifndef NotInBlink_h',
- '#define NotInBlink_h',
- 'struct McBoatFace;',
- '#endif // NotInBlink_h',
- ]),
- # Using a Blink style include guard in Blink is no longer ok.
- MockAffectedFile('third_party/blink/InBlink.h', [
- '#ifndef InBlink_h',
- '#define InBlink_h',
- 'struct McBoatFace;',
- '#endif // InBlink_h',
- ]),
- # Using a bad include guard in Blink is not ok.
- MockAffectedFile('third_party/blink/AlsoInBlink.h', [
- '#ifndef WrongInBlink_h',
- '#define WrongInBlink_h',
- 'struct McBoatFace;',
- '#endif // WrongInBlink_h',
- ]),
- # Using a bad include guard in Blink is not accepted even if
- # it's an old file.
- MockAffectedFile('third_party/blink/StillInBlink.h', [
- '// New contents',
- '#ifndef AcceptedInBlink_h',
- '#define AcceptedInBlink_h',
- 'struct McBoatFace;',
- '#endif // AcceptedInBlink_h',
- ], [
- '// Old contents',
- '#ifndef AcceptedInBlink_h',
- '#define AcceptedInBlink_h',
- 'struct McBoatFace;',
- '#endif // AcceptedInBlink_h',
- ]),
- # Using a non-Chromium include guard in third_party
- # (outside blink) is accepted.
- MockAffectedFile('third_party/foo/some_file.h', [
- '#ifndef REQUIRED_RPCNDR_H_',
- '#define REQUIRED_RPCNDR_H_',
- 'struct SomeFileFoo;',
- '#endif // REQUIRED_RPCNDR_H_',
- ]),
- # Not having proper include guard in *_message_generator.h
- # for old IPC messages is allowed.
- MockAffectedFile('content/common/content_message_generator.h', [
- '#undef CONTENT_COMMON_FOO_MESSAGES_H_',
- '#include "content/common/foo_messages.h"',
- '#ifndef CONTENT_COMMON_FOO_MESSAGES_H_',
- '#error "Failed to include content/common/foo_messages.h"',
- '#endif',
- ]),
- ]
- msgs = PRESUBMIT.CheckForIncludeGuards(
- mock_input_api, mock_output_api)
- expected_fail_count = 8
- self.assertEqual(expected_fail_count, len(msgs),
- 'Expected %d items, found %d: %s'
- % (expected_fail_count, len(msgs), msgs))
- self.assertEqual(msgs[0].items, ['content/browser/thing/bar.h'])
- self.assertEqual(msgs[0].message,
- 'Include guard CONTENT_BROWSER_THING_BAR_H_ '
- 'not covering the whole file')
- self.assertIn('content/browser/test1.h', msgs[1].message)
- self.assertIn('Recommended name: CONTENT_BROWSER_TEST1_H_',
- msgs[1].message)
- self.assertEqual(msgs[2].items, ['content/browser/test2.h:3'])
- self.assertEqual(msgs[2].message,
- 'Missing "#define CONTENT_BROWSER_TEST2_H_" for '
- 'include guard')
- self.assertEqual(msgs[3].items, ['content/browser/spleling.h:1'])
- self.assertEqual(msgs[3].message,
- 'Header using the wrong include guard name '
- 'CONTENT_BROWSER_SPLLEING_H_')
- self.assertIn('content/browser/foo+bar.h', msgs[4].message)
- self.assertIn('Recommended name: CONTENT_BROWSER_FOO_BAR_H_',
- msgs[4].message)
- self.assertEqual(msgs[5].items, ['content/NotInBlink.h:1'])
- self.assertEqual(msgs[5].message,
- 'Header using the wrong include guard name '
- 'NotInBlink_h')
- self.assertEqual(msgs[6].items, ['third_party/blink/InBlink.h:1'])
- self.assertEqual(msgs[6].message,
- 'Header using the wrong include guard name '
- 'InBlink_h')
- self.assertEqual(msgs[7].items, ['third_party/blink/AlsoInBlink.h:1'])
- self.assertEqual(msgs[7].message,
- 'Header using the wrong include guard name '
- 'WrongInBlink_h')
- class AccessibilityRelnotesFieldTest(unittest.TestCase):
- def testRelnotesPresent(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [MockAffectedFile('ui/accessibility/foo.bar', [''])]
- mock_input_api.change.DescriptionText = lambda : 'Commit description'
- mock_input_api.change.footers['AX-Relnotes'] = [
- 'Important user facing change']
- msgs = PRESUBMIT.CheckAccessibilityRelnotesField(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- def testRelnotesMissingFromAccessibilityChange(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('some/file', ['']),
- MockAffectedFile('ui/accessibility/foo.bar', ['']),
- MockAffectedFile('some/other/file', [''])
- ]
- mock_input_api.change.DescriptionText = lambda : 'Commit description'
- msgs = PRESUBMIT.CheckAccessibilityRelnotesField(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (1, len(msgs), msgs))
- self.assertTrue("Missing 'AX-Relnotes:' field" in msgs[0].message,
- 'Missing AX-Relnotes field message not found in errors')
- # The relnotes footer is not required for changes which do not touch any
- # accessibility directories.
- def testIgnoresNonAccessibilityCode(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('some/file', ['']),
- MockAffectedFile('some/other/file', [''])
- ]
- mock_input_api.change.DescriptionText = lambda : 'Commit description'
- msgs = PRESUBMIT.CheckAccessibilityRelnotesField(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that our presubmit correctly raises an error for a set of known paths.
- def testExpectedPaths(self):
- filesToTest = [
- "chrome/browser/accessibility/foo.py",
- "chrome/browser/ash/arc/accessibility/foo.cc",
- "chrome/browser/ui/views/accessibility/foo.h",
- "chrome/browser/extensions/api/automation/foo.h",
- "chrome/browser/extensions/api/automation_internal/foo.cc",
- "chrome/renderer/extensions/accessibility_foo.h",
- "chrome/tests/data/accessibility/foo.html",
- "content/browser/accessibility/foo.cc",
- "content/renderer/accessibility/foo.h",
- "content/tests/data/accessibility/foo.cc",
- "extensions/renderer/api/automation/foo.h",
- "ui/accessibility/foo/bar/baz.cc",
- "ui/views/accessibility/foo/bar/baz.h",
- ]
- for testFile in filesToTest:
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile(testFile, [''])
- ]
- mock_input_api.change.DescriptionText = lambda : 'Commit description'
- msgs = PRESUBMIT.CheckAccessibilityRelnotesField(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(msgs),
- 'Expected %d messages, found %d: %s, for file %s'
- % (1, len(msgs), msgs, testFile))
- self.assertTrue("Missing 'AX-Relnotes:' field" in msgs[0].message,
- ('Missing AX-Relnotes field message not found in errors '
- ' for file %s' % (testFile)))
- # Test that AX-Relnotes field can appear in the commit description (as long
- # as it appears at the beginning of a line).
- def testRelnotesInCommitDescription(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('ui/accessibility/foo.bar', ['']),
- ]
- mock_input_api.change.DescriptionText = lambda : ('Description:\n' +
- 'AX-Relnotes: solves all accessibility issues forever')
- msgs = PRESUBMIT.CheckAccessibilityRelnotesField(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that we don't match AX-Relnotes if it appears in the middle of a line.
- def testRelnotesMustAppearAtBeginningOfLine(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('ui/accessibility/foo.bar', ['']),
- ]
- mock_input_api.change.DescriptionText = lambda : ('Description:\n' +
- 'This change has no AX-Relnotes: we should print a warning')
- msgs = PRESUBMIT.CheckAccessibilityRelnotesField(
- mock_input_api, mock_output_api)
- self.assertTrue("Missing 'AX-Relnotes:' field" in msgs[0].message,
- 'Missing AX-Relnotes field message not found in errors')
- # Tests that the AX-Relnotes field can be lowercase and use a '=' in place
- # of a ':'.
- def testRelnotesLowercaseWithEqualSign(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('ui/accessibility/foo.bar', ['']),
- ]
- mock_input_api.change.DescriptionText = lambda : ('Description:\n' +
- 'ax-relnotes= this is a valid format for accessibility relnotes')
- msgs = PRESUBMIT.CheckAccessibilityRelnotesField(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- class AccessibilityEventsTestsAreIncludedForAndroidTest(unittest.TestCase):
- # Test that no warning is raised when the Android file is also modified.
- def testAndroidChangeIncluded(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/event/foo.html',
- [''], action='A'),
- MockAffectedFile(
- 'accessibility/WebContentsAccessibilityEventsTest.java',
- [''], action='M')
- ]
- msgs = PRESUBMIT.CheckAccessibilityEventsTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that a warning is raised when the Android file is not modified.
- def testAndroidChangeMissing(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/event/foo.html',
- [''], action='A'),
- ]
- msgs = PRESUBMIT.CheckAccessibilityEventsTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (1, len(msgs), msgs))
- # Test that Android change is not required when no html file is added/removed.
- def testIgnoreNonHtmlFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/event/foo.txt',
- [''], action='A'),
- MockAffectedFile('content/test/data/accessibility/event/foo.cc',
- [''], action='A'),
- MockAffectedFile('content/test/data/accessibility/event/foo.h',
- [''], action='A'),
- MockAffectedFile('content/test/data/accessibility/event/foo.py',
- [''], action='A')
- ]
- msgs = PRESUBMIT.CheckAccessibilityEventsTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that Android change is not required for unrelated html files.
- def testIgnoreNonRelatedHtmlFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/aria/foo.html',
- [''], action='A'),
- MockAffectedFile('content/test/data/accessibility/html/foo.html',
- [''], action='A'),
- MockAffectedFile('chrome/tests/data/accessibility/foo.html',
- [''], action='A')
- ]
- msgs = PRESUBMIT.CheckAccessibilityEventsTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that only modifying an html file will not trigger the warning.
- def testIgnoreModifiedFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/event/foo.html',
- [''], action='M')
- ]
- msgs = PRESUBMIT.CheckAccessibilityEventsTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that deleting an html file will trigger the warning.
- def testAndroidChangeMissingOnDeletedFile(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/event/foo.html',
- [], action='D')
- ]
- msgs = PRESUBMIT.CheckAccessibilityEventsTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (1, len(msgs), msgs))
- class AccessibilityTreeTestsAreIncludedForAndroidTest(unittest.TestCase):
- # Test that no warning is raised when the Android file is also modified.
- def testAndroidChangeIncluded(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/aria/foo.html',
- [''], action='A'),
- MockAffectedFile(
- 'accessibility/WebContentsAccessibilityTreeTest.java',
- [''], action='M')
- ]
- msgs = PRESUBMIT.CheckAccessibilityTreeTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that no warning is raised when the Android file is also modified.
- def testAndroidChangeIncludedManyFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/accname/foo.html',
- [''], action='A'),
- MockAffectedFile('content/test/data/accessibility/aria/foo.html',
- [''], action='A'),
- MockAffectedFile('content/test/data/accessibility/css/foo.html',
- [''], action='A'),
- MockAffectedFile('content/test/data/accessibility/html/foo.html',
- [''], action='A'),
- MockAffectedFile(
- 'accessibility/WebContentsAccessibilityTreeTest.java',
- [''], action='M')
- ]
- msgs = PRESUBMIT.CheckAccessibilityTreeTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that a warning is raised when the Android file is not modified.
- def testAndroidChangeMissing(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/aria/foo.html',
- [''], action='A'),
- ]
- msgs = PRESUBMIT.CheckAccessibilityTreeTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (1, len(msgs), msgs))
- # Test that Android change is not required when no html file is added/removed.
- def testIgnoreNonHtmlFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/accname/foo.txt',
- [''], action='A'),
- MockAffectedFile('content/test/data/accessibility/aria/foo.cc',
- [''], action='A'),
- MockAffectedFile('content/test/data/accessibility/css/foo.h',
- [''], action='A'),
- MockAffectedFile('content/test/data/accessibility/tree/foo.py',
- [''], action='A')
- ]
- msgs = PRESUBMIT.CheckAccessibilityTreeTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that Android change is not required for unrelated html files.
- def testIgnoreNonRelatedHtmlFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/event/foo.html',
- [''], action='A'),
- ]
- msgs = PRESUBMIT.CheckAccessibilityTreeTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that only modifying an html file will not trigger the warning.
- def testIgnoreModifiedFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/aria/foo.html',
- [''], action='M')
- ]
- msgs = PRESUBMIT.CheckAccessibilityTreeTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (0, len(msgs), msgs))
- # Test that deleting an html file will trigger the warning.
- def testAndroidChangeMissingOnDeletedFile(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('content/test/data/accessibility/accname/foo.html',
- [], action='D')
- ]
- msgs = PRESUBMIT.CheckAccessibilityTreeTestsAreIncludedForAndroid(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(msgs),
- 'Expected %d messages, found %d: %s'
- % (1, len(msgs), msgs))
- class AndroidDeprecatedTestAnnotationTest(unittest.TestCase):
- def testCheckAndroidTestAnnotationUsage(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('LalaLand.java', [
- 'random stuff'
- ]),
- MockAffectedFile('CorrectUsage.java', [
- 'import android.support.test.filters.LargeTest;',
- 'import android.support.test.filters.MediumTest;',
- 'import android.support.test.filters.SmallTest;',
- ]),
- MockAffectedFile('UsedDeprecatedLargeTestAnnotation.java', [
- 'import android.test.suitebuilder.annotation.LargeTest;',
- ]),
- MockAffectedFile('UsedDeprecatedMediumTestAnnotation.java', [
- 'import android.test.suitebuilder.annotation.MediumTest;',
- ]),
- MockAffectedFile('UsedDeprecatedSmallTestAnnotation.java', [
- 'import android.test.suitebuilder.annotation.SmallTest;',
- ]),
- MockAffectedFile('UsedDeprecatedSmokeAnnotation.java', [
- 'import android.test.suitebuilder.annotation.Smoke;',
- ])
- ]
- msgs = PRESUBMIT._CheckAndroidTestAnnotationUsage(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(msgs),
- 'Expected %d items, found %d: %s'
- % (1, len(msgs), msgs))
- self.assertEqual(4, len(msgs[0].items),
- 'Expected %d items, found %d: %s'
- % (4, len(msgs[0].items), msgs[0].items))
- self.assertTrue('UsedDeprecatedLargeTestAnnotation.java:1' in msgs[0].items,
- 'UsedDeprecatedLargeTestAnnotation not found in errors')
- self.assertTrue('UsedDeprecatedMediumTestAnnotation.java:1'
- in msgs[0].items,
- 'UsedDeprecatedMediumTestAnnotation not found in errors')
- self.assertTrue('UsedDeprecatedSmallTestAnnotation.java:1' in msgs[0].items,
- 'UsedDeprecatedSmallTestAnnotation not found in errors')
- self.assertTrue('UsedDeprecatedSmokeAnnotation.java:1' in msgs[0].items,
- 'UsedDeprecatedSmokeAnnotation not found in errors')
- class CheckNoDownstreamDepsTest(unittest.TestCase):
- def testInvalidDepFromUpstream(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('BUILD.gn', [
- 'deps = [',
- ' "//clank/target:test",',
- ']'
- ]),
- MockAffectedFile('chrome/android/BUILD.gn', [
- 'deps = [ "//clank/target:test" ]'
- ]),
- MockAffectedFile('chrome/chrome_java_deps.gni', [
- 'java_deps = [',
- ' "//clank/target:test",',
- ']'
- ]),
- ]
- mock_input_api.change.RepositoryRoot = lambda: 'chromium/src'
- msgs = PRESUBMIT.CheckNoUpstreamDepsOnClank(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(msgs),
- 'Expected %d items, found %d: %s'
- % (1, len(msgs), msgs))
- self.assertEqual(3, len(msgs[0].items),
- 'Expected %d items, found %d: %s'
- % (3, len(msgs[0].items), msgs[0].items))
- self.assertTrue(any('BUILD.gn:2' in item for item in msgs[0].items),
- 'BUILD.gn not found in errors')
- self.assertTrue(
- any('chrome/android/BUILD.gn:1' in item for item in msgs[0].items),
- 'chrome/android/BUILD.gn:1 not found in errors')
- self.assertTrue(
- any('chrome/chrome_java_deps.gni:2' in item for item in msgs[0].items),
- 'chrome/chrome_java_deps.gni:2 not found in errors')
- def testAllowsComments(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('BUILD.gn', [
- '# real implementation in //clank/target:test',
- ]),
- ]
- mock_input_api.change.RepositoryRoot = lambda: 'chromium/src'
- msgs = PRESUBMIT.CheckNoUpstreamDepsOnClank(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(msgs),
- 'Expected %d items, found %d: %s'
- % (0, len(msgs), msgs))
- def testOnlyChecksBuildFiles(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('README.md', [
- 'DEPS = [ "//clank/target:test" ]'
- ]),
- MockAffectedFile('chrome/android/java/file.java', [
- '//clank/ only function'
- ]),
- ]
- mock_input_api.change.RepositoryRoot = lambda: 'chromium/src'
- msgs = PRESUBMIT.CheckNoUpstreamDepsOnClank(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(msgs),
- 'Expected %d items, found %d: %s'
- % (0, len(msgs), msgs))
- def testValidDepFromDownstream(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('BUILD.gn', [
- 'DEPS = [',
- ' "//clank/target:test",',
- ']'
- ]),
- MockAffectedFile('java/BUILD.gn', [
- 'DEPS = [ "//clank/target:test" ]'
- ]),
- ]
- mock_input_api.change.RepositoryRoot = lambda: 'chromium/src/clank'
- msgs = PRESUBMIT.CheckNoUpstreamDepsOnClank(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(msgs),
- 'Expected %d items, found %d: %s'
- % (0, len(msgs), msgs))
- class AndroidDeprecatedJUnitFrameworkTest(unittest.TestCase):
- def testCheckAndroidTestJUnitFramework(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('LalaLand.java', [
- 'random stuff'
- ]),
- MockAffectedFile('CorrectUsage.java', [
- 'import org.junit.ABC',
- 'import org.junit.XYZ;',
- ]),
- MockAffectedFile('UsedDeprecatedJUnit.java', [
- 'import junit.framework.*;',
- ]),
- MockAffectedFile('UsedDeprecatedJUnitAssert.java', [
- 'import junit.framework.Assert;',
- ]),
- ]
- msgs = PRESUBMIT._CheckAndroidTestJUnitFrameworkImport(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(msgs),
- 'Expected %d items, found %d: %s'
- % (1, len(msgs), msgs))
- self.assertEqual(2, len(msgs[0].items),
- 'Expected %d items, found %d: %s'
- % (2, len(msgs[0].items), msgs[0].items))
- self.assertTrue('UsedDeprecatedJUnit.java:1' in msgs[0].items,
- 'UsedDeprecatedJUnit.java not found in errors')
- self.assertTrue('UsedDeprecatedJUnitAssert.java:1'
- in msgs[0].items,
- 'UsedDeprecatedJUnitAssert not found in errors')
- class AndroidJUnitBaseClassTest(unittest.TestCase):
- def testCheckAndroidTestJUnitBaseClass(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('LalaLand.java', [
- 'random stuff'
- ]),
- MockAffectedFile('CorrectTest.java', [
- '@RunWith(ABC.class);'
- 'public class CorrectTest {',
- '}',
- ]),
- MockAffectedFile('HistoricallyIncorrectTest.java', [
- 'public class Test extends BaseCaseA {',
- '}',
- ], old_contents=[
- 'public class Test extends BaseCaseB {',
- '}',
- ]),
- MockAffectedFile('CorrectTestWithInterface.java', [
- '@RunWith(ABC.class);'
- 'public class CorrectTest implement Interface {',
- '}',
- ]),
- MockAffectedFile('IncorrectTest.java', [
- 'public class IncorrectTest extends TestCase {',
- '}',
- ]),
- MockAffectedFile('IncorrectWithInterfaceTest.java', [
- 'public class Test implements X extends BaseClass {',
- '}',
- ]),
- MockAffectedFile('IncorrectMultiLineTest.java', [
- 'public class Test implements X, Y, Z',
- ' extends TestBase {',
- '}',
- ]),
- ]
- msgs = PRESUBMIT._CheckAndroidTestJUnitInheritance(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(msgs),
- 'Expected %d items, found %d: %s'
- % (1, len(msgs), msgs))
- self.assertEqual(3, len(msgs[0].items),
- 'Expected %d items, found %d: %s'
- % (3, len(msgs[0].items), msgs[0].items))
- self.assertTrue('IncorrectTest.java:1' in msgs[0].items,
- 'IncorrectTest not found in errors')
- self.assertTrue('IncorrectWithInterfaceTest.java:1'
- in msgs[0].items,
- 'IncorrectWithInterfaceTest not found in errors')
- self.assertTrue('IncorrectMultiLineTest.java:2' in msgs[0].items,
- 'IncorrectMultiLineTest not found in errors')
- class AndroidDebuggableBuildTest(unittest.TestCase):
- def testCheckAndroidDebuggableBuild(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('RandomStuff.java', [
- 'random stuff'
- ]),
- MockAffectedFile('CorrectUsage.java', [
- 'import org.chromium.base.BuildInfo;',
- 'some random stuff',
- 'boolean isOsDebuggable = BuildInfo.isDebugAndroid();',
- ]),
- MockAffectedFile('JustCheckUserdebugBuild.java', [
- 'import android.os.Build;',
- 'some random stuff',
- 'boolean isOsDebuggable = Build.TYPE.equals("userdebug")',
- ]),
- MockAffectedFile('JustCheckEngineeringBuild.java', [
- 'import android.os.Build;',
- 'some random stuff',
- 'boolean isOsDebuggable = "eng".equals(Build.TYPE)',
- ]),
- MockAffectedFile('UsedBuildType.java', [
- 'import android.os.Build;',
- 'some random stuff',
- 'boolean isOsDebuggable = Build.TYPE.equals("userdebug")'
- '|| "eng".equals(Build.TYPE)',
- ]),
- MockAffectedFile('UsedExplicitBuildType.java', [
- 'some random stuff',
- 'boolean isOsDebuggable = android.os.Build.TYPE.equals("userdebug")'
- '|| "eng".equals(android.os.Build.TYPE)',
- ]),
- ]
- msgs = PRESUBMIT._CheckAndroidDebuggableBuild(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(msgs),
- 'Expected %d items, found %d: %s'
- % (1, len(msgs), msgs))
- self.assertEqual(4, len(msgs[0].items),
- 'Expected %d items, found %d: %s'
- % (4, len(msgs[0].items), msgs[0].items))
- self.assertTrue('JustCheckUserdebugBuild.java:3' in msgs[0].items)
- self.assertTrue('JustCheckEngineeringBuild.java:3' in msgs[0].items)
- self.assertTrue('UsedBuildType.java:3' in msgs[0].items)
- self.assertTrue('UsedExplicitBuildType.java:2' in msgs[0].items)
- class LogUsageTest(unittest.TestCase):
- def testCheckAndroidCrLogUsage(self):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockAffectedFile('RandomStuff.java', [
- 'random stuff'
- ]),
- MockAffectedFile('HasAndroidLog.java', [
- 'import android.util.Log;',
- 'some random stuff',
- 'Log.d("TAG", "foo");',
- ]),
- MockAffectedFile('HasExplicitUtilLog.java', [
- 'some random stuff',
- 'android.util.Log.d("TAG", "foo");',
- ]),
- MockAffectedFile('IsInBasePackage.java', [
- 'package org.chromium.base;',
- 'private static final String TAG = "cr_Foo";',
- 'Log.d(TAG, "foo");',
- ]),
- MockAffectedFile('IsInBasePackageButImportsLog.java', [
- 'package org.chromium.base;',
- 'import android.util.Log;',
- 'private static final String TAG = "cr_Foo";',
- 'Log.d(TAG, "foo");',
- ]),
- MockAffectedFile('HasBothLog.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'private static final String TAG = "cr_Foo";',
- 'Log.d(TAG, "foo");',
- 'android.util.Log.d("TAG", "foo");',
- ]),
- MockAffectedFile('HasCorrectTag.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'private static final String TAG = "cr_Foo";',
- 'Log.d(TAG, "foo");',
- ]),
- MockAffectedFile('HasOldTag.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'private static final String TAG = "cr.Foo";',
- 'Log.d(TAG, "foo");',
- ]),
- MockAffectedFile('HasDottedTag.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'private static final String TAG = "cr_foo.bar";',
- 'Log.d(TAG, "foo");',
- ]),
- MockAffectedFile('HasDottedTagPublic.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'public static final String TAG = "cr_foo.bar";',
- 'Log.d(TAG, "foo");',
- ]),
- MockAffectedFile('HasNoTagDecl.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'Log.d(TAG, "foo");',
- ]),
- MockAffectedFile('HasIncorrectTagDecl.java', [
- 'import org.chromium.base.Log;',
- 'private static final String TAHG = "cr_Foo";',
- 'some random stuff',
- 'Log.d(TAG, "foo");',
- ]),
- MockAffectedFile('HasInlineTag.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'private static final String TAG = "cr_Foo";',
- 'Log.d("TAG", "foo");',
- ]),
- MockAffectedFile('HasInlineTagWithSpace.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'private static final String TAG = "cr_Foo";',
- 'Log.d("log message", "foo");',
- ]),
- MockAffectedFile('HasUnprefixedTag.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'private static final String TAG = "rubbish";',
- 'Log.d(TAG, "foo");',
- ]),
- MockAffectedFile('HasTooLongTag.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'private static final String TAG = "21_characters_long___";',
- 'Log.d(TAG, "foo");',
- ]),
- MockAffectedFile('HasTooLongTagWithNoLogCallsInDiff.java', [
- 'import org.chromium.base.Log;',
- 'some random stuff',
- 'private static final String TAG = "21_characters_long___";',
- ]),
- ]
- msgs = PRESUBMIT._CheckAndroidCrLogUsage(
- mock_input_api, mock_output_api)
- self.assertEqual(5, len(msgs),
- 'Expected %d items, found %d: %s' % (5, len(msgs), msgs))
- # Declaration format
- nb = len(msgs[0].items)
- self.assertEqual(2, nb,
- 'Expected %d items, found %d: %s' % (2, nb, msgs[0].items))
- self.assertTrue('HasNoTagDecl.java' in msgs[0].items)
- self.assertTrue('HasIncorrectTagDecl.java' in msgs[0].items)
- # Tag length
- nb = len(msgs[1].items)
- self.assertEqual(2, nb,
- 'Expected %d items, found %d: %s' % (2, nb, msgs[1].items))
- self.assertTrue('HasTooLongTag.java' in msgs[1].items)
- self.assertTrue('HasTooLongTagWithNoLogCallsInDiff.java' in msgs[1].items)
- # Tag must be a variable named TAG
- nb = len(msgs[2].items)
- self.assertEqual(3, nb,
- 'Expected %d items, found %d: %s' % (3, nb, msgs[2].items))
- self.assertTrue('HasBothLog.java:5' in msgs[2].items)
- self.assertTrue('HasInlineTag.java:4' in msgs[2].items)
- self.assertTrue('HasInlineTagWithSpace.java:4' in msgs[2].items)
- # Util Log usage
- nb = len(msgs[3].items)
- self.assertEqual(3, nb,
- 'Expected %d items, found %d: %s' % (3, nb, msgs[3].items))
- self.assertTrue('HasAndroidLog.java:3' in msgs[3].items)
- self.assertTrue('HasExplicitUtilLog.java:2' in msgs[3].items)
- self.assertTrue('IsInBasePackageButImportsLog.java:4' in msgs[3].items)
- # Tag must not contain
- nb = len(msgs[4].items)
- self.assertEqual(3, nb,
- 'Expected %d items, found %d: %s' % (2, nb, msgs[4].items))
- self.assertTrue('HasDottedTag.java' in msgs[4].items)
- self.assertTrue('HasDottedTagPublic.java' in msgs[4].items)
- self.assertTrue('HasOldTag.java' in msgs[4].items)
- class GoogleAnswerUrlFormatTest(unittest.TestCase):
- def testCatchAnswerUrlId(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('somewhere/file.cc',
- ['char* host = '
- ' "https://support.google.com/chrome/answer/123456";']),
- MockFile('somewhere_else/file.cc',
- ['char* host = '
- ' "https://support.google.com/chrome/a/answer/123456";']),
- ]
- warnings = PRESUBMIT.CheckGoogleSupportAnswerUrlOnUpload(
- input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertEqual(2, len(warnings[0].items))
- def testAllowAnswerUrlParam(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('somewhere/file.cc',
- ['char* host = '
- ' "https://support.google.com/chrome/?p=cpn_crash_reports";']),
- ]
- warnings = PRESUBMIT.CheckGoogleSupportAnswerUrlOnUpload(
- input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- class HardcodedGoogleHostsTest(unittest.TestCase):
- def testWarnOnAssignedLiterals(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('content/file.cc',
- ['char* host = "https://www.google.com";']),
- MockFile('content/file.cc',
- ['char* host = "https://www.googleapis.com";']),
- MockFile('content/file.cc',
- ['char* host = "https://clients1.google.com";']),
- ]
- warnings = PRESUBMIT.CheckHardcodedGoogleHostsInLowerLayers(
- input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertEqual(3, len(warnings[0].items))
- def testAllowInComment(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('content/file.cc',
- ['char* host = "https://www.aol.com"; // google.com'])
- ]
- warnings = PRESUBMIT.CheckHardcodedGoogleHostsInLowerLayers(
- input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- class ChromeOsSyncedPrefRegistrationTest(unittest.TestCase):
- def testWarnsOnChromeOsDirectories(self):
- files = [
- MockFile('ash/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_PREF']),
- MockFile('chrome/browser/chromeos/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_PREF']),
- MockFile('chromeos/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_PREF']),
- MockFile('components/arc/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_PREF']),
- MockFile('components/exo/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_PREF']),
- ]
- input_api = MockInputApi()
- for file in files:
- input_api.files = [file]
- warnings = PRESUBMIT.CheckChromeOsSyncedPrefRegistration(
- input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- def testDoesNotWarnOnSyncOsPref(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('chromeos/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_OS_PREF']),
- ]
- warnings = PRESUBMIT.CheckChromeOsSyncedPrefRegistration(
- input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testDoesNotWarnOnOtherDirectories(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('chrome/browser/ui/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_PREF']),
- MockFile('components/sync/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_PREF']),
- MockFile('content/browser/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_PREF']),
- MockFile('a/notchromeos/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_PREF']),
- ]
- warnings = PRESUBMIT.CheckChromeOsSyncedPrefRegistration(
- input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testSeparateWarningForPriorityPrefs(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('chromeos/file.cc',
- ['PrefRegistrySyncable::SYNCABLE_PREF',
- 'PrefRegistrySyncable::SYNCABLE_PRIORITY_PREF']),
- ]
- warnings = PRESUBMIT.CheckChromeOsSyncedPrefRegistration(
- input_api, MockOutputApi())
- self.assertEqual(2, len(warnings))
- class ForwardDeclarationTest(unittest.TestCase):
- def testCheckHeadersOnlyOutsideThirdParty(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('somewhere/file.cc', [
- 'class DummyClass;'
- ]),
- MockAffectedFile('third_party/header.h', [
- 'class DummyClass;'
- ])
- ]
- warnings = PRESUBMIT.CheckUselessForwardDeclarations(mock_input_api,
- MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testNoNestedDeclaration(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('somewhere/header.h', [
- 'class SomeClass {',
- ' protected:',
- ' class NotAMatch;',
- '};'
- ])
- ]
- warnings = PRESUBMIT.CheckUselessForwardDeclarations(mock_input_api,
- MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testSubStrings(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('somewhere/header.h', [
- 'class NotUsefulClass;',
- 'struct SomeStruct;',
- 'UsefulClass *p1;',
- 'SomeStructPtr *p2;'
- ])
- ]
- warnings = PRESUBMIT.CheckUselessForwardDeclarations(mock_input_api,
- MockOutputApi())
- self.assertEqual(2, len(warnings))
- def testUselessForwardDeclaration(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('somewhere/header.h', [
- 'class DummyClass;',
- 'struct DummyStruct;',
- 'class UsefulClass;',
- 'std::unique_ptr<UsefulClass> p;'
- ])
- ]
- warnings = PRESUBMIT.CheckUselessForwardDeclarations(mock_input_api,
- MockOutputApi())
- self.assertEqual(2, len(warnings))
- def testBlinkHeaders(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('third_party/blink/header.h', [
- 'class DummyClass;',
- 'struct DummyStruct;',
- ]),
- MockAffectedFile('third_party\\blink\\header.h', [
- 'class DummyClass;',
- 'struct DummyStruct;',
- ])
- ]
- warnings = PRESUBMIT.CheckUselessForwardDeclarations(mock_input_api,
- MockOutputApi())
- self.assertEqual(4, len(warnings))
- class RelativeIncludesTest(unittest.TestCase):
- def testThirdPartyNotWebKitIgnored(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('third_party/test.cpp', '#include "../header.h"'),
- MockAffectedFile('third_party/test/test.cpp', '#include "../header.h"'),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForRelativeIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(errors))
- def testNonCppFileIgnored(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('test.py', '#include "../header.h"'),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForRelativeIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(errors))
- def testInnocuousChangesAllowed(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('test.cpp', '#include "header.h"'),
- MockAffectedFile('test2.cpp', '../'),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForRelativeIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(errors))
- def testRelativeIncludeNonWebKitProducesError(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('test.cpp', ['#include "../header.h"']),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForRelativeIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(errors))
- def testRelativeIncludeWebKitProducesError(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('third_party/blink/test.cpp',
- ['#include "../header.h']),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForRelativeIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(errors))
- class CCIncludeTest(unittest.TestCase):
- def testThirdPartyNotBlinkIgnored(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('third_party/test.cpp', '#include "file.cc"'),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForCcIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(errors))
- def testPythonFileIgnored(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('test.py', '#include "file.cc"'),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForCcIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(errors))
- def testIncFilesAccepted(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('test.py', '#include "file.inc"'),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForCcIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(errors))
- def testInnocuousChangesAllowed(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('test.cpp', '#include "header.h"'),
- MockAffectedFile('test2.cpp', 'Something "file.cc"'),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForCcIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(errors))
- def testCcIncludeNonBlinkProducesError(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('test.cpp', ['#include "file.cc"']),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForCcIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(errors))
- def testCppIncludeBlinkProducesError(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('third_party/blink/test.cpp',
- ['#include "foo/file.cpp"']),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForCcIncludes(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(errors))
- class GnGlobForwardTest(unittest.TestCase):
- def testAddBareGlobs(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.gni', [
- 'forward_variables_from(invoker, "*")']),
- MockAffectedFile('base/BUILD.gn', [
- 'forward_variables_from(invoker, "*")']),
- ]
- warnings = PRESUBMIT.CheckGnGlobForward(mock_input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- msg = '\n'.join(warnings[0].items)
- self.assertIn('base/stuff.gni', msg)
- # Should not check .gn files. Local templates don't need to care about
- # visibility / testonly.
- self.assertNotIn('base/BUILD.gn', msg)
- def testValidUses(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.gni', [
- 'forward_variables_from(invoker, "*", [])']),
- MockAffectedFile('base/stuff2.gni', [
- 'forward_variables_from(invoker, "*", TESTONLY_AND_VISIBILITY)']),
- MockAffectedFile('base/stuff3.gni', [
- 'forward_variables_from(invoker, [ "testonly" ])']),
- ]
- warnings = PRESUBMIT.CheckGnGlobForward(mock_input_api, MockOutputApi())
- self.assertEqual([], warnings)
- class NewHeaderWithoutGnChangeTest(unittest.TestCase):
- def testAddHeaderWithoutGn(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.h', ''),
- ]
- warnings = PRESUBMIT.CheckNewHeaderWithoutGnChangeOnUpload(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertTrue('base/stuff.h' in warnings[0].items)
- def testModifyHeader(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.h', '', action='M'),
- ]
- warnings = PRESUBMIT.CheckNewHeaderWithoutGnChangeOnUpload(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testDeleteHeader(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.h', '', action='D'),
- ]
- warnings = PRESUBMIT.CheckNewHeaderWithoutGnChangeOnUpload(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testAddHeaderWithGn(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.h', ''),
- MockAffectedFile('base/BUILD.gn', 'stuff.h'),
- ]
- warnings = PRESUBMIT.CheckNewHeaderWithoutGnChangeOnUpload(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testAddHeaderWithGni(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.h', ''),
- MockAffectedFile('base/files.gni', 'stuff.h'),
- ]
- warnings = PRESUBMIT.CheckNewHeaderWithoutGnChangeOnUpload(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testAddHeaderWithOther(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.h', ''),
- MockAffectedFile('base/stuff.cc', 'stuff.h'),
- ]
- warnings = PRESUBMIT.CheckNewHeaderWithoutGnChangeOnUpload(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- def testAddHeaderWithWrongGn(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.h', ''),
- MockAffectedFile('base/BUILD.gn', 'stuff_h'),
- ]
- warnings = PRESUBMIT.CheckNewHeaderWithoutGnChangeOnUpload(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- def testAddHeadersWithGn(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.h', ''),
- MockAffectedFile('base/another.h', ''),
- MockAffectedFile('base/BUILD.gn', 'another.h\nstuff.h'),
- ]
- warnings = PRESUBMIT.CheckNewHeaderWithoutGnChangeOnUpload(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testAddHeadersWithWrongGn(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.h', ''),
- MockAffectedFile('base/another.h', ''),
- MockAffectedFile('base/BUILD.gn', 'another_h\nstuff.h'),
- ]
- warnings = PRESUBMIT.CheckNewHeaderWithoutGnChangeOnUpload(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertFalse('base/stuff.h' in warnings[0].items)
- self.assertTrue('base/another.h' in warnings[0].items)
- def testAddHeadersWithWrongGn2(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('base/stuff.h', ''),
- MockAffectedFile('base/another.h', ''),
- MockAffectedFile('base/BUILD.gn', 'another_h\nstuff_h'),
- ]
- warnings = PRESUBMIT.CheckNewHeaderWithoutGnChangeOnUpload(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertTrue('base/stuff.h' in warnings[0].items)
- self.assertTrue('base/another.h' in warnings[0].items)
- class CorrectProductNameInMessagesTest(unittest.TestCase):
- def testProductNameInDesc(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('chrome/app/google_chrome_strings.grd', [
- '<message name="Foo" desc="Welcome to Chrome">',
- ' Welcome to Chrome!',
- '</message>',
- ]),
- MockAffectedFile('chrome/app/chromium_strings.grd', [
- '<message name="Bar" desc="Welcome to Chrome">',
- ' Welcome to Chromium!',
- '</message>',
- ]),
- ]
- warnings = PRESUBMIT.CheckCorrectProductNameInMessages(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testChromeInChromium(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('chrome/app/google_chrome_strings.grd', [
- '<message name="Foo" desc="Welcome to Chrome">',
- ' Welcome to Chrome!',
- '</message>',
- ]),
- MockAffectedFile('chrome/app/chromium_strings.grd', [
- '<message name="Bar" desc="Welcome to Chrome">',
- ' Welcome to Chrome!',
- '</message>',
- ]),
- ]
- warnings = PRESUBMIT.CheckCorrectProductNameInMessages(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertTrue('chrome/app/chromium_strings.grd' in warnings[0].items[0])
- def testChromiumInChrome(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('chrome/app/google_chrome_strings.grd', [
- '<message name="Foo" desc="Welcome to Chrome">',
- ' Welcome to Chromium!',
- '</message>',
- ]),
- MockAffectedFile('chrome/app/chromium_strings.grd', [
- '<message name="Bar" desc="Welcome to Chrome">',
- ' Welcome to Chromium!',
- '</message>',
- ]),
- ]
- warnings = PRESUBMIT.CheckCorrectProductNameInMessages(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertTrue(
- 'chrome/app/google_chrome_strings.grd:2' in warnings[0].items[0])
- def testMultipleInstances(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('chrome/app/chromium_strings.grd', [
- '<message name="Bar" desc="Welcome to Chrome">',
- ' Welcome to Chrome!',
- '</message>',
- '<message name="Baz" desc="A correct message">',
- ' Chromium is the software you are using.',
- '</message>',
- '<message name="Bat" desc="An incorrect message">',
- ' Google Chrome is the software you are using.',
- '</message>',
- ]),
- ]
- warnings = PRESUBMIT.CheckCorrectProductNameInMessages(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertTrue(
- 'chrome/app/chromium_strings.grd:2' in warnings[0].items[0])
- self.assertTrue(
- 'chrome/app/chromium_strings.grd:8' in warnings[0].items[1])
- def testMultipleWarnings(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('chrome/app/chromium_strings.grd', [
- '<message name="Bar" desc="Welcome to Chrome">',
- ' Welcome to Chrome!',
- '</message>',
- '<message name="Baz" desc="A correct message">',
- ' Chromium is the software you are using.',
- '</message>',
- '<message name="Bat" desc="An incorrect message">',
- ' Google Chrome is the software you are using.',
- '</message>',
- ]),
- MockAffectedFile('components/components_google_chrome_strings.grd', [
- '<message name="Bar" desc="Welcome to Chrome">',
- ' Welcome to Chrome!',
- '</message>',
- '<message name="Baz" desc="A correct message">',
- ' Chromium is the software you are using.',
- '</message>',
- '<message name="Bat" desc="An incorrect message">',
- ' Google Chrome is the software you are using.',
- '</message>',
- ]),
- ]
- warnings = PRESUBMIT.CheckCorrectProductNameInMessages(
- mock_input_api, MockOutputApi())
- self.assertEqual(2, len(warnings))
- self.assertTrue(
- 'components/components_google_chrome_strings.grd:5'
- in warnings[0].items[0])
- self.assertTrue(
- 'chrome/app/chromium_strings.grd:2' in warnings[1].items[0])
- self.assertTrue(
- 'chrome/app/chromium_strings.grd:8' in warnings[1].items[1])
- class _SecurityOwnersTestCase(unittest.TestCase):
- def _createMockInputApi(self):
- mock_input_api = MockInputApi()
- def FakeRepositoryRoot():
- return mock_input_api.os_path.join('chromium', 'src')
- mock_input_api.change.RepositoryRoot = FakeRepositoryRoot
- self._injectFakeOwnersClient(
- mock_input_api,
- ['apple@chromium.org', 'orange@chromium.org'])
- return mock_input_api
- def _setupFakeChange(self, input_api):
- class FakeGerrit(object):
- def IsOwnersOverrideApproved(self, issue):
- return False
- input_api.change.issue = 123
- input_api.gerrit = FakeGerrit()
- def _injectFakeOwnersClient(self, input_api, owners):
- class FakeOwnersClient(object):
- def ListOwners(self, f):
- return owners
- input_api.owners_client = FakeOwnersClient()
- def _injectFakeChangeOwnerAndReviewers(self, input_api, owner, reviewers):
- def MockOwnerAndReviewers(input_api, email_regexp, approval_needed=False):
- return [owner, reviewers]
- input_api.canned_checks.GetCodereviewOwnerAndReviewers = \
- MockOwnerAndReviewers
- class IpcSecurityOwnerTest(_SecurityOwnersTestCase):
- _test_cases = [
- ('*_messages.cc', 'scary_messages.cc'),
- ('*_messages*.h', 'scary_messages.h'),
- ('*_messages*.h', 'scary_messages_android.h'),
- ('*_param_traits*.*', 'scary_param_traits.h'),
- ('*_param_traits*.*', 'scary_param_traits_win.h'),
- ('*.mojom', 'scary.mojom'),
- ('*_mojom_traits*.*', 'scary_mojom_traits.h'),
- ('*_mojom_traits*.*', 'scary_mojom_traits_mac.h'),
- ('*_type_converter*.*', 'scary_type_converter.h'),
- ('*_type_converter*.*', 'scary_type_converter_nacl.h'),
- ('*.aidl', 'scary.aidl'),
- ]
- def testHasCorrectPerFileRulesAndSecurityReviewer(self):
- mock_input_api = self._createMockInputApi()
- new_owners_file_path = mock_input_api.os_path.join(
- 'services', 'goat', 'public', 'OWNERS')
- new_owners_file = [
- 'per-file *.mojom=set noparent',
- 'per-file *.mojom=file://ipc/SECURITY_OWNERS'
- ]
- def FakeReadFile(filename):
- self.assertEqual(
- mock_input_api.os_path.join('chromium', 'src', new_owners_file_path),
- filename)
- return '\n'.join(new_owners_file)
- mock_input_api.ReadFile = FakeReadFile
- mock_input_api.files = [
- MockAffectedFile(
- new_owners_file_path, new_owners_file),
- MockAffectedFile(
- mock_input_api.os_path.join(
- 'services', 'goat', 'public', 'goat.mojom'),
- ['// Scary contents.'])]
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['orange@chromium.org'])
- mock_input_api.is_committing = True
- mock_input_api.dry_run = False
- mock_output_api = MockOutputApi()
- results = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual(0, len(results))
- def testMissingSecurityReviewerAtUpload(self):
- mock_input_api = self._createMockInputApi()
- new_owners_file_path = mock_input_api.os_path.join(
- 'services', 'goat', 'public', 'OWNERS')
- new_owners_file = [
- 'per-file *.mojom=set noparent',
- 'per-file *.mojom=file://ipc/SECURITY_OWNERS'
- ]
- def FakeReadFile(filename):
- self.assertEqual(
- mock_input_api.os_path.join('chromium', 'src', new_owners_file_path),
- filename)
- return '\n'.join(new_owners_file)
- mock_input_api.ReadFile = FakeReadFile
- mock_input_api.files = [
- MockAffectedFile(
- new_owners_file_path, new_owners_file),
- MockAffectedFile(
- mock_input_api.os_path.join(
- 'services', 'goat', 'public', 'goat.mojom'),
- ['// Scary contents.'])]
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_input_api.is_committing = False
- mock_input_api.dry_run = False
- mock_output_api = MockOutputApi()
- results = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(results))
- self.assertEqual('notify', results[0].type)
- self.assertEqual(
- 'Review from an owner in ipc/SECURITY_OWNERS is required for the '
- 'following newly-added files:', results[0].message)
- def testMissingSecurityReviewerAtDryRunCommit(self):
- mock_input_api = self._createMockInputApi()
- new_owners_file_path = mock_input_api.os_path.join(
- 'services', 'goat', 'public', 'OWNERS')
- new_owners_file = [
- 'per-file *.mojom=set noparent',
- 'per-file *.mojom=file://ipc/SECURITY_OWNERS'
- ]
- def FakeReadFile(filename):
- self.assertEqual(
- mock_input_api.os_path.join('chromium', 'src', new_owners_file_path),
- filename)
- return '\n'.join(new_owners_file)
- mock_input_api.ReadFile = FakeReadFile
- mock_input_api.files = [
- MockAffectedFile(
- new_owners_file_path, new_owners_file),
- MockAffectedFile(
- mock_input_api.os_path.join(
- 'services', 'goat', 'public', 'goat.mojom'),
- ['// Scary contents.'])]
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_input_api.is_committing = True
- mock_input_api.dry_run = True
- mock_output_api = MockOutputApi()
- results = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(results))
- self.assertEqual('error', results[0].type)
- self.assertEqual(
- 'Review from an owner in ipc/SECURITY_OWNERS is required for the '
- 'following newly-added files:', results[0].message)
- def testMissingSecurityApprovalAtRealCommit(self):
- mock_input_api = self._createMockInputApi()
- new_owners_file_path = mock_input_api.os_path.join(
- 'services', 'goat', 'public', 'OWNERS')
- new_owners_file = [
- 'per-file *.mojom=set noparent',
- 'per-file *.mojom=file://ipc/SECURITY_OWNERS'
- ]
- def FakeReadFile(filename):
- self.assertEqual(
- mock_input_api.os_path.join('chromium', 'src', new_owners_file_path),
- filename)
- return '\n'.join(new_owners_file)
- mock_input_api.ReadFile = FakeReadFile
- mock_input_api.files = [
- MockAffectedFile(
- new_owners_file_path, new_owners_file),
- MockAffectedFile(
- mock_input_api.os_path.join(
- 'services', 'goat', 'public', 'goat.mojom'),
- ['// Scary contents.'])]
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_input_api.is_committing = True
- mock_input_api.dry_run = False
- mock_output_api = MockOutputApi()
- results = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual('error', results[0].type)
- self.assertEqual(
- 'Review from an owner in ipc/SECURITY_OWNERS is required for the '
- 'following newly-added files:', results[0].message)
- def testIpcChangeNeedsSecurityOwner(self):
- for is_committing in [True, False]:
- for pattern, filename in self._test_cases:
- with self.subTest(
- line=f'is_committing={is_committing}, filename={filename}'):
- mock_input_api = self._createMockInputApi()
- mock_input_api.files = [
- MockAffectedFile(
- mock_input_api.os_path.join(
- 'services', 'goat', 'public', filename),
- ['// Scary contents.'])]
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_input_api.is_committing = is_committing
- mock_input_api.dry_run = False
- mock_output_api = MockOutputApi()
- results = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(results))
- self.assertEqual('error', results[0].type)
- self.assertTrue(results[0].message.replace('\\', '/').startswith(
- 'Found missing OWNERS lines for security-sensitive files. '
- 'Please add the following lines to services/goat/public/OWNERS:'))
- self.assertEqual(['ipc-security-reviews@chromium.org'],
- mock_output_api.more_cc)
- def testServiceManifestChangeNeedsSecurityOwner(self):
- mock_input_api = self._createMockInputApi()
- mock_input_api.files = [
- MockAffectedFile(
- mock_input_api.os_path.join(
- 'services', 'goat', 'public', 'cpp', 'manifest.cc'),
- [
- '#include "services/goat/public/cpp/manifest.h"',
- 'const service_manager::Manifest& GetManifest() {}',
- ])]
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertTrue(errors[0].message.replace('\\', '/').startswith(
- 'Found missing OWNERS lines for security-sensitive files. '
- 'Please add the following lines to services/goat/public/cpp/OWNERS:'))
- self.assertEqual(['ipc-security-reviews@chromium.org'], mock_output_api.more_cc)
- def testNonServiceManifestSourceChangesDoNotRequireSecurityOwner(self):
- mock_input_api = self._createMockInputApi()
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_input_api.files = [
- MockAffectedFile('some/non/service/thing/foo_manifest.cc',
- [
- 'const char kNoEnforcement[] = "not a manifest!";',
- ])]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual([], errors)
- self.assertEqual([], mock_output_api.more_cc)
- class FuchsiaSecurityOwnerTest(_SecurityOwnersTestCase):
- def testFidlChangeNeedsSecurityOwner(self):
- mock_input_api = self._createMockInputApi()
- mock_input_api.files = [
- MockAffectedFile('potentially/scary/ipc.fidl',
- [
- 'library test.fidl'
- ])]
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertTrue(errors[0].message.replace('\\', '/').startswith(
- 'Found missing OWNERS lines for security-sensitive files. '
- 'Please add the following lines to potentially/scary/OWNERS:'))
- def testComponentManifestV1ChangeNeedsSecurityOwner(self):
- mock_input_api = self._createMockInputApi()
- mock_input_api.files = [
- MockAffectedFile('potentially/scary/v2_manifest.cmx',
- [
- '{ "that is no": "manifest!" }'
- ])]
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertTrue(errors[0].message.replace('\\', '/').startswith(
- 'Found missing OWNERS lines for security-sensitive files. '
- 'Please add the following lines to potentially/scary/OWNERS:'))
- def testComponentManifestV2NeedsSecurityOwner(self):
- mock_input_api = self._createMockInputApi()
- mock_input_api.files = [
- MockAffectedFile('potentially/scary/v2_manifest.cml',
- [
- '{ "that is no": "manifest!" }'
- ])]
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertTrue(errors[0].message.replace('\\', '/').startswith(
- 'Found missing OWNERS lines for security-sensitive files. '
- 'Please add the following lines to potentially/scary/OWNERS:'))
- def testThirdPartyTestsDoNotRequireSecurityOwner(self):
- mock_input_api = MockInputApi()
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_input_api.files = [
- MockAffectedFile('third_party/crashpad/test/tests.cmx',
- [
- 'const char kNoEnforcement[] = "Security?!? Pah!";',
- ])]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual([], errors)
- def testOtherFuchsiaChangesDoNotRequireSecurityOwner(self):
- mock_input_api = MockInputApi()
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_input_api.files = [
- MockAffectedFile('some/non/service/thing/fuchsia_fidl_cml_cmx_magic.cc',
- [
- 'const char kNoEnforcement[] = "Security?!? Pah!";',
- ])]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckSecurityOwners(
- mock_input_api, mock_output_api)
- self.assertEqual([], errors)
- class SecurityChangeTest(_SecurityOwnersTestCase):
- def testDiffGetServiceSandboxType(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile(
- 'services/goat/teleporter_host.cc',
- [
- 'template <>',
- 'inline content::SandboxType',
- 'content::GetServiceSandboxType<chrome::mojom::GoatTeleporter>() {',
- '#if defined(OS_WIN)',
- ' return SandboxType::kGoaty;',
- '#else',
- ' return SandboxType::kNoSandbox;',
- '#endif // !defined(OS_WIN)',
- '}'
- ]
- ),
- ]
- files_to_functions = PRESUBMIT._GetFilesUsingSecurityCriticalFunctions(
- mock_input_api)
- self.assertEqual({
- 'services/goat/teleporter_host.cc': set([
- 'content::GetServiceSandboxType<>()'
- ])},
- files_to_functions)
- def testDiffRemovingLine(self):
- mock_input_api = MockInputApi()
- mock_file = MockAffectedFile('services/goat/teleporter_host.cc', '')
- mock_file._scm_diff = """--- old 2020-05-04 14:08:25.000000000 -0400
- +++ new 2020-05-04 14:08:32.000000000 -0400
- @@ -1,5 +1,4 @@
- template <>
- inline content::SandboxType
- -content::GetServiceSandboxType<chrome::mojom::GoatTeleporter>() {
- #if defined(OS_WIN)
- return SandboxType::kGoaty;
- """
- mock_input_api.files = [mock_file]
- files_to_functions = PRESUBMIT._GetFilesUsingSecurityCriticalFunctions(
- mock_input_api)
- self.assertEqual({
- 'services/goat/teleporter_host.cc': set([
- 'content::GetServiceSandboxType<>()'
- ])},
- files_to_functions)
- def testChangeOwnersMissing(self):
- mock_input_api = self._createMockInputApi()
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_input_api.is_committing = False
- mock_input_api.files = [
- MockAffectedFile('file.cc', ['GetServiceSandboxType<Goat>(Sandbox)'])
- ]
- mock_output_api = MockOutputApi()
- result = PRESUBMIT.CheckSecurityChanges(mock_input_api, mock_output_api)
- self.assertEqual(1, len(result))
- self.assertEqual(result[0].type, 'notify')
- self.assertEqual(result[0].message,
- 'The following files change calls to security-sensitive functions\n' \
- 'that need to be reviewed by ipc/SECURITY_OWNERS.\n'
- ' file.cc\n'
- ' content::GetServiceSandboxType<>()\n\n')
- def testChangeOwnersMissingAtCommit(self):
- mock_input_api = self._createMockInputApi()
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org', ['banana@chromium.org'])
- mock_input_api.is_committing = True
- mock_input_api.dry_run = False
- mock_input_api.files = [
- MockAffectedFile('file.cc', ['GetServiceSandboxType<mojom::Goat>()'])
- ]
- mock_output_api = MockOutputApi()
- result = PRESUBMIT.CheckSecurityChanges(mock_input_api, mock_output_api)
- self.assertEqual(1, len(result))
- self.assertEqual(result[0].type, 'error')
- self.assertEqual(result[0].message,
- 'The following files change calls to security-sensitive functions\n' \
- 'that need to be reviewed by ipc/SECURITY_OWNERS.\n'
- ' file.cc\n'
- ' content::GetServiceSandboxType<>()\n\n')
- def testChangeOwnersPresent(self):
- mock_input_api = self._createMockInputApi()
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'owner@chromium.org',
- ['apple@chromium.org', 'banana@chromium.org'])
- mock_input_api.files = [
- MockAffectedFile('file.cc', ['WithSandboxType(Sandbox)'])
- ]
- mock_output_api = MockOutputApi()
- result = PRESUBMIT.CheckSecurityChanges(mock_input_api, mock_output_api)
- self.assertEqual(0, len(result))
- def testChangeOwnerIsSecurityOwner(self):
- mock_input_api = self._createMockInputApi()
- self._setupFakeChange(mock_input_api)
- self._injectFakeChangeOwnerAndReviewers(
- mock_input_api, 'orange@chromium.org', ['pear@chromium.org'])
- mock_input_api.files = [
- MockAffectedFile('file.cc', ['GetServiceSandboxType<T>(Sandbox)'])
- ]
- mock_output_api = MockOutputApi()
- result = PRESUBMIT.CheckSecurityChanges(mock_input_api, mock_output_api)
- self.assertEqual(1, len(result))
- class BannedTypeCheckTest(unittest.TestCase):
- def testBannedCppFunctions(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('some/cpp/problematic/file.cc',
- ['using namespace std;']),
- MockFile('third_party/blink/problematic/file.cc',
- ['GetInterfaceProvider()']),
- MockFile('some/cpp/ok/file.cc',
- ['using std::string;']),
- MockFile('some/cpp/problematic/file2.cc',
- ['set_owned_by_client()']),
- MockFile('some/cpp/nocheck/file.cc',
- ['using namespace std; // nocheck']),
- MockFile('some/cpp/comment/file.cc',
- [' // A comment about `using namespace std;`']),
- ]
- results = PRESUBMIT.CheckNoBannedFunctions(input_api, MockOutputApi())
- # warnings are results[0], errors are results[1]
- self.assertEqual(2, len(results))
- self.assertTrue('some/cpp/problematic/file.cc' in results[1].message)
- self.assertTrue(
- 'third_party/blink/problematic/file.cc' in results[0].message)
- self.assertTrue('some/cpp/ok/file.cc' not in results[1].message)
- self.assertTrue('some/cpp/problematic/file2.cc' in results[0].message)
- self.assertFalse('some/cpp/nocheck/file.cc' in results[0].message)
- self.assertFalse('some/cpp/nocheck/file.cc' in results[1].message)
- self.assertFalse('some/cpp/comment/file.cc' in results[0].message)
- self.assertFalse('some/cpp/comment/file.cc' in results[1].message)
- def testBannedIosObjcFunctions(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('some/ios/file.mm',
- ['TEST(SomeClassTest, SomeInteraction) {',
- '}']),
- MockFile('some/mac/file.mm',
- ['TEST(SomeClassTest, SomeInteraction) {',
- '}']),
- MockFile('another/ios_file.mm',
- ['class SomeTest : public testing::Test {};']),
- MockFile('some/ios/file_egtest.mm',
- ['- (void)testSomething { EXPECT_OCMOCK_VERIFY(aMock); }']),
- MockFile('some/ios/file_unittest.mm',
- ['TEST_F(SomeTest, TestThis) { EXPECT_OCMOCK_VERIFY(aMock); }']),
- ]
- errors = PRESUBMIT.CheckNoBannedFunctions(input_api, MockOutputApi())
- self.assertEqual(1, len(errors))
- self.assertTrue('some/ios/file.mm' in errors[0].message)
- self.assertTrue('another/ios_file.mm' in errors[0].message)
- self.assertTrue('some/mac/file.mm' not in errors[0].message)
- self.assertTrue('some/ios/file_egtest.mm' in errors[0].message)
- self.assertTrue('some/ios/file_unittest.mm' not in errors[0].message)
- def testBannedMojoFunctions(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('some/cpp/problematic/file2.cc',
- ['mojo::ConvertTo<>']),
- MockFile('third_party/blink/ok/file3.cc',
- ['mojo::ConvertTo<>']),
- MockFile('content/renderer/ok/file3.cc',
- ['mojo::ConvertTo<>']),
- ]
- results = PRESUBMIT.CheckNoBannedFunctions(input_api, MockOutputApi())
- # warnings are results[0], errors are results[1]
- self.assertEqual(1, len(results))
- self.assertTrue('some/cpp/problematic/file2.cc' in results[0].message)
- self.assertTrue('third_party/blink/ok/file3.cc' not in results[0].message)
- self.assertTrue('content/renderer/ok/file3.cc' not in results[0].message)
- def testBannedMojomPatterns(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('bad.mojom',
- ['struct Bad {',
- ' handle<shared_buffer> buffer;',
- '};']),
- MockFile('good.mojom',
- ['struct Good {',
- ' mojo_base.mojom.ReadOnlySharedMemoryRegion region1;',
- ' mojo_base.mojom.WritableSharedMemoryRegion region2;',
- ' mojo_base.mojom.UnsafeSharedMemoryRegion region3;',
- '};']),
- ]
- results = PRESUBMIT.CheckNoBannedFunctions(input_api, MockOutputApi())
- # warnings are results[0], errors are results[1]
- self.assertEqual(1, len(results))
- self.assertTrue('bad.mojom' in results[0].message)
- self.assertTrue('good.mojom' not in results[0].message)
- class NoProductionCodeUsingTestOnlyFunctionsTest(unittest.TestCase):
- def testTruePositives(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('some/path/foo.cc', ['foo_for_testing();']),
- MockFile('some/path/foo.mm', ['FooForTesting();']),
- MockFile('some/path/foo.cxx', ['FooForTests();']),
- MockFile('some/path/foo.cpp', ['foo_for_test();']),
- ]
- results = PRESUBMIT.CheckNoProductionCodeUsingTestOnlyFunctions(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(results))
- self.assertEqual(4, len(results[0].items))
- self.assertTrue('foo.cc' in results[0].items[0])
- self.assertTrue('foo.mm' in results[0].items[1])
- self.assertTrue('foo.cxx' in results[0].items[2])
- self.assertTrue('foo.cpp' in results[0].items[3])
- def testFalsePositives(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('some/path/foo.h', ['foo_for_testing();']),
- MockFile('some/path/foo.mm', ['FooForTesting() {']),
- MockFile('some/path/foo.cc', ['::FooForTests();']),
- MockFile('some/path/foo.cpp', ['// foo_for_test();']),
- ]
- results = PRESUBMIT.CheckNoProductionCodeUsingTestOnlyFunctions(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(results))
- def testAllowedFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('path/foo_unittest.cc', ['foo_for_testing();']),
- MockFile('path/bar_unittest_mac.cc', ['foo_for_testing();']),
- MockFile('path/baz_unittests.cc', ['foo_for_testing();']),
- ]
- results = PRESUBMIT.CheckNoProductionCodeUsingTestOnlyFunctions(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(results))
- class NoProductionJavaCodeUsingTestOnlyFunctionsTest(unittest.TestCase):
- def testTruePositives(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('dir/java/src/foo.java', ['FooForTesting();']),
- MockFile('dir/java/src/bar.java', ['FooForTests(x);']),
- MockFile('dir/java/src/baz.java', ['FooForTest(', 'y', ');']),
- MockFile('dir/java/src/mult.java', [
- 'int x = SomethingLongHere()',
- ' * SomethingLongHereForTesting();'
- ])
- ]
- results = PRESUBMIT.CheckNoProductionCodeUsingTestOnlyFunctionsJava(
- mock_input_api, MockOutputApi())
- self.assertEqual(1, len(results))
- self.assertEqual(4, len(results[0].items))
- self.assertTrue('foo.java' in results[0].items[0])
- self.assertTrue('bar.java' in results[0].items[1])
- self.assertTrue('baz.java' in results[0].items[2])
- self.assertTrue('mult.java' in results[0].items[3])
- def testFalsePositives(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('dir/java/src/foo.xml', ['FooForTesting();']),
- MockFile('dir/java/src/foo.java', ['FooForTests() {']),
- MockFile('dir/java/src/bar.java', ['// FooForTest();']),
- MockFile('dir/java/src/bar2.java', ['x = 1; // FooForTest();']),
- MockFile('dir/java/src/bar3.java', ['@VisibleForTesting']),
- MockFile('dir/java/src/bar4.java', ['@VisibleForTesting()']),
- MockFile('dir/java/src/bar5.java', [
- '@VisibleForTesting(otherwise = VisibleForTesting.PROTECTED)'
- ]),
- MockFile('dir/javatests/src/baz.java', ['FooForTest(', 'y', ');']),
- MockFile('dir/junit/src/baz.java', ['FooForTest(', 'y', ');']),
- MockFile('dir/junit/src/javadoc.java', [
- '/** Use FooForTest(); to obtain foo in tests.'
- ' */'
- ]),
- MockFile('dir/junit/src/javadoc2.java', [
- '/** ',
- ' * Use FooForTest(); to obtain foo in tests.'
- ' */'
- ]),
- ]
- results = PRESUBMIT.CheckNoProductionCodeUsingTestOnlyFunctionsJava(
- mock_input_api, MockOutputApi())
- self.assertEqual(0, len(results))
- class NewImagesWarningTest(unittest.TestCase):
- def testTruePositives(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('dir/android/res/drawable/foo.png', []),
- MockFile('dir/android/res/drawable-v21/bar.svg', []),
- MockFile('dir/android/res/mipmap-v21-en/baz.webp', []),
- MockFile('dir/android/res_gshoe/drawable-mdpi/foobar.png', []),
- ]
- results = PRESUBMIT._CheckNewImagesWarning(mock_input_api, MockOutputApi())
- self.assertEqual(1, len(results))
- self.assertEqual(4, len(results[0].items))
- self.assertTrue('foo.png' in results[0].items[0].LocalPath())
- self.assertTrue('bar.svg' in results[0].items[1].LocalPath())
- self.assertTrue('baz.webp' in results[0].items[2].LocalPath())
- self.assertTrue('foobar.png' in results[0].items[3].LocalPath())
- def testFalsePositives(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('dir/pngs/README.md', []),
- MockFile('java/test/res/drawable/foo.png', []),
- MockFile('third_party/blink/foo.png', []),
- MockFile('dir/third_party/libpng/src/foo.cc', ['foobar']),
- MockFile('dir/resources.webp/.gitignore', ['foo.png']),
- ]
- results = PRESUBMIT._CheckNewImagesWarning(mock_input_api, MockOutputApi())
- self.assertEqual(0, len(results))
- class ProductIconsTest(unittest.TestCase):
- def test(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('components/vector_icons/google_jetpack.icon', []),
- MockFile('components/vector_icons/generic_jetpack.icon', []),
- ]
- results = PRESUBMIT.CheckNoProductIconsAddedToPublicRepo(mock_input_api, MockOutputApi())
- self.assertEqual(1, len(results))
- self.assertEqual(1, len(results[0].items))
- self.assertTrue('google_jetpack.icon' in results[0].items[0])
- class CheckUniquePtrTest(unittest.TestCase):
- def testTruePositivesNullptr(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('dir/baz.cc', ['std::unique_ptr<T>()']),
- MockFile('dir/baz-p.cc', ['std::unique_ptr<T<P>>()']),
- ]
- results = PRESUBMIT.CheckUniquePtrOnUpload(mock_input_api, MockOutputApi())
- self.assertEqual(1, len(results))
- self.assertTrue('nullptr' in results[0].message)
- self.assertEqual(2, len(results[0].items))
- self.assertTrue('baz.cc' in results[0].items[0])
- self.assertTrue('baz-p.cc' in results[0].items[1])
- def testTruePositivesConstructor(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('dir/foo.cc', ['return std::unique_ptr<T>(foo);']),
- MockFile('dir/bar.mm', ['bar = std::unique_ptr<T>(foo)']),
- MockFile('dir/mult.cc', [
- 'return',
- ' std::unique_ptr<T>(barVeryVeryLongFooSoThatItWouldNotFitAbove);'
- ]),
- MockFile('dir/mult2.cc', [
- 'barVeryVeryLongLongBaaaaaarSoThatTheLineLimitIsAlmostReached =',
- ' std::unique_ptr<T>(foo);'
- ]),
- MockFile('dir/mult3.cc', [
- 'bar = std::unique_ptr<T>(',
- ' fooVeryVeryVeryLongStillGoingWellThisWillTakeAWhileFinallyThere);'
- ]),
- MockFile('dir/multi_arg.cc', [
- 'auto p = std::unique_ptr<std::pair<T, D>>(new std::pair(T, D));']),
- ]
- results = PRESUBMIT.CheckUniquePtrOnUpload(mock_input_api, MockOutputApi())
- self.assertEqual(1, len(results))
- self.assertTrue('std::make_unique' in results[0].message)
- self.assertEqual(6, len(results[0].items))
- self.assertTrue('foo.cc' in results[0].items[0])
- self.assertTrue('bar.mm' in results[0].items[1])
- self.assertTrue('mult.cc' in results[0].items[2])
- self.assertTrue('mult2.cc' in results[0].items[3])
- self.assertTrue('mult3.cc' in results[0].items[4])
- self.assertTrue('multi_arg.cc' in results[0].items[5])
- def testFalsePositives(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('dir/foo.cc', ['return std::unique_ptr<T[]>(foo);']),
- MockFile('dir/bar.mm', ['bar = std::unique_ptr<T[]>(foo)']),
- MockFile('dir/file.cc', ['std::unique_ptr<T> p = Foo();']),
- MockFile('dir/baz.cc', [
- 'std::unique_ptr<T> result = std::make_unique<T>();'
- ]),
- MockFile('dir/baz2.cc', [
- 'std::unique_ptr<T> result = std::make_unique<T>('
- ]),
- MockFile('dir/nested.cc', ['set<std::unique_ptr<T>>();']),
- MockFile('dir/nested2.cc', ['map<U, std::unique_ptr<T>>();']),
- # Two-argument invocation of std::unique_ptr is exempt because there is
- # no equivalent using std::make_unique.
- MockFile('dir/multi_arg.cc', [
- 'auto p = std::unique_ptr<T, D>(new T(), D());']),
- ]
- results = PRESUBMIT.CheckUniquePtrOnUpload(mock_input_api, MockOutputApi())
- self.assertEqual(0, len(results))
- class CheckNoDirectIncludesHeadersWhichRedefineStrCat(unittest.TestCase):
- def testBlocksDirectIncludes(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('dir/foo_win.cc', ['#include "shlwapi.h"']),
- MockFile('dir/bar.h', ['#include <propvarutil.h>']),
- MockFile('dir/baz.h', ['#include <atlbase.h>']),
- MockFile('dir/jumbo.h', ['#include "sphelper.h"']),
- ]
- results = PRESUBMIT.CheckNoStrCatRedefines(mock_input_api, MockOutputApi())
- self.assertEqual(1, len(results))
- self.assertEqual(4, len(results[0].items))
- self.assertTrue('StrCat' in results[0].message)
- self.assertTrue('foo_win.cc' in results[0].items[0])
- self.assertTrue('bar.h' in results[0].items[1])
- self.assertTrue('baz.h' in results[0].items[2])
- self.assertTrue('jumbo.h' in results[0].items[3])
- def testAllowsToIncludeWrapper(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('dir/baz_win.cc', ['#include "base/win/shlwapi.h"']),
- MockFile('dir/baz-win.h', ['#include "base/win/atl.h"']),
- ]
- results = PRESUBMIT.CheckNoStrCatRedefines(mock_input_api, MockOutputApi())
- self.assertEqual(0, len(results))
- def testAllowsToCreateWrapper(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('base/win/shlwapi.h', [
- '#include <shlwapi.h>',
- '#include "base/win/windows_defines.inc"']),
- ]
- results = PRESUBMIT.CheckNoStrCatRedefines(mock_input_api, MockOutputApi())
- self.assertEqual(0, len(results))
- def testIgnoresNonImplAndHeaders(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('dir/foo_win.txt', ['#include "shlwapi.h"']),
- MockFile('dir/bar.asm', ['#include <propvarutil.h>']),
- ]
- results = PRESUBMIT.CheckNoStrCatRedefines(mock_input_api, MockOutputApi())
- self.assertEqual(0, len(results))
- class StringTest(unittest.TestCase):
- """Tests ICU syntax check and translation screenshots check."""
- # An empty grd file.
- OLD_GRD_CONTENTS = """<?xml version="1.0" encoding="UTF-8"?>
- <grit latest_public_release="1" current_release="1">
- <release seq="1">
- <messages></messages>
- </release>
- </grit>
- """.splitlines()
- # A grd file with a single message.
- NEW_GRD_CONTENTS1 = """<?xml version="1.0" encoding="UTF-8"?>
- <grit latest_public_release="1" current_release="1">
- <release seq="1">
- <messages>
- <message name="IDS_TEST1">
- Test string 1
- </message>
- <message name="IDS_TEST_STRING_NON_TRANSLATEABLE1"
- translateable="false">
- Non translateable message 1, should be ignored
- </message>
- <message name="IDS_TEST_STRING_ACCESSIBILITY"
- is_accessibility_with_no_ui="true">
- Accessibility label 1, should be ignored
- </message>
- </messages>
- </release>
- </grit>
- """.splitlines()
- # A grd file with two messages.
- NEW_GRD_CONTENTS2 = """<?xml version="1.0" encoding="UTF-8"?>
- <grit latest_public_release="1" current_release="1">
- <release seq="1">
- <messages>
- <message name="IDS_TEST1">
- Test string 1
- </message>
- <message name="IDS_TEST2">
- Test string 2
- </message>
- <message name="IDS_TEST_STRING_NON_TRANSLATEABLE2"
- translateable="false">
- Non translateable message 2, should be ignored
- </message>
- </messages>
- </release>
- </grit>
- """.splitlines()
- # A grd file with one ICU syntax message without syntax errors.
- NEW_GRD_CONTENTS_ICU_SYNTAX_OK1 = """<?xml version="1.0" encoding="UTF-8"?>
- <grit latest_public_release="1" current_release="1">
- <release seq="1">
- <messages>
- <message name="IDS_TEST1">
- {NUM, plural,
- =1 {Test text for numeric one}
- other {Test text for plural with {NUM} as number}}
- </message>
- </messages>
- </release>
- </grit>
- """.splitlines()
- # A grd file with one ICU syntax message without syntax errors.
- NEW_GRD_CONTENTS_ICU_SYNTAX_OK2 = """<?xml version="1.0" encoding="UTF-8"?>
- <grit latest_public_release="1" current_release="1">
- <release seq="1">
- <messages>
- <message name="IDS_TEST1">
- {NUM, plural,
- =1 {Different test text for numeric one}
- other {Different test text for plural with {NUM} as number}}
- </message>
- </messages>
- </release>
- </grit>
- """.splitlines()
- # A grd file with one ICU syntax message with syntax errors (misses a comma).
- NEW_GRD_CONTENTS_ICU_SYNTAX_ERROR = """<?xml version="1.0" encoding="UTF-8"?>
- <grit latest_public_release="1" current_release="1">
- <release seq="1">
- <messages>
- <message name="IDS_TEST1">
- {NUM, plural
- =1 {Test text for numeric one}
- other {Test text for plural with {NUM} as number}}
- </message>
- </messages>
- </release>
- </grit>
- """.splitlines()
- OLD_GRDP_CONTENTS = (
- '<?xml version="1.0" encoding="utf-8"?>',
- '<grit-part>',
- '</grit-part>'
- )
- NEW_GRDP_CONTENTS1 = (
- '<?xml version="1.0" encoding="utf-8"?>',
- '<grit-part>',
- '<message name="IDS_PART_TEST1">',
- 'Part string 1',
- '</message>',
- '</grit-part>')
- NEW_GRDP_CONTENTS2 = (
- '<?xml version="1.0" encoding="utf-8"?>',
- '<grit-part>',
- '<message name="IDS_PART_TEST1">',
- 'Part string 1',
- '</message>',
- '<message name="IDS_PART_TEST2">',
- 'Part string 2',
- '</message>',
- '</grit-part>')
- NEW_GRDP_CONTENTS3 = (
- '<?xml version="1.0" encoding="utf-8"?>',
- '<grit-part>',
- '<message name="IDS_PART_TEST1" desc="Description with typo.">',
- 'Part string 1',
- '</message>',
- '</grit-part>')
- NEW_GRDP_CONTENTS4 = (
- '<?xml version="1.0" encoding="utf-8"?>',
- '<grit-part>',
- '<message name="IDS_PART_TEST1" desc="Description with typo fixed.">',
- 'Part string 1',
- '</message>',
- '</grit-part>')
- NEW_GRDP_CONTENTS5 = (
- '<?xml version="1.0" encoding="utf-8"?>',
- '<grit-part>',
- '<message name="IDS_PART_TEST1" meaning="Meaning with typo.">',
- 'Part string 1',
- '</message>',
- '</grit-part>')
- NEW_GRDP_CONTENTS6 = (
- '<?xml version="1.0" encoding="utf-8"?>',
- '<grit-part>',
- '<message name="IDS_PART_TEST1" meaning="Meaning with typo fixed.">',
- 'Part string 1',
- '</message>',
- '</grit-part>')
- # A grdp file with one ICU syntax message without syntax errors.
- NEW_GRDP_CONTENTS_ICU_SYNTAX_OK1 = (
- '<?xml version="1.0" encoding="utf-8"?>',
- '<grit-part>',
- '<message name="IDS_PART_TEST1">',
- '{NUM, plural,',
- '=1 {Test text for numeric one}',
- 'other {Test text for plural with {NUM} as number}}',
- '</message>',
- '</grit-part>')
- # A grdp file with one ICU syntax message without syntax errors.
- NEW_GRDP_CONTENTS_ICU_SYNTAX_OK2 = (
- '<?xml version="1.0" encoding="utf-8"?>',
- '<grit-part>',
- '<message name="IDS_PART_TEST1">',
- '{NUM, plural,',
- '=1 {Different test text for numeric one}',
- 'other {Different test text for plural with {NUM} as number}}',
- '</message>',
- '</grit-part>')
- # A grdp file with one ICU syntax message with syntax errors (superfluent
- # whitespace).
- NEW_GRDP_CONTENTS_ICU_SYNTAX_ERROR = (
- '<?xml version="1.0" encoding="utf-8"?>',
- '<grit-part>',
- '<message name="IDS_PART_TEST1">',
- '{NUM, plural,',
- '= 1 {Test text for numeric one}',
- 'other {Test text for plural with {NUM} as number}}',
- '</message>',
- '</grit-part>')
- DO_NOT_UPLOAD_PNG_MESSAGE = ('Do not include actual screenshots in the '
- 'changelist. Run '
- 'tools/translate/upload_screenshots.py to '
- 'upload them instead:')
- GENERATE_SIGNATURES_MESSAGE = ('You are adding or modifying UI strings.\n'
- 'To ensure the best translations, take '
- 'screenshots of the relevant UI '
- '(https://g.co/chrome/translation) and add '
- 'these files to your changelist:')
- REMOVE_SIGNATURES_MESSAGE = ('You removed strings associated with these '
- 'files. Remove:')
- ICU_SYNTAX_ERROR_MESSAGE = ('ICU syntax errors were found in the following '
- 'strings (problems or feedback? Contact '
- 'rainhard@chromium.org):')
- def makeInputApi(self, files):
- input_api = MockInputApi()
- input_api.files = files
- # Override os_path.exists because the presubmit uses the actual
- # os.path.exists.
- input_api.CreateMockFileInPath(
- [x.LocalPath() for x in input_api.AffectedFiles(include_deletes=True)])
- return input_api
- """ CL modified and added messages, but didn't add any screenshots."""
- def testNoScreenshots(self):
- # No new strings (file contents same). Should not warn.
- input_api = self.makeInputApi([
- MockAffectedFile('test.grd', self.NEW_GRD_CONTENTS1,
- self.NEW_GRD_CONTENTS1, action='M'),
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS1,
- self.NEW_GRDP_CONTENTS1, action='M')])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- # Add two new strings. Should have two warnings.
- input_api = self.makeInputApi([
- MockAffectedFile('test.grd', self.NEW_GRD_CONTENTS2,
- self.NEW_GRD_CONTENTS1, action='M'),
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS2,
- self.NEW_GRDP_CONTENTS1, action='M')])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertEqual(self.GENERATE_SIGNATURES_MESSAGE, warnings[0].message)
- self.assertEqual('error', warnings[0].type)
- self.assertEqual([
- os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
- os.path.join('test_grd', 'IDS_TEST2.png.sha1')],
- warnings[0].items)
- # Add four new strings. Should have four warnings.
- input_api = self.makeInputApi([
- MockAffectedFile('test.grd', self.NEW_GRD_CONTENTS2,
- self.OLD_GRD_CONTENTS, action='M'),
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS2,
- self.OLD_GRDP_CONTENTS, action='M')])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertEqual('error', warnings[0].type)
- self.assertEqual(self.GENERATE_SIGNATURES_MESSAGE, warnings[0].message)
- self.assertEqual([
- os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
- os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
- os.path.join('test_grd', 'IDS_TEST1.png.sha1'),
- os.path.join('test_grd', 'IDS_TEST2.png.sha1'),
- ], warnings[0].items)
- def testModifiedMessageDescription(self):
- # CL modified a message description for a message that does not yet have a
- # screenshot. Should not warn.
- input_api = self.makeInputApi([
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS3,
- self.NEW_GRDP_CONTENTS4, action='M')])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- # CL modified a message description for a message that already has a
- # screenshot. Should not warn.
- input_api = self.makeInputApi([
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS3,
- self.NEW_GRDP_CONTENTS4, action='M'),
- MockFile(os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
- 'binary', action='A')])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testModifiedMessageMeaning(self):
- # CL modified a message meaning for a message that does not yet have a
- # screenshot. Should warn.
- input_api = self.makeInputApi([
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS5,
- self.NEW_GRDP_CONTENTS6, action='M')])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- # CL modified a message meaning for a message that already has a
- # screenshot. Should not warn.
- input_api = self.makeInputApi([
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS5,
- self.NEW_GRDP_CONTENTS6, action='M'),
- MockFile(os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
- 'binary', action='A')])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(0, len(warnings))
- def testPngAddedSha1NotAdded(self):
- # CL added one new message in a grd file and added the png file associated
- # with it, but did not add the corresponding sha1 file. This should warn
- # twice:
- # - Once for the added png file (because we don't want developers to upload
- # actual images)
- # - Once for the missing .sha1 file
- input_api = self.makeInputApi([
- MockAffectedFile(
- 'test.grd',
- self.NEW_GRD_CONTENTS1,
- self.OLD_GRD_CONTENTS,
- action='M'),
- MockAffectedFile(
- os.path.join('test_grd', 'IDS_TEST1.png'), 'binary', action='A')
- ])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(2, len(warnings))
- self.assertEqual('error', warnings[0].type)
- self.assertEqual(self.DO_NOT_UPLOAD_PNG_MESSAGE, warnings[0].message)
- self.assertEqual([os.path.join('test_grd', 'IDS_TEST1.png')],
- warnings[0].items)
- self.assertEqual('error', warnings[1].type)
- self.assertEqual(self.GENERATE_SIGNATURES_MESSAGE, warnings[1].message)
- self.assertEqual([os.path.join('test_grd', 'IDS_TEST1.png.sha1')],
- warnings[1].items)
- # CL added two messages (one in grd, one in grdp) and added the png files
- # associated with the messages, but did not add the corresponding sha1
- # files. This should warn twice:
- # - Once for the added png files (because we don't want developers to upload
- # actual images)
- # - Once for the missing .sha1 files
- input_api = self.makeInputApi([
- # Modified files:
- MockAffectedFile(
- 'test.grd',
- self.NEW_GRD_CONTENTS1,
- self.OLD_GRD_CONTENTS,
- action='M'),
- MockAffectedFile(
- 'part.grdp',
- self.NEW_GRDP_CONTENTS1,
- self.OLD_GRDP_CONTENTS,
- action='M'),
- # Added files:
- MockAffectedFile(
- os.path.join('test_grd', 'IDS_TEST1.png'), 'binary', action='A'),
- MockAffectedFile(
- os.path.join('part_grdp', 'IDS_PART_TEST1.png'), 'binary',
- action='A')
- ])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(2, len(warnings))
- self.assertEqual('error', warnings[0].type)
- self.assertEqual(self.DO_NOT_UPLOAD_PNG_MESSAGE, warnings[0].message)
- self.assertEqual([os.path.join('part_grdp', 'IDS_PART_TEST1.png'),
- os.path.join('test_grd', 'IDS_TEST1.png')],
- warnings[0].items)
- self.assertEqual('error', warnings[0].type)
- self.assertEqual(self.GENERATE_SIGNATURES_MESSAGE, warnings[1].message)
- self.assertEqual([os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
- os.path.join('test_grd', 'IDS_TEST1.png.sha1')],
- warnings[1].items)
- def testScreenshotsWithSha1(self):
- # CL added four messages (two each in a grd and grdp) and their
- # corresponding .sha1 files. No warnings.
- input_api = self.makeInputApi([
- # Modified files:
- MockAffectedFile(
- 'test.grd',
- self.NEW_GRD_CONTENTS2,
- self.OLD_GRD_CONTENTS,
- action='M'),
- MockAffectedFile(
- 'part.grdp',
- self.NEW_GRDP_CONTENTS2,
- self.OLD_GRDP_CONTENTS,
- action='M'),
- # Added files:
- MockFile(
- os.path.join('test_grd', 'IDS_TEST1.png.sha1'),
- 'binary',
- action='A'),
- MockFile(
- os.path.join('test_grd', 'IDS_TEST2.png.sha1'),
- 'binary',
- action='A'),
- MockFile(
- os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
- 'binary',
- action='A'),
- MockFile(
- os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
- 'binary',
- action='A'),
- ])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual([], warnings)
- def testScreenshotsRemovedWithSha1(self):
- # Replace new contents with old contents in grd and grp files, removing
- # IDS_TEST1, IDS_TEST2, IDS_PART_TEST1 and IDS_PART_TEST2.
- # Should warn to remove the sha1 files associated with these strings.
- input_api = self.makeInputApi([
- # Modified files:
- MockAffectedFile(
- 'test.grd',
- self.OLD_GRD_CONTENTS, # new_contents
- self.NEW_GRD_CONTENTS2, # old_contents
- action='M'),
- MockAffectedFile(
- 'part.grdp',
- self.OLD_GRDP_CONTENTS, # new_contents
- self.NEW_GRDP_CONTENTS2, # old_contents
- action='M'),
- # Unmodified files:
- MockFile(os.path.join('test_grd', 'IDS_TEST1.png.sha1'), 'binary', ''),
- MockFile(os.path.join('test_grd', 'IDS_TEST2.png.sha1'), 'binary', ''),
- MockFile(os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
- 'binary', ''),
- MockFile(os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
- 'binary', '')
- ])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertEqual('error', warnings[0].type)
- self.assertEqual(self.REMOVE_SIGNATURES_MESSAGE, warnings[0].message)
- self.assertEqual([
- os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
- os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
- os.path.join('test_grd', 'IDS_TEST1.png.sha1'),
- os.path.join('test_grd', 'IDS_TEST2.png.sha1')
- ], warnings[0].items)
- # Same as above, but this time one of the .sha1 files is also removed.
- input_api = self.makeInputApi([
- # Modified files:
- MockAffectedFile(
- 'test.grd',
- self.OLD_GRD_CONTENTS, # new_contents
- self.NEW_GRD_CONTENTS2, # old_contents
- action='M'),
- MockAffectedFile(
- 'part.grdp',
- self.OLD_GRDP_CONTENTS, # new_contents
- self.NEW_GRDP_CONTENTS2, # old_contents
- action='M'),
- # Unmodified files:
- MockFile(os.path.join('test_grd', 'IDS_TEST1.png.sha1'), 'binary', ''),
- MockFile(os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
- 'binary', ''),
- # Deleted files:
- MockAffectedFile(
- os.path.join('test_grd', 'IDS_TEST2.png.sha1'),
- '',
- 'old_contents',
- action='D'),
- MockAffectedFile(
- os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
- '',
- 'old_contents',
- action='D')
- ])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual(1, len(warnings))
- self.assertEqual('error', warnings[0].type)
- self.assertEqual(self.REMOVE_SIGNATURES_MESSAGE, warnings[0].message)
- self.assertEqual([os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
- os.path.join('test_grd', 'IDS_TEST1.png.sha1')
- ], warnings[0].items)
- # Remove all sha1 files. There should be no warnings.
- input_api = self.makeInputApi([
- # Modified files:
- MockAffectedFile(
- 'test.grd',
- self.OLD_GRD_CONTENTS,
- self.NEW_GRD_CONTENTS2,
- action='M'),
- MockAffectedFile(
- 'part.grdp',
- self.OLD_GRDP_CONTENTS,
- self.NEW_GRDP_CONTENTS2,
- action='M'),
- # Deleted files:
- MockFile(
- os.path.join('test_grd', 'IDS_TEST1.png.sha1'),
- 'binary',
- action='D'),
- MockFile(
- os.path.join('test_grd', 'IDS_TEST2.png.sha1'),
- 'binary',
- action='D'),
- MockFile(
- os.path.join('part_grdp', 'IDS_PART_TEST1.png.sha1'),
- 'binary',
- action='D'),
- MockFile(
- os.path.join('part_grdp', 'IDS_PART_TEST2.png.sha1'),
- 'binary',
- action='D')
- ])
- warnings = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- self.assertEqual([], warnings)
- def testIcuSyntax(self):
- # Add valid ICU syntax string. Should not raise an error.
- input_api = self.makeInputApi([
- MockAffectedFile('test.grd', self.NEW_GRD_CONTENTS_ICU_SYNTAX_OK2,
- self.NEW_GRD_CONTENTS1, action='M'),
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS_ICU_SYNTAX_OK2,
- self.NEW_GRDP_CONTENTS1, action='M')])
- results = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- # We expect no ICU syntax errors.
- icu_errors = [e for e in results
- if e.message == self.ICU_SYNTAX_ERROR_MESSAGE]
- self.assertEqual(0, len(icu_errors))
- # Valid changes in ICU syntax. Should not raise an error.
- input_api = self.makeInputApi([
- MockAffectedFile('test.grd', self.NEW_GRD_CONTENTS_ICU_SYNTAX_OK2,
- self.NEW_GRD_CONTENTS_ICU_SYNTAX_OK1, action='M'),
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS_ICU_SYNTAX_OK2,
- self.NEW_GRDP_CONTENTS_ICU_SYNTAX_OK1, action='M')])
- results = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- # We expect no ICU syntax errors.
- icu_errors = [e for e in results
- if e.message == self.ICU_SYNTAX_ERROR_MESSAGE]
- self.assertEqual(0, len(icu_errors))
- # Add invalid ICU syntax strings. Should raise two errors.
- input_api = self.makeInputApi([
- MockAffectedFile('test.grd', self.NEW_GRD_CONTENTS_ICU_SYNTAX_ERROR,
- self.NEW_GRD_CONTENTS1, action='M'),
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS_ICU_SYNTAX_ERROR,
- self.NEW_GRD_CONTENTS1, action='M')])
- results = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- # We expect 2 ICU syntax errors.
- icu_errors = [e for e in results
- if e.message == self.ICU_SYNTAX_ERROR_MESSAGE]
- self.assertEqual(1, len(icu_errors))
- self.assertEqual([
- 'IDS_TEST1: This message looks like an ICU plural, but does not follow '
- 'ICU syntax.',
- 'IDS_PART_TEST1: Variant "= 1" is not valid for plural message'
- ], icu_errors[0].items)
- # Change two strings to have ICU syntax errors. Should raise two errors.
- input_api = self.makeInputApi([
- MockAffectedFile('test.grd', self.NEW_GRD_CONTENTS_ICU_SYNTAX_ERROR,
- self.NEW_GRD_CONTENTS_ICU_SYNTAX_OK1, action='M'),
- MockAffectedFile('part.grdp', self.NEW_GRDP_CONTENTS_ICU_SYNTAX_ERROR,
- self.NEW_GRDP_CONTENTS_ICU_SYNTAX_OK1, action='M')])
- results = PRESUBMIT.CheckStrings(input_api, MockOutputApi())
- # We expect 2 ICU syntax errors.
- icu_errors = [e for e in results
- if e.message == self.ICU_SYNTAX_ERROR_MESSAGE]
- self.assertEqual(1, len(icu_errors))
- self.assertEqual([
- 'IDS_TEST1: This message looks like an ICU plural, but does not follow '
- 'ICU syntax.',
- 'IDS_PART_TEST1: Variant "= 1" is not valid for plural message'
- ], icu_errors[0].items)
- class TranslationExpectationsTest(unittest.TestCase):
- ERROR_MESSAGE_FORMAT = (
- "Failed to get a list of translatable grd files. "
- "This happens when:\n"
- " - One of the modified grd or grdp files cannot be parsed or\n"
- " - %s is not updated.\n"
- "Stack:\n"
- )
- REPO_ROOT = os.path.join('tools', 'translation', 'testdata')
- # This lists all .grd files under REPO_ROOT.
- EXPECTATIONS = os.path.join(REPO_ROOT,
- "translation_expectations.pyl")
- # This lists all .grd files under REPO_ROOT except unlisted.grd.
- EXPECTATIONS_WITHOUT_UNLISTED_FILE = os.path.join(
- REPO_ROOT, "translation_expectations_without_unlisted_file.pyl")
- # Tests that the presubmit doesn't return when no grd or grdp files are
- # modified.
- def testExpectationsNoModifiedGrd(self):
- input_api = MockInputApi()
- input_api.files = [
- MockAffectedFile('not_used.txt', 'not used', 'not used', action='M')
- ]
- # Fake list of all grd files in the repo. This list is missing all grd/grdps
- # under tools/translation/testdata. This is OK because the presubmit won't
- # run in the first place since there are no modified grd/grps in input_api.
- grd_files = ['doesnt_exist_doesnt_matter.grd']
- warnings = PRESUBMIT.CheckTranslationExpectations(
- input_api, MockOutputApi(), self.REPO_ROOT, self.EXPECTATIONS,
- grd_files)
- self.assertEqual(0, len(warnings))
- # Tests that the list of files passed to the presubmit matches the list of
- # files in the expectations.
- def testExpectationsSuccess(self):
- # Mock input file list needs a grd or grdp file in order to run the
- # presubmit. The file itself doesn't matter.
- input_api = MockInputApi()
- input_api.files = [
- MockAffectedFile('dummy.grd', 'not used', 'not used', action='M')
- ]
- # List of all grd files in the repo.
- grd_files = ['test.grd', 'unlisted.grd', 'not_translated.grd',
- 'internal.grd']
- warnings = PRESUBMIT.CheckTranslationExpectations(
- input_api, MockOutputApi(), self.REPO_ROOT, self.EXPECTATIONS,
- grd_files)
- self.assertEqual(0, len(warnings))
- # Tests that the presubmit warns when a file is listed in expectations, but
- # does not actually exist.
- def testExpectationsMissingFile(self):
- # Mock input file list needs a grd or grdp file in order to run the
- # presubmit.
- input_api = MockInputApi()
- input_api.files = [
- MockAffectedFile('dummy.grd', 'not used', 'not used', action='M')
- ]
- # unlisted.grd is listed under tools/translation/testdata but is not
- # included in translation expectations.
- grd_files = ['unlisted.grd', 'not_translated.grd', 'internal.grd']
- warnings = PRESUBMIT.CheckTranslationExpectations(
- input_api, MockOutputApi(), self.REPO_ROOT, self.EXPECTATIONS,
- grd_files)
- self.assertEqual(1, len(warnings))
- self.assertTrue(warnings[0].message.startswith(
- self.ERROR_MESSAGE_FORMAT % self.EXPECTATIONS))
- self.assertTrue(
- ("test.grd is listed in the translation expectations, "
- "but this grd file does not exist")
- in warnings[0].message)
- # Tests that the presubmit warns when a file is not listed in expectations but
- # does actually exist.
- def testExpectationsUnlistedFile(self):
- # Mock input file list needs a grd or grdp file in order to run the
- # presubmit.
- input_api = MockInputApi()
- input_api.files = [
- MockAffectedFile('dummy.grd', 'not used', 'not used', action='M')
- ]
- # unlisted.grd is listed under tools/translation/testdata but is not
- # included in translation expectations.
- grd_files = ['test.grd', 'unlisted.grd', 'not_translated.grd',
- 'internal.grd']
- warnings = PRESUBMIT.CheckTranslationExpectations(
- input_api, MockOutputApi(), self.REPO_ROOT,
- self.EXPECTATIONS_WITHOUT_UNLISTED_FILE, grd_files)
- self.assertEqual(1, len(warnings))
- self.assertTrue(warnings[0].message.startswith(
- self.ERROR_MESSAGE_FORMAT % self.EXPECTATIONS_WITHOUT_UNLISTED_FILE))
- self.assertTrue(
- ("unlisted.grd appears to be translatable "
- "(because it contains <file> or <message> elements), "
- "but is not listed in the translation expectations.")
- in warnings[0].message)
- # Tests that the presubmit warns twice:
- # - for a non-existing file listed in expectations
- # - for an existing file not listed in expectations
- def testMultipleWarnings(self):
- # Mock input file list needs a grd or grdp file in order to run the
- # presubmit.
- input_api = MockInputApi()
- input_api.files = [
- MockAffectedFile('dummy.grd', 'not used', 'not used', action='M')
- ]
- # unlisted.grd is listed under tools/translation/testdata but is not
- # included in translation expectations.
- # test.grd is not listed under tools/translation/testdata but is included
- # in translation expectations.
- grd_files = ['unlisted.grd', 'not_translated.grd', 'internal.grd']
- warnings = PRESUBMIT.CheckTranslationExpectations(
- input_api, MockOutputApi(), self.REPO_ROOT,
- self.EXPECTATIONS_WITHOUT_UNLISTED_FILE, grd_files)
- self.assertEqual(1, len(warnings))
- self.assertTrue(warnings[0].message.startswith(
- self.ERROR_MESSAGE_FORMAT % self.EXPECTATIONS_WITHOUT_UNLISTED_FILE))
- self.assertTrue(
- ("unlisted.grd appears to be translatable "
- "(because it contains <file> or <message> elements), "
- "but is not listed in the translation expectations.")
- in warnings[0].message)
- self.assertTrue(
- ("test.grd is listed in the translation expectations, "
- "but this grd file does not exist")
- in warnings[0].message)
- class DISABLETypoInTest(unittest.TestCase):
- def testPositive(self):
- # Verify the typo "DISABLE_" instead of "DISABLED_" in various contexts
- # where the desire is to disable a test.
- tests = [
- # Disabled on one platform:
- '#if defined(OS_WIN)\n'
- '#define MAYBE_FoobarTest DISABLE_FoobarTest\n'
- '#else\n'
- '#define MAYBE_FoobarTest FoobarTest\n'
- '#endif\n',
- # Disabled on one platform spread cross lines:
- '#if defined(OS_WIN)\n'
- '#define MAYBE_FoobarTest \\\n'
- ' DISABLE_FoobarTest\n'
- '#else\n'
- '#define MAYBE_FoobarTest FoobarTest\n'
- '#endif\n',
- # Disabled on all platforms:
- ' TEST_F(FoobarTest, DISABLE_Foo)\n{\n}',
- # Disabled on all platforms but multiple lines
- ' TEST_F(FoobarTest,\n DISABLE_foo){\n}\n',
- ]
- for test in tests:
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('some/path/foo_unittest.cc', test.splitlines()),
- ]
- results = PRESUBMIT.CheckNoDISABLETypoInTests(mock_input_api,
- MockOutputApi())
- self.assertEqual(
- 1,
- len(results),
- msg=('expected len(results) == 1 but got %d in test: %s' %
- (len(results), test)))
- self.assertTrue(
- 'foo_unittest.cc' in results[0].message,
- msg=('expected foo_unittest.cc in message but got %s in test %s' %
- (results[0].message, test)))
- def testIgnoreNotTestFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('some/path/foo.cc', 'TEST_F(FoobarTest, DISABLE_Foo)'),
- ]
- results = PRESUBMIT.CheckNoDISABLETypoInTests(mock_input_api,
- MockOutputApi())
- self.assertEqual(0, len(results))
- def testIgnoreDeletedFiles(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('some/path/foo.cc', 'TEST_F(FoobarTest, Foo)', action='D'),
- ]
- results = PRESUBMIT.CheckNoDISABLETypoInTests(mock_input_api,
- MockOutputApi())
- self.assertEqual(0, len(results))
- class ForgettingMAYBEInTests(unittest.TestCase):
- def testPositive(self):
- test = (
- '#if defined(HAS_ENERGY)\n'
- '#define MAYBE_CastExplosion DISABLED_CastExplosion\n'
- '#else\n'
- '#define MAYBE_CastExplosion CastExplosion\n'
- '#endif\n'
- 'TEST_F(ArchWizard, CastExplosion) {\n'
- '#if defined(ARCH_PRIEST_IN_PARTY)\n'
- '#define MAYBE_ArchPriest ArchPriest\n'
- '#else\n'
- '#define MAYBE_ArchPriest DISABLED_ArchPriest\n'
- '#endif\n'
- 'TEST_F(ArchPriest, CastNaturesBounty) {\n'
- '#if !defined(CRUSADER_IN_PARTY)\n'
- '#define MAYBE_Crusader \\\n'
- ' DISABLED_Crusader \n'
- '#else\n'
- '#define MAYBE_Crusader \\\n'
- ' Crusader\n'
- '#endif\n'
- ' TEST_F(\n'
- ' Crusader,\n'
- ' CastTaunt) { }\n'
- '#if defined(LEARNED_BASIC_SKILLS)\n'
- '#define MAYBE_CastSteal \\\n'
- ' DISABLED_CastSteal \n'
- '#else\n'
- '#define MAYBE_CastSteal \\\n'
- ' CastSteal\n'
- '#endif\n'
- ' TEST_F(\n'
- ' ThiefClass,\n'
- ' CastSteal) { }\n'
- )
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('fantasyworld/classes_unittest.cc', test.splitlines()),
- ]
- results = PRESUBMIT.CheckForgettingMAYBEInTests(mock_input_api,
- MockOutputApi())
- self.assertEqual(4, len(results))
- self.assertTrue('CastExplosion' in results[0].message)
- self.assertTrue('fantasyworld/classes_unittest.cc:2' in results[0].message)
- self.assertTrue('ArchPriest' in results[1].message)
- self.assertTrue('fantasyworld/classes_unittest.cc:8' in results[1].message)
- self.assertTrue('Crusader' in results[2].message)
- self.assertTrue('fantasyworld/classes_unittest.cc:14' in results[2].message)
- self.assertTrue('CastSteal' in results[3].message)
- self.assertTrue('fantasyworld/classes_unittest.cc:24' in results[3].message)
- def testNegative(self):
- test = (
- '#if defined(HAS_ENERGY)\n'
- '#define MAYBE_CastExplosion DISABLED_CastExplosion\n'
- '#else\n'
- '#define MAYBE_CastExplosion CastExplosion\n'
- '#endif\n'
- 'TEST_F(ArchWizard, MAYBE_CastExplosion) {\n'
- '#if defined(ARCH_PRIEST_IN_PARTY)\n'
- '#define MAYBE_ArchPriest ArchPriest\n'
- '#else\n'
- '#define MAYBE_ArchPriest DISABLED_ArchPriest\n'
- '#endif\n'
- 'TEST_F(MAYBE_ArchPriest, CastNaturesBounty) {\n'
- '#if !defined(CRUSADER_IN_PARTY)\n'
- '#define MAYBE_Crusader \\\n'
- ' DISABLED_Crusader \n'
- '#else\n'
- '#define MAYBE_Crusader \\\n'
- ' Crusader\n'
- '#endif\n'
- ' TEST_F(\n'
- ' MAYBE_Crusader,\n'
- ' CastTaunt) { }\n'
- '#if defined(LEARNED_BASIC_SKILLS)\n'
- '#define MAYBE_CastSteal \\\n'
- ' DISABLED_CastSteal \n'
- '#else\n'
- '#define MAYBE_CastSteal \\\n'
- ' CastSteal\n'
- '#endif\n'
- ' TEST_F(\n'
- ' ThiefClass,\n'
- ' MAYBE_CastSteal) { }\n'
- )
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockFile('fantasyworld/classes_unittest.cc', test.splitlines()),
- ]
- results = PRESUBMIT.CheckForgettingMAYBEInTests(mock_input_api,
- MockOutputApi())
- self.assertEqual(0, len(results))
- class CheckFuzzTargetsTest(unittest.TestCase):
- def _check(self, files):
- mock_input_api = MockInputApi()
- mock_input_api.files = []
- for fname, contents in files.items():
- mock_input_api.files.append(MockFile(fname, contents.splitlines()))
- return PRESUBMIT.CheckFuzzTargetsOnUpload(mock_input_api, MockOutputApi())
- def testLibFuzzerSourcesIgnored(self):
- results = self._check({
- "third_party/lib/Fuzzer/FuzzerDriver.cpp": "LLVMFuzzerInitialize",
- })
- self.assertEqual(results, [])
- def testNonCodeFilesIgnored(self):
- results = self._check({
- "README.md": "LLVMFuzzerInitialize",
- })
- self.assertEqual(results, [])
- def testNoErrorHeaderPresent(self):
- results = self._check({
- "fuzzer.cc": (
- "#include \"testing/libfuzzer/libfuzzer_exports.h\"\n" +
- "LLVMFuzzerInitialize"
- )
- })
- self.assertEqual(results, [])
- def testErrorMissingHeader(self):
- results = self._check({
- "fuzzer.cc": "LLVMFuzzerInitialize"
- })
- self.assertEqual(len(results), 1)
- self.assertEqual(results[0].items, ['fuzzer.cc'])
- class SetNoParentTest(unittest.TestCase):
- def testSetNoParentTopLevelAllowed(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('goat/OWNERS',
- [
- 'set noparent',
- 'jochen@chromium.org',
- ])
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckSetNoParent(mock_input_api, mock_output_api)
- self.assertEqual([], errors)
- def testSetNoParentMissing(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('services/goat/OWNERS',
- [
- 'set noparent',
- 'jochen@chromium.org',
- 'per-file *.json=set noparent',
- 'per-file *.json=jochen@chromium.org',
- ])
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckSetNoParent(mock_input_api, mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertTrue('goat/OWNERS:1' in errors[0].long_text)
- self.assertTrue('goat/OWNERS:3' in errors[0].long_text)
- def testSetNoParentWithCorrectRule(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('services/goat/OWNERS',
- [
- 'set noparent',
- 'file://ipc/SECURITY_OWNERS',
- 'per-file *.json=set noparent',
- 'per-file *.json=file://ipc/SECURITY_OWNERS',
- ])
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckSetNoParent(mock_input_api, mock_output_api)
- self.assertEqual([], errors)
- class MojomStabilityCheckTest(unittest.TestCase):
- def runTestWithAffectedFiles(self, affected_files):
- mock_input_api = MockInputApi()
- mock_input_api.files = affected_files
- mock_output_api = MockOutputApi()
- return PRESUBMIT.CheckStableMojomChanges(
- mock_input_api, mock_output_api)
- def testSafeChangePasses(self):
- errors = self.runTestWithAffectedFiles([
- MockAffectedFile('foo/foo.mojom',
- ['[Stable] struct S { [MinVersion=1] int32 x; };'],
- old_contents=['[Stable] struct S {};'])
- ])
- self.assertEqual([], errors)
- def testBadChangeFails(self):
- errors = self.runTestWithAffectedFiles([
- MockAffectedFile('foo/foo.mojom',
- ['[Stable] struct S { int32 x; };'],
- old_contents=['[Stable] struct S {};'])
- ])
- self.assertEqual(1, len(errors))
- self.assertTrue('not backward-compatible' in errors[0].message)
- def testDeletedFile(self):
- """Regression test for https://crbug.com/1091407."""
- errors = self.runTestWithAffectedFiles([
- MockAffectedFile('a.mojom', [], old_contents=['struct S {};'],
- action='D'),
- MockAffectedFile('b.mojom',
- ['struct S {}; struct T { S s; };'],
- old_contents=['import "a.mojom"; struct T { S s; };'])
- ])
- self.assertEqual([], errors)
- class CheckForUseOfChromeAppsDeprecationsTest(unittest.TestCase):
- ERROR_MSG_PIECE = 'technologies which will soon be deprecated'
- # Each positive test is also a naive negative test for the other cases.
- def testWarningNMF(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile(
- 'foo.NMF',
- ['"program"', '"Z":"content"', 'B'],
- ['"program"', 'B'],
- scm_diff='\n'.join([
- '--- foo.NMF.old 2020-12-02 20:40:54.430676385 +0100',
- '+++ foo.NMF.new 2020-12-02 20:41:02.086700197 +0100',
- '@@ -1,2 +1,3 @@',
- ' "program"',
- '+"Z":"content"',
- ' B']),
- action='M')
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForUseOfChromeAppsDeprecations(mock_input_api,
- mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertTrue( self.ERROR_MSG_PIECE in errors[0].message)
- self.assertTrue( 'foo.NMF' in errors[0].message)
- def testWarningManifest(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile(
- 'manifest.json',
- ['"app":', '"Z":"content"', 'B'],
- ['"app":"', 'B'],
- scm_diff='\n'.join([
- '--- manifest.json.old 2020-12-02 20:40:54.430676385 +0100',
- '+++ manifest.json.new 2020-12-02 20:41:02.086700197 +0100',
- '@@ -1,2 +1,3 @@',
- ' "app"',
- '+"Z":"content"',
- ' B']),
- action='M')
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForUseOfChromeAppsDeprecations(mock_input_api,
- mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertTrue( self.ERROR_MSG_PIECE in errors[0].message)
- self.assertTrue( 'manifest.json' in errors[0].message)
- def testOKWarningManifestWithoutApp(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile(
- 'manifest.json',
- ['"name":', '"Z":"content"', 'B'],
- ['"name":"', 'B'],
- scm_diff='\n'.join([
- '--- manifest.json.old 2020-12-02 20:40:54.430676385 +0100',
- '+++ manifest.json.new 2020-12-02 20:41:02.086700197 +0100',
- '@@ -1,2 +1,3 @@',
- ' "app"',
- '+"Z":"content"',
- ' B']),
- action='M')
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForUseOfChromeAppsDeprecations(mock_input_api,
- mock_output_api)
- self.assertEqual(0, len(errors))
- def testWarningPPAPI(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile(
- 'foo.hpp',
- ['A', '#include <ppapi.h>', 'B'],
- ['A', 'B'],
- scm_diff='\n'.join([
- '--- foo.hpp.old 2020-12-02 20:40:54.430676385 +0100',
- '+++ foo.hpp.new 2020-12-02 20:41:02.086700197 +0100',
- '@@ -1,2 +1,3 @@',
- ' A',
- '+#include <ppapi.h>',
- ' B']),
- action='M')
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForUseOfChromeAppsDeprecations(mock_input_api,
- mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertTrue( self.ERROR_MSG_PIECE in errors[0].message)
- self.assertTrue( 'foo.hpp' in errors[0].message)
- def testNoWarningPPAPI(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile(
- 'foo.txt',
- ['A', 'Peppapig', 'B'],
- ['A', 'B'],
- scm_diff='\n'.join([
- '--- foo.txt.old 2020-12-02 20:40:54.430676385 +0100',
- '+++ foo.txt.new 2020-12-02 20:41:02.086700197 +0100',
- '@@ -1,2 +1,3 @@',
- ' A',
- '+Peppapig',
- ' B']),
- action='M')
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckForUseOfChromeAppsDeprecations(mock_input_api,
- mock_output_api)
- self.assertEqual(0, len(errors))
- class CheckDeprecationOfPreferencesTest(unittest.TestCase):
- # Test that a warning is generated if a preference registration is removed
- # from a random file.
- def testWarning(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile(
- 'foo.cc',
- ['A', 'B'],
- ['A', 'prefs->RegisterStringPref("foo", "default");', 'B'],
- scm_diff='\n'.join([
- '--- foo.cc.old 2020-12-02 20:40:54.430676385 +0100',
- '+++ foo.cc.new 2020-12-02 20:41:02.086700197 +0100',
- '@@ -1,3 +1,2 @@',
- ' A',
- '-prefs->RegisterStringPref("foo", "default");',
- ' B']),
- action='M')
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckDeprecationOfPreferences(mock_input_api,
- mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertTrue(
- 'Discovered possible removal of preference registrations' in
- errors[0].message)
- # Test that a warning is inhibited if the preference registration was moved
- # to the deprecation functions in browser prefs.
- def testNoWarningForMigration(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- # RegisterStringPref was removed from foo.cc.
- MockAffectedFile(
- 'foo.cc',
- ['A', 'B'],
- ['A', 'prefs->RegisterStringPref("foo", "default");', 'B'],
- scm_diff='\n'.join([
- '--- foo.cc.old 2020-12-02 20:40:54.430676385 +0100',
- '+++ foo.cc.new 2020-12-02 20:41:02.086700197 +0100',
- '@@ -1,3 +1,2 @@',
- ' A',
- '-prefs->RegisterStringPref("foo", "default");',
- ' B']),
- action='M'),
- # But the preference was properly migrated.
- MockAffectedFile(
- 'chrome/browser/prefs/browser_prefs.cc',
- [
- '// BEGIN_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- '// END_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- '// BEGIN_MIGRATE_OBSOLETE_PROFILE_PREFS',
- 'prefs->RegisterStringPref("foo", "default");',
- '// END_MIGRATE_OBSOLETE_PROFILE_PREFS',
- ],
- [
- '// BEGIN_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- '// END_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- '// BEGIN_MIGRATE_OBSOLETE_PROFILE_PREFS',
- '// END_MIGRATE_OBSOLETE_PROFILE_PREFS',
- ],
- scm_diff='\n'.join([
- '--- browser_prefs.cc.old 2020-12-02 20:51:40.812686731 +0100',
- '+++ browser_prefs.cc.new 2020-12-02 20:52:02.936755539 +0100',
- '@@ -2,3 +2,4 @@',
- ' // END_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- ' // BEGIN_MIGRATE_OBSOLETE_PROFILE_PREFS',
- '+prefs->RegisterStringPref("foo", "default");',
- ' // END_MIGRATE_OBSOLETE_PROFILE_PREFS']),
- action='M'),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckDeprecationOfPreferences(mock_input_api,
- mock_output_api)
- self.assertEqual(0, len(errors))
- # Test that a warning is NOT inhibited if the preference registration was
- # moved to a place outside of the migration functions in browser_prefs.cc
- def testWarningForImproperMigration(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- # RegisterStringPref was removed from foo.cc.
- MockAffectedFile(
- 'foo.cc',
- ['A', 'B'],
- ['A', 'prefs->RegisterStringPref("foo", "default");', 'B'],
- scm_diff='\n'.join([
- '--- foo.cc.old 2020-12-02 20:40:54.430676385 +0100',
- '+++ foo.cc.new 2020-12-02 20:41:02.086700197 +0100',
- '@@ -1,3 +1,2 @@',
- ' A',
- '-prefs->RegisterStringPref("foo", "default");',
- ' B']),
- action='M'),
- # The registration call was moved to a place in browser_prefs.cc that
- # is outside the migration functions.
- MockAffectedFile(
- 'chrome/browser/prefs/browser_prefs.cc',
- [
- 'prefs->RegisterStringPref("foo", "default");',
- '// BEGIN_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- '// END_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- '// BEGIN_MIGRATE_OBSOLETE_PROFILE_PREFS',
- '// END_MIGRATE_OBSOLETE_PROFILE_PREFS',
- ],
- [
- '// BEGIN_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- '// END_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- '// BEGIN_MIGRATE_OBSOLETE_PROFILE_PREFS',
- '// END_MIGRATE_OBSOLETE_PROFILE_PREFS',
- ],
- scm_diff='\n'.join([
- '--- browser_prefs.cc.old 2020-12-02 20:51:40.812686731 +0100',
- '+++ browser_prefs.cc.new 2020-12-02 20:52:02.936755539 +0100',
- '@@ -1,2 +1,3 @@',
- '+prefs->RegisterStringPref("foo", "default");',
- ' // BEGIN_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- ' // END_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS']),
- action='M'),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckDeprecationOfPreferences(mock_input_api,
- mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertTrue(
- 'Discovered possible removal of preference registrations' in
- errors[0].message)
- # Check that the presubmit fails if a marker line in browser_prefs.cc is
- # deleted.
- def testDeletedMarkerRaisesError(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('chrome/browser/prefs/browser_prefs.cc',
- [
- '// BEGIN_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- '// END_MIGRATE_OBSOLETE_LOCAL_STATE_PREFS',
- '// BEGIN_MIGRATE_OBSOLETE_PROFILE_PREFS',
- # The following line is deleted for this test
- # '// END_MIGRATE_OBSOLETE_PROFILE_PREFS',
- ])
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckDeprecationOfPreferences(mock_input_api,
- mock_output_api)
- self.assertEqual(1, len(errors))
- self.assertEqual(
- 'Broken .*MIGRATE_OBSOLETE_.*_PREFS markers in browser_prefs.cc.',
- errors[0].message)
- class MPArchApiUsage(unittest.TestCase):
- def _assert_notify(
- self, expected_uses, expect_fyi, msg, local_path, new_contents):
- mock_input_api = MockInputApi()
- mock_output_api = MockOutputApi()
- mock_input_api.files = [
- MockFile(local_path, new_contents),
- ]
- result = PRESUBMIT.CheckMPArchApiUsage(mock_input_api, mock_output_api)
- watchlist_email = ('mparch-reviews+watchfyi@chromium.org'
- if expect_fyi else 'mparch-reviews+watch@chromium.org')
- self.assertEqual(
- bool(expected_uses or expect_fyi),
- watchlist_email in mock_output_api.more_cc,
- msg)
- if expected_uses:
- self.assertEqual(1, len(result), msg)
- self.assertEqual(result[0].type, 'notify', msg)
- self.assertEqual(sorted(result[0].items), sorted(expected_uses), msg)
- else:
- self.assertEqual(0, len(result), msg)
- def testNotify(self):
- self._assert_notify(
- ['IsInMainFrame'],
- False,
- 'Introduce IsInMainFrame',
- 'chrome/my_feature.cc',
- ['void DoSomething(content::NavigationHandle* navigation_handle) {',
- ' if (navigation_handle->IsInMainFrame())',
- ' all_of_our_page_state.reset();',
- '}',
- ])
- self._assert_notify(
- ['FromRenderFrameHost'],
- False,
- 'Introduce WC::FromRenderFrameHost',
- 'chrome/my_feature.cc',
- ['void DoSomething(content::RenderFrameHost* rfh) {',
- ' auto* wc = content::WebContents::FromRenderFrameHost(rfh);',
- ' ChangeTabState(wc);',
- '}',
- ])
- def testFyi(self):
- self._assert_notify(
- [],
- True,
- 'Introduce WCO and WCUD',
- 'chrome/my_feature.h',
- ['class MyFeature',
- ' : public content::WebContentsObserver,',
- ' public content::WebContentsUserData<MyFeature> {};',
- ])
- self._assert_notify(
- [],
- True,
- 'Introduce WCO override',
- 'chrome/my_feature.h',
- ['void DidFinishNavigation(',
- ' content::NavigationHandle* navigation_handle) override;',
- ])
- def testNoNotify(self):
- self._assert_notify(
- [],
- False,
- 'No API usage',
- 'chrome/my_feature.cc',
- ['void DoSomething() {',
- ' // TODO: Something',
- '}',
- ])
- # Something under a top level directory we're not concerned about happens
- # to share a name with a content API.
- self._assert_notify(
- [],
- False,
- 'Uninteresting top level directory',
- 'third_party/my_dep/my_code.cc',
- ['bool HasParent(Node* node) {',
- ' return node->GetParent();',
- '}',
- ])
- # We're not concerned with usage in test code.
- self._assert_notify(
- [],
- False,
- 'Usage in test code',
- 'chrome/my_feature_unittest.cc',
- ['TEST_F(MyFeatureTest, DoesSomething) {',
- ' EXPECT_TRUE(rfh()->GetMainFrame());',
- '}',
- ])
- class AssertAshOnlyCodeTest(unittest.TestCase):
- def testErrorsOnlyOnAshDirectories(self):
- files_in_ash = [
- MockFile('ash/BUILD.gn', []),
- MockFile('chrome/browser/ash/BUILD.gn', []),
- ]
- other_files = [
- MockFile('chrome/browser/BUILD.gn', []),
- MockFile('chrome/browser/BUILD.gn', ['assert(is_chromeos_ash)']),
- ]
- input_api = MockInputApi()
- input_api.files = files_in_ash
- errors = PRESUBMIT.CheckAssertAshOnlyCode(input_api, MockOutputApi())
- self.assertEqual(2, len(errors))
- input_api.files = other_files
- errors = PRESUBMIT.CheckAssertAshOnlyCode(input_api, MockOutputApi())
- self.assertEqual(0, len(errors))
- def testDoesNotErrorOnNonGNFiles(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('ash/test.h', ['assert(is_chromeos_ash)']),
- MockFile('chrome/browser/ash/test.cc',
- ['assert(is_chromeos_ash)']),
- ]
- errors = PRESUBMIT.CheckAssertAshOnlyCode(input_api, MockOutputApi())
- self.assertEqual(0, len(errors))
- def testDeletedFile(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('ash/BUILD.gn', []),
- MockFile('ash/foo/BUILD.gn', [], action='D'),
- ]
- errors = PRESUBMIT.CheckAssertAshOnlyCode(input_api, MockOutputApi())
- self.assertEqual(1, len(errors))
- def testDoesNotErrorWithAssertion(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('ash/BUILD.gn', ['assert(is_chromeos_ash)']),
- MockFile('chrome/browser/ash/BUILD.gn',
- ['assert(is_chromeos_ash)']),
- MockFile('chrome/browser/ash/BUILD.gn',
- ['assert(is_chromeos_ash, "test")']),
- ]
- errors = PRESUBMIT.CheckAssertAshOnlyCode(input_api, MockOutputApi())
- self.assertEqual(0, len(errors))
- class CheckRawPtrUsageTest(unittest.TestCase):
- def testAllowedCases(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- # Browser-side files are allowed.
- MockAffectedFile('test10/browser/foo.h', ['raw_ptr<int>']),
- MockAffectedFile('test11/browser/foo.cc', ['raw_ptr<int>']),
- MockAffectedFile('test12/blink/common/foo.cc', ['raw_ptr<int>']),
- MockAffectedFile('test13/blink/public/common/foo.cc', ['raw_ptr<int>']),
- MockAffectedFile('test14/blink/public/platform/foo.cc',
- ['raw_ptr<int>']),
- # Non-C++ files are allowed.
- MockAffectedFile('test20/renderer/foo.md', ['raw_ptr<int>']),
- # Mentions in a comment are allowed.
- MockAffectedFile('test30/renderer/foo.cc', ['//raw_ptr<int>']),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckRawPtrUsage(mock_input_api, mock_output_api)
- self.assertFalse(errors)
- def testDisallowedCases(self):
- mock_input_api = MockInputApi()
- mock_input_api.files = [
- MockAffectedFile('test1/renderer/foo.h', ['raw_ptr<int>']),
- MockAffectedFile('test2/renderer/foo.cc', ['raw_ptr<int>']),
- MockAffectedFile('test3/blink/public/web/foo.cc', ['raw_ptr<int>']),
- ]
- mock_output_api = MockOutputApi()
- errors = PRESUBMIT.CheckRawPtrUsage(mock_input_api, mock_output_api)
- self.assertEqual(len(mock_input_api.files), len(errors))
- for error in errors:
- self.assertTrue(
- 'raw_ptr<T> should not be used in Renderer-only code' in
- error.message)
- class AssertPythonShebangTest(unittest.TestCase):
- def testError(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('ash/test.py', ['#!/usr/bin/python']),
- MockFile('chrome/test.py', ['#!/usr/bin/python2']),
- MockFile('third_party/blink/test.py', ['#!/usr/bin/python3']),
- MockFile('empty.py', []),
- ]
- errors = PRESUBMIT.CheckPythonShebang(input_api, MockOutputApi())
- self.assertEqual(3, len(errors))
- def testNonError(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('chrome/browser/BUILD.gn', ['#!/usr/bin/python']),
- MockFile('third_party/blink/web_tests/external/test.py',
- ['#!/usr/bin/python2']),
- MockFile('third_party/test/test.py', ['#!/usr/bin/python3']),
- ]
- errors = PRESUBMIT.CheckPythonShebang(input_api, MockOutputApi())
- self.assertEqual(0, len(errors))
- class VerifyDcheckParentheses(unittest.TestCase):
- def testPermissibleUsage(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('okay1.cc', ['DCHECK_IS_ON()']),
- MockFile('okay2.cc', ['#if DCHECK_IS_ON()']),
- # Other constructs that aren't exactly `DCHECK_IS_ON()` do their
- # own thing at their own risk.
- MockFile('okay3.cc', ['PA_DCHECK_IS_ON']),
- MockFile('okay4.cc', ['#if PA_DCHECK_IS_ON']),
- MockFile('okay6.cc', ['BUILDFLAG(PA_DCHECK_IS_ON)']),
- ]
- errors = PRESUBMIT.CheckDCHECK_IS_ONHasBraces(input_api, MockOutputApi())
- self.assertEqual(0, len(errors))
- def testMissingParentheses(self):
- input_api = MockInputApi()
- input_api.files = [
- MockFile('bad1.cc', ['DCHECK_IS_ON']),
- MockFile('bad2.cc', ['#if DCHECK_IS_ON']),
- MockFile('bad3.cc', ['DCHECK_IS_ON && foo']),
- ]
- errors = PRESUBMIT.CheckDCHECK_IS_ONHasBraces(input_api, MockOutputApi())
- self.assertEqual(3, len(errors))
- for error in errors:
- self.assertRegex(error.message, r'DCHECK_IS_ON().+parentheses')
- class CheckBatchAnnotation(unittest.TestCase):
- """Test the CheckBatchAnnotation presubmit check."""
- def testTruePositives(self):
- """Examples of when there is no @Batch or @DoNotBatch is correctly flagged.
- """
- mock_input = MockInputApi()
- mock_input.files = [
- MockFile('path/OneTest.java', ['public class OneTest']),
- MockFile('path/TwoTest.java', ['public class TwoTest']),
- MockFile('path/ThreeTest.java',
- ['@Batch(Batch.PER_CLASS)',
- 'import org.chromium.base.test.BaseRobolectricTestRunner;',
- 'public class Three {']),
- MockFile('path/FourTest.java',
- ['@DoNotBatch(reason = "dummy reason 1")',
- 'import org.chromium.base.test.BaseRobolectricTestRunner;',
- 'public class Four {']),
- ]
- errors = PRESUBMIT.CheckBatchAnnotation(mock_input, MockOutputApi())
- self.assertEqual(2, len(errors))
- self.assertEqual(2, len(errors[0].items))
- self.assertIn('OneTest.java', errors[0].items[0])
- self.assertIn('TwoTest.java', errors[0].items[1])
- self.assertEqual(2, len(errors[1].items))
- self.assertIn('ThreeTest.java', errors[1].items[0])
- self.assertIn('FourTest.java', errors[1].items[1])
- def testAnnotationsPresent(self):
- """Examples of when there is @Batch or @DoNotBatch is correctly flagged."""
- mock_input = MockInputApi()
- mock_input.files = [
- MockFile('path/OneTest.java',
- ['@Batch(Batch.PER_CLASS)', 'public class One {']),
- MockFile('path/TwoTest.java',
- ['@DoNotBatch(reason = "dummy reasons.")', 'public class Two {'
- ]),
- MockFile('path/ThreeTest.java',
- ['@Batch(Batch.PER_CLASS)',
- 'public class Three extends BaseTestA {'],
- ['@Batch(Batch.PER_CLASS)',
- 'public class Three extends BaseTestB {']),
- MockFile('path/FourTest.java',
- ['@DoNotBatch(reason = "dummy reason 1")',
- 'public class Four extends BaseTestA {'],
- ['@DoNotBatch(reason = "dummy reason 2")',
- 'public class Four extends BaseTestB {']),
- MockFile('path/FiveTest.java',
- ['import androidx.test.uiautomator.UiDevice;',
- 'public class Five extends BaseTestA {'],
- ['import androidx.test.uiautomator.UiDevice;',
- 'public class Five extends BaseTestB {']),
- MockFile('path/SixTest.java',
- ['import org.chromium.base.test.BaseRobolectricTestRunner;',
- 'public class Six extends BaseTestA {'],
- ['import org.chromium.base.test.BaseRobolectricTestRunner;',
- 'public class Six extends BaseTestB {']),
- MockFile('path/SevenTest.java',
- ['import org.robolectric.annotation.Config;',
- 'public class Seven extends BaseTestA {'],
- ['import org.robolectric.annotation.Config;',
- 'public class Seven extends BaseTestB {']),
- MockFile(
- 'path/OtherClass.java',
- ['public class OtherClass {'],
- ),
- MockFile('path/PRESUBMIT.py',
- ['@Batch(Batch.PER_CLASS)',
- '@DoNotBatch(reason = "dummy reason)']),
- ]
- errors = PRESUBMIT.CheckBatchAnnotation(mock_input, MockOutputApi())
- self.assertEqual(0, len(errors))
- if __name__ == '__main__':
- unittest.main()
|