forked from nosami/visualfsharp
/
UnusedOpensTests.fs
856 lines (753 loc) · 17.8 KB
/
UnusedOpensTests.fs
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
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the Apache License, Version 2.0. See License.txt in the project root for license information.
[<NUnit.Framework.TestFixture>]
module Tests.ServiceAnalysis.UnusedOpens
open System
open NUnit.Framework
open FSharp.Compiler.SourceCodeServices
open FSharp.Compiler.Range
/// like "should equal", but validates same-type
let shouldEqual (x: 'a) (y: 'a) = Assert.AreEqual(x, y, sprintf "Expected: %A\nActual: %A" x y)
let private filePath = "C:\\test.fs"
let private projectOptions : FSharpProjectOptions =
{ ProjectFileName = "C:\\test.fsproj"
ProjectId = None
SourceFiles = [| filePath |]
ReferencedProjects = [| |]
OtherOptions = [| |]
IsIncompleteTypeCheckEnvironment = true
UseScriptResolutionRules = false
LoadTime = DateTime.MaxValue
OriginalLoadReferences = []
UnresolvedReferences = None
ExtraProjectInfo = None
Stamp = None }
let private checker = FSharpChecker.Create()
let (=>) (source: string) (expectedRanges: ((*line*)int * ((*start column*)int * (*end column*)int)) list) =
let sourceLines = source.Split ([|"\r\n"; "\n"; "\r"|], StringSplitOptions.None)
let _, checkFileAnswer = checker.ParseAndCheckFileInProject(filePath, 0, FSharp.Compiler.Text.SourceText.ofString source, projectOptions) |> Async.RunSynchronously
let checkFileResults =
match checkFileAnswer with
| FSharpCheckFileAnswer.Aborted -> failwithf "ParseAndCheckFileInProject aborted"
| FSharpCheckFileAnswer.Succeeded(checkFileResults) -> checkFileResults
let unusedOpenRanges = UnusedOpens.getUnusedOpens (checkFileResults, fun lineNum -> sourceLines.[Line.toZ lineNum]) |> Async.RunSynchronously
unusedOpenRanges
|> List.map (fun x -> x.StartLine, (x.StartColumn, x.EndColumn))
|> shouldEqual expectedRanges
[<Test>]
let ``unused open declaration in top level module``() =
"""
module TopModule
open System
open System.IO
let _ = DateTime.Now
"""
=> [ 4, (5, 14) ]
[<Test>]
let ``unused open declaration in namespace``() =
"""
namespace TopNamespace
open System
open System.IO
module Nested =
let _ = DateTime.Now
"""
=> [ 4, (5, 14) ]
[<Test>]
let ``unused open declaration in nested module``() =
"""
namespace TopNamespace
module Nested =
open System
open System.IO
let _ = DateTime.Now
"""
=> [ 5, (9, 18) ]
[<Test>]
let ``unused open declaration due to partially qualified symbol``() =
"""
module TopModule
open System
open System.IO
let _ = IO.File.Create ""
"""
=> [ 4, (5, 14) ]
[<Test>]
let ``unused parent open declaration due to partially qualified symbol``() =
"""
module TopModule
open System
open System.IO
let _ = File.Create ""
"""
=> [ 3, (5, 11) ]
[<Test>]
let ``open statement duplication in parent module is unused``() =
"""
module TopModule
open System.IO
module Nested =
open System.IO
let _ = File.Create ""
"""
=> [ 5, (9, 18) ]
[<Test>]
let ``open statement duplication in parent module is marked as unused even though it seems to be used in its scope``() =
"""
module TopModule
open System.IO
module Nested =
open System.IO
let _ = File.Create ""
let _ = File.Create ""
"""
=> [ 5, (9, 18) ]
[<Test>]
let ``multiple open declaration in the same line``() =
"""
open System.IO; let _ = File.Create "";; open System.IO
"""
=> [ 2, (46, 55) ]
[<Test>]
let ``open a nested module inside another one is not unused``() =
"""
module Top
module M1 =
let x = ()
module M2 =
open M1
let y = x
"""
=> []
[<Test>]
let ``open a nested module inside another one is not unused, complex hierarchy``() =
"""
module Top =
module M1 =
module M11 =
let x = ()
module M2 =
module M22 =
open M1.M11
let y = x
"""
=> []
[<Test>]
let ``open a nested module inside another one is not unused, even more complex hierarchy``() =
"""
module Top =
module M1 =
module M11 =
module M111 =
module M1111 =
let x = ()
module M2 =
module M22 =
open M1.M11.M111.M1111
let y = x
"""
=> []
[<Test>]
let ``opening auto open module after it's parent module was opened should be marked as unused``() =
"""
module NormalModule =
[<AutoOpen>]
module AutoOpenModule1 =
module NestedNormalModule =
[<AutoOpen>]
module AutoOpenModule2 =
[<AutoOpen>]
module AutoOpenModule3 =
type Class() = class end
open NormalModule.AutoOpenModule1.NestedNormalModule
open NormalModule.AutoOpenModule1.NestedNormalModule.AutoOpenModule2
let _ = Class()
"""
=> [ 13, (5, 68) ]
[<Test>]
let ``opening parent module after one of its auto open module was opened should be marked as unused``() =
"""
module NormalModule =
[<AutoOpen>]
module AutoOpenModule1 =
module NestedNormalModule =
[<AutoOpen>]
module AutoOpenModule2 =
[<AutoOpen>]
module AutoOpenModule3 =
type Class() = class end
open NormalModule.AutoOpenModule1.NestedNormalModule.AutoOpenModule2
open NormalModule.AutoOpenModule1.NestedNormalModule
let _ = Class()
"""
=> [ 13, (5, 52) ]
[<Test>]
let ``open declaration is not marked as unused if there is a shortened attribute symbol from it``() =
"""
open System
[<Serializable>]
type Class() = class end
"""
=> []
[<Test>]
let ``open declaration is not marked as unused if an extension property is used``() =
"""
module Module =
type System.String with
member __.ExtensionProperty = ()
open Module
let _ = "a long string".ExtensionProperty
"""
=> []
[<Test>]
let ``open declaration is marked as unused if an extension property is not used``() =
"""
module Module =
type System.String with
member __.ExtensionProperty = ()
open Module
let _ = "a long string".Trim()
"""
=> [ 5, (5, 11) ]
[<Test>]
let ``open declaration is not marked as unused if an extension method is used``() =
"""
type Class() = class end
module Module =
type Class with
member __.ExtensionMethod() = ()
open Module
let x = Class()
let _ = x.ExtensionMethod()
"""
=> []
[<Test>]
let ``open declaration is marked as unused if an extension method is not used``() =
"""
type Class() = class end
module Module =
type Class with
member __.ExtensionMethod() = ()
open Module
let x = Class()
"""
=> [ 6, (5, 11) ]
[<Test>]
let ``open declaration is not marked as unused if one of its types is used in a constructor signature``() =
"""
module M =
type Class() = class end
open M
type Site (x: Class -> unit) = class end
"""
=> []
[<Test>]
let ``open declaration is marked as unused if nothing from it is used``() =
"""
module M =
type Class() = class end
open M
type Site (x: int -> unit) = class end
"""
=> [ 4, (5, 6) ]
[<Test>]
let ``static extension method applied to a type results that both namespaces /where the type is declared and where the extension is declared/ is not marked as unused``() =
"""
module Extensions =
type System.DateTime with
static member ExtensionMethod() = ()
open System
open Extensions
let _ = DateTime.ExtensionMethod
"""
=> []
[<Test>]
let ``static extension property applied to a type results that both namespaces /where the type is declared and where the extension is declared/ is not marked as unused``() =
"""
module Extensions =
type System.DateTime with
static member ExtensionProperty = ()
open System
open Extensions
let _ = DateTime.ExtensionProperty
"""
=> []
[<Test>]
let ``accessing property on a variable should not force the namespace in which the type is declared to be marked as used``() =
"""
let dt = System.DateTime.Now
module M =
open System
let _ = dt.Hour
"""
=> [4, (9, 15) ]
[<Test>]
let ``either of two open declarations are not marked as unused if symbols from both of them are used``() =
"""
module M1 =
module M2 =
let func1 _ = ()
module M3 =
let func2 _ = ()
open M1.M2.M3
open M1.M2
let _ = func1()
let _ = func2()
"""
=> []
[<Test>]
let ``open module with ModuleSuffix attribute value applied is not marked as unused if a symbol declared in it is used``() =
"""
[<CompilationRepresentation (CompilationRepresentationFlags.ModuleSuffix)>]
module M =
let func _ = ()
open M
let _ = func()
"""
=> []
[<Test>]
let ``open module all of which symbols are used by qualifier is marked as unused``() =
"""
module M =
let func _ = ()
open M
let _ = M.func 1
"""
=> [4, (5, 6) ]
[<Test>]
let ``open module is not marked as unused if a symbol defined in it is used in OCaml-style type annotation``() =
"""
module M =
type Class() = class end
open M
let func (arg: Class list) = ()
"""
=> []
[<Test>]
let ``auto open module``() =
"""
module Top =
[<AutoOpen>]
module M =
let func _ = ()
open Top
let _ = func()
"""
=> []
[<Test>]
let ``auto open module with namespace``() =
"""
namespace Module1Namespace
[<AutoOpen>]
module Module1 =
module Module2 =
let x = 1
namespace ConsumerNamespace
open Module1Namespace
module Module3 =
let y = Module2.x
"""
=> []
[<Test>]
let ``auto open module in the middle of hierarchy``() =
"""
namespace Ns
module M1 =
[<AutoOpen>]
module MA1 =
let func _ = ()
open M1
module M2 =
let _ = func()
"""
=> []
[<Test>]
let ``open declaration is not marked as unused if a delegate defined in it is used``() =
"""
open System
let _ = Func<int, int>(fun _ -> 1)
"""
=> []
[<Test>]
let ``open declaration is not marked as unused if a unit of measure defined in it is used``() =
"""
module M =
type [<Measure>] m
module N =
open M
let _ = 1<m>
"""
=> []
[<Test>]
let ``open declaration is not marked as unused if an attribute defined in it is applied on an interface member argument``() =
"""
open System.Runtime.InteropServices
type T = abstract M: [<DefaultParameterValue(null)>] ?x: int -> unit
"""
=> []
[<Test>]
let ``relative module open declaration``() =
"""
module Top =
module Nested =
let x = 1
open Top
open Nested
let _ = x
"""
=> []
[<Test>]
let ``open declaration is used if a symbol defined in it is used in a module top-level do expression``() =
"""
module Top
open System.IO
File.ReadAllLines ""
|> ignore
"""
=> []
[<Test>]
let ``redundant opening a module with ModuleSuffix attribute value is marks as unused``() =
"""
[<CompilationRepresentation (CompilationRepresentationFlags.ModuleSuffix)>]
module InternalModuleWithSuffix =
let func1 _ = ()
module M =
open InternalModuleWithSuffix
let _ = InternalModuleWithSuffix.func1()
"""
=> [ 6, (9, 33) ]
[<Test>]
let ``redundant opening a module is marks as unused``() =
"""
module InternalModuleWithSuffix =
let func1 _ = ()
module M =
open InternalModuleWithSuffix
let _ = InternalModuleWithSuffix.func1()
"""
=> [ 5, (9, 33) ]
[<Test>]
let ``usage of an unqualified union case doesn't make an opening module where it's defined to be marked as unused``() =
"""
module M =
type DU = Case1
open M
let _ = Case1
"""
=> []
[<Test>]
let ``usage of qualified union case doesn't make an opening module where it's defined to be marked as unused``() =
"""
module M =
type DU = Case1
open M
let _ = DU.Case1
"""
=> []
[<Test>]
let ``type with different DisplayName``() =
"""
open Microsoft.FSharp.Quotations
let _ = Expr.Coerce (<@@ 1 @@>, typeof<int>)
"""
=> []
[<Test>]
let ``auto open module with ModuleSuffix attribute value``() =
"""
module Top =
[<AutoOpen; CompilationRepresentation (CompilationRepresentationFlags.ModuleSuffix)>]
module Module =
let func _ = ()
open Top
module Module1 =
let _ = func()
"""
=> []
[<Test>]
let ``a type which has more than one DisplayName causes the namespace it's defined in to be not marked as unused``() =
"""
open System
let _ = IntPtr.Zero
"""
=> []
[<Test>]
let ``usage of an operator makes the module it's defined in to be not marked as unused``() =
"""
module M =
let (++|) x y = ()
open M
let _ = 1 ++| 2
"""
=> []
[<Test>]
let ``usage of an operator makes the module /with Module suffix/ it's defined in to be not marked as unused``() =
"""
[<CompilationRepresentation (CompilationRepresentationFlags.ModuleSuffix)>]
module M =
let (++|) x y = ()
open M
let _ = 1 ++| 2
"""
=> []
[<Test>]
let ``type used in pattern matching with "as" keyword causes the module in which the type is defined to be not marked as unused``() =
"""
module M =
type Class() = class end
open M
let _ = match obj() with
| :? Class as c -> ()
| _ -> ()
"""
=> []
[<Test>]
let ``a function from printf family prevents Printf module from marking as unused``() =
"""
open Microsoft.FSharp.Core.Printf
open System.Text
let _ = bprintf (StringBuilder()) "%A" 1
"""
=> []
[<Test>]
let ``assembly level attribute prevents namespace in which it's defined to be marked as unused``() =
"""
open System
[<assembly: Version("1")>]
()
"""
=> []
[<Test>]
let ``open declaration is not marked as unused if a related type extension is used``() =
"""
module Module =
open System
type String with
member __.Method() = ()
"""
=> []
[<Test>]
let ``open declaration is not marked as unused if a symbol defined in it is used in type do block``() =
"""
open System.IO.Compression
type OutliningHint() as self =
do self.E.Add (fun (e: GZipStream) -> ())
member __.E: IEvent<_> = Unchecked.defaultof<_>
"""
=> []
[<Test>]
let ``should not mark open declaration with global prefix``() =
"""
module Module =
open global.System
let _ = String("")
"""
=> []
[<Test>]
let ``record fields should be taken into account``() =
"""
module M1 =
type Record = { Field: int }
module M2 =
open M1
let x = { Field = 0 }
"""
=> []
[<Test>]
let ``handle type alias``() =
"""
module TypeAlias =
type MyInt = int
module Usage =
open TypeAlias
let f (x:MyInt) = x
"""
=> []
[<Test>]
let ``handle override members``() =
"""
type IInterface =
abstract Property: int
type IClass() =
interface IInterface with
member __.Property = 0
let f (x: IClass) = (x :> IInterface).Property
"""
=> []
[<Test>]
let ``active pattern cases should be taken into account``() =
"""
module M =
let (|Pattern|_|) _ = Some()
open M
let f (Pattern _) = ()
"""
=> []
[<Test>]
let ``active patterns applied as a function should be taken into account``() =
"""
module M =
let (|Pattern|_|) _ = Some()
open M
let _ = (|Pattern|_|) ()
"""
=> []
[<Test>]
let ``not used active pattern does not make the module in which it's defined to not mark as unused``() =
"""
module M =
let (|Pattern|_|) _ = Some()
open M
let _ = 1
"""
=> [ 4, (5, 6) ]
[<Test>]
let ``type in type parameter constraint should be taken into account``() =
"""
open System
let f (x: 'a when 'a :> IDisposable) = ()
"""
=> []
[<Test>]
let ``namespace declaration should never be marked as unused``() =
"""
namespace Library2
type T() = class end
"""
=> []
[<Test>]
let ``auto open module opened before enclosing one is handled correctly``() =
"""
module M =
let x = 1
[<AutoOpen>]
module N =
let y = 2
open M.N
open M
let _ = x
let _ = y
"""
=> []
[<Test>]
let ``single relative open declaration opens two independent modules in different parent modules``() =
"""
module M =
module Xxx =
let x = 1
module N =
module Xxx =
let y = 1
open M
open N
open N.Xxx
open Xxx
let _ = y
let _ = x
"""
=> []
[<Test>]
let ``C# extension methods are taken into account``() =
"""
open System.Linq
module Test =
let xs = []
let _ = xs.ToList()
"""
=> []
[<Test>]
let ``namespace which contains types with C# extension methods is marked as unused if no extension is used``() =
"""
open System.Linq
module Test =
let xs = []
"""
=> [ 2, (5, 16) ]
[<Test>]
let ``a type from an auto open module is taken into account``() =
"""
module M1 =
[<AutoOpen>]
module AutoOpened =
type T() = class end
module M2 =
open M1
let _ = T()
"""
=> []
[<Test>]
let ``unused open declaration in top level rec module``() =
"""
module rec TopModule
open System
open System.IO
let _ = DateTime.Now
"""
=> [ 4, (5, 14) ]
[<Test>]
let ``unused open declaration in rec namespace``() =
"""
namespace rec TopNamespace
open System
open System.IO
module Nested =
let _ = DateTime.Now
"""
=> [ 4, (5, 14) ]
[<Test>]
let ``unused inner module open declaration in rec module``() =
"""
module rec TopModule
module Nested =
let x = 1
let f x = x
type T() = class end
type R = { F: int }
open Nested
"""
=> [ 10, (5, 11) ]
[<Test>]
let ``used inner module open declaration in rec module``() =
"""
module rec TopModule
module Nested =
let x = 1
let f x = x
type T() = class end
type R = { F: int }
open Nested
let _ = f 1
"""
=> []
[<Test>]
let ``used open C# type``() =
"""
open type System.Console
WriteLine("Hello World")
"""
=> []
[<Test>]
let ``unused open C# type``() =
"""
open type System.Console
printfn "%s" "Hello World"
"""
=> [2, (10, 24)]
[<Test>]
let ``used open type from module``() =
"""
module MyModule =
type Thingy =
static member Thing = ()
open type MyModule.Thingy
printfn "%A" Thing
"""
=> []
[<Test>]
let ``unused open type from module``() =
"""
module MyModule =
type Thingy =
static member Thing = ()
open type MyModule.Thingy
printfn "%A" MyModule.Thingy.Thing
"""
=> [6, (10, 25)]