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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
|
<?php
declare(strict_types=1);
/**
* FullTextSearch - Full text search framework for Nextcloud
*
* This file is licensed under the Affero General Public License version 3 or
* later. See the COPYING file.
*
* @author Maxence Lange <maxence@artificial-owl.com>
* @copyright 2018
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\FullTextSearch\Command;
use Exception;
use OC\Core\Command\InterruptedException;
use OCA\FullTextSearch\ACommandBase;
use OCA\FullTextSearch\Exceptions\InterruptException;
use OCA\FullTextSearch\Exceptions\ProviderDoesNotExistException;
use OCA\FullTextSearch\Exceptions\ProviderIsNotCompatibleException;
use OCA\FullTextSearch\Exceptions\ProviderIsNotUniqueException;
use OCA\FullTextSearch\Exceptions\RunnerAlreadyUpException;
use OCA\FullTextSearch\Exceptions\TickDoesNotExistException;
use OCA\FullTextSearch\Model\IndexOptions;
use OCA\FullTextSearch\Model\Runner;
use OCA\FullTextSearch\Model\SearchRequest;
use OCA\FullTextSearch\Model\SearchResult;
use OCA\FullTextSearch\Provider\TestProvider;
use OCA\FullTextSearch\Service\IndexService;
use OCA\FullTextSearch\Service\MiscService;
use OCA\FullTextSearch\Service\PlatformService;
use OCA\FullTextSearch\Service\ProviderService;
use OCA\FullTextSearch\Service\RunningService;
use OCA\FullTextSearch\Service\TestService;
use OCP\AppFramework\QueryException;
use OCP\FullTextSearch\IFullTextSearchPlatform;
use OCP\FullTextSearch\IFullTextSearchProvider;
use OCP\FullTextSearch\Model\DocumentAccess;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
/**
* Class Test
*
* @package OCA\FullTextSearch\Command
*/
class Test extends ACommandBase {
const DELAY_STABILIZE_PLATFORM = 3;
/** @var RunningService */
private $runningService;
/** @var PlatformService */
private $platformService;
/** @var ProviderService */
private $providerService;
/** @var IndexService */
private $indexService;
/** @var TestService */
private $testService;
/** @var MiscService */
private $miscService;
/** @var Runner */
private $runner;
/** @var boolean */
private $isJson = false;
/**
* Index constructor.
*
* @param RunningService $runningService
* @param ProviderService $providerService
* @param IndexService $indexService
* @param PlatformService $platformService
* @param TestService $testService
* @param MiscService $miscService
*/
public function __construct(
RunningService $runningService, PlatformService $platformService,
ProviderService $providerService, IndexService $indexService, TestService $testService,
MiscService $miscService
) {
parent::__construct();
$this->runningService = $runningService;
$this->platformService = $platformService;
$this->providerService = $providerService;
$this->indexService = $indexService;
$this->testService = $testService;
$this->miscService = $miscService;
}
/**
*
*/
protected function configure() {
parent::configure();
$this->setName('fulltextsearch:test')
->setDescription('Testing the platform setup')
->addOption('json', 'j', InputOption::VALUE_NONE, 'return result as JSON')
->addOption(
'platform_delay', 'd', InputOption::VALUE_REQUIRED,
'change DELAY_STABILIZE_PLATFORM'
);
}
/**
* @param InputInterface $input
* @param OutputInterface $output
*
* @throws Exception
*/
protected function execute(InputInterface $input, OutputInterface $output) {
$this->isJson = ($input->getOption('json') === true);
$platformDelay = ($input->getOption('platform_delay') > 0) ? $input->getOption(
'platform_delay'
) : self::DELAY_STABILIZE_PLATFORM;
$this->output($output, '.Testing your current setup:');
try {
$testProvider = $this->testCreatingProvider($output);
$this->testMockedProvider($output, $testProvider);
$testPlatform = $this->testLoadingPlatform($output);
$this->testLockingProcess($output, $testPlatform, $testProvider);
} catch (Exception $e) {
$this->outputResult($output, false);
throw $e;
}
try {
$this->testResetTest($output, $testProvider);
$this->pause($output, $platformDelay);
$this->testInitIndexing($output, $testPlatform);
$this->testIndexingDocuments($output, $testPlatform, $testProvider);
$this->pause($output, $platformDelay);
$this->testContentLicense($output, $testPlatform);
$this->testSearchSimple($output, $testPlatform, $testProvider);
$this->testUpdatingDocumentsAccess($output, $testPlatform, $testProvider);
$this->pause($output, $platformDelay);
$this->testSearchAccess($output, $testPlatform, $testProvider);
$this->testSearchShare($output, $testPlatform, $testProvider);
$this->testResetTest($output, $testProvider);
$this->testUnlockingProcess($output);
} catch (Exception $e) {
$this->outputResult($output, false);
$this->output($output, 'Error detected, unlocking process');
$this->runner->stop();
$this->outputResult($output, true);
throw $e;
}
$this->output($output, '', true);
}
/**
* @return IFullTextSearchProvider
* @throws ProviderIsNotCompatibleException
* @throws QueryException
* @throws ProviderDoesNotExistException
* @throws ProviderIsNotUniqueException
*/
private function generateMockProvider(): IFullTextSearchProvider {
$this->providerService->loadProvider(
'fulltextsearch', 'OCA\FullTextSearch\Provider\TestProvider'
);
$providerWrapper = $this->providerService->getProvider(TestProvider::TEST_PROVIDER_ID);
return $providerWrapper->getProvider();
}
/**
* @param OutputInterface $output
* @param string $line
* @param bool $isNewLine
*/
private function output(OutputInterface $output, string $line, bool $isNewLine = true) {
if ($isNewLine) {
$output->write(' ', true);
}
$output->write($line . ' ', false);
}
/**
* @param OutputInterface $output
* @param bool $result
*/
private function outputResult(OutputInterface $output, bool $result) {
$line = $this->convertBoolToLine($result, $isNewLine);
$this->output($output, $line, $isNewLine);
}
/**
* @param bool $result
* @param bool $isNewLine
*
* @return string
*/
private function convertBoolToLine(bool $result, bool &$isNewLine): string {
$isNewLine = false;
if ($result === false) {
return '<error>fail</error>';
}
return '<info>ok</info>';
}
/**
* @param OutputInterface $output
*
* @return IFullTextSearchProvider
* @throws ProviderDoesNotExistException
* @throws ProviderIsNotCompatibleException
* @throws ProviderIsNotUniqueException
* @throws QueryException
*/
private function testCreatingProvider(OutputInterface $output): IFullTextSearchProvider {
$this->output($output, 'Creating mocked content provider.');
$testProvider = $this->generateMockProvider();
$this->outputResult($output, true);
return $testProvider;
}
/**
* @param OutputInterface $output
* @param IFullTextSearchProvider $testProvider
*/
private function testMockedProvider(
OutputInterface $output, IFullTextSearchProvider $testProvider
) {
$this->output($output, 'Testing mocked provider: get indexable documents.');
$testProvider->setIndexOptions(new IndexOptions());
$indexableDocuments =
$testProvider->generateIndexableDocuments(TestService::DOCUMENT_USER1);
$this->output($output, '(' . sizeof($indexableDocuments) . ' items)', false);
$this->outputResult($output, true);
}
/**
* @param OutputInterface $output
*
* @return IFullTextSearchPlatform
* @throws Exception
*/
private function testLoadingPlatform(OutputInterface $output): IFullTextSearchPlatform {
$this->output($output, 'Loading search platform.');
$wrapper = $this->platformService->getPlatform();
$testPlatform = $wrapper->getPlatform();
$this->output($output, '(' . $testPlatform->getName() . ')', false);
$this->outputResult($output, true);
$this->output($output, 'Testing search platform.');
if (!$testPlatform->testPlatform()) {
throw new Exception ('Search platform (' . $testPlatform->getName() . ') down ?');
}
$this->outputResult($output, true);
return $testPlatform;
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $testPlatform
* @param IFullTextSearchProvider $testProvider
*
* @throws RunnerAlreadyUpException
*/
private function testLockingProcess(
OutputInterface $output, IFullTextSearchPlatform $testPlatform,
IFullTextSearchProvider $testProvider
) {
$this->output($output, 'Locking process');
$this->runner = new Runner($this->runningService, 'test');
$this->runner->sourceIsCommandLine($this, $output);
$this->runner->start();
$this->indexService->setRunner($this->runner);
$testPlatform->setRunner($this->runner);
$testProvider->setRunner($this->runner);
$this->outputResult($output, true);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchProvider $testProvider
*
* @throws Exception
*/
private function testResetTest(OutputInterface $output, IFullTextSearchProvider $testProvider
) {
$this->output($output, 'Removing test.');
$this->indexService->resetIndex($testProvider->getId());
$this->outputResult($output, true);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $testPlatform
*/
private function testInitIndexing(OutputInterface $output, IFullTextSearchPlatform $testPlatform
) {
$this->output($output, 'Initializing index mapping.');
$testPlatform->initializeIndex();
$this->outputResult($output, true);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $testPlatform
* @param IFullTextSearchProvider $testProvider
*
* @throws Exception
*/
private function testIndexingDocuments(
OutputInterface $output, IFullTextSearchPlatform $testPlatform,
IFullTextSearchProvider $testProvider
) {
$this->output($output, 'Indexing generated documents.');
$options = new IndexOptions(
[
'provider' => TestProvider::TEST_PROVIDER_ID
]
);
$this->indexService->indexProviderContentFromUser(
$testPlatform, $testProvider, TestService::DOCUMENT_USER1, $options
);
$this->outputResult($output, true);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $testPlatform
*
* @throws Exception
*/
private function testContentLicense(
OutputInterface $output, IFullTextSearchPlatform $testPlatform
) {
try {
$this->output($output, 'Retreiving content from a big index (license).');
$indexDocument = $testPlatform->getDocument(
TestProvider::TEST_PROVIDER_ID, TestService::DOCUMENT_TYPE_LICENSE
);
$this->output(
$output, '(size: ' . $indexDocument->getContentSize() . ')', false
);
$this->outputResult($output, true);
} catch (Exception $e) {
throw new Exception(
"Issue while getting test document '" . TestService::DOCUMENT_TYPE_LICENSE
. "' from search platform: " . $e->getMessage()
);
}
$this->output($output, 'Comparing document with source.');
$this->testService->compareIndexDocument(
$this->testService->generateIndexDocumentContentLicense(new IndexOptions()),
$indexDocument
);
$this->outputResult($output, true);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $testPlatform
* @param IFullTextSearchProvider $testProvider
*
* @throws Exception
*/
private function testSearchSimple(
OutputInterface $output, IFullTextSearchPlatform $testPlatform,
IFullTextSearchProvider $testProvider
) {
$this->output($output, 'Searching basic keywords:');
$access = new DocumentAccess();
$access->setViewerId(TestService::DOCUMENT_USER1);
$this->search(
$output, $testPlatform, $testProvider, $access, 'test',
[TestService::DOCUMENT_TYPE_SIMPLE]
);
$this->search(
$output, $testPlatform, $testProvider, $access, 'document is a simple test',
// [TestService::DOCUMENT_TYPE_SIMPLE]
[TestService::DOCUMENT_TYPE_SIMPLE, TestService::DOCUMENT_TYPE_LICENSE]
);
$this->search(
$output, $testPlatform, $testProvider, $access, '"document is a test"',
[]
);
$this->search(
$output, $testPlatform, $testProvider, $access, '"document is a simple test"',
[TestService::DOCUMENT_TYPE_SIMPLE]
);
$this->search(
$output, $testPlatform, $testProvider, $access, 'document is a simple -test',
[TestService::DOCUMENT_TYPE_LICENSE]
);
$this->search(
$output, $testPlatform, $testProvider, $access, 'document is a simple +test',
[TestService::DOCUMENT_TYPE_SIMPLE]
);
$this->search(
$output, $testPlatform, $testProvider, $access, '-document is a simple test',
[]
);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $testPlatform
* @param IFullTextSearchProvider $testProvider
*
* @throws Exception
*/
private function testUpdatingDocumentsAccess(
OutputInterface $output, IFullTextSearchPlatform $testPlatform,
IFullTextSearchProvider $testProvider
) {
$this->output($output, 'Updating documents access.');
$options = new IndexOptions(
[
'provider' => TestProvider::TEST_PROVIDER_ID,
TestService::DOCUMENT_INDEXING_OPTION => TestService::DOCUMENT_INDEXING_ACCESS
]
);
$testProvider->setIndexOptions($options);
$this->indexService->indexProviderContentFromUser(
$testPlatform, $testProvider, TestService::DOCUMENT_USER1, $options
);
$this->outputResult($output, true);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $platform
* @param IFullTextSearchProvider $provider
*
* @throws Exception
*/
private function testSearchAccess(
OutputInterface $output, IFullTextSearchPlatform $platform,
IFullTextSearchProvider $provider
) {
$this->output($output, 'Searching with group access rights:');
$this->searchGroups($output, $platform, $provider, [], []);
$this->searchGroups(
$output, $platform, $provider, [TestService::DOCUMENT_GROUP1],
[TestService::DOCUMENT_TYPE_LICENSE]
);
$this->searchGroups(
$output, $platform, $provider,
[TestService::DOCUMENT_GROUP1, TestService::DOCUMENT_GROUP2],
[TestService::DOCUMENT_TYPE_LICENSE]
);
$this->searchGroups(
$output, $platform, $provider,
[TestService::DOCUMENT_NOTGROUP, TestService::DOCUMENT_GROUP2],
[TestService::DOCUMENT_TYPE_LICENSE]
);
$this->searchGroups($output, $platform, $provider, [TestService::DOCUMENT_NOTGROUP], []);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $platform
* @param IFullTextSearchProvider $provider
*
* @throws Exception
*/
private function testSearchShare(
OutputInterface $output, IFullTextSearchPlatform $platform,
IFullTextSearchProvider $provider
) {
$this->output($output, 'Searching with share rights:');
$this->searchUsers($output, $platform, $provider, TestService::DOCUMENT_NOTUSER, []);
$this->searchUsers($output, $platform, $provider, TestService::DOCUMENT_USER2, ['license']);
$this->searchUsers($output, $platform, $provider, TestService::DOCUMENT_USER3, ['license']);
}
/**
* @param OutputInterface $output
*
* @throws TickDoesNotExistException
*/
private function testUnlockingProcess(OutputInterface $output) {
$this->output($output, 'Unlocking process');
$this->runner->stop();
$this->outputResult($output, true);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $testPlatform
* @param IFullTextSearchProvider $testProvider
* @param DocumentAccess $access
* @param string $search
* @param array $expected
* @param string $moreOutput
*
* @throws Exception
*/
private function search(
OutputInterface $output, IFullTextSearchPlatform $testPlatform,
IFullTextSearchProvider $testProvider,
DocumentAccess $access, string $search, array $expected, string $moreOutput = ''
) {
$this->output(
$output,
" - '" . $search . "'" . (($moreOutput === '') ? '' : ' - ' . $moreOutput . ' - ')
);
$request = new SearchRequest();
$request->setSearch($search);
$searchResult = new SearchResult($request);
$searchResult->setProvider($testProvider);
$searchResult->setPlatform($testPlatform);
$testPlatform->searchRequest($searchResult, $access);
$this->output(
$output,
'(result: ' . $searchResult->getCount() . ', expected: ' . json_encode($expected) . ')',
false
);
$this->compareSearchResult($searchResult, $expected);
$this->outputResult($output, true);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $testPlatform
* @param IFullTextSearchProvider $testProvider
* @param array $groups
* @param array $expected
*
* @throws Exception
*/
private function searchGroups(
OutputInterface $output, IFullTextSearchPlatform $testPlatform,
IFullTextSearchProvider $testProvider, array $groups, array $expected
) {
$access = new DocumentAccess();
$access->setViewerId(TestService::DOCUMENT_NOTUSER);
$access->setGroups($groups);
$this->search(
$output, $testPlatform, $testProvider, $access, 'license',
$expected, json_encode($groups)
);
}
/**
* @param OutputInterface $output
* @param IFullTextSearchPlatform $testPlatform
* @param IFullTextSearchProvider $testProvider
* @param string $user
* @param array $expected
*
* @throws Exception
*/
private function searchUsers(
OutputInterface $output, IFullTextSearchPlatform $testPlatform,
IFullTextSearchProvider $testProvider, string $user, array $expected
) {
$access = new DocumentAccess();
$access->setViewerId($user);
$this->search(
$output, $testPlatform, $testProvider, $access, 'license',
$expected, $user
);
}
/**
* @param SearchResult $searchResult
* @param array $entries
*
* @throws Exception
*/
private function compareSearchResult(SearchResult $searchResult, array $entries) {
$documents = $searchResult->getDocuments();
if (sizeof($documents) !== sizeof($entries)) {
throw new \Exception('Unexpected SearchResult: ' . json_encode($searchResult));
}
foreach ($documents as $document) {
if (!in_array($document->getId(), $entries)) {
throw new \Exception('Unexpected Document: ' . json_encode($document));
}
}
}
/**
* @param OutputInterface $output
* @param int $s
*
* @throws InterruptException
*/
private function pause(OutputInterface $output, int $s) {
$this->output($output, 'Pausing ' . $s . ' seconds');
for ($i = 1; $i <= $s; $i++) {
if (time_nanosleep(1, 0) !== true) {
throw new InterruptException('Interrupted by user');
}
$this->output($output, (string)$i, false);
}
$this->outputResult($output, true);
}
/**
* @throws TickDoesNotExistException
*/
public function abort() {
try {
$this->abortIfInterrupted();
} catch (InterruptedException $e) {
$this->runner->stop();
exit();
}
}
}
|