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 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
|
#include "catch2_common.h"
constexpr static const Tango::DevDouble k_alarm_level = 20;
constexpr static const Tango::DevDouble k_alarming_value = 99;
constexpr static const Tango::DevDouble k_normal_value = 0;
constexpr static const char *k_test_reason = "Test_Reason";
constexpr static const char *k_a_helpful_desc = "A helpful description";
enum class Action
{
normal,
alarm,
except,
};
Action action_from_string(std::string_view str)
{
if(str == "normal")
{
return Action::normal;
}
if(str == "alarm")
{
return Action::alarm;
}
if(str == "except")
{
return Action::except;
}
std::stringstream ss;
ss << "Unknown action \"" << str << "\"";
TANGO_THROW_EXCEPTION(Tango::API_InvalidArgs, ss.str());
}
std::string to_string(Action action)
{
switch(action)
{
case Action::normal:
return "normal";
case Action::alarm:
return "alarm";
case Action::except:
return "except";
default:
return "unknown";
}
}
template <class Base>
class DevStateExcept : public Base
{
public:
using Base::Base;
~DevStateExcept() override { }
void init_device() override
{
Base::set_state(Tango::ON);
Tango::MultiAttribute *multi_attr = Base::get_device_attr();
std::vector<Tango::Attribute *> attrs = multi_attr->get_attribute_list();
m_on_read.clear();
for(auto *attr : attrs)
{
const std::string &name = attr->get_name();
if(name.find("attr") == 0)
{
m_on_read[name] = Action::normal;
m_values[name] = k_normal_value;
}
}
}
Tango::DevState dev_state() override
{
Tango::DevState state = Base::dev_state();
m_dev_state_called = true;
return state;
}
void reset_dev_state_called()
{
m_dev_state_called = false;
}
void read_attr(Tango::Attribute &attr) override
{
Action action = m_on_read[attr.get_name()];
TANGO_LOG_DEBUG << "Performing action " << to_string(action) << " for " << attr.get_name();
switch(action)
{
case Action::normal:
{
Tango::DevDouble &value = m_values[attr.get_name()];
value = k_normal_value;
attr.set_value(&value);
break;
}
case Action::alarm:
{
Tango::DevDouble &value = m_values[attr.get_name()];
value = k_alarming_value;
attr.set_value(&value);
break;
}
case Action::except:
TANGO_THROW_EXCEPTION(k_test_reason, k_a_helpful_desc);
default:
TANGO_ASSERT_ON_DEFAULT(action);
}
}
bool has_dev_state_been_called()
{
return m_dev_state_called;
}
void set_actions(const Tango::DevVarStringArray &args)
{
if(args.length() != 3)
{
std::stringstream ss;
ss << "length (= " << args.length() << ") != 3";
TANGO_THROW_EXCEPTION(Tango::API_InvalidArgs, ss.str());
}
for(Tango::DevULong i = 0; i < args.length(); ++i)
{
std::string attr_name = [](Tango::DevULong num)
{
std::stringstream ss;
ss << "attr" << num;
return ss.str();
}(i + 1);
TANGO_LOG_DEBUG << "Setting action " << args[i].in() << " for " << attr_name;
Action action = action_from_string(args[i].in());
m_on_read[attr_name] = action;
}
}
static void attribute_factory(std::vector<Tango::Attr *> &attrs)
{
Tango::UserDefaultAttrProp props;
props.set_max_alarm(std::to_string(k_alarm_level).c_str());
attrs.push_back(new TangoTest::AutoAttr<&DevStateExcept::read_attr>("attr1", Tango::DEV_DOUBLE));
attrs.back()->set_default_properties(props);
attrs.push_back(new TangoTest::AutoAttr<&DevStateExcept::read_attr>("attr2", Tango::DEV_DOUBLE));
attrs.back()->set_default_properties(props);
attrs.push_back(new TangoTest::AutoAttr<&DevStateExcept::read_attr>("attr3", Tango::DEV_DOUBLE));
attrs.back()->set_default_properties(props);
}
static void command_factory(std::vector<Tango::Command *> &cmds)
{
cmds.push_back(new TangoTest::AutoCommand<&DevStateExcept::set_actions>("set_actions"));
cmds.push_back(
new TangoTest::AutoCommand<&DevStateExcept::has_dev_state_been_called>("has_dev_state_been_called"));
cmds.push_back(new TangoTest::AutoCommand<&DevStateExcept::reset_dev_state_called>("reset_dev_state_called"));
}
private:
std::unordered_map<std::string, Action> m_on_read;
std::unordered_map<std::string, Tango::DevDouble> m_values;
bool m_dev_state_called = false;
};
TANGO_TEST_AUTO_DEV_TMPL_INSTANTIATE(DevStateExcept, 1)
SCENARIO("dev_state works with exceptions")
{
int idlver = GENERATE(TangoTest::idlversion(1));
GIVEN("a device proxy to a simple IDLv" << idlver << " device")
{
TangoTest::Context ctx{"state", "DevStateExcept", idlver};
std::unique_ptr<Tango::DeviceProxy> device = ctx.get_proxy();
struct TestData
{
std::array<const char *, 3> actions;
Tango::DevState expected;
};
auto data = GENERATE(TestData{{"normal", "normal", "normal"}, Tango::ON},
TestData{{"normal", "except", "normal"}, Tango::ON},
TestData{{"alarm", "normal", "normal"}, Tango::ALARM},
TestData{{"alarm", "except", "normal"}, Tango::ALARM},
TestData{{"normal", "except", "alarm"}, Tango::ALARM});
WHEN("we prime attributes with " << Catch::StringMaker<decltype(data.actions)>::convert(data.actions)
<< " actions")
{
Tango::DeviceData args;
Tango::DevVarStringArray actions;
actions.length(3);
actions[0] = data.actions[0];
actions[1] = data.actions[1];
actions[2] = data.actions[2];
args << actions;
REQUIRE_NOTHROW(device->command_inout("set_actions", args));
AND_WHEN("we call the State command")
{
Tango::DeviceData dd;
REQUIRE_NOTHROW(dd = device->command_inout("State"));
THEN("we find an " << Tango::DevStateName[data.expected] << " state")
{
using TangoTest::AnyLikeContains;
REQUIRE_THAT(dd, AnyLikeContains(data.expected));
}
}
// Reading the "State" attribute is only available from IDLv3
// onwards.
if(idlver >= 3)
{
AND_WHEN("we read the State attribute")
{
Tango::DeviceAttribute da;
REQUIRE_NOTHROW(da = device->read_attribute("State"));
THEN("we find an " << Tango::DevStateName[data.expected] << " state")
{
using TangoTest::AnyLikeContains;
REQUIRE_THAT(da, AnyLikeContains(data.expected));
}
}
}
}
}
}
SCENARIO("user dev_state is always called")
{
int idlver = GENERATE(TangoTest::idlversion(3));
GIVEN("a device proxy to a simple IDLv" << idlver << " device in ALARM state")
{
using TangoTest::AnyLikeContains;
TangoTest::Context ctx{"state", "DevStateExcept", idlver};
std::unique_ptr<Tango::DeviceProxy> device = ctx.get_proxy();
Tango::DeviceData args;
Tango::DevVarStringArray actions;
actions.length(3);
actions[0] = "alarm";
actions[1] = "normal";
actions[2] = "normal";
args << actions;
REQUIRE_NOTHROW(device->command_inout("set_actions", args));
Tango::DeviceData dd;
REQUIRE_NOTHROW(dd = device->command_inout("State"));
REQUIRE_THAT(dd, AnyLikeContains(Tango::ALARM));
REQUIRE_NOTHROW(dd = device->command_inout("reset_dev_state_called"));
WHEN("we prime the alarming attribute to throw an exception")
{
actions[0] = "except";
actions[1] = "normal";
actions[2] = "normal";
args << actions;
REQUIRE_NOTHROW(device->command_inout("set_actions", args));
AND_WHEN("we read the throwing attribute and State")
{
using UniquePtr = std::unique_ptr<std::vector<Tango::DeviceAttribute>>;
using TangoTest::AnyErrorMatches;
using TangoTest::AnyLikeContains;
using TangoTest::Reason;
UniquePtr das;
REQUIRE_NOTHROW(das = UniquePtr{device->read_attributes({"attr1", "State"})});
THEN("it returns an exception for the throwing attribute and ON for the State")
{
Tango::DevDouble value;
REQUIRE_THROWS_MATCHES(
(*das)[0] >> value, Tango::DevFailed, AnyErrorMatches(Reason(k_test_reason)));
REQUIRE_THAT((*das)[1], AnyLikeContains(Tango::ALARM));
AND_THEN("we find that dev_state() has been called")
{
using TangoTest::AnyLikeContains;
Tango::DeviceData dd;
REQUIRE_NOTHROW(dd = device->command_inout("has_dev_state_been_called"));
REQUIRE_THAT(dd, AnyLikeContains(true));
}
}
}
}
}
}
|