forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathArrayTests.cs
More file actions
415 lines (362 loc) · 19.4 KB
/
ArrayTests.cs
File metadata and controls
415 lines (362 loc) · 19.4 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
411
412
413
414
415
using System;
using System.Collections;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Data;
using System.Text;
using System.Threading.Tasks;
using Npgsql.Internal.Converters;
using NpgsqlTypes;
using NUnit.Framework;
using static Npgsql.Tests.TestUtil;
namespace Npgsql.Tests.Types;
// ReSharper disable BitwiseOperatorOnEnumWithoutFlags
/// <summary>
/// Tests on PostgreSQL arrays
/// </summary>
/// <remarks>
/// https://www.postgresql.org/docs/current/static/arrays.html
/// </remarks>
public class ArrayTests(MultiplexingMode multiplexingMode) : MultiplexingTestBase(multiplexingMode)
{
static readonly TestCaseData[] ArrayTestCases =
[
new TestCaseData(new[] { 1, 2, 3 }, "{1,2,3}", "integer[]")
.SetName("Integer_array"),
new TestCaseData(Array.Empty<int>(), "{}", "integer[]")
.SetName("Empty_array"),
new TestCaseData(new[,] { { 1, 2, 3 }, { 7, 8, 9 } }, "{{1,2,3},{7,8,9}}", "integer[]")
.SetName("Two_dimensional_array"),
new TestCaseData(new[] { [1, 2], new byte[] { 3, 4 } }, """{"\\x0102","\\x0304"}""", "bytea[]")
.SetName("Bytea_array")
];
[Test, TestCaseSource(nameof(ArrayTestCases))]
public Task Arrays<T>(T array, string sqlLiteral, string pgTypeName)
=> AssertType(array, sqlLiteral, pgTypeName);
[Test]
public async Task NullableInts()
{
var connectionStringBuilder = new NpgsqlConnectionStringBuilder(ConnectionString)
{
ArrayNullabilityMode = ArrayNullabilityMode.Always
};
var dataSourceBuilder = new NpgsqlDataSourceBuilder(connectionStringBuilder.ToString());
await using var dataSource = dataSourceBuilder.Build();
await AssertType(dataSource, new int?[] { 1, 2, null, 3 }, "{1,2,NULL,3}", "integer[]");
}
[Test, Description("Checks that PG arrays containing nulls can't be read as CLR arrays of non-nullable value types (the default).")]
public async Task Nullable_ints_cannot_be_read_as_non_nullable()
=> await AssertTypeUnsupportedRead<InvalidOperationException>("{1,NULL,2}", "int[]");
[Test]
public async Task Throws_too_many_dimensions()
{
await using var conn = CreateConnection();
await conn.OpenAsync();
await using var cmd = new NpgsqlCommand("SELECT 1", conn);
cmd.Parameters.AddWithValue("p", new int[1, 1, 1, 1, 1, 1, 1, 1, 1]); // 9 dimensions
Assert.That(
() => cmd.ExecuteScalarAsync(),
Throws.Exception.TypeOf<ArgumentException>().With.Message.EqualTo("Postgres arrays can have at most 8 dimensions. (Parameter 'values')"));
}
[Test, Description("Checks that PG arrays containing nulls are returned as set via ValueTypeArrayMode.")]
[TestCase(ArrayNullabilityMode.Always)]
[TestCase(ArrayNullabilityMode.Never)]
[TestCase(ArrayNullabilityMode.PerInstance)]
public async Task Value_type_array_nullabilities(ArrayNullabilityMode mode)
{
await using var dataSource = CreateDataSource(csb => csb.ArrayNullabilityMode = mode);
await using var conn = await dataSource.OpenConnectionAsync();
await using var cmd = new NpgsqlCommand(
"""
SELECT onedim, twodim FROM (VALUES
('{1, 2, 3, 4}'::int[],'{{1, 2},{3, 4}}'::int[][]),
('{5, NULL, 6, 7}'::int[],'{{5, NULL},{6, 7}}'::int[][])) AS x(onedim,twodim)
""", conn);
await using var reader = await cmd.ExecuteReaderAsync();
switch (mode)
{
case ArrayNullabilityMode.Never:
reader.Read();
var value = reader.GetValue(0);
Assert.That(reader.GetFieldType(0), Is.EqualTo(typeof(Array)));
Assert.That(value.GetType(), Is.EqualTo(typeof(int[])));
Assert.That(value, Is.EqualTo(new []{1, 2, 3, 4}));
Assert.That(reader.GetFieldType(1), Is.EqualTo(typeof(Array)));
Assert.That(reader.GetValue(1).GetType(), Is.EqualTo(typeof(int[,])));
Assert.That(reader.GetValue(1), Is.EqualTo(new [,]{{1, 2}, {3, 4}}));
reader.Read();
Assert.That(reader.GetFieldType(0), Is.EqualTo(typeof(Array)));
Assert.That(() => reader.GetValue(0), Throws.Exception.TypeOf<InvalidCastException>());
Assert.That(reader.GetFieldType(1), Is.EqualTo(typeof(Array)));
Assert.That(() => reader.GetValue(1), Throws.Exception.TypeOf<InvalidCastException>());
break;
case ArrayNullabilityMode.Always:
reader.Read();
value = reader.GetValue(0);
Assert.That(reader.GetFieldType(0), Is.EqualTo(typeof(Array)));
Assert.That(value.GetType(), Is.EqualTo(typeof(int?[])));
Assert.That(value, Is.EqualTo(new int?[]{1, 2, 3, 4}));
value = reader.GetValue(1);
Assert.That(reader.GetFieldType(1), Is.EqualTo(typeof(Array)));
Assert.That(value.GetType(), Is.EqualTo(typeof(int?[,])));
Assert.That(value, Is.EqualTo(new int?[,]{{1, 2}, {3, 4}}));
reader.Read();
value = reader.GetValue(0);
Assert.That(reader.GetFieldType(0), Is.EqualTo(typeof(Array)));
Assert.That(value.GetType(), Is.EqualTo(typeof(int?[])));
Assert.That(value, Is.EqualTo(new int?[]{5, null, 6, 7}));
value = reader.GetValue(1);
Assert.That(reader.GetFieldType(1), Is.EqualTo(typeof(Array)));
Assert.That(value.GetType(), Is.EqualTo(typeof(int?[,])));
Assert.That(value, Is.EqualTo(new int?[,]{{5, null},{6, 7}}));
break;
case ArrayNullabilityMode.PerInstance:
reader.Read();
value = reader.GetValue(0);
Assert.That(reader.GetFieldType(0), Is.EqualTo(typeof(Array)));
Assert.That(value.GetType(), Is.EqualTo(typeof(int[])));
Assert.That(value, Is.EqualTo(new []{1, 2, 3, 4}));
value = reader.GetValue(1);
Assert.That(reader.GetFieldType(1), Is.EqualTo(typeof(Array)));
Assert.That(value.GetType(), Is.EqualTo(typeof(int[,])));
Assert.That(value, Is.EqualTo(new [,]{{1, 2}, {3, 4}}));
reader.Read();
value = reader.GetValue(0);
Assert.That(reader.GetFieldType(0), Is.EqualTo(typeof(Array)));
Assert.That(value.GetType(), Is.EqualTo(typeof(int?[])));
Assert.That(value, Is.EqualTo(new int?[]{5, null, 6, 7}));
value = reader.GetValue(1);
Assert.That(reader.GetFieldType(1), Is.EqualTo(typeof(Array)));
Assert.That(value.GetType(), Is.EqualTo(typeof(int?[,])));
Assert.That(value, Is.EqualTo(new int?[,]{{5, null},{6, 7}}));
break;
default:
throw new ArgumentOutOfRangeException(nameof(mode), mode, null);
}
}
// Note that PG normalizes empty multidimensional arrays to single-dimensional, e.g. ARRAY[[], []]::integer[] returns {}.
[Test]
public async Task Write_empty_multidimensional_array()
=> await AssertTypeWrite(new int[0, 0], "{}", "integer[]");
[Test]
public async Task Generic_List()
=> await AssertType(
new List<int> { 1, 2, 3 }, "{1,2,3}", "integer[]", isDefaultForReading: false);
[Test]
public async Task Write_IList_implementation()
=> await AssertTypeWrite(
ImmutableArray.Create(1, 2, 3), "{1,2,3}", "integer[]");
[Test]
public void Read_IList_implementation_throws()
=> Assert.ThrowsAsync<InvalidCastException>(() =>
AssertTypeRead("{1,2,3}", "integer[]", ImmutableArray.Create(1, 2, 3), isDefault: false));
[Test]
public async Task Generic_IList()
{
await using var conn = await OpenConnectionAsync();
await using var cmd = new NpgsqlCommand("SELECT @p1", conn);
var expected = ImmutableArray.Create(1,2,3);
cmd.Parameters.Add(new NpgsqlParameter<IList<int>>("p1", NpgsqlDbType.Array | NpgsqlDbType.Integer) { TypedValue = expected });
var reader = await cmd.ExecuteReaderAsync();
reader.Read();
Assert.That(reader.GetFieldValue<int[]>(0), Is.EqualTo(expected));
}
[Test, Description("Verifies that an InvalidOperationException is thrown when the returned array has a different number of dimensions from what was requested.")]
public async Task Wrong_array_dimensions_throws()
{
await using var conn = await OpenConnectionAsync();
await using var cmd = new NpgsqlCommand("SELECT ARRAY[[1], [2]]", conn);
var reader = await cmd.ExecuteReaderAsync();
reader.Read();
var ex = Assert.Throws<InvalidCastException>(() => reader.GetFieldValue<int[]>(0))!;
Assert.That(ex.Message, Does.StartWith("Cannot read an array value with 2 dimensions into a collection type with 1 dimension"));
}
[Test, Description("Verifies that an attempt to read an Array of value types that contains null values as array of a non-nullable type fails.")]
public async Task Read_null_as_non_nullable_array_throws()
{
await using var conn = await OpenConnectionAsync();
await using var cmd = new NpgsqlCommand("SELECT @p1", conn);
var expected = new int?[] { 1, 5, null, 9 };
cmd.Parameters.AddWithValue("p1", NpgsqlDbType.Array | NpgsqlDbType.Integer, expected);
var reader = await cmd.ExecuteReaderAsync();
reader.Read();
Assert.That(
() => reader.GetFieldValue<int[]>(0),
Throws.Exception.TypeOf<InvalidCastException>()
.With.Message.EqualTo(PgArrayConverter.ReadNonNullableCollectionWithNullsExceptionMessage));
}
[Test, Description("Verifies that an attempt to read an Array of value types that contains null values as List of a non-nullable type fails.")]
public async Task Read_null_as_non_nullable_list_throws()
{
await using var conn = await OpenConnectionAsync();
await using var cmd = new NpgsqlCommand("SELECT @p1", conn);
var expected = new int?[] { 1, 5, null, 9 };
cmd.Parameters.AddWithValue("p1", NpgsqlDbType.Array | NpgsqlDbType.Integer, expected);
var reader = await cmd.ExecuteReaderAsync();
reader.Read();
Assert.That(
() => reader.GetFieldValue<List<int>>(0),
Throws.Exception.TypeOf<InvalidCastException>()
.With.Message.EqualTo(PgArrayConverter.ReadNonNullableCollectionWithNullsExceptionMessage));
}
[Test, Description("Roundtrips a large, one-dimensional array of ints that will be chunked")]
public async Task Long_one_dimensional()
{
await using var conn = await OpenConnectionAsync();
var expected = new int[conn.Settings.WriteBufferSize/4 + 100];
for (var i = 0; i < expected.Length; i++)
expected[i] = i;
await using var cmd = new NpgsqlCommand("SELECT @p", conn);
var p = new NpgsqlParameter {ParameterName = "p", Value = expected};
cmd.Parameters.Add(p);
await using var reader = await cmd.ExecuteReaderAsync(CommandBehavior.SequentialAccess);
reader.Read();
Assert.That(reader[0], Is.EqualTo(expected));
}
[Test, Description("Roundtrips a large, two-dimensional array of ints that will be chunked")]
public async Task Long_two_dimensional()
{
await using var conn = await OpenConnectionAsync();
var len = conn.Settings.WriteBufferSize/2 + 100;
var expected = new int[2, len];
for (var i = 0; i < len; i++)
expected[0, i] = i;
for (var i = 0; i < len; i++)
expected[1, i] = i;
await using var cmd = new NpgsqlCommand("SELECT @p", conn);
var p = new NpgsqlParameter {ParameterName = "p", Value = expected};
cmd.Parameters.Add(p);
await using var reader = await cmd.ExecuteReaderAsync(CommandBehavior.SequentialAccess);
reader.Read();
Assert.That(reader[0], Is.EqualTo(expected));
}
[Test, Description("Reads an one-dimensional array with lower bound != 0")]
public Task Read_non_zero_lower_bounded()
=> AssertTypeRead("[2:3]={ 8, 9 }", "integer[]", new[] { 8, 9 });
[Test, Description("Reads an one-dimensional array with lower bound != 0")]
public Task Read_non_zero_lower_bounded_multidimensional()
=> AssertTypeRead("[2:3][2:3]={ {8,9}, {1,2} }", "integer[]", new[,] { { 8, 9 }, { 1, 2 }});
[Test, Description("Roundtrips a long, one-dimensional array of strings, including a null")]
public async Task Strings_with_null()
{
await using var conn = await OpenConnectionAsync();
var largeString = new StringBuilder();
largeString.Append('a', conn.Settings.WriteBufferSize);
var expected = new[] {"value1", null, largeString.ToString(), "val3"};
await using var cmd = new NpgsqlCommand("SELECT @p", conn);
var p = new NpgsqlParameter("p", NpgsqlDbType.Array | NpgsqlDbType.Text) {Value = expected};
cmd.Parameters.Add(p);
await using var reader = await cmd.ExecuteReaderAsync(CommandBehavior.SequentialAccess);
reader.Read();
Assert.That(reader.GetFieldValue<string[]>(0), Is.EqualTo(expected));
}
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/844")]
public async Task Writing_IEnumerable_is_not_supported()
{
await using var conn = await OpenConnectionAsync();
await using var cmd = new NpgsqlCommand("SELECT @p1", conn);
cmd.Parameters.AddWithValue("p1", new EnumerableOnly<int>());
Assert.That(async () => await cmd.ExecuteScalarAsync(), Throws.Exception.TypeOf<InvalidCastException>().With.Property("InnerException").Message.Contains("array or some implementation of IList<T>"));
}
class EnumerableOnly<T> : IEnumerable<T>
{
public IEnumerator<T> GetEnumerator() => throw new NotImplementedException();
IEnumerator IEnumerable.GetEnumerator() => GetEnumerator();
}
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/960")]
public async Task Jagged_arrays_not_supported()
{
await using var conn = await OpenConnectionAsync();
await using var cmd = new NpgsqlCommand("SELECT @p1", conn);
cmd.Parameters.AddWithValue("p1", NpgsqlDbType.Array | NpgsqlDbType.Integer, new[] { [8], new[] { 8, 10 } });
Assert.That(async () => await cmd.ExecuteNonQueryAsync(), Throws.Exception
.TypeOf<InvalidCastException>()
.With.Property("InnerException").Message.Contains("jagged"));
}
[Test, Description("Roundtrips one-dimensional and two-dimensional arrays of a PostgreSQL domain.")]
public async Task Array_of_domain()
{
if (IsMultiplexing)
Assert.Ignore("Multiplexing, ReloadTypes");
await using var conn = await OpenConnectionAsync();
MinimumPgVersion(conn, "11.0", "Arrays of domains were introduced in PostgreSQL 11");
await conn.ExecuteNonQueryAsync("CREATE DOMAIN pg_temp.posint AS integer CHECK (VALUE > 0);");
await conn.ReloadTypesAsync();
await using var cmd = new NpgsqlCommand("SELECT @p1::posint[], @p2::posint[][]", conn);
var oneDim = new[] { 1, 3, 5, 9 };
var twoDim = new[,] { { 1, 3 }, { 5, 9 } };
cmd.Parameters.AddWithValue("p1", NpgsqlDbType.Integer | NpgsqlDbType.Array, oneDim);
cmd.Parameters.AddWithValue("p2", NpgsqlDbType.Integer | NpgsqlDbType.Array, twoDim);
await using var reader = cmd.ExecuteReader();
reader.Read();
Assert.That(reader.GetValue(0), Is.EqualTo(oneDim));
Assert.That(reader.GetProviderSpecificValue(0), Is.EqualTo(oneDim));
Assert.That(reader.GetFieldValue<int[]>(0), Is.EqualTo(oneDim));
Assert.That(reader.GetFieldValue<int[]>(0), Is.EqualTo(oneDim));
Assert.That(reader.GetFieldType(0), Is.EqualTo(typeof(Array)));
Assert.That(reader.GetProviderSpecificFieldType(0), Is.EqualTo(typeof(Array)));
Assert.That(reader.GetValue(1), Is.EqualTo(twoDim));
Assert.That(reader.GetProviderSpecificValue(1), Is.EqualTo(twoDim));
Assert.That(reader.GetFieldValue<int[,]>(1), Is.EqualTo(twoDim));
Assert.That(reader.GetFieldType(1), Is.EqualTo(typeof(Array)));
Assert.That(reader.GetProviderSpecificFieldType(1), Is.EqualTo(typeof(Array)));
}
[Test, Description("Roundtrips a PostgreSQL domain over a one-dimensional and a two-dimensional array.")]
public async Task Domain_of_array()
{
if (IsMultiplexing)
Assert.Ignore("Multiplexing, ReloadTypes");
await using var conn = await OpenConnectionAsync();
MinimumPgVersion(conn, "11.0", "Domains over arrays were introduced in PostgreSQL 11");
await conn.ExecuteNonQueryAsync(
"""
CREATE DOMAIN pg_temp.int_array_1d AS int[] CHECK(array_length(VALUE, 1) = 4);
CREATE DOMAIN pg_temp.int_array_2d AS int[][] CHECK(array_length(VALUE, 2) = 2);
""");
await conn.ReloadTypesAsync();
await using var cmd = new NpgsqlCommand("SELECT @p1::int_array_1d, @p2::int_array_2d", conn);
var oneDim = new[] { 1, 3, 5, 9 };
var twoDim = new[,] { { 1, 3 }, { 5, 9 } };
cmd.Parameters.AddWithValue("p1", NpgsqlDbType.Integer | NpgsqlDbType.Array, oneDim);
cmd.Parameters.AddWithValue("p2", NpgsqlDbType.Integer | NpgsqlDbType.Array, twoDim);
await using var reader = cmd.ExecuteReader();
reader.Read();
Assert.That(reader.GetValue(0), Is.EqualTo(oneDim));
Assert.That(reader.GetProviderSpecificValue(0), Is.EqualTo(oneDim));
Assert.That(reader.GetFieldValue<int[]>(0), Is.EqualTo(oneDim));
Assert.That(reader.GetFieldType(0), Is.EqualTo(typeof(Array)));
Assert.That(reader.GetProviderSpecificFieldType(0), Is.EqualTo(typeof(Array)));
Assert.That(reader.GetValue(1), Is.EqualTo(twoDim));
Assert.That(reader.GetProviderSpecificValue(1), Is.EqualTo(twoDim));
Assert.That(reader.GetFieldValue<int[,]>(1), Is.EqualTo(twoDim));
Assert.That(reader.GetFieldType(1), Is.EqualTo(typeof(Array)));
Assert.That(reader.GetProviderSpecificFieldType(1), Is.EqualTo(typeof(Array)));
}
[Test, IssueLink("https://github.com/npgsql/npgsql/issues/3417")]
public async Task Read_two_empty_arrays()
{
await using var conn = await OpenConnectionAsync();
await using var cmd = new NpgsqlCommand("SELECT '{}'::INT[], '{}'::INT[]", conn);
await using var reader = await cmd.ExecuteReaderAsync();
await reader.ReadAsync();
Assert.That(reader.GetFieldValue<int[]>(1), Is.SameAs(reader.GetFieldValue<int[]>(0)));
// Unlike T[], List<T> is mutable so we should not return the same instance
Assert.That(reader.GetFieldValue<List<int>>(1), Is.Not.SameAs(reader.GetFieldValue<List<int>>(0)));
}
[Test]
public async Task Arrays_not_supported_by_default_on_NpgsqlSlimSourceBuilder()
{
var dataSourceBuilder = new NpgsqlSlimDataSourceBuilder(ConnectionString);
await using var dataSource = dataSourceBuilder.Build();
await AssertTypeUnsupportedRead<int[], InvalidCastException>("{1,2,3}", "integer[]", dataSource);
await AssertTypeUnsupportedWrite<int[], InvalidCastException>([1, 2, 3], "integer[]", dataSource);
}
[Test]
public async Task NpgsqlSlimSourceBuilder_EnableArrays()
{
var dataSourceBuilder = new NpgsqlSlimDataSourceBuilder(ConnectionString);
dataSourceBuilder.EnableArrays();
await using var dataSource = dataSourceBuilder.Build();
await AssertType(dataSource, new[] { 1, 2, 3 }, "{1,2,3}", "integer[]");
}
}