com.github.writethemfirst.approvals.reporters.windows

Class CommandReporter

java.lang.Object

com.github.writethemfirst.approvals.reporters.windows.CommandReporter

All Implemented Interfaces:

Reporter

public class CommandReporter
extends java.lang.Object
implements Reporter

A reporter which delegates execution to an external command.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ARGUMENTS

Fields inherited from interface com.github.writethemfirst.approvals.Reporter

DEFAULT

Constructor Summary

Constructors

Constructor and Description
CommandReporter(Command command)
CommandReporter(Command command, java.lang.String arguments) Constructs the reporter with a single String of arguments, split on spaces.

Method Summary

Modifier and Type	Method and Description
boolean	isAvailable() A Reporter may not be relevant in all contexts, and they should provide some automated checks validating that they’re actually able to perform what they’re supposed to do in the current execution customFiles (like libraries available in the classpath or Diff / Merge programs available on the computer).
void	mismatch(java.nio.file.Path approved, java.nio.file.Path received) A Reporter is called whenever a difference is found while comparing the output of a Program Under Tests and the existing approved files linked to the tests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ARGUMENTS

public static final java.lang.String DEFAULT_ARGUMENTS

See Also:

Constant Field Values

Constructor Detail

CommandReporter

public CommandReporter(Command command)

CommandReporter

public CommandReporter(Command command,
                       java.lang.String arguments)

Constructs the reporter with a single String of arguments, split on spaces.

Method Detail

mismatch

public void mismatch(java.nio.file.Path approved,
                     java.nio.file.Path received)

Description copied from interface: Reporter

A Reporter is called whenever a difference is found while comparing the output of a Program Under Tests and the existing approved files linked to the tests. That method is the one which will be called by the framework, specifying the approved and received files which present differences.

It is then used to implement the behavior to execute for dealing with that mismatch between both files.

Specified by:

mismatch in interface Reporter

Parameters:

approved - The Path to the approved file (which contains the data reviewed and approved by the developer)

received - The Path to the temporary received file (which contains the data generated by the Program Under Tests)

isAvailable

public boolean isAvailable()

Description copied from interface: Reporter

A Reporter may not be relevant in all contexts, and they should provide some automated checks validating that they’re actually able to perform what they’re supposed to do in the current execution customFiles (like libraries available in the classpath or Diff / Merge programs available on the computer).

This method allows to state if a Reporter should be executed in case any differences are found during the comparison of approved and received files. If it returns false, the Reporter won’t be used.

Specified by:

isAvailable in interface Reporter

Returns:

true if the Reporter can be used in the current execution customFiles.