Open-Xchange - User contributions [en]

AppSuite:Load Tests

2016-04-11T07:16:24Z

Zap23: Replaced content with "This page has been moved to repository https://git.open-xchange.com/git/wd/testing/performance."

This page has been moved to repository https://git.open-xchange.com/git/wd/testing/performance.

AppSuite:Updating To Guard PGP

2015-05-19T10:54:08Z

Zap23: /* Step 1: Test installation */

= Guard Update =

Starting with Guard 2.0, the proprietary Guard format is discontinued in favor of PGP encryption. The proprietary format is still supported for decoding/reading, but all future encryption will be done with PGP compliant encryption.

The upgrade from 1.2 to 2.0 requires database modification and data population. During the update, Guard 1.2 servers can continue to operate. During the alter tables, no additional Guard members can be added, but users can continue to encrypt and decode items. After the alter table is complete, a data population phase begins. During this phase, lookup tables are created for the existing PGP public keys. Depending on the number of users, this may take a while, but there will be no impact on the functioning Guard 1.2 servers.

The database upgrade is required for Guard 2.0 to function, but Guard 1.2 will function without issue on the updated database.

== Guard Upgrade Process ==

Install Guard 2.0 on the server you would like to do the upgrade. The guard.properties file should reflect all of the database and REST API settings as before. There have been some changes in the guard.properties file (addressed below), but there are no changes required for the update process

=== Step 1: Test installation ===

Once the installation is complete, it is often best to test that Guard is configured properly and able to communiate with the OX backend. Use an email address that is a user on the OX system...for this example, we'll use john@doe.com

On command line:
/opt/open-xchange/guard/sbin/guard test john@doe.com

Guard should return a result similar to
Response received. Testing JSON
{"john@doe.com":{"uid":13,"user":{"language":"en_US","displayName":"John Smith"},"cid":10}}
User id 13
Context 10
Language en_US
Name John Smith
Success

If you do not get a "Success", then check the logs and guard.properties file for a configuration issue.

=== Step 2: Upgrade ===

Once the installation is verified, the upgrade process can begin.

On command line:
/opt/open-xchange/sbin/guard upgradePGP

This will begin the upgrade process. First, the required database alter function are performed. This is the only stage that locks the tables. During this process, no additional Guard users can be created.

Once this is done, then the lookup tables are populated. Progress will be written to the console.

Once complete, the database upgrade is finished.

=== Step 3: Configuration File ===

There are some minor changes to the Guard backend's guard.properties file. This file will have to be altered on each of the Guard servers when they are each updated.

==== PGP lookup ====

When a user tries to send a PGP email to a recipient, Guard will check configured public key servers for the recipients PGP Public key. You can configure which servers are used in a comma deliminated list.

com.openexchange.guard.publicPGPDirectory = hkp://keys.gnupg.net:11371, hkp://pgp.mit.edu:11371

==== External Email URL ====

The URL for the external guest reader has been changed. The value can now be configured through the configuration cascade so that a custom domain can be used for each context. The guard.properties file contains the default value if the configuration cascade is not present

com.openexchange.guard.externalReaderPath=example.com/appsuite/api/oxguard/reader/reader.html

This value will be used as the default unless over-written by cascade value
com.openexchange.guard.externalReaderURL

Finally, each PGP email is also sent with a help file that explains what PGP is, and how to log onto Appsuite to view the email. The domain for appsuite should be configured here
com.openexchange.guard.externalEmailURL=example.com

=== Step 4: Start ===

Start Guard 2.0 using (Debian)
/etc/init.d/open-xchange-guard start

AppSuite:Load Tests

2014-11-29T00:22:13Z

Zap23: /* Getting Performance Repository */

== Software Requirements ==
* Java SE JDK6 or JDK7
* Git
* SBT

== Getting Performance Repository ==
* Cloning Repository
<pre class="shell">$ git clone https://git.open-xchange.com/git/wd/testing/performance</pre>

* Checkout a branch, e.g. ''develop''
<pre class="shell">$ git checkout develop</pre>

== Install SBT ==
Since we use the Gatling-SBT plugin, which allows us to use Gatling as a testing framework, we'll need to install SBT first.

=== Installing sbt on Mac ===
* [http://macports.org Macports]
<pre class="shell">$ port install sbt</pre>

* [http://mxcl.github.com/homebrew Homebrew]
<pre class="shell">$ brew install sbt</pre>

=== Installing sbt on Windows ===
* Download the [https://dl.bintray.com/sbt/native-packages/sbt/0.13.7/sbt-0.13.7.msi msi installer] and install it.

=== Installing sbt on Linux ===
* [https://dl.bintray.com/sbt/rpm/sbt-0.13.7.rpm RPM] package
* [https://dl.bintray.com/sbt/debian/sbt-0.13.7.deb DEB] package

=== Installing sbt manually ===
* [http://www.scala-sbt.org/0.13/tutorial/Manual-Installation.html Manual] instructions

== Build and execute the tests with the SBT-Plugin ==
After SBT has been successfully installed we can switch to the project's directory:
<pre class="shell">
$ cd ~/performance/com.openexchange.test.performance.gatling
</pre>

SBT can be used both as a command line script and as a build console. Most of the commands can be run standalone by passing the command as an argument to SBT, e.g.

<pre class="shell">$ sbt update</pre>

Display all available projects:

<pre class="shell">
$ sbt projects
[info] Loading project definition from ~/performance/com.openexchange.test.performance.gatling/project
[info] Set current project to root (in build file:~/performance/com.openexchange.test.performance.gatling/)
[info] In file:~/performance/com.openexchange.test.performance.gatling/
[info] project-ajax
[info] project-common
[info] project-drive
[info] project-guard
[info] project-in8
[info] project-jolokia
[info] project-usm
[info] * root
</pre>

Switch to a specific project:

<pre class="shell">
root> project project-ajax
[info] Set current project to project-ajax (in build file:~/performance/com.openexchange.test.performance.gatling/)
project-ajax>
</pre>

To execute all tests in the project just enter:

<pre class="shell">
project-ajax> gatling:test
[info] Formatting 21 Scala sources {file:~/performance/com.openexchange.test.performance.gatling/}project-common(test) ...
[info] Formatting 66 Scala sources {file:~/performance/com.openexchange.test.performance.gatling/}project-ajax(test) ...
[info] Compiling 21 Scala sources to ~/performance/com.openexchange.test.performance.gatling/project-common/target/scala-2.10/test-classes...
[info] Compiling 66 Scala sources to ~/performance/com.openexchange.test.performance.gatling/project-ajax/target/scala-2.10/test-classes...
[info] Compiling 66 Scala sources to ~/performance/com.openexchange.test.performance.gatling/project-ajax/target/scala-2.10/gatling-classes...
Simulation com.openexchange.test.performance.gatling.simulations.QAPerfOX6 started...
</pre>

Note that if a command takes arguments, you need to quote the entire argument path, e.g.

<pre class="shell">
$ sbt 'project-ajax/gatling:testOnly com.openexchange.test.performance.gatling.simulations.QAPerfOX6'
</pre>

The following command line script will execute the Gatling OX6 Performance test:
<pre class="shell">$ sbt "project project-ajax" 'set javaOptions ++=Seq("-Dgatling_host=10.0.0.1", "-Dgatling_protocol=http", "-Dgatling_port=80", "-Dgatling_user=100", "-Dgatling_duration_time=120", "-Dgatling_duration_unit=SECONDS")' clean "gatling:testOnly com.openexchange.test.performance.gatling.simulations.QAPerfOX6"
</pre>

== Development Environment ==
If you want to execute/debug the tests via an IDE like Eclipse or IntelliJ IDEA then you will also need to install the following software:

=== IntelliJ IDEA ===
Download and install the [http://www.jetbrains.com/idea/download/ IntelliJ IDEA Community Edition]

=== Eclipse ===
* [https://www.eclipse.org Eclipse 4.2] or later
* [http://scala-ide.org Scala IDE plugin]

Since there are a few problems with the Scala IDE for eclipse we recommend to use IntelliJ which works out of the box.

=== Importing Project into IntelliJ ===

==== Create project files ====
To create the Idea project files please use the sbt task '''gen-idea'''.

<pre class="shell">
$ cd ~/git/performance/com.openexchange.test.performance.gatling

$ sbt gen-idea
[info] Loading project definition from ~/git/performance/com.openexchange.test.performance.gatling/project
[info] Set current project to root (in build file:~/git/performance/com.openexchange.test.performance.gatling/)
...
</pre>
This task will resolve all project dependencies and create the IDEA modules accordingly.

==== Import project ====
# Start IntelliJ
# Click on Import Project...
# Select the gatling folder within the performance repository
# Import project from external model → SBT Project → Finish

== Configurable Parameters ==
List of all available System-Properties and JVM-Arguments:

; gatling_protocol: Which protocol to use. ''Possible values are: '''"http"''' or '''"https"'''. Default value: '''"http"'''.''

; gatling_host: Which host to use. ''Possible values are: '''"localhost"''', '''"10.0.0.1"''' or if you want to stress several groupware servers, to bypass a loadbalancer for example, then you can use comma-separated IPs or hostnames '''"10.0.0.1,10.0.0.2,localhost"'''. Default value: '''"localhost"'''.''

; gatling_port: Which port to use. ''Possible values are: '''"80"''', '''"8009"'''

; gatling_user: How many concurrent users to simulate. ''Default value: '''"5"'''.''

; gatling_duration_time: Duration time of the simulation. ''Default value: '''"30"'''.''

; gatling_duration_unit: The Unit of the durationTime. ''Possible values are: '''"SECONDS"''', '''"MINUTES"''', '''"HOURS"''' or '''"DAYS"'''. Default value: '''"SECONDS"'''.''

; gatling_successpercent: Successful responses in percentage. ''Default value: '''"100"'''.''

; gatling_reqpersec: Mean number of requests per second (lower bound). ''Default value: '''"0"'''.''

; gatling_resptime: Mean response time (lower bound). ''Default value: '''"0"'''.''

; gatling_user_feeder: Name of the CSV-File for feeding the requests. ''Default value: '''"ox_user_credentials.csv"'''.''

; gatling_basic_auth_user: The user name of the basic access authentication.

; gatling_basic_auth_pass: The password of the basic access authentication.

; gatling_syncmsgmax: How many objects to synchronize. ''Relevant only for '''QAPerfUSM'''. Default value: '''"50"'''.''

; gatling_pimObjects: How many PIM Objects, e.g. contacts, should be created. ''Default value: '''"5"'''.''

== Test Execution ==

=== Pre-Requisites for the Open-Xchange Groupware Server ===
==== Disabling rate limitation ====
* Modify the parameter maxRateLenientClients @server.properties:
$ vim /opt/etc/open-xchange/etc/server.properties
* Specify a new User-Agent which is excluded from rate limit checks
"GATLING*"

==== Resources/Data ====
In the data folder you can find an sample csv file which is used to perform a login. If you want to use your own CSV-File place it into the data directory.

* Structure of the csv file:
<code>
username,password
user1,secret
user2,secret
user3,secret
...
user998,secret
user999,secret
user1000,secret
</code>

== Practical hints and tips ==
* If you want to run tests for more than 24h, uncomment the "timeOut" → "simulation" property at gatling.conf and define a value of more than 24h (in seconds).
* If you experience OutOfMemory issues when generating charts, adjust "charting" → "accuracy" to a higher value. This will lower the accuracy of the generated graphs. Especially for long-running tests, this could be set to 100ms.

AppSuite:Load Tests

2014-11-29T00:21:13Z

Zap23:

== Software Requirements ==
* Java SE JDK6 or JDK7
* Git
* SBT

== Getting Performance Repository ==
* Cloning Repository
<pre class="shell">
$ git clone https://git.open-xchange.com/git/wd/testing/performance
</pre>

* Checkout a branch, e.g. ''develop''
<pre class="shell">$ git checkout develop</pre>

== Install SBT ==
Since we use the Gatling-SBT plugin, which allows us to use Gatling as a testing framework, we'll need to install SBT first.

=== Installing sbt on Mac ===
* [http://macports.org Macports]
<pre class="shell">$ port install sbt</pre>

* [http://mxcl.github.com/homebrew Homebrew]
<pre class="shell">$ brew install sbt</pre>

=== Installing sbt on Windows ===
* Download the [https://dl.bintray.com/sbt/native-packages/sbt/0.13.7/sbt-0.13.7.msi msi installer] and install it.

=== Installing sbt on Linux ===
* [https://dl.bintray.com/sbt/rpm/sbt-0.13.7.rpm RPM] package
* [https://dl.bintray.com/sbt/debian/sbt-0.13.7.deb DEB] package

=== Installing sbt manually ===
* [http://www.scala-sbt.org/0.13/tutorial/Manual-Installation.html Manual] instructions

== Build and execute the tests with the SBT-Plugin ==
After SBT has been successfully installed we can switch to the project's directory:
<pre class="shell">
$ cd ~/performance/com.openexchange.test.performance.gatling
</pre>

SBT can be used both as a command line script and as a build console. Most of the commands can be run standalone by passing the command as an argument to SBT, e.g.

<pre class="shell">$ sbt update</pre>

Display all available projects:

<pre class="shell">
$ sbt projects
[info] Loading project definition from ~/performance/com.openexchange.test.performance.gatling/project
[info] Set current project to root (in build file:~/performance/com.openexchange.test.performance.gatling/)
[info] In file:~/performance/com.openexchange.test.performance.gatling/
[info] project-ajax
[info] project-common
[info] project-drive
[info] project-guard
[info] project-in8
[info] project-jolokia
[info] project-usm
[info] * root
</pre>

Switch to a specific project:

<pre class="shell">
root> project project-ajax
[info] Set current project to project-ajax (in build file:~/performance/com.openexchange.test.performance.gatling/)
project-ajax>
</pre>

To execute all tests in the project just enter:

<pre class="shell">
project-ajax> gatling:test
[info] Formatting 21 Scala sources {file:~/performance/com.openexchange.test.performance.gatling/}project-common(test) ...
[info] Formatting 66 Scala sources {file:~/performance/com.openexchange.test.performance.gatling/}project-ajax(test) ...
[info] Compiling 21 Scala sources to ~/performance/com.openexchange.test.performance.gatling/project-common/target/scala-2.10/test-classes...
[info] Compiling 66 Scala sources to ~/performance/com.openexchange.test.performance.gatling/project-ajax/target/scala-2.10/test-classes...
[info] Compiling 66 Scala sources to ~/performance/com.openexchange.test.performance.gatling/project-ajax/target/scala-2.10/gatling-classes...
Simulation com.openexchange.test.performance.gatling.simulations.QAPerfOX6 started...
</pre>

Note that if a command takes arguments, you need to quote the entire argument path, e.g.

<pre class="shell">
$ sbt 'project-ajax/gatling:testOnly com.openexchange.test.performance.gatling.simulations.QAPerfOX6'
</pre>

The following command line script will execute the Gatling OX6 Performance test:
<pre class="shell">$ sbt "project project-ajax" 'set javaOptions ++=Seq("-Dgatling_host=10.0.0.1", "-Dgatling_protocol=http", "-Dgatling_port=80", "-Dgatling_user=100", "-Dgatling_duration_time=120", "-Dgatling_duration_unit=SECONDS")' clean "gatling:testOnly com.openexchange.test.performance.gatling.simulations.QAPerfOX6"
</pre>

== Development Environment ==
If you want to execute/debug the tests via an IDE like Eclipse or IntelliJ IDEA then you will also need to install the following software:

=== IntelliJ IDEA ===
Download and install the [http://www.jetbrains.com/idea/download/ IntelliJ IDEA Community Edition]

=== Eclipse ===
* [https://www.eclipse.org Eclipse 4.2] or later
* [http://scala-ide.org Scala IDE plugin]

Since there are a few problems with the Scala IDE for eclipse we recommend to use IntelliJ which works out of the box.

=== Importing Project into IntelliJ ===

==== Create project files ====
To create the Idea project files please use the sbt task '''gen-idea'''.

<pre class="shell">
$ cd ~/git/performance/com.openexchange.test.performance.gatling

$ sbt gen-idea
[info] Loading project definition from ~/git/performance/com.openexchange.test.performance.gatling/project
[info] Set current project to root (in build file:~/git/performance/com.openexchange.test.performance.gatling/)
...
</pre>
This task will resolve all project dependencies and create the IDEA modules accordingly.

==== Import project ====
# Start IntelliJ
# Click on Import Project...
# Select the gatling folder within the performance repository
# Import project from external model → SBT Project → Finish

== Configurable Parameters ==
List of all available System-Properties and JVM-Arguments:

; gatling_protocol: Which protocol to use. ''Possible values are: '''"http"''' or '''"https"'''. Default value: '''"http"'''.''

; gatling_host: Which host to use. ''Possible values are: '''"localhost"''', '''"10.0.0.1"''' or if you want to stress several groupware servers, to bypass a loadbalancer for example, then you can use comma-separated IPs or hostnames '''"10.0.0.1,10.0.0.2,localhost"'''. Default value: '''"localhost"'''.''

; gatling_port: Which port to use. ''Possible values are: '''"80"''', '''"8009"'''

; gatling_user: How many concurrent users to simulate. ''Default value: '''"5"'''.''

; gatling_duration_time: Duration time of the simulation. ''Default value: '''"30"'''.''

; gatling_duration_unit: The Unit of the durationTime. ''Possible values are: '''"SECONDS"''', '''"MINUTES"''', '''"HOURS"''' or '''"DAYS"'''. Default value: '''"SECONDS"'''.''

; gatling_successpercent: Successful responses in percentage. ''Default value: '''"100"'''.''

; gatling_reqpersec: Mean number of requests per second (lower bound). ''Default value: '''"0"'''.''

; gatling_resptime: Mean response time (lower bound). ''Default value: '''"0"'''.''

; gatling_user_feeder: Name of the CSV-File for feeding the requests. ''Default value: '''"ox_user_credentials.csv"'''.''

; gatling_basic_auth_user: The user name of the basic access authentication.

; gatling_basic_auth_pass: The password of the basic access authentication.

; gatling_syncmsgmax: How many objects to synchronize. ''Relevant only for '''QAPerfUSM'''. Default value: '''"50"'''.''

; gatling_pimObjects: How many PIM Objects, e.g. contacts, should be created. ''Default value: '''"5"'''.''

== Test Execution ==

=== Pre-Requisites for the Open-Xchange Groupware Server ===
==== Disabling rate limitation ====
* Modify the parameter maxRateLenientClients @server.properties:
$ vim /opt/etc/open-xchange/etc/server.properties
* Specify a new User-Agent which is excluded from rate limit checks
"GATLING*"

==== Resources/Data ====
In the data folder you can find an sample csv file which is used to perform a login. If you want to use your own CSV-File place it into the data directory.

* Structure of the csv file:
<code>
username,password
user1,secret
user2,secret
user3,secret
...
user998,secret
user999,secret
user1000,secret
</code>

== Practical hints and tips ==
* If you want to run tests for more than 24h, uncomment the "timeOut" → "simulation" property at gatling.conf and define a value of more than 24h (in seconds).
* If you experience OutOfMemory issues when generating charts, adjust "charting" → "accuracy" to a higher value. This will lower the accuracy of the generated graphs. Especially for long-running tests, this could be set to 100ms.

2014-07-30T07:55:11Z

2014-07-29T14:17:04Z

Zap23: /* Build and execute the tests with the SBT-Plugin */

== Software Requirements ==
* Java SE JDK6 or JDK7
* Git
* SBT

== Getting Performance Repository ==
* Cloning Repository
<code>$ git clone https://git.open-xchange.com/git/wd/testing/performance</code>

* Checkout a branch, e.g. ''develop''
<code>$ git checkout develop</code>

== Install SBT ==
Since we use the Gatling-SBT plugin, which allows us to use Gatling as a testing framework, we'll need to install SBT first.

=== Installing sbt on Mac ===
* [http://macports.org Macports]
<code>$ port install sbt</code>

* [http://mxcl.github.com/homebrew Homebrew]
<code>$ brew install sbt</code>

=== Installing sbt on Windows ===
* Download the [http://dl.bintray.com/sbt/native-packages/sbt/0.13.5/sbt-0.13.5.msi msi installer] and install it.

=== Installing sbt on Linux ===
* [http://dl.bintray.com/sbt/rpm/sbt-0.13.5.rpm RPM] package
* [http://dl.bintray.com/sbt/debian/sbt-0.13.5.deb DEB] package

=== Installing sbt manually ===
* [http://www.scala-sbt.org/0.13/tutorial/Manual-Installation.html Manual] instructions

== Build and execute the tests with the SBT-Plugin ==
After SBT has been successfully installed we can switch to the project's directory:
<code>$ cd ~/performance/com.openexchange.test.performance.gatling</code>

SBT can be used both as a command line script and as a build console. Most of the commands can be run standalone by passing the command as an argument to SBT, e.g.

<code>$ sbt update</code>

Note that if a command takes arguments, you need to quote the entire argument path, e.g.

<code>$ sbt 'gatling:testOnly com.openexchange.test.performance.gatling.tests.QAPerfOX6'</code>

== Development Environment ==
If you want to execute the tests via an IDE like Eclipse or IntelliJ IDEA then you will also need to install the following software:
* [https://www.eclipse.org Eclipse 4.2] or later
* [http://scala-ide.org Scala IDE plugin]

=== Importing Project into Eclipse ===
# Open Eclipse
# Click on File → Import... → Maven → Existing Maven Project
# Select the gatling folder within the performance repository

== Configurable Parameters ==
List of all available System-Properties and JVM-Arguments:

; protocol: Which protocol to use. ''Possible values are: '''"http"''' or '''"https"'''. Default value: '''"http"'''.''

; host: Which host to use. ''Possible values are: '''"localhost"''', '''"10.0.0.1"''' or if you want to stress several groupware servers, to bypass a loadbalancer for example, then you can use comma-separated IPs or hostnames '''"10.0.0.1,10.0.0.2,localhost"'''. Default value: '''"localhost"'''.''

; users: How many concurrent users to simulate. ''Default value: '''"5"'''.''

; durationTime: Duration time of the simulation. ''Default value: '''"30"'''.''

; durationUnit: The Unit of the durationTime. ''Possible values are: '''"SECONDS"''', '''"MINUTES"''', '''"HOURS"''' or '''"DAYS"'''. Default value: '''"SECONDS"'''.''

; successpercent: Successful responses in percentage. ''Default value: '''"100"'''.''

; reqpersec: Mean number of requests per second (lower bound). ''Default value: '''"0"'''.''

; resptime: Mean response time (lower bound). ''Default value: '''"0"'''.''

; csv_users: Name of the CSV-File for feeding the requests. ''Default value: '''"ox_user_credentials.csv"'''.''

; syncmsgmax: How many objects to synchronize. ''Relevant only for '''QAPerfUSM'''. Default value: '''"50"'''.''

; pimObjects: How many PIM Objects, e.g. contacts, should be created. ''Default value: '''"5"'''.''

=== Snippet from the <properties>-section in the pom.xml ===
<properties>
<protocol>http</protocol>
<host>localhost</host>
<port>80</port>
<users>5</users>
<durationTime>30</durationTime>
<durationUnit>SECONDS</durationUnit>
<successpercent>100</successpercent>
<reqpersec>0</reqpersec>
<resptime>0</resptime>
<csv_users>ox_user_credentials.csv</csv_users>
<syncmsgmax>50</syncmsgmax>
<pimObjects>5</pimObjects>
</properties>

=== Snippet from the <jvmArgs>-section in the pom.xml ===
<jvmArgs>
<jvmArg>-Dprotocol=${protocol}</jvmArg>
<jvmArg>-Dhost=${host}</jvmArg>
<jvmArg>-Dport=${port}</jvmArg>
<jvmArg>-Dcsv_users=${csv_users}</jvmArg>
<jvmArg>-Dusers=${users}</jvmArg>
<jvmArg>-DdurationTime=${durationTime}</jvmArg>
<jvmArg>-DdurationUnit=${durationUnit}</jvmArg>
<jvmArg>-Dsuccesspercent=${successpercent}</jvmArg>
<jvmArg>-Dreqpersec=${reqpersec}</jvmArg>
<jvmArg>-Dresptime=${resptime}</jvmArg>
<jvmArg>-Dsyncmsgmax=${syncmsgmax}</jvmArg>
<jvmArg>-DpimObjects=${pimObjects}</jvmArg>
</jvmArgs>

== Test Execution ==

=== Pre-Requisites for the Open-Xchange Groupware Server ===
==== Disabling rate limitation ====
* Modify the parameter maxRateLenientClients @server.properties:
$ vim /opt/etc/open-xchange/etc/server.properties
* Specify a new User-Agent which is excluded from rate limit checks
"GATLING*"

==== Resources/Data ====
In the data folder you can find an sample csv file which is used to perform a login. If you want to use your own CSV-File place it into the data directory.

* Structure of the csv file:
<code>
username,password
user1,secret
user2,secret
user3,secret
...
user998,secret
user999,secret
user1000,secret
</code>

== Practical hints and tips ==
* If you want to run tests for more than 24h, uncomment the "timeOut" → "simulation" property at gatling.conf and define a value of more than 24h (in seconds).
* If you experience OutOfMemory issues when generating charts, adjust "charting" → "accuracy" to a higher value. This will lower the accuracy of the generated graphs. Especially for long-running tests, this could be set to 100ms.

AppSuite:Load Tests

2014-07-29T14:15:06Z

Zap23: /* Building with SBT */

2014-04-11T13:03:34Z

Zap23: /* Pre-compiled version of the gatling tests */

== Software Requirements ==
* Java SE JDK6 or JDK7
* Git

== Getting Performance Repository ==
* Cloning Repository
<code>$ git clone https://git.open-xchange.com/git/wd/testing/performance</code>

* Checkout a branch, for example ''develop''
<code>$ git checkout develop</code>

== Development Environment ==
If you want to execute the tests via an IDE like Eclipse then you will also need to install the following software:
* [https://www.eclipse.org Eclipse 4.2] or later
* [http://scala-ide.org Scala IDE plugin]
* Maven integration from the default update site '''m2e'''
* [http://alchim31.free.fr/m2e-scala/update-site m2e-scala]
* [http://maven.apache.org/ Apache Maven]

=== Importing Project into Eclipse ===
# Open Eclipse
# Click on File → Import... → Maven → Existing Maven Project
# Select the gatling folder within the performance repository

== Configurable Parameters ==
List of all available System-Properties and JVM-Arguments:

; protocol: Which protocol to use. ''Possible values are: '''"http"''' or '''"https"'''. Default value: '''"http"'''.''

; host: Which host to use. ''Possible values are: '''"localhost"''', '''"10.0.0.1"''' or if you want to stress several groupware servers, to bypass a loadbalancer for example, then you can use comma-separated IPs or hostnames '''"10.0.0.1,10.0.0.2,localhost"'''. Default value: '''"localhost"'''.''

; users: How many concurrent users to simulate. ''Default value: '''"5"'''.''

; durationTime: Duration time of the simulation. ''Default value: '''"30"'''.''

; durationUnit: The Unit of the durationTime. ''Possible values are: '''"SECONDS"''', '''"MINUTES"''', '''"HOURS"''' or '''"DAYS"'''. Default value: '''"SECONDS"'''.''

; successpercent: Successful responses in percentage. ''Default value: '''"100"'''.''

; reqpersec: Mean number of requests per second (lower bound). ''Default value: '''"0"'''.''

; resptime: Mean response time (lower bound). ''Default value: '''"0"'''.''

; csv_users: Name of the CSV-File for feeding the requests. ''Default value: '''"ox_user_credentials.csv"'''.''

; syncmsgmax: How many objects to synchronize. ''Relevant only for '''QAPerfUSM'''. Default value: '''"50"'''.''

; pimObjects: How many PIM Objects, for example contacts, should be created. ''Relevant only for PIM-Simulations like '''QAPerfContacts''' or '''QAPerfAppointments'''. Default value: '''"5"'''.''

=== Snippet from the <properties>-section in the pom.xml ===
<properties>
<protocol>http</protocol>
<host>localhost</host>
<port>80</port>
<users>5</users>
<durationTime>30</durationTime>
<durationUnit>SECONDS</durationUnit>
<successpercent>100</successpercent>
<reqpersec>0</reqpersec>
<resptime>0</resptime>
<csv_users>ox_user_credentials.csv</csv_users>
<syncmsgmax>50</syncmsgmax>
<pimObjects>5</pimObjects>
</properties>

=== Snippet from the <jvmArgs>-section in the pom.xml ===
<jvmArgs>
<jvmArg>-Dprotocol=${protocol}</jvmArg>
<jvmArg>-Dhost=${host}</jvmArg>
<jvmArg>-Dport=${port}</jvmArg>
<jvmArg>-Dcsv_users=${csv_users}</jvmArg>
<jvmArg>-Dusers=${users}</jvmArg>
<jvmArg>-DdurationTime=${durationTime}</jvmArg>
<jvmArg>-DdurationUnit=${durationUnit}</jvmArg>
<jvmArg>-Dsuccesspercent=${successpercent}</jvmArg>
<jvmArg>-Dreqpersec=${reqpersec}</jvmArg>
<jvmArg>-Dresptime=${resptime}</jvmArg>
<jvmArg>-Dsyncmsgmax=${syncmsgmax}</jvmArg>
<jvmArg>-DpimObjects=${pimObjects}</jvmArg>
</jvmArgs>

== Test Execution ==

=== Pre-Requisites for the Open-Xchange Groupware Server ===
==== Disabling rate limitation ====
* Modify the parameter maxRateLenientClients @server.properties:
$ vim /opt/etc/open-xchange/etc/server.properties
* Specify a new User-Agent which is excluded from rate limit checks
"GATLING*"

=== Pre-compiled version of the gatling tests ===
Execute the gatling tests via bash script (Linux) or batch file (Windows).

* Unzip ox-gatling-*-bin.zip
* Change working directory
$ cd Downloads/ox-gatling-1.0.0-SNAPSHOT
* Please '''adjust''' the ''JAVA_OPTS'' in the scripts ''bin/box-gatling.sh'' or ''bin/ox-gatling.bat'' to match your needs.
* Execute the script
$ bin/ox-gatling.sh

Now you will see some output of the compilation process but finally you should be able to start the simulation by entering a number.

<code>
Choose a simulation number:
[0] com.openexchange.test.performance.gatling.tests.QAPerfOX6
[1] com.openexchange.test.performance.gatling.tests.QAPerfOXAppSuite
[2] com.openexchange.test.performance.gatling.tests.QAPerfContacts
[3] com.openexchange.test.performance.gatling.tests.QAPerfAppointments
[4] com.openexchange.test.performance.gatling.tests.QAPerfUSM
</code>

== Practical hints and tips ==
* If you want to run tests for more than 24h, uncomment the "timeOut" → "simulation" property at gatling.conf and define a value of more than 24h (in seconds).
* If you experience OutOfMemory issues when generating charts, adjust "charting" → "accuracy" to a higher value. This will lower the accuracy of the generated graphs. Especially for long-running tests, this could be set to 100ms.

AppSuite:Load Tests

2014-04-11T13:01:43Z

Zap23: /* Test Execution */

== Software Requirements ==
* Java SE JDK6 or JDK7
* Git

== Getting Performance Repository ==
* Cloning Repository
<code>$ git clone https://git.open-xchange.com/git/wd/testing/performance</code>

* Checkout a branch, for example ''develop''
<code>$ git checkout develop</code>

== Development Environment ==
If you want to execute the tests via an IDE like Eclipse then you will also need to install the following software:
* [https://www.eclipse.org Eclipse 4.2] or later
* [http://scala-ide.org Scala IDE plugin]
* Maven integration from the default update site '''m2e'''
* [http://alchim31.free.fr/m2e-scala/update-site m2e-scala]
* [http://maven.apache.org/ Apache Maven]

=== Importing Project into Eclipse ===
# Open Eclipse
# Click on File → Import... → Maven → Existing Maven Project
# Select the gatling folder within the performance repository

== Configurable Parameters ==
List of all available System-Properties and JVM-Arguments:

; protocol: Which protocol to use. ''Possible values are: '''"http"''' or '''"https"'''. Default value: '''"http"'''.''

; host: Which host to use. ''Possible values are: '''"localhost"''', '''"10.0.0.1"''' or if you want to stress several groupware servers, to bypass a loadbalancer for example, then you can use comma-separated IPs or hostnames '''"10.0.0.1,10.0.0.2,localhost"'''. Default value: '''"localhost"'''.''

; users: How many concurrent users to simulate. ''Default value: '''"5"'''.''

; durationTime: Duration time of the simulation. ''Default value: '''"30"'''.''

; durationUnit: The Unit of the durationTime. ''Possible values are: '''"SECONDS"''', '''"MINUTES"''', '''"HOURS"''' or '''"DAYS"'''. Default value: '''"SECONDS"'''.''

; successpercent: Successful responses in percentage. ''Default value: '''"100"'''.''

; reqpersec: Mean number of requests per second (lower bound). ''Default value: '''"0"'''.''

; resptime: Mean response time (lower bound). ''Default value: '''"0"'''.''

; csv_users: Name of the CSV-File for feeding the requests. ''Default value: '''"ox_user_credentials.csv"'''.''

; syncmsgmax: How many objects to synchronize. ''Relevant only for '''QAPerfUSM'''. Default value: '''"50"'''.''

; pimObjects: How many PIM Objects, for example contacts, should be created. ''Relevant only for PIM-Simulations like '''QAPerfContacts''' or '''QAPerfAppointments'''. Default value: '''"5"'''.''

=== Snippet from the <properties>-section in the pom.xml ===
<properties>
<protocol>http</protocol>
<host>localhost</host>
<port>80</port>
<users>5</users>
<durationTime>30</durationTime>
<durationUnit>SECONDS</durationUnit>
<successpercent>100</successpercent>
<reqpersec>0</reqpersec>
<resptime>0</resptime>
<csv_users>ox_user_credentials.csv</csv_users>
<syncmsgmax>50</syncmsgmax>
<pimObjects>5</pimObjects>
</properties>

=== Snippet from the <jvmArgs>-section in the pom.xml ===
<jvmArgs>
<jvmArg>-Dprotocol=${protocol}</jvmArg>
<jvmArg>-Dhost=${host}</jvmArg>
<jvmArg>-Dport=${port}</jvmArg>
<jvmArg>-Dcsv_users=${csv_users}</jvmArg>
<jvmArg>-Dusers=${users}</jvmArg>
<jvmArg>-DdurationTime=${durationTime}</jvmArg>
<jvmArg>-DdurationUnit=${durationUnit}</jvmArg>
<jvmArg>-Dsuccesspercent=${successpercent}</jvmArg>
<jvmArg>-Dreqpersec=${reqpersec}</jvmArg>
<jvmArg>-Dresptime=${resptime}</jvmArg>
<jvmArg>-Dsyncmsgmax=${syncmsgmax}</jvmArg>
<jvmArg>-DpimObjects=${pimObjects}</jvmArg>
</jvmArgs>

== Test Execution ==

=== Pre-Requisites for the Open-Xchange Groupware Server ===
==== Disabling rate limitation ====
* Modify the parameter maxRateLenientClients @server.properties:
$ vim /opt/etc/open-xchange/etc/server.properties
* Specify a new User-Agent which is excluded from rate limit checks
"GATLING*"

=== Pre-compiled version of the gatling tests ===
Execute the gatling tests via bash script (Linux) or batch file (Windows).

* Unzip ox-gatling-*-bin.zip
* Change working directory
$ cd Downloads/ox-gatling-1.0.0-SNAPSHOT
* Please '''adjust''' the ''JAVA_OPTS'' in the scripts ''bin/box-gatling.sh'' or ''bin/ox-gatling.bat'' to match your needs.
* Execute the script
$ bin/ox-gatling.sh

Now you will see some output of the compilation process but finally you should be able to start the simulation by entering a number.

== Practical hints and tips ==
* If you want to run tests for more than 24h, uncomment the "timeOut" → "simulation" property at gatling.conf and define a value of more than 24h (in seconds).
* If you experience OutOfMemory issues when generating charts, adjust "charting" → "accuracy" to a higher value. This will lower the accuracy of the generated graphs. Especially for long-running tests, this could be set to 100ms.

AppSuite:Load Tests

2014-04-11T12:40:19Z

Zap23: /* Pre-Requisites for the Open-Xchange Groupware Server */

AppSuite:Load Tests

2014-04-11T12:38:15Z

Zap23: /* Pre-Requisites for the Open-Xchange Groupware Server */

AppSuite:Load Tests

2014-04-11T12:37:35Z

Zap23: /* Pre-Requisites for the OX Groupware Server */