├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── requirements.txt └── simpleservice.py /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | *.egg-info/ 24 | .installed.cfg 25 | *.egg 26 | 27 | # PyInstaller 28 | # Usually these files are written by a python script from a template 29 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 30 | *.manifest 31 | *.spec 32 | 33 | # Installer logs 34 | pip-log.txt 35 | pip-delete-this-directory.txt 36 | 37 | # Unit test / coverage reports 38 | htmlcov/ 39 | .tox/ 40 | .coverage 41 | .coverage.* 42 | .cache 43 | nosetests.xml 44 | coverage.xml 45 | *,cover 46 | .hypothesis/ 47 | 48 | # Translations 49 | *.mo 50 | *.pot 51 | 52 | # Django stuff: 53 | *.log 54 | local_settings.py 55 | 56 | # Flask stuff: 57 | instance/ 58 | .webassets-cache 59 | 60 | # Scrapy stuff: 61 | .scrapy 62 | 63 | # Sphinx documentation 64 | docs/_build/ 65 | 66 | # PyBuilder 67 | target/ 68 | 69 | # IPython Notebook 70 | .ipynb_checkpoints 71 | 72 | # pyenv 73 | .python-version 74 | 75 | # celery beat schedule file 76 | celerybeat-schedule 77 | 78 | # dotenv 79 | .env 80 | 81 | # virtualenv 82 | venv/ 83 | ENV/ 84 | 85 | # Spyder project settings 86 | .spyderproject 87 | 88 | # Rope project settings 89 | .ropeproject 90 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:2.7-onbuild 2 | MAINTAINER Michael Hausenblas 3 | ENV REFRESHED_AT 2017-04-24T13:50 4 | CMD [ "python", "./simpleservice.py" ] 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # A Simple Service 2 | 3 | A simple and configurable service that can, for example, be used for testing container orchestration setups (incl. health check endpoint). 4 | 5 | Note that the versions of `simpleservice`, such as `0.4.0`, used in the following refer to the tags used in the respective [Docker images](https://hub.docker.com/r/mhausenblas/simpleservice/tags/) created. There are no tags or releases as such in this GitHub repo. 6 | 7 | Contents: 8 | 9 | - [The HTTP API](#the-http-api) 10 | - [Running it](#running-it) 11 | - [Changing runtime behaviour](#changing-runtime-behaviour) 12 | - [Invoking it](#invoking-it) 13 | 14 | ## The HTTP API 15 | 16 | In addition to the endpoints listed here, see also the [change the runtime behaviour](#changing-runtime-behaviour) section below. 17 | 18 | ### `/env` [0.5.0+] 19 | 20 | Principled response: 21 | 22 | HTTP/1.1 200 OK 23 | $HEADER_FIELDS 24 | { 25 | "env": "$DUMP_OF_ENVIRONMENT_VARS", 26 | "version": "$VERSION" 27 | } 28 | 29 | Example response: 30 | 31 | HTTP/1.1 200 OK [5/99] 32 | Content-Length: 2471 33 | Content-Type: application/json 34 | Date: Mon, 24 Apr 2017 12:38:47 GMT 35 | Etag: "5ccb76cf1545f01fd1e0df4257ff6f8da19678e9" 36 | Server: TornadoServer/4.3 37 | 38 | { 39 | "env": "{'USER': 'mhausenblas', ...}" 40 | "version": "0.5.0" 41 | } 42 | 43 | ### `/info` [0.5.0+] 44 | 45 | Principled response: 46 | 47 | HTTP/1.1 200 OK 48 | $HEADER_FIELDS 49 | { 50 | "from": "$REMOTE_IP", 51 | "host": ""$HOST:$PORT"", 52 | "version": "$VERSION" 53 | } 54 | 55 | Example response: 56 | 57 | HTTP/1.1 200 OK 58 | Content-Length: 67 59 | Content-Type: application/json 60 | Date: Mon, 24 Apr 2017 12:36:37 GMT 61 | Etag: "9d09b0a126f68a0fddfec0f494e56fcab29eac15" 62 | Server: TornadoServer/4.3 63 | 64 | { 65 | "from": "127.0.0.1", 66 | "host": "localhost:9876", 67 | "version": "0.5.0" 68 | } 69 | 70 | 71 | ### `/health` [0.4.0+] 72 | 73 | Principled response: 74 | 75 | HTTP/1.1 200 OK 76 | $HEADER_FIELDS 77 | { 78 | "healthy": true 79 | } 80 | 81 | Example response: 82 | 83 | HTTP/1.1 200 OK 84 | Content-Length: 17 85 | Content-Type: application/json 86 | Date: Tue, 11 Oct 2016 17:17:21 GMT 87 | Etag: "b40026a9bea9f5096f4ef55d3d23d6730139ff5e" 88 | Server: TornadoServer/4.3 89 | 90 | { 91 | "healthy": true 92 | } 93 | 94 | ### `/endpoint0` [0.3.0+] 95 | 96 | Principled response: 97 | 98 | HTTP/1.1 200 OK 99 | $HEADER_FIELDS 100 | { 101 | "host": "$HOST:$PORT", 102 | "result": "all is well", 103 | "version": "$VERSION" 104 | } 105 | 106 | Example response: 107 | 108 | HTTP/1.1 200 OK 109 | Content-Length: 71 110 | Content-Type: application/json 111 | Date: Tue, 11 Oct 2016 16:57:33 GMT 112 | Etag: "ce18606c019e1d8c584b796d1fe7402d9767b9b6" 113 | Server: TornadoServer/4.3 114 | 115 | { 116 | "host": "localhost:9876", 117 | "result": "all is well", 118 | "version": "0.4.0" 119 | } 120 | 121 | ## Running it 122 | 123 | For local execution, Python `2.7.9` is required. You can then run `simpleservice` like so: 124 | 125 | # with defaults: 126 | $ python simpleservice.py 127 | 128 | # overwriting certain runtime settings: 129 | $ HEALTH_MAX=200 VERSION=1.0 python simpleservice.py 130 | 131 | If you fancy it you can run the containerized version of `simpleservice` on your local machine (requires Docker installed): 132 | 133 | $ docker run -P mhausenblas/simpleservice:0.5.0 134 | 135 | See also the [container images](https://hub.docker.com/r/mhausenblas/simpleservice/tags/). 136 | 137 | 138 | ## Changing runtime behaviour 139 | 140 | Through setting the following environment variables, you can change the runtime behaviour of `simpleservice`: 141 | 142 | - `PORT0` ... the port `simpleservice` is serving on 143 | - `VERSION` ... the value of `version` returned in the JSON response of the `/endpoint0` endpoint 144 | - `HEALTH_MIN` and `HEALTH_MAX` ... the min. and max. delay in milliseconds that the `/health` endpoint responds 145 | 146 | ## Invoking it 147 | 148 | Once `simpleservice` is started you can invoke it like so (here is a local service execution shown): 149 | 150 | $ http localhost:9876/endpoint0 151 | HTTP/1.1 200 OK 152 | Content-Length: 71 153 | Content-Type: application/json 154 | Date: Tue, 11 Oct 2016 16:57:33 GMT 155 | Etag: "ce18606c019e1d8c584b796d1fe7402d9767b9b6" 156 | Server: TornadoServer/4.3 157 | 158 | { 159 | "host": "localhost:9876", 160 | "result": "all is well", 161 | "version": "0.4.0" 162 | } 163 | 164 | And the service logs would show something like: 165 | 166 | ~$ python simpleservice.py 167 | This is a simple service in version v0.4.0 listening on port 9876 168 | 2016-10-11T05:57:33 INFO /endpoint0 serving from localhost:9876 has been invoked from 127.0.0.1 [at line 58] 169 | 2016-10-11T05:57:33 INFO 200 GET /endpoint0 (127.0.0.1) 1.10ms [at line 1946] 170 | 171 | Note that the available endpoints depend on the version of `simpleservice` as defined in the first section of this docs (aka API). 172 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | tornado==4.3 -------------------------------------------------------------------------------- /simpleservice.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | 3 | """ 4 | A simple service 5 | 6 | @author: Michael Hausenblas, http://mhausenblas.info/#i 7 | @since: 2016-09-23 8 | """ 9 | 10 | import logging 11 | import os 12 | import json 13 | import tornado.ioloop 14 | import tornado.web 15 | import random 16 | import time 17 | 18 | from tornado.escape import json_encode 19 | 20 | DEBUG = True 21 | 22 | ############################################################################## 23 | # The following enviroment variables can be overridden 24 | # to simulate different behaviour of the simple service: 25 | 26 | # By default simple service serves on 9876 but you can 27 | # make it listen on a different port by setting the env 28 | # variable `PORT0` (also: it listens on all network interfaces, 29 | # i.e. 0.0.0.0). 30 | PORT = os.getenv('PORT0', 9876) 31 | 32 | # By default simple service reports this value in 33 | # the /endpoint0 unless overridden by below env variable. 34 | VERSION = os.getenv('SIMPLE_SERVICE_VERSION', "0.5.0") 35 | 36 | # By default the `/health` endpoint returns a HTTP code 200 37 | # immediately but you can define the range with the following 38 | # env variables. 39 | # 40 | # Examples: 41 | # HEALTH_MIN=1000 HEALTH_MAX=2000 ... delays between 1 sec and 3 sec 42 | # HEALTH_MAX=500 ... delays up to 0.5 sec 43 | HEALTH_MIN = os.getenv('HEALTH_MIN', 0) # in milliseconds 44 | HEALTH_MAX = os.getenv('HEALTH_MAX', 0) # in milliseconds 45 | 46 | if DEBUG: 47 | FORMAT = "%(asctime)-0s %(levelname)s %(message)s [at line %(lineno)d]" 48 | logging.basicConfig(level=logging.DEBUG, format=FORMAT, datefmt="%Y-%m-%dT%I:%M:%S") 49 | else: 50 | FORMAT = "%(asctime)-0s %(message)s" 51 | logging.basicConfig(level=logging.INFO, format=FORMAT, datefmt="%Y-%m-%dT%I:%M:%S") 52 | 53 | class Endpoint0(tornado.web.RequestHandler): 54 | def get(self): 55 | """ 56 | Handles `/endpoint0` resource. 57 | """ 58 | try: 59 | logging.info("/endpoint0 serving from %s has been invoked from %s", self.request.host, self.request.remote_ip) 60 | self.set_header("Content-Type", "application/json") 61 | self.write(json_encode( 62 | { 63 | "version" : VERSION, 64 | "host" : self.request.host, 65 | "result" : "all is well" 66 | } 67 | )) 68 | self.finish() 69 | except Exception, e: 70 | logging.debug(e) 71 | self.set_status(404) 72 | 73 | class Health(tornado.web.RequestHandler): 74 | def get(self): 75 | """ 76 | Handles `/health` resource. 77 | """ 78 | try: 79 | logging.info("/health serving from %s has been invoked from %s", self.request.host, self.request.remote_ip) 80 | self.set_header("Content-Type", "application/json") 81 | self.write(json_encode( 82 | { 83 | "healthy" : True 84 | } 85 | )) 86 | 87 | if HEALTH_MAX > HEALTH_MIN and HEALTH_MIN >= 0: # make sure no shenanigans take place 88 | delay_response = random.randrange(float(HEALTH_MIN), float(HEALTH_MAX)) 89 | time.sleep(delay_response/1000.0) 90 | self.finish() 91 | except Exception, e: 92 | logging.debug(e) 93 | self.set_status(404) 94 | 95 | class Info(tornado.web.RequestHandler): 96 | def get(self): 97 | """ 98 | Handles `/info` resource. 99 | """ 100 | try: 101 | logging.info("/info serving from %s has been invoked from %s", self.request.host, self.request.remote_ip) 102 | self.set_header("Content-Type", "application/json") 103 | self.write(json_encode( 104 | { 105 | "version" : VERSION, 106 | "host" : self.request.host, 107 | "from" : self.request.remote_ip 108 | } 109 | )) 110 | self.finish() 111 | except Exception, e: 112 | logging.debug(e) 113 | self.set_status(404) 114 | 115 | class Environment(tornado.web.RequestHandler): 116 | def get(self): 117 | """ 118 | Handles `/env` resource. 119 | """ 120 | try: 121 | logging.info("/env serving from %s has been invoked from %s", self.request.host, self.request.remote_ip) 122 | self.set_header("Content-Type", "application/json") 123 | self.write(json_encode( 124 | { 125 | "version" : VERSION, 126 | "env" : str(os.environ), 127 | } 128 | )) 129 | self.finish() 130 | except Exception, e: 131 | logging.debug(e) 132 | self.set_status(404) 133 | 134 | if __name__ == "__main__": 135 | app = tornado.web.Application([ 136 | (r"/endpoint0", Endpoint0), 137 | (r"/health", Health), 138 | (r"/info", Info), 139 | (r"/env", Environment) 140 | ]) 141 | app.listen(PORT, address='0.0.0.0') 142 | logging.info("This is simple service in version v%s listening on port %s", VERSION, PORT) 143 | tornado.ioloop.IOLoop.current().start() 144 | --------------------------------------------------------------------------------