From 91787d6b83eec16dd4cd021a18116e94ee4956a3 Mon Sep 17 00:00:00 2001 From: aviau Date: Tue, 12 Aug 2014 14:37:27 -0400 Subject: [PATCH] Added demo API + tests Change-Id: I4bdd12f72b9b02c2ba9adafcfbdbdaa079d19e34 --- .gitignore | 11 ++ .testr.conf | 8 + LICENSE | 175 ++++++++++++++++++ requirements.txt | 1 + setup.cfg | 11 ++ setup.py | 7 +- surveil/__init__.py | 0 surveil/api/__init__.py | 0 surveil/api/api.py | 5 + surveil/api/app.py | 14 ++ surveil/api/config.py | 53 ++++++ surveil/api/controllers/__init__.py | 0 surveil/api/controllers/root.py | 5 + surveil/api/controllers/v1/__init__.py | 0 surveil/api/controllers/v1/hello.py | 9 + surveil/api/controllers/v1/v1.py | 5 + surveil/tests/__init__.py | 0 surveil/tests/api/__init__.py | 0 surveil/tests/api/controllers/__init__.py | 0 surveil/tests/api/controllers/v1/__init__.py | 0 .../tests/api/controllers/v1/test_hello.py | 23 +++ surveil/tests/api/functionalTest.py | 24 +++ test-requirements.txt | 1 + tox.ini | 8 +- 24 files changed, 356 insertions(+), 4 deletions(-) create mode 100644 .testr.conf create mode 100644 LICENSE create mode 100644 surveil/__init__.py create mode 100644 surveil/api/__init__.py create mode 100644 surveil/api/api.py create mode 100644 surveil/api/app.py create mode 100644 surveil/api/config.py create mode 100644 surveil/api/controllers/__init__.py create mode 100644 surveil/api/controllers/root.py create mode 100644 surveil/api/controllers/v1/__init__.py create mode 100644 surveil/api/controllers/v1/hello.py create mode 100644 surveil/api/controllers/v1/v1.py create mode 100644 surveil/tests/__init__.py create mode 100644 surveil/tests/api/__init__.py create mode 100644 surveil/tests/api/controllers/__init__.py create mode 100644 surveil/tests/api/controllers/v1/__init__.py create mode 100644 surveil/tests/api/controllers/v1/test_hello.py create mode 100644 surveil/tests/api/functionalTest.py diff --git a/.gitignore b/.gitignore index e03559c..0c760ab 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,16 @@ +*.pyc + +# Packages +*.egg +*.egg-info +AUTHORS +ChangeLog + # documentation doc/build +doc/source/_build # tests .tox +env +.testrepository diff --git a/.testr.conf b/.testr.conf new file mode 100644 index 0000000..1cc70e5 --- /dev/null +++ b/.testr.conf @@ -0,0 +1,8 @@ +[DEFAULT] +test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \ + OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \ + OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-160} \ + ${PYTHON:-python} -m subunit.run discover -t ./ ./surveil/tests $LISTOPT $IDOPTION + +test_id_option=--load-list $IDFILE +test_list_option=--list diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..67db858 --- /dev/null +++ b/LICENSE @@ -0,0 +1,175 @@ + + 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. diff --git a/requirements.txt b/requirements.txt index e69de29..ede54b0 100644 --- a/requirements.txt +++ b/requirements.txt @@ -0,0 +1 @@ +pecan>=0.5.0 diff --git a/setup.cfg b/setup.cfg index 8394725..957b8ff 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,3 +1,14 @@ +[metadata] +name = surveil +version = 2014.1.0 +summary = Monitoring as a Service for OpenStack +description-file = + README.rst + +[files] +packages = + surveil + [build_sphinx] source-dir = doc/source build-dir = doc/build diff --git a/setup.py b/setup.py index b908cbe..a080304 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,8 @@ import setuptools +from setuptools import find_packages -setuptools.setup() +setuptools.setup( + setup_requires=['pbr'], + pbr=True, + packages=find_packages(exclude=['ez_setup']) +) diff --git a/surveil/__init__.py b/surveil/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/surveil/api/__init__.py b/surveil/api/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/surveil/api/api.py b/surveil/api/api.py new file mode 100644 index 0000000..838d27b --- /dev/null +++ b/surveil/api/api.py @@ -0,0 +1,5 @@ +from pecanrest.controllers.api import order + + +class ApiController(object): + orders = order.OrdersController() diff --git a/surveil/api/app.py b/surveil/api/app.py new file mode 100644 index 0000000..79fa0ae --- /dev/null +++ b/surveil/api/app.py @@ -0,0 +1,14 @@ +from pecan import make_app +# from pecanrest import model + + +def setup_app(config): + + # model.init_model() + app_conf = dict(config.app) + + return make_app( + app_conf.pop('root'), + logging=getattr(config, 'logging', {}), + **app_conf + ) diff --git a/surveil/api/config.py b/surveil/api/config.py new file mode 100644 index 0000000..85e0b85 --- /dev/null +++ b/surveil/api/config.py @@ -0,0 +1,53 @@ +# Server Specific Configurations +server = { + 'port': '8080', + 'host': '0.0.0.0' +} + +# Pecan Application Configurations +app = { + 'root': 'surveil.api.controllers.root.RootController', + 'modules': ['surveil.api'], + 'template_path': '%(confdir)s/pecanrest/templates', + 'debug': True, + 'errors': { + 404: '/error/404', + '__force_dict__': True + } +} + +logging = { + 'loggers': { + 'root': {'level': 'INFO', 'handlers': ['console']}, + 'pecanrest': {'level': 'DEBUG', 'handlers': ['console']}, + 'pecan.commands.serve': {'level': 'DEBUG', 'handlers': ['console']}, + 'py.warnings': {'handlers': ['console']}, + '__force_dict__': True + }, + 'handlers': { + 'console': { + 'level': 'DEBUG', + 'class': 'logging.StreamHandler', + 'formatter': 'color' + } + }, + 'formatters': { + 'simple': { + 'format': ('%(asctime)s %(levelname)-5.5s [%(name)s]' + '[%(threadName)s] %(message)s') + }, + 'color': { + '()': 'pecan.log.ColorFormatter', + 'format': ('%(asctime)s [%(padded_color_levelname)s] [%(name)s]' + '[%(threadName)s] %(message)s'), + '__force_dict__': True + } + } +} + +# Custom Configurations must be in Python dictionary format:: +# +# foo = {'bar':'baz'} +# +# All configurations are accessible at:: +# pecan.conf diff --git a/surveil/api/controllers/__init__.py b/surveil/api/controllers/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/surveil/api/controllers/root.py b/surveil/api/controllers/root.py new file mode 100644 index 0000000..2f1b917 --- /dev/null +++ b/surveil/api/controllers/root.py @@ -0,0 +1,5 @@ +from surveil.api.controllers.v1 import v1 + + +class RootController(object): + v1 = v1.V1Controller() diff --git a/surveil/api/controllers/v1/__init__.py b/surveil/api/controllers/v1/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/surveil/api/controllers/v1/hello.py b/surveil/api/controllers/v1/hello.py new file mode 100644 index 0000000..16841d4 --- /dev/null +++ b/surveil/api/controllers/v1/hello.py @@ -0,0 +1,9 @@ +import pecan +from pecan import rest + + +class HelloController(rest.RestController): + + @pecan.expose() + def get(self): + return "Hello World!" diff --git a/surveil/api/controllers/v1/v1.py b/surveil/api/controllers/v1/v1.py new file mode 100644 index 0000000..bb9f6a5 --- /dev/null +++ b/surveil/api/controllers/v1/v1.py @@ -0,0 +1,5 @@ +from surveil.api.controllers.v1 import hello + + +class V1Controller(object): + hello = hello.HelloController() diff --git a/surveil/tests/__init__.py b/surveil/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/surveil/tests/api/__init__.py b/surveil/tests/api/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/surveil/tests/api/controllers/__init__.py b/surveil/tests/api/controllers/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/surveil/tests/api/controllers/v1/__init__.py b/surveil/tests/api/controllers/v1/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/surveil/tests/api/controllers/v1/test_hello.py b/surveil/tests/api/controllers/v1/test_hello.py new file mode 100644 index 0000000..9507b17 --- /dev/null +++ b/surveil/tests/api/controllers/v1/test_hello.py @@ -0,0 +1,23 @@ +# Copyright 2014 - Savoir-Faire Linux inc. +# +# 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. + +from surveil.tests.api.functionalTest import FunctionalTest + + +class TestRootController(FunctionalTest): + + def test_get(self): + response = self.app.get('/v1/hello') + assert response.body == b"Hello World!" + assert response.status_int == 200 diff --git a/surveil/tests/api/functionalTest.py b/surveil/tests/api/functionalTest.py new file mode 100644 index 0000000..0fcecd1 --- /dev/null +++ b/surveil/tests/api/functionalTest.py @@ -0,0 +1,24 @@ +from unittest import TestCase +from pecan import set_config +from pecan.testing import load_test_app + +__all__ = ['FunctionalTest'] + + +class FunctionalTest(TestCase): + """ + Used for functional tests where you need to test your + literal application and its integration with the framework. + """ + + def setUp(self): + self.app = load_test_app({ + 'app': { + 'root': 'surveil.api.controllers.root.RootController', + 'modules': ['surveil.api'], + 'debug': False + } + }) + + def tearDown(self): + set_config({}, overwrite=True) diff --git a/test-requirements.txt b/test-requirements.txt index a6700f9..3a6758c 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -4,3 +4,4 @@ wsme oslosphinx nose flake8 +testrepository>=0.0.18 diff --git a/tox.ini b/tox.ini index 02c0531..9ed4599 100644 --- a/tox.ini +++ b/tox.ini @@ -1,13 +1,15 @@ [tox] minverson = 1.6 +envlist = py33, py27, pep8, docs skipsdist = True -envlist = py27, pep8, docs [testenv] +usedevelop = True +install_command = pip install -U --force-reinstall {opts} {packages} deps = -r{toxinidir}/requirements.txt -r{toxinidir}/test-requirements.txt -commands = nosetests +commands = python setup.py testr --slowest --testr-args='{posargs}' [testenv:pep8] commands = flake8 @@ -19,4 +21,4 @@ commands = {posargs} commands = python setup.py build_sphinx [flake8] -exclude = .tox +exclude = .tox,env,*egg