forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathPgServerMock.cs
More file actions
410 lines (347 loc) · 13.5 KB
/
PgServerMock.cs
File metadata and controls
410 lines (347 loc) · 13.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
using System;
using System.Buffers.Binary;
using System.Collections.Generic;
using System.Linq;
using System.Net.Sockets;
using System.Text;
using System.Threading.Tasks;
using Npgsql.BackendMessages;
using Npgsql.Internal;
using Npgsql.Internal.Postgres;
using NUnit.Framework;
namespace Npgsql.Tests.Support;
class PgServerMock : IDisposable
{
static uint BoolOid => PostgresMinimalDatabaseInfo.DefaultTypeCatalog.GetOid(DataTypeNames.Bool).Value;
static uint Int4Oid => PostgresMinimalDatabaseInfo.DefaultTypeCatalog.GetOid(DataTypeNames.Int4).Value;
static uint TextOid => PostgresMinimalDatabaseInfo.DefaultTypeCatalog.GetOid(DataTypeNames.Text).Value;
static readonly Encoding Encoding = NpgsqlWriteBuffer.UTF8Encoding;
readonly NetworkStream _stream;
readonly NpgsqlReadBuffer _readBuffer;
readonly NpgsqlWriteBuffer _writeBuffer;
bool _disposed;
const int BackendSecret = 12345;
internal int ProcessId { get; }
internal NpgsqlReadBuffer ReadBuffer => _readBuffer;
internal NpgsqlWriteBuffer WriteBuffer => _writeBuffer;
internal PgServerMock(
NetworkStream stream,
NpgsqlReadBuffer readBuffer,
NpgsqlWriteBuffer writeBuffer,
int processId)
{
ProcessId = processId;
_stream = stream;
_readBuffer = readBuffer;
_writeBuffer = writeBuffer;
writeBuffer.MessageLengthValidation = false;
}
internal async Task Startup(MockState state)
{
// Read and skip the startup message
await SkipMessage();
WriteAuthenticateOk();
var parameters = new Dictionary<string, string>
{
{ "server_version", "14" },
{ "server_encoding", "UTF8" },
{ "client_encoding", "UTF8" },
{ "application_name", "Mock" },
{ "is_superuser", "on" },
{ "session_authorization", "foo" },
{ "DateStyle", "ISO, MDY" },
{ "IntervalStyle", "postgres" },
{ "TimeZone", "UTC" },
{ "integer_datetimes", "on" },
{ "standard_conforming_strings", "on" }
};
// While PostgreSQL 14 always sends default_transaction_read_only and in_hot_standby, we only send them if requested
// To minimize potential issues for tests not requiring multiple hosts
if (state != MockState.MultipleHostsDisabled)
{
parameters["default_transaction_read_only"] = state == MockState.Primary ? "off" : "on";
parameters["in_hot_standby"] = state == MockState.Standby ? "on" : "off";
}
WriteParameterStatuses(parameters);
WriteBackendKeyData(ProcessId, BackendSecret);
WriteReadyForQuery();
await FlushAsync();
}
internal async Task FailedStartup(string errorCode)
{
// Read and skip the startup message
await SkipMessage();
WriteErrorResponse(errorCode);
await FlushAsync();
}
internal Task SendMockState(MockState state)
{
var isStandby = state == MockState.Standby;
var transactionReadOnly = state == MockState.Standby || state == MockState.PrimaryReadOnly
? "on"
: "off";
return WriteParseComplete()
.WriteBindComplete()
.WriteRowDescription(new FieldDescription(BoolOid))
.WriteDataRow(BitConverter.GetBytes(isStandby))
.WriteCommandComplete()
.WriteParseComplete()
.WriteBindComplete()
.WriteRowDescription(new FieldDescription(TextOid))
.WriteDataRow(Encoding.ASCII.GetBytes(transactionReadOnly))
.WriteCommandComplete()
.WriteReadyForQuery()
.FlushAsync();
}
internal async Task SkipMessage()
{
await _readBuffer.EnsureAsync(4);
var len = _readBuffer.ReadInt32();
await _readBuffer.EnsureAsync(len - 4);
_readBuffer.Skip(len - 4);
}
internal async Task ExpectMessage(byte expectedCode)
{
CheckDisposed();
await _readBuffer.EnsureAsync(5);
var actualCode = _readBuffer.ReadByte();
Assert.That(actualCode, Is.EqualTo(expectedCode),
$"Expected message of type '{(char)expectedCode}' but got '{(char)actualCode}'");
var len = _readBuffer.ReadInt32();
_readBuffer.Skip(len - 4);
}
internal Task ExpectExtendedQuery()
=> ExpectMessages(
FrontendMessageCode.Parse,
FrontendMessageCode.Bind,
FrontendMessageCode.Describe,
FrontendMessageCode.Execute,
FrontendMessageCode.Sync);
internal async Task ExpectMessages(params byte[] expectedCodes)
{
foreach (var expectedCode in expectedCodes)
await ExpectMessage(expectedCode);
}
internal async Task ExpectSimpleQuery(string expectedSql)
{
CheckDisposed();
await _readBuffer.EnsureAsync(5);
var actualCode = _readBuffer.ReadByte();
Assert.That(actualCode, Is.EqualTo(FrontendMessageCode.Query), $"Expected message of type Query but got '{(char)actualCode}'");
_ = _readBuffer.ReadInt32();
var actualSql = _readBuffer.ReadNullTerminatedString();
Assert.That(actualSql, Is.EqualTo(expectedSql));
}
internal Task WaitForData() => _readBuffer.EnsureAsync(1).AsTask();
internal Task FlushAsync()
{
CheckDisposed();
return _writeBuffer.Flush(async: true);
}
internal Task WriteScalarResponseAndFlush(int value)
=> WriteParseComplete()
.WriteBindComplete()
.WriteRowDescription(new FieldDescription(Int4Oid))
.WriteDataRow(BitConverter.GetBytes(BinaryPrimitives.ReverseEndianness(value)))
.WriteCommandComplete()
.WriteReadyForQuery()
.FlushAsync();
internal Task WriteScalarResponseAndFlush(bool value)
=> WriteParseComplete()
.WriteBindComplete()
.WriteRowDescription(new FieldDescription(BoolOid))
.WriteDataRow(BitConverter.GetBytes(value))
.WriteCommandComplete()
.WriteReadyForQuery()
.FlushAsync();
internal Task WriteScalarResponseAndFlush(string value)
=> WriteParseComplete()
.WriteBindComplete()
.WriteRowDescription(new FieldDescription(TextOid))
.WriteDataRow(Encoding.ASCII.GetBytes(value))
.WriteCommandComplete()
.WriteReadyForQuery()
.FlushAsync();
internal void Close() => _stream.Close();
#region Low-level message writing
internal PgServerMock WriteParseComplete()
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.ParseComplete);
_writeBuffer.WriteInt32(4);
return this;
}
internal PgServerMock WriteBindComplete()
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.BindComplete);
_writeBuffer.WriteInt32(4);
return this;
}
internal PgServerMock WriteRowDescription(params FieldDescription[] fields)
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.RowDescription);
_writeBuffer.WriteInt32(4 + 2 + fields.Sum(f => Encoding.GetByteCount(f.Name) + 1 + 18));
_writeBuffer.WriteInt16((short)fields.Length);
foreach (var field in fields)
{
_writeBuffer.WriteNullTerminatedString(field.Name);
_writeBuffer.WriteUInt32(field.TableOID);
_writeBuffer.WriteInt16(field.ColumnAttributeNumber);
_writeBuffer.WriteUInt32(field.TypeOID);
_writeBuffer.WriteInt16(field.TypeSize);
_writeBuffer.WriteInt32(field.TypeModifier);
_writeBuffer.WriteInt16(field.DataFormat.ToFormatCode());
}
return this;
}
internal PgServerMock WriteParameterDescription(params FieldDescription[] fields)
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.ParameterDescription);
_writeBuffer.WriteInt32(1 + 4 + 2 + fields.Length * 4);
_writeBuffer.WriteUInt16((ushort)fields.Length);
foreach (var field in fields)
_writeBuffer.WriteUInt32(field.TypeOID);
return this;
}
internal PgServerMock WriteNoData()
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.NoData);
_writeBuffer.WriteInt32(4);
return this;
}
internal PgServerMock WriteEmptyQueryResponse()
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.EmptyQueryResponse);
_writeBuffer.WriteInt32(4);
return this;
}
internal PgServerMock WriteDataRow(params byte[][] columnValues)
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.DataRow);
_writeBuffer.WriteInt32(4 + 2 + columnValues.Sum(v => 4 + v.Length));
_writeBuffer.WriteInt16((short)columnValues.Length);
foreach (var field in columnValues)
{
_writeBuffer.WriteInt32(field.Length);
_writeBuffer.WriteBytes(field);
}
return this;
}
/// <summary>
/// Writes the bytes to the buffer and flushes <b>only</b> when the buffer is full
/// </summary>
internal async Task WriteDataRowWithFlush(params byte[][] columnValues)
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.DataRow);
_writeBuffer.WriteInt32(4 + 2 + columnValues.Sum(v => 4 + v.Length));
_writeBuffer.WriteInt16((short)columnValues.Length);
foreach (var field in columnValues)
{
_writeBuffer.WriteInt32(field.Length);
await _writeBuffer.WriteBytesRaw(field, true);
}
}
internal PgServerMock WriteCommandComplete(string tag = "")
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.CommandComplete);
_writeBuffer.WriteInt32(4 + Encoding.GetByteCount(tag) + 1);
_writeBuffer.WriteNullTerminatedString(tag);
return this;
}
internal PgServerMock WriteReadyForQuery(TransactionStatus transactionStatus = TransactionStatus.Idle)
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.ReadyForQuery);
_writeBuffer.WriteInt32(4 + 1);
_writeBuffer.WriteByte((byte)transactionStatus);
return this;
}
internal PgServerMock WriteAuthenticateOk()
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.AuthenticationRequest);
_writeBuffer.WriteInt32(4 + 4);
_writeBuffer.WriteInt32(0);
return this;
}
internal PgServerMock WriteParameterStatuses(Dictionary<string, string> parameters)
{
foreach (var kv in parameters)
WriteParameterStatus(kv.Key, kv.Value);
return this;
}
internal PgServerMock WriteParameterStatus(string name, string value)
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.ParameterStatus);
_writeBuffer.WriteInt32(4 + Encoding.GetByteCount(name) + 1 + Encoding.GetByteCount(value) + 1);
_writeBuffer.WriteNullTerminatedString(name);
_writeBuffer.WriteNullTerminatedString(value);
return this;
}
internal PgServerMock WriteBackendKeyData(int processId, int secret)
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.BackendKeyData);
_writeBuffer.WriteInt32(4 + 4 + 4);
_writeBuffer.WriteInt32(processId);
_writeBuffer.WriteInt32(secret);
return this;
}
internal PgServerMock WriteCancellationResponse()
=> WriteErrorResponse(PostgresErrorCodes.QueryCanceled, "Cancellation", "Query cancelled");
internal PgServerMock WriteCopyInResponse(bool isBinary = false)
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.CopyInResponse);
_writeBuffer.WriteInt32(5);
_writeBuffer.WriteByte(isBinary ? (byte)1 : (byte)0);
_writeBuffer.WriteInt16(1);
_writeBuffer.WriteInt16(0);
return this;
}
internal PgServerMock WriteErrorResponse(string code)
=> WriteErrorResponse(code, "ERROR", "MOCK ERROR MESSAGE");
internal PgServerMock WriteErrorResponse(string code, string severity, string message)
{
CheckDisposed();
_writeBuffer.WriteByte((byte)BackendMessageCode.ErrorResponse);
_writeBuffer.WriteInt32(
4 +
1 + Encoding.GetByteCount(code) +
1 + Encoding.GetByteCount(severity) +
1 + Encoding.GetByteCount(message) +
1);
_writeBuffer.WriteByte((byte)ErrorOrNoticeMessage.ErrorFieldTypeCode.Code);
_writeBuffer.WriteNullTerminatedString(code);
_writeBuffer.WriteByte((byte)ErrorOrNoticeMessage.ErrorFieldTypeCode.Severity);
_writeBuffer.WriteNullTerminatedString(severity);
_writeBuffer.WriteByte((byte)ErrorOrNoticeMessage.ErrorFieldTypeCode.Message);
_writeBuffer.WriteNullTerminatedString(message);
_writeBuffer.WriteByte((byte)ErrorOrNoticeMessage.ErrorFieldTypeCode.Done);
return this;
}
#endregion Low-level message writing
void CheckDisposed()
{
if (_stream is null)
throw new ObjectDisposedException(nameof(PgServerMock));
}
public void Dispose()
{
if (_disposed)
return;
_readBuffer.Dispose();
_writeBuffer.Dispose();
_stream.Dispose();
_disposed = true;
}
}