AlgorithmProxyTest.h 8.33 KB
Newer Older
1
2
3
4
5
#ifndef ALGORITHMPROXYTEST_H_
#define ALGORITHMPROXYTEST_H_

#include <cxxtest/TestSuite.h>

6
#include "MantidAPI/Algorithm.h"
LamarMoore's avatar
LamarMoore committed
7
#include "MantidAPI/AlgorithmManager.h"
8
#include "MantidAPI/AlgorithmObserver.h"
LamarMoore's avatar
LamarMoore committed
9
#include "MantidAPI/AlgorithmProxy.h"
10

11
12
#include <Poco/ActiveResult.h>
#include <Poco/Thread.h>
13

14
15
#include <boost/lexical_cast.hpp>

16
17
18
using namespace Mantid::API;
using namespace Mantid::Kernel;

19
class ToyAlgorithmProxy : public Algorithm {
20
21
public:
  ToyAlgorithmProxy() : Algorithm() {}
22
23
  ~ToyAlgorithmProxy() override {}
  const std::string name() const override {
24
    return "ToyAlgorithmProxy";
Hahn, Steven's avatar
Hahn, Steven committed
25
  } ///< Algorithm's name for identification
26
27
28
29
  int version() const override {
    return 1;
  } ///< Algorithm's version for identification
  const std::string category() const override {
30
31
    return "ProxyCat";
  } ///< Algorithm's category for identification
32
  const std::vector<std::string> seeAlso() const override {
Nick Draper's avatar
Nick Draper committed
33
    return {"elephant", "seal"};
34
  } ///< Algorithm's seeAlso
35
36
37
38
39
40
41
42
  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 {
43
    return "MatrixWorkspace;ITableWorkspace";
44
  }
45
  const std::string workspaceMethodInputProperty() const override {
46
47
48
    return "InputWorkspace";
  }

49
  void init() override {
50
51
52
53
    declareProperty("prop1", "value");
    declareProperty("prop2", 1);
    declareProperty("out", 8, Direction::Output);
  }
54
  void exec() override {
55
56
57
58
59
60
61
62
63
64
65
66
67
    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);
68
69
70
  }
};

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

110
DECLARE_ALGORITHM(ToyAlgorithmProxy)
Nick Draper's avatar
Nick Draper committed
111
DECLARE_ALGORITHM(ToyAlgorithmProxyMultipleCategory)
112

113
class TestProxyObserver : public AlgorithmObserver {
114
public:
115
116
117
118
119
  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) {}
120
121
122
  void startHandle(const IAlgorithm *) override { start = true; }
  void progressHandle(const IAlgorithm *, double p,
                      const std::string &msg) override {
123
124
125
126
    progress = true;
    TS_ASSERT_EQUALS(p, 0.333);
    TS_ASSERT_EQUALS(msg, "Running");
  }
127
  void finishHandle(const IAlgorithm *) override { finish = true; }
128
129
};

130
class AlgorithmProxyTest : public CxxTest::TestSuite {
131
public:
132
133
134
135
136
137
138
139
  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
140
    std::vector<std::string> seeAlsoList{"elephant", "seal"};
141
    TS_ASSERT_EQUALS(alg->seeAlso(), seeAlsoList);
142
143
144
145
146
147
148
149
150
151
152
    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
153

154
155
156
157
158
159
160
  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");
161
    std::vector<std::string> result{"ProxyCat", "ProxyLeopard"};
162
163
164
165
    TS_ASSERT_EQUALS(alg->categories(), result);
    TS_ASSERT_EQUALS(alg->alias(), "Dog");
    TS_ASSERT(alg->isInitialized());
  }
Nick Draper's avatar
Nick Draper committed
166

167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
  /**
   * 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());
  }
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
  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);
  }
216

217
218
219
  void test_WorkspaceMethodFunctionsReturnProxiedContent() {
    IAlgorithm_sptr alg =
        AlgorithmManager::Instance().create("ToyAlgorithmProxy");
220

221
222
223
224
225
226
227
228
229
230
    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());
  }
231
232

  void test_copyPropertiesFrom() {
Nick Draper's avatar
Nick Draper committed
233
    IAlgorithm_sptr alg =
234
        AlgorithmManager::Instance().create("ToyAlgorithmProxy");
Nick Draper's avatar
Nick Draper committed
235
236
237
238
    alg->initialize();
    alg->setPropertyValue("prop1", "string");
    alg->setPropertyValue("prop2", "1");
    IAlgorithm_sptr algCopy =
239
240
        AlgorithmManager::Instance().create("ToyAlgorithmProxy");

Nick Draper's avatar
Nick Draper committed
241
242
243
    auto algProxy = boost::dynamic_pointer_cast<AlgorithmProxy>(alg);
    auto algCopyProxy = boost::dynamic_pointer_cast<AlgorithmProxy>(algCopy);
    algCopyProxy->copyPropertiesFrom(*algProxy);
244

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

Nick Draper's avatar
Nick Draper committed
247
    TS_ASSERT_EQUALS(val, 1);
248

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

Nick Draper's avatar
Nick Draper committed
253
    TS_ASSERT_EQUALS(val, val2);
254
  }
255
};
256
257

#endif /*ALGORITHMPROXYTEST_H_*/