Pepper  3.6.0
A highly extensible plattform for conversion and manipulationoflinguisticdata.
org.corpus_tools.pepper.testFramework.PepperExporterTest Class Referenceabstract

Inherits org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest.

Public Member Functions

void checkThatWhenSimulatingFitnessCheckModulePassesSelfTest (final ModuleFitness fitness)
 
- Public Member Functions inherited from org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest
void addSupportedFormat (FormatDesc formatDesc)
 
void addFormatWhichShouldBeSupported (FormatDesc formatDesc)
 Adds a format description to the list of formats which should be supported by the module to be tested.
 
void addFormatWhichShouldBeSupported (String formatName, String formatVersion)
 Adds a format description to the list of formats which should be supported by the module to be tested.
 
void checkThatCorrectFormatsAreSupported ()
 
- Public Member Functions inherited from org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest
void checkThatFixtureIsSet ()
 
void checkThatCorpusGraphIsSettable ()
 
void checkThatModuleHasName ()
 
void checkThatResourcePathIsSet ()
 
void checkThatWhenSimulatingFitnessCheckModulePassesSelfTest ()
 
- Public Member Functions inherited from org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper
 PepperModuleTestHelper ()
 Creates an object of type PepperModuleTest. More...
 
void initialize ()
 Initializes this object. More...
 
URI getTempURI (String testDirectory)
 Returns a File object pointing to a temporary path, where the caller can store temporary files. More...
 
File getTempPath (String testDirectory)
 Returns a File object pointing to a temporary path, where the caller can store temporary files. More...
 
void start ()
 This methods starts the processing of Pepper in the development environment. More...
 
void setResourcesURI (URI resourceURI)
 Sets the path to resources folder for module. More...
 
boolean compareFiles (URI uri1, URI uri2) throws IOException
 Compares the content of two files. More...
 
boolean compareFiles (File file1, File file2) throws IOException
 Compares the content of two files. More...
 

Protected Member Functions

PepperExporter getFixture ()
 Returns the current fixture to test. More...
 
- Protected Member Functions inherited from org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest
void setFixture (PepperModule fixture)
 Sets the current fixture to test. More...
 
- Protected Member Functions inherited from org.corpus_tools.pepper.testFramework.helpers.PepperModuleTest
ModuleFitness runSelfTest ()
 
String diffsBetweenActualAndExpected ()
 

Additional Inherited Members

- Static Public Member Functions inherited from org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper
static File getTempPath_static (String testDirectory)
 {@inheritDoc PepperTestUtil::getTempPath_static(String)}
 
static String getTestResources ()
 {@inheritDoc PepperTestUtil::getTestResources()}
 
static String getSrcResources ()
 {@inheritDoc PepperTestUtil::getSrcResources()}
 
- Static Public Attributes inherited from org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper
static String TMP_TEST_DIR = PepperTestUtil.TMP_TEST_DIR
 {@inheritDoc PepperTestUtil::TMP_TEST_DIR}
 
- Protected Attributes inherited from org.corpus_tools.pepper.testFramework.helpers.PepperImExporterTest
List< FormatDescsupportedFormatsCheck = null
 A list of formats, which shall be supported. More...
 
- Protected Attributes inherited from org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper
URI resourceURI = null
 
PepperModule fixture = null
 
- Static Protected Attributes inherited from org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper
static final Logger logger = LoggerFactory.getLogger("Pepper")
 

Detailed Description

This class is a helper class for creating tests for PepperExporters. This class provides a fixture declaration which could be called via setFixture(PepperExporter). The fixture which is returned via getFixture() is of type PepperExporter. To create an easier access, we recommend to overwrite the method getFixture() as follows:

&#064;Override
public MY_EXPORTER_CLASS getFixture() {
        return (MY_EXPORTER_CLASS) fixture;
}

The method setFixture(PepperExporter) sets the SaltProject and creates a single SCorpusGraph object, which is added to the list of corpus structures in the salt project. To access the salt project or the corpus structure use the following code:

        getFixture().getSaltProject();
 getFixture().getSaltProject().getCorpusGraphs()

This class predefines a test to check that the format of the exporter is set correctly. Therefore you need to call addSupportedFormat(FormatDesc) and pass the format your exporter should support. Otherwise this test will fail. You can do this as follows:

addSupportedFormat(new FormatDesc().setFormatName(FORMAT_NAME).setFormatVersion(FROMAT_VERSION));

To run the test call start() in your test method. This will start the test environment, which simulates a Pepper conversion process.

Author
florian

Member Function Documentation

◆ getFixture()

PepperExporter org.corpus_tools.pepper.testFramework.PepperExporterTest.getFixture ( )
protected

Returns the current fixture to test.

Returns
object to test, derived from PepperModule

Reimplemented from org.corpus_tools.pepper.testFramework.helpers.PepperModuleTestHelper.