AlgorithmProxyTest.h 8.56 KB
Newer Older
1
2
3
// Mantid Repository : https://github.com/mantidproject/mantid
//
// Copyright © 2018 ISIS Rutherford Appleton Laboratory UKRI,
4
5
//   NScD Oak Ridge National Laboratory, European Spallation Source,
//   Institut Laue - Langevin & CSNS, Institute of High Energy Physics, CAS
6
// SPDX - License - Identifier: GPL - 3.0 +
7
#pragma once
8
9
10

#include <cxxtest/TestSuite.h>

11
#include "MantidAPI/Algorithm.h"
LamarMoore's avatar
LamarMoore committed
12
#include "MantidAPI/AlgorithmManager.h"
13
#include "MantidAPI/AlgorithmObserver.h"
LamarMoore's avatar
LamarMoore committed
14
#include "MantidAPI/AlgorithmProxy.h"
15

16
17
#include <Poco/ActiveResult.h>
#include <Poco/Thread.h>
18

19
20
#include <boost/lexical_cast.hpp>

21
22
23
using namespace Mantid::API;
using namespace Mantid::Kernel;

24
class ToyAlgorithmProxy : public Algorithm {
25
26
public:
  ToyAlgorithmProxy() : Algorithm() {}
27
28
  ~ToyAlgorithmProxy() override {}
  const std::string name() const override {
29
    return "ToyAlgorithmProxy";
Hahn, Steven's avatar
Hahn, Steven committed
30
  } ///< Algorithm's name for identification
31
32
33
34
  int version() const override {
    return 1;
  } ///< Algorithm's version for identification
  const std::string category() const override {
35
36
    return "ProxyCat";
  } ///< Algorithm's category for identification
37
  const std::vector<std::string> seeAlso() const override {
Nick Draper's avatar
Nick Draper committed
38
    return {"elephant", "seal"};
39
  } ///< Algorithm's seeAlso
40
41
42
43
44
45
46
47
  const std::string alias() const override {
    return "Dog";
  } ///< Algorithm's alias
  const std::string summary() const override { return "Test summary"; }
  const std::string workspaceMethodName() const override {
    return "toyalgorithm";
  }
  const std::string workspaceMethodOnTypes() const override {
48
    return "MatrixWorkspace;ITableWorkspace";
49
  }
50
  const std::string workspaceMethodInputProperty() const override {
51
52
53
    return "InputWorkspace";
  }

54
  void init() override {
55
56
57
58
    declareProperty("prop1", "value");
    declareProperty("prop2", 1);
    declareProperty("out", 8, Direction::Output);
  }
59
  void exec() override {
60
61
62
63
64
65
66
67
68
69
70
71
72
    std::string p1 = getProperty("prop1");
    int p2 = getProperty("prop2");

    Poco::Thread::current()->sleep(500);
    progress(0.333, "Running");
    interruption_point();
    Algorithm *alg = dynamic_cast<Algorithm *>(this);
    TS_ASSERT(alg);

    TS_ASSERT_EQUALS(p1, "stuff");
    TS_ASSERT_EQUALS(p2, 17);

    setProperty("out", 28);
73
74
75
  }
};

76
class ToyAlgorithmProxyMultipleCategory : public Algorithm {
Nick Draper's avatar
Nick Draper committed
77
78
public:
  ToyAlgorithmProxyMultipleCategory() : Algorithm() {}
79
80
  ~ToyAlgorithmProxyMultipleCategory() override {}
  const std::string name() const override {
81
    return "ToyAlgorithmProxyMultipleCategory";
Hahn, Steven's avatar
Hahn, Steven committed
82
  } ///< Algorithm's name for identification
83
84
85
86
  int version() const override {
    return 1;
  } ///< Algorithm's version for identification
  const std::string category() const override {
87
88
    return "ProxyCat;ProxyLeopard";
  } ///< Algorithm's category for identification
89
90
91
92
93
  const std::string alias() const override {
    return "Dog";
  } ///< Algorithm's alias
  const std::string summary() const override { return "Test summary"; }
  void init() override {
94
95
96
    declareProperty("prop1", "value");
    declareProperty("prop2", 1);
    declareProperty("out", 8, Direction::Output);
Nick Draper's avatar
Nick Draper committed
97
  }
98
  void exec() override {
99
100
101
102
103
104
105
106
107
108
109
110
111
    std::string p1 = getProperty("prop1");
    int p2 = getProperty("prop2");

    Poco::Thread::current()->sleep(500);
    progress(0.333, "Running");
    interruption_point();
    Algorithm *alg = dynamic_cast<Algorithm *>(this);
    TS_ASSERT(alg);

    TS_ASSERT_EQUALS(p1, "stuff");
    TS_ASSERT_EQUALS(p2, 17);

    setProperty("out", 28);
Nick Draper's avatar
Nick Draper committed
112
113
114
  }
};

115
DECLARE_ALGORITHM(ToyAlgorithmProxy)
Nick Draper's avatar
Nick Draper committed
116
DECLARE_ALGORITHM(ToyAlgorithmProxyMultipleCategory)
117

118
class TestProxyObserver : public AlgorithmObserver {
119
public:
120
121
122
123
124
  bool start, progress, finish;
  TestProxyObserver()
      : AlgorithmObserver(), start(false), progress(false), finish(false) {}
  TestProxyObserver(IAlgorithm_const_sptr alg)
      : AlgorithmObserver(alg), start(false), progress(false), finish(false) {}
125
126
127
  void startHandle(const IAlgorithm *) override { start = true; }
  void progressHandle(const IAlgorithm *, double p,
                      const std::string &msg) override {
128
129
130
131
    progress = true;
    TS_ASSERT_EQUALS(p, 0.333);
    TS_ASSERT_EQUALS(msg, "Running");
  }
132
  void finishHandle(const IAlgorithm *) override { finish = true; }
133
134
};

135
class AlgorithmProxyTest : public CxxTest::TestSuite {
136
public:
137
138
139
140
141
142
143
144
  void testCreateProxy() {
    IAlgorithm_sptr alg =
        AlgorithmManager::Instance().create("ToyAlgorithmProxy");
    TS_ASSERT(dynamic_cast<AlgorithmProxy *>(alg.get()));
    TS_ASSERT_EQUALS(alg->name(), "ToyAlgorithmProxy");
    TS_ASSERT_EQUALS(alg->version(), 1);
    TS_ASSERT_EQUALS(alg->category(), "ProxyCat");
    TS_ASSERT_EQUALS(alg->alias(), "Dog");
Nick Draper's avatar
Nick Draper committed
145
    std::vector<std::string> seeAlsoList{"elephant", "seal"};
146
    TS_ASSERT_EQUALS(alg->seeAlso(), seeAlsoList);
147
148
149
150
151
152
153
154
155
156
157
    TS_ASSERT(alg->isInitialized());
    TS_ASSERT(alg->existsProperty("prop1"));
    TS_ASSERT(alg->existsProperty("prop2"));
    TS_ASSERT(!alg->isRunning());
    alg->setProperty("prop1", "stuff");
    alg->setProperty("prop2", 17);
    TS_ASSERT_THROWS_NOTHING(alg->execute());
    TS_ASSERT(alg->isExecuted());
    int out = alg->getProperty("out");
    TS_ASSERT_EQUALS(out, 28);
  }
Nick Draper's avatar
Nick Draper committed
158

159
160
161
162
163
164
165
  void testMultipleCategory() {
    IAlgorithm_sptr alg = AlgorithmManager::Instance().create(
        "ToyAlgorithmProxyMultipleCategory");
    TS_ASSERT(dynamic_cast<AlgorithmProxy *>(alg.get()));
    TS_ASSERT_EQUALS(alg->name(), "ToyAlgorithmProxyMultipleCategory");
    TS_ASSERT_EQUALS(alg->version(), 1);
    TS_ASSERT_EQUALS(alg->category(), "ProxyCat;ProxyLeopard");
166
    std::vector<std::string> result{"ProxyCat", "ProxyLeopard"};
167
168
169
170
    TS_ASSERT_EQUALS(alg->categories(), result);
    TS_ASSERT_EQUALS(alg->alias(), "Dog");
    TS_ASSERT(alg->isInitialized());
  }
Nick Draper's avatar
Nick Draper committed
171

172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
  /**
   * Disabled due to random failures that cannot be pinned down and are most
   * likely timing issues.
   * This test has never failed legitimately and only serves to cause confusion
   * when it fails
   * due to completely unrelated changes.
   */
  void xtestRunning() {
    IAlgorithm_sptr alg =
        AlgorithmManager::Instance().create("ToyAlgorithmProxy");
    TS_ASSERT(dynamic_cast<AlgorithmProxy *>(alg.get()));
    alg->setProperty("prop1", "stuff");
    alg->setProperty("prop2", 17);
    Poco::ActiveResult<bool> res = alg->executeAsync();
    res.tryWait(60);
    TS_ASSERT(alg->isRunning());

    res.wait();
    TS_ASSERT(res.data());
    TS_ASSERT(alg->isExecuted());
  }
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
  void testCancel() {
    IAlgorithm_sptr alg =
        AlgorithmManager::Instance().create("ToyAlgorithmProxy");
    TS_ASSERT(dynamic_cast<AlgorithmProxy *>(alg.get()));
    alg->setProperty("prop1", "stuff");
    alg->setProperty("prop2", 17);
    Poco::ActiveResult<bool> res = alg->executeAsync();
    res.tryWait(100);
    alg->cancel();
    res.wait();
    TS_ASSERT(!alg->isExecuted());
    int out = alg->getProperty("out");
    TS_ASSERT_EQUALS(out, 8);
  }
  void testAddObserver() {
    IAlgorithm_sptr alg =
        AlgorithmManager::Instance().create("ToyAlgorithmProxy");
    TS_ASSERT(dynamic_cast<AlgorithmProxy *>(alg.get()));
    alg->setProperty("prop1", "stuff");
    alg->setProperty("prop2", 17);
    TestProxyObserver obs(alg);
    Poco::ActiveResult<bool> res = alg->executeAsync();
    res.wait();
    TS_ASSERT(obs.start);
    TS_ASSERT(obs.progress);
    TS_ASSERT(obs.finish);
  }
221

222
223
224
  void test_WorkspaceMethodFunctionsReturnProxiedContent() {
    IAlgorithm_sptr alg =
        AlgorithmManager::Instance().create("ToyAlgorithmProxy");
225

226
227
228
229
230
231
232
233
234
235
    TS_ASSERT_EQUALS("toyalgorithm", alg->workspaceMethodName());

    auto types = alg->workspaceMethodOn();
    TS_ASSERT_EQUALS(2, types.size());
    if (types.size() == 2) {
      TS_ASSERT_EQUALS("MatrixWorkspace", types[0]);
      TS_ASSERT_EQUALS("ITableWorkspace", types[1]);
    }
    TS_ASSERT_EQUALS("InputWorkspace", alg->workspaceMethodInputProperty());
  }
236
237

  void test_copyPropertiesFrom() {
Nick Draper's avatar
Nick Draper committed
238
    IAlgorithm_sptr alg =
239
        AlgorithmManager::Instance().create("ToyAlgorithmProxy");
Nick Draper's avatar
Nick Draper committed
240
241
242
243
    alg->initialize();
    alg->setPropertyValue("prop1", "string");
    alg->setPropertyValue("prop2", "1");
    IAlgorithm_sptr algCopy =
244
245
        AlgorithmManager::Instance().create("ToyAlgorithmProxy");

Nick Draper's avatar
Nick Draper committed
246
247
248
    auto algProxy = boost::dynamic_pointer_cast<AlgorithmProxy>(alg);
    auto algCopyProxy = boost::dynamic_pointer_cast<AlgorithmProxy>(algCopy);
    algCopyProxy->copyPropertiesFrom(*algProxy);
249

Nick Draper's avatar
Nick Draper committed
250
    int val = boost::lexical_cast<int>(algCopy->getPropertyValue("prop2"));
251

Nick Draper's avatar
Nick Draper committed
252
    TS_ASSERT_EQUALS(val, 1);
253

Nick Draper's avatar
Nick Draper committed
254
255
256
    // set another value and check the other value is unaffected
    algCopy->setPropertyValue("prop1", "A difference");
    int val2 = boost::lexical_cast<int>(algCopy->getPropertyValue("prop2"));
257

Nick Draper's avatar
Nick Draper committed
258
    TS_ASSERT_EQUALS(val, val2);
259
  }
260
};