summaryrefslogtreecommitdiffstats
path: root/doc/afb-tests-overview.md
blob: a4632d49a2fc0c890ffb8018e270f9084c3123a8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# Overview of tests shipped with AFB-Daemon
    Version: 1
    Date:    30 May 2016
    Author:  Manuel Bachmann


## List of tests
  Here are the tests shipped in the source tree:
 * **afb-client-demo** (command-line WebSockets)
 * **token-websock.qml** (Qt/QML WebSockets)
 * ***.html** (HTML5/JS HTTP-REST & WebSockets)


## Detail of tests

### afb-client-demo (command-line WebSockets)

This clients interactively calls plugins APIs from the command line, using the binder [WebSockets](https://en.wikipedia.org/wiki/WebSocket) facility.

If _afb-daemon_ has been launched with the following parameters:
```
$ afb-daemon --port=1234 --token=123456 [...]
```

Then run the client with :
```
afb-client-demo ws://localhost:1234/api?token=123456 <plugin> <verb>
```

For instance, to initialize the Audio plugin from the command line :
```
afb-client-demo ws://localhost:1234/api?token=123456 auth connect
(copy-paste the "token" field from the response)
afb-client-demo ws://localhost:1234/api?token=123456 audio init <TOKEN>
```

<br />



### token-websock.qml (Qt/QML WebSockets)

If _afb-daemon_ has been launched with the following parameters:
```
$ afb-daemon --port=1234 --token=123456 [...]
```
and Qt5 is installed, on **Ubuntu 16.04**:
```
$ apt-get install qmlscene qml-module-qtwebsockets qml-module-qtquick-controls
```
or on **Fedora 23** :
```
$ dnf install qt5-qtdeclarative-devel qt5-qtwebsockets-devel qt5-qtquickcontrols
```

Then run the client with :
```
qmlscene test/token-websock.qml
```
and interactively press the buttons, "Connect", "Refresh", "Logout".

<br />


### *.html (HTML5/JS HTTP-REST & WebSockets)

If _afb-daemon_ has been launched with the following parameters:
```
$ afb-daemon --port=1234 --rootdir=$PWD/test [...]
```
_("$PWD/test_" being the "test" subdirectory of the source tree)_


Then open your preferred Web browser, connect to the following URL:
```
http://localhost:1234
```
and interactively run the various tests.