2. Configure GreenPepper Confluence plugin

GreenPepper plugin setup

Confluence Server Base Url If you expose the Confluence server to the oustide world (other than localhost), make sure the Server Base Url of 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:
  1. Quick install: a HSQL will be created locally. This setup is not suggested for a production environment, it was put inplace for quick trial setup purposes.
  2. Custom install: This will allow you to setup GreenPepper to use an external DBMS via a JNDI name.
     

• Licence manager: From where you will be able upload your licence and see your licence details
  

• Runner: Your runners configuration pane.
  You will be able to add/remove/update your runners (GreenPepper Open; Test engine)

  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.

  .Net Runner Default command line : .../GreenPepper.exe ${inputPath} ${outputPath} -a ${classpaths} -r ${repository} -f ${fixtureFactory} --xml Main class : leave it empty Environment : .NET Classpaths (mandatory) : .../GreenPepper.Core.dll .../GreenPepper.Extensions.dll .../CookComputing.XmlRpc.dll All required assemblies are found in the GreenPepper Open .Net binaries. Note : You need to specify the full path for the Assembly files and the GreenPepper.exe file.

  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) : .../apache-maven-2.0.x/lib/maven-2.0.x-uber.jar .../apache-maven-2.0.x/boot/classworlds-1.1.jar .../greenpepper-maven-runner-x.x-complete.jar Note : You need to specify the full path for the classpath files. More info Maven Runner.

• Project Management: Your Space registration to GreenPepper.
  From this pane you will be able to:
  1. Associate your Confluence spaces to GreenPepper projects.
  2. Set your GreenPepper credentials to be able to run the tests if the space is secured.
  3. Add/Remove/Edit your System under tests for a specific GreenPepper project.
     

Confluence Space setup

I. 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. The GreenPepper Colour Theme provides the GreenPepper colour palette.
   
   
2. The GreenPepper Theme provides the GreenPepper colour 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)

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.

Confluence 2.8 and up If you are not using the GreenPepper Plugin v2.2+, the theme should be configured manually (see below)

II. Manual configuration

First, you need to add the following to your Page Layout:

Confluence version 2.8 and up

  You need to replace the following in your Page Layout:

<div class="wiki-content">       
  $body     
</div>

<table cellspacing="0" width="100%">
  #parse($greenPepper.header)
</table>
#parse($greenPepper.body)

Previous version of Confluence

Copy #parse($greenPepper.header) at the designated place in the vm. (See bellow)

## VIEW    
 #if ($mode == "view")      
 #set ($labelable = $page)      
 #permitSearchEngines()      
  <table width="100%" style="margin-bottom: 5px" cellspacing="0">        
   <tr>          
    <td align="left" valign="top">            
     <span class="smalltext">              
     #editReport()              
     #parse ("/labels/labels-include.vm")            
    </span>          
   </td>
   Test          
   <td align="right" valign="top">            
    #if(\!$action.anonymousUser && \!$action.isPrintableVersion())              
     <div style="padding: 5px; width: 40px; border: 1px solid #cccccc; margin: 0px">...            
    #end          
   </td>        
  </tr> 
<\!-\\\\\\\- PLACE THIS HERE \-->  
  #parse($greenPepper.header)  
<\!-\\\\\\\- PLACE THIS HERE \-->      
  </table>      
  #if ($helper.isHistoricalVersion())

<div class="wiki-content">       
  $body     
</div>

#parse($greenPepper.body)

Register a Space to use GreenPepper

I. 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:

II. How to register a repository

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

1. Click the Space Registration tab, then click Register.
   
   
   
   
   
2. Select the GreenPepper project to which you want to associate your repository to.
3. Enter the alias to identify your JIRA project Or Confluence Space (i.e. MYJIRA-PROJECTNAME).
4. In order to restrict access, enter the username and password of a Confluence and/or JIRA user. This restriction will be applied to Confluence, JIRA and any other plugins accessing or executing the executable specifications.
5. From the list, select a system under test, if any available.
6. Click Save.
   
   
   
   
   

   N.B.: You may add a new GreenPepper project by selecting New Project from the GreenPepper Project Name dropdown list.