Skip to content

Commit 7c0a3a3

Browse files
committed
Update tests
1 parent f145ead commit 7c0a3a3

File tree

3 files changed

+33
-19
lines changed

3 files changed

+33
-19
lines changed

tests/Render/BitzArt.XDoc.PlainText.Tests/InheritanceResolverTests.cs

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,4 +78,18 @@ public void GetTargetMember_PropertyImplementedOnlyItself_ShouldReturnNull()
7878
// Assert
7979
Assert.Null(targetMember);
8080
}
81+
82+
[Fact]
83+
public void GetTargetMember_MyClassA_ShouldReturnMyBaseClass()
84+
{
85+
// Arrange
86+
var type = typeof(MyClassA);
87+
var expected = typeof(MyBaseClass);
88+
89+
// Act
90+
var targetMember = InheritanceResolver.GetTargetMember(type);
91+
92+
// Assert
93+
Assert.Equal(expected, targetMember);
94+
}
8195
}

tests/Render/BitzArt.XDoc.PlainText.Tests/PlainTextRendererEndToEndTests.cs

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,32 @@ class MyClass
55
/// <summary>
66
/// This is testing property from MyClass.
77
/// </summary>
8-
public virtual int TestPropertyFromMyClass { get; set; }
8+
public virtual int MyProperty { get; set; }
99
}
1010

1111
class MyInheritedClass : MyClass
1212
{
1313
/// <inheritdoc />
14-
public override int TestPropertyFromMyClass { get; set; }
14+
public override int MyProperty { get; set; }
1515

1616

1717
/// <summary>
1818
/// This is testing property from inherited class.
1919
/// </summary>
20-
public int TestPropertyFromMyInheritedClass { get; set; }
20+
public int AnotherProperty { get; set; }
2121
}
2222

2323
class MyDoubleInheritedClass : MyInheritedClass
2424
{
2525
/// <inheritdoc />
26-
public override int TestPropertyFromMyClass { get; set; }
26+
public override int MyProperty { get; set; }
2727
}
2828

2929
class MySimpleClass
3030
{
3131
public int MyMethod() => 1;
32+
33+
public int MyMethod(int x) => x + 1;
3234
}
3335

3436
public class PlainTextRendererEndToEndTests
@@ -37,11 +39,11 @@ public class PlainTextRendererEndToEndTests
3739
private const string ThisIsTestingPropertyFromInheritedClass = "This is testing property from inherited class.";
3840

3941
[Fact]
40-
public void Render_ExtractsPropertySummary_ForMyInheritedClassReturnXmlCommentFromMyClass()
42+
public void ToPlainText_MyPropertyFromMyInheritedClass_ReturnsThisIsTestingPropertyFromMyClass()
4143
{
4244
// Arrange
4345
var xdoc = new XDoc();
44-
var propertyInfo = typeof(MyInheritedClass).GetProperty(nameof(MyInheritedClass.TestPropertyFromMyClass));
46+
var propertyInfo = typeof(MyInheritedClass).GetProperty(nameof(MyInheritedClass.MyProperty));
4547

4648
// Act
4749
var propertyDocumentation = xdoc.Get(propertyInfo);
@@ -52,12 +54,11 @@ public void Render_ExtractsPropertySummary_ForMyInheritedClassReturnXmlCommentFr
5254
}
5355

5456
[Fact]
55-
public void Render_ExtractsPropertySummary_ForMyDoubleInheritedClassReturnXmlCommentFromMyClass()
57+
public void ToPlainText_MyPropertyFromMyDoubleInheritedClass_ReturnsThisIsTestingPropertyFromMyClass()
5658
{
5759
// Arrange
5860
var xdoc = new XDoc();
59-
var propertyInfo =
60-
typeof(MyDoubleInheritedClass).GetProperty(nameof(MyDoubleInheritedClass.TestPropertyFromMyClass));
61+
var propertyInfo = typeof(MyDoubleInheritedClass).GetProperty(nameof(MyDoubleInheritedClass.MyProperty));
6162

6263
// Act
6364
var propertyDocumentation = xdoc.Get(propertyInfo);
@@ -68,11 +69,11 @@ public void Render_ExtractsPropertySummary_ForMyDoubleInheritedClassReturnXmlCom
6869
}
6970

7071
[Fact]
71-
public void Render_ExtractsPropertySummary_ForMyInheritedClassReturnXmlCommentFromMyInheritedClass()
72+
public void ToPlainText_AnotherPropertyFromMyInheritedClass_ReturnsThisIsTestingPropertyFromInheritedClass()
7273
{
7374
// Arrange
7475
var xdoc = new XDoc();
75-
var propertyInfo = typeof(MyInheritedClass).GetProperty(nameof(MyInheritedClass.TestPropertyFromMyInheritedClass));
76+
var propertyInfo = typeof(MyInheritedClass).GetProperty(nameof(MyInheritedClass.AnotherProperty));
7677

7778
// Act
7879
var propertyDocumentation = xdoc.Get(propertyInfo);
@@ -83,26 +84,26 @@ public void Render_ExtractsPropertySummary_ForMyInheritedClassReturnXmlCommentFr
8384
}
8485

8586
[Fact]
86-
public void Render_ExtractsPropertySummary_ForMySimpleClassReturnEmpty()
87+
public void ToPlainText_MyMethodFromMySimpleClass_ReturnsEmptyString()
8788
{
8889
// Arrange
8990
var xdoc = new XDoc();
90-
var methodInfo = typeof(MySimpleClass).GetMethod(nameof(MySimpleClass.MyMethod));
91+
var methodInfo = typeof(MySimpleClass).GetMethod(nameof(MySimpleClass.MyMethod), [typeof(int)])!;
9192

9293
// Act
9394
var methodocumentation = xdoc.Get(methodInfo);
9495
var xmlComment = methodocumentation.ToPlainText();
9596

9697
// Assert
9798
Assert.Equal(string.Empty, xmlComment);
98-
}
99-
99+
}
100+
100101
[Fact]
101-
public void Render_ExtractsPropertySummary_ForMyClassReturnComment()
102+
public void ToPlainText_MyPropertyFromMyClass_ReturnsThisIsTestingPropertyFromMyClass()
102103
{
103104
// Arrange
104105
var xdoc = new XDoc();
105-
var propertyInfo = typeof(MyClass).GetProperty(nameof(MyClass.TestPropertyFromMyClass));
106+
var propertyInfo = typeof(MyClass).GetProperty(nameof(MyClass.MyProperty));
106107

107108
// Act
108109
var methodocumentation = xdoc.Get(propertyInfo);

tests/Render/BitzArt.XDoc.PlainText.Tests/PlainTextRendererTests.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@ public void Render_ReturnsEmptyString_WhenInheritDocTagProvided()
4343
// Arrange
4444
var assembly = GetType().Assembly;
4545

46-
4746
List<TestMemberNode> nodes =
4847
[
4948
new TestMemberNode(typeof(TestClass), "node with inherit doc test"),
@@ -63,7 +62,7 @@ public void Render_ReturnsEmptyString_WhenInheritDocTagProvided()
6362
var plainTextRenderer = new PlainTextRenderer(new XDoc());
6463
var comment = plainTextRenderer.Render(memberDocumentation);
6564

66-
Assert.Equal("", comment);
65+
Assert.Equal(string.Empty, comment);
6766
}
6867

6968
[Fact]

0 commit comments

Comments
 (0)