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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
Unit-Testing
============
PHP unit testing
----------------
Getting PHPUnit
~~~~~~~~~~~~~~~
ownCloud uses PHPUnit >= 3.7 for unit testing.
To install it, either get it via your packagemanager::
sudo apt-get install phpunit
or install it via PEAR::
pear config-set auto_discover 1
pear install pear.phpunit.de/PHPUnit
After the installation the ''phpunit'' command is available.
Writing PHP unit tests
~~~~~~~~~~~~~~~~~~~~~~
To get started, do the following:
- Create a directory called ``tests`` in the top level of your application
- Create a php file in the directory and ``require_once`` your class which you want to test.
Then you can simply run the created test with phpunit.
.. note:: If you use owncloud functions in your class under test (i.e: OC::getUser()) you'll need to bootstrap owncloud or use dependency injection.
.. note:: You'll most likely run your tests under a different user than the web server. This might cause problems with your PHP settings (i.e: open_basedir) and requires you to adjust your configuration.
An example for a simple test would be:
:file:`/srv/http/owncloud/apps/myapp/tests/testsuite.php`
.. code-block:: php
<?php
require_once("../myfolder/myfunction.php");
class TestAddTwo extends PHPUnit_Framework_TestCase {
public function testAddTwo(){
$this->assertEquals(5, addTwo(3));
}
}
?>
:file:`/srv/http/owncloud/apps/myapp/tests/testsuite.php`
.. code-block:: php
<?php
function addTwo($number){
return $number + 2;
}
?>
In :file:`/srv/http/owncloud/apps/myapp/` you run the test with::
phpunit tests/testsuite.php
For more resources on PHPUnit visit: http://www.phpunit.de/manual/current/en/writing-tests-for-phpunit.html
Bootstrapping ownCloud
~~~~~~~~~~~~~~~~~~~~~~
If you use ownCloud functions or classes in your code, you'll need to make them available to your test by bootstrapping ownCloud.
To do this, you'll need to provide the ``--bootstrap`` argument when running PHPUnit
:file:`/srv/http/owncloud`::
phpunit --bootstrap tests/bootstrap.php apps/myapp/tests/testsuite.php
If you run the test under a different user than your web server, you'll have to
adjust your php.ini and file rights.
:file:`/etc/php/php.ini`::
open_basedir = none
:file:`/srv/http/owncloud`::
su -c "chmod a+r config/config.php"
su -c "chmod a+rx data/"
su -c "chmod a+w data/owncloud.log"
Running unit tests for the ownCloud core project
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The core project provides a script that runs all the core unit tests using different database backends like sqlite, mysql, pgsql, oci (for Oracle)::
./autotest.sh
To run tests only for sqlite::
./autotest.sh sqlite
To run a specific test suite (note that the test file path is relative to the "tests" directory)::
./autotest.sh sqlite lib/share/share.php
Further Reading
~~~~~~~~~~~~~~~
- http://googletesting.blogspot.de/2008/08/by-miko-hevery-so-you-decided-to.html
- http://www.phpunit.de/manual/current/en/writing-tests-for-phpunit.html
- http://www.youtube.com/watch?v=4E4672CS58Q&feature=bf_prev&list=PLBDAB2BA83BB6588E
- Clean Code: A Handbook of Agile Software Craftsmanship (Robert C. Martin)
JavaScript unit testing for core
--------------------------------
JavaScript Unit testing for **core** and **core apps** is done using the `Karma <http://karma-runner.github.io>`_ test runner with `Jasmine <http://pivotal.github.io/jasmine/>`_.
Installing Node JS
~~~~~~~~~~~~~~~~~~
To run the JavaScript unit tests you will need to install **Node JS**.
You can get it here: http://nodejs.org/
After that you will need to setup the **Karma** test environment.
The easiest way to do this is to run the automatic test script first, see next section.
Running all tests
~~~~~~~~~~~~~~~~~
To run all tests, just run::
./autotest-js.sh
This will also automatically set up your test environment.
Debugging tests in the browser
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To debug tests in the browser, you need to run **Karma** in browser mode::
karma start tests/karma.config.js
From there, open the URL http://localhost:9876 in a web browser.
On that page, click on the "Debug" button.
An empty page will appear, from which you must open the browser console (F12 in Firefox/Chrome).
Every time you reload the page, the unit tests will be relaunched and will output the results in the browser console.
Unit test paths
~~~~~~~~~~~~~~~
JavaScript unit test examples can be found in :file:`apps/files/tests/js/`
Unit tests for the core app JavaScript code can be found in :file:`core/js/tests/specs`
Documentation
~~~~~~~~~~~~~
Here are some useful links about how to write unit tests with Jasmine and Sinon:
- Karma test runner: http://karma-runner.github.io
- Jasmine: http://pivotal.github.io/jasmine
- Sinon (for mocking and stubbing): http://sinonjs.org/
|
