Skip to content
This repository has been archived by the owner on Mar 11, 2019. It is now read-only.

Commit

Permalink
Added documentation about the syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
JohanLorenzo committed Jul 17, 2015
1 parent e4504aa commit 06c4876
Showing 1 changed file with 103 additions and 1 deletion.
104 changes: 103 additions & 1 deletion README.md
Expand Up @@ -30,7 +30,109 @@ markdownTestfileToJson([inputFile1, inputFile2]).then(function(testsuites) {
});
```

## License
# Syntax
## General structure
``` markdown
# Suite Name

## product.app.test_case_id
`decorator`

Test instructions
```

## Suite name
To be deprecated.

## IDs
Valid IDs are lower case. Words are separated by either dots (.) or underscores (_).
The recommended format is `product.app.test_case_id`

``` markdown
Valid
## fxos.sms.send_mms

Not valid
## fxos.sms.send_MMS
## fxos.sms.send-mms
```

## Decorators
They are used to describe the test case right above it (no blank line in the middle).
One decorator is recommended (but not mandatory): ``` `bug n` ```, with n the bug number that introduced the feature on [Bugzilla](https://bugzilla.mozilla.org/).
You can also define the user story that introduced the feature on [Aha](http://aha.io): ``` `story n` ```.
You can choose to not activate a test with one of these decorator: ``` `draft` `disabled` `xfail` ```. If none of these decorator is provided, the test will be considered active.

``` markdown
Valid
## fxos.sms.send_mms
`bug 1`

Not valid
## fxos.sms.send_mms

`bug 1`

## fxos.sms.send_mms
`disabled`
```

## Suite matrices
You can specify a set of variable common to many test cases. By defining a [markdown table](https://help.github.com/articles/github-flavored-markdown/#tables). Put the
table at the top of the file. For example:

``` markdown
# SMS suite

| TMobile | Wi-FI | No Internet | 2G | 3G | Multiple SIMS | Reference Workload | AT&T | Automatic Download | Delivery Reports | Airplane Mode | Dual SIM priority | Multiple Recipient Thread |
:-- |:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:|:-:
fxos.sms.send_sms | x | x | x | x | x | x | x | x | x | x | x | x | x
fxos.sms.send_mms | x | x | x | x | x | x | x | x | x | x | x | x | x
fxos.sms.forward_sms | | | x | | | | | x | | | | |
fxos.sms.call_recipient | | | x | | | | | x | | | | |

## fxos.sms.send_sms
`bug 1`

Send a text message to another phone number.

## fxos.sms.send_mms
`bug 2`

Receive a text message from another phone number.

## fxos.sms.forward_sms
`bug 3`

Send an SMS you received to another contact.

## fxos.sms.call_recipient
`bug 4`

From a text conversation, perform a call to your contact.

```
Please note that the ID must be defined below

## Test case matrices
A single test case can have multiple variables.

``` markdown
## fxos.sms.text_new_number
`bug 5`

Create a new text message and add the following recipients:

recipients | should pass
---- | ----
123 | yes
+++ | no
contact name | yes
```



# License

MIT

Expand Down

0 comments on commit 06c4876

Please sign in to comment.