/
Confluence Plugin Setup

Confluence Plugin Setup

Owned by Aziz OUATTARA
Last updated: Apr 06, 2020

Installation

The installation of GreenPepper is no different from any other Confluence Add-On installation.

Simply upload your greenpepper-confluence-plugin-xx.jar via your Add-On Manager.



Upgrade

The upgrade of GreenPepper is no different from any other Confluence plugin upgrade.

1. Uninstall your GreenPepper Plugin via your Add-On Manager
2. Re-Upload your GreenPepper Plugin via your Add-On Manager

Uninstall

If you really want to uninstall GreenPepper, simply uninstall your GreenPepper Plugin via your Add-On Manager

Configure Greenpepper Confluence plugin


Confluence Server Base Url

If you expose the Confluence server to the outside world (other than localhost), make sure the Server Base URLof Confluence found is the external URL of the server.

This property is found under the General Configuration of the Administration of Confluence.

Note : If you change this URL when existing Spaces have been registered as greenpepper project, you will need to refresh each project by clicking the Edit link then the Save link on the Space Registration form of the Space Administration or on the Project Management tab of the configuration of the greenpepper plugin.

Here are the panes that will be accessible from your GreenPepper Toolbox plugin Configuration.


Database setup



 GreenPepper has its own database to store multiple data such as executions results, references and so on. You will have two options:


Quick install

 A HSQL will be created locally. This setup is not suggested for a production environment, it was put in place for quick trial setup purposes.

Custom install


This will allow you to setup GreenPepper to use an external DBMS. Supported DBMS includes:

  • PostgreSQL
  • MySQL
  • H2
  • HSQL
  • SQLServer
  • Oracle

(warning) Be aware that some of these systems JDBC drivers are not include in Confluence. Please refer to Confluence Wiki for more information.

Once you have set the database up, you can test your parameters while the Test button.

For databases like H2 and HSQL, the database name should be a path to a directory.

Runners



Your runners configuration pane.
You will be able to add/remove/update your runners.

We recommend creating an own remote runner because tests must be run outside of the confluence VM.

Java Runner

The most recent Java runner will be available by default. At each start of Confluence, we make sure there is a Java Runner matching the GreenPepper plugin version.

  1. Click on Add a new Runner
  2. Enter the name respectively IP of your server
  3. Enter the port of your server
  4. If your server runs in secure mode, enable the appropriate checkbox
  5. Enter the file path of your Runner-jar
  6. Click Save


Maven Runner

Default command line :java -cp ${classpaths} ${mainClass} ${inputPath} ${outputPath} -l ${locale} -r ${repository} -f ${fixtureFactory} --xml --pdd ${projectDependencyDescriptor}
Main class :com.greenpepper.maven.runner.Main
Environment :JAVA
Classpaths
(mandatory) :		.../greenpepper-maven-runner-x.x-complete.jar

Note : You need to specify the full path for the classpath files.

You can set different classpaths to the same Runner(e.g. different folder locations for Linux- and Windows-Users). Delimitate paths with a NewLine(Enter). During runtime every non existing path will be ignored.

Please ensure the data consistency of two or more Runners of the same name and package but a different and existing path. The easiest way to achieve this, is to keep your project up-to-date via version control systems like Git or Subversion.

Project Management (register a space to GreenPepper)


Goal of the registration

The goal of the repository registration is to regroup available specifications and requirements repositories under a single common GreenPepper project so that, when linking specifications to requirements, we can concentrate on related repositories. Here is an overview of the domain:

How to register a repository

To register your repository to GreenPepper server, follow these steps:

  1. Select the Space which you want to register, then click Register. 


  2. Select the GreenPepper project to which you want to associate your repository to or choose New Project.
  3. Enter the Project name if you want to register a new project
  4. Enter the alias to identify your Confluence Space (i.e. PROJECTNAME).
  5. In order to restrict access, enter the username and password of a Confluence user. This restriction will be applied to Confluence and any other plugins accessing or executing the executable specifications.
  6. Click Save.


  7. From the list, select a system under test, if any available.
  8. If no one is available choose Add a new System under Test
  9. Enter the name of your System under Test. It don't has to be the project name of your SuT.
  10. Select the Runner you have specified in step 2.1.2

  11. Enter the Classpath, where your greenpepper-Classes(Fixtures) can be found

You can set different classpaths to the same project(e.g. different folder locations for Linux- and Windows-Users). Delimitate paths with a NewLine(Enter). While executing tables every non existing path will be ignored.

Please ensure the data consistency of two or more classes of the same name and package but a different and existing path. The easiest way to achieve this, is to keep your project up-to-date via version control systems like Git or Subversion.

Confluence Space setup


Using GreenPepper theme

The Theme is a plug-and-play plugin giving access to all GreenPepper functionalities once it has been set.
You can set the GreenPepper Theme from the Space admin panel or Global admin panel.

The drawback of using the Theme is that you will not be able to customize your layouts (e.g. page, space, template) or, if already customized, your customization will be ignored.
Two themes are available.

  1. Select the Space you want to apply greenpepper
  2. Select "Space tools" (bottom left)
  3. Select "Look and Feel"
  4. Select  GreenPepper Documentation Theme. It provides the greenpepper color palette and overrides the default ( or custom) page layout.The page layout automatically includes:
    • the greenpepper header (Execute button and reference list at the top of the page)
    • the greenpepper body (allows GreenPepper to print out test results)

  5. Select "confirm"

Caution with the Greenpepper theme

We cannot guaranty the behavior of the theme between Confluence upgrades. We do not have control on the default page layout of Confluence. This one may vary from a version to another. We advise you to manually configure your page layout. See Confluence Plugin Setup.

Further Configuration


To allow remote access to the the GreenPepper addon, it is necessary to activate the Remote API. Go to the menu Further Configuration of your confluence installation and check the box next to Remote API (XML-RPC & SOAP).