Lint itScreenshot.skip like we lint other skip calls

Fixed: 373791684
Change-Id: If9729360cf7260b9cbf068b9cfa5f6876a60cada
No-Presubmit: True
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/5933853
Auto-Submit: Jack Franklin <[email protected]>
Reviewed-by: Philip Pfaffe <[email protected]>
Commit-Queue: Jack Franklin <[email protected]>

Author: jackfranklin

scripts/eslint_rules/lib/check_test_definitions.js

@@ -47,7 +47,7 @@ module.exports = {
   create: function(context) {
     return {
       MemberExpression(node) {
-        if ((node.object.name === 'it' || node.object.name === 'describe') &&
+        if ((node.object.name === 'it' || node.object.name === 'describe' || node.object.name === 'itScreenshot') &&
             (node.property.name === 'skip' || node.property.name === 'skipOnPlatforms') &&
             node.parent.type === 'CallExpression') {
           const testNameNode = node.property.name === 'skip' ? node.parent.arguments[0] : node.parent.arguments[1];

scripts/eslint_rules/tests/check_test_definitions_test.js

@@ -121,6 +121,16 @@ ruleTester.run('check_e2e_tests', rule, {
       filename: 'test/e2e/folder/file.ts',
       errors: [{message: rule.meta.messages.missingBugId}],
     },
+    {
+      code: `describe('e2e-test', async () => {
+        // Explaining comment
+        itScreenshot.skip(\`normal test \${withVariable}\`, async () => {
+        });
+      });
+      `,
+      filename: 'test/e2e/folder/file.ts',
+      errors: [{message: rule.meta.messages.missingBugId}],
+    },
     {
       code: `import {describe, it} from '../../shared/mocha-extensions.js';
 

test/interactions/panels/performance/timeline/overview_test.ts

@@ -8,8 +8,8 @@ import {assertElementScreenshotUnchanged} from '../../../../shared/screenshots.j
 import {loadComponentDocExample} from '../../../helpers/shared.js';
 
 describe('Performance panel overview/minimap', function() {
-  // b/336787201
-  itScreenshot.skip('renders the overview', async () => {
+  // Flaking.
+  itScreenshot.skip('[crbug.com/336787201]: renders the overview', async () => {
     await loadComponentDocExample('performance_panel/overview.html?trace=web-dev');
     const pane = await waitFor('.container #timeline-overview-pane');
     await assertElementScreenshotUnchanged(pane, 'performance/timeline-overview.png', 3);
@@ -21,8 +21,8 @@ describe('Performance panel overview/minimap', function() {
     await assertElementScreenshotUnchanged(pane, 'performance/timeline-overview-long-task-red-bar.png', 3);
   });
 
-  // b/336788321
-  itScreenshot.skip('shows network requests in the overview', async () => {
+  // Flaking.
+  itScreenshot.skip('[crbug.com/336788321]: shows network requests in the overview', async () => {
     await loadComponentDocExample('performance_panel/overview.html?trace=many-requests');
     const pane = await waitFor('.container #timeline-overview-pane');
     await assertElementScreenshotUnchanged(pane, 'performance/timeline-overview-busy-network.png', 3);

test/interactions/panels/performance/timeline/timeline_test.ts

@@ -46,7 +46,7 @@ describe('Performance panel', function() {
 
   // Flaky on linux
   itScreenshot.skipOnPlatforms(
-      ['linux'], '[crbug.com/327586819 renders the timeline correctly when scrolling', async () => {
+      ['linux'], '[crbug.com/327586819]: renders the timeline correctly when scrolling', async () => {
         await loadComponentDocExample('performance_panel/basic.html?trace=one-second-interaction');
         await waitFor('.timeline-flamechart');
         const panel = await waitFor('body');
@@ -89,7 +89,8 @@ describe('Performance panel', function() {
     await assertElementScreenshotUnchanged(panel, 'performance/timeline-long-task-candystripe.png', 2);
   });
 
-  itScreenshot.skip('renders screenshots in the frames track', async () => {
+  // Flaking.
+  itScreenshot.skip('[crbug.com/41483851]: renders screenshots in the frames track', async () => {
     if (this.timeout() !== 0) {
       this.timeout(20_000);
     }
@@ -105,21 +106,24 @@ describe('Performance panel', function() {
     await assertElementScreenshotUnchanged(panel, 'performance/timeline-web-dev-screenshot-frames.png', 1);
   });
 
-  itScreenshot.skip('supports the network track being expanded and then clicked', async function() {
-    await loadComponentDocExample('performance_panel/basic.html?trace=web-dev');
-    await waitFor('.timeline-flamechart');
-    const panel = await waitFor('body');
+  // Flaking.
+  itScreenshot.skip(
+      '[crbug.com/373792008]: supports the network track being expanded and then clicked', async function() {
+        await loadComponentDocExample('performance_panel/basic.html?trace=web-dev');
+        await waitFor('.timeline-flamechart');
+        const panel = await waitFor('body');
 
-    const {frontend} = getBrowserAndPages();
-    // Click to expand the network track.
-    await frontend.mouse.click(27, 131);
-    await timeout(100);  // cannot await for DOM as this is a purely canvas change.
-    await assertElementScreenshotUnchanged(panel, 'performance/timeline-expand-network-panel.png', 1);
-    // Click to select a network event.
-    await frontend.mouse.click(104, 144);
-    await timeout(100);  // cannot await for DOM as this is a purely canvas change.
-    await assertElementScreenshotUnchanged(panel, 'performance/timeline-expand-network-panel-and-select-event.png', 1);
-  });
+        const {frontend} = getBrowserAndPages();
+        // Click to expand the network track.
+        await frontend.mouse.click(27, 131);
+        await timeout(100);  // cannot await for DOM as this is a purely canvas change.
+        await assertElementScreenshotUnchanged(panel, 'performance/timeline-expand-network-panel.png', 1);
+        // Click to select a network event.
+        await frontend.mouse.click(104, 144);
+        await timeout(100);  // cannot await for DOM as this is a purely canvas change.
+        await assertElementScreenshotUnchanged(
+            panel, 'performance/timeline-expand-network-panel-and-select-event.png', 1);
+      });
 
   it('renders the window range bounds correctly when loading multiple profiles', async () => {
     await loadComponentDocExample('performance_panel/basic.html?cpuprofile=basic');