Mercurial > hg > orthanc

annotate OrthancServer/UnitTestsSources/PluginsTests.cpp @ 4819:70d2a97ca8cb openssl-3.x

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
integration mainline->openssl-3.x
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 25 Nov 2021 13:12:32 +0100
parents f0038043fb97 15f9cc6c11f0
children 2e71a08eea15
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
4437
d9473bd5ed43 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4062
diff changeset
5 * Copyright (C) 2017-2021 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 * 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
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * General Public License for more details.
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU General Public License
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #include "PrecompiledHeadersUnitTests.h"
4062
0953b3dc3261 pretty-printing
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
23 #include <gtest/gtest.h>
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
4813
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
25 #include "../../OrthancFramework/Sources/Compatibility.h"
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
26 #include "../../OrthancFramework/Sources/OrthancException.h"
887
4066e6f2d134 PluginsManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 886
diff changeset
27 #include "../Plugins/Engine/PluginsManager.h"
885
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 using namespace Orthanc;
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
1578
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
31
2136
dd609a99d39a uniformization of the macro naming
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1976
diff changeset
32 #if ORTHANC_ENABLE_PLUGINS == 1
1578
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
33
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
34 TEST(SharedLibrary, Enumerations)
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
35 {
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
36 // The plugin engine cannot work if the size of an enumeration does
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
37 // not correspond to the size of "int32_t"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
38 ASSERT_EQ(sizeof(int32_t), sizeof(OrthancPluginErrorCode));
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
39 }
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
40
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
41
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 TEST(SharedLibrary, Basic)
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 #if defined(_WIN32)
893
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 888
diff changeset
45 SharedLibrary l("kernel32.dll");
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 888
diff changeset
46 ASSERT_THROW(l.GetFunction("world"), OrthancException);
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 888
diff changeset
47 ASSERT_TRUE(l.GetFunction("GetVersionExW") != NULL);
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 888
diff changeset
48 ASSERT_TRUE(l.HasFunction("GetVersionExW"));
f57802f8b4dc plugins for windows
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 888
diff changeset
49 ASSERT_FALSE(l.HasFunction("world"));
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50
2451
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
51 #elif defined(__LSB_VERSION__)
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
52 // 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
53 // with glibc:
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
54 // http://www.linuxfromscratch.org/lfs/view/6.5/chapter06/glibc.html
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
55 SharedLibrary l("libSegFault.so");
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
56 ASSERT_THROW(l.GetFunction("world"), OrthancException);
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
57 ASSERT_FALSE(l.HasFunction("world"));
a4032b162502 lsb working
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
58
3035
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
59 /**
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
60 * On the Docker image "debian:buster-slim", the "libSegFault.so"
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
61 * library does exist, but does not contain any public symbol:
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
62 *
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
63 * $ 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
64 * # apt-get update && apt-get install -y binutils
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
65 * # nm -C /lib/x86_64-linux-gnu/libSegFault.so
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
66 * nm: /lib/x86_64-linux-gnu/libSegFault.so: no symbols
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
67 *
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
68 * 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
69 * 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
70 * spread. Reference:
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
71 * 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
72 **/
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
73
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
74 //ASSERT_TRUE(l.GetFunction("_init") != NULL);
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
75 //ASSERT_TRUE(l.HasFunction("_init"));
3254b36a5f9b fix lsb compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2463
diff changeset
76
1976
325772dadcd6 Macro "__linux" (now obsolete) replaced by macro "__linux__"
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
77 #elif defined(__linux__) || defined(__FreeBSD_kernel__)
4813
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
78 std::unique_ptr<SharedLibrary> l;
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
79 try
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
80 {
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
81 /**
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
82 * Since Orthanc 1.9.8, we test the "libdl.so.2" instead of the
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
83 * "libdl.so", as discussed here:
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
84 * https://groups.google.com/g/orthanc-users/c/I5g1fN6MCvg/m/JVdvRyjJAAAJ
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
85 **/
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
86 l.reset(new SharedLibrary("libdl.so.2"));
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
87 }
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
88 catch (OrthancException&)
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
89 {
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
90 l.reset(new SharedLibrary("libdl.so")); // Fallback for backward compat
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
91 }
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
92
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
93 ASSERT_THROW(l->GetFunction("world"), OrthancException);
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
94 ASSERT_TRUE(l->GetFunction("dlopen") != NULL);
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
95 ASSERT_TRUE(l->HasFunction("dlclose"));
15f9cc6c11f0 fix unit test SharedLibrary.Basic
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
96 ASSERT_FALSE(l->HasFunction("world"));
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97
2364
ae50eccd41b7 compilation succeeds on OpenBSD
jodogne
parents: 2244
diff changeset
98 #elif defined(__FreeBSD__) || defined(__OpenBSD__)
ae50eccd41b7 compilation succeeds on OpenBSD
jodogne
parents: 2244
diff changeset
99 // dlopen() in FreeBSD/OpenBSD is supplied by libc, libc.so is
1337
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
100 // a ldscript, so we can't actually use it. Use thread
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
101 // library instead - if it works - dlopen() is good.
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
102 SharedLibrary l("libpthread.so");
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
103 ASSERT_THROW(l.GetFunction("world"), OrthancException);
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
104 ASSERT_TRUE(l.GetFunction("pthread_create") != NULL);
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
105 ASSERT_TRUE(l.HasFunction("pthread_cancel"));
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
106 ASSERT_FALSE(l.HasFunction("world"));
afaa55d42ddd FreeBSD support
jodogne
parents: 1288
diff changeset
107
1026
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
108 #elif defined(__APPLE__) && defined(__MACH__)
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
109 SharedLibrary l("libdl.dylib");
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
110 ASSERT_THROW(l.GetFunction("world"), OrthancException);
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
111 ASSERT_TRUE(l.GetFunction("dlopen") != NULL);
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
112 ASSERT_TRUE(l.HasFunction("dlclose"));
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
113 ASSERT_FALSE(l.HasFunction("world"));
a13ccd93df28 fix OS X build
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 907
diff changeset
114
885
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 #else
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
116 #error Support your platform here
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
117 #endif
0570a8c859cb SharedLibrary class
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
118 }
1578
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
119
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1486
diff changeset
120 #endif