Hello {name}

* + * --verbose + + Where: + + ** specifies the path to the configuration file. + + *

* specifies the section within that config file. + + *verbose* generates more information in the log files. + + The process listens for REST API invocations and checks them. Errors are + displayed to stdout and logged. + ''' + + if argv is None: + argv = sys.argv + else: + sys.argv.extend(argv) + + program_name = os.path.basename(sys.argv[0]) + program_version = 'v{0}'.format(__version__) + program_build_date = str(__updated__) + program_version_message = '%%(prog)s {0} ({1})'.format(program_version, + program_build_date) + if (__import__('__main__').__doc__ is not None): + program_shortdesc = __import__('__main__').__doc__.split('\n')[1] + else: + program_shortdesc = 'Running in test harness' + program_license = '''{0} + + Created on {1}. + Copyright 2015 Metaswitch Networks Ltd. All rights reserved. + + Distributed on an "AS IS" basis without warranties + or conditions of any kind, either express or implied. + +USAGE +'''.format(program_shortdesc, str(__date__)) + + try: + #---------------------------------------------------------------------- + # Setup argument parser so we can parse the command-line. + #---------------------------------------------------------------------- + parser = ArgumentParser(description=program_license, + formatter_class=ArgumentDefaultsHelpFormatter) + parser.add_argument('-v', '--verbose', + dest='verbose', + action='count', + help='set verbosity level') + parser.add_argument('-V', '--version', + action='version', + version=program_version_message, + help='Display version information') + parser.add_argument('-a', '--api-version', + dest='api_version', + default='3', + help='set API version') + parser.add_argument('-c', '--config', + dest='config', + default='/etc/opt/att/collector.conf', + help='Use this config file.', + metavar='') + parser.add_argument('-s', '--section', + dest='section', + default='default', + metavar='

', + help='section to use in the config file') + + #---------------------------------------------------------------------- + # Process arguments received. + #---------------------------------------------------------------------- + args = parser.parse_args() + verbose = args.verbose + api_version = args.api_version + config_file = args.config + config_section = args.section + + #---------------------------------------------------------------------- + # Now read the config file, using command-line supplied values as + # overrides. + #---------------------------------------------------------------------- + defaults = {'log_file': 'collector.log', + 'vel_port': '12233', + 'vel_path': '', + 'vel_topic_name': '' + } + overrides = {} + config = ConfigParser.SafeConfigParser(defaults) + config.read(config_file) + + #---------------------------------------------------------------------- + # extract the values we want. + #---------------------------------------------------------------------- + log_file = config.get(config_section, 'log_file', vars=overrides) + vel_port = config.get(config_section, 'vel_port', vars=overrides) + vel_path = config.get(config_section, 'vel_path', vars=overrides) + vel_topic_name = config.get(config_section, + 'vel_topic_name', + vars=overrides) + global vel_username + global vel_password + vel_username = config.get(config_section, + 'vel_username', + vars=overrides) + vel_password = config.get(config_section, + 'vel_password', + vars=overrides) + vel_schema_file = config.get(config_section, + 'schema_file', + vars=overrides) + base_schema_file = config.get(config_section, + 'base_schema_file', + vars=overrides) + throttle_schema_file = config.get(config_section, + 'throttle_schema_file', + vars=overrides) + test_control_schema_file = config.get(config_section, + 'test_control_schema_file', + vars=overrides) + + #---------------------------------------------------------------------- + # Finally we have enough info to start a proper flow trace. + #---------------------------------------------------------------------- + global logger + print('Logfile: {0}'.format(log_file)) + logger = logging.getLogger('collector') + if verbose > 0: + print('Verbose mode on') + logger.setLevel(logging.DEBUG) + else: + logger.setLevel(logging.INFO) + handler = logging.handlers.RotatingFileHandler(log_file, + maxBytes=1000000, + backupCount=10) + if (platform.system() == 'Windows'): + date_format = '%Y-%m-%d %H:%M:%S' + else: + date_format = '%Y-%m-%d %H:%M:%S.%f %z' + formatter = logging.Formatter('%(asctime)s %(name)s - ' + '%(levelname)s - %(message)s', + date_format) + handler.setFormatter(formatter) + logger.addHandler(handler) + logger.info('Started') + + #---------------------------------------------------------------------- + # Log the details of the configuration. + #---------------------------------------------------------------------- + logger.debug('Log file = {0}'.format(log_file)) + logger.debug('Event Listener Port = {0}'.format(vel_port)) + logger.debug('Event Listener Path = {0}'.format(vel_path)) + logger.debug('Event Listener Topic = {0}'.format(vel_topic_name)) + logger.debug('Event Listener Username = {0}'.format(vel_username)) + # logger.debug('Event Listener Password = {0}'.format(vel_password)) + logger.debug('Event Listener JSON Schema File = {0}'.format( + vel_schema_file)) + logger.debug('Base JSON Schema File = {0}'.format(base_schema_file)) + logger.debug('Throttle JSON Schema File = {0}'.format( + throttle_schema_file)) + logger.debug('Test Control JSON Schema File = {0}'.format( + test_control_schema_file)) + + #---------------------------------------------------------------------- + # Perform some basic error checking on the config. + #---------------------------------------------------------------------- + if (int(vel_port) < 1024 or int(vel_port) > 65535): + logger.error('Invalid Vendor Event Listener port ({0}) ' + 'specified'.format(vel_port)) + raise RuntimeError('Invalid Vendor Event Listener port ({0}) ' + 'specified'.format(vel_port)) + + if (len(vel_path) > 0 and vel_path[-1] != '/'): + logger.warning('Event Listener Path ({0}) should have terminating ' + '"/"! Adding one on to configured string.'.format( + vel_path)) + vel_path += '/' + + #---------------------------------------------------------------------- + # Load up the vel_schema, if it exists. + #---------------------------------------------------------------------- + if not os.path.exists(vel_schema_file): + logger.warning('Event Listener Schema File ({0}) not found. ' + 'No validation will be undertaken.'.format( + vel_schema_file)) + else: + global vel_schema + global throttle_schema + global test_control_schema + vel_schema = json.load(open(vel_schema_file, 'r')) + Draft4Validator.check_schema(vel_schema) + logger.debug('Loaded the JSON schema file') + + #------------------------------------------------------------------ + # Load up the throttle_schema, if it exists. + #------------------------------------------------------------------ + if (os.path.exists(throttle_schema_file)): + logger.debug('Loading throttle schema') + throttle_fragment = json.load(open(throttle_schema_file, 'r')) + throttle_schema = {} + throttle_schema.update(vel_schema) + throttle_schema.update(throttle_fragment) + logger.debug('Loaded the throttle schema') + + #------------------------------------------------------------------ + # Load up the test control _schema, if it exists. + #------------------------------------------------------------------ + if (os.path.exists(test_control_schema_file)): + logger.debug('Loading test control schema') + test_control_fragment = json.load( + open(test_control_schema_file, 'r')) + test_control_schema = {} + test_control_schema.update(vel_schema) + test_control_schema.update(test_control_fragment) + logger.debug('Loaded the test control schema') + + #------------------------------------------------------------------ + # Load up the base_schema, if it exists. + #------------------------------------------------------------------ + if (os.path.exists(base_schema_file)): + logger.debug('Updating the schema with base definition') + base_schema = json.load(open(base_schema_file, 'r')) + vel_schema.update(base_schema) + logger.debug('Updated the JSON schema file') + + #---------------------------------------------------------------------- + # We are now ready to get started with processing. Start-up the various + # components of the system in order: + # + # 1) Create the dispatcher. + # 2) Register the functions for the URLs of interest. + # 3) Run the webserver. + #---------------------------------------------------------------------- + root_url = '/{0}eventListener/v{1}{2}'.\ + format(vel_path, + api_version, + '/' + vel_topic_name + if len(vel_topic_name) > 0 + else '') + throttle_url = '/{0}eventListener/v{1}/clientThrottlingState'.\ + format(vel_path, api_version) + set_404_content(root_url) + dispatcher = PathDispatcher() + vendor_event_listener = partial(listener, schema = vel_schema) + dispatcher.register('GET', root_url, vendor_event_listener) + dispatcher.register('POST', root_url, vendor_event_listener) + vendor_throttle_listener = partial(listener, schema = throttle_schema) + dispatcher.register('GET', throttle_url, vendor_throttle_listener) + dispatcher.register('POST', throttle_url, vendor_throttle_listener) + + #---------------------------------------------------------------------- + # We also add a POST-only mechanism for test control, so that we can + # send commands to a single attached client. + #---------------------------------------------------------------------- + test_control_url = '/testControl/v{0}/commandList'.format(api_version) + test_control_listener = partial(test_listener, + schema = test_control_schema) + dispatcher.register('POST', test_control_url, test_control_listener) + dispatcher.register('GET', test_control_url, test_control_listener) + + httpd = make_server('', int(vel_port), dispatcher) + print('Serving on port {0}...'.format(vel_port)) + httpd.serve_forever() + + logger.error('Main loop exited unexpectedly!') + return 0 + + except KeyboardInterrupt: + #---------------------------------------------------------------------- + # handle keyboard interrupt + #---------------------------------------------------------------------- + logger.info('Exiting on keyboard interrupt!') + return 0 + + except Exception as e: + #---------------------------------------------------------------------- + # Handle unexpected exceptions. + #---------------------------------------------------------------------- + if DEBUG or TESTRUN: + raise(e) + indent = len(program_name) * ' ' + sys.stderr.write(program_name + ': ' + repr(e) + '\n') + sys.stderr.write(indent + ' for help use --help\n') + sys.stderr.write(traceback.format_exc()) + logger.critical('Exiting because of exception: {0}'.format(e)) + logger.critical(traceback.format_exc()) + return 2 + +#------------------------------------------------------------------------------ +# MAIN SCRIPT ENTRY POINT. +#------------------------------------------------------------------------------ +if __name__ == '__main__': + if TESTRUN: + #---------------------------------------------------------------------- + # Running tests - note that doctest comments haven't been included so + # this is a hook for future improvements. + #---------------------------------------------------------------------- + import doctest + doctest.testmod() + + if PROFILE: + #---------------------------------------------------------------------- + # Profiling performance. Performance isn't expected to be a major + # issue, but this should all work as expected. + #---------------------------------------------------------------------- + import cProfile + import pstats + profile_filename = 'collector_profile.txt' + cProfile.run('main()', profile_filename) + statsfile = open('collector_profile_stats.txt', 'wb') + p = pstats.Stats(profile_filename, stream=statsfile) + stats = p.strip_dirs().sort_stats('cumulative') + stats.print_stats() + statsfile.close() + sys.exit(0) + + #-------------------------------------------------------------------------- + # Normal operation - call through to the main function. + #-------------------------------------------------------------------------- + sys.exit(main()) diff --git a/vnfs/VES5.0/collector/code/collector/rest_dispatcher.py b/vnfs/VES5.0/collector/code/collector/rest_dispatcher.py new file mode 100644 index 00000000..6911d5e5 --- /dev/null +++ b/vnfs/VES5.0/collector/code/collector/rest_dispatcher.py @@ -0,0 +1,104 @@ +#!/usr/bin/env python +''' +Simple dispatcher for the REST API. + +Only intended for test purposes. + +License +------- + +Copyright(c) <2016>, AT&T Intellectual Property. All other rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. +3. All advertising materials mentioning features or use of this software + must display the following acknowledgement: This product includes + software developed by the AT&T. +4. Neither the name of AT&T nor the names of its contributors may be used to + endorse or promote products derived from this software without specific + prior written permission. + +THIS SOFTWARE IS PROVIDED BY AT&T INTELLECTUAL PROPERTY ''AS IS'' AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL AT&T INTELLECTUAL PROPERTY BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +''' + +import logging +logger = logging.getLogger('collector.disp') + +base_url = '' + +template_404 = b'''POST {0}''' + +def set_404_content(url): + ''' + Called at initialization to set the base URL so that we can serve helpful + diagnostics as part of the 404 response. + ''' + global base_url + base_url = url + return + +def notfound_404(environ, start_response): + ''' + Serve the 404 Not Found response. + + Provides diagnostics in the 404 response showing the hierarchy of valid + REST resources. + ''' + logger.warning('Unexpected URL/Method: {0} {1}'.format( + environ['REQUEST_METHOD'].upper(), + environ['PATH_INFO'])) + start_response('404 Not Found', [ ('Content-type', 'text/plain') ]) + return [template_404.format(base_url)] + +class PathDispatcher: + ''' + A dispatcher which can take HTTP requests in a WSGI environment and invoke + appropriate methods for each request. + ''' + def __init__(self): + '''Constructor: initialize the pathmap to be empty.''' + self.pathmap = { } + + def __call__(self, environ, start_response): + ''' + The main callable that the WSGI app will invoke with each request. + ''' + #---------------------------------------------------------------------- + # Extract the method and path from the environment. + #---------------------------------------------------------------------- + method = environ['REQUEST_METHOD'].lower() + path = environ['PATH_INFO'] + logger.info('Dispatcher called for: {0} {1}'.format(method, path)) + logger.debug('Dispatcher environment is: {0}'.format(environ)) + + #---------------------------------------------------------------------- + # See if we have a handler for this path, and if so invoke it. + # Otherwise, return a 404. + #---------------------------------------------------------------------- + handler = self.pathmap.get((method, path), notfound_404) + logger.debug('Dispatcher will use handler: {0}'.format(handler)) + return handler(environ, start_response) + + def register(self, method, path, function): + ''' + Register a handler for a method/path, adding it to the pathmap. + ''' + logger.debug('Registering for {0} at {1}'.format(method, path)) + print('Registering for {0} at {1}'.format(method, path)) + self.pathmap[method.lower(), path] = function + return function diff --git a/vnfs/VES5.0/collector/code/collector/rest_dispatcher.pyc b/vnfs/VES5.0/collector/code/collector/rest_dispatcher.pyc new file mode 100644 index 00000000..cb00d7f3 Binary files /dev/null and b/vnfs/VES5.0/collector/code/collector/rest_dispatcher.pyc differ diff --git a/vnfs/VES5.0/collector/code/collector/test_control.py b/vnfs/VES5.0/collector/code/collector/test_control.py new file mode 100644 index 00000000..e2ce8163 --- /dev/null +++ b/vnfs/VES5.0/collector/code/collector/test_control.py @@ -0,0 +1,192 @@ +#!/usr/bin/env python +''' +Example script to inject a throttling command list to the test_collector. + +Only intended for test purposes. + +License +------- + +Copyright(c) <2016>, AT&T Intellectual Property. All other rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. +3. All advertising materials mentioning features or use of this software + must display the following acknowledgement: This product includes + software developed by the AT&T. +4. Neither the name of AT&T nor the names of its contributors may be used to + endorse or promote products derived from this software without specific + prior written permission. + +THIS SOFTWARE IS PROVIDED BY AT&T INTELLECTUAL PROPERTY ''AS IS'' AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL AT&T INTELLECTUAL PROPERTY BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +''' +import optparse +import requests +import json + +############################################################################### +# Functions to build up commandList contents +############################################################################### +def command_state(): + "return a provideThrottlingState command" + return {'command': + {'commandType': 'provideThrottlingState'}} + +def command_interval(interval): + "return a measurementIntervalChange command" + return {'command': + {'commandType': 'measurementIntervalChange', + 'measurementInterval': interval}} + +def command_throttle(domain, fields, pairs): + "return a throttlingSpecification" + throttle_spec = {'eventDomain' : domain} + if len(fields): + throttle_spec['suppressedFieldNames'] = fields + if len(pairs): + throttle_spec['suppressedNvPairsList'] = pairs + return {'command': + {'commandType': 'throttlingSpecification', + 'eventDomainThrottleSpecification': throttle_spec}} + +def command_nvpairs(field_name, pair_names): + "return a suppressedNvPairs" + return {'nvPairFieldName' : field_name, + 'suppressedNvPairNames' : pair_names} + +############################################################################### +# Example functions to build up commandLists for various domains. +############################################################################### +def command_list_empty(): + return {'commandList' : []} + +def command_list_provide(): + return {'commandList' : [command_state()]} + +def command_list_interval(interval): + return {'commandList' : [command_interval(interval)]} + +def command_list_fault_suppress_fields(): + "Throttling Specification - two suppressedFieldNames" + fields = ['alarmInterfaceA', 'alarmAdditionalInformation'] + pairs = [] + command_list = [command_throttle('fault', fields, pairs)] + return {'commandList' : command_list} + +def command_list_fault_suppress_nothing(): + "Throttling Specification - no suppression" + fields = [] + pairs = [] + command_list = [command_throttle('fault', fields, pairs)] + return {'commandList' : command_list} + +def command_list_fault_suppress_pairs(): + "Throttling Specification - two suppressedNvPairNames" + fields = [] + pairs = [command_nvpairs('alarmAdditionalInformation', + ['name1', 'name2'])] + command_list = [command_throttle('fault', fields, pairs)] + return {'commandList' : command_list} + +def command_list_fault_suppress_fields_and_pairs(): + "Throttling Specification - a mixture of fields and pairs" + fields = ['alarmInterfaceA'] + pairs = [command_nvpairs('alarmAdditionalInformation', + ['name1', 'name2'])] + command_list = [command_throttle('fault', fields, pairs)] + return {'commandList' : command_list} + +def command_list_measurements_suppress_example(): + "Throttling Specification - measurements" + fields = ['numberOfMediaPortsInUse', 'aggregateCpuUsage'] + pairs = [command_nvpairs('cpuUsageArray', + ['cpu1', 'cpu3'])] + command_list = [command_throttle('measurementsForVfScaling', + fields, pairs)] + return {'commandList' : command_list} + +def command_list_mobile_flow_suppress_example(): + "Throttling Specification - mobile flow" + fields = ['radioAccessTechnology', 'samplingAlgorithm'] + pairs = [] + command_list = [command_throttle('mobileFlow', fields, pairs)] + return {'commandList' : command_list} + +def command_list_state_change_suppress_example(): + "Throttling Specification - state change" + fields = ['reportingEntityId', 'eventType', 'sourceId'] + pairs = [command_nvpairs('additionalFields', ['Name1'])] + command_list = [command_throttle('stateChange', fields, pairs)] + return {'commandList' : command_list} + +def command_list_syslog_suppress_example(): + "Throttling Specification - syslog" + fields = ['syslogFacility', 'syslogProc', 'syslogProcId'] + pairs = [command_nvpairs('additionalFields', ['Name1', 'Name4'])] + command_list = [command_throttle('syslog', fields, pairs)] + return {'commandList' : command_list} + +def command_list_reset_all_domains(): + "Throttling Specification - reset all domains" + command_list = [command_throttle('fault', [], []), + command_throttle('measurementsForVfScaling', [], []), + command_throttle('mobileFlow', [], []), + command_throttle('stateChange', [], []), + command_throttle('syslog', [], [])] + return {'commandList' : command_list} + +def mixed_example(): + fields = ['alarmInterfaceA'] + pairs = [command_nvpairs('alarmAdditionalInformation', + ['name1', 'name2'])] + command_list = [command_throttle('fault', fields, pairs), + command_interval(10), + command_state()] + return {'commandList' : command_list} + +############################################################################### +# Default command line values +############################################################################### +DEFAULT_FQDN = "127.0.0.1" +DEFAULT_PORT = 30000 + +############################################################################### +# Command Line Parsing +############################################################################### +parser = optparse.OptionParser() +parser.add_option('--fqdn', + action="store", + dest="fqdn", + default=DEFAULT_FQDN) +parser.add_option('--port', + action="store", + dest="port", + default=DEFAULT_PORT, + type="int") +options, remainder = parser.parse_args() + +############################################################################### +# Derive the Test Control URL +############################################################################### +url = 'http://%s:%d/testControl/v1.1/commandList'%(options.fqdn, options.port) + +############################################################################### +# Create JSON and POST it to the Test Control URL. +############################################################################### +command_list = command_list_fault_suppress_fields_and_pairs() +requests.post(url, json = command_list) -- cgit 1.2.3-korg

Hello {name}!