annotate UnitTestsSources/PluginsTests.cpp @ 4014:27628b0f6ada

merging logging code for plugins and files
author Sebastien Jodogne <s.jodogne@gmail.com>
date Mon, 08 Jun 2020 17:03:25 +0200
parents f9863630ec7f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1578
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1032
diff changeset
4 * Department, University Hospital of Liege, Belgium
3640
94f4a18a79cc upgrade to year 2020
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU General Public License as
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * published by the Free Software Foundation, either version 3 of the
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * License, or (at your option) any later version.
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * In addition, as a special exception, the copyright holders of this
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * program give permission to link the code of its release with the
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * OpenSSL project's "OpenSSL" library (or with modified versions of it
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * that use the same license as the "OpenSSL" library), and distribute
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * the linked executables. You must obey the GNU General Public License
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * in all respects for all of the code used other than "OpenSSL". If you
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * modify file(s) with this exception, you may extend this exception to
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * your version of the file(s), but you are not obligated to do so. If
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * you do not wish to do so, delete this exception statement from your
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * version. If you delete this exception statement from all source files
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * in the program, then also delete it here.
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 *
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 * This program is distributed in the hope that it will be useful, but
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * WITHOUT ANY WARRANTY; without even the implied warranty of
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * General Public License for more details.
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 *
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 * You should have received a copy of the GNU General Public License
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 **/
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
34 #if ORTHANC_UNIT_TESTS_LINK_FRAMEWORK == 1
4014
27628b0f6ada merging logging code for plugins and files
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3992
diff changeset
35 # include <OrthancFramework.h>
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
36 #endif
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
37
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 #include "PrecompiledHeadersUnitTests.h"
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 #include "gtest/gtest.h"
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
41 #include "../Core/OrthancException.h"
887
4066e6f2d134 PluginsManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 886
diff changeset
42 #include "../Plugins/Engine/PluginsManager.h"
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 using namespace Orthanc;
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
45
1578
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
46
2136
dd609a99d39a uniformization of the macro naming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1976
diff changeset
47 #if ORTHANC_ENABLE_PLUGINS == 1
1578
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
48
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
49 TEST(SharedLibrary, Enumerations)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
50 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
51 // The plugin engine cannot work if the size of an enumeration does
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
52 // not correspond to the size of "int32_t"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
53 ASSERT_EQ(sizeof(int32_t), sizeof(OrthancPluginErrorCode));
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
54 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
55
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
56
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 TEST(SharedLibrary, Basic)
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 {
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 #if defined(_WIN32)
893
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 888
diff changeset
60 SharedLibrary l("kernel32.dll");
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 888
diff changeset
61 ASSERT_THROW(l.GetFunction("world"), OrthancException);
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 888
diff changeset
62 ASSERT_TRUE(l.GetFunction("GetVersionExW") != NULL);
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 888
diff changeset
63 ASSERT_TRUE(l.HasFunction("GetVersionExW"));
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 888
diff changeset
64 ASSERT_FALSE(l.HasFunction("world"));
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65
2451
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
66 #elif defined(__LSB_VERSION__)
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
67 // For Linux Standard Base, we use a low-level shared library coming
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
68 // with glibc:
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
69 // http://www.linuxfromscratch.org/lfs/view/6.5/chapter06/glibc.html
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
70 SharedLibrary l("libSegFault.so");
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
71 ASSERT_THROW(l.GetFunction("world"), OrthancException);
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
72 ASSERT_FALSE(l.HasFunction("world"));
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
73
3035
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
74 /**
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
75 * On the Docker image "debian:buster-slim", the "libSegFault.so"
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
76 * library does exist, but does not contain any public symbol:
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
77 *
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
78 * $ sudo docker run -i -t --rm --entrypoint=bash debian:buster-slim
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
79 * # apt-get update && apt-get install -y binutils
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
80 * # nm -C /lib/x86_64-linux-gnu/libSegFault.so
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
81 * nm: /lib/x86_64-linux-gnu/libSegFault.so: no symbols
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
82 *
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
83 * As a consequence, this part of the test is disabled since Orthanc
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
84 * 1.5.1, until we locate another shared library that is widely
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
85 * spread. Reference:
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
86 * https://groups.google.com/d/msg/orthanc-users/v-QFzpOzgJY/4Hm5NgxKBwAJ
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
87 **/
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
88
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
89 //ASSERT_TRUE(l.GetFunction("_init") != NULL);
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
90 //ASSERT_TRUE(l.HasFunction("_init"));
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
91
1976
325772dadcd6 Macro "__linux" (now obsolete) replaced by macro "__linux__"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
92 #elif defined(__linux__) || defined(__FreeBSD_kernel__)
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 SharedLibrary l("libdl.so");
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 ASSERT_THROW(l.GetFunction("world"), OrthancException);
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 ASSERT_TRUE(l.GetFunction("dlopen") != NULL);
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
96 ASSERT_TRUE(l.HasFunction("dlclose"));
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 ASSERT_FALSE(l.HasFunction("world"));
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
2364
ae50eccd41b7 compilation succeeds on OpenBSD
jodogne
parents: 2244
diff changeset
99 #elif defined(__FreeBSD__) || defined(__OpenBSD__)
ae50eccd41b7 compilation succeeds on OpenBSD
jodogne
parents: 2244
diff changeset
100 // dlopen() in FreeBSD/OpenBSD is supplied by libc, libc.so is
1337
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
101 // a ldscript, so we can't actually use it. Use thread
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
102 // library instead - if it works - dlopen() is good.
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
103 SharedLibrary l("libpthread.so");
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
104 ASSERT_THROW(l.GetFunction("world"), OrthancException);
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
105 ASSERT_TRUE(l.GetFunction("pthread_create") != NULL);
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
106 ASSERT_TRUE(l.HasFunction("pthread_cancel"));
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
107 ASSERT_FALSE(l.HasFunction("world"));
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
108
1026
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
109 #elif defined(__APPLE__) && defined(__MACH__)
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
110 SharedLibrary l("libdl.dylib");
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
111 ASSERT_THROW(l.GetFunction("world"), OrthancException);
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
112 ASSERT_TRUE(l.GetFunction("dlopen") != NULL);
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
113 ASSERT_TRUE(l.HasFunction("dlclose"));
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
114 ASSERT_FALSE(l.HasFunction("world"));
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
115
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 #else
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 #error Support your platform here
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 #endif
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
119 }
1578
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
120
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
121 #endif