Mercurial > hg > orthanc
view OrthancServer/UnitTestsSources/UnitTestsMain.cpp @ 5816:3f10350b26da
DICOMWeb Json formatter: improve support for ill-formed DS values + DS values are now represented as strings instead of doubles
author | Alain Mazy <am@orthanc.team> |
---|---|
date | Wed, 25 Sep 2024 19:36:43 +0200 |
parents | c2817a9eb032 |
children |
line wrap: on
line source
/** * 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-2024 Orthanc Team SRL, Belgium * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium * * 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 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 * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. **/ #include "PrecompiledHeadersUnitTests.h" #include <gtest/gtest.h> #include "../../OrthancFramework/Sources/DicomFormat/DicomArray.h" #include "../../OrthancFramework/Sources/DicomParsing/FromDcmtkBridge.h" #include "../../OrthancFramework/Sources/DicomParsing/ParsedDicomFile.h" #include "../../OrthancFramework/Sources/DicomParsing/ToDcmtkBridge.h" #include "../../OrthancFramework/Sources/EnumerationDictionary.h" #include "../../OrthancFramework/Sources/Images/Image.h" #include "../../OrthancFramework/Sources/Images/PngWriter.h" #include "../../OrthancFramework/Sources/Logging.h" #include "../../OrthancFramework/Sources/OrthancException.h" #include "../../OrthancFramework/Sources/Toolbox.h" #include "../Plugins/Engine/PluginsEnumerations.h" #include "../Sources/DicomInstanceToStore.h" #include "../Sources/OrthancConfiguration.h" // For the FontRegistry #include "../Sources/OrthancInitialization.h" #include "../Sources/ServerEnumerations.h" #include "../Sources/ServerToolbox.h" #include "../Sources/StorageCommitmentReports.h" #include <OrthancServerResources.h> #include <dcmtk/dcmdata/dcdeftag.h> using namespace Orthanc; TEST(EnumerationDictionary, Simple) { EnumerationDictionary<MetadataType> d; ASSERT_THROW(d.Translate("ReceptionDate"), OrthancException); ASSERT_EQ(MetadataType_ModifiedFrom, d.Translate("5")); ASSERT_EQ(256, d.Translate("256")); d.Add(MetadataType_Instance_ReceptionDate, "ReceptionDate"); ASSERT_EQ(MetadataType_Instance_ReceptionDate, d.Translate("ReceptionDate")); ASSERT_EQ(MetadataType_Instance_ReceptionDate, d.Translate("2")); ASSERT_EQ("ReceptionDate", d.Translate(MetadataType_Instance_ReceptionDate)); ASSERT_THROW(d.Add(MetadataType_Instance_ReceptionDate, "Hello"), OrthancException); ASSERT_THROW(d.Add(MetadataType_ModifiedFrom, "ReceptionDate"), OrthancException); // already used ASSERT_THROW(d.Add(MetadataType_ModifiedFrom, "1024"), OrthancException); // cannot register numbers d.Add(MetadataType_ModifiedFrom, "ModifiedFrom"); // ok } TEST(EnumerationDictionary, ServerEnumerations) { ASSERT_STREQ("Patient", EnumerationToString(ResourceType_Patient)); ASSERT_STREQ("Study", EnumerationToString(ResourceType_Study)); ASSERT_STREQ("Series", EnumerationToString(ResourceType_Series)); ASSERT_STREQ("Instance", EnumerationToString(ResourceType_Instance)); ASSERT_STREQ("ModifiedSeries", EnumerationToString(ChangeType_ModifiedSeries)); ASSERT_STREQ("Failure", EnumerationToString(StoreStatus_Failure)); ASSERT_STREQ("Success", EnumerationToString(StoreStatus_Success)); ASSERT_STREQ("CompletedSeries", EnumerationToString(ChangeType_CompletedSeries)); ASSERT_EQ("IndexInSeries", EnumerationToString(MetadataType_Instance_IndexInSeries)); ASSERT_EQ("LastUpdate", EnumerationToString(MetadataType_LastUpdate)); ASSERT_EQ(ResourceType_Patient, StringToResourceType("PATienT")); ASSERT_EQ(ResourceType_Study, StringToResourceType("STudy")); ASSERT_EQ(ResourceType_Series, StringToResourceType("SeRiEs")); ASSERT_EQ(ResourceType_Instance, StringToResourceType("INStance")); ASSERT_EQ(ResourceType_Instance, StringToResourceType("IMagE")); ASSERT_THROW(StringToResourceType("heLLo"), OrthancException); ASSERT_EQ(2047, StringToMetadata("2047")); ASSERT_THROW(StringToMetadata("Ceci est un test"), OrthancException); ASSERT_THROW(RegisterUserMetadata(128, ""), OrthancException); // too low (< 1024) ASSERT_THROW(RegisterUserMetadata(128000, ""), OrthancException); // too high (> 65535) RegisterUserMetadata(2047, "Ceci est un test"); ASSERT_EQ(2047, StringToMetadata("2047")); ASSERT_EQ(2047, StringToMetadata("Ceci est un test")); ASSERT_STREQ("Generic", EnumerationToString(StringToModalityManufacturer("Generic"))); ASSERT_STREQ("GenericNoWildcardInDates", EnumerationToString(StringToModalityManufacturer("GenericNoWildcardInDates"))); ASSERT_STREQ("GenericNoUniversalWildcard", EnumerationToString(StringToModalityManufacturer("GenericNoUniversalWildcard"))); ASSERT_STREQ("Vitrea", EnumerationToString(StringToModalityManufacturer("Vitrea"))); ASSERT_STREQ("GE", EnumerationToString(StringToModalityManufacturer("GE"))); // backward compatibility tests (to remove once we make these manufacturer really obsolete) ASSERT_STREQ("Generic", EnumerationToString(StringToModalityManufacturer("MedInria"))); ASSERT_STREQ("Generic", EnumerationToString(StringToModalityManufacturer("EFilm2"))); ASSERT_STREQ("Generic", EnumerationToString(StringToModalityManufacturer("ClearCanvas"))); ASSERT_STREQ("Generic", EnumerationToString(StringToModalityManufacturer("Dcm4Chee"))); ASSERT_STREQ("GenericNoWildcardInDates", EnumerationToString(StringToModalityManufacturer("SyngoVia"))); ASSERT_STREQ("GenericNoWildcardInDates", EnumerationToString(StringToModalityManufacturer("AgfaImpax"))); ASSERT_STREQ("default", EnumerationToString(StringToVerbosity("default"))); ASSERT_STREQ("verbose", EnumerationToString(StringToVerbosity("verbose"))); ASSERT_STREQ("trace", EnumerationToString(StringToVerbosity("trace"))); ASSERT_THROW(StringToVerbosity("nope"), OrthancException); } TEST(FontRegistry, Basic) { Orthanc::Image s(Orthanc::PixelFormat_RGB24, 640, 480, false); memset(s.GetBuffer(), 0, s.GetPitch() * s.GetHeight()); { Orthanc::OrthancConfiguration::ReaderLock lock; ASSERT_GE(1u, lock.GetConfiguration().GetFontRegistry().GetSize()); lock.GetConfiguration().GetFontRegistry().GetFont(0).Draw (s, "Hello world É\n\rComment ça va ?\nq", 50, 60, 255, 0, 0); } Orthanc::PngWriter w; Orthanc::IImageWriter::WriteToFile(w, "UnitTestsResults/font.png", s); } TEST(FromDcmtkBridge, ValueRepresentationConversions) { #if ORTHANC_ENABLE_PLUGINS == 1 ASSERT_EQ(1, ValueRepresentation_ApplicationEntity); ASSERT_EQ(1, OrthancPluginValueRepresentation_AE); for (int i = ValueRepresentation_ApplicationEntity; i <= ValueRepresentation_NotSupported; i++) { ValueRepresentation vr = static_cast<ValueRepresentation>(i); if (vr == ValueRepresentation_NotSupported) { ASSERT_THROW(ToDcmtkBridge::Convert(vr), OrthancException); ASSERT_THROW(Plugins::Convert(vr), OrthancException); } else if (vr == ValueRepresentation_OtherDouble || vr == ValueRepresentation_OtherLong || vr == ValueRepresentation_UniversalResource || vr == ValueRepresentation_UnlimitedCharacters) { // These VR are not supported as of DCMTK 3.6.0 ASSERT_THROW(ToDcmtkBridge::Convert(vr), OrthancException); ASSERT_EQ(OrthancPluginValueRepresentation_UN, Plugins::Convert(vr)); } else { ASSERT_EQ(vr, FromDcmtkBridge::Convert(ToDcmtkBridge::Convert(vr))); OrthancPluginValueRepresentation plugins = Plugins::Convert(vr); ASSERT_EQ(vr, Plugins::Convert(plugins)); } } for (int i = OrthancPluginValueRepresentation_AE; i <= OrthancPluginValueRepresentation_UT; i++) { OrthancPluginValueRepresentation plugins = static_cast<OrthancPluginValueRepresentation>(i); ValueRepresentation orthanc = Plugins::Convert(plugins); ASSERT_EQ(plugins, Plugins::Convert(orthanc)); } #endif } TEST(DicomMap, DicomAsJson) { // This is a Latin-1 test string: "crane" with a circumflex accent const unsigned char raw[] = { 0x63, 0x72, 0xe2, 0x6e, 0x65 }; std::string latin1((char*) &raw[0], sizeof(raw) / sizeof(char)); std::string utf8 = Toolbox::ConvertToUtf8(latin1, Encoding_Latin1, false); ParsedDicomFile dicom(false); dicom.SetEncoding(Encoding_Latin1); dicom.ReplacePlainString(DICOM_TAG_PATIENT_NAME, "Hello"); dicom.ReplacePlainString(DICOM_TAG_STUDY_DESCRIPTION, utf8); dicom.ReplacePlainString(DICOM_TAG_SERIES_DESCRIPTION, std::string(ORTHANC_MAXIMUM_TAG_LENGTH, 'a')); dicom.ReplacePlainString(DICOM_TAG_MANUFACTURER, std::string(ORTHANC_MAXIMUM_TAG_LENGTH + 1, 'a')); dicom.ReplacePlainString(DICOM_TAG_PIXEL_DATA, "binary"); dicom.ReplacePlainString(DICOM_TAG_ROWS, "512"); DcmDataset& dataset = *dicom.GetDcmtkObject().getDataset(); dataset.insertEmptyElement(DCM_StudyID, OFFalse); { std::unique_ptr<DcmSequenceOfItems> sequence(new DcmSequenceOfItems(DCM_ReferencedSeriesSequence)); { std::unique_ptr<DcmItem> item(new DcmItem); item->putAndInsertString(DCM_ReferencedSOPInstanceUID, "nope", OFFalse); ASSERT_TRUE(sequence->insert(item.release(), false, false).good()); } ASSERT_TRUE(dataset.insert(sequence.release(), false, false).good()); } // Check re-encoding DcmElement* element = NULL; ASSERT_TRUE(dataset.findAndGetElement(DCM_StudyDescription, element).good() && element != NULL); char* c = NULL; ASSERT_TRUE(element != NULL && element->isLeaf() && element->isaString() && element->getString(c).good()); ASSERT_EQ(0, memcmp(c, raw, latin1.length())); ASSERT_TRUE(dataset.findAndGetElement(DCM_Rows, element).good() && element != NULL && element->getTag().getEVR() == EVR_US); std::unique_ptr<DicomInstanceToStore> toStore(DicomInstanceToStore::CreateFromParsedDicomFile(dicom)); Json::Value dicomAsJson; OrthancConfiguration::DefaultDicomDatasetToJson(dicomAsJson, toStore->GetParsedDicomFile()); { // without parsing sequences DicomMap m; m.FromDicomAsJson(dicomAsJson); ASSERT_EQ("ISO_IR 100", m.GetValue(DICOM_TAG_SPECIFIC_CHARACTER_SET).GetContent()); ASSERT_FALSE(m.GetValue(DICOM_TAG_PATIENT_NAME).IsBinary()); ASSERT_EQ("Hello", m.GetValue(DICOM_TAG_PATIENT_NAME).GetContent()); ASSERT_FALSE(m.GetValue(DICOM_TAG_STUDY_DESCRIPTION).IsBinary()); ASSERT_EQ(utf8, m.GetValue(DICOM_TAG_STUDY_DESCRIPTION).GetContent()); ASSERT_FALSE(m.HasTag(DICOM_TAG_MANUFACTURER)); // Too long ASSERT_FALSE(m.HasTag(DICOM_TAG_PIXEL_DATA)); // Pixel data ASSERT_FALSE(m.HasTag(DICOM_TAG_REFERENCED_SERIES_SEQUENCE)); // Sequence ASSERT_EQ(DICOM_TAG_REFERENCED_SERIES_SEQUENCE.GetGroup(), DCM_ReferencedSeriesSequence.getGroup()); ASSERT_EQ(DICOM_TAG_REFERENCED_SERIES_SEQUENCE.GetElement(), DCM_ReferencedSeriesSequence.getElement()); ASSERT_TRUE(m.HasTag(DICOM_TAG_SERIES_DESCRIPTION)); // Maximum length ASSERT_FALSE(m.GetValue(DICOM_TAG_SERIES_DESCRIPTION).IsBinary()); ASSERT_EQ(ORTHANC_MAXIMUM_TAG_LENGTH, static_cast<int>(m.GetValue(DICOM_TAG_SERIES_DESCRIPTION).GetContent().length())); ASSERT_FALSE(m.GetValue(DICOM_TAG_ROWS).IsBinary()); ASSERT_EQ("512", m.GetValue(DICOM_TAG_ROWS).GetContent()); ASSERT_FALSE(m.GetValue(DICOM_TAG_STUDY_ID).IsNull()); ASSERT_FALSE(m.GetValue(DICOM_TAG_STUDY_ID).IsBinary()); ASSERT_EQ("", m.GetValue(DICOM_TAG_STUDY_ID).GetContent()); DicomArray a(m); ASSERT_EQ(6u, a.GetSize()); //dicom.SaveToFile("/tmp/test.dcm"); //std::cout << toStore.GetJson() << std::endl; //a.Print(stdout); } { // now parses sequences // LOG(INFO) << dicomAsJson.toStyledString(); DicomMap m; m.FromDicomAsJson(dicomAsJson, false, true /* parseSequences */); ASSERT_TRUE(m.HasTag(DICOM_TAG_REFERENCED_SERIES_SEQUENCE)); } } namespace Orthanc { // Namespace for the "FRIEND_TEST()" directive in "FromDcmtkBridge" to apply: // https://github.com/google/googletest/blob/master/googletest/docs/AdvancedGuide.md#private-class-members static const DicomTag REFERENCED_STUDY_SEQUENCE(0x0008, 0x1110); static const DicomTag REFERENCED_PATIENT_SEQUENCE(0x0008, 0x1120); static void CreateSampleJson(Json::Value& a) { { Json::Value b = Json::objectValue; b["PatientName"] = "Hello"; b["PatientID"] = "World"; b["StudyDescription"] = "Toto"; a.append(b); } { Json::Value b = Json::objectValue; b["PatientName"] = "data:application/octet-stream;base64,SGVsbG8y"; // echo -n "Hello2" | base64 b["PatientID"] = "World2"; a.append(b); } } TEST(FromDcmtkBridge, FromJson) { std::unique_ptr<DcmElement> element; { Json::Value a; a = "Hello"; element.reset(FromDcmtkBridge::FromJson(DICOM_TAG_PATIENT_NAME, a, false, Encoding_Utf8, "")); Json::Value b; std::set<DicomTag> ignoreTagLength; ignoreTagLength.insert(DICOM_TAG_PATIENT_ID); FromDcmtkBridge::ElementToJson(b, *element, DicomToJsonFormat_Short, DicomToJsonFlags_Default, 0, Encoding_Ascii, false, ignoreTagLength, 0); ASSERT_TRUE(b.isMember("0010,0010")); ASSERT_EQ("Hello", b["0010,0010"].asString()); FromDcmtkBridge::ElementToJson(b, *element, DicomToJsonFormat_Short, DicomToJsonFlags_Default, 3, Encoding_Ascii, false, ignoreTagLength, 0); ASSERT_TRUE(b["0010,0010"].isNull()); // "Hello" has more than 3 characters FromDcmtkBridge::ElementToJson(b, *element, DicomToJsonFormat_Full, DicomToJsonFlags_Default, 3, Encoding_Ascii, false, ignoreTagLength, 0); ASSERT_TRUE(b["0010,0010"].isObject()); ASSERT_EQ("PatientName", b["0010,0010"]["Name"].asString()); ASSERT_EQ("TooLong", b["0010,0010"]["Type"].asString()); ASSERT_TRUE(b["0010,0010"]["Value"].isNull()); ignoreTagLength.insert(DICOM_TAG_PATIENT_NAME); FromDcmtkBridge::ElementToJson(b, *element, DicomToJsonFormat_Short, DicomToJsonFlags_Default, 3, Encoding_Ascii, false, ignoreTagLength, 0); ASSERT_EQ("Hello", b["0010,0010"].asString()); } { Json::Value a; a = "Hello"; // Cannot assign a string to a sequence ASSERT_THROW(element.reset(FromDcmtkBridge::FromJson(REFERENCED_STUDY_SEQUENCE, a, false, Encoding_Utf8, "")), OrthancException); } { Json::Value a = Json::arrayValue; a.append("Hello"); // Cannot assign an array to a string ASSERT_THROW(element.reset(FromDcmtkBridge::FromJson(DICOM_TAG_PATIENT_NAME, a, false, Encoding_Utf8, "")), OrthancException); } { Json::Value a; a = "data:application/octet-stream;base64,SGVsbG8="; // echo -n "Hello" | base64 element.reset(FromDcmtkBridge::FromJson(DICOM_TAG_PATIENT_NAME, a, true, Encoding_Utf8, "")); Json::Value b; std::set<DicomTag> ignoreTagLength; FromDcmtkBridge::ElementToJson(b, *element, DicomToJsonFormat_Short, DicomToJsonFlags_Default, 0, Encoding_Ascii, false, ignoreTagLength, 0); ASSERT_EQ("Hello", b["0010,0010"].asString()); } { Json::Value a = Json::arrayValue; CreateSampleJson(a); element.reset(FromDcmtkBridge::FromJson(REFERENCED_STUDY_SEQUENCE, a, true, Encoding_Utf8, "")); { Json::Value b; std::set<DicomTag> ignoreTagLength; FromDcmtkBridge::ElementToJson(b, *element, DicomToJsonFormat_Short, DicomToJsonFlags_Default, 0, Encoding_Ascii, false, ignoreTagLength, 0); ASSERT_EQ(Json::arrayValue, b["0008,1110"].type()); ASSERT_EQ(2u, b["0008,1110"].size()); Json::Value::ArrayIndex i = (b["0008,1110"][0]["0010,0010"].asString() == "Hello") ? 0 : 1; ASSERT_EQ(3u, b["0008,1110"][i].size()); ASSERT_EQ(2u, b["0008,1110"][1 - i].size()); ASSERT_EQ(b["0008,1110"][i]["0010,0010"].asString(), "Hello"); ASSERT_EQ(b["0008,1110"][i]["0010,0020"].asString(), "World"); ASSERT_EQ(b["0008,1110"][i]["0008,1030"].asString(), "Toto"); ASSERT_EQ(b["0008,1110"][1 - i]["0010,0010"].asString(), "Hello2"); ASSERT_EQ(b["0008,1110"][1 - i]["0010,0020"].asString(), "World2"); } { Json::Value b; std::set<DicomTag> ignoreTagLength; FromDcmtkBridge::ElementToJson(b, *element, DicomToJsonFormat_Full, DicomToJsonFlags_Default, 0, Encoding_Ascii, false, ignoreTagLength, 0); Json::Value c; Toolbox::SimplifyDicomAsJson(c, b, DicomToJsonFormat_Human); a[1]["PatientName"] = "Hello2"; // To remove the Data URI Scheme encoding ASSERT_EQ(0, c["ReferencedStudySequence"].compare(a)); } } } } TEST(StorageCommitmentReports, Basic) { Orthanc::StorageCommitmentReports reports(2); ASSERT_EQ(2u, reports.GetMaxSize()); { Orthanc::StorageCommitmentReports::Accessor accessor(reports, "nope"); ASSERT_EQ("nope", accessor.GetTransactionUid()); ASSERT_FALSE(accessor.IsValid()); ASSERT_THROW(accessor.GetReport(), Orthanc::OrthancException); } reports.Store("a", new Orthanc::StorageCommitmentReports::Report("aet_a")); reports.Store("b", new Orthanc::StorageCommitmentReports::Report("aet_b")); reports.Store("c", new Orthanc::StorageCommitmentReports::Report("aet_c")); { Orthanc::StorageCommitmentReports::Accessor accessor(reports, "a"); ASSERT_FALSE(accessor.IsValid()); } { Orthanc::StorageCommitmentReports::Accessor accessor(reports, "b"); ASSERT_TRUE(accessor.IsValid()); ASSERT_EQ("aet_b", accessor.GetReport().GetRemoteAet()); ASSERT_EQ(Orthanc::StorageCommitmentReports::Report::Status_Pending, accessor.GetReport().GetStatus()); } { Orthanc::StorageCommitmentReports::Accessor accessor(reports, "c"); ASSERT_EQ("aet_c", accessor.GetReport().GetRemoteAet()); ASSERT_TRUE(accessor.IsValid()); } { std::unique_ptr<Orthanc::StorageCommitmentReports::Report> report (new Orthanc::StorageCommitmentReports::Report("aet")); report->AddSuccess("class1", "instance1"); report->AddFailure("class2", "instance2", Orthanc::StorageCommitmentFailureReason_ReferencedSOPClassNotSupported); report->MarkAsComplete(); reports.Store("a", report.release()); } { Orthanc::StorageCommitmentReports::Accessor accessor(reports, "a"); ASSERT_TRUE(accessor.IsValid()); ASSERT_EQ("aet", accessor.GetReport().GetRemoteAet()); ASSERT_EQ(Orthanc::StorageCommitmentReports::Report::Status_Failure, accessor.GetReport().GetStatus()); } { Orthanc::StorageCommitmentReports::Accessor accessor(reports, "b"); ASSERT_FALSE(accessor.IsValid()); } { Orthanc::StorageCommitmentReports::Accessor accessor(reports, "c"); ASSERT_TRUE(accessor.IsValid()); } { std::unique_ptr<Orthanc::StorageCommitmentReports::Report> report (new Orthanc::StorageCommitmentReports::Report("aet")); report->AddSuccess("class1", "instance1"); report->MarkAsComplete(); reports.Store("a", report.release()); } { Orthanc::StorageCommitmentReports::Accessor accessor(reports, "a"); ASSERT_TRUE(accessor.IsValid()); ASSERT_EQ("aet", accessor.GetReport().GetRemoteAet()); ASSERT_EQ(Orthanc::StorageCommitmentReports::Report::Status_Success, accessor.GetReport().GetStatus()); } { Orthanc::StorageCommitmentReports::Accessor accessor(reports, "b"); ASSERT_FALSE(accessor.IsValid()); } { Orthanc::StorageCommitmentReports::Accessor accessor(reports, "c"); ASSERT_TRUE(accessor.IsValid()); } } int main(int argc, char **argv) { Logging::Initialize(); Toolbox::InitializeGlobalLocale(NULL); SetGlobalVerbosity(Verbosity_Verbose); Toolbox::DetectEndianness(); SystemToolbox::MakeDirectory("UnitTestsResults"); OrthancInitialize(); ::testing::InitGoogleTest(&argc, argv); int result = RUN_ALL_TESTS(); OrthancFinalize(); Logging::Finalize(); return result; }