osmo-python-tests/osmopy/osmo_verify_transcript_ctrl.py

121 lines
3.8 KiB
Python
Executable File

#!/usr/bin/env python3
#
# (C) 2017 by sysmocom s.f.m.c. GmbH <info@sysmocom.de>
# All rights reserved.
#
# Author: Neels Hofmeyr <nhofmeyr@sysmocom.de>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
'''
Run CTRL test transcripts against a given application.
A CTRL transcript contains CTRL commands and their expected results.
It looks like:
"
SET 1 var val
SET_REPLY 1 var OK
GET 2 var
GET_REPLY 2 var val
"
The application to be tested is described by
- a binary to run,
- command line arguments to pass to the binary,
- the CTRL port.
This module can either be run directly to run or update a given CTRL transcript,
or it can be imported as a module to run more complex setups.
'''
import re
from osmopy.osmo_verify_transcript_common import *
from osmopy.osmo_ipa import Ctrl, IPA
class InteractCtrl(Interact):
next_id = 1
keep_ids = True
re_command = re.compile('^(SET|GET) ([^ ]*) (.*)$')
class CtrlStep(Interact.StepBase):
@staticmethod
def is_next_step(line, interact_instance):
m = InteractCtrl.re_command.match(line)
if not m:
return None
next_step = InteractCtrl.CtrlStep()
set_get = m.group(1)
cmd_id = m.group(2)
var_val = m.group(3)
if not interact_instance.keep_ids:
cmd_id = interact_instance.next_id
interact_instance.next_id += 1
next_step.command = '%s %s %s' % (set_get, cmd_id, var_val)
return next_step
def __init__(self, port, host, verbose=False, update=False, keep_ids=True):
if not update:
keep_ids = True
self.keep_ids = keep_ids
super().__init__(InteractCtrl.CtrlStep, port=port, host=host, verbose=verbose, update=update)
def connect(self):
self.next_id = 1
super().connect()
def send(self, data):
data = Ctrl().add_header(data)
return self.socket.send(data) == len(data)
def receive(self):
responses = []
data = self.socket.recv(4096)
while (len(data)>0):
(response_with_header, data) = IPA().split_combined(data)
response = Ctrl().rem_header(response_with_header)
responses.append(response.decode('utf-8'))
return responses
def command(self, command):
assert self.send(command)
res = self.receive()
split_responses = []
for r in res:
split_responses.extend(r.splitlines())
sys.stdout.flush()
sys.stderr.flush()
return split_responses
if __name__ == '__main__':
parser = common_parser()
parser.add_argument('-i', '--keep-ids', dest='keep_ids', action='store_true',
help='With --update, default is to overwrite the command IDs'
' so that they are consecutive numbers starting from 1.'
' With --keep-ids, do not change these command IDs.')
args = parser.parse_args()
interact = InteractCtrl(args.port, args.host, args.verbose, args.update, args.keep_ids)
main(command_str=args.command_str,
transcript_files=args.transcript_files,
interact=interact,
verbose=args.verbose)
# vim: tabstop=4 shiftwidth=4 expandtab nocin ai