Orthanc/OrthancFramework/UnitTestsSources/RestApiTests.cpp
2025-06-23 19:07:37 +05:30

1387 lines
38 KiB
C++

/**
* Orthanc - A Lightweight, RESTful DICOM Store
* Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
* Department, University Hospital of Liege, Belgium
* Copyright (C) 2017-2023 Osimis S.A., Belgium
* Copyright (C) 2024-2025 Orthanc Team SRL, Belgium
* Copyright (C) 2021-2025 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
*
* This program is free software: you can redistribute it and/or
* modify it under the terms of the GNU Lesser 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
**/
#if ORTHANC_UNIT_TESTS_LINK_FRAMEWORK == 1
// Must be the first to be sure to use the Orthanc framework shared library
# include <OrthancFramework.h>
#endif
#include <gtest/gtest.h>
#include "../Sources/ChunkedBuffer.h"
#include "../Sources/Compression/ZlibCompressor.h"
#include "../Sources/HttpServer/HttpContentNegociation.h"
#include "../Sources/HttpServer/MultipartStreamReader.h"
#include "../Sources/HttpServer/StringMatcher.h"
#include "../Sources/Logging.h"
#include "../Sources/OrthancException.h"
#include "../Sources/RestApi/RestApiHierarchy.h"
#include "../Sources/WebServiceParameters.h"
#include <ctype.h>
#include <boost/lexical_cast.hpp>
#include <algorithm>
#if ORTHANC_SANDBOXED != 1
# include "../Sources/RestApi/RestApi.h"
#endif
using namespace Orthanc;
#if !defined(UNIT_TESTS_WITH_HTTP_CONNEXIONS) && (ORTHANC_SANDBOXED != 1)
# error UNIT_TESTS_WITH_HTTP_CONNEXIONS is not defined
#endif
#if !defined(ORTHANC_ENABLE_SSL)
# error ORTHANC_ENABLE_SSL is not defined
#endif
#if ORTHANC_SANDBOXED != 1
# include "../Sources/HttpClient.h"
# include "../Sources/SystemToolbox.h"
#endif
#if ORTHANC_SANDBOXED != 1
TEST(HttpClient, Basic)
{
HttpClient c;
ASSERT_FALSE(c.IsVerbose());
c.SetVerbose(true);
ASSERT_TRUE(c.IsVerbose());
c.SetVerbose(false);
ASSERT_FALSE(c.IsVerbose());
ASSERT_TRUE(c.IsRedirectionFollowed());
c.SetRedirectionFollowed(false);
ASSERT_FALSE(c.IsRedirectionFollowed());
#if UNIT_TESTS_WITH_HTTP_CONNEXIONS == 1
// The "http://httpbin.org/get" URL does not automatically redirect
// to HTTPS, so we can use it even if the OpenSSL/HTTPS support is
// disabled in curl
const std::string URL = "http://httpbin.org/get";
Json::Value v;
c.SetUrl(URL);
c.Apply(v);
ASSERT_TRUE(v.type() == Json::objectValue);
ASSERT_TRUE(v.isMember("url"));
ASSERT_EQ(URL, v["url"].asString());
#endif
}
#endif
#if (UNIT_TESTS_WITH_HTTP_CONNEXIONS == 1) && (ORTHANC_ENABLE_SSL == 1) && (ORTHANC_SANDBOXED != 1)
/**
The HTTPS CA certificates for Github were extracted as follows:
(1) We retrieve the URI of the root CA of Github:
# echo | openssl s_client -servername raw.githubusercontent.com -connect raw.githubusercontent.com:443 2>/dev/null | openssl x509 -text | grep "CA Issuers"
(2) Once we get the URL to the CA certificate, we convert it to a C
macro that can be used by libcurl:
# cd UnitTestsSources
# python2 ../Resources/RetrieveCACertificates.py GITHUB_CERTIFICATES http://crt.sectigo.com/SectigoRSADomainValidationSecureServerCA.crt > GithubCACertificates.h
**/
#include "GithubCACertificates.h"
TEST(HttpClient, Ssl)
{
SystemToolbox::WriteFile(GITHUB_CERTIFICATES, "UnitTestsResults/github.cert");
/*{
std::string s;
SystemToolbox::ReadFile(s, "/etc/ssl/certs/ca-certificates.crt");
SystemToolbox::WriteFile(s, "UnitTestsResults/bitbucket.cert");
}*/
HttpClient c;
//c.SetVerbose(true);
c.SetHttpsVerifyPeers(true);
c.SetHttpsCACertificates("UnitTestsResults/github.cert");
// Test file modified on 2020-04-20, in order to use a git
// repository on BitBucket instead of a Mercurial repository
// (because Mercurial support disappears on 2020-05-31)
c.SetUrl("https://raw.githubusercontent.com/orthanc-server/orthanc-setup-samples/refs/heads/master/docker/serve-folders/orthanc/serve-folders.json");
Json::Value v;
c.Apply(v);
ASSERT_TRUE(v.isMember("ServeFolders"));
}
TEST(HttpClient, SslNoVerification)
{
HttpClient c;
c.SetHttpsVerifyPeers(false);
c.SetUrl("https://raw.githubusercontent.com/orthanc-server/orthanc-setup-samples/refs/heads/master/docker/serve-folders/orthanc/serve-folders.json");
Json::Value v;
c.Apply(v);
ASSERT_TRUE(v.isMember("ServeFolders"));
}
#endif
TEST(ChunkedBuffer, Basic)
{
for (unsigned int i = 0; i < 2; i++)
{
ChunkedBuffer b;
if (i == 0)
{
b.SetPendingBufferSize(0);
ASSERT_EQ(0u, b.GetPendingBufferSize());
}
else
{
ASSERT_EQ(16u * 1024u, b.GetPendingBufferSize());
}
ASSERT_EQ(0u, b.GetNumBytes());
b.AddChunk("hello", 5);
ASSERT_EQ(5u, b.GetNumBytes());
b.AddChunk("world", 5);
ASSERT_EQ(10u, b.GetNumBytes());
std::string s;
b.Flatten(s);
ASSERT_EQ("helloworld", s);
}
}
TEST(RestApi, ParseCookies)
{
HttpToolbox::Arguments headers;
HttpToolbox::Arguments cookies;
headers["cookie"] = "a=b;c=d;;;e=f;;g=h;";
HttpToolbox::ParseCookies(cookies, headers);
ASSERT_EQ(4u, cookies.size());
ASSERT_EQ("b", cookies["a"]);
ASSERT_EQ("d", cookies["c"]);
ASSERT_EQ("f", cookies["e"]);
ASSERT_EQ("h", cookies["g"]);
headers["cookie"] = " name = value ; name2=value2";
HttpToolbox::ParseCookies(cookies, headers);
ASSERT_EQ(2u, cookies.size());
ASSERT_EQ("value", cookies["name"]);
ASSERT_EQ("value2", cookies["name2"]);
headers["cookie"] = " ;;; ";
HttpToolbox::ParseCookies(cookies, headers);
ASSERT_EQ(0u, cookies.size());
headers["cookie"] = " ; n=v ;; ";
HttpToolbox::ParseCookies(cookies, headers);
ASSERT_EQ(1u, cookies.size());
ASSERT_EQ("v", cookies["n"]);
}
TEST(RestApi, RestApiPath)
{
HttpToolbox::Arguments args;
UriComponents trail;
{
RestApiPath uri("/coucou/{abc}/d/*");
ASSERT_TRUE(uri.Match(args, trail, "/coucou/moi/d/e/f/g"));
ASSERT_EQ(1u, args.size());
ASSERT_EQ(3u, trail.size());
ASSERT_EQ("moi", args["abc"]);
ASSERT_EQ("e", trail[0]);
ASSERT_EQ("f", trail[1]);
ASSERT_EQ("g", trail[2]);
ASSERT_FALSE(uri.Match(args, trail, "/coucou/moi/f"));
ASSERT_TRUE(uri.Match(args, trail, "/coucou/moi/d/"));
ASSERT_FALSE(uri.Match(args, trail, "/a/moi/d"));
ASSERT_FALSE(uri.Match(args, trail, "/coucou/moi"));
ASSERT_EQ(3u, uri.GetLevelCount());
ASSERT_TRUE(uri.IsUniversalTrailing());
ASSERT_EQ("coucou", uri.GetLevelName(0));
ASSERT_THROW(uri.GetWildcardName(0), OrthancException);
ASSERT_EQ("abc", uri.GetWildcardName(1));
ASSERT_THROW(uri.GetLevelName(1), OrthancException);
ASSERT_EQ("d", uri.GetLevelName(2));
ASSERT_THROW(uri.GetWildcardName(2), OrthancException);
}
{
RestApiPath uri("/coucou/{abc}/d");
ASSERT_FALSE(uri.Match(args, trail, "/coucou/moi/d/e/f/g"));
ASSERT_TRUE(uri.Match(args, trail, "/coucou/moi/d"));
ASSERT_EQ(1u, args.size());
ASSERT_EQ(0u, trail.size());
ASSERT_EQ("moi", args["abc"]);
ASSERT_EQ(3u, uri.GetLevelCount());
ASSERT_FALSE(uri.IsUniversalTrailing());
ASSERT_EQ("coucou", uri.GetLevelName(0));
ASSERT_THROW(uri.GetWildcardName(0), OrthancException);
ASSERT_EQ("abc", uri.GetWildcardName(1));
ASSERT_THROW(uri.GetLevelName(1), OrthancException);
ASSERT_EQ("d", uri.GetLevelName(2));
ASSERT_THROW(uri.GetWildcardName(2), OrthancException);
}
{
RestApiPath uri("/*");
ASSERT_TRUE(uri.Match(args, trail, "/a/b/c"));
ASSERT_EQ(0u, args.size());
ASSERT_EQ(3u, trail.size());
ASSERT_EQ("a", trail[0]);
ASSERT_EQ("b", trail[1]);
ASSERT_EQ("c", trail[2]);
ASSERT_EQ(0u, uri.GetLevelCount());
ASSERT_TRUE(uri.IsUniversalTrailing());
}
}
static int testValue;
template <int value>
static void SetValue(RestApiGetCall& get)
{
testValue = value;
}
static bool GetDirectory(Json::Value& target,
RestApiHierarchy& hierarchy,
const std::string& uri)
{
UriComponents p;
Toolbox::SplitUriComponents(p, uri);
return hierarchy.GetDirectory(target, p);
}
namespace
{
class MyVisitor : public RestApiHierarchy::IVisitor
{
public:
virtual bool Visit(const RestApiHierarchy::Resource& resource,
const UriComponents& uri,
bool hasTrailing,
const HttpToolbox::Arguments& components,
const UriComponents& trailing) ORTHANC_OVERRIDE
{
return resource.Handle(*(RestApiGetCall*) NULL);
}
};
}
static bool HandleGet(RestApiHierarchy& hierarchy,
const std::string& uri)
{
UriComponents p;
Toolbox::SplitUriComponents(p, uri);
MyVisitor visitor;
return hierarchy.LookupResource(p, visitor);
}
TEST(RestApi, RestApiHierarchy)
{
RestApiHierarchy root;
root.Register("/hello/world/test", SetValue<1>);
root.Register("/hello/world/test2", SetValue<2>);
root.Register("/hello/{world}/test3/test4", SetValue<3>);
root.Register("/hello2/*", SetValue<4>);
Json::Value m;
root.CreateSiteMap(m);
std::string s;
Toolbox::WriteStyledJson(s, m);
Json::Value d;
ASSERT_FALSE(GetDirectory(d, root, "/hello"));
ASSERT_TRUE(GetDirectory(d, root, "/hello/a"));
ASSERT_EQ(1u, d.size());
ASSERT_EQ("test3", d[0].asString());
ASSERT_TRUE(GetDirectory(d, root, "/hello/world"));
ASSERT_EQ(2u, d.size());
ASSERT_TRUE(GetDirectory(d, root, "/hello/a/test3"));
ASSERT_EQ(1u, d.size());
ASSERT_EQ("test4", d[0].asString());
ASSERT_TRUE(GetDirectory(d, root, "/hello/world/test"));
ASSERT_TRUE(GetDirectory(d, root, "/hello/world/test2"));
ASSERT_FALSE(GetDirectory(d, root, "/hello2"));
testValue = 0;
ASSERT_TRUE(HandleGet(root, "/hello/world/test"));
ASSERT_EQ(testValue, 1);
ASSERT_TRUE(HandleGet(root, "/hello/world/test2"));
ASSERT_EQ(testValue, 2);
ASSERT_TRUE(HandleGet(root, "/hello/b/test3/test4"));
ASSERT_EQ(testValue, 3);
ASSERT_FALSE(HandleGet(root, "/hello/b/test3/test"));
ASSERT_EQ(testValue, 3);
ASSERT_TRUE(HandleGet(root, "/hello2/a/b"));
ASSERT_EQ(testValue, 4);
}
namespace
{
class AcceptHandler : public HttpContentNegociation::IHandler
{
private:
std::string type_;
std::string subtype_;
HttpContentNegociation::Dictionary parameters_;
public:
AcceptHandler()
{
Reset();
}
void Reset()
{
HttpContentNegociation::Dictionary parameters;
Handle("nope", "nope", parameters);
}
const std::string& GetType() const
{
return type_;
}
const std::string& GetSubType() const
{
return subtype_;
}
HttpContentNegociation::Dictionary& GetParameters()
{
return parameters_;
}
virtual void Handle(const std::string& type,
const std::string& subtype,
const HttpContentNegociation::Dictionary& parameters) ORTHANC_OVERRIDE
{
type_ = type;
subtype_ = subtype;
parameters_ = parameters;
}
};
}
TEST(RestApi, HttpContentNegociation)
{
// Reference: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.1
AcceptHandler h;
{
HttpContentNegociation d;
d.Register("audio/mp3", h);
d.Register("audio/basic", h);
ASSERT_TRUE(d.Apply("audio/*; q=0.2, audio/basic"));
ASSERT_EQ("audio", h.GetType());
ASSERT_EQ("basic", h.GetSubType());
ASSERT_EQ(0u, h.GetParameters().size());
ASSERT_TRUE(d.Apply("audio/*; q=0.2 ; type = test ; hello , audio/nope"));
ASSERT_EQ("audio", h.GetType());
ASSERT_EQ("mp3", h.GetSubType());
ASSERT_EQ(3u, h.GetParameters().size());
ASSERT_EQ("0.2", h.GetParameters() ["q"]);
ASSERT_EQ("test", h.GetParameters() ["type"]);
ASSERT_EQ("", h.GetParameters() ["hello"]);
ASSERT_FALSE(d.Apply("application/*; q=0.2, application/pdf"));
ASSERT_TRUE(d.Apply("*/*; hello=world, application/*; q=0.2, application/pdf"));
ASSERT_EQ("audio", h.GetType());
ASSERT_EQ(1u, h.GetParameters().size());
ASSERT_EQ("world", h.GetParameters() ["hello"]);
}
// "This would be interpreted as "text/html and text/x-c are the
// preferred media types, but if they do not exist, then send the
// text/x-dvi entity, and if that does not exist, send the
// text/plain entity.""
const std::string T1 = "text/plain; q=0.5, text/html ; hello = \"world\" , text/x-dvi; q=0.8, text/x-c";
{
HttpContentNegociation d;
d.Register("text/plain", h);
d.Register("text/html", h);
d.Register("text/x-dvi", h);
ASSERT_TRUE(d.Apply(T1));
ASSERT_EQ("text", h.GetType());
ASSERT_EQ("html", h.GetSubType());
ASSERT_EQ(1u, h.GetParameters().size());
ASSERT_EQ("world", h.GetParameters() ["hello"]);
}
{
HttpContentNegociation d;
d.Register("text/plain", h);
d.Register("text/x-dvi", h);
d.Register("text/x-c", h);
ASSERT_TRUE(d.Apply(T1));
ASSERT_EQ("text", h.GetType());
ASSERT_EQ("x-c", h.GetSubType());
ASSERT_EQ(0u, h.GetParameters().size());
}
{
HttpContentNegociation d;
d.Register("text/plain", h);
d.Register("text/x-dvi", h);
d.Register("text/x-c", h);
d.Register("text/html", h);
ASSERT_TRUE(d.Apply(T1));
ASSERT_EQ("text", h.GetType());
ASSERT_TRUE(h.GetSubType() == "x-c" || h.GetSubType() == "html");
if (h.GetSubType() == "x-c")
{
ASSERT_EQ(0u, h.GetParameters().size());
}
else
{
ASSERT_EQ(1u, h.GetParameters().size());
ASSERT_EQ("world", h.GetParameters() ["hello"]);
}
}
{
HttpContentNegociation d;
d.Register("text/plain", h);
d.Register("text/x-dvi", h);
ASSERT_TRUE(d.Apply(T1));
ASSERT_EQ("text", h.GetType());
ASSERT_EQ("x-dvi", h.GetSubType());
ASSERT_EQ(1u, h.GetParameters().size());
ASSERT_EQ("0.8", h.GetParameters() ["q"]);
}
{
HttpContentNegociation d;
d.Register("text/plain", h);
ASSERT_TRUE(d.Apply(T1));
ASSERT_EQ("text", h.GetType());
ASSERT_EQ("plain", h.GetSubType());
ASSERT_EQ(1u, h.GetParameters().size());
ASSERT_EQ("0.5", h.GetParameters() ["q"]);
}
// Below are the tests from issue 216:
// https://orthanc.uclouvain.be/bugs/show_bug.cgi?id=216
{
HttpContentNegociation d;
d.Register("application/dicom+json", h);
ASSERT_TRUE(d.Apply("image/webp, */*;q=0.8, text/html, application/xhtml+xml, application/xml;q=0.9"));
ASSERT_EQ("application", h.GetType());
ASSERT_EQ("dicom+json", h.GetSubType());
ASSERT_EQ(1u, h.GetParameters().size());
ASSERT_EQ("0.8", h.GetParameters() ["q"]);
}
{
HttpContentNegociation d;
d.Register("application/dicom+json", h);
ASSERT_TRUE(d.Apply("image/webp, */*; q = \"0.8\" , text/html, application/xhtml+xml, application/xml;q=0.9"));
ASSERT_EQ("application", h.GetType());
ASSERT_EQ("dicom+json", h.GetSubType());
ASSERT_EQ(1u, h.GetParameters().size());
ASSERT_EQ("0.8", h.GetParameters() ["q"]);
}
{
HttpContentNegociation d;
d.Register("application/dicom+json", h);
ASSERT_TRUE(d.Apply("text/html, application/xhtml+xml, application/xml, image/webp, */*;q=0.8"));
ASSERT_EQ("application", h.GetType());
ASSERT_EQ("dicom+json", h.GetSubType());
ASSERT_EQ(1u, h.GetParameters().size());
ASSERT_EQ("0.8", h.GetParameters() ["q"]);
}
{
HttpContentNegociation d;
d.Register("application/dicom+json", h);
ASSERT_TRUE(d.Apply("text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2"));
ASSERT_EQ("application", h.GetType());
ASSERT_EQ("dicom+json", h.GetSubType());
ASSERT_EQ(1u, h.GetParameters().size());
ASSERT_EQ(".2", h.GetParameters() ["q"]);
}
}
TEST(WebServiceParameters, Serialization)
{
{
Json::Value v = Json::arrayValue;
v.append("http://localhost:8042/");
WebServiceParameters p(v);
ASSERT_FALSE(p.IsAdvancedFormatNeeded());
Json::Value v2;
p.Serialize(v2, false, true);
ASSERT_EQ(v, v2);
WebServiceParameters p2(v2);
ASSERT_EQ("http://localhost:8042/", p2.GetUrl());
ASSERT_TRUE(p2.GetUsername().empty());
ASSERT_TRUE(p2.GetPassword().empty());
ASSERT_TRUE(p2.GetCertificateFile().empty());
ASSERT_TRUE(p2.GetCertificateKeyFile().empty());
ASSERT_TRUE(p2.GetCertificateKeyPassword().empty());
ASSERT_FALSE(p2.IsPkcs11Enabled());
}
{
Json::Value v = Json::arrayValue;
v.append("http://localhost:8042/");
v.append("user");
v.append("pass");
WebServiceParameters p(v);
ASSERT_FALSE(p.IsAdvancedFormatNeeded());
ASSERT_EQ("http://localhost:8042/", p.GetUrl());
ASSERT_EQ("user", p.GetUsername());
ASSERT_EQ("pass", p.GetPassword());
ASSERT_TRUE(p.GetCertificateFile().empty());
ASSERT_TRUE(p.GetCertificateKeyFile().empty());
ASSERT_TRUE(p.GetCertificateKeyPassword().empty());
ASSERT_FALSE(p.IsPkcs11Enabled());
Json::Value v2;
p.Serialize(v2, false, true);
ASSERT_EQ(v, v2);
p.Serialize(v2, false, false /* no password */);
ASSERT_EQ(Json::arrayValue, v2.type());
ASSERT_EQ(3u, v2.size());
ASSERT_EQ("http://localhost:8042/", v2[0u].asString());
ASSERT_EQ("user", v2[1u].asString());
ASSERT_TRUE(v2[2u].asString().empty());
WebServiceParameters p2(v2); // Test decoding
ASSERT_EQ("http://localhost:8042/", p2.GetUrl());
}
{
Json::Value v = Json::arrayValue;
v.append("http://localhost:8042/");
WebServiceParameters p(v);
ASSERT_FALSE(p.IsAdvancedFormatNeeded());
p.SetPkcs11Enabled(true);
ASSERT_TRUE(p.IsAdvancedFormatNeeded());
Json::Value v2;
p.Serialize(v2, false, true);
ASSERT_EQ(Json::objectValue, v2.type());
ASSERT_EQ(4u, v2.size());
ASSERT_EQ("http://localhost:8042/", v2["Url"].asString());
ASSERT_TRUE(v2["Pkcs11"].asBool());
ASSERT_EQ(Json::objectValue, v2["HttpHeaders"].type());
ASSERT_EQ(0u, v2["HttpHeaders"].size());
ASSERT_EQ(0, v2["Timeout"].asInt());
WebServiceParameters p2(v2); // Test decoding
ASSERT_EQ("http://localhost:8042/", p2.GetUrl());
}
{
Json::Value v = Json::arrayValue;
v.append("http://localhost:8042/");
WebServiceParameters p(v);
ASSERT_FALSE(p.IsAdvancedFormatNeeded());
p.SetClientCertificate("a", "b", "c");
ASSERT_TRUE(p.IsAdvancedFormatNeeded());
Json::Value v2;
p.Serialize(v2, false, true);
ASSERT_EQ(Json::objectValue, v2.type());
ASSERT_EQ(7u, v2.size());
ASSERT_EQ("http://localhost:8042/", v2["Url"].asString());
ASSERT_EQ("a", v2["CertificateFile"].asString());
ASSERT_EQ("b", v2["CertificateKeyFile"].asString());
ASSERT_EQ("c", v2["CertificateKeyPassword"].asString());
ASSERT_FALSE(v2["Pkcs11"].asBool());
ASSERT_EQ(Json::objectValue, v2["HttpHeaders"].type());
ASSERT_EQ(0u, v2["HttpHeaders"].size());
ASSERT_EQ(0, v2["Timeout"].asInt());
WebServiceParameters p2(v2); // Test decoding
ASSERT_EQ("http://localhost:8042/", p2.GetUrl());
}
{
Json::Value v = Json::arrayValue;
v.append("http://localhost:8042/");
WebServiceParameters p(v);
ASSERT_FALSE(p.IsAdvancedFormatNeeded());
p.AddHttpHeader("a", "b");
p.AddHttpHeader("c", "d");
p.SetTimeout(42);
ASSERT_TRUE(p.IsAdvancedFormatNeeded());
Json::Value v2;
p.Serialize(v2, false, true);
WebServiceParameters p2(v2);
ASSERT_EQ(Json::objectValue, v2.type());
ASSERT_EQ(4u, v2.size());
ASSERT_EQ("http://localhost:8042/", v2["Url"].asString());
ASSERT_FALSE(v2["Pkcs11"].asBool());
ASSERT_EQ(Json::objectValue, v2["HttpHeaders"].type());
ASSERT_EQ(2u, v2["HttpHeaders"].size());
ASSERT_EQ("b", v2["HttpHeaders"]["a"].asString());
ASSERT_EQ("d", v2["HttpHeaders"]["c"].asString());
ASSERT_EQ(42, v2["Timeout"].asInt());
std::set<std::string> a;
p2.ListHttpHeaders(a);
ASSERT_EQ(2u, a.size());
ASSERT_TRUE(a.find("a") != a.end());
ASSERT_TRUE(a.find("c") != a.end());
std::string s;
ASSERT_TRUE(p2.LookupHttpHeader(s, "a")); ASSERT_EQ("b", s);
ASSERT_TRUE(p2.LookupHttpHeader(s, "c")); ASSERT_EQ("d", s);
ASSERT_FALSE(p2.LookupHttpHeader(s, "nope"));
}
}
TEST(WebServiceParameters, UserProperties)
{
Json::Value v = Json::nullValue;
{
WebServiceParameters p;
p.SetUrl("http://localhost:8042/");
ASSERT_FALSE(p.IsAdvancedFormatNeeded());
ASSERT_THROW(p.AddUserProperty("Url", "nope"), OrthancException);
p.AddUserProperty("Hello", "world");
p.AddUserProperty("a", "b");
ASSERT_TRUE(p.IsAdvancedFormatNeeded());
p.Serialize(v, false, true);
p.ClearUserProperties();
ASSERT_FALSE(p.IsAdvancedFormatNeeded());
}
{
WebServiceParameters p(v);
ASSERT_TRUE(p.IsAdvancedFormatNeeded());
ASSERT_TRUE(p.GetHttpHeaders().empty());
std::set<std::string> tmp;
p.ListUserProperties(tmp);
ASSERT_EQ(2u, tmp.size());
ASSERT_TRUE(tmp.find("a") != tmp.end());
ASSERT_TRUE(tmp.find("Hello") != tmp.end());
ASSERT_TRUE(tmp.find("hello") == tmp.end());
std::string s;
ASSERT_TRUE(p.LookupUserProperty(s, "a")); ASSERT_TRUE(s == "b");
ASSERT_TRUE(p.LookupUserProperty(s, "Hello")); ASSERT_TRUE(s == "world");
ASSERT_FALSE(p.LookupUserProperty(s, "hello"));
}
}
TEST(StringMatcher, Basic)
{
StringMatcher matcher("---");
ASSERT_THROW(matcher.GetMatchBegin(), OrthancException);
{
const std::string s = "";
ASSERT_FALSE(matcher.Apply(s));
}
{
const std::string s = "abc----def";
ASSERT_TRUE(matcher.Apply(s));
ASSERT_EQ(3, std::distance(s.begin(), matcher.GetMatchBegin()));
ASSERT_EQ("---", std::string(matcher.GetMatchBegin(), matcher.GetMatchEnd()));
}
{
const std::string s = "abc---";
ASSERT_TRUE(matcher.Apply(s));
ASSERT_EQ(3, std::distance(s.begin(), matcher.GetMatchBegin()));
ASSERT_EQ(s.end(), matcher.GetMatchEnd());
ASSERT_EQ("---", std::string(matcher.GetMatchBegin(), matcher.GetMatchEnd()));
ASSERT_EQ("", std::string(matcher.GetMatchEnd(), s.end()));
}
{
const std::string s = "abc--def";
ASSERT_FALSE(matcher.Apply(s));
ASSERT_THROW(matcher.GetMatchBegin(), OrthancException);
ASSERT_THROW(matcher.GetMatchEnd(), OrthancException);
}
{
std::string s(10u, '\0'); // String with null values
ASSERT_EQ(10u, s.size());
ASSERT_FALSE(matcher.Apply(s));
s[9] = '-';
ASSERT_FALSE(matcher.Apply(s));
s[8] = '-';
ASSERT_FALSE(matcher.Apply(s));
s[7] = '-';
ASSERT_TRUE(matcher.Apply(s));
ASSERT_EQ(s.c_str() + 7, matcher.GetPointerBegin());
ASSERT_EQ(s.c_str() + 10, matcher.GetPointerEnd());
ASSERT_EQ(s.end() - 3, matcher.GetMatchBegin());
ASSERT_EQ(s.end(), matcher.GetMatchEnd());
}
}
TEST(CStringMatcher, Basic)
{
CStringMatcher matcher("---");
ASSERT_THROW(matcher.GetMatchBegin(), OrthancException);
{
ASSERT_FALSE(matcher.Apply(NULL, 0));
const std::string s = "";
ASSERT_FALSE(matcher.Apply(s));
}
{
const char* s = "abc---def";
ASSERT_TRUE(matcher.Apply(s, s + 9));
ASSERT_EQ('a', matcher.GetMatchBegin()[-3]);
ASSERT_EQ('b', matcher.GetMatchBegin()[-2]);
ASSERT_EQ('c', matcher.GetMatchBegin()[-1]);
ASSERT_EQ('-', matcher.GetMatchBegin()[0]);
ASSERT_EQ('-', matcher.GetMatchBegin()[1]);
ASSERT_EQ('-', matcher.GetMatchBegin()[2]);
ASSERT_EQ('d', matcher.GetMatchBegin()[3]);
ASSERT_EQ('e', matcher.GetMatchBegin()[4]);
ASSERT_EQ('f', matcher.GetMatchBegin()[5]);
ASSERT_EQ('\0', matcher.GetMatchBegin()[6]);
ASSERT_EQ('a', matcher.GetMatchEnd()[-6]);
ASSERT_EQ('b', matcher.GetMatchEnd()[-5]);
ASSERT_EQ('c', matcher.GetMatchEnd()[-4]);
ASSERT_EQ('-', matcher.GetMatchEnd()[-3]);
ASSERT_EQ('-', matcher.GetMatchEnd()[-2]);
ASSERT_EQ('-', matcher.GetMatchEnd()[-1]);
ASSERT_EQ('d', matcher.GetMatchEnd()[0]);
ASSERT_EQ('e', matcher.GetMatchEnd()[1]);
ASSERT_EQ('f', matcher.GetMatchEnd()[2]);
ASSERT_EQ('\0', matcher.GetMatchEnd()[3]);
}
{
const std::string s = "abc----def";
ASSERT_TRUE(matcher.Apply(s));
ASSERT_EQ(3, std::distance(s.c_str(), matcher.GetMatchBegin()));
ASSERT_EQ("---", std::string(matcher.GetMatchBegin(), matcher.GetMatchEnd()));
}
{
const std::string s = "abc---";
ASSERT_TRUE(matcher.Apply(s));
ASSERT_EQ(3, std::distance(s.c_str(), matcher.GetMatchBegin()));
ASSERT_EQ(s.c_str() + s.size(), matcher.GetMatchEnd());
ASSERT_EQ("---", std::string(matcher.GetMatchBegin(), matcher.GetMatchEnd()));
ASSERT_EQ("", std::string(matcher.GetMatchEnd(), s.c_str() + s.size()));
}
{
const std::string s = "abc--def";
ASSERT_FALSE(matcher.Apply(s));
ASSERT_THROW(matcher.GetMatchBegin(), OrthancException);
ASSERT_THROW(matcher.GetMatchEnd(), OrthancException);
}
{
std::string s(10u, '\0'); // String with null values
ASSERT_EQ(10u, s.size());
ASSERT_FALSE(matcher.Apply(s));
s[9] = '-';
ASSERT_FALSE(matcher.Apply(s));
s[8] = '-';
ASSERT_FALSE(matcher.Apply(s));
s[7] = '-';
ASSERT_TRUE(matcher.Apply(s));
ASSERT_EQ(s.c_str() + 7, matcher.GetMatchBegin());
ASSERT_EQ(s.c_str() + 10, matcher.GetMatchEnd());
ASSERT_EQ(s.c_str() + s.size() - 3, matcher.GetMatchBegin());
ASSERT_EQ(s.c_str() + s.size(), matcher.GetMatchEnd());
}
}
class MultipartTester : public MultipartStreamReader::IHandler
{
private:
struct Part
{
MultipartStreamReader::HttpHeaders headers_;
std::string data_;
Part(const MultipartStreamReader::HttpHeaders& headers,
const void* part,
size_t size) :
headers_(headers),
data_(reinterpret_cast<const char*>(part), size)
{
}
};
std::vector<Part> parts_;
public:
virtual void HandlePart(const MultipartStreamReader::HttpHeaders& headers,
const void* part,
size_t size)
{
parts_.push_back(Part(headers, part, size));
}
unsigned int GetCount() const
{
return parts_.size();
}
MultipartStreamReader::HttpHeaders& GetHeaders(size_t i)
{
return parts_[i].headers_;
}
const std::string& GetData(size_t i) const
{
return parts_[i].data_;
}
};
TEST(MultipartStreamReader, ParseHeaders)
{
std::string ct, b, st, header;
{
MultipartStreamReader::HttpHeaders h;
h["hello"] = "world";
h["Content-Type"] = "world"; // Should be in lower-case
h["CONTENT-type"] = "world"; // Should be in lower-case
ASSERT_FALSE(MultipartStreamReader::GetMainContentType(header, h));
}
{
MultipartStreamReader::HttpHeaders h;
h["content-type"] = "world";
ASSERT_TRUE(MultipartStreamReader::GetMainContentType(header, h));
ASSERT_EQ(header, "world");
ASSERT_FALSE(MultipartStreamReader::ParseMultipartContentType(ct, st, b, header));
}
{
MultipartStreamReader::HttpHeaders h;
h["content-type"] = "multipart/related; dummy=value; boundary=1234; hello=world";
ASSERT_TRUE(MultipartStreamReader::GetMainContentType(header, h));
ASSERT_EQ(header, h["content-type"]);
ASSERT_TRUE(MultipartStreamReader::ParseMultipartContentType(ct, st, b, header));
ASSERT_EQ(ct, "multipart/related");
ASSERT_EQ(b, "1234");
ASSERT_TRUE(st.empty());
}
{
ASSERT_FALSE(MultipartStreamReader::ParseMultipartContentType
(ct, st, b, "multipart/related; boundary=")); // Empty boundary
}
{
ASSERT_TRUE(MultipartStreamReader::ParseMultipartContentType
(ct, st, b, "Multipart/Related; TYPE=Application/Dicom; Boundary=heLLO"));
ASSERT_EQ(ct, "multipart/related");
ASSERT_EQ(b, "heLLO");
ASSERT_EQ(st, "application/dicom");
}
{
ASSERT_TRUE(MultipartStreamReader::ParseMultipartContentType
(ct, st, b, "Multipart/Related; type=\"application/DICOM\"; Boundary=a"));
ASSERT_EQ(ct, "multipart/related");
ASSERT_EQ(b, "a");
ASSERT_EQ(st, "application/dicom");
}
}
TEST(MultipartStreamReader, ParseHeaders2)
{
std::string main;
std::map<std::string, std::string> args;
ASSERT_FALSE(MultipartStreamReader::ParseHeaderArguments(main, args, ""));
ASSERT_FALSE(MultipartStreamReader::ParseHeaderArguments(main, args, " "));
ASSERT_FALSE(MultipartStreamReader::ParseHeaderArguments(main, args, " ; "));
ASSERT_TRUE(MultipartStreamReader::ParseHeaderArguments(main, args, "hello"));
ASSERT_EQ("hello", main);
ASSERT_TRUE(args.empty());
ASSERT_TRUE(MultipartStreamReader::ParseHeaderArguments(main, args, "hello ; a = \" b \";c=d ; e=f;"));
ASSERT_EQ("hello", main);
ASSERT_EQ(3u, args.size());
ASSERT_EQ(" b ", args["a"]);
ASSERT_EQ("d", args["c"]);
ASSERT_EQ("f", args["e"]);
ASSERT_TRUE(MultipartStreamReader::ParseHeaderArguments(main, args, " hello ;;;; ; "));
ASSERT_EQ("hello", main);
ASSERT_TRUE(args.empty());
ASSERT_FALSE(MultipartStreamReader::ParseHeaderArguments(main, args, "hello;a=b;c=d;a=f"));
ASSERT_TRUE(MultipartStreamReader::ParseHeaderArguments(main, args, "multipart/related; dummy=value; boundary=1234; hello=world"));
ASSERT_EQ("multipart/related", main);
ASSERT_EQ(3u, args.size());
ASSERT_EQ("value", args["dummy"]);
ASSERT_EQ("1234", args["boundary"]);
ASSERT_EQ("world", args["hello"]);
ASSERT_TRUE(MultipartStreamReader::ParseHeaderArguments(main, args, "multipart/related; boundary="));
ASSERT_EQ("multipart/related", main);
ASSERT_EQ(1u, args.size());
ASSERT_EQ("", args["boundary"]);
ASSERT_TRUE(MultipartStreamReader::ParseHeaderArguments(main, args, "multipart/related; boundary"));
ASSERT_EQ("multipart/related", main);
ASSERT_EQ(1u, args.size());
ASSERT_EQ("", args["boundary"]);
ASSERT_TRUE(MultipartStreamReader::ParseHeaderArguments(main, args, "Multipart/Related; TYPE=Application/Dicom; Boundary=heLLO"));
ASSERT_EQ("multipart/related", main);
ASSERT_EQ(2u, args.size());
ASSERT_EQ("Application/Dicom", args["type"]);
ASSERT_EQ("heLLO", args["boundary"]);
ASSERT_TRUE(MultipartStreamReader::ParseHeaderArguments(main, args, "Multipart/Related; type=\"application/DICOM\"; Boundary=a"));
ASSERT_EQ("multipart/related", main);
ASSERT_EQ(2u, args.size());
ASSERT_EQ("application/DICOM", args["type"]);
ASSERT_EQ("a", args["boundary"]);
}
TEST(MultipartStreamReader, BytePerByte)
{
std::string stream = "GARBAGE";
std::string boundary = "123456789123456789";
{
for (size_t i = 0; i < 10; i++)
{
std::string f = "hello " + boost::lexical_cast<std::string>(i);
stream += "\r\n--" + boundary + "\r\n";
if (i % 2 == 0)
stream += "Content-Length: " + boost::lexical_cast<std::string>(f.size()) + "\r\n";
stream += "Content-Type: toto " + boost::lexical_cast<std::string>(i) + "\r\n\r\n";
stream += f;
}
stream += "\r\n--" + boundary + "--";
stream += "GARBAGE";
}
for (unsigned int k = 0; k < 2; k++)
{
MultipartTester decoded;
MultipartStreamReader reader(boundary);
reader.SetBlockSize(1);
reader.SetHandler(decoded);
if (k == 0)
{
for (size_t i = 0; i < stream.size(); i++)
{
reader.AddChunk(&stream[i], 1);
}
}
else
{
reader.AddChunk(stream);
}
reader.CloseStream();
ASSERT_EQ(10u, decoded.GetCount());
for (size_t i = 0; i < 10; i++)
{
ASSERT_EQ("hello " + boost::lexical_cast<std::string>(i), decoded.GetData(i));
ASSERT_EQ("toto " + boost::lexical_cast<std::string>(i), decoded.GetHeaders(i)["content-type"]);
if (i % 2 == 0)
{
ASSERT_EQ(2u, decoded.GetHeaders(i).size());
ASSERT_TRUE(decoded.GetHeaders(i).find("content-length") != decoded.GetHeaders(i).end());
}
}
}
}
TEST(MultipartStreamReader, Issue190)
{
// https://orthanc.uclouvain.be/bugs/show_bug.cgi?id=190
// https://orthanc.uclouvain.be/hg/orthanc-dicomweb/rev/6dc2f79b5579
std::map<std::string, std::string> headers;
headers["content-type"] = "multipart/related; type=application/dicom; boundary=0f3cf5c0-70e0-41ef-baef-c6f9f65ec3e1";
{
std::string tmp, contentType, subType, boundary;
ASSERT_TRUE(Orthanc::MultipartStreamReader::GetMainContentType(tmp, headers));
ASSERT_TRUE(Orthanc::MultipartStreamReader::ParseMultipartContentType(contentType, subType, boundary, tmp));
ASSERT_EQ("multipart/related", contentType);
ASSERT_EQ("application/dicom", subType);
ASSERT_EQ("0f3cf5c0-70e0-41ef-baef-c6f9f65ec3e1", boundary);
}
headers["content-type"] = "multipart/related; type=\"application/dicom\"; boundary=\"0f3cf5c0-70e0-41ef-baef-c6f9f65ec3e1\"";
{
std::string tmp, contentType, subType, boundary;
ASSERT_TRUE(Orthanc::MultipartStreamReader::GetMainContentType(tmp, headers));
ASSERT_TRUE(Orthanc::MultipartStreamReader::ParseMultipartContentType(contentType, subType, boundary, tmp));
ASSERT_EQ("multipart/related", contentType);
ASSERT_EQ("application/dicom", subType);
ASSERT_EQ("0f3cf5c0-70e0-41ef-baef-c6f9f65ec3e1", boundary);
}
}
TEST(WebServiceParameters, Url)
{
WebServiceParameters w;
ASSERT_THROW(w.SetUrl("ssh://coucou"), OrthancException);
w.SetUrl("http://coucou");
w.SetUrl("https://coucou");
ASSERT_THROW(w.SetUrl("httpss://coucou"), OrthancException);
ASSERT_THROW(w.SetUrl(""), OrthancException);
// New in Orthanc 1.7.2: Allow relative URLs (for DICOMweb in Stone)
w.SetUrl("coucou");
w.SetUrl("/coucou");
}
TEST(ChunkedBuffer, DISABLED_Large)
{
const size_t LARGE = 60 * 1024 * 1024;
ChunkedBuffer b;
for (size_t i = 0; i < LARGE; i++)
{
b.AddChunk(boost::lexical_cast<std::string>(i % 10));
}
std::string s;
b.Flatten(s);
ASSERT_EQ(LARGE, s.size());
ASSERT_EQ(0u, b.GetNumBytes());
for (size_t i = 0; i < LARGE; i++)
{
ASSERT_EQ(static_cast<char>('0' + (i % 10)), s[i]);
}
b.Flatten(s);
ASSERT_EQ(0u, s.size());
}
TEST(ChunkedBuffer, Pending)
{
ChunkedBuffer b;
for (size_t pendingSize = 0; pendingSize < 16; pendingSize++)
{
b.SetPendingBufferSize(pendingSize);
ASSERT_EQ(pendingSize, b.GetPendingBufferSize());
unsigned int pos = 0;
unsigned int iteration = 0;
while (pos < 1024)
{
size_t chunkSize = (iteration % 17);
std::string chunk;
chunk.resize(chunkSize);
for (size_t i = 0; i < chunkSize; i++)
{
chunk[i] = '0' + (pos % 10);
pos++;
}
b.AddChunk(chunk);
iteration ++;
}
std::string s;
b.Flatten(s);
ASSERT_EQ(0u, b.GetNumBytes());
ASSERT_EQ(pos, s.size());
for (size_t i = 0; i < s.size(); i++)
{
ASSERT_EQ(static_cast<char>('0' + (i % 10)), s[i]);
}
}
}
#if ORTHANC_SANDBOXED != 1
namespace
{
class TotoBody : public HttpClient::IRequestBody
{
private:
size_t size_;
size_t chunkSize_;
size_t pos_;
public:
TotoBody(size_t size,
size_t chunkSize) :
size_(size),
chunkSize_(chunkSize),
pos_(0)
{
}
virtual bool ReadNextChunk(std::string& chunk) ORTHANC_OVERRIDE
{
if (pos_ == size_)
{
return false;
}
chunk.clear();
chunk.resize(chunkSize_);
size_t i = 0;
while (pos_ < size_ &&
i < chunk.size())
{
chunk[i] = '0' + (pos_ % 7);
pos_++;
i++;
}
if (i < chunk.size())
{
chunk.erase(i, chunk.size());
}
return true;
}
};
class TotoServer : public IHttpHandler
{
public:
virtual bool CreateChunkedRequestReader(std::unique_ptr<IChunkedRequestReader>& target,
RequestOrigin origin,
const char* remoteIp,
const char* username,
HttpMethod method,
const UriComponents& uri,
const HttpToolbox::Arguments& headers) ORTHANC_OVERRIDE
{
return false;
}
virtual bool Handle(HttpOutput& output,
RequestOrigin origin,
const char* remoteIp,
const char* username,
HttpMethod method,
const UriComponents& uri,
const HttpToolbox::Arguments& headers,
const HttpToolbox::GetArguments& getArguments,
const void* bodyData,
size_t bodySize) ORTHANC_OVERRIDE
{
printf("received %d\n", static_cast<int>(bodySize));
const uint8_t* b = reinterpret_cast<const uint8_t*>(bodyData);
for (size_t i = 0; i < bodySize; i++)
{
if (b[i] != ('0' + i % 7))
{
throw;
}
}
output.Answer("ok");
return true;
}
};
}
#include "../Sources/HttpServer/HttpServer.h"
TEST(HttpClient, DISABLED_Issue156_Slow)
{
// https://orthanc.uclouvain.be/bugs/show_bug.cgi?id=156
TotoServer handler;
HttpServer server;
server.SetPortNumber(5000);
server.Register(handler);
server.Start();
WebServiceParameters w;
w.SetUrl("http://localhost:5000");
// This is slow in Orthanc <= 1.5.8 (issue 156)
TotoBody body(600 * 1024 * 1024, 6 * 1024 * 1024 - 17);
HttpClient c(w, "toto");
c.SetMethod(HttpMethod_Post);
c.AddHeader("Expect", "");
c.AddHeader("Transfer-Encoding", "chunked");
c.SetBody(body);
std::string s;
ASSERT_TRUE(c.Apply(s));
ASSERT_EQ("ok", s);
server.Stop();
}
TEST(HttpClient, DISABLED_Issue156_Crash)
{
TotoServer handler;
HttpServer server;
server.SetPortNumber(5000);
server.Register(handler);
server.Start();
WebServiceParameters w;
w.SetUrl("http://localhost:5000");
// This crashes Orthanc 1.6.0 to 1.7.2
TotoBody body(32 * 1024, 1);
HttpClient c(w, "toto");
c.SetMethod(HttpMethod_Post);
c.AddHeader("Expect", "");
c.AddHeader("Transfer-Encoding", "chunked");
c.SetBody(body);
std::string s;
ASSERT_TRUE(c.Apply(s));
ASSERT_EQ("ok", s);
server.Stop();
}
#endif