File: test_IsotopicDataUserConfigHandler.cpp

package info (click to toggle)
libxpertmass 1.4.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,908 kB
  • sloc: cpp: 50,586; xml: 2,193; python: 417; ansic: 70; makefile: 33
file content (284 lines) | stat: -rw-r--r-- 8,410 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
// ./tests/catch2-tests [section] -s


/////////////////////// Qt includes
#include <QDebug>
#include <QString>
#include <QDir>

/////////////////////// IsoSpec
#include <IsoSpec++/isoSpec++.h>
#include <IsoSpec++/element_tables.h>


/////////////////////// Catch2 includes
#include <catch2/catch_test_macros.hpp>
#include <catch2/matchers/catch_matchers_floating_point.hpp>


/////////////////////// libXpertMassCore includes
#include <libXpertMass/Isotope.hpp>
#include <libXpertMass/IsotopicData.hpp>
#include <libXpertMass/IsotopicDataLibraryHandler.hpp>
#include <libXpertMass/IsotopicDataUserConfigHandler.hpp>

/////////////////////// Local includes
#include "tests-config.h"
#include "TestUtils.hpp"


namespace MsXpS
{
namespace libXpertMassCore
{

SCENARIO("Construction of an empty IsotopicDataUserConfigHandler",
         "[IsotopicDataUserConfigHandler]")
{

  TestUtils test_utils;

  test_utils.initializeXpertmassLibrary();

  QString isotopic_data_file_path =
    QString("%1/%2/%3")
      .arg(
        TESTS_INPUT_DIR, "isotopes", test_utils.m_naturalIsotopicDataFileName);

  GIVEN("An entirely empty IsotopicDataUserConfigHandler instance")
  {
    IsotopicDataUserConfigHandler isotopic_data_user_config_handler;

    WHEN("Constructed like so")
    {
      THEN("The isotopic data are empty but they are allocated")
      {
        REQUIRE(isotopic_data_user_config_handler.getIsotopicData() != nullptr);
        REQUIRE(isotopic_data_user_config_handler.getIsotopicData()->size() ==
                0);
        REQUIRE(isotopic_data_user_config_handler.getFileName().toStdString() ==
                "");
      }

      AND_WHEN("The file name is set using the setter")
      {
        isotopic_data_user_config_handler.setFileName(isotopic_data_file_path);

        THEN("The file name is set")
        {
          REQUIRE(
            isotopic_data_user_config_handler.getFileName().toStdString() ==
            isotopic_data_file_path.toStdString());
        }
      }
    }
  }
}

SCENARIO(
  "Construction of an IsotopicDataUserConfigHandler with an inexistent file's "
  "name",
  "[IsotopicDataUserConfigHandler]")
{
  TestUtils test_utils;

  QString inexistent_isotopic_data_file_path =
    QString("%1/%2/%3").arg(TESTS_INPUT_DIR, "isotopes", "inexistent.dat");

  GIVEN(
    "A IsotopicDataUserConfigHandler instance constructed with an inexistent "
    "file's name")
  {
    IsotopicDataUserConfigHandler isotopic_data_user_config_handler(
      inexistent_isotopic_data_file_path);

    THEN("All the data are set to nothing, but the IsotopicData")
    {
      REQUIRE(isotopic_data_user_config_handler.getIsotopicData() != nullptr);
      REQUIRE(isotopic_data_user_config_handler.getIsotopicData()->size() == 0);
      REQUIRE(isotopic_data_user_config_handler.getFileName().toStdString() ==
              inexistent_isotopic_data_file_path.toStdString());
    }

    WHEN("Trying to load the data")
    {
      std::size_t loaded_isotope_count =
        isotopic_data_user_config_handler.loadData();

      THEN("The data cannot be loaded")
      {
        REQUIRE(loaded_isotope_count == 0);
        REQUIRE(isotopic_data_user_config_handler.getIsotopicData()->size() ==
                loaded_isotope_count);
      }

      AND_WHEN("Trying to load the data specifying an existing file's name")
      {
        QString isotopic_data_file_path =
          QString("%1/%2/%3")
            .arg(TESTS_INPUT_DIR,
                 "isotopes",
                 test_utils.m_naturalIsotopicDataFileName);

        isotopic_data_user_config_handler.setFileName(isotopic_data_file_path);
        std::size_t loaded_isotope_count =
          isotopic_data_user_config_handler.loadData();

        THEN("The number of isotopes loaded is checked")
        {
          REQUIRE(loaded_isotope_count > 0);
          REQUIRE(isotopic_data_user_config_handler.getIsotopicData()->size() ==
                  loaded_isotope_count);
        }
      }
    }
  }
}

SCENARIO(
  "Construction of an IsotopicDataUserConfigHandler with an existing file's "
  "name",
  "[IsotopicDataUserConfigHandler]")
{
  TestUtils test_utils;

  QString isotopic_data_file_path =
    QString("%1/%2/%3")
      .arg(
        TESTS_INPUT_DIR, "isotopes", test_utils.m_naturalIsotopicDataFileName);

  WHEN("Constructed, the data are empty")
  {
    IsotopicDataUserConfigHandler isotopic_data_user_config_handler(
      isotopic_data_file_path);

    THEN("The isotopic data are empty but they are allocated")
    {
      REQUIRE(isotopic_data_user_config_handler.getIsotopicData() != nullptr);
    }

    AND_WHEN("Loading isotopic data")
    {
      std::size_t loaded_isotope_count =
        isotopic_data_user_config_handler.loadData();

      THEN("The number of isotopes loaded is checked")
      {
        REQUIRE(loaded_isotope_count > 0);
        REQUIRE(isotopic_data_user_config_handler.getIsotopicData()->size() ==
                loaded_isotope_count);
      }
    }
  }
}

SCENARIO(
  "IsotopicDataUserConfigHandler loads data from file previously "
  "written by writeDate test for IsotopicDataLibraryHandler")
{
  QString isotopic_data_file_path =
    QString("%1/%2/%3").arg(TESTS_OUTPUT_DIR, "isotopes", "isospec-tables.dat");

  WHEN("Constructed with a correct file name")
  {
    IsotopicDataUserConfigHandler isotopic_data_user_config_handler(
      isotopic_data_file_path);

    THEN("The isotopic data are empty but they are allocated")
    {
      REQUIRE(isotopic_data_user_config_handler.getIsotopicData() != nullptr);
    }

    AND_WHEN("Loading isotopic data from a user config file")
    {
      std::size_t loaded_isotope_count =
        isotopic_data_user_config_handler.loadData(isotopic_data_file_path);

      THEN("The number of isotopes loaded is checked")
      {
        REQUIRE(loaded_isotope_count > 0);
        REQUIRE(isotopic_data_user_config_handler.getIsotopicData()->size() ==
                loaded_isotope_count);
      }

      AND_WHEN(
        "A new IsotopicDataUserConfigHandler instance is copy constructed")
      {
        long use_count_before_copy =
          isotopic_data_user_config_handler.getIsotopicData().use_count();

        IsotopicDataUserConfigHandler isotopic_data_user_config_handler_1(
          isotopic_data_user_config_handler);

        THEN("The instances are checked and should be identical")
        {
          REQUIRE(
            isotopic_data_user_config_handler.getIsotopicData()->size() ==
            isotopic_data_user_config_handler_1.getIsotopicData()->size());

          long use_count_after_copy =
            isotopic_data_user_config_handler.getIsotopicData().use_count();

          REQUIRE(use_count_after_copy == use_count_before_copy + 1);
        }
      }
    }
  }
}

SCENARIO("IsotopicDataUserConfigHandler writes data to file",
         "[IsotopicDataUserConfigHandler]")
{
  TestUtils test_utils;

  QString isotopic_data_file_path =
    QString("%1/%2/%3")
      .arg(
        TESTS_INPUT_DIR, "isotopes", test_utils.m_naturalIsotopicDataFileName);

  WHEN("Constructed with a correct file name")
  {
    IsotopicDataUserConfigHandler isotopic_data_user_config_handler(
      isotopic_data_file_path);

    WHEN("Data have been loaded")
    {
      std::size_t loaded_isotope_count =
        isotopic_data_user_config_handler.loadData(isotopic_data_file_path);

      THEN("The number of isotopes loaded is checked")
      {
        REQUIRE(loaded_isotope_count > 0);
        REQUIRE(isotopic_data_user_config_handler.getIsotopicData()->size() ==
                loaded_isotope_count);
      }

      AND_WHEN("Isotopic data are written to file")
      {
        QString isotopes_output_dir =
          QString("%1/%2").arg(TESTS_OUTPUT_DIR, "isotopes");

        QDir dir;
        bool result = dir.mkpath(isotopes_output_dir);
        REQUIRE(result == true);

        QString output_file_name = QString("%1/%2").arg(
          isotopes_output_dir, "output_isotopic_data_user_config.dat");

        // qDebug() << "The write file name: " << output_file_name;

        std::size_t written_isotope_count =
          isotopic_data_user_config_handler.writeData(output_file_name);

        THEN("The count of written isotopes is checked")
        {
          REQUIRE(written_isotope_count == loaded_isotope_count);
        }
      }
    }
  }
}


} // namespace libXpertMassCore
} // namespace MsXpS