| #!/usr/bin/env python |
| |
| """ |
| Module to test JMS message types across different APIs |
| """ |
| |
| # |
| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information |
| # regarding copyright ownership. The ASF licenses this file |
| # to you under the Apache License, Version 2.0 (the |
| # "License"); you may not use this file except in compliance |
| # with the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, |
| # software distributed under the License is distributed on an |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| # KIND, either express or implied. See the License for the |
| # specific language governing permissions and limitations |
| # under the License. |
| # |
| |
| import argparse |
| import sys |
| import unittest |
| |
| from itertools import product |
| from json import dumps |
| from os import getenv, path |
| |
| from proton import symbol |
| import qpid_interop_test.broker_properties |
| import qpid_interop_test.shims |
| from qpid_interop_test.test_type_map import TestTypeMap |
| |
| |
| # TODO: propose a sensible default when installation details are worked out |
| QIT_INSTALL_PREFIX = getenv('QIT_INSTALL_PREFIX') |
| if QIT_INSTALL_PREFIX is None: |
| print 'ERROR: Environment variable QIT_INSTALL_PREFIX is not set' |
| sys.exit(1) |
| QIT_TEST_SHIM_HOME = path.join(QIT_INSTALL_PREFIX, 'libexec', 'qpid_interop_test', 'shims') |
| |
| class JmsMessageTypes(TestTypeMap): |
| """ |
| Class which contains all the described JMS message types and the test values to be used in testing. |
| """ |
| |
| COMMON_SUBMAP = { |
| 'boolean': ['True', |
| 'False'], |
| 'byte': ['-0x80', |
| '-0x1', |
| '0x0', |
| '0x7f'], |
| 'double': ['0x0000000000000000', # 0.0 |
| '0x8000000000000000', # -0.0 |
| '0x400921fb54442eea', # pi (3.14159265359) positive decimal |
| '0xc005bf0a8b145fcf', # -e (-2.71828182846) negative decimal |
| '0x0000000000000001', # Smallest positive denormalized number |
| '0x8000000000000001', # Smallest negative denormalized number |
| '0x000fffffffffffff', # Largest positive denormalized number |
| '0x8010000000000000', # Largest negative denormalized number |
| '0x7fefffffffffffff', # Largest positive normalized number |
| '0xffefffffffffffff', # Largest negative normalized number |
| '0x7ff0000000000000', # +Infinity |
| '0xfff0000000000000', # -Infinity |
| '0x7ff8000000000000'], # +NaN |
| 'float': ['0x00000000', # 0.0 |
| '0x80000000', # -0.0 |
| '0x40490fdb', # pi (3.14159265359) positive decimal |
| '0xc02df854', # -e (-2.71828182846) negative decimal |
| '0x00000001', # Smallest positive denormalized number |
| '0x80000001', # Smallest negative denormalized number |
| '0x007fffff', # Largest positive denormalized number |
| '0x807fffff', # Largest negative denormalized number |
| '0x00800000', # Smallest positive normalized number |
| '0x80800000', # Smallest negative normalized number |
| '0x7f7fffff', # Largest positive normalized number |
| '0xff7fffff', # Largest negative normalized number |
| #'0x7f800000', # +Infinity # PROTON-1149 - fails on RHEL7 |
| #'0xff800000', # -Infinity # PROTON-1149 - fails on RHEL7 |
| '0x7fc00000'], # +NaN |
| 'int': ['-0x80000000', |
| '-0x81', |
| '-0x80', |
| '-0x1', |
| '0x0', |
| '0x7f', |
| '0x80', |
| '0x7fffffff'], |
| 'long': ['-0x8000000000000000', |
| '-0x81', |
| '-0x80', |
| '-0x1', |
| '0x0', |
| '0x7f', |
| '0x80', |
| '0x7fffffffffffffff'], |
| 'short': ['-0x8000', |
| '-0x1', |
| '0x0', |
| '0x7fff'], |
| 'string': ['', |
| 'Hello, world', |
| '"Hello, world"', |
| "Charlie's \"peach\"", |
| 'Charlie\'s "peach"', |
| 'The quick brown fox jumped over the lazy dog 0123456789.'# * 100] |
| ] |
| } |
| |
| TYPE_ADDITIONAL_SUBMAP = { |
| 'bytes': [b'', |
| b'12345', |
| b'Hello, world', |
| b'\\x01\\x02\\x03\\x04\\x05abcde\\x80\\x81\\xfe\\xff', |
| b'The quick brown fox jumped over the lazy dog 0123456789.' #* 100], |
| ], |
| 'char': ['a', |
| 'Z', |
| '\x01', |
| '\x7f'], |
| } |
| |
| # The TYPE_SUBMAP defines test values for JMS message types that allow typed message content. Note that the |
| # types defined here are understood to be *Java* types and the stringified values are to be interpreted |
| # as the appropriate Java type by the send shim. |
| TYPE_SUBMAP = TestTypeMap.merge_dicts(COMMON_SUBMAP, TYPE_ADDITIONAL_SUBMAP) |
| |
| TYPE_MAP = { |
| 'JMS_MESSAGE_TYPE': {'none': [None]}, |
| 'JMS_BYTESMESSAGE_TYPE': TYPE_SUBMAP, |
| 'JMS_MAPMESSAGE_TYPE': TYPE_SUBMAP, |
| 'JMS_STREAMMESSAGE_TYPE': TYPE_SUBMAP, |
| 'JMS_TEXTMESSAGE_TYPE': {'text': ['', |
| 'Hello, world', |
| '"Hello, world"', |
| "Charlie's \"peach\"", |
| 'Charlie\'s "peach"', |
| 'The quick brown fox jumped over the lazy dog 0123456789.' * 10 |
| ] |
| }, |
| # TODO: Add Object messages when other (non-JMS clients) can generate Java class strings used in this message |
| # type |
| #'JMS_OBJECTMESSAGE_TYPE': { |
| # 'java.lang.Boolean': ['true', |
| # 'false'], |
| # 'java.lang.Byte': ['-128', |
| # '0', |
| # '127'], |
| # 'java.lang.Character': [u'a', |
| # u'Z'], |
| # 'java.lang.Double': ['0.0', |
| # '3.141592654', |
| # '-2.71828182846'], |
| # 'java.lang.Float': ['0.0', |
| # '3.14159', |
| # '-2.71828'], |
| # 'java.lang.Integer': ['-2147483648', |
| # '-129', |
| # '-128', |
| # '-1', |
| # '0', |
| # '127', |
| # '128', |
| # '2147483647'], |
| # 'java.lang.Long' : ['-9223372036854775808', |
| # '-129', |
| # '-128', |
| # '-1', |
| # '0', |
| # '127', |
| # '128', |
| # '9223372036854775807'], |
| # 'java.lang.Short': ['-32768', |
| # '-129', |
| # '-128', |
| # '-1', |
| # '0', |
| # '127', |
| # '128', |
| # '32767'], |
| # 'java.lang.String': [u'', |
| # u'Hello, world', |
| # u'"Hello, world"', |
| # u"Charlie's \"peach\"", |
| # u'Charlie\'s "peach"'] |
| # }, |
| } |
| |
| BROKER_SKIP = {} |
| |
| |
| class JmsMessageTypeTestCase(unittest.TestCase): |
| """ |
| Abstract base class for JMS message type test cases |
| """ |
| |
| def run_test(self, sender_addr, receiver_addr, jms_message_type, test_values, send_shim, receive_shim): |
| """ |
| Run this test by invoking the shim send method to send the test values, followed by the shim receive method |
| to receive the values. Finally, compare the sent values with the received values. |
| """ |
| queue_name = 'jms.queue.qpid-interop.jms_message_type_tests.%s.%s.%s' % (jms_message_type, send_shim.NAME, |
| receive_shim.NAME) |
| |
| # First create a map containing the numbers of expected mesasges for each JMS message type |
| num_test_values_map = {} |
| if len(test_values) > 0: |
| for index in test_values.keys(): |
| num_test_values_map[index] = len(test_values[index]) |
| # Start the receiver shim |
| receiver = receive_shim.create_receiver(receiver_addr, queue_name, jms_message_type, |
| dumps(num_test_values_map)) |
| receiver.start() |
| |
| # Start the send shim |
| sender = send_shim.create_sender(sender_addr, queue_name, jms_message_type, |
| dumps(test_values)) |
| sender.start() |
| |
| # Wait for both shims to finish |
| sender.join_or_kill(qpid_interop_test.shims.THREAD_TIMEOUT) |
| receiver.join_or_kill(qpid_interop_test.shims.THREAD_TIMEOUT) |
| |
| # Process return string from sender |
| send_obj = sender.get_return_object() |
| if send_obj is not None: |
| if isinstance(send_obj, str): |
| if len(send_obj) > 0: |
| self.fail('Send shim \'%s\':\n%s' % (send_shim.NAME, send_obj)) |
| else: |
| self.fail('Send shim \'%s\':\n%s' % (send_shim.NAME, str(send_obj))) |
| |
| # Process return string from receiver |
| receive_obj = receiver.get_return_object() |
| if receive_obj is None: |
| self.fail('JmsReceiver shim returned None') |
| else: |
| if isinstance(receive_obj, tuple): |
| if len(receive_obj) == 2: |
| return_jms_message_type, return_test_values = receive_obj |
| self.assertEqual(return_jms_message_type, jms_message_type, |
| msg='JMS message type error:\n\n sent:%s\n\n received:%s' % \ |
| (jms_message_type, return_jms_message_type)) |
| self.assertEqual(return_test_values, test_values, |
| msg='JMS message body error:\n\n sent:%s\n\n received:%s' % \ |
| (test_values, return_test_values)) |
| else: |
| self.fail('Received incorrect tuple format: %s' % str(receive_obj)) |
| else: |
| self.fail('Received non-tuple: %s' % str(receive_obj)) |
| |
| |
| def create_testcase_class(jms_message_type, shim_product): |
| """ |
| Class factory function which creates new subclasses to JmsMessageTypeTestCase. Each call creates a single new |
| test case named and based on the parameters supplied to the method |
| """ |
| |
| def __repr__(self): |
| """Print the class name""" |
| return self.__class__.__name__ |
| |
| def add_test_method(cls, send_shim, receive_shim): |
| """Function which creates a new test method in class cls""" |
| |
| @unittest.skipIf(TYPES.skip_test(jms_message_type, BROKER), |
| TYPES.skip_test_message(jms_message_type, BROKER)) |
| def inner_test_method(self): |
| self.run_test(self.sender_addr, |
| self.receiver_addr, |
| self.jms_message_type, |
| self.test_values, |
| send_shim, |
| receive_shim) |
| |
| inner_test_method.__name__ = 'test_%s_%s->%s' % (jms_message_type[4:-5], send_shim.NAME, receive_shim.NAME) |
| setattr(cls, inner_test_method.__name__, inner_test_method) |
| |
| class_name = jms_message_type[4:-5].title() + 'TestCase' |
| class_dict = {'__name__': class_name, |
| '__repr__': __repr__, |
| '__doc__': 'Test case for JMS message type \'%s\'' % jms_message_type, |
| 'jms_message_type': jms_message_type, |
| 'sender_addr': ARGS.sender, |
| 'receiver_addr': ARGS.receiver, |
| 'test_values': TYPES.get_test_values(jms_message_type)} # tuple (tot_size, {...} |
| new_class = type(class_name, (JmsMessageTypeTestCase,), class_dict) |
| for send_shim, receive_shim in shim_product: |
| add_test_method(new_class, send_shim, receive_shim) |
| |
| return new_class |
| |
| |
| class TestOptions(object): |
| """ |
| Class controlling command-line arguments used to control the test. |
| """ |
| def __init__(self, shim_map): |
| parser = argparse.ArgumentParser(description='Qpid-interop AMQP client interoparability test suite ' |
| 'for JMS message types') |
| parser.add_argument('--sender', action='store', default='localhost:5672', metavar='IP-ADDR:PORT', |
| help='Node to which test suite will send messages.') |
| parser.add_argument('--receiver', action='store', default='localhost:5672', metavar='IP-ADDR:PORT', |
| help='Node from which test suite will receive messages.') |
| parser.add_argument('--no-skip', action='store_true', |
| help='Do not skip tests that are excluded by default for reasons of a known bug') |
| parser.add_argument('--broker-type', action='store', metavar='BROKER_NAME', |
| help='Disable test of broker type (using connection properties) by specifying the broker' + |
| ' name, or "None".') |
| type_group = parser.add_mutually_exclusive_group() |
| type_group.add_argument('--include-type', action='append', metavar='JMS_MESSAGE-TYPE', |
| help='Name of JMS message type to include. Supported types:\n%s' % |
| sorted(JmsMessageTypes.TYPE_MAP.keys())) |
| type_group.add_argument('--exclude-type', action='append', metavar='JMS_MESSAGE-TYPE', |
| help='Name of JMS message type to exclude. Supported types: see "include-type" above') |
| shim_group = parser.add_mutually_exclusive_group() |
| shim_group.add_argument('--include-shim', action='append', metavar='SHIM-NAME', |
| help='Name of shim to include. Supported shims:\n%s' % sorted(shim_map.keys())) |
| shim_group.add_argument('--exclude-shim', action='append', metavar='SHIM-NAME', |
| help='Name of shim to exclude. Supported shims: see "include-shim" above') |
| self.args = parser.parse_args() |
| |
| |
| #--- Main program start --- |
| |
| if __name__ == '__main__': |
| |
| PROTON_CPP_RECEIVER_SHIM = path.join(QIT_TEST_SHIM_HOME, 'qpid-proton-cpp', 'jms_messages_test', 'Receiver') |
| PROTON_CPP_SENDER_SHIM = path.join(QIT_TEST_SHIM_HOME, 'qpid-proton-cpp', 'jms_messages_test', 'Sender') |
| PROTON_PYTHON_RECEIVER_SHIM = path.join(QIT_TEST_SHIM_HOME, 'qpid-proton-python', 'jms_messages_test', 'Receiver.py') |
| PROTON_PYTHON_SENDER_SHIM = path.join(QIT_TEST_SHIM_HOME, 'qpid-proton-python', 'jms_messages_test', 'Sender.py') |
| QIT_JMS_CLASSPATH_FILE = path.join(QIT_TEST_SHIM_HOME, 'qpid-jms', 'cp.txt') |
| if path.isfile(QIT_JMS_CLASSPATH_FILE): |
| with open(QIT_JMS_CLASSPATH_FILE, 'r') as classpath_file: |
| QIT_JMS_CLASSPATH = classpath_file.read() |
| else: |
| QIT_JMS_CLASSPATH = path.join(QIT_TEST_SHIM_HOME, 'qpid-jms', '*') |
| QPID_JMS_RECEIVER_SHIM = 'org.apache.qpid.interop_test.jms_messages_test.Receiver' |
| QPID_JMS_SENDER_SHIM = 'org.apache.qpid.interop_test.jms_messages_test.Sender' |
| |
| # SHIM_MAP contains an instance of each client language shim that is to be tested as a part of this test. For |
| # every shim in this list, a test is dynamically constructed which tests it against itself as well as every |
| # other shim in the list. |
| # |
| # As new shims are added, add them into this map to have them included in the test cases. |
| SHIM_MAP = {qpid_interop_test.shims.ProtonCppShim.NAME: \ |
| qpid_interop_test.shims.ProtonCppShim(PROTON_CPP_SENDER_SHIM, PROTON_CPP_RECEIVER_SHIM), |
| qpid_interop_test.shims.ProtonPythonShim.NAME: \ |
| qpid_interop_test.shims.ProtonPythonShim(PROTON_PYTHON_SENDER_SHIM, PROTON_PYTHON_RECEIVER_SHIM), |
| qpid_interop_test.shims.QpidJmsShim.NAME: \ |
| qpid_interop_test.shims.QpidJmsShim(QIT_JMS_CLASSPATH, QPID_JMS_SENDER_SHIM, QPID_JMS_RECEIVER_SHIM), |
| } |
| |
| ARGS = TestOptions(SHIM_MAP).args |
| #print 'ARGS:', ARGS # debug |
| |
| # Add shims included from the command-line |
| if ARGS.include_shim is not None: |
| new_shim_map = {} |
| for shim in ARGS.include_shim: |
| try: |
| new_shim_map[shim] = SHIM_MAP[shim] |
| except KeyError: |
| print 'No such shim: "%s". Use --help for valid shims' % shim |
| sys.exit(1) # Errors or failures present |
| SHIM_MAP = new_shim_map |
| # Remove shims excluded from the command-line |
| elif ARGS.exclude_shim is not None: |
| for shim in ARGS.exclude_shim: |
| try: |
| SHIM_MAP.pop(shim) |
| except KeyError: |
| print 'No such shim: "%s". Use --help for valid shims' % shim |
| sys.exit(1) # Errors or failures present |
| |
| # Connect to broker to find broker type, or use --broker-type param if present |
| if ARGS.broker_type is not None: |
| if ARGS.broker_type == 'None': |
| BROKER = None |
| else: |
| BROKER = ARGS.broker_type |
| else: |
| CONNECTION_PROPS = qpid_interop_test.broker_properties.get_broker_properties(ARGS.sender) |
| if CONNECTION_PROPS is None: |
| print 'WARNING: Unable to get connection properties - unknown broker' |
| BROKER = 'unknown' |
| else: |
| BROKER = CONNECTION_PROPS[symbol(u'product')] if symbol(u'product') in CONNECTION_PROPS \ |
| else '<product not found>' |
| BROKER_VERSION = CONNECTION_PROPS[symbol(u'version')] if symbol(u'version') in CONNECTION_PROPS \ |
| else '<version not found>' |
| BROKER_PLATFORM = CONNECTION_PROPS[symbol(u'platform')] if symbol(u'platform') in CONNECTION_PROPS \ |
| else '<platform not found>' |
| print 'Test Broker: %s v.%s on %s' % (BROKER, BROKER_VERSION, BROKER_PLATFORM) |
| print |
| sys.stdout.flush() |
| if ARGS.no_skip: |
| BROKER = None # Will cause all tests to run |
| |
| TYPES = JmsMessageTypes().get_types(ARGS) |
| |
| # TEST_CASE_CLASSES is a list that collects all the test classes that are constructed. One class is constructed |
| # per AMQP type used as the key in map JmsMessageTypes.TYPE_MAP. |
| TEST_CASE_CLASSES = [] |
| |
| # TEST_SUITE is the final suite of tests that will be run and which contains all the dynamically created |
| # type classes, each of which contains a test for the combinations of client shims |
| TEST_SUITE = unittest.TestSuite() |
| |
| # Create test classes dynamically |
| for jmt in sorted(TYPES.get_type_list()): |
| if ARGS.exclude_type is None or jmt not in ARGS.exclude_type: |
| test_case_class = create_testcase_class(jmt, product(SHIM_MAP.values(), repeat=2)) |
| TEST_CASE_CLASSES.append(test_case_class) |
| TEST_SUITE.addTest(unittest.makeSuite(test_case_class)) |
| |
| # Finally, run all the dynamically created tests |
| RES = unittest.TextTestRunner(verbosity=2).run(TEST_SUITE) |
| if not RES.wasSuccessful(): |
| sys.exit(1) |