Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing xml doc for member getset #13841

Merged
merged 4 commits into from
Oct 6, 2022
Merged

Missing xml doc for member getset #13841

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1c06e42
Extract Member tests to separate module.
nojaf Sep 5, 2022
78b37cb
Assert XML comment is present.
nojaf Sep 5, 2022
4296743
Remove duplicate tests.
nojaf Sep 26, 2022
6c364c3
Rename modules to contents.
nojaf Oct 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions tests/FSharp.Compiler.Service.Tests/FSharp.Compiler.Service.Tests.fsproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,9 @@
<Compile Include="..\service\SyntaxTreeTests\MemberFlagTests.fs">
<Link>SyntaxTree\MemberFlagTests.fs</Link>
</Compile>
<Compile Include="..\service\SyntaxTreeTests\MemberTests.fs">
<Link>SyntaxTree\MemberTests.fs</Link>
</Compile>
<Compile Include="..\service\SyntaxTreeTests\ComputationExpressionTests.fs">
<Link>SyntaxTree\ComputationExpressionTests.fs</Link>
</Compile>
Expand Down
225 changes: 225 additions & 0 deletions tests/service/SyntaxTreeTests/MemberTests.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,225 @@
module FSharp.Compiler.Service.Tests.SyntaxTreeTests.MemberTests

open FSharp.Compiler.Service.Tests.Common
open FSharp.Compiler.Syntax
open FSharp.Compiler.SyntaxTrivia
open NUnit.Framework

[<Test>]
let ``SynTypeDefn with AutoProperty contains the range of the equals sign`` () =
let parseResults =
getParseResults
"""
/// mutable class with auto-properties
type Person(name : string, age : int) =
/// Full name
member val Name = name with get, set
"""

match parseResults with
| ParsedInput.ImplFile (ParsedImplFileInput (contents = [ SynModuleOrNamespace.SynModuleOrNamespace(decls = [
SynModuleDecl.Types(
typeDefns = [ SynTypeDefn(typeRepr = SynTypeDefnRepr.ObjectModel(members = [_ ; SynMemberDefn.AutoProperty(equalsRange = mEquals)])) ]
)
]) ])) ->
assertRange (5, 20) (5, 21) mEquals
| _ -> Assert.Fail "Could not get valid AST"

[<Test>]
let ``SynTypeDefn with AutoProperty contains the range of the with keyword`` () =
let parseResults =
getParseResults
"""
type Foo() =
member val AutoProperty = autoProp with get, set
member val AutoProperty2 = autoProp
"""

match parseResults with
| ParsedInput.ImplFile (ParsedImplFileInput (contents = [ SynModuleOrNamespace.SynModuleOrNamespace(decls = [
SynModuleDecl.Types(
typeDefns = [ SynTypeDefn(typeRepr = SynTypeDefnRepr.ObjectModel(members = [_
SynMemberDefn.AutoProperty(withKeyword=Some mWith)
SynMemberDefn.AutoProperty(withKeyword=None)])) ]
)
]) ])) ->
assertRange (3, 39) (3, 43) mWith
| _ -> Assert.Fail "Could not get valid AST"

[<Test>]
let ``SynTypeDefn with AbstractSlot contains the range of the with keyword`` () =
let parseResults =
getParseResults
"""
type Foo() =
abstract member Bar : int with get,set
"""

match parseResults with
| ParsedInput.ImplFile (ParsedImplFileInput (contents = [ SynModuleOrNamespace.SynModuleOrNamespace(decls = [
SynModuleDecl.Types(
typeDefns = [ SynTypeDefn(typeRepr = SynTypeDefnRepr.ObjectModel(members = [_
SynMemberDefn.AbstractSlot(slotSig=SynValSig(trivia = { WithKeyword = Some mWith }))])) ]
)
]) ])) ->
assertRange (3, 30) (3, 34) mWith
| _ -> Assert.Fail "Could not get valid AST"

[<Test>]
let ``read-only property in SynMemberDefn.Member contains the range of the with keyword`` () =
let parseResults =
getParseResults
"""
type Foo() =
// A read-only property.
member this.MyReadProperty with get () = myInternalValue
"""

match parseResults with
| ParsedInput.ImplFile (ParsedImplFileInput (contents = [ SynModuleOrNamespace.SynModuleOrNamespace(decls = [
SynModuleDecl.Types(
typeDefns = [ SynTypeDefn(typeRepr =
SynTypeDefnRepr.ObjectModel(members=[
_
SynMemberDefn.GetSetMember(Some(SynBinding _), None, _, { WithKeyword = mWith }) ])
) ])
]) ])) ->
assertRange (4, 31) (4, 35) mWith
| _ -> Assert.Fail "Could not get valid AST"

[<Test>]
let ``write-only property in SynMemberDefn.Member contains the range of the with keyword`` () =
let parseResults =
getParseResults
"""
type Foo() =
// A write-only property.
member this.MyWriteOnlyProperty with set (value) = myInternalValue <- value
"""

match parseResults with
| ParsedInput.ImplFile (ParsedImplFileInput (contents = [ SynModuleOrNamespace.SynModuleOrNamespace(decls = [
SynModuleDecl.Types(
typeDefns = [ SynTypeDefn(typeRepr =
SynTypeDefnRepr.ObjectModel(members=[
_
SynMemberDefn.GetSetMember(None, Some(SynBinding _), _, { WithKeyword = mWith }) ])
) ])
]) ])) ->
assertRange (4, 36) (4, 40) mWith
| _ -> Assert.Fail "Could not get valid AST"

[<Test>]
let ``read/write property in SynMemberDefn.Member contains the range of the with keyword`` () =
let parseResults =
getParseResults
"""
type Foo() =
// A read-write property.
member this.MyReadWriteProperty
with get () = myInternalValue
and set (value) = myInternalValue <- value
"""

match parseResults with
| ParsedInput.ImplFile (ParsedImplFileInput (contents = [ SynModuleOrNamespace.SynModuleOrNamespace(decls = [
SynModuleDecl.Types(
typeDefns = [ SynTypeDefn(typeRepr =
SynTypeDefnRepr.ObjectModel(members=[
_
SynMemberDefn.GetSetMember(Some _, Some _, _, { WithKeyword = mWith; AndKeyword = Some mAnd }) ])
) ])
]) ])) ->
assertRange (5, 8) (5, 12) mWith
assertRange (6, 8) (6, 11) mAnd
| _ -> Assert.Fail "Could not get valid AST"

[<Test>]
let ``SynTypeDefn with static member with get/set`` () =
let parseResults =
getParseResults
"""
type Foo =
static member ReadWrite2
with set x = lastUsed <- ("ReadWrite2", x)
and get () = lastUsed <- ("ReadWrite2", 0); 4
"""

match parseResults with
| ParsedInput.ImplFile (ParsedImplFileInput (contents = [ SynModuleOrNamespace.SynModuleOrNamespace(decls = [
SynModuleDecl.Types(
typeDefns = [ SynTypeDefn(typeRepr = SynTypeDefnRepr.ObjectModel(members = [
SynMemberDefn.GetSetMember(Some _, Some _, m, { WithKeyword = mWith
GetKeyword = Some mGet
AndKeyword = Some mAnd
SetKeyword = Some mSet })
])) ]
)
]) ])) ->
assertRange (4, 8) (4, 12) mWith
assertRange (4, 13) (4, 16) mSet
assertRange (5, 8) (5, 11) mAnd
assertRange (5, 13) (5, 16) mGet
assertRange (3, 4) (5, 54) m
| _ -> Assert.Fail "Could not get valid AST"

[<Test>]
let ``SynTypeDefn with member with set/get`` () =
let parseResults =
getParseResults
"""
type A() =
member this.Z with set (_:int):unit = () and get():int = 1
"""

match parseResults with
| ParsedInput.ImplFile (ParsedImplFileInput (contents = [ SynModuleOrNamespace.SynModuleOrNamespace(decls = [
SynModuleDecl.Types(
typeDefns = [ SynTypeDefn(typeRepr = SynTypeDefnRepr.ObjectModel(members = [
SynMemberDefn.ImplicitCtor _
SynMemberDefn.GetSetMember(Some (SynBinding(headPat = SynPat.LongIdent(extraId = Some getIdent))),
Some (SynBinding(headPat = SynPat.LongIdent(extraId = Some setIdent))),
m,
{ WithKeyword = mWith
GetKeyword = Some mGet
AndKeyword = Some mAnd
SetKeyword = Some mSet })
])) ]
)
]) ])) ->
Assert.AreEqual("get", getIdent.idText)
Assert.AreEqual("set", setIdent.idText)
assertRange (3, 18) (3, 22) mWith
assertRange (3, 23) (3, 26) mSet
assertRange (3, 23) (3, 26) setIdent.idRange
assertRange (3, 45) (3, 48) mAnd
assertRange (3, 49) (3, 52) mGet
assertRange (3, 49) (3, 52) getIdent.idRange
assertRange (3, 4) (3, 62) m
| _ -> Assert.Fail "Could not get valid AST"

[<Test>]
let ``SynTypeDefn with member with get has xml comment`` () =
let parseResults =
getParseResults
"""
type A =
/// B
member x.B with get() = 5
"""

match parseResults with
| ParsedInput.ImplFile (ParsedImplFileInput (contents = [ SynModuleOrNamespace.SynModuleOrNamespace(decls = [
SynModuleDecl.Types(
typeDefns = [ SynTypeDefn(typeRepr = SynTypeDefnRepr.ObjectModel(members = [
SynMemberDefn.GetSetMember(Some (SynBinding(xmlDoc = preXmlDoc)),
None,
_,
_)
])) ]
)
]) ])) ->
Assert.False preXmlDoc.IsEmpty
let comment = preXmlDoc.ToXmlDoc(false, None).GetXmlText()
Assert.False (System.String.IsNullOrWhiteSpace(comment))
| _ -> Assert.Fail "Could not get valid AST"
Loading