FilesExpand file tree

 develop

/

test_vector.py

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

460 lines (386 loc) · 17.7 KB

 develop

/

test_vector.py

Copy path

Top

File metadata and controls

• Code
• Blame

460 lines (386 loc) · 17.7 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

#!/usr/bin/env python

"""

Test for Vector Interface

"""

import ctypes

import os

import pickle

import unittest

from unittest.mock import Mock

import pytest

import can

from can.interfaces.vector import (

canlib,

xldefine,

xlclass,

VectorError,

VectorInitializationError,

VectorOperationError,

VectorChannelConfig,

)

from test.config import IS_WINDOWS

class TestVectorBus(unittest.TestCase):

def setUp(self) -> None:

# basic mock for XLDriver

can.interfaces.vector.canlib.xldriver = Mock()

# bus creation functions

can.interfaces.vector.canlib.xldriver.xlOpenDriver = Mock()

can.interfaces.vector.canlib.xldriver.xlGetApplConfig = Mock(

side_effect=xlGetApplConfig

)

can.interfaces.vector.canlib.xldriver.xlGetChannelIndex = Mock(

side_effect=xlGetChannelIndex

)

can.interfaces.vector.canlib.xldriver.xlOpenPort = Mock(side_effect=xlOpenPort)

can.interfaces.vector.canlib.xldriver.xlCanFdSetConfiguration = Mock(

return_value=0

)

can.interfaces.vector.canlib.xldriver.xlCanSetChannelMode = Mock(return_value=0)

can.interfaces.vector.canlib.xldriver.xlActivateChannel = Mock(return_value=0)

can.interfaces.vector.canlib.xldriver.xlGetSyncTime = Mock(

side_effect=xlGetSyncTime

)

can.interfaces.vector.canlib.xldriver.xlCanSetChannelAcceptance = Mock(

return_value=0

)

can.interfaces.vector.canlib.xldriver.xlCanSetChannelBitrate = Mock(

return_value=0

)

can.interfaces.vector.canlib.xldriver.xlSetNotification = Mock(

side_effect=xlSetNotification

)

# bus deactivation functions

can.interfaces.vector.canlib.xldriver.xlDeactivateChannel = Mock(return_value=0)

can.interfaces.vector.canlib.xldriver.xlClosePort = Mock(return_value=0)

can.interfaces.vector.canlib.xldriver.xlCloseDriver = Mock()

# sender functions

can.interfaces.vector.canlib.xldriver.xlCanTransmit = Mock(return_value=0)

can.interfaces.vector.canlib.xldriver.xlCanTransmitEx = Mock(return_value=0)

# various functions

can.interfaces.vector.canlib.xldriver.xlCanFlushTransmitQueue = Mock()

can.interfaces.vector.canlib.WaitForSingleObject = Mock()

self.bus = None

def tearDown(self) -> None:

if self.bus:

self.bus.shutdown()

self.bus = None

def test_bus_creation(self) -> None:

self.bus = can.Bus(channel=0, bustype="vector", _testing=True)

self.assertIsInstance(self.bus, canlib.VectorBus)

can.interfaces.vector.canlib.xldriver.xlOpenDriver.assert_called()

can.interfaces.vector.canlib.xldriver.xlGetApplConfig.assert_called()

can.interfaces.vector.canlib.xldriver.xlOpenPort.assert_called()

xlOpenPort_args = can.interfaces.vector.canlib.xldriver.xlOpenPort.call_args[0]

self.assertEqual(

xlOpenPort_args[5], xldefine.XL_InterfaceVersion.XL_INTERFACE_VERSION.value

)

self.assertEqual(xlOpenPort_args[6], xldefine.XL_BusTypes.XL_BUS_TYPE_CAN.value)

can.interfaces.vector.canlib.xldriver.xlCanFdSetConfiguration.assert_not_called()

can.interfaces.vector.canlib.xldriver.xlCanSetChannelBitrate.assert_not_called()

def test_bus_creation_bitrate(self) -> None:

self.bus = can.Bus(channel=0, bustype="vector", bitrate=200000, _testing=True)

self.assertIsInstance(self.bus, canlib.VectorBus)

can.interfaces.vector.canlib.xldriver.xlOpenDriver.assert_called()

can.interfaces.vector.canlib.xldriver.xlGetApplConfig.assert_called()

can.interfaces.vector.canlib.xldriver.xlOpenPort.assert_called()

xlOpenPort_args = can.interfaces.vector.canlib.xldriver.xlOpenPort.call_args[0]

self.assertEqual(

xlOpenPort_args[5], xldefine.XL_InterfaceVersion.XL_INTERFACE_VERSION.value

)

self.assertEqual(xlOpenPort_args[6], xldefine.XL_BusTypes.XL_BUS_TYPE_CAN.value)

can.interfaces.vector.canlib.xldriver.xlCanFdSetConfiguration.assert_not_called()

can.interfaces.vector.canlib.xldriver.xlCanSetChannelBitrate.assert_called()

xlCanSetChannelBitrate_args = (

can.interfaces.vector.canlib.xldriver.xlCanSetChannelBitrate.call_args[0]

)

self.assertEqual(xlCanSetChannelBitrate_args[2], 200000)

def test_bus_creation_fd(self) -> None:

self.bus = can.Bus(channel=0, bustype="vector", fd=True, _testing=True)

self.assertIsInstance(self.bus, canlib.VectorBus)

can.interfaces.vector.canlib.xldriver.xlOpenDriver.assert_called()

can.interfaces.vector.canlib.xldriver.xlGetApplConfig.assert_called()

can.interfaces.vector.canlib.xldriver.xlOpenPort.assert_called()

xlOpenPort_args = can.interfaces.vector.canlib.xldriver.xlOpenPort.call_args[0]

self.assertEqual(

xlOpenPort_args[5],

xldefine.XL_InterfaceVersion.XL_INTERFACE_VERSION_V4.value,

)

self.assertEqual(xlOpenPort_args[6], xldefine.XL_BusTypes.XL_BUS_TYPE_CAN.value)

can.interfaces.vector.canlib.xldriver.xlCanFdSetConfiguration.assert_called()

can.interfaces.vector.canlib.xldriver.xlCanSetChannelBitrate.assert_not_called()

def test_bus_creation_fd_bitrate_timings(self) -> None:

self.bus = can.Bus(

channel=0,

bustype="vector",

fd=True,

bitrate=500000,

data_bitrate=2000000,

sjw_abr=10,

tseg1_abr=11,

tseg2_abr=12,

sjw_dbr=13,

tseg1_dbr=14,

tseg2_dbr=15,

_testing=True,

)

self.assertIsInstance(self.bus, canlib.VectorBus)

can.interfaces.vector.canlib.xldriver.xlOpenDriver.assert_called()

can.interfaces.vector.canlib.xldriver.xlGetApplConfig.assert_called()

can.interfaces.vector.canlib.xldriver.xlOpenPort.assert_called()

xlOpenPort_args = can.interfaces.vector.canlib.xldriver.xlOpenPort.call_args[0]

self.assertEqual(

xlOpenPort_args[5],

xldefine.XL_InterfaceVersion.XL_INTERFACE_VERSION_V4.value,

)

self.assertEqual(xlOpenPort_args[6], xldefine.XL_BusTypes.XL_BUS_TYPE_CAN.value)

can.interfaces.vector.canlib.xldriver.xlCanFdSetConfiguration.assert_called()

can.interfaces.vector.canlib.xldriver.xlCanSetChannelBitrate.assert_not_called()

xlCanFdSetConfiguration_args = (

can.interfaces.vector.canlib.xldriver.xlCanFdSetConfiguration.call_args[0]

)

canFdConf = xlCanFdSetConfiguration_args[2]

self.assertEqual(canFdConf.arbitrationBitRate, 500000)

self.assertEqual(canFdConf.dataBitRate, 2000000)

self.assertEqual(canFdConf.sjwAbr, 10)

self.assertEqual(canFdConf.tseg1Abr, 11)

self.assertEqual(canFdConf.tseg2Abr, 12)

self.assertEqual(canFdConf.sjwDbr, 13)

self.assertEqual(canFdConf.tseg1Dbr, 14)

self.assertEqual(canFdConf.tseg2Dbr, 15)

def test_receive(self) -> None:

can.interfaces.vector.canlib.xldriver.xlReceive = Mock(side_effect=xlReceive)

self.bus = can.Bus(channel=0, bustype="vector", _testing=True)

self.bus.recv(timeout=0.05)

can.interfaces.vector.canlib.xldriver.xlReceive.assert_called()

can.interfaces.vector.canlib.xldriver.xlCanReceive.assert_not_called()

def test_receive_fd(self) -> None:

can.interfaces.vector.canlib.xldriver.xlCanReceive = Mock(

side_effect=xlCanReceive

)

self.bus = can.Bus(channel=0, bustype="vector", fd=True, _testing=True)

self.bus.recv(timeout=0.05)

can.interfaces.vector.canlib.xldriver.xlReceive.assert_not_called()

can.interfaces.vector.canlib.xldriver.xlCanReceive.assert_called()

def test_receive_non_msg_event(self) -> None:

can.interfaces.vector.canlib.xldriver.xlReceive = Mock(

side_effect=xlReceive_chipstate

)

self.bus = can.Bus(channel=0, bustype="vector", _testing=True)

self.bus.handle_can_event = Mock()

self.bus.recv(timeout=0.05)

can.interfaces.vector.canlib.xldriver.xlReceive.assert_called()

can.interfaces.vector.canlib.xldriver.xlCanReceive.assert_not_called()

self.bus.handle_can_event.assert_called()

def test_receive_fd_non_msg_event(self) -> None:

can.interfaces.vector.canlib.xldriver.xlCanReceive = Mock(

side_effect=xlCanReceive_chipstate

)

self.bus = can.Bus(channel=0, bustype="vector", fd=True, _testing=True)

self.bus.handle_canfd_event = Mock()

self.bus.recv(timeout=0.05)

can.interfaces.vector.canlib.xldriver.xlReceive.assert_not_called()

can.interfaces.vector.canlib.xldriver.xlCanReceive.assert_called()

self.bus.handle_canfd_event.assert_called()

def test_send(self) -> None:

self.bus = can.Bus(channel=0, bustype="vector", _testing=True)

msg = can.Message(

arbitration_id=0xC0FFEF, data=[1, 2, 3, 4, 5, 6, 7, 8], is_extended_id=True

)

self.bus.send(msg)

can.interfaces.vector.canlib.xldriver.xlCanTransmit.assert_called()

can.interfaces.vector.canlib.xldriver.xlCanTransmitEx.assert_not_called()

def test_send_fd(self) -> None:

self.bus = can.Bus(channel=0, bustype="vector", fd=True, _testing=True)

msg = can.Message(

arbitration_id=0xC0FFEF, data=[1, 2, 3, 4, 5, 6, 7, 8], is_extended_id=True

)

self.bus.send(msg)

can.interfaces.vector.canlib.xldriver.xlCanTransmit.assert_not_called()

can.interfaces.vector.canlib.xldriver.xlCanTransmitEx.assert_called()

def test_flush_tx_buffer(self) -> None:

self.bus = can.Bus(channel=0, bustype="vector", _testing=True)

self.bus.flush_tx_buffer()

can.interfaces.vector.canlib.xldriver.xlCanFlushTransmitQueue.assert_called()

def test_shutdown(self) -> None:

self.bus = can.Bus(channel=0, bustype="vector", _testing=True)

self.bus.shutdown()

can.interfaces.vector.canlib.xldriver.xlDeactivateChannel.assert_called()

can.interfaces.vector.canlib.xldriver.xlClosePort.assert_called()

can.interfaces.vector.canlib.xldriver.xlCloseDriver.assert_called()

def test_reset(self) -> None:

self.bus = can.Bus(channel=0, bustype="vector", _testing=True)

self.bus.reset()

can.interfaces.vector.canlib.xldriver.xlDeactivateChannel.assert_called()

can.interfaces.vector.canlib.xldriver.xlActivateChannel.assert_called()

def test_popup_hw_cfg(self) -> None:

canlib.xldriver.xlPopupHwConfig = Mock()

canlib.VectorBus.popup_vector_hw_configuration(10)

assert canlib.xldriver.xlPopupHwConfig.called

args, kwargs = canlib.xldriver.xlPopupHwConfig.call_args

assert isinstance(args[0], ctypes.c_char_p)

assert isinstance(args[1], ctypes.c_uint)

def test_get_application_config(self) -> None:

canlib.xldriver.xlGetApplConfig = Mock()

canlib.VectorBus.get_application_config(app_name="CANalyzer", app_channel=0)

assert canlib.xldriver.xlGetApplConfig.called

def test_set_application_config(self) -> None:

canlib.xldriver.xlSetApplConfig = Mock()

canlib.VectorBus.set_application_config(

app_name="CANalyzer",

app_channel=0,

hw_type=xldefine.XL_HardwareType.XL_HWTYPE_VN1610,

hw_index=0,

hw_channel=0,

)

assert canlib.xldriver.xlSetApplConfig.called

def test_set_timer_rate(self) -> None:

canlib.xldriver.xlSetTimerRate = Mock()

bus: canlib.VectorBus = can.Bus(

channel=0, bustype="vector", fd=True, _testing=True

)

bus.set_timer_rate(timer_rate_ms=1)

assert canlib.xldriver.xlSetTimerRate.called

def test_called_without_testing_argument(self) -> None:

"""This tests if an exception is thrown when we are not running on Windows."""

if os.name != "nt":

with self.assertRaises(can.CanInterfaceNotImplementedError):

# do not set the _testing argument, since it would suppress the exception

can.Bus(channel=0, bustype="vector")

def test_vector_error_pickle(self) -> None:

for error_type in [

VectorError,

VectorInitializationError,

VectorOperationError,

]:

with self.subTest(f"error_type = {error_type.__name__}"):

error_code = 118

error_string = "XL_ERROR"

function = "function_name"

exc = error_type(error_code, error_string, function)

# pickle and unpickle

p = pickle.dumps(exc)

exc_unpickled: VectorError = pickle.loads(p)

self.assertEqual(str(exc), str(exc_unpickled))

self.assertEqual(error_code, exc_unpickled.error_code)

with pytest.raises(error_type):

raise exc_unpickled

def test_vector_subtype_error_from_generic(self) -> None:

for error_type in [VectorInitializationError, VectorOperationError]:

with self.subTest(f"error_type = {error_type.__name__}"):

error_code = 118

error_string = "XL_ERROR"

function = "function_name"

generic = VectorError(error_code, error_string, function)

# pickle and unpickle

specific: VectorError = error_type.from_generic(generic)

self.assertEqual(str(generic), str(specific))

self.assertEqual(error_code, specific.error_code)

with pytest.raises(error_type):

raise specific

@unittest.skipUnless(IS_WINDOWS, "Windows specific test")

def test_winapi_availability(self) -> None:

self.assertIsNotNone(canlib.WaitForSingleObject)

self.assertIsNotNone(canlib.INFINITE)

class TestVectorChannelConfig:

def test_attributes(self):

assert hasattr(VectorChannelConfig, "name")

assert hasattr(VectorChannelConfig, "hwType")

assert hasattr(VectorChannelConfig, "hwIndex")

assert hasattr(VectorChannelConfig, "hwChannel")

assert hasattr(VectorChannelConfig, "channelIndex")

assert hasattr(VectorChannelConfig, "channelMask")

assert hasattr(VectorChannelConfig, "channelCapabilities")

assert hasattr(VectorChannelConfig, "channelBusCapabilities")

assert hasattr(VectorChannelConfig, "isOnBus")

assert hasattr(VectorChannelConfig, "connectedBusType")

assert hasattr(VectorChannelConfig, "serialNumber")

assert hasattr(VectorChannelConfig, "articleNumber")

assert hasattr(VectorChannelConfig, "transceiverName")

def xlGetApplConfig(

app_name_p: ctypes.c_char_p,

app_channel: ctypes.c_uint,

hw_type: ctypes.POINTER(ctypes.c_uint),

hw_index: ctypes.POINTER(ctypes.c_uint),

hw_channel: ctypes.POINTER(ctypes.c_uint),

bus_type: ctypes.c_uint,

) -> int:

hw_type.value = 1

hw_channel.value = 0

return 0

def xlGetChannelIndex(

hw_type: ctypes.c_int, hw_index: ctypes.c_int, hw_channel: ctypes.c_int

) -> int:

return hw_channel

def xlOpenPort(

port_handle_p: ctypes.POINTER(xlclass.XLportHandle),

app_name_p: ctypes.c_char_p,

access_mask: xlclass.XLaccess,

permission_mask_p: ctypes.POINTER(xlclass.XLaccess),

rx_queue_size: ctypes.c_uint,

xl_interface_version: ctypes.c_uint,

bus_type: ctypes.c_uint,

) -> int:

port_handle_p.value = 0

return 0

def xlGetSyncTime(

port_handle: xlclass.XLportHandle, time_p: ctypes.POINTER(xlclass.XLuint64)

) -> int:

time_p.value = 544219859027581

return 0

def xlSetNotification(

port_handle: xlclass.XLportHandle,

event_handle: ctypes.POINTER(xlclass.XLhandle),

queue_level: ctypes.c_int,

) -> int:

event_handle.value = 520

return 0

def xlReceive(

port_handle: xlclass.XLportHandle,

event_count_p: ctypes.POINTER(ctypes.c_uint),

event: ctypes.POINTER(xlclass.XLevent),

) -> int:

event.tag = xldefine.XL_EventTags.XL_RECEIVE_MSG.value

event.tagData.msg.id = 0x123

event.tagData.msg.dlc = 8

event.tagData.msg.flags = 0

event.timeStamp = 0

event.chanIndex = 0

for idx, value in enumerate([1, 2, 3, 4, 5, 6, 7, 8]):

event.tagData.msg.data[idx] = value

return 0

def xlCanReceive(

port_handle: xlclass.XLportHandle, event: ctypes.POINTER(xlclass.XLcanRxEvent)

) -> int:

event.tag = xldefine.XL_CANFD_RX_EventTags.XL_CAN_EV_TAG_RX_OK.value

event.tagData.canRxOkMsg.canId = 0x123

event.tagData.canRxOkMsg.dlc = 8

event.tagData.canRxOkMsg.msgFlags = 0

event.timeStamp = 0

event.chanIndex = 0

for idx, value in enumerate([1, 2, 3, 4, 5, 6, 7, 8]):

event.tagData.canRxOkMsg.data[idx] = value

return 0

def xlReceive_chipstate(

port_handle: xlclass.XLportHandle,

event_count_p: ctypes.POINTER(ctypes.c_uint),

event: ctypes.POINTER(xlclass.XLevent),

) -> int:

event.tag = xldefine.XL_EventTags.XL_CHIP_STATE.value

event.tagData.chipState.busStatus = 8

event.tagData.chipState.rxErrorCounter = 0

event.tagData.chipState.txErrorCounter = 0

event.timeStamp = 0

event.chanIndex = 2

return 0

def xlCanReceive_chipstate(

port_handle: xlclass.XLportHandle, event: ctypes.POINTER(xlclass.XLcanRxEvent)

) -> int:

event.tag = xldefine.XL_CANFD_RX_EventTags.XL_CAN_EV_TAG_CHIP_STATE.value

event.tagData.canChipState.busStatus = 8

event.tagData.canChipState.rxErrorCounter = 0

event.tagData.canChipState.txErrorCounter = 0

event.timeStamp = 0

event.chanIndex = 2

return 0

if __name__ == "__main__":

unittest.main()