From b399fb7d39261a772466a66fc46d186d0b91570d Mon Sep 17 00:00:00 2001 From: aakarshg Date: Thu, 17 Oct 2019 16:48:32 -0400 Subject: [PATCH] initial skeleton implementation --- .gitignore | 50 +++++ AUTHORS.rst | 5 + CHANGELOG.rst | 10 + LICENSE | 201 -------------------- LICENSE.txt | 21 ++ README.md | 2 - README.rst | 11 ++ requirements.txt | 0 setup.cfg | 55 ++++++ setup.py | 15 ++ src/touchstone/__init__.py | 11 ++ src/touchstone/benchmarks/__init__.py | 27 +++ src/touchstone/benchmarks/base_benchmark.py | 19 ++ src/touchstone/benchmarks/uperf.py | 25 +++ src/touchstone/compare.py | 112 +++++++++++ src/touchstone/databases/__init__.py | 25 +++ src/touchstone/databases/base_database.py | 10 + src/touchstone/databases/elasticsearch.py | 14 ++ 18 files changed, 410 insertions(+), 203 deletions(-) create mode 100644 .gitignore create mode 100644 AUTHORS.rst create mode 100644 CHANGELOG.rst delete mode 100644 LICENSE create mode 100644 LICENSE.txt delete mode 100644 README.md create mode 100644 README.rst create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 src/touchstone/__init__.py create mode 100644 src/touchstone/benchmarks/__init__.py create mode 100644 src/touchstone/benchmarks/base_benchmark.py create mode 100644 src/touchstone/benchmarks/uperf.py create mode 100644 src/touchstone/compare.py create mode 100644 src/touchstone/databases/__init__.py create mode 100644 src/touchstone/databases/base_database.py create mode 100644 src/touchstone/databases/elasticsearch.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2be14f0 --- /dev/null +++ b/.gitignore @@ -0,0 +1,50 @@ +# Temporary and binary files +*~ +*.py[cod] +*.so +*.cfg +!.isort.cfg +!setup.cfg +*.orig +*.log +*.pot +__pycache__/* +.cache/* +.*.swp +*/.ipynb_checkpoints/* +.DS_Store + +# Project files +.ropeproject +.project +.pydevproject +.settings +.idea +tags + +# Package files +*.egg +*.eggs/ +.installed.cfg +*.egg-info + +# Unittest and coverage +htmlcov/* +.coverage +.tox +junit.xml +coverage.xml +.pytest_cache/ + +# Build and docs folder/files +build/* +dist/* +sdist/* +docs/api/* +docs/_rst/* +docs/_build/* +cover/* +MANIFEST + +# Per-project virtualenvs +.venv*/ diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 0000000..8d8ebfa --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,5 @@ +============ +Contributors +============ + +* aakarshg diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 0000000..226e6f5 --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,10 @@ +========= +Changelog +========= + +Version 0.1 +=========== + +- Feature A added +- FIX: nasty bug #1729 fixed +- add your changes here! diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 261eeb9..0000000 --- a/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed 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. diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..7af8c0d --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2019 aakarshg + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md deleted file mode 100644 index 8721adf..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# touchstone -Judging whether the SUT performance is gold. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..e78a104 --- /dev/null +++ b/README.rst @@ -0,0 +1,11 @@ +========== +touchstone +========== + +To compare two benchmark results + + +Description +=========== + +A longer description of your project goes here... diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..1096f3d --- /dev/null +++ b/setup.cfg @@ -0,0 +1,55 @@ +# This file is used to configure your project. +# Read more about the various options under: +# http://setuptools.readthedocs.io/en/latest/setuptools.html#configuring-setup-using-setup-cfg-files + +[metadata] +name = touchstone +description = To compare benchmark results in elasticsearch +author = aakarshg +author-email = aakarsh.g2012@gmail.com +license = mit +long-description = file: README.rst +long-description-content-type = text/x-rst; charset=UTF-8 +classifiers = + Development Status :: 4 - Beta + Programming Language :: Python + +[options] +zip_safe = False +packages = find: +include_package_data = True +package_dir = + =src +# Add here dependencies of your project (semicolon/line-separated), e.g. +install_requires = numpy; elasticsearch >= 6.7 +# tests_require = pytest; pytest-cov +# Require a specific Python version, e.g. Python 2.7 or >= 3.4 +# python_requires = >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.* + +[options.packages.find] +where = src + +[options.extras_require] +# Add here additional requirements for extra features, to install with: +# `pip install touchstone[PDF]` like: +# PDF = ReportLab; RXP + +[options.entry_points] +# Add here console scripts like: +console_scripts = + touchstone_compare = touchstone.compare:render + +[aliases] +dists = bdist_wheel + +[bdist_wheel] +# Use this option if your package is pure-python +universal = 1 + +[flake8] +# Some sane defaults for the code style checker flake8 +exclude = + .tox + build + dist + .eggs diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..6d697d1 --- /dev/null +++ b/setup.py @@ -0,0 +1,15 @@ +# -*- coding: utf-8 -*- +import sys + +from pkg_resources import VersionConflict, require +from setuptools import setup + +try: + require('setuptools>=38.3') +except VersionConflict: + print("Error: version of setuptools is too old (<38.3)!") + sys.exit(1) + + +if __name__ == "__main__": + setup() diff --git a/src/touchstone/__init__.py b/src/touchstone/__init__.py new file mode 100644 index 0000000..c99a72a --- /dev/null +++ b/src/touchstone/__init__.py @@ -0,0 +1,11 @@ +# -*- coding: utf-8 -*- +from pkg_resources import get_distribution, DistributionNotFound + +try: + # Change here if project is renamed and does not equal the package name + dist_name = __name__ + __version__ = get_distribution(dist_name).version +except DistributionNotFound: + __version__ = 'unknown' +finally: + del get_distribution, DistributionNotFound diff --git a/src/touchstone/benchmarks/__init__.py b/src/touchstone/benchmarks/__init__.py new file mode 100644 index 0000000..7fd1a5d --- /dev/null +++ b/src/touchstone/benchmarks/__init__.py @@ -0,0 +1,27 @@ +from importlib import import_module +import logging + +from . base_benchmark import BenchmarkBaseClass ## noqa + + +_logger = logging.getLogger("touchstone") + +def grab(benchmark_input_type, *args, **kwargs): + try: + _logger.debug("Grabbing the right benchmark instance") + if '.' in benchmark_input_type: + module_name, class_name = benchmark_input_type.rsplit('.', 1) + else: + module_name = benchmark_input_type + class_name = benchmark_input_type.capitalize() + _logger.debug("Importing the right benchmark module") + benchmark_module = import_module('touchstone.benchmarks.' + module_name, + package='benchmarks') + benchmark_input_class = getattr(benchmark_module, class_name) + _logger.debug("Creating the benchmark instance") + instance = benchmark_input_class(*args, **kwargs) + + except (AttributeError, ModuleNotFoundError): + _logger.debug("Hit an error finding the right module") + raise ImportError('{} is not part of our benchmark collection!'.format(benchmark_input_type)) + return instance diff --git a/src/touchstone/benchmarks/base_benchmark.py b/src/touchstone/benchmarks/base_benchmark.py new file mode 100644 index 0000000..2cccf31 --- /dev/null +++ b/src/touchstone/benchmarks/base_benchmark.py @@ -0,0 +1,19 @@ +from abc import ABCMeta, abstractmethod +import logging + + +_logger = logging.getLogger("touchstone") + +class BenchmarkBaseClass(metaclass=ABCMeta): + def __init__(self, source_type=None, harness_type=None): + _logger.debug("Initializing BenchmarkBaseClass instance") + if source_type: + self._source_type = source_type + if harness_type: + self._harness_type = harness_type + self._indices_array = None + _logger.debug("Finished initializing BenchmarkBaseClass instance") + + @abstractmethod + def _emit_indices(self): + pass diff --git a/src/touchstone/benchmarks/uperf.py b/src/touchstone/benchmarks/uperf.py new file mode 100644 index 0000000..c0aab11 --- /dev/null +++ b/src/touchstone/benchmarks/uperf.py @@ -0,0 +1,25 @@ +import logging + + +from . import BenchmarkBaseClass + + +_logger = logging.getLogger("touchstone") + +class Uperf(BenchmarkBaseClass): + + def _build_indices(self): + _logger.debug("Building indices array for uperf") + return self._indices_dict[self._source_type][self._harness_type] + + def __init__(self, source_type=None, harness_type=None): + _logger.debug("Initializing uperf instance") + BenchmarkBaseClass.__init__(self, source_type=source_type, harness_type=harness_type) + self._indices_dict = {'elasticsearch': { 'ripsaw': {'indices': ['ripsaw-uperf-results'], 'buckets':['test_type','protocol','message_size','num_threads'], 'aggregations': ['norm_byte','norm_ops','norm_ltcy'], 'compare':['uuid','user','cluster_name','hostnetwork','serviceip']} }} + self._indices_array = self._build_indices() + _logger.debug("Finished initializing uperf instance") + + def _emit_indices(self): + _logger.debug("Emitting built indices array") + _logger.info("Indices to search are {} in the database {}".format(self._indices_array,self._source_type)) + return self._indices_array diff --git a/src/touchstone/compare.py b/src/touchstone/compare.py new file mode 100644 index 0000000..85915d5 --- /dev/null +++ b/src/touchstone/compare.py @@ -0,0 +1,112 @@ +# -*- coding: utf-8 -*- +import argparse +import sys +import logging + +from touchstone import __version__ +from . import benchmarks +from . import databases + +__author__ = "aakarshg" +__copyright__ = "aakarshg" +__license__ = "mit" + +_logger = logging.getLogger("touchstone") + +def parse_args(args): + """Parse command line parameters + + Args: + args ([str]): command line parameters as list of strings + + Returns: + :obj:`argparse.Namespace`: command line parameters namespace + """ + parser = argparse.ArgumentParser( + description="compare results from benchmarks") + parser.add_argument( + "--version", + action="version", + version="touchstone {ver}".format(ver=__version__)) + parser.add_argument( + dest="benchmark", + help="which type of benchmark to compare", + type=str, + choices=['uperf'], + metavar="benchmark") + parser.add_argument( + dest="database", + help="the type of database data is stored in", + type=str, + choices=['elasticsearch'], + metavar="database") + parser.add_argument( + dest="harness", + help="the test harness that was used to run the benchmark", + type=str, + choices=['ripsaw'], + metavar="harness") + parser.add_argument( + '-u', '--uuid', + dest="uuid", + help="2 uuids to compare", + type=str, + nargs=2) + parser.add_argument( + '-url', '--connection-url', + dest="conn_url", + help="the database connection strings in the same order as the uuids", + type=str, + nargs=2) + parser.add_argument( + "-v", + "--verbose", + dest="loglevel", + help="set loglevel to INFO", + action="store_const", + const=logging.INFO) + parser.add_argument( + "-vv", + "--very-verbose", + dest="loglevel", + help="set loglevel to DEBUG", + action="store_const", + const=logging.DEBUG) + return parser.parse_args(args) + + +def setup_logging(loglevel): + """Setup basic logging + + Args: + loglevel (int): minimum loglevel for emitting messages + """ + logformat = "[%(asctime)s] %(levelname)s:%(name)s:%(message)s" + logging.basicConfig(level=loglevel, stream=sys.stdout, + format=logformat, datefmt="%Y-%m-%d %H:%M:%S") + + +def main(args): + """Main entry point allowing external calls + + Args: + args ([str]): command line parameter list + """ + args = parse_args(args) + setup_logging(args.loglevel) + _logger.debug("Instantiating the benchmark instance") + benchmark_instance = benchmarks.grab(args.benchmark,source_type=args.database,harness_type=args.harness) + print(benchmark_instance._emit_indices()) + database_instance = databases.grab(args.database) + print(database_instance.emit_values_dict(),args.conn_url) + _logger.info("Script ends here") + + +def render(): + """Entry point for console_scripts + """ + main(sys.argv[1:]) + + +if __name__ == "__main__": + render() diff --git a/src/touchstone/databases/__init__.py b/src/touchstone/databases/__init__.py new file mode 100644 index 0000000..16a801d --- /dev/null +++ b/src/touchstone/databases/__init__.py @@ -0,0 +1,25 @@ +from importlib import import_module +import logging + +from . base_database import DatabaseBaseClass ## noqa + + +_logger = logging.getLogger("touchstone") + + +def grab(database_input_type, *args, **kwargs): + + try: + if '.' in database_input_type: + module_name, class_name = database_input_type.rsplit('.', 1) + else: + module_name = database_input_type + class_name = database_input_type.capitalize() + database_module = import_module('touchstone.databases.' + module_name, + package='databases') + database_input_class = getattr(database_module, class_name) + instance = database_input_class(*args, **kwargs) + + except (AttributeError, ModuleNotFoundError): + raise ImportError('{} is not part of our database collection!'.format(database_input_type)) + return instance diff --git a/src/touchstone/databases/base_database.py b/src/touchstone/databases/base_database.py new file mode 100644 index 0000000..5db6171 --- /dev/null +++ b/src/touchstone/databases/base_database.py @@ -0,0 +1,10 @@ +from abc import ABCMeta, abstractmethod + + +class DatabaseBaseClass(metaclass=ABCMeta): + def __init__(self): + self._dict = None + + @abstractmethod + def emit_values_dict(self): + pass diff --git a/src/touchstone/databases/elasticsearch.py b/src/touchstone/databases/elasticsearch.py new file mode 100644 index 0000000..43e3bfa --- /dev/null +++ b/src/touchstone/databases/elasticsearch.py @@ -0,0 +1,14 @@ +from . import DatabaseBaseClass + +class Elasticsearch(DatabaseBaseClass): + + def _build_keys(self): + output_dict = {'database_name':'elasticsearch'} + return output_dict + + def __init__(self): + DatabaseBaseClass.__init__(self) + self._dict = self._build_keys() + + def emit_values_dict(self): + return self._dict