-
-
Notifications
You must be signed in to change notification settings - Fork 0
docs: document protected member support #432
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
59 changes: 59 additions & 0 deletions
59
Docs/pages/advanced-features/01-working-with-protected-members.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| # Working with protected members | ||
|
|
||
| Mockolate allows you to set up and verify protected virtual members on class mocks. Access protected members using the | ||
| `.Protected` property: | ||
|
|
||
| ## Example: | ||
|
|
||
| ```csharp | ||
| public abstract class ChocolateDispenser | ||
| { | ||
| protected virtual bool DispenseInternal(string type, int amount) => true; | ||
| protected virtual int InternalStock { get; set; } | ||
| } | ||
|
|
||
| var sut = Mock.Create<ChocolateDispenser>(); | ||
| ``` | ||
|
|
||
| ### Setup | ||
|
|
||
| ```csharp | ||
| // Setup protected method | ||
| sut.SetupMock.Protected.Method.DispenseInternal( | ||
| It.Is("Dark"), It.IsAny<int>()) | ||
| .Returns(true); | ||
|
|
||
| // Setup protected property | ||
| sut.SetupMock.Protected.Property.InternalStock.InitializeWith(100); | ||
| ``` | ||
|
|
||
| **Notes:** | ||
|
|
||
| - Protected members can be set up and verified just like public members, using the `.Protected` accessor. | ||
| - All setup options (`.Returns()`, `.Throws()`, `.Do()`, `.InitializeWith()`, etc.) work with protected members. | ||
|
|
||
| ### Verification | ||
|
|
||
| ```csharp | ||
| // Verify protected method was invoked | ||
| sut.VerifyMock.Invoked.Protected.DispenseInternal( | ||
| It.Is("Dark"), It.IsAny<int>()).Once(); | ||
|
|
||
| // Verify protected property was read | ||
| sut.VerifyMock.Got.Protected.InternalStock().AtLeastOnce(); | ||
|
|
||
| // Verify protected property was set | ||
| sut.VerifyMock.Set.Protected.InternalStock(It.Is(100)).Once(); | ||
|
|
||
| // Verify protected indexer was read | ||
| sut.VerifyMock.GotProtectedIndexer(It.Is(0)).Once(); | ||
|
|
||
| // Verify protected indexer was set | ||
| sut.VerifyMock.SetProtectedIndexer(It.Is(0), It.Is(42)).Once(); | ||
| ``` | ||
|
|
||
| **Note:** | ||
|
|
||
| - All verification options (argument matchers, count assertions) work the same for protected members as for public | ||
| members. | ||
| - Protected indexers are supported using `.GotProtectedIndexer()`/`.SetProtectedIndexer()` for verification. | ||
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.