This is a framework built with JBehave. The ReadMe contains the 'how to build a test for UI' and an explanation of the structure. For further info please also check JBselDiagram.png In a later update I'll also add 'How to build a test for API' with examples, using the same project.

'How to build a test for UI'

Steps:

1. Create a new story file. The reference is below under point 1 of 'The project structure.
2. Create a new glue class that will link text to implementation. See GoogleSearchTest as example. The reference is below under point 3 of 'The project structure'.
3. Create a new steps class, reuse or add to an already created one if it contains the implementation to your text. See GoogleCommonSteps, GoogleSearchSteps and GoogleAsserts as example. I chose to do it like this to better exemplify this framework's possibility of data sharing among steps classes(implementation classes).
4. Create a new Page Object class, reuse or add new methods to an already created one.
5. Run your test by right clicking the glue class(test class) from point 2 above.

'The project structure'

1. The story files. They usually live under "resources". In this example, they are in the package called stories from resources, module test. The story files contains scenarios written using plain English following the given/when/then syntax (gherkin).

2. The JBehave configs for story mapping. They live in the test module, in the bdd.setup package. StoryMapper is the parent class that all glue classes for running tests inherit. The default config of the StoryMapper is to run all the tests.

3. The glue classes linking the story files with the implementation steps. They live in the test module, in the tests package. Their purpose is to link the story files with the steps classes that implement the given/when/then from the story files. This is done by specifying the location of the story files and the name of the appropriate steps classes. Be careful to also include the steps classes where the WebDriver is initiated. In this example, the class StoryBasic takes care of initiating and quiting the WebDriver using JBehave @BeforeClass / @AfterClass annotations.

4. The test setup classes concerning the WebDriver instantiation + WebDriver and Test data sharing between the steps classes. They live in the main module, under the steps.setup package. Bear in mind that the BaseSteps needs to be inherited by all steps classes, including StoryBasic in this case, where the WebDriver instantiation is not done in a given/when/then step, but by using JBehave annotations. See point 3.

5. The steps classes containing the implementation of the given/when/then steps; the "what to do". They live in the main module, under the steps package. Under the current structure, steps classes can either match the story files 1 to 1, or they can be specialized, covering steps for specific parts of the application, multiple story files being able to use their implementation.

6. The page object classes containing the WebElements and their behavior; the "how to do". They live in the main module, under the pages package. PageFactoryUtils class is used to instantiate them, so whenever you build a new Page class, you can add its getter there.

7. Utility classes that can be used to read property files, test data, etc. They live in the main module, under the utilities package.

The tests can be ran from the glue classes from point 3, which have Test in their name.

Please bear in mind that this is just an example of structuring a framework, and you can adapt it according to your project's specific needs.

'How to build a test for Rest Api'

The first 3 points are identical to writing an Ui test.

the 4th step is not needed, and the 5th is also identical to Ui tests.

6. Feature classes are under the rest package. The role is to build your requests according to the needed functionalities. In the example, there is the createUser rest request build there.

7. Utility classes for Back-end tests include pojo classes that live under the pojo package, to structure your json objects, the Generator for random test data, the HttpRequestEngine that provides the functionality to send rest requests and the JsonUtilities that help with serializing and deserializing Pojo objects to json and viceversa.