Mercurial > hg > orthanc-tests

annotate NewTests/README @ 486:6144ef431512

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
new tests for sequences in ExtraMainDicomTags
author Alain Mazy <am@osimis.io>
date Tue, 28 Jun 2022 18:38:21 +0200
parents 45c3fe035fed
children 2078cb20a560
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
473
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
1 This is a new set of tests directly written in python3. They should be able to handle
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
2 more complex scenarios like upgrades or change of configurations.
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
3
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
4 Prerequisites:
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
5 =============
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
6
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
7 These tests use python3 and require some modules define in requirements.txt. Therefore, you need
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
8 to first execute
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
9
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
10 pip3 install -r requirements.txt
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
11
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
12 Introduction:
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
13 ============
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
14
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
15 You may use these tests to debug Orthanc on your machine. In this case, there is
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
16 usually a `preparation` phase and `execution` phase. You are usually able to
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
17 interrupt the tests between these 2 phases such that you can start your debugger.
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
18 Use the `--break_after_preparation` option to do so.
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
19 As well, you may skip the preperation phase thanks to the `--skip_preparation` option.
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
20
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
21 The orthanc that is being tested is called the `orthanc-under-tests`.
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
22
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
23 Examples:
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
24 ========
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
25
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
26 All-tests:
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
27 ---------
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
28
474
6917a26881ed NewTests working with Docker
Alain Mazy <am@osimis.io>
parents: 473
diff changeset
29 with a local executable:
6917a26881ed NewTests working with Docker
Alain Mazy <am@osimis.io>
parents: 473
diff changeset
30
473
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
31 python3 NewTests/main.py --pattern=* \
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
32 --orthanc_under_tests_exe=/home/alain/o/build/orthanc/Orthanc \
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
33 --orthanc_under_tests_http_port=8043 \
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
34 --plugin=/home/alain/o/build/orthanc/libHousekeeper.so \
483
45c3fe035fed added tests for delayed_deletion
Alain Mazy <am@osimis.io>
parents: 474
diff changeset
35 --plugin=/home/alain/o/build/orthanc/libDelayedDeletion.so \
473
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
36 --plugin=/home/alain/o/build/orthanc-gdcm/libOrthancGdcm.so
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
37
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
38
474
6917a26881ed NewTests working with Docker
Alain Mazy <am@osimis.io>
parents: 473
diff changeset
39 with Docker:
6917a26881ed NewTests working with Docker
Alain Mazy <am@osimis.io>
parents: 473
diff changeset
40
6917a26881ed NewTests working with Docker
Alain Mazy <am@osimis.io>
parents: 473
diff changeset
41 python3 NewTests/main.py --pattern=* \
6917a26881ed NewTests working with Docker
Alain Mazy <am@osimis.io>
parents: 473
diff changeset
42 --orthanc_under_tests_docker_image=osimis/orthanc:current \
6917a26881ed NewTests working with Docker
Alain Mazy <am@osimis.io>
parents: 473
diff changeset
43 --orthanc_previous_version_docker_image=osimis/orthanc:22.4.0 \
6917a26881ed NewTests working with Docker
Alain Mazy <am@osimis.io>
parents: 473
diff changeset
44 --orthanc_under_tests_http_port=8043
6917a26881ed NewTests working with Docker
Alain Mazy <am@osimis.io>
parents: 473
diff changeset
45
473
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
46 Housekeeper:
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
47 -----------
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
48
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
49 Run the Housekeeper tests with your locally build version and break between preparation
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
50 and execution to allow you to start your debugger.
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
51
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
52 python3 NewTests/main.py --pattern=Housekeeper.test_housekeeper.TestHousekeeper.test_before_after_reconstruction \
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
53 --orthanc_under_tests_exe=/home/alain/o/build/orthanc/Orthanc \
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
54 --orthanc_under_tests_http_port=8043 \
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
55 --plugin=/home/alain/o/build/orthanc/libHousekeeper.so \
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
56 --break_after_preparation
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
57
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
58 The test script will:
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
59 - generate 2 configuration file in the `configurations` folder,
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
60 - start your local Orthanc version to prepare the db with one of the configuration file,
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
61 - drive this Orthanc to prepare the DB
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
62 - interrupt and instruct you how to start your own version, pointing to the configuration file to use
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
63 - execute tests
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
64
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
65
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
66
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
67 TODO: implement and document usage with Docker !!!!
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
68
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
69
486
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
70 ExtraMainDicomTags:
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
71 ------------------
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
72
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
73 Runs an Orthanc in Index Only mode while storing extra main dicom tags and perform various find (including DicomWeb).
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
74
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
75 Run the ExtraMainDicomTags tests with your locally build version.
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
76
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
77 python3 NewTests/main.py --pattern=ExtraMainDicomTags.* \
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
78 --orthanc_under_tests_exe=/home/alain/o/build/orthanc/Orthanc \
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
79 --orthanc_under_tests_http_port=8043 \
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
80 --plugin=/home/alain/o/build/orthanc-dicomweb/libOrthancDicomWeb.so \
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
81 --break_after_preparation
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
82
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
83 The test script will:
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
84 - generate 1 configuration file in the `configurations` folder,
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
85 - interrupt and instruct you how to start your own version, pointing to the configuration file to use
6144ef431512 new tests for sequences in ExtraMainDicomTags
Alain Mazy <am@osimis.io>
parents: 483
diff changeset
86 - execute tests
473
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
87
4ee85b016a40 added NewTests framework - only the Housekeeper tests right now
Alain Mazy <am@osimis.io>
parents:
diff changeset
88