From b7661a8311a0bf5703a009bf35b4333c1c6e60e0 Mon Sep 17 00:00:00 2001
From: Rich Trott <rtrott@gmail.com>
Date: Mon, 30 Jul 2018 16:33:41 -0700
Subject: [PATCH] tools: prevent string literals in some assertions

String literals provided as the third argument to assert.strictEqual()
or assert.deepStrictEqual() will mask the values that are causing
issues. Use a lint rule to prevent such usage.

PR-URL: https://github.com/nodejs/node/pull/22849
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
---
 .eslintrc.js        | 5 +++++
 lib/.eslintrc.yaml  | 4 ++++
 test/.eslintrc.yaml | 4 ++++
 3 files changed, 13 insertions(+)

diff --git a/.eslintrc.js b/.eslintrc.js
index 9c3a78d81cd..e4192c35399 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -156,6 +156,7 @@ module.exports = {
     ],
     /* eslint-disable max-len */
     // If this list is modified, please copy the change to lib/.eslintrc.yaml
+    // and test/.eslintrc.yaml.
     'no-restricted-syntax': [
       'error',
       {
@@ -166,6 +167,10 @@ module.exports = {
         selector: "CallExpression[callee.object.name='assert'][callee.property.name='rejects'][arguments.length<2]",
         message: 'assert.rejects() must be invoked with at least two arguments.',
       },
+      {
+        selector: "CallExpression[callee.object.name='assert'][callee.property.name='strictEqual'][arguments.2.type='Literal']",
+        message: 'Do not use a literal for the third argument of assert.strictEqual()'
+      },
       {
         selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.1.type='Literal']:not([arguments.1.regex])",
         message: 'Use an object as second argument of assert.throws()',
diff --git a/lib/.eslintrc.yaml b/lib/.eslintrc.yaml
index e7cab0ad931..a1a0b9490a9 100644
--- a/lib/.eslintrc.yaml
+++ b/lib/.eslintrc.yaml
@@ -2,10 +2,14 @@ rules:
   no-restricted-syntax:
     # Config copied from .eslintrc.js
     - error
+    - selector: "CallExpression[callee.object.name='assert'][callee.property.name='deepStrictEqual'][arguments.2.type='Literal']"
+      message: "Do not use a literal for the third argument of assert.deepStrictEqual()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='doesNotThrow']"
       message: "Please replace `assert.doesNotThrow()` and add a comment next to the code instead."
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='rejects'][arguments.length<2]"
       message: "assert.rejects() must be invoked with at least two arguments."
+    - selector: "CallExpression[callee.object.name='assert'][callee.property.name='strictEqual'][arguments.2.type='Literal']"
+      message: "Do not use a literal for the third argument of assert.strictEqual()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.1.type='Literal']:not([arguments.1.regex])"
       message: "Use an object as second argument of assert.throws()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.length<2]"
diff --git a/test/.eslintrc.yaml b/test/.eslintrc.yaml
index 25026fec5a1..63d2127d738 100644
--- a/test/.eslintrc.yaml
+++ b/test/.eslintrc.yaml
@@ -23,10 +23,14 @@ rules:
   no-restricted-syntax:
     # Config copied from .eslintrc.js
     - error
+    - selector: "CallExpression[callee.object.name='assert'][callee.property.name='deepStrictEqual'][arguments.2.type='Literal']"
+      message: "Do not use a literal for the third argument of assert.deepStrictEqual()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='doesNotThrow']"
       message: "Please replace `assert.doesNotThrow()` and add a comment next to the code instead."
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='rejects'][arguments.length<2]"
       message: "assert.rejects() must be invoked with at least two arguments."
+    - selector: "CallExpression[callee.object.name='assert'][callee.property.name='strictEqual'][arguments.2.type='Literal']"
+      message: "Do not use a literal for the third argument of assert.strictEqual()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.1.type='Literal']:not([arguments.1.regex])"
       message: "Use an object as second argument of assert.throws()"
     - selector: "CallExpression[callee.object.name='assert'][callee.property.name='throws'][arguments.length<2]"