chrome/browser/web_dev_style/css_checker_test.py

   1 #!/usr/bin/env python
   2 # Copyright 2015 The Chromium Authors. All rights reserved.
   3 # Use of this source code is governed by a BSD-style license that can be
   4 # found in the LICENSE file.
   5
   6 import css_checker
   7 from os import path as os_path
   8 import re
   9 from sys import path as sys_path
  10 import unittest
  11
  12 _HERE = os_path.dirname(os_path.abspath(__file__))
  13 sys_path.append(os_path.join(_HERE, '..', '..', '..', 'tools'))
  14
  15 import find_depot_tools  # pylint: disable=W0611
  16 from testing_support.super_mox import SuperMoxTestBase
  17
  18
  19 class CssCheckerTest(SuperMoxTestBase):
  20   def setUp(self):
  21     SuperMoxTestBase.setUp(self)
  22
  23     self.fake_file_name = 'fake.css'
  24
  25     self.fake_file = self.mox.CreateMockAnything()
  26     self.mox.StubOutWithMock(self.fake_file, 'LocalPath')
  27     self.fake_file.LocalPath().AndReturn(self.fake_file_name)
  28     # Actual calls to NewContents() are defined in each test.
  29     self.mox.StubOutWithMock(self.fake_file, 'NewContents')
  30
  31     self.input_api = self.mox.CreateMockAnything()
  32     self.input_api.re = re
  33     self.mox.StubOutWithMock(self.input_api, 'AffectedSourceFiles')
  34     self.input_api.AffectedFiles(
  35         include_deletes=False, file_filter=None).AndReturn([self.fake_file])
  36
  37     # Actual creations of PresubmitPromptWarning are defined in each test.
  38     self.output_api = self.mox.CreateMockAnything()
  39     self.mox.StubOutWithMock(self.output_api, 'PresubmitPromptWarning',
  40                              use_mock_anything=True)
  41
  42     self.output_api = self.mox.CreateMockAnything()
  43     self.mox.StubOutWithMock(self.output_api, 'PresubmitNotifyResult',
  44                              use_mock_anything=True)
  45
  46   def VerifyContentsIsValid(self, contents):
  47     self.fake_file.NewContents().AndReturn(contents.splitlines())
  48     self.mox.ReplayAll()
  49     css_checker.CSSChecker(self.input_api, self.output_api).RunChecks()
  50
  51   def VerifyContentsProducesOutput(self, contents, output):
  52     self.fake_file.NewContents().AndReturn(contents.splitlines())
  53     author_msg = ('Was the CSS checker useful? '
  54                   'Send feedback or hate mail to dbeam@chromium.org.')
  55     self.output_api.PresubmitNotifyResult(author_msg).AndReturn(None)
  56     self.output_api.PresubmitPromptWarning(
  57         self.fake_file_name + ':\n' + output.strip()).AndReturn(None)
  58     self.mox.ReplayAll()
  59     css_checker.CSSChecker(self.input_api, self.output_api).RunChecks()
  60
  61   def testCssAlphaWithAtBlock(self):
  62     self.VerifyContentsProducesOutput("""
  63 <include src="../shared/css/cr/ui/overlay.css">
  64 <include src="chrome://resources/totally-cool.css" />
  65
  66 /* A hopefully safely ignored comment and @media statement. /**/
  67 @media print {
  68   div {
  69     display: block;
  70     color: red;
  71   }
  72 }
  73
  74 .rule {
  75   z-index: 5;
  76 <if expr="not is macosx">
  77   background-image: url(chrome://resources/BLAH); /* TODO(dbeam): Fix this. */
  78   background-color: rgb(235, 239, 249);
  79 </if>
  80 <if expr="is_macosx">
  81   background-color: white;
  82   background-image: url(chrome://resources/BLAH2);
  83 </if>
  84   color: black;
  85 }
  86
  87 <if expr="is_macosx">
  88 .language-options-right {
  89   visibility: hidden;
  90   opacity: 1; /* TODO(dbeam): Fix this. */
  91 }
  92 </if>""", """
  93 - Alphabetize properties and list vendor specific (i.e. -webkit) above standard.
  94     display: block;
  95     color: red;
  96
  97     z-index: 5;
  98     color: black;""")
  99
 100   def testCssStringWithAt(self):
 101     self.VerifyContentsIsValid("""
 102 #logo {
 103   background-image: url(images/google_logo.png@2x);
 104 }
 105
 106 body.alternate-logo #logo {
 107   -webkit-mask-image: url(images/google_logo.png@2x);
 108   background: none;
 109 }
 110
 111 .stuff1 {
 112 }
 113
 114 .stuff2 {
 115 }
 116       """)
 117
 118   def testCssAlphaWithNonStandard(self):
 119     self.VerifyContentsProducesOutput("""
 120 div {
 121   /* A hopefully safely ignored comment and @media statement. /**/
 122   color: red;
 123   -webkit-margin-start: 5px;
 124 }""", """
 125 - Alphabetize properties and list vendor specific (i.e. -webkit) above standard.
 126     color: red;
 127     -webkit-margin-start: 5px;""")
 128
 129   def testCssAlphaWithLongerDashedProps(self):
 130     self.VerifyContentsProducesOutput("""
 131 div {
 132   border-left: 5px;  /* A hopefully removed comment. */
 133   border: 5px solid red;
 134 }""", """
 135 - Alphabetize properties and list vendor specific (i.e. -webkit) above standard.
 136     border-left: 5px;
 137     border: 5px solid red;""")
 138
 139   def testCssBracesHaveSpaceBeforeAndNothingAfter(self):
 140     self.VerifyContentsProducesOutput("""
 141 /* Hello! */div/* Comment here*/{
 142   display: block;
 143 }
 144
 145 blah /* hey! */
 146 {
 147   rule: value;
 148 }
 149
 150 .mixed-in {
 151   --css-mixin: {
 152     color: red;
 153   };  /* This should be ignored. */
 154 }
 155
 156 .this.is { /* allowed */
 157   rule: value;
 158 }""", """
 159 - Start braces ({) end a selector, have a space before them and no rules after.
 160     div{
 161     {""")
 162
 163   def testCssClassesUseDashes(self):
 164     self.VerifyContentsProducesOutput("""
 165 .className,
 166 .ClassName,
 167 .class-name /* We should not catch this. */,
 168 .class_name {
 169   display: block;
 170 }""", """
 171  - Classes use .dash-form.
 172     .className,
 173     .ClassName,
 174     .class_name {""")
 175
 176   def testCssCloseBraceOnNewLine(self):
 177     self.VerifyContentsProducesOutput("""
 178 @media { /* TODO(dbeam) Fix this case. */
 179   .rule {
 180     display: block;
 181   }}
 182
 183 @-webkit-keyframe blah {
 184   from { height: rotate(-10turn); }
 185   100% { height: 500px; }
 186 }
 187
 188 #id { /* ${TemplateExpressions} should be ignored. */
 189   rule: ${someValue};
 190   --css-mixin: {
 191     color: red;
 192   };
 193 }
 194
 195 .paper-wrapper {
 196   --paper-thinger: {
 197     background: blue;
 198   };
 199 }
 200
 201 #rule {
 202   rule: value; }""", """
 203 - Always put a rule closing brace (}) on a new line.
 204     rule: value; }""")
 205
 206   def testCssColonsHaveSpaceAfter(self):
 207     self.VerifyContentsProducesOutput("""
 208 div:not(.class):not([attr=5]), /* We should not catch this. */
 209 div:not(.class):not([attr]) /* Nor this. */ {
 210   background: url(data:image/jpeg,asdfasdfsadf); /* Ignore this. */
 211   background: -webkit-linear-gradient(left, red,
 212                                       80% blah blee blar);
 213   color: red;
 214   display:block;
 215 }""", """
 216 - Colons (:) should have a space after them.
 217     display:block;
 218
 219 - Don't use data URIs in source files. Use grit instead.
 220     background: url(data:image/jpeg,asdfasdfsadf);""")
 221
 222   def testCssFavorSingleQuotes(self):
 223     self.VerifyContentsProducesOutput("""
 224 html[dir="rtl"] body,
 225 html[dir=ltr] body /* TODO(dbeam): Require '' around rtl in future? */ {
 226   font-family: "Open Sans";
 227 <if expr="is_macosx">
 228   blah: blee;
 229 </if>
 230 }""", """
 231 - Use single quotes (') instead of double quotes (") in strings.
 232     html[dir="rtl"] body,
 233     font-family: "Open Sans";""")
 234
 235   def testCssHexCouldBeShorter(self):
 236     self.VerifyContentsProducesOutput("""
 237 #abc,
 238 #abc-,
 239 #abc-ghij,
 240 #abcdef-,
 241 #abcdef-ghij,
 242 #aaaaaa,
 243 #bbaacc {
 244   background-color: #336699; /* Ignore short hex rule if not gray. */
 245   color: #999999;
 246   color: #666;
 247 }""", """
 248 - Use abbreviated hex (#rgb) when in form #rrggbb.
 249     color: #999999; (replace with #999)
 250
 251 - Use rgb() over #hex when not a shade of gray (like #333).
 252     background-color: #336699; (replace with rgb(51, 102, 153))""")
 253
 254   def testCssUseMillisecondsForSmallTimes(self):
 255     self.VerifyContentsProducesOutput("""
 256 .transition-0s /* This is gross but may happen. */ {
 257   transform: one 0.2s;
 258   transform: two .1s;
 259   transform: tree 1s;
 260   transform: four 300ms;
 261 }""", """
 262 - Use milliseconds for time measurements under 1 second.
 263     transform: one 0.2s; (replace with 200ms)
 264     transform: two .1s; (replace with 100ms)""")
 265
 266   def testCssNoDataUrisInSourceFiles(self):
 267     self.VerifyContentsProducesOutput("""
 268 img {
 269   background: url( data:image/jpeg,4\/\/350|\/|3|2 );
 270 }""", """
 271 - Don't use data URIs in source files. Use grit instead.
 272     background: url( data:image/jpeg,4\/\/350|\/|3|2 );""")
 273
 274   def testCssNoQuotesInUrl(self):
 275     self.VerifyContentsProducesOutput("""
 276 img {
 277   background: url('chrome://resources/images/blah.jpg');
 278   background: url("../../folder/hello.png");
 279 }""", """
 280 - Use single quotes (') instead of double quotes (") in strings.
 281     background: url("../../folder/hello.png");
 282
 283 - Don't use quotes in url().
 284     background: url('chrome://resources/images/blah.jpg');
 285     background: url("../../folder/hello.png");""")
 286
 287   def testCssOneRulePerLine(self):
 288     self.VerifyContentsProducesOutput("""
 289 a:not([hidden]):not(.custom-appearance):not([version=1]):first-of-type,
 290 a:not([hidden]):not(.custom-appearance):not([version=1]):first-of-type ~
 291     input[type='checkbox']:not([hidden]),
 292 div {
 293   background: url(chrome://resources/BLAH);
 294   rule: value; /* rule: value; */
 295   rule: value; rule: value;
 296 }
 297
 298 .remix {
 299   --dj: {
 300     spin: that;
 301   };
 302 }
 303 """, """
 304 - One rule per line (what not to do: color: red; margin: 0;).
 305     rule: value; rule: value;""")
 306
 307   def testCssOneSelectorPerLine(self):
 308     self.VerifyContentsProducesOutput("""
 309 a,
 310 div,a,
 311 div,/* Hello! */ span,
 312 #id.class([dir=rtl):not(.class):any(a, b, d) {
 313   rule: value;
 314 }
 315
 316 a,
 317 div,a {
 318   some-other: rule here;
 319 }""", """
 320 - One selector per line (what not to do: a, b {}).
 321     div,a,
 322     div, span,
 323     div,a {""")
 324
 325   def testCssPseudoElementDoubleColon(self):
 326     self.VerifyContentsProducesOutput("""
 327 a:href,
 328 br::after,
 329 ::-webkit-scrollbar-thumb,
 330 a:not([empty]):hover:focus:active, /* shouldn't catch here and above */
 331 abbr:after,
 332 .tree-label:empty:after,
 333 b:before,
 334 :-WebKit-ScrollBar {
 335   rule: value;
 336 }""", """
 337 - Pseudo-elements should use double colon (i.e. ::after).
 338     :after (should be ::after)
 339     :after (should be ::after)
 340     :before (should be ::before)
 341     :-WebKit-ScrollBar (should be ::-WebKit-ScrollBar)
 342     """)
 343
 344   def testCssRgbIfNotGray(self):
 345     self.VerifyContentsProducesOutput("""
 346 #abc,
 347 #aaa,
 348 #aabbcc {
 349   background: -webkit-linear-gradient(left, from(#abc), to(#def));
 350   color: #bad;
 351   color: #bada55;
 352 }""", """
 353 - Use rgb() over #hex when not a shade of gray (like #333).
 354     background: -webkit-linear-gradient(left, from(#abc), to(#def)); """
 355 """(replace with rgb(170, 187, 204), rgb(221, 238, 255))
 356     color: #bad; (replace with rgb(187, 170, 221))
 357     color: #bada55; (replace with rgb(186, 218, 85))""")
 358
 359   def testWebkitBeforeOrAfter(self):
 360     self.VerifyContentsProducesOutput("""
 361 .test {
 362   -webkit-margin-before: 10px;
 363   -webkit-margin-start: 20px;
 364   -webkit-padding-after: 3px;
 365   -webkit-padding-end: 5px;
 366 }
 367 """, """
 368 - Use *-top/bottom instead of -webkit-*-before/after.
 369     -webkit-margin-before: 10px; (replace with margin-top)
 370     -webkit-padding-after: 3px; (replace with padding-bottom)""")
 371
 372   def testCssZeroWidthLengths(self):
 373     self.VerifyContentsProducesOutput("""
 374 @-webkit-keyframe anim {
 375   0% { /* Ignore key frames */
 376     width: 0px;
 377   }
 378   10% {
 379     width: 10px;
 380   }
 381   100% {
 382     width: 100px;
 383   }
 384 }
 385
 386 #logo {
 387   background-image: url(images/google_logo.png@2x);
 388 }
 389
 390 body.alternate-logo #logo {
 391   -webkit-mask-image: url(images/google_logo.png@2x);
 392 }
 393
 394 /* http://crbug.com/359682 */
 395 #spinner-container #spinner {
 396   -webkit-animation-duration: 1.0s;
 397 }
 398
 399 .media-button.play > .state0.active,
 400 .media-button[state='0'] > .state0.normal /* blah */, /* blee */
 401 .media-button[state='0']:not(.disabled):hover > .state0.hover {
 402   -webkit-animation: anim 0s;
 403   -webkit-animation-duration: anim 0ms;
 404   -webkit-transform: scale(0%);
 405   background-position-x: 0em;
 406   background-position-y: 0ex;
 407   border-width: 0em;
 408   color: hsl(0, 0%, 85%); /* Shouldn't trigger error. */
 409   opacity: .0;
 410   opacity: 0.0;
 411   opacity: 0.;
 412 }
 413
 414 @page {
 415   border-width: 0mm;
 416   height: 0cm;
 417   width: 0in;
 418 }""", """
 419 - Use "0" for zero-width lengths (i.e. 0px -> 0)
 420     width: 0px;
 421     -webkit-transform: scale(0%);
 422     background-position-x: 0em;
 423     background-position-y: 0ex;
 424     border-width: 0em;
 425     opacity: .0;
 426     opacity: 0.0;
 427     opacity: 0.;
 428     border-width: 0mm;
 429     height: 0cm;
 430     width: 0in;
 431 """)
 432
 433
 434 if __name__ == '__main__':
 435   unittest.main()