Refactor Assert methods

[CoryCharlton]

Description

• Added CallerArgumentExpression to improve default failure messages
• Fixed incorrect assertion names being passed to HandleFail
• Updated null checks to use is operator so equality overloads cannot impact them
• Removed regions in favor of separate files for AreEqual, AreNotEqual and obsolete methods
• Added DoesNotReturn attribute to methods that always throw exceptions (ie: HandleFail)
• Updated AreSame and AreNotSame to use ReferenceEquals so equality overloads cannot impact them
• Removed Array overload of AreEqual since it is effectively the same as the Object overload and gave a false impression that the collection was being checking
• Updated Contains, DoesNotContains, EndsWith, and StartsWith to use the built-in methods in the String class
• Updated POC project to ensure that all overloads with being tested and that the negative/failure conditions were also being verified.

Motivation and Context

The existing code needed some love. My motivation was that by making all these changes not only will unit testing be more enjoyable but hopefully it will be easier to keep this code up to date.

How Has This Been Tested?

• Manually
• Unit tests

Screenshots

Types of changes

• Improvement (non-breaking change that improves a feature, code or algorithm)
• Bug fix (non-breaking change which fixes an issue with code or algorithm)
• New feature (non-breaking change which adds functionality to code)
• Breaking change (fix or feature that would cause existing functionality to change)
• Config and build (change in the configuration and build system, has no impact on code or features)
• Dependencies (update dependencies and changes associated, has no impact on code or features)
• Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
• Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

• My code follows the code style of this project (only if there are changes in source code).
• My changes require an update to the documentation (there are changes that require the docs website to be updated).
• I have updated the documentation accordingly (the changes require an update on the docs in this repo).
• I have read the CONTRIBUTING document.
• I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
• I have added new tests to cover my changes.

[coderabbitai]

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (10)

• poc/TestOfTestFrameworkByReference/Mock/MockObject.cs is excluded by none and included by none
• poc/TestOfTestFrameworkByReference/NFUnitTestByReference.nfproj is excluded by none and included by none
• poc/TestOfTestFrameworkByReference/Test.cs is excluded by none and included by none
• source/TestFramework/Assert.AreEqual.cs is excluded by none and included by none
• source/TestFramework/Assert.AreNotEqual.cs is excluded by none and included by none
• source/TestFramework/Assert.Obsolete.cs is excluded by none and included by none
• source/TestFramework/Assert.cs is excluded by none and included by none
• source/TestFramework/CollectionAssert.cs is excluded by none and included by none
• source/TestFramework/nanoFramework.TestFramework.nfproj is excluded by none and included by none
• source/TestFrameworkShared/SkipTestException.cs is excluded by none and included by none

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[CoryCharlton]

This PR has a ton of changes so it might be easier to review on a commit by commit basis. The POC project was updated to ensure that all Assert methods work as expected.

[Ellerbach]

ok, so from my point of view, you've been adjusting the following and please correct me if I'm wrong:

• you've moved in new files (equal, not equal and obsolete) some of the code
• there is no breaking change
• some adjustments there and there
• updating the poc test project
• added Mock in the poc test project

All up, I feel it's ok, indeed, not easy to review if not going in each commit. I'll still need a bit of time to review everything.

[CoryCharlton]

ok, so from my point of view, you've been adjusting the following and please correct me if I'm wrong:

• you've moved in new files (equal, not equal and obsolete) some of the code
• there is no breaking change
• some adjustments there and there
• updating the poc test project
• added Mock in the poc test project

All up, I feel it's ok, indeed, not easy to review if not going in each commit. I'll still need a bit of time to review everything.

That is a good summary. The primary change was adding the CallerArgumentExpression attribute to the methods to improve the default failure message like I did in #254 and #252.

Along the way I fixed some tech debt (such as using string.Contains, string.StartsWith, etc) and got rid of the regions in favor of separate files.

I'll update the description with a more comprehensive list of changes.

[Ellerbach]

Finally took the time to review and it looks good.

[Ellerbach]

@CoryCharlton if no other change to be done, I can go and merge, just let me know.

[CoryCharlton]

@CoryCharlton if no other change to be done, I can go and merge, just let me know.

I have no other changes at this time.