test: improve clarity of test names (#1720)

* test: improve test names for clarity and fix typos

- Fix typos: 'succesfully' -> 'successfully' in connector-test.ts
- Fix typo: 'Wrtiable' -> 'Writable' in writable-tracking-buffer-test.ts
- Fix typo: 'package' -> 'packet' in incoming-message-stream-test.ts
- Fix typo: 'mulitple' -> 'multiple' in packet-test.ts
- Rename 'Packet Tests' describe block to 'Debug' in debug-test.ts
- Change 'should write X' to 'should parse X' in row-token-parser-test.ts
- Fix awkward test names in done-token-parser-test.ts
- Fix test names in env-change-token-parser-test.ts
- Rename describe blocks for consistency (PreloginPayload, NTLMPayload, etc.)
- Fix camelCase test names to readable sentences in instance-lookup-test.ts
- Fix unclear test names in packet-test.ts
- Fix redundant 'it' prefix in rerouting-test.ts
- Fix awkward phrasing in feature-ext-parser-test.ts
- Improve test names in tedious-test.ts, colmetadata-token-parser-test.ts
- Rename TransientErrorLookup describe block and test names

* test: rename debug test names for consistency

Update 'should not enable payload' and 'should not enable data' to
'should not emit payload debug events when disabled' and 'should not
emit data debug events when disabled' for consistency with the token
test naming pattern.

* Undo unintended changes.

---------

Co-authored-by: Claude <noreply@anthropic.com>

Author: arthurschreiber

test/integration/bulk-load-test.ts

@@ -1504,7 +1504,7 @@ describe('BulkLoad', function() {
       connection.execSqlBatch(request);
     });
 
-    it('should handle validation errors during streaming bulk loads', (done) => {
+    it('should handle validation errors during streaming bulk loads', function(done) {
       const bulkLoad = connection.newBulkLoad('#stream_test', completeBulkLoad);
       bulkLoad.addColumn('value', TYPES.Date, { nullable: false });
 
@@ -1522,7 +1522,7 @@ describe('BulkLoad', function() {
       }
     });
 
-    it('should allow reusing the connection after validation errors during streaming bulk loads', (done) => {
+    it('should allow reusing the connection after validation errors during streaming bulk loads', function(done) {
       const bulkLoad = connection.newBulkLoad('#stream_test', completeBulkLoad);
       bulkLoad.addColumn('value', TYPES.Date, { nullable: false });
 
@@ -1554,7 +1554,7 @@ describe('BulkLoad', function() {
     });
   });
 
-  it('should not throw in _transform function', (done) => {
+  it('should not throw in _transform function', function(done) {
     const bulkLoad = connection.newBulkLoad(
       '#tmpTestTable',
       (err, rowCount) => {

test/integration/connection-test.ts

@@ -1428,7 +1428,7 @@ update #tab1 set name = 'a3' where name like 'a%'\
     }
   });
 
-  it('should request timeout', (done) => {
+  it('should request timeout', function(done) {
     const request = new Request(
       "select 1 as C1;waitfor delay '00:00:05';select 2 as C2",
       function(err, rowCount, rows) {

test/unit/all-headers-test.ts

@@ -2,7 +2,7 @@ import { assert } from 'chai';
 import WritableTrackingBuffer from '../../src/tracking-buffer/writable-tracking-buffer';
 import { writeToTrackingBuffer as writeAllHeaders } from '../../src/all-headers';
 
-describe('all headers test', function() {
+describe('All Headers', function() {
   it('should write headers', function() {
     const expected = Buffer.from([
       0x16,

test/unit/connector-test.ts

@@ -125,7 +125,7 @@ describe('connectInSequence', function() {
     assert.strictEqual(attemptedConnections[2].localAddress, '192.168.0.1');
   });
 
-  it('passes the first succesfully connected socket to the callback', async function() {
+  it('passes the first successfully connected socket to the callback', async function() {
     const controller = new AbortController();
 
     let expectedSocket: any;
@@ -222,7 +222,7 @@ describe('connectInSequence', function() {
     assert.strictEqual(error.errors[2].message, 'failed connection #3');
   });
 
-  it('destroys all sockets except for the first succesfully connected socket', async function() {
+  it('destroys all sockets except for the first successfully connected socket', async function() {
     const controller = new AbortController();
     const attemptedSockets: any[] = [];
 
@@ -411,7 +411,7 @@ describe('connectInParallel', function() {
     assert.strictEqual(error.errors[2].message, 'failed connection #3');
   });
 
-  it('passes the first succesfully connected socket to the callback', async function() {
+  it('passes the first successfully connected socket to the callback', async function() {
     const controller = new AbortController();
 
     let expectedSocket: any;
@@ -439,7 +439,7 @@ describe('connectInParallel', function() {
     assert.strictEqual(expectedSocket, socket);
   });
 
-  it('destroys all sockets except for the first succesfully connected socket', async function() {
+  it('destroys all sockets except for the first successfully connected socket', async function() {
     const controller = new AbortController();
     const attemptedSockets: any[] = [];
 

test/unit/debug-test.ts

@@ -16,8 +16,8 @@ class MockPacket {
   }
 }
 
-describe('Packet Tests', function() {
-  it('Create new packet', function(done) {
+describe('Debug', function() {
+  it('should emit debug events when sending a packet', function(done) {
     let emitCount = 0;
 
     const debug = new Debug({ packet: true });
@@ -52,7 +52,7 @@ describe('Packet Tests', function() {
     });
   });
 
-  it('should not enable payload', function(done) {
+  it('should not emit payload debug events when disabled', function(done) {
     const debug = new Debug();
     debug.on('debug', function() {
       assert.fail('Expected no debug event to be emitted');
@@ -74,7 +74,7 @@ describe('Packet Tests', function() {
     debug.data(new MockPacket() as Packet);
   });
 
-  it('should not enable data', function(done) {
+  it('should not emit data debug events when disabled', function(done) {
     const debug = new Debug();
     debug.on('debug', function() {
       assert.fail('Expected no debug event to be emitted');
@@ -96,7 +96,7 @@ describe('Packet Tests', function() {
     debug.token({ name: 'test' } as Token);
   });
 
-  it('should not enable payload', function(done) {
+  it('should not emit token debug events when disabled', function(done) {
     const debug = new Debug();
     debug.on('debug', function() {
       assert.fail('Expected no debug event to be emitted');

test/unit/incoming-message-stream-test.ts

@@ -107,7 +107,7 @@ describe('IncomingMessageStream', function() {
     });
   });
 
-  it('correctly handles the last package coming in after the stream was paused', function(done) {
+  it('correctly handles the last packet coming in after the stream was paused', function(done) {
     const packetData = Buffer.from('test1234');
     const packetHeader = Buffer.alloc(8);
 

test/unit/instance-lookup-test.ts

@@ -314,30 +314,30 @@ describe('InstanceLookup', function() {
 });
 
 describe('parseBrowserResponse', function() {
-  it('oneInstanceFound', function() {
+  it('should find port when one instance matches', function() {
     const response =
       'ServerName;WINDOWS2;InstanceName;SQLEXPRESS;IsClustered;No;Version;10.50.2500.0;tcp;1433;;';
 
     assert.strictEqual(parseBrowserResponse(response, 'sqlexpress'), 1433);
   });
 
-  it('twoInstancesFoundInFirst', function() {
+  it('should find port in first instance when two instances exist', function() {
     const response =
       'ServerName;WINDOWS2;InstanceName;SQLEXPRESS;IsClustered;No;Version;10.50.2500.0;tcp;1433;;' +
       'ServerName;WINDOWS2;InstanceName;XXXXXXXXXX;IsClustered;No;Version;10.50.2500.0;tcp;0;;';
 
     assert.strictEqual(parseBrowserResponse(response, 'sqlexpress'), 1433);
   });
 
-  it('twoInstancesFoundInSecond', function() {
+  it('should find port in second instance when two instances exist', function() {
     const response =
       'ServerName;WINDOWS2;InstanceName;XXXXXXXXXX;IsClustered;No;Version;10.50.2500.0;tcp;0;;' +
       'ServerName;WINDOWS2;InstanceName;SQLEXPRESS;IsClustered;No;Version;10.50.2500.0;tcp;1433;;';
 
     assert.strictEqual(parseBrowserResponse(response, 'sqlexpress'), 1433);
   });
 
-  it('twoInstancesNotFound', function() {
+  it('should return undefined when no instance matches', function() {
     const response =
       'ServerName;WINDOWS2;InstanceName;XXXXXXXXXX;IsClustered;No;Version;10.50.2500.0;tcp;0;;' +
       'ServerName;WINDOWS2;InstanceName;YYYYYYYYYY;IsClustered;No;Version;10.50.2500.0;tcp;0;;';

test/unit/ntlm-payload-test.ts

@@ -11,7 +11,7 @@ const challenge = {
   }
 };
 
-describe('ntlm payload test', function() {
+describe('NTLMPayload', function() {
   it('should respond to challenge', function() {
 
     const response = new NTLMPayload(challenge);

test/unit/packet-test.ts

@@ -98,7 +98,7 @@ describe('packet type tests', function() {
     assert.strictEqual(packet.dataToString('--'), expectedText);
   });
 
-  it('should data with exact lines worth', function() {
+  it('should convert data to string with exactly one line of data', function() {
     const dataLine1a = Buffer.from([0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07]);
     const dataLine1b = Buffer.from([0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f]);
     const dataLine2a = Buffer.from([0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17]);
@@ -118,7 +118,7 @@ describe('packet type tests', function() {
     assert.strictEqual(packet.dataToString('--'), expectedText);
   });
 
-  it('should convert data to strings in mulitple lines', function() {
+  it('should convert data to strings in multiple lines', function() {
     const dataLine1a = Buffer.from([0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07]);
     const dataLine1b = Buffer.from([0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f]);
     const dataLine2a = Buffer.from([0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17]);
@@ -146,18 +146,18 @@ describe('packet type tests', function() {
     assert.strictEqual(packet.dataToString('--'), expectedText);
   });
 
-  it('should packet complete shorter than header', function() {
+  it('should report incomplete when buffer is shorter than header', function() {
     const buffer = Buffer.alloc(7);
     assert.isFalse(isPacketComplete(buffer));
   });
 
-  it('should packet complete with just header', function() {
+  it('should report complete when buffer contains only header', function() {
     const buffer = new Packet(TYPE.PRELOGIN).buffer;
 
     assert.isTrue(isPacketComplete(buffer));
   });
 
-  it('should not packet complete too short', function() {
+  it('should report incomplete when buffer is shorter than declared length', function() {
     const buffer = Buffer.from([
       0x00,
       0x00,
@@ -174,7 +174,7 @@ describe('packet type tests', function() {
     assert.isFalse(isPacketComplete(buffer));
   });
 
-  it('should packet complete long enough', function() {
+  it('should report complete when buffer matches declared length', function() {
     const buffer = Buffer.from([
       0x00,
       0x00,

test/unit/prelogin-payload-test.ts

@@ -21,7 +21,7 @@ function assertPayload(payload: PreloginPayload, encryptionString: string, { maj
   assert.strictEqual(payload.fedAuthRequired, 1);
 }
 
-describe('prelogin-payload-assert', function() {
+describe('PreloginPayload', function() {
   it('should not encrypt', function() {
     const payload = new PreloginPayload();
     assertPayload(payload, 'NOT_SUP', { major: 0, minor: 0, build: 0, subbuild: 0 });