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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
|
#!/usr/bin/env python
# --------------------------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for license information.
# --------------------------------------------------------------------------------------------
import os
import json
import pytest
from breaking_changes_checker.breaking_changes_tracker import BreakingChangesTracker
from breaking_changes_checker.detect_breaking_changes import main
from breaking_changes_checker.checkers.removed_method_overloads_checker import RemovedMethodOverloadChecker
def format_breaking_changes(breaking_changes):
formatted = "\n"
for bc in breaking_changes:
formatted += f"{bc}\n"
formatted += f"\nFound {len(breaking_changes)} breaking changes.\n"
formatted += "\nSee aka.ms/azsdk/breaking-changes-tool to resolve " \
"any reported breaking changes or false positives.\n"
return formatted
EXPECTED = [
"(RemovedOrRenamedInstanceAttribute): Model `Metrics` deleted or renamed its instance variable `retention_policy`",
"(RemovedOrRenamedInstanceAttribute): Client `QueueClient` deleted or renamed instance variable `queue_name`",
"(ChangedParameterKind): Method `QueueClient.from_queue_url` changed its parameter `credential` from `positional_or_keyword` to `keyword_only`",
"(AddedPositionalParam): Method `QueueClient.get_queue_access_policy` inserted a `positional_or_keyword` parameter `queue_name`",
"(RemovedOrRenamedPositionalParam): Method `QueueClient.set_queue_access_policy` deleted or renamed its parameter `signed_identifiers` of kind `positional_or_keyword`",
"(ChangedParameterDefaultValue): Method `QueueClient.set_queue_metadata` parameter `metadata` changed default value from `None` to ``",
"(RemovedOrRenamedClassMethod): Deleted or renamed method `QueueSasPermissions.from_string`",
"(RemovedFunctionKwargs): Method `QueueServiceClient.set_service_properties` changed from accepting keyword arguments to not accepting them",
"(RemovedOrRenamedClientMethod): Deleted or renamed client method `QueueServiceClient.get_service_properties`",
"(RemovedOrRenamedEnumValue): Deleted or renamed enum value `StorageErrorCode.queue_not_found`",
"(RemovedOrRenamedClass): Deleted or renamed model `QueueMessage`",
"(ChangedParameterDefaultValue): Function `generate_queue_sas` parameter `permission` changed default value from `None` to ``",
"(ChangedParameterKind): Function `generate_queue_sas` changed its parameter `ip` from `positional_or_keyword` to `keyword_only`",
"(AddedPositionalParam): Function `generate_queue_sas` inserted a `positional_or_keyword` parameter `conn_str`",
"(RemovedOrRenamedPositionalParam): Function `generate_queue_sas` deleted or renamed its parameter `account_name` of kind `positional_or_keyword`",
"(RemovedOrRenamedModuleLevelFunction): Deleted or renamed function `generate_account_sas`",
"(RemovedParameterDefaultValue): Method `QueueClient.update_message` removed default value `None` from its parameter `pop_receipt`",
"(ChangedFunctionKind): Method `QueueServiceClient.get_service_stats` changed from `asynchronous` to `synchronous`",
"(ChangedParameterOrdering): Method `QueueClient.from_connection_string` re-ordered its parameters from `['conn_str', 'queue_name', 'credential', 'kwargs']` to `['queue_name', 'conn_str', 'credential', 'kwargs']`",
]
def test_multiple_checkers():
with open(os.path.join(os.path.dirname(__file__), "test_stable.json"), "r") as fd:
stable = json.load(fd)
with open(os.path.join(os.path.dirname(__file__), "test_current.json"), "r") as fd:
current = json.load(fd)
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")
bc.run_checks()
changes = bc.report_changes()
expected_msg = format_breaking_changes(EXPECTED)
assert len(bc.breaking_changes) == len(EXPECTED)
assert changes == expected_msg
def test_ignore_checks():
with open(os.path.join(os.path.dirname(__file__), "test_stable.json"), "r") as fd:
stable = json.load(fd)
with open(os.path.join(os.path.dirname(__file__), "test_current.json"), "r") as fd:
current = json.load(fd)
ignore = {
"azure-storage-queue": [
("ChangedParameterOrdering", "*", "QueueClient", "from_connection_string"),
]
}
bc = BreakingChangesTracker(stable, current, "azure-storage-queue", ignore=ignore)
bc.run_checks()
changes = bc.report_changes()
expected_msg = format_breaking_changes(EXPECTED[:-1])
assert len(bc.breaking_changes)+1 == len(EXPECTED)
assert changes == expected_msg
def test_ignore_with_wildcard_checks():
with open(os.path.join(os.path.dirname(__file__), "test_stable.json"), "r") as fd:
stable = json.load(fd)
with open(os.path.join(os.path.dirname(__file__), "test_current.json"), "r") as fd:
current = json.load(fd)
ignore = {
"azure-storage-queue": [
("ChangedParameterOrdering", "*", "*", "from_connection_string"),
("ChangedFunctionKind", "azure.storage.queue.aio", "QueueServiceClient", "get_service_stats"),
]
}
bc = BreakingChangesTracker(stable, current, "azure-storage-queue", ignore=ignore)
bc.run_checks()
changes = bc.report_changes()
expected_msg = format_breaking_changes(EXPECTED[:-2])
assert len(bc.breaking_changes)+2 == len(EXPECTED)
assert changes == expected_msg
def test_replace_all_params():
current = {
"azure.ai.formrecognizer": {
"function_nodes": {
"my_function_name": {
"parameters": {},
"is_async": False
}
},
"class_nodes": {
"class_name": {
"methods": {
"one": {
"parameters": {},
"is_async": True
},
"two": {
"parameters": {},
"is_async": True
},
}
}
}
}
}
stable = {
"azure.ai.formrecognizer": {
"function_nodes": {
"my_function_name": {
"is_async": False,
"parameters": {
"testing": {
"default": None,
"param_type": "positional_or_keyword"
},
"testing2": {
"default": None,
"param_type": "positional_or_keyword"
}
}
}
},
"class_nodes": {
"class_name": {
"methods": {
"one": {
"parameters": {
"testing": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True
},
"two": {
"parameters": {
"testing2": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True
},
}
}
}
}
}
EXPECTED = [
"(RemovedOrRenamedPositionalParam): Method `class_name.one` deleted or renamed its parameter `testing` of kind `positional_or_keyword`",
"(RemovedOrRenamedPositionalParam): Method `class_name.two` deleted or renamed its parameter `testing2` of kind `positional_or_keyword`",
"(RemovedOrRenamedPositionalParam): Function `my_function_name` deleted or renamed its parameter `testing` of kind `positional_or_keyword`",
"(RemovedOrRenamedPositionalParam): Function `my_function_name` deleted or renamed its parameter `testing2` of kind `positional_or_keyword`"
]
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")
bc.run_checks()
changes = bc.report_changes()
expected_msg = format_breaking_changes(EXPECTED)
assert len(bc.breaking_changes) == len(EXPECTED)
assert changes == expected_msg
def test_replace_all_functions():
current = {
"azure.ai.formrecognizer": {
"function_nodes": {},
"class_nodes": {
"class_name": {
"methods": {}
}
}
}
}
stable = {
"azure.ai.formrecognizer": {
"function_nodes": {
"my_function_name": {
"is_async": False,
"parameters": {
"testing": {
"default": None,
"param_type": "positional_or_keyword"
},
"testing2": {
"default": None,
"param_type": "positional_or_keyword"
}
}
},
"my_function_name2": {
"is_async": False,
"parameters": {
"testing": {
"default": None,
"param_type": "positional_or_keyword"
},
"testing2": {
"default": None,
"param_type": "positional_or_keyword"
}
}
},
},
"class_nodes": {
"class_name": {
"methods": {
"one": {
"parameters": {
"testing": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True
},
"two": {
"parameters": {
"testing2": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True
},
}
}
}
}
}
EXPECTED = [
"(RemovedOrRenamedClassMethod): Deleted or renamed method `class_name.one`",
"(RemovedOrRenamedClassMethod): Deleted or renamed method `class_name.two`",
"(RemovedOrRenamedModuleLevelFunction): Deleted or renamed function `my_function_name`",
"(RemovedOrRenamedModuleLevelFunction): Deleted or renamed function `my_function_name2`"
]
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")
bc.run_checks()
changes = bc.report_changes()
expected_msg = format_breaking_changes(EXPECTED)
assert len(bc.breaking_changes) == len(EXPECTED)
assert changes == expected_msg
def test_replace_all_classes():
current = {
"azure.ai.formrecognizer": {
"class_nodes": {}
}
}
stable = {
"azure.ai.formrecognizer": {
"class_nodes": {
"class_name": {
"methods": {
"one": {
"parameters": {
"testing": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True
},
"two": {
"parameters": {
"testing2": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True
},
}
},
"class_name2": {
"methods": {
"one": {
"parameters": {
"testing": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True
},
"two": {
"parameters": {
"testing2": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True
},
}
},
}
}
}
EXPECTED = [
"(RemovedOrRenamedClass): Deleted or renamed model `class_name`",
"(RemovedOrRenamedClass): Deleted or renamed model `class_name2`"
]
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")
bc.run_checks()
changes = bc.report_changes()
expected_msg = format_breaking_changes(EXPECTED)
assert len(bc.breaking_changes) == len(EXPECTED)
assert changes == expected_msg
def test_replace_all_modules():
current = {}
stable = {
"azure.ai.formrecognizer": {
"class_nodes": {}
},
"azure.ai.formrecognizer.aio": {
"class_nodes": {}
},
}
EXPECTED = [
"(RemovedOrRenamedModule): Deleted or renamed module `azure.ai.formrecognizer`",
]
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")
bc.run_checks()
changes = bc.report_changes()
expected_msg = format_breaking_changes(EXPECTED)
assert len(bc.breaking_changes) == len(EXPECTED)
assert changes == expected_msg
@pytest.mark.skip(reason="We need to regenerate the code reports for these tests and update the expected results")
def test_pass_custom_reports_breaking(capsys):
source_report = "test_stable.json"
target_report = "test_current.json"
try:
main(None, None, None, None, "tests", False, False, False, source_report, target_report)
except SystemExit as e:
if e.code == 1:
out, _ = capsys.readouterr()
# Check if we have some breaking changes reported
assert out.endswith("See aka.ms/azsdk/breaking-changes-tool to resolve any reported breaking changes or false positives.\n\n")
else:
pytest.fail("test_compare_reports failed to report breaking changes when passing custom reports")
def test_removed_operation_group():
current = {
"azure.contoso": {
"class_nodes": {
"ContosoClient": {
"methods": {},
"properties": {}
}
},
}
}
stable = {
"azure.contoso": {
"class_nodes": {
"ContosoClient": {
"methods": {},
"properties": {
"foo": {
"attr_type": "FooOperations",
}
}
}
},
}
}
EXPECTED = [
"(RemovedOrRenamedOperationGroup): Deleted or renamed client operation group `ContosoClient.foo`"
]
bc = BreakingChangesTracker(stable, current, "azure-storage-queue")
bc.run_checks()
changes = bc.report_changes()
expected_msg = format_breaking_changes(EXPECTED)
assert len(bc.breaking_changes) == len(EXPECTED)
assert changes == expected_msg
def test_async_breaking_changes_cleanup():
breaking_changes = [
("Message", "RemovedOrRenamedClassMethod", "azure.contoso.aio.operations", "Foo", "foo"),
("Message", "RemovedOrRenamedClassMethod", "azure.contoso.operations", "Foo", "foo"),
("Message", "ChangedParameterOrdering", "azure.contoso", "FooClient", "from_connection_string"),
]
# create dummy BreakingChangesTracker instance
bct = BreakingChangesTracker({}, {}, "azure-contoso")
bct.breaking_changes = breaking_changes
bct.run_async_cleanup(bct.breaking_changes)
assert len(bct.breaking_changes) == 2
assert bct.breaking_changes[0] == ("Message", "RemovedOrRenamedClassMethod", "azure.contoso.operations", "Foo", "foo")
assert bct.breaking_changes[1] == ("Message", "ChangedParameterOrdering", "azure.contoso", "FooClient", "from_connection_string")
def test_removed_overload():
stable = {
"azure.contoso": {
"class_nodes": {
"class_name": {
"methods": {
"one": {
"parameters": {
"testing": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True,
"overloads": [
{
"parameters": {
"testing": {
"type": "Test",
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True,
"return_type": "TestResult"
},
{
"parameters": {
"testing": {
"type": "JSON",
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True,
"return_type": None
}
]
},
"two": {
"parameters": {
"testing2": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True,
"overloads": [
{
"parameters": {
"foo": {
"type": "JSON",
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True,
"return_type": None
}
]
},
}
}
}
}
}
current = {
"azure.contoso": {
"class_nodes": {
"class_name": {
"methods": {
"one": {
"parameters": {
"testing": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True,
"overloads": [
{
"parameters": {
"testing": {
"type": "JSON",
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True,
"return_type": None
}
]
},
"two": {
"parameters": {
"testing2": {
"default": None,
"param_type": "positional_or_keyword"
}
},
"is_async": True,
"overloads": []
},
}
}
}
}
}
EXPECTED = [
"(RemovedMethodOverload): `class_name.one` had an overload `def one(testing: Test) -> TestResult` removed",
"(RemovedMethodOverload): `class_name.two` had all overloads removed"
]
bc = BreakingChangesTracker(stable, current, "azure-contoso", checkers=[RemovedMethodOverloadChecker()])
bc.run_checks()
changes = bc.report_changes()
expected_msg = format_breaking_changes(EXPECTED)
assert len(bc.breaking_changes) == len(EXPECTED)
assert changes == expected_msg
|
