hu.ibello.requirements

Interface RequirementHandler

public interface RequirementHandler

With the methods of this class we can load and save Cucumber feature files. The files will be loaded from the current ibello project.

The return values are in ibello's own format. The Requirements class describes a requirement list.

Author:

Kornél Simon

Method Summary

Modifier and Type	Method and Description
RequirementsCoverage	calculateExampleCoverage(String relativePath) Calculate the example coverage of the requirements defined in the specified file.
RequirementsCoverage	calculateTestCoverage(String relativePath) Calculate the test coverage of the requirements defined in the specified file.
boolean	existsRequirementsFile(String relativePath) Checks if a requirement file exists.
List<Requirements>	loadRequirements() Loads all requirement files and put them into a list.
List<Requirements>	loadRequirements(Pattern relativePath) Loads selected requirement files and put them into a list.
Requirements	loadRequirements(String relativePath) Loads a single requirement file.

Method Detail

loadRequirements

Requirements loadRequirements(String relativePath)
                       throws RequirementException

Loads a single requirement file.

Parameters:

relativePath - the path to the file, relative to the requirements directory of the project

Returns:

the loaded requirement list

Throws:

RequirementException - if there was an error during loading the file

loadRequirements

List<Requirements> loadRequirements()
                             throws RequirementException

Loads all requirement files and put them into a list.

Returns:

the list of the loaded requirements

Throws:

RequirementException - if there was an error during loading a file

loadRequirements

List<Requirements> loadRequirements(Pattern relativePath)
                             throws RequirementException

Loads selected requirement files and put them into a list.

Parameters:

relativePath - regular expression for the path to the file (which is relative to the requirements directory of the project)

Returns:

the loaded requirement list

Throws:

RequirementException - if there was an error during loading the file

existsRequirementsFile

boolean existsRequirementsFile(String relativePath)

Checks if a requirement file exists.

Parameters:

relativePath - the path to the file, relative to the requirements directory of the project

Returns:

true if the given file exists, false otherwise

calculateTestCoverage

RequirementsCoverage calculateTestCoverage(String relativePath)
                                    throws RequirementException

Calculate the test coverage of the requirements defined in the specified file. The test coverage is calculated from the Cucumber feature files related to the requirements. The relation is made by the requirement ID: if a scenario has a tag with the ID of a requirement, then the requirement is covered by the test.

Parameters:

relativePath - the path to the file, relative to the requirements directory of the project

Returns:

the test coverage of the requirements

Throws:

RequirementException - if there was an error during loading the file or calculating the coverage

calculateExampleCoverage

RequirementsCoverage calculateExampleCoverage(String relativePath)
                                       throws RequirementException

Calculate the example coverage of the requirements defined in the specified file. The example coverage is calculated from the Cucumber example files related to the requirements. The relation is made by the requirement ID: if a scenario has a tag with the ID of a requirement, then the requirement is covered by the example.

Parameters:

relativePath - the path to the file, relative to the requirements directory of the project

Returns:

the example coverage of the requirements

Throws:

RequirementException - if there was an error during loading the file or calculating the coverage