approval_tests library

Classes

ApprovalConverter
ApprovalLogger
ApprovalLogger is a class that provides methods to log messages with different log levels.
ApprovalNamer
ApprovalNamer is an abstract class that provides methods to generate the file names for the approved and received files.
Approvals
Approvals is a class that provides methods to verify the content of a response.
ApprovalScrubber
Scrubbers are used to clean up strings before they are compared.
ApprovalTestsConstants
ApprovalTextWriter
ApprovalTextWriter is a class that writes the content to a file at the specified path.
ApprovalUtils
ApprovalWriter
ApprovalWriter is an abstract class for writing approvals.
CommandLineReporter
CommandLineReporter is a class for reporting the comparison results using the command line.
Comparator
Comparator is an abstract class for comparing files.
DiffInfo
DiffInfo is a class for storing information about a diff tool.
DiffReporter
DiffReporter is a class for reporting the comparison results using a Diff Tool.
ExecutableQuery
ExecutableQuery is an abstract class for executing queries.
FileComparator
A class FileComparator that implements the Comparator interface. This class is used to compare the content of two files.
FileNamerOptions
FilePathExtractor
GitReporter
GitReporter is a class for reporting the comparison results using the git.
IPlatformWrapper
IPlatformWrapper is an abstract class for platform detection.
IStackTraceFetcher
Interface for fetching the current stack trace.
LinuxDiffTools
LinuxDiffTools contains diff tools available on Linux.
MacDiffTools
MacDiffTools contains diff tools available on macOS.
Namer
Namer class is used to generate the file names for the approved and received files.
Options
Options class is a class used to set options for the approval test.
PlatformWrapper
PlatformWrapper is a class for platform detection.
Reporter
Reporter is an abstract class for reporting the comparison results.
ScrubDates
A class named ScrubDates that extends ScrubWithRegEx. ScrubDates uses a regular expression to scrub date strings in a specific format.
ScrubNothing
A class named ScrubNothing that implements the Scrubber interface. ScrubNothing is default scrubber that does nothing.
ScrubWithRegEx
A class named ScrubWithRegEx that implements the Scrubber interface. ScrubWithRegEx is a scrubber that uses a regular expression to scrub strings.
StackTraceFetcher
A class that provides the current stack trace.
WindowsDiffTools
WindowsDiffTools contains diff tools available on Windows.

Extensions

StringExtensions on String
Extension on String to add a method for replacing occurrences based on a regular expression. This extension method is used by ScrubWithRegEx to perform the scrubbing.

Exceptions / Errors

DoesntMatchException
Exception thrown when the actual value doesn't match the expected value.
FileNotFoundException
FileNotFoundException is thrown when a file is not found.
NoDiffToolException
NoDiffToolException is thrown when a diff tool is not found.