Disallow equality assertions with boolean, null, and undefined.

Require the more descriptive `assert.isTrue`, `assert.isFalse`,
`assert.isNull`, `assert.isUndefined`, and friends instead, which also
produce a more meaningful error message than the generic
`assert.strictEqual`, `assert.deepEqual`, and friends.

Bug: 386335487
Change-Id: Ic58a07381196c358a43857b53364d74076e9c7e8
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6113833
Reviewed-by: Changhao Han <[email protected]>
Commit-Queue: Benedikt Meurer <[email protected]>

Author: bmeurer

.eslintrc.js

@@ -293,8 +293,9 @@ module.exports = {
 
       'rulesdir/check-test-definitions' : 'error',
       'rulesdir/compare-arrays-with-assert-deepequal' : 'error',
-      'rulesdir/no-assert-equal' : 'error',
       'rulesdir/no-assert-deep-strict-equal' : 'error',
+      'rulesdir/no-assert-equal' : 'error',
+      'rulesdir/no-assert-equal-boolean-null-undefined' : 'error',
       'rulesdir/no-repeated-tests' : 'error',
       'rulesdir/no-screenshot-test-outside-perf-panel' : 'error',
       'rulesdir/prefer-assert-length-of' : 'error',

front_end/core/common/CharacterIdMap.test.ts

@@ -41,6 +41,6 @@ describe('CharacterIdMap class', () => {
 
   it('returns null when trying to convert  a character that does not exist in the Map', () => {
     const characterIdMap = new CharacterIdMap();
-    assert.strictEqual(characterIdMap.fromChar('!'), null, 'character was not converted correctly');
+    assert.isNull(characterIdMap.fromChar('!'), 'character was not converted correctly');
   });
 });

front_end/core/common/ColorUtils.test.ts

@@ -95,9 +95,9 @@ describe('ColorUtils', () => {
   });
 
   it('is able to find APCA threshold by font size and weight', () => {
-    assert.deepEqual(Common.ColorUtils.getAPCAThreshold('11px', '100'), null);
+    assert.isNull(Common.ColorUtils.getAPCAThreshold('11px', '100'));
     assert.deepEqual(Common.ColorUtils.getAPCAThreshold('121px', '100'), 60);
-    assert.deepEqual(Common.ColorUtils.getAPCAThreshold('16px', '100'), null);
+    assert.isNull(Common.ColorUtils.getAPCAThreshold('16px', '100'));
     assert.deepEqual(Common.ColorUtils.getAPCAThreshold('16px', '400'), 90);
     assert.deepEqual(Common.ColorUtils.getAPCAThreshold('16px', '900'), 50);
   });

front_end/core/common/Console.test.ts

@@ -15,7 +15,7 @@ describe('Console', () => {
       assert.lengthOf(messages, 1);
       assert.strictEqual(messages[0].text, 'Foo');
       assert.strictEqual(messages[0].level, Common.Console.MessageLevel.INFO);
-      assert.strictEqual(messages[0].show, true);
+      assert.isTrue(messages[0].show);
     });
 
     it('stores messages', () => {
@@ -47,7 +47,7 @@ describe('Console', () => {
       console.log('Lorem Ipsum');
       const messages = console.messages();
       assert.lengthOf(messages, 1);
-      assert.strictEqual(messages[0].show, false);  // Infos don't popup the Console panel by default
+      assert.isFalse(messages[0].show);  // Infos don't popup the Console panel by default
       assert.strictEqual(messages[0].level, Common.Console.MessageLevel.INFO);
     });
   });
@@ -58,7 +58,7 @@ describe('Console', () => {
       console.warn('Lorem Ipsum');
       const messages = console.messages();
       assert.lengthOf(messages, 1);
-      assert.strictEqual(messages[0].show, false);  // Warnings don't popup the Console panel by default
+      assert.isFalse(messages[0].show);  // Warnings don't popup the Console panel by default
       assert.strictEqual(messages[0].level, Common.Console.MessageLevel.WARNING);
     });
   });
@@ -69,7 +69,7 @@ describe('Console', () => {
       console.error('Lorem Ipsum');
       const messages = console.messages();
       assert.lengthOf(messages, 1);
-      assert.strictEqual(messages[0].show, true);  // Errors popup the Console panel by default
+      assert.isTrue(messages[0].show);  // Errors popup the Console panel by default
       assert.strictEqual(messages[0].level, Common.Console.MessageLevel.ERROR);
     });
 
@@ -79,8 +79,8 @@ describe('Console', () => {
       console.error('Baz', true);
       const messages = console.messages();
       assert.lengthOf(messages, 2);
-      assert.strictEqual(messages[0].show, false);
-      assert.strictEqual(messages[1].show, true);
+      assert.isFalse(messages[0].show);
+      assert.isTrue(messages[1].show);
     });
   });
 });

front_end/core/common/ParsedURL.test.ts

@@ -159,17 +159,17 @@ describe('Parsed URL', () => {
 
   it('checks that URL is valid', () => {
     const urlTest = 'http://www.example.com#?test';
-    assert.strictEqual(ParsedURL.isValidUrlString(urlTest), true, 'URL validation was incorrect');
+    assert.isTrue(ParsedURL.isValidUrlString(urlTest), 'URL validation was incorrect');
   });
 
   it('checks that file:// URL is valid', () => {
     const urlTest = 'file:///usr/lib';
-    assert.strictEqual(ParsedURL.isValidUrlString(urlTest), true, 'URL validation was incorrect');
+    assert.isTrue(ParsedURL.isValidUrlString(urlTest), 'URL validation was incorrect');
   });
 
   it('checks that "://" is not a valid URL', () => {
     const urlTest = '://';
-    assert.strictEqual(ParsedURL.isValidUrlString(urlTest), false, 'URL validation was incorrect');
+    assert.isFalse(ParsedURL.isValidUrlString(urlTest), 'URL validation was incorrect');
   });
 
   it('converts URL with a hash to a URL without a hash', () => {
@@ -358,7 +358,7 @@ describe('Parsed URL', () => {
     const hrefTest = 'www.example.com';
     const baseUrlTest = 'www.example.com' as Platform.DevToolsPath.UrlString;
     const completeUrl = ParsedURL.completeURL(baseUrlTest, hrefTest);
-    assert.strictEqual(completeUrl, null, 'complete URL is not returned correctly');
+    assert.isNull(completeUrl, 'complete URL is not returned correctly');
   });
 
   it('uses the completeURL function to return the href if the base URL is a data URL', () => {
@@ -421,7 +421,7 @@ describe('Parsed URL', () => {
     const splitResult = ParsedURL.splitLineAndColumn(stringTest);
     assert.strictEqual(splitResult.url, 'http://www.example.com/foo.js', 'URL is not correct');
     assert.strictEqual(splitResult.lineNumber, 14, 'line number is incorrect');
-    assert.strictEqual(splitResult.columnNumber, undefined, 'column number is incorrect');
+    assert.isUndefined(splitResult.columnNumber, 'column number is incorrect');
   });
 
   it('uses the splitLineAndColumn function to return the line and column numbers if the URL contains them', () => {

front_end/core/common/Progress.test.ts

@@ -64,7 +64,7 @@ describe('Composite Progress Bar', () => {
     const composite = new CompositeProgress(indicator);
     const subProgress = composite.createSubProgress();
 
-    assert.strictEqual(indicator.getTitle, undefined);
+    assert.isUndefined(indicator.getTitle);
     assert.strictEqual(indicator.getWorkCompleted, 0);
     assert.strictEqual(indicator.getTotalWork, 1);
 
@@ -98,7 +98,7 @@ describe('Composite Progress Bar', () => {
     // Creates a sub progress with the weight of 3
     const subProgress2 = composite.createSubProgress(3);
 
-    assert.strictEqual(indicator.getTitle, undefined);
+    assert.isUndefined(indicator.getTitle);
     assert.strictEqual(indicator.getWorkCompleted, 0);
     assert.strictEqual(indicator.getTotalWork, 1);
 
@@ -154,17 +154,17 @@ describe('Composite Progress Bar', () => {
     const composite1 = new CompositeProgress(subProgress01);
     const subProgress11 = composite1.createSubProgress(10);  // Weight should have no effect
 
-    assert.strictEqual(indicator.getTitle, undefined);
+    assert.isUndefined(indicator.getTitle);
     assert.strictEqual(indicator.getWorkCompleted, 0);
     assert.strictEqual(indicator.getTotalWork, 1);
 
     subProgress11.setWorked(10);
-    assert.strictEqual(indicator.getTitle, undefined);
+    assert.isUndefined(indicator.getTitle);
     assert.strictEqual(indicator.getWorkCompleted, 0);
     assert.strictEqual(indicator.getTotalWork, 1);
 
     subProgress11.setTotalWork(100);
-    assert.strictEqual(indicator.getTitle, undefined);
+    assert.isUndefined(indicator.getTitle);
     assert.strictEqual(indicator.getWorkCompleted, 0.1);
     assert.strictEqual(indicator.getTotalWork, 1);
 
@@ -188,14 +188,14 @@ describe('Composite Progress Bar', () => {
     const composite = new CompositeProgress(indicator);
     const subProgress = composite.createSubProgress();
 
-    assert.strictEqual(indicator.getTitle, undefined);
+    assert.isUndefined(indicator.getTitle);
     assert.strictEqual(indicator.getWorkCompleted, 0);
     assert.strictEqual(indicator.getTotalWork, 1);
     assert.strictEqual(subProgress.getWorked(), 0);
 
     subProgress.incrementWorked();
 
-    assert.strictEqual(indicator.getTitle, undefined);
+    assert.isUndefined(indicator.getTitle);
     assert.strictEqual(indicator.getWorkCompleted, 0);
     assert.strictEqual(indicator.getTotalWork, 1);
     assert.strictEqual(subProgress.getWorked(), 1);

front_end/core/common/ResolverBase.test.ts

@@ -62,15 +62,15 @@ describe('ResolverBase', () => {
         throw new Error('This should not get called');
       });
       resolver.assertIsListening();
-      assert.strictEqual(obj, null);
+      assert.isNull(obj);
       resolver.clear();
     });
 
     it('should resolve a previously unknown object when it becomes available', async () => {
       const resolver = new ResolverTestImpl();
       const waitForCall = new Promise<TestClass>(resolve => {
         const obj = resolver.tryGet(id, resolve);
-        assert.strictEqual(obj, null);
+        assert.isNull(obj);
       });
       resolver.assertIsListening();
       resolver.onResolve(id, testObj);

front_end/core/common/ResourceType.test.ts

@@ -34,7 +34,7 @@ describeWithEnvironment('ResourceType class', () => {
     assert.strictEqual(
         resourceType.category().shortTitle(), 'Category Test Short Title',
         'category short title was not set correctly');
-    assert.strictEqual(resourceType.isTextType(), true, 'resource type was not set correctly');
+    assert.isTrue(resourceType.isTextType(), 'resource type was not set correctly');
   });
 
   it('is able to return a document resource from the string "text/html"', () => {
@@ -411,13 +411,13 @@ describeWithEnvironment('ResourceType class', () => {
 
   it('treats a Ping as Other', () => {
     const resourceType = resourceTypes.Ping;
-    assert.strictEqual(resourceType.isTextType(), false, 'A ping is not a text type');
+    assert.isFalse(resourceType.isTextType(), 'A ping is not a text type');
     assert.strictEqual(resourceType.canonicalMimeType(), '', 'A ping does not have an associated mime type');
   });
 
   it('treats a CSPViolationsReport as Other', () => {
     const resourceType = resourceTypes.CSPViolationReport;
-    assert.strictEqual(resourceType.isTextType(), false, 'A ping is not a text type');
+    assert.isFalse(resourceType.isTextType(), 'A ping is not a text type');
     assert.strictEqual(resourceType.canonicalMimeType(), '', 'A ping does not have an associated mime type');
   });
 });

front_end/core/dom_extension/DOMExtension.test.ts

@@ -47,7 +47,7 @@ describe('DataGrid', () => {
         */
 
     let node: HTMLElement = component1;
-    assert.strictEqual(node.nodeValue, null, 'root node value is incorrect');
+    assert.isNull(node.nodeValue, 'root node value is incorrect');
     assert.strictEqual(node.nodeName, 'DIV', 'root node name is incorrect');
     assert.strictEqual(node.className, 'component1', 'root node class is incorrect');
 

front_end/core/platform/StringUtilities.test.ts

@@ -249,7 +249,7 @@ describe('StringUtilities', () => {
   describe('createSearchRegex', () => {
     it('returns a case sensitive regex if the call states it is case sensitive', () => {
       const regex = Platform.StringUtilities.createSearchRegex('foo', true, false);
-      assert.strictEqual(regex.ignoreCase, false);
+      assert.isFalse(regex.ignoreCase);
       assert.strictEqual(regex.source, 'foo');
     });