summaryrefslogtreecommitdiff
path: root/_test/cases/inc/remote.test.php
blob: c4f0cd2c221bb61f86fdfe615450270619ae58d9 (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
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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
<?php

require_once DOKU_INC . 'inc/init.php';
require_once DOKU_INC . 'inc/RemoteAPICore.php';

Mock::generate('Doku_Plugin_Controller');

class RemoteAPICoreTest {

    function __getRemoteInfo() {
        return array(
            'wiki.stringTestMethod' => array(
                'args' => array(),
                'return' => 'string',
                'doc' => 'Test method',
                'name' => 'stringTestMethod',
            ), 'wiki.intTestMethod' => array(
                'args' => array(),
                'return' => 'int',
                'doc' => 'Test method',
                'name' => 'intTestMethod',
            ), 'wiki.floatTestMethod' => array(
                'args' => array(),
                'return' => 'float',
                'doc' => 'Test method',
                'name' => 'floatTestMethod',
            ), 'wiki.dateTestMethod' => array(
                'args' => array(),
                'return' => 'date',
                'doc' => 'Test method',
                'name' => 'dateTestMethod',
            ), 'wiki.fileTestMethod' => array(
                'args' => array(),
                'return' => 'file',
                'doc' => 'Test method',
                'name' => 'fileTestMethod',
            ), 'wiki.voidTestMethod' => array(
                'args' => array(),
                'return' => 'void',
                'doc' => 'Test method',
                'name' => 'voidTestMethod',
            ),  'wiki.oneStringArgMethod' => array(
                'args' => array('string'),
                'return' => 'string',
                'doc' => 'Test method',
                'name' => 'oneStringArgMethod',
            ), 'wiki.twoArgMethod' => array(
                'args' => array('string', 'int'),
                'return' => 'array',
                'doc' => 'Test method',
                'name' => 'twoArgMethod',
            ), 'wiki.twoArgWithDefaultArg' => array(
                'args' => array('string', 'string'),
                'return' => 'string',
                'doc' => 'Test method',
                'name' => 'twoArgWithDefaultArg',
            ), 'wiki.publicCall' => array(
                'args' => array(),
                'return' => 'boolean',
                'doc' => 'testing for public access',
                'name' => 'publicCall',
                'public' => 1
            )
        );
    }
    function stringTestMethod() { return 'success'; }
    function intTestMethod() { return 42; }
    function floatTestMethod() { return 3.14159265; }
    function dateTestMethod() { return 2623452346; }
    function fileTestMethod() { return 'file content'; }
    function voidTestMethod() { return null; }
    function oneStringArgMethod($arg) {return $arg; }
    function twoArgMethod($string, $int) { return array($string, $int); }
    function twoArgWithDefaultArg($string1, $string2 = 'default') { return array($string1, $string2); }
    function publicCall() {return true;}

}

class remote_plugin_testplugin extends DokuWiki_Remote_Plugin {
    function _getMethods() {
        return array(
            'method1' => array(
                'args' => array(),
                'return' => 'void'
            ), 'methodString' => array(
                'args' => array(),
                'return' => 'string'
            ), 'method2' => array(
                'args' => array('string', 'int'),
                'return' => 'array',
                'name' => 'method2',
            ), 'method2ext' => array(
                'args' => array('string', 'int', 'bool'),
                'return' => 'array',
                'name' => 'method2',
            ), 'publicCall' => array(
                'args' => array(),
                'return' => 'boolean',
                'doc' => 'testing for public access',
                'name' => 'publicCall',
                'public' => 1
            )
        );
    }

    function method1() { return null; }
    function methodString() { return 'success'; }
    function method2($str, $int, $bool = false) { return array($str, $int, $bool); }
    function publicCall() {return true;}

}


class remote_test extends UnitTestCase {

    var $originalConf;
    var $userinfo;

    var $remote;

    function setUp() {
        global $plugin_controller;
        global $conf;
        global $USERINFO;

        parent::setUp();
        $pluginManager = new MockDoku_Plugin_Controller();
        $pluginManager->setReturnValue('getList', array('testplugin'));
        $pluginManager->setReturnValue('load', new remote_plugin_testplugin());
        $plugin_controller = $pluginManager;

        $this->originalConf = $conf;
        $conf['remote'] = 1;
        $conf['remoteuser'] = '!!not set!!';
        $conf['useacl'] = 0;

        $this->userinfo = $USERINFO;
        $this->remote = new RemoteAPI();
    }

    function tearDown() {
        global $conf;
        global $USERINFO;
        $conf = $this->originalConf;
        $USERINFO = $this->userinfo;

    }

    function test_pluginMethods() {
        $methods = $this->remote->getPluginMethods();
        $actual = array_keys($methods);
        sort($actual);
        $expect = array('plugin.testplugin.method1', 'plugin.testplugin.method2', 'plugin.testplugin.methodString', 'plugin.testplugin.method2ext', 'plugin.testplugin.publicCall');
        sort($expect);
        $this->assertEqual($expect,$actual);
    }

    function test_hasAccessSuccess() {
        $this->assertTrue($this->remote->hasAccess());
    }

    function test_hasAccessFail() {
        global $conf;
        $conf['remote'] = 0;
        $this->assertFalse($this->remote->hasAccess());
    }

    function test_hasAccessFailAcl() {
        global $conf;
        $conf['useacl'] = 1;
        $this->assertFalse($this->remote->hasAccess());
    }

    function test_hasAccessSuccessAclEmptyRemoteUser() {
        global $conf;
        $conf['useacl'] = 1;
        $conf['remoteuser'] = '';

        $this->assertTrue($this->remote->hasAccess());
    }

    function test_hasAccessSuccessAcl() {
        global $conf;
        global $USERINFO;
        $conf['useacl'] = 1;
        $conf['remoteuser'] = '@grp,@grp2';
        $USERINFO['grps'] = array('grp');

        $this->assertTrue($this->remote->hasAccess());
    }

    function test_hasAccessFailAcl2() {
        global $conf;
        global $USERINFO;
        $conf['useacl'] = 1;
        $conf['remoteuser'] = '@grp';
        $USERINFO['grps'] = array('grp1');

        $this->assertFalse($this->remote->hasAccess());
    }


    function test_forceAccessSuccess() {
        global $conf;
        $conf['remote'] = 1;
        $this->remote->forceAccess(); // no exception should occur
    }

    function test_forceAccessFail() {
        global $conf;
        $conf['remote'] = 0;
        $this->expectException('RemoteException');
        $this->remote->forceAccess();
    }

    function test_generalCoreFunctionWithoutArguments() {
        global $conf;
        $conf['remote'] = 1;
        $remoteApi = new RemoteApi();
        $remoteApi->getCoreMethods(new RemoteAPICoreTest());

        $this->assertEqual($remoteApi->call('wiki.stringTestMethod'), 'success');
        $this->assertEqual($remoteApi->call('wiki.intTestMethod'), 42);
        $this->assertEqual($remoteApi->call('wiki.floatTestMethod'), 3.14159265);
        $this->assertEqual($remoteApi->call('wiki.dateTestMethod'), 2623452346);
        $this->assertEqual($remoteApi->call('wiki.fileTestMethod'), 'file content');
        $this->assertEqual($remoteApi->call('wiki.voidTestMethod'), null);
    }

    function test_generalCoreFunctionOnArgumentMismatch() {
        global $conf;
        $conf['remote'] = 1;
        $remoteApi = new RemoteApi();
        $remoteApi->getCoreMethods(new RemoteAPICoreTest());

        $this->expectException('RemoteException');
        $remoteApi->call('wiki.voidTestMethod', array('something'));
    }

    function test_generalCoreFunctionWithArguments() {
        global $conf;
        $conf['remote'] = 1;

        $remoteApi = new RemoteApi();
        $remoteApi->getCoreMethods(new RemoteAPICoreTest());

        $this->assertEqual($remoteApi->call('wiki.oneStringArgMethod', array('string')), 'string');
        $this->assertEqual($remoteApi->call('wiki.twoArgMethod', array('string', 1)), array('string' , 1));
        $this->assertEqual($remoteApi->call('wiki.twoArgWithDefaultArg', array('string')), array('string', 'default'));
        $this->assertEqual($remoteApi->call('wiki.twoArgWithDefaultArg', array('string', 'another')), array('string', 'another'));
    }

    function test_pluginCallMethods() {
        global $conf;
        $conf['remote'] = 1;

        $remoteApi = new RemoteApi();
        $this->assertEqual($remoteApi->call('plugin.testplugin.method1'), null);
        $this->assertEqual($remoteApi->call('plugin.testplugin.method2', array('string', 7)), array('string', 7, false));
        $this->assertEqual($remoteApi->call('plugin.testplugin.method2ext', array('string', 7, true)), array('string', 7, true));
        $this->assertEqual($remoteApi->call('plugin.testplugin.methodString'), 'success');
    }

    function test_notExistingCall() {
        global $conf;
        $conf['remote'] = 1;

        $remoteApi = new RemoteApi();
        $this->expectException('RemoteException');
        $remoteApi->call('dose not exist');
    }

    function test_publicCallCore() {
        global $conf;
        $conf['useacl'] = 1;
        $remoteApi = new RemoteApi();
        $remoteApi->getCoreMethods(new RemoteAPICoreTest());
        $this->assertTrue($remoteApi->call('wiki.publicCall'));
    }

    function test_publicCallPlugin() {
        global $conf;
        $conf['useacl'] = 1;
        $remoteApi = new RemoteApi();
        $this->assertTrue($remoteApi->call('plugin.testplugin.publicCall'));
    }

    function test_publicCallCoreDeny() {
        global $conf;
        $conf['useacl'] = 1;
        $remoteApi = new RemoteApi();
        $remoteApi->getCoreMethods(new RemoteAPICoreTest());
        $this->expectException('RemoteAccessDenied');
        $remoteApi->call('wiki.stringTestMethod');
    }

    function test_publicCallPluginDeny() {
        global $conf;
        $conf['useacl'] = 1;
        $remoteApi = new RemoteApi();
        $this->expectException('RemoteAccessDenied');
        $remoteApi->call('plugin.testplugin.methodString');
    }

}