Use backquotes for strings (#45)

FerretDB · Sep 23, 2024 · b05894d · b05894d
1 parent 74fd337
commit b05894d
Show file tree

Hide file tree

Showing 8 changed files with 67 additions and 62 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -9,12 +9,16 @@ linters-settings:
     settings:
       shadow:
         strict: true
+  staticcheck:
+    checks:
+      - all
 
 linters:
   disable-all: true
   enable:
     # TODO https://github.com/FerretDB/wire/issues/4
     - govet
+    - staticcheck
 
 issues:
   max-issues-per-linter: 0

diff --git a/op_msg_test.go b/op_msg_test.go
@@ -53,7 +53,7 @@ var msgTestCases = []testCase{
 			}},
 		},
 		command: "buildInfo",
-		b: `
+		si: `
 		{
 		  "FlagBits": "[]",
 		  "Checksum": int64(0),
@@ -128,7 +128,7 @@ var msgTestCases = []testCase{
 			}},
 		},
 		command: "version",
-		b: `
+		si: `
 		{
 		  "FlagBits": "[]",
 		  "Checksum": int64(0),
@@ -221,7 +221,7 @@ var msgTestCases = []testCase{
 			},
 		},
 		command: "insert",
-		b: `
+		si: `
 		{
 		  "FlagBits": "[]",
 		  "Checksum": int64(0),
@@ -315,7 +315,7 @@ var msgTestCases = []testCase{
 			}},
 		},
 		command: "insert",
-		b: `
+		si: `
 		{
 		  "FlagBits": "[]",
 		  "Checksum": int64(0),
@@ -389,7 +389,7 @@ var msgTestCases = []testCase{
 			},
 		},
 		command: "insert",
-		b: `
+		si: `
 		{
 		  "FlagBits": "[]",
 		  "Checksum": int64(0),
@@ -475,7 +475,7 @@ var msgTestCases = []testCase{
 			checksum: 1737537506,
 		},
 		command: "insert",
-		b: `
+		si: `
 		{
 		  "FlagBits": "[checksumPresent]",
 		  "Checksum": int64(1737537506),
@@ -584,7 +584,7 @@ var msgTestCases = []testCase{
 			checksum: 2932997361,
 		},
 		command: "update",
-		b: `
+		si: `
 		{
 		  "FlagBits": "[checksumPresent]",
 		  "Checksum": int64(2932997361),

diff --git a/op_query_test.go b/op_query_test.go
@@ -60,7 +60,7 @@ var queryTestCases = []testCase{
 			),
 			returnFieldsSelector: nil,
 		},
-		b: `
+		si: `
 		{
 		  "Flags": "[]",
 		  "FullCollectionName": "admin.$cmd",
@@ -129,7 +129,7 @@ var queryTestCases = []testCase{
 			),
 			returnFieldsSelector: nil,
 		},
-		b: `
+		si: `
 		{
 		  "Flags": "[]",
 		  "FullCollectionName": "admin.$cmd",

diff --git a/op_reply_test.go b/op_reply_test.go
@@ -55,7 +55,7 @@ var replyTestCases = []testCase{
 				"ok", float64(1),
 			),
 		},
-		b: `
+		si: `
 		{
 		  "ResponseFlags": "[AwaitCapable]",
 		  "CursorID": int64(0),
@@ -112,7 +112,7 @@ var replyTestCases = []testCase{
 				"ok", float64(1),
 			),
 		},
-		b: `
+		si: `
 		{
 		  "ResponseFlags": "[AwaitCapable]",
 		  "CursorID": int64(0),

diff --git a/wire_test.go b/wire_test.go
@@ -20,6 +20,7 @@ import (
 	"errors"
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 	"time"
 
@@ -70,7 +71,7 @@ type testCase struct {
 	msgHeader *MsgHeader
 	msgBody   MsgBody
 	command   string // only for OpMsg
-	b         string
+	si        string
 	err       string // unwrapped
 }
 
@@ -127,7 +128,7 @@ func testMessages(t *testing.T, testCases []testCase) {
 				require.NotNil(t, msgHeader)
 				require.NotNil(t, msgBody)
 				assert.NotEmpty(t, msgHeader.String())
-				assert.Equal(t, testutil.Unindent(tc.b), msgBody.StringIndent())
+				assert.Equal(t, strings.ReplaceAll(testutil.Unindent(tc.si), `"`, "`"), msgBody.StringIndent())
 				assert.NotEmpty(t, msgBody.String())
 
 				require.NoError(t, msgBody.check())

diff --git a/wirebson/bson_test.go b/wirebson/bson_test.go
@@ -15,6 +15,7 @@
 package wirebson
 
 import (
+	"strings"
 	"testing"
 	"time"
 
@@ -31,7 +32,7 @@ type normalTestCase struct {
 	name string
 	raw  RawDocument
 	doc  *Document
-	b    string
+	mi   string
 }
 
 // decodeTestCase represents a single test case for unsuccessful decoding.
@@ -77,7 +78,7 @@ var normalTestCases = []normalTestCase{
 			"compression", MustArray("none"),
 			"loadBalanced", false,
 		),
-		b: `
+		mi: `
 		{
 		  "ismaster": true,
 		  "client": {
@@ -126,7 +127,7 @@ var normalTestCases = []normalTestCase{
 			"compression", MustArray("none"),
 			"loadBalanced", false,
 		),
-		b: `
+		mi: `
 		{
 		  "ismaster": true,
 		  "client": {
@@ -167,7 +168,7 @@ var normalTestCases = []normalTestCase{
 			),
 			"$db", "admin",
 		),
-		b: `
+		mi: `
 		{
 		  "buildInfo": 1,
 		  "lsid": {
@@ -220,7 +221,7 @@ var normalTestCases = []normalTestCase{
 			"storageEngines", MustArray("devnull", "ephemeralForTest", "wiredTiger"),
 			"ok", float64(1),
 		),
-		b: `
+		mi: `
 		{
 		  "version": "5.0.0",
 		  "gitVersion": "1184f004a99660de6f5e745573419bda8a28c0e9",
@@ -290,7 +291,7 @@ var normalTestCases = []normalTestCase{
 			"timestamp", MustArray(Timestamp(42), Timestamp(0)),
 			"decimal128", MustArray(Decimal128{L: 42, H: 13}),
 		),
-		b: `
+		mi: `
 		{
 		  "array": [
 		    [
@@ -353,7 +354,7 @@ var normalTestCases = []normalTestCase{
 		name: "nested",
 		raw:  testutil.MustParseDumpFile("testdata", "nested.hex"),
 		doc:  makeNested(false, 150).(*Document),
-		b: `
+		mi: `
 		{
 		  "f": [
 		    {
@@ -407,7 +408,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", float64(3.141592653589793),
 		),
-		b: `
+		mi: `
 		{
 		  "f": 3.141592653589793,
 		}`,
@@ -424,7 +425,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", "v",
 		),
-		b: `
+		mi: `
 		{
 		  "f": "v",
 		}`,
@@ -442,7 +443,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", Binary{B: []byte("v"), Subtype: BinaryUser},
 		),
-		b: `
+		mi: `
 		{
 		  "f": Binary(user:dg==),
 		}`,
@@ -458,7 +459,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", ObjectID{0x62, 0x56, 0xc5, 0xba, 0x18, 0x2d, 0x44, 0x54, 0xfb, 0x21, 0x09, 0x40},
 		),
-		b: `
+		mi: `
 		{
 		  "f": ObjectID(6256c5ba182d4454fb210940),
 		}`,
@@ -474,7 +475,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", true,
 		),
-		b: `
+		mi: `
 		{
 		  "f": true,
 		}`,
@@ -490,7 +491,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", time.Date(2024, 1, 17, 17, 40, 42, 123000000, time.UTC),
 		),
-		b: `
+		mi: `
 		{
 		  "f": 2024-01-17T17:40:42.123Z,
 		}`,
@@ -505,7 +506,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", Null,
 		),
-		b: `
+		mi: `
 		{
 		  "f": null,
 		}`,
@@ -522,7 +523,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", Regex{Pattern: "p", Options: "o"},
 		),
-		b: `
+		mi: `
 		{
 		  "f": /p/o,
 		}`,
@@ -538,7 +539,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", int32(314159265),
 		),
-		b: `
+		mi: `
 		{
 		  "f": 314159265,
 		}`,
@@ -554,7 +555,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", Timestamp(42),
 		),
-		b: `
+		mi: `
 		{
 		  "f": Timestamp(42),
 		}`,
@@ -570,7 +571,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", int64(3141592653589793),
 		),
-		b: `
+		mi: `
 		{
 		  "f": int64(3141592653589793),
 		}`,
@@ -586,7 +587,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"f", Decimal128{L: 42, H: 13},
 		),
-		b: `
+		mi: `
 		{
 		  "f": Decimal128(42,13),
 		}`,
@@ -602,7 +603,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"foo", MustDocument(),
 		),
-		b: `
+		mi: `
 		{
 		  "foo": {},
 		}`,
@@ -618,7 +619,7 @@ var normalTestCases = []normalTestCase{
 		doc: MustDocument(
 			"foo", MustArray(),
 		),
-		b: `
+		mi: `
 		{
 		  "foo": [],
 		}`,
@@ -635,7 +636,7 @@ var normalTestCases = []normalTestCase{
 			"", false,
 			"", true,
 		),
-		b: `
+		mi: `
 		{
 		  "": false,
 		  "": true,
@@ -781,7 +782,7 @@ func TestNormal(t *testing.T) {
 				assert.NotContains(t, ls, "called too many times")
 
 				assert.NotEmpty(t, doc.LogMessage())
-				assert.Equal(t, testutil.Unindent(tc.b), doc.LogMessageIndent())
+				assert.Equal(t, strings.ReplaceAll(testutil.Unindent(tc.mi), `"`, "`"), doc.LogMessageIndent())
 
 				raw, err := doc.Encode()
 				require.NoError(t, err)