Skip to content

README update #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nyco wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README update #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
Test suite for ESL's branch of ejabberd
=======================================
# Mercutio [![Build Status](https://travis-ci.org/esl/ejabberd_tests.svg?branch=master)](https://travis-ci.org/esl/ejabberd_tests)

This repository contains test code for ejabberd/MongooseIM.
It's used mainly for [ESL's branch of ejabberd](https://github.com/esl/MongooseIM),
This repository contains test code for MongooseIM and ejabberd.

It is used mainly for [ESL's MongooseIM](https://github.com/esl/MongooseIM),
but one that may be reused in other projects.

This tool, mercutio, is using the [ESL's escalus](https://github.com/esl/escalus) XMPP client, and can be used by [ESL's amoc](https://github.com/esl/amoc) for load tests.

## How to run tests

There are 2 ways of running the tests:
* quick (`make quicktest`) - this command tests the current configuration of the server
* full (`make test`) - this command tests all server configurations defined in test.config file - [see the section on various server configurations](#testing-various-server-configurations)
Expand Down Expand Up @@ -37,7 +40,7 @@ In order to do this define configuration variables in `test.config` file, for ex
{auth_method, "internal"}]}
]}.
```
For each configuration the given variables merged with values from `node1_vars.config`
For each configuration the given variables merged with values from `node1_vars.config`
will be overlaid with the original `ejabberd.cfg` file and ejabberd will be restarted.


Expand Down Expand Up @@ -91,3 +94,10 @@ In the `end_per_suite` previously backuped config file is restored and
the server is restarted again. See [ejabberd_node_utils](tests/ejabberd_node_utils.erl)
for more information.

# Naming

According to [Wikipedia](https://en.wikipedia.org/wiki/Characters_in_Romeo_and_Juliet#Mercutio), Mercutio, of the House Escalus, is the cousin of Prince Escalus, and is a close friend of Romeo Montague.

It follows the great tradition to use characters of William Shakespeare's Romeo and Juliet in the XMPP specifications.

mercutio's former name was 'ejabberd_tests'.