<p>fixeria has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.osmocom.org/c/osmocom-bb/+/15296">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">trx_toolkit/data_msg.py: raise exceptions from validate() methods<br><br>Raising exceptions is a Pythonic way to handle errors, which in this<br>particular case will help us to know *why* exactly a given message<br>is incorrect or incomplete.<br><br>Change-Id: Ia961f83c717066af61699c80536468392b8ce064<br>---<br>M src/target/trx_toolkit/data_dump.py<br>M src/target/trx_toolkit/data_if.py<br>M src/target/trx_toolkit/data_msg.py<br>3 files changed, 74 insertions(+), 61 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.osmocom.org:29418/osmocom-bb refs/changes/96/15296/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/target/trx_toolkit/data_dump.py b/src/target/trx_toolkit/data_dump.py</span><br><span>index 97518bd..da42023 100644</span><br><span>--- a/src/target/trx_toolkit/data_dump.py</span><br><span>+++ b/src/target/trx_toolkit/data_dump.py</span><br><span>@@ -296,7 +296,7 @@</span><br><span> assert(messages_check[i].tn == messages_ref[i].tn)</span><br><span> </span><br><span> # Validate a message</span><br><span style="color: hsl(0, 100%, 40%);">- assert(messages_check[i].validate())</span><br><span style="color: hsl(120, 100%, 40%);">+ messages_check[i].validate()</span><br><span> </span><br><span> log.info("Check append_msg(): OK")</span><br><span> </span><br><span>@@ -318,7 +318,7 @@</span><br><span> assert(messages_check[i].tn == messages_ref[i].tn)</span><br><span> </span><br><span> # Validate a message</span><br><span style="color: hsl(0, 100%, 40%);">- assert(messages_check[i].validate())</span><br><span style="color: hsl(120, 100%, 40%);">+ messages_check[i].validate()</span><br><span> </span><br><span> log.info("Check append_all(): OK")</span><br><span> </span><br><span>@@ -340,8 +340,8 @@</span><br><span> assert(msg10.tn == messages_ref[10].tn)</span><br><span> </span><br><span> # Validate both messages</span><br><span style="color: hsl(0, 100%, 40%);">- assert(msg0.validate())</span><br><span style="color: hsl(0, 100%, 40%);">- assert(msg10.validate())</span><br><span style="color: hsl(120, 100%, 40%);">+ msg0.validate()</span><br><span style="color: hsl(120, 100%, 40%);">+ msg10.validate()</span><br><span> </span><br><span> log.info("Check parse_msg(): OK")</span><br><span> </span><br><span>@@ -362,6 +362,6 @@</span><br><span> assert(messages_check[i].tn == messages_ref[i + 10].tn)</span><br><span> </span><br><span> # Validate a message</span><br><span style="color: hsl(0, 100%, 40%);">- assert(messages_check[i].validate())</span><br><span style="color: hsl(120, 100%, 40%);">+ messages_check[i].validate()</span><br><span> </span><br><span> log.info("Check parse_all(): OK")</span><br><span>diff --git a/src/target/trx_toolkit/data_if.py b/src/target/trx_toolkit/data_if.py</span><br><span>index e43b388..418c3f8 100644</span><br><span>--- a/src/target/trx_toolkit/data_if.py</span><br><span>+++ b/src/target/trx_toolkit/data_if.py</span><br><span>@@ -107,8 +107,7 @@</span><br><span> </span><br><span> def send_msg(self, msg, legacy = False):</span><br><span> # Validate a message</span><br><span style="color: hsl(0, 100%, 40%);">- if not msg.validate():</span><br><span style="color: hsl(0, 100%, 40%);">- raise ValueError("Message incomplete or incorrect")</span><br><span style="color: hsl(120, 100%, 40%);">+ msg.validate()</span><br><span> </span><br><span> # Generate TRX message</span><br><span> payload = msg.gen_msg(legacy)</span><br><span>diff --git a/src/target/trx_toolkit/data_msg.py b/src/target/trx_toolkit/data_msg.py</span><br><span>index de5f908..a1046ec 100644</span><br><span>--- a/src/target/trx_toolkit/data_msg.py</span><br><span>+++ b/src/target/trx_toolkit/data_msg.py</span><br><span>@@ -227,30 +227,27 @@</span><br><span> </span><br><span> return buf</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- # Validates the message fields</span><br><span style="color: hsl(120, 100%, 40%);">+ # Validates the message fields (throws ValueError)</span><br><span> def validate(self):</span><br><span> if not self.ver in self.known_versions:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("Unknown TRXD header version")</span><br><span> </span><br><span> if self.fn is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("TDMA frame-number is not set")</span><br><span> </span><br><span> if self.fn < 0 or self.fn > GSM_HYPERFRAME:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("TDMA frame-number %d is out of range" % self.fn)</span><br><span> </span><br><span> if self.tn is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("TDMA time-slot is not set")</span><br><span> </span><br><span> if self.tn < 0 or self.tn > 7:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- return True</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("TDMA time-slot %d is out of range" % self.tn)</span><br><span> </span><br><span> # Generates a TRX DATA message</span><br><span> def gen_msg(self, legacy = False):</span><br><span> # Validate all the fields</span><br><span style="color: hsl(0, 100%, 40%);">- if not self.validate():</span><br><span style="color: hsl(0, 100%, 40%);">- raise ValueError("Message incomplete or incorrect")</span><br><span style="color: hsl(120, 100%, 40%);">+ self.validate()</span><br><span> </span><br><span> # Allocate an empty byte-array</span><br><span> buf = bytearray()</span><br><span>@@ -342,27 +339,24 @@</span><br><span> </span><br><span> return length</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- # Validates the message fields</span><br><span style="color: hsl(120, 100%, 40%);">+ # Validates the message fields (throws ValueError)</span><br><span> def validate(self):</span><br><span> # Validate common fields</span><br><span style="color: hsl(0, 100%, 40%);">- if not DATAMSG.validate(self):</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ DATAMSG.validate(self)</span><br><span> </span><br><span> if self.pwr is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("Tx Attenuation level is not set")</span><br><span> </span><br><span> if self.pwr < self.PWR_MIN or self.pwr > self.PWR_MAX:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("Tx Attenuation %d is out of range" % self.pwr)</span><br><span> </span><br><span> # FIXME: properly handle IDLE / NOPE indications</span><br><span> if self.burst is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("Tx burst bits are not set")</span><br><span> </span><br><span> # FIXME: properly handle IDLE / NOPE indications</span><br><span> if len(self.burst) not in (GSM_BURST_LEN, EDGE_BURST_LEN):</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- return True</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("Tx burst has odd length %u" % len(self.burst))</span><br><span> </span><br><span> # Generates a random power level</span><br><span> def rand_pwr(self, min = None, max = None):</span><br><span>@@ -582,85 +576,77 @@</span><br><span> def _validate_burst_v0(self):</span><br><span> # Burst is mandatory</span><br><span> if self.burst is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("Rx burst bits are not set")</span><br><span> </span><br><span> # ... and can be either of GSM (GMSK) or EDGE (8-PSK)</span><br><span> if len(self.burst) not in (GSM_BURST_LEN, EDGE_BURST_LEN):</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- return True</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("Rx burst has odd length %u" % len(self.burst))</span><br><span> </span><br><span> def _validate_burst_v1(self):</span><br><span> # Burst is omitted in case of an IDLE / NOPE indication</span><br><span> if self.nope_ind and self.burst is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return True</span><br><span style="color: hsl(0, 100%, 40%);">- if self.nope_ind and self.burst is not None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ return</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ if self.nope_ind and self.burst is not None:</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("NOPE.ind comes with burst?!?")</span><br><span> if self.burst is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("Rx burst bits are not set")</span><br><span> </span><br><span> # Burst length depends on modulation type</span><br><span> if len(self.burst) != self.mod_type.bl:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("Rx burst has odd length %u" % len(self.burst))</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- return True</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- # Validates the burst</span><br><span style="color: hsl(120, 100%, 40%);">+ # Validates the burst (throws ValueError)</span><br><span> def validate_burst(self):</span><br><span> if self.ver == 0x00:</span><br><span style="color: hsl(0, 100%, 40%);">- return self._validate_burst_v0()</span><br><span style="color: hsl(120, 100%, 40%);">+ self._validate_burst_v0()</span><br><span> elif self.ver >= 0x01:</span><br><span style="color: hsl(0, 100%, 40%);">- return self._validate_burst_v1()</span><br><span style="color: hsl(120, 100%, 40%);">+ self._validate_burst_v1()</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- # Validates the message header fields</span><br><span style="color: hsl(120, 100%, 40%);">+ # Validates the message header fields (throws ValueError)</span><br><span> def validate(self):</span><br><span> # Validate common fields</span><br><span style="color: hsl(0, 100%, 40%);">- if not DATAMSG.validate(self):</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ DATAMSG.validate(self)</span><br><span> </span><br><span> if self.rssi is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("RSSI is not set")</span><br><span> </span><br><span> if self.rssi < self.RSSI_MIN or self.rssi > self.RSSI_MAX:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("RSSI %d is out of range" % self.rssi)</span><br><span> </span><br><span> if self.toa256 is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("ToA256 is not set")</span><br><span> </span><br><span> if self.toa256 < self.TOA256_MIN or self.toa256 > self.TOA256_MAX:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("ToA256 %d is out of range" % self.toa256)</span><br><span> </span><br><span> if self.ver >= 0x01:</span><br><span> if type(self.mod_type) is not Modulation:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("Unknown Rx modulation type")</span><br><span> </span><br><span> if self.tsc_set is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("TSC set is not set")</span><br><span> </span><br><span> if self.mod_type is Modulation.ModGMSK:</span><br><span> if self.tsc_set not in range(0, 4):</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("TSC set %d is out of range" % self.tsc_set)</span><br><span> else:</span><br><span> if self.tsc_set not in range(0, 2):</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("TSC set %d is out of range" % self.tsc_set)</span><br><span> </span><br><span> if self.tsc is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("TSC is not set")</span><br><span> </span><br><span> if self.tsc not in self.TSC_RANGE:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("TSC %d is out of range" % self.tsc)</span><br><span> </span><br><span> if self.ci is None:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("C/I is not set")</span><br><span> </span><br><span> if self.ci < self.CI_MIN or self.ci > self.CI_MAX:</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ValueError("C/I %d is out of range" % self.ci)</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- if not self.validate_burst():</span><br><span style="color: hsl(0, 100%, 40%);">- return False</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span style="color: hsl(0, 100%, 40%);">- return True</span><br><span style="color: hsl(120, 100%, 40%);">+ self.validate_burst()</span><br><span> </span><br><span> # Generates a random RSSI value</span><br><span> def rand_rssi(self, min = None, max = None):</span><br><span>@@ -886,11 +872,39 @@</span><br><span> msg_l12trx_ref.rand_burst()</span><br><span> msg_trx2l1_ref.rand_burst()</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- assert(msg_l12trx_ref.validate())</span><br><span style="color: hsl(0, 100%, 40%);">- assert(msg_trx2l1_ref.validate())</span><br><span style="color: hsl(120, 100%, 40%);">+ msg_l12trx_ref.validate()</span><br><span style="color: hsl(120, 100%, 40%);">+ msg_trx2l1_ref.validate()</span><br><span> </span><br><span> log.info("Validate header randomization: OK")</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ # Test error handling for common fields</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = DATAMSG()</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Make sure that message validation throws a ValueError</span><br><span style="color: hsl(120, 100%, 40%);">+ def validate_throw(msg):</span><br><span style="color: hsl(120, 100%, 40%);">+ try:</span><br><span style="color: hsl(120, 100%, 40%);">+ msg.validate()</span><br><span style="color: hsl(120, 100%, 40%);">+ return False</span><br><span style="color: hsl(120, 100%, 40%);">+ except ValueError:</span><br><span style="color: hsl(120, 100%, 40%);">+ return True</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Unknown version</span><br><span style="color: hsl(120, 100%, 40%);">+ msg.rand_hdr()</span><br><span style="color: hsl(120, 100%, 40%);">+ msg.ver = 100</span><br><span style="color: hsl(120, 100%, 40%);">+ assert(validate_throw(msg))</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Uninitialized field</span><br><span style="color: hsl(120, 100%, 40%);">+ msg.rand_hdr()</span><br><span style="color: hsl(120, 100%, 40%);">+ msg.fn = None</span><br><span style="color: hsl(120, 100%, 40%);">+ assert(validate_throw(msg))</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Out-of-range value</span><br><span style="color: hsl(120, 100%, 40%);">+ msg.rand_hdr()</span><br><span style="color: hsl(120, 100%, 40%);">+ msg.tn = 10</span><br><span style="color: hsl(120, 100%, 40%);">+ assert(validate_throw(msg))</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ log.info("Check incorrect message validation: OK")</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> log.info("Encoding the reference messages")</span><br><span> </span><br><span> # Encode DATA messages</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmocom-bb/+/15296">change 15296</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmocom-bb/+/15296"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: osmocom-bb </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Ia961f83c717066af61699c80536468392b8ce064 </div>
<div style="display:none"> Gerrit-Change-Number: 15296 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: fixeria <axilirator@gmail.com> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>