-
-
Notifications
You must be signed in to change notification settings - Fork 3k
/
test_qgsprocessexecutable.py
494 lines (411 loc) · 20.6 KB
/
test_qgsprocessexecutable.py
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
# -*- coding: utf-8 -*-
"""QGIS Unit tests for qgis_process.
.. note:: This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
"""
__author__ = '(C) 2020 by Nyall Dawson'
__date__ = '05/04/2020'
__copyright__ = 'Copyright 2020, The QGIS Project'
import sys
import os
import glob
import re
import time
import shutil
import subprocess
import tempfile
import json
import errno
from qgis.testing import unittest
from utilities import unitTestDataPath
print('CTEST_FULL_OUTPUT')
TEST_DATA_DIR = unitTestDataPath()
class TestQgsProcessExecutable(unittest.TestCase):
TMP_DIR = ''
@classmethod
def setUpClass(cls):
cls.TMP_DIR = tempfile.mkdtemp()
# print('TMP_DIR: ' + cls.TMP_DIR)
# subprocess.call(['open', cls.TMP_DIR])
@classmethod
def tearDownClass(cls):
shutil.rmtree(cls.TMP_DIR, ignore_errors=True)
def run_process(self, arguments):
call = [QGIS_PROCESS_BIN] + arguments
print(' '.join(call))
myenv = os.environ.copy()
myenv["QGIS_DEBUG"] = '0'
p = subprocess.Popen(call, stdout=subprocess.PIPE, stderr=subprocess.PIPE, env=myenv)
output, err = p.communicate()
rc = p.returncode
return rc, output.decode(), err.decode()
def run_process_stdin(self, arguments, stdin_string: str):
call = [QGIS_PROCESS_BIN] + arguments
print(' '.join(call))
myenv = os.environ.copy()
myenv["QGIS_DEBUG"] = '0'
p = subprocess.Popen(call, stdout=subprocess.PIPE, stderr=subprocess.PIPE, stdin=subprocess.PIPE, env=myenv)
output, err = p.communicate(input=stdin_string.encode())
rc = p.returncode
return rc, output.decode(), err.decode()
def testNoArgs(self):
rc, output, err = self.run_process([])
self.assertIn('Available commands', output)
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
def testPlugins(self):
rc, output, err = self.run_process(['plugins'])
self.assertIn('available plugins', output.lower())
self.assertIn('processing', output.lower())
self.assertNotIn('metasearch', output.lower())
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
def testPluginsJson(self):
rc, output, err = self.run_process(['plugins', '--json'])
res = json.loads(output)
self.assertIn('gdal_version', res)
self.assertIn('geos_version', res)
self.assertIn('proj_version', res)
self.assertIn('python_version', res)
self.assertIn('qt_version', res)
self.assertIn('qgis_version', res)
self.assertIn('plugins', res)
self.assertIn('processing', res['plugins'])
self.assertTrue(res['plugins']['processing']['loaded'])
self.assertEqual(rc, 0)
def testAlgorithmList(self):
rc, output, err = self.run_process(['list'])
self.assertIn('available algorithms', output.lower())
self.assertIn('native:reprojectlayer', output.lower())
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
def testAlgorithmsListJson(self):
rc, output, err = self.run_process(['list', '--json'])
res = json.loads(output)
self.assertIn('gdal_version', res)
self.assertIn('geos_version', res)
self.assertIn('proj_version', res)
self.assertIn('python_version', res)
self.assertIn('qt_version', res)
self.assertIn('qgis_version', res)
self.assertIn('providers', res)
self.assertIn('native', res['providers'])
self.assertTrue(res['providers']['native']['is_active'])
self.assertIn('native:buffer', res['providers']['native']['algorithms'])
self.assertFalse(res['providers']['native']['algorithms']['native:buffer']['deprecated'])
self.assertEqual(rc, 0)
def testAlgorithmHelpNoAlg(self):
rc, output, err = self.run_process(['help'])
self.assertEqual(rc, 1)
self.assertIn('algorithm id or model file not specified', err.lower())
self.assertFalse(output)
def testAlgorithmHelp(self):
rc, output, err = self.run_process(['help', 'native:centroids'])
self.assertIn('representing the centroid', output.lower())
self.assertIn('argument type', output.lower())
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
def testAlgorithmHelpJson(self):
rc, output, err = self.run_process(['help', 'native:buffer', '--json'])
res = json.loads(output)
self.assertIn('gdal_version', res)
self.assertIn('geos_version', res)
self.assertIn('proj_version', res)
self.assertIn('python_version', res)
self.assertIn('qt_version', res)
self.assertIn('qgis_version', res)
self.assertFalse(res['algorithm_details']['deprecated'])
self.assertTrue(res['provider_details']['is_active'])
self.assertIn('OUTPUT', res['outputs'])
self.assertEqual(res['outputs']['OUTPUT']['description'], 'Buffered')
self.assertEqual(res['parameters']['DISSOLVE']['description'], 'Dissolve result')
self.assertFalse(res['parameters']['DISTANCE']['is_advanced'])
self.assertEqual(rc, 0)
def testAlgorithmRunNoAlg(self):
rc, output, err = self.run_process(['run'])
self.assertIn('algorithm id or model file not specified', err.lower())
self.assertFalse(output)
self.assertEqual(rc, 1)
def testAlgorithmRunNoArgs(self):
rc, output, err = self.run_process(['run', 'native:centroids'])
self.assertIn('the following mandatory parameters were not specified', err.lower())
self.assertIn('inputs', output.lower())
self.assertEqual(rc, 1)
def testAlgorithmRunLegacy(self):
output_file = self.TMP_DIR + '/polygon_centroid.shp'
rc, output, err = self.run_process(['run', 'native:centroids', '--INPUT={}'.format(TEST_DATA_DIR + '/polys.shp'), '--OUTPUT={}'.format(output_file)])
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertIn('0...10...20...30...40...50...60...70...80...90', output.lower())
self.assertIn('results', output.lower())
self.assertIn('OUTPUT:\t' + output_file, output)
self.assertTrue(os.path.exists(output_file))
self.assertEqual(rc, 0)
def testAlgorithmRun(self):
output_file = self.TMP_DIR + '/polygon_centroid.shp'
rc, output, err = self.run_process(['run', 'native:centroids', '--', 'INPUT={}'.format(TEST_DATA_DIR + '/polys.shp'), 'OUTPUT={}'.format(output_file)])
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertIn('0...10...20...30...40...50...60...70...80...90', output.lower())
self.assertIn('results', output.lower())
self.assertIn('OUTPUT:\t' + output_file, output)
self.assertTrue(os.path.exists(output_file))
self.assertEqual(rc, 0)
def testAlgorithmRunStdIn(self):
output_file = self.TMP_DIR + '/polygon_centroid_json.shp'
params = {
'inputs': {
'INPUT': TEST_DATA_DIR + '/polys.shp',
'OUTPUT': output_file
}
}
rc, output, err = self.run_process_stdin(['run', 'native:centroids', '-'], json.dumps(params))
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
res = json.loads(output)
self.assertIn('gdal_version', res)
self.assertIn('geos_version', res)
self.assertIn('proj_version', res)
self.assertIn('python_version', res)
self.assertIn('qt_version', res)
self.assertIn('qgis_version', res)
self.assertEqual(res['algorithm_details']['name'], 'Centroids')
self.assertEqual(res['inputs']['INPUT'], TEST_DATA_DIR + '/polys.shp')
self.assertEqual(res['inputs']['OUTPUT'], output_file)
self.assertEqual(res['results']['OUTPUT'], output_file)
self.assertTrue(os.path.exists(output_file))
self.assertEqual(rc, 0)
def testAlgorithmRunStdInMissingInputKey(self):
output_file = self.TMP_DIR + '/polygon_centroid_json.shp'
params = {
'INPUT': TEST_DATA_DIR + '/polys.shp',
'OUTPUT': output_file
}
rc, output, err = self.run_process_stdin(['run', 'native:centroids', '-'], json.dumps(params))
self.assertEqual(rc, 1)
self.assertIn('JSON parameters object must contain an "inputs" key.', err)
def testAlgorithmRunStdInNoInput(self):
rc, output, err = self.run_process_stdin(['run', 'native:centroids', '-'], '')
self.assertEqual(rc, 1)
self.assertIn('Could not parse JSON parameters', err)
def testAlgorithmRunStdInBadInput(self):
rc, output, err = self.run_process_stdin(['run', 'native:centroids', '-'], '{"not valid json"}')
self.assertEqual(rc, 1)
self.assertIn('Could not parse JSON parameters', err)
def testAlgorithmRunJson(self):
output_file = self.TMP_DIR + '/polygon_centroid2.shp'
rc, output, err = self.run_process(['run', '--json', 'native:centroids', '--', 'INPUT={}'.format(TEST_DATA_DIR + '/polys.shp'), 'OUTPUT={}'.format(output_file)])
res = json.loads(output)
self.assertIn('gdal_version', res)
self.assertIn('geos_version', res)
self.assertIn('proj_version', res)
self.assertIn('python_version', res)
self.assertIn('qt_version', res)
self.assertIn('qgis_version', res)
self.assertEqual(res['algorithm_details']['name'], 'Centroids')
self.assertEqual(res['inputs']['INPUT'], TEST_DATA_DIR + '/polys.shp')
self.assertEqual(res['inputs']['OUTPUT'], output_file)
self.assertEqual(res['results']['OUTPUT'], output_file)
self.assertTrue(os.path.exists(output_file))
self.assertEqual(rc, 0)
def testAlgorithmRunListValue(self):
"""
Test an algorithm which requires a list of layers as a parameter value
"""
output_file = self.TMP_DIR + '/package.gpkg'
rc, output, err = self.run_process(['run', '--json', 'native:package', '--',
'LAYERS={}'.format(TEST_DATA_DIR + '/polys.shp'),
'LAYERS={}'.format(TEST_DATA_DIR + '/points.shp'),
'LAYERS={}'.format(TEST_DATA_DIR + '/lines.shp'),
'OUTPUT={}'.format(output_file)])
res = json.loads(output)
self.assertIn('gdal_version', res)
self.assertIn('geos_version', res)
self.assertIn('proj_version', res)
self.assertIn('python_version', res)
self.assertIn('qt_version', res)
self.assertIn('qgis_version', res)
self.assertEqual(res['algorithm_details']['name'], 'Package layers')
self.assertEqual(len(res['inputs']['LAYERS']), 3)
self.assertEqual(res['inputs']['OUTPUT'], output_file)
self.assertEqual(res['results']['OUTPUT'], output_file)
self.assertEqual(len(res['results']['OUTPUT_LAYERS']), 3)
self.assertTrue(os.path.exists(output_file))
self.assertEqual(rc, 0)
def testModelHelp(self):
rc, output, err = self.run_process(['help', TEST_DATA_DIR + '/test_model.model3'])
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
self.assertIn('model description', output.lower())
def testModelRun(self):
output_file = self.TMP_DIR + '/model_output.shp'
rc, output, err = self.run_process(['run', TEST_DATA_DIR + '/test_model.model3', '--', 'FEATS={}'.format(TEST_DATA_DIR + '/polys.shp'), 'native:centroids_1:CENTROIDS={}'.format(output_file)])
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
self.assertIn('0...10...20...30...40...50...60...70...80...90', output.lower())
self.assertIn('results', output.lower())
self.assertTrue(os.path.exists(output_file))
def testModelRunStdIn(self):
output_file = self.TMP_DIR + '/model_output_stdin.shp'
params = {
'inputs': {
'FEATS': TEST_DATA_DIR + '/polys.shp',
'native:centroids_1:CENTROIDS': output_file
}
}
rc, output, err = self.run_process_stdin(['run', TEST_DATA_DIR + '/test_model.model3', '-'], json.dumps(params))
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
res = json.loads(output)
self.assertIn('gdal_version', res)
self.assertIn('geos_version', res)
self.assertIn('proj_version', res)
self.assertIn('python_version', res)
self.assertIn('qt_version', res)
self.assertIn('qgis_version', res)
self.assertEqual(res['algorithm_details']['id'], 'Test model')
self.assertTrue(os.path.exists(output_file))
def testModelRunJson(self):
output_file = self.TMP_DIR + '/model_output2.shp'
rc, output, err = self.run_process(['run', TEST_DATA_DIR + '/test_model.model3', '--json', '--', 'FEATS={}'.format(TEST_DATA_DIR + '/polys.shp'), 'native:centroids_1:CENTROIDS={}'.format(output_file)])
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
res = json.loads(output)
self.assertIn('gdal_version', res)
self.assertIn('geos_version', res)
self.assertIn('proj_version', res)
self.assertIn('python_version', res)
self.assertIn('qt_version', res)
self.assertIn('qgis_version', res)
self.assertEqual(res['algorithm_details']['id'], 'Test model')
self.assertTrue(os.path.exists(output_file))
def testModelRunWithLog(self):
output_file = self.TMP_DIR + '/model_log.log'
rc, output, err = self.run_process(['run', TEST_DATA_DIR + '/test_logging_model.model3', '--', 'logfile={}'.format(output_file)])
self.assertIn('Test logged message', err)
self.assertEqual(rc, 0)
self.assertIn('0...10...20...30...40...50...60...70...80...90', output.lower())
self.assertIn('results', output.lower())
self.assertTrue(os.path.exists(output_file))
with open(output_file, 'rt') as f:
lines = '\n'.join(f.readlines())
self.assertIn('Test logged message', lines)
def testPythonScriptHelp(self):
rc, output, err = self.run_process(['help', TEST_DATA_DIR + '/convert_to_upper.py'])
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
self.assertIn('converts a string to upper case', output.lower())
def testPythonScriptRun(self):
rc, output, err = self.run_process(['run', TEST_DATA_DIR + '/convert_to_upper.py', '--', 'INPUT=abc'])
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
self.assertIn('Converted abc to ABC', output)
self.assertIn('OUTPUT:\tABC', output)
def testPythonScriptRunJson(self):
rc, output, err = self.run_process(['run', TEST_DATA_DIR + '/convert_to_upper.py', '--json', '--', 'INPUT=abc'])
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
res = json.loads(output)
self.assertIn('gdal_version', res)
self.assertIn('geos_version', res)
self.assertIn('proj_version', res)
self.assertIn('python_version', res)
self.assertIn('qt_version', res)
self.assertIn('qgis_version', res)
self.assertEqual(res['algorithm_details']['id'], 'script:converttouppercase')
self.assertEqual(res['results']['OUTPUT'], 'ABC')
def testScriptRunStdIn(self):
output_file = self.TMP_DIR + '/model_output_stdin.shp'
params = {
'inputs':
{
'INPUT': 'abc def'
}
}
rc, output, err = self.run_process_stdin(['run', TEST_DATA_DIR + '/convert_to_upper.py', '-'], json.dumps(params))
if os.environ.get('TRAVIS', '') != 'true':
# Travis DOES have errors, due to QStandardPaths: XDG_RUNTIME_DIR not set warnings raised by Qt
self.assertFalse(err)
self.assertEqual(rc, 0)
res = json.loads(output)
self.assertIn('gdal_version', res)
self.assertIn('geos_version', res)
self.assertIn('proj_version', res)
self.assertIn('python_version', res)
self.assertIn('qt_version', res)
self.assertIn('qgis_version', res)
self.assertEqual(res['algorithm_details']['id'], 'script:converttouppercase')
self.assertEqual(res['results']['OUTPUT'], 'ABC DEF')
def testPythonScriptRunNotAlgorithm(self):
rc, output, err = self.run_process(['run', TEST_DATA_DIR + '/not_a_processing_script.py'])
self.assertEqual(rc, 1)
self.assertIn('is not a valid Processing script', err)
def testPythonScriptHelpNotAlgorithm(self):
rc, output, err = self.run_process(['help', TEST_DATA_DIR + '/not_a_processing_script.py'])
self.assertEqual(rc, 1)
self.assertIn('is not a valid Processing script', err)
def testPythonScriptRunError(self):
rc, output, err = self.run_process(['run', TEST_DATA_DIR + '/script_with_error.py'])
self.assertEqual(rc, 1)
self.assertIn('is not a valid Processing script', err)
def testPythonScriptHelpError(self):
rc, output, err = self.run_process(['help', TEST_DATA_DIR + '/script_with_error.py'])
self.assertEqual(rc, 1)
self.assertIn('is not a valid Processing script', err)
if __name__ == '__main__':
# look for qgis bin path
QGIS_PROCESS_BIN = ''
prefixPath = os.environ['QGIS_PREFIX_PATH']
# see qgsapplication.cpp:98
for f in ['', '..', 'bin']:
d = os.path.join(prefixPath, f)
b = os.path.abspath(os.path.join(d, 'qgis_process'))
if os.path.exists(b):
QGIS_PROCESS_BIN = b
break
b = os.path.abspath(os.path.join(d, 'qgis_process.exe'))
if os.path.exists(b):
QGIS_PROCESS_BIN = b
break
if sys.platform[:3] == 'dar': # Mac
# QGIS.app may be QGIS_x.x-dev.app for nightlies
# internal binary will match, minus the '.app'
found = False
for app_path in glob.glob(d + '/QGIS*.app'):
m = re.search(r'/(QGIS(_\d\.\d-dev)?)\.app', app_path)
if m:
QGIS_PROCESS_BIN = app_path + '/Contents/MacOS/' + m.group(1)
found = True
break
if found:
break
print(('\nQGIS_PROCESS_BIN: {}'.format(QGIS_PROCESS_BIN)))
assert QGIS_PROCESS_BIN, 'qgis_process binary not found, skipping test suite'
unittest.main()