├── .coveralls.yml ├── .gitignore ├── .travis.yml ├── LICENSE ├── MANIFEST.in ├── README.md ├── django_nameko ├── VERSION ├── __init__.py └── rpc.py ├── requirements.txt ├── setup.cfg ├── setup.py ├── tests ├── __init__.py ├── config.yaml ├── services.py ├── test_rpc.py └── test_running_services.py └── tox.ini /.coveralls.yml: -------------------------------------------------------------------------------- 1 | service_name: travis-pro 2 | repo_token: Q7dFAhsb23120r63zLQ2bVOT7IaOJNvyM 3 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### JetBrains template 2 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm 3 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 4 | 5 | # User-specific stuff: 6 | .idea/ 7 | # Sensitive or high-churn files: 8 | .idea/**/dataSources/ 9 | .idea/**/dataSources.ids 10 | .idea/**/dataSources.xml 11 | .idea/**/dataSources.local.xml 12 | .idea/**/sqlDataSources.xml 13 | .idea/**/dynamic.xml 14 | .idea/**/uiDesigner.xml 15 | 16 | # Gradle: 17 | .idea/**/gradle.xml 18 | .idea/**/libraries 19 | 20 | # Mongo Explorer plugin: 21 | .idea/**/mongoSettings.xml 22 | 23 | ## File-based project format: 24 | *.iws 25 | 26 | ## Plugin-specific files: 27 | 28 | # IntelliJ 29 | /out/ 30 | 31 | # mpeltonen/sbt-idea plugin 32 | .idea_modules/ 33 | 34 | # JIRA plugin 35 | atlassian-ide-plugin.xml 36 | 37 | # Crashlytics plugin (for Android Studio and IntelliJ) 38 | com_crashlytics_export_strings.xml 39 | crashlytics.properties 40 | crashlytics-build.properties 41 | fabric.properties 42 | ### macOS template 43 | *.DS_Store 44 | .AppleDouble 45 | .LSOverride 46 | 47 | # Icon must end with two \r 48 | Icon 49 | 50 | 51 | # Thumbnails 52 | ._* 53 | 54 | # Files that might appear in the root of a volume 55 | .DocumentRevisions-V100 56 | .fseventsd 57 | .Spotlight-V100 58 | .TemporaryItems 59 | .Trashes 60 | .VolumeIcon.icns 61 | .com.apple.timemachine.donotpresent 62 | 63 | # Directories potentially created on remote AFP share 64 | .AppleDB 65 | .AppleDesktop 66 | Network Trash Folder 67 | Temporary Items 68 | .apdisk 69 | 70 | # Byte-compiled / optimized / DLL files 71 | __pycache__/ 72 | *.py[cod] 73 | *$py.class 74 | 75 | # C extensions 76 | *.so 77 | 78 | # Distribution / packaging 79 | .Python 80 | env/ 81 | build/ 82 | develop-eggs/ 83 | dist/ 84 | downloads/ 85 | eggs/ 86 | .eggs/ 87 | lib/ 88 | lib64/ 89 | parts/ 90 | sdist/ 91 | var/ 92 | *.egg-info/ 93 | .installed.cfg 94 | *.egg 95 | 96 | # PyInstaller 97 | # Usually these files are written by a python script from a template 98 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 99 | *.manifest 100 | *.spec 101 | 102 | # Installer logs 103 | pip-log.txt 104 | pip-delete-this-directory.txt 105 | 106 | # Unit test / coverage reports 107 | htmlcov/ 108 | .tox/ 109 | .coverage 110 | .coverage.* 111 | .cache 112 | nosetests.xml 113 | coverage.xml 114 | *,cover 115 | .hypothesis/ 116 | 117 | # Translations 118 | *.mo 119 | *.pot 120 | 121 | # Django stuff: 122 | *.log 123 | local_settings.py 124 | 125 | # Flask stuff: 126 | instance/ 127 | .webassets-cache 128 | 129 | # Scrapy stuff: 130 | .scrapy 131 | 132 | # Sphinx documentation 133 | docs/_build/ 134 | 135 | # PyBuilder 136 | target/ 137 | 138 | # IPython Notebook 139 | .ipynb_checkpoints 140 | 141 | # pyenv 142 | .python-version 143 | 144 | # celery beat schedule file 145 | celerybeat-schedule 146 | 147 | # dotenv 148 | .env 149 | 150 | # virtualenv 151 | venv/ 152 | ENV/ 153 | 154 | # Spyder project settings 155 | .spyderproject 156 | 157 | # Rope project settings 158 | .ropeproject 159 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: python 3 | dist: xenial 4 | services: 5 | - docker 6 | before_install: 7 | - docker run -d --rm -p 15672:15672 -p 5672:5672 -p 5671:5671 --name nameko-rabbitmq nameko/nameko-rabbitmq:3.6.6 8 | 9 | python: 10 | - "2.7" 11 | - "3.5" 12 | - "3.6" 13 | - "3.7" 14 | 15 | addons: 16 | apt_packages: 17 | - libenchant-dev 18 | 19 | install: 20 | - pip install tox-travis virtualenv tox python-coveralls coveralls 21 | 22 | cache: 23 | directories: 24 | - $HOME/.cache/pip 25 | 26 | script: 27 | - QUIET=true tox 28 | stages: 29 | - test 30 | - deploy 31 | 32 | jobs: 33 | include: 34 | - stage: test 35 | after_success: 36 | - coveralls 37 | - stage: deploy 38 | python: 2.7 39 | script: skip 40 | install: skip 41 | if: repo = "and3rson/django-nameko" 42 | deploy: 43 | provider: pypi 44 | user: tranvietanh1991 45 | password: 46 | secure: M0EPUdbMkb740aJvQWX0gIkPrkaSEhj/a7VzgyYeIA6iqpeDIxSk6nMix0HxcTvYOM7r+xQevk5CJyJAHVTnvrksYkZWbq+znp/GnFV3VwdZ5+0+7598azy0MJr8cUDeqGUbK3SOswdqztXLL1nqQ3f7XjQmViheC3OKEhwm5cdtqd92lFaprnx0pQCYYlxaAGL+W9jmVFwsxPJXaf3e98Nz8iIbCkFqlEsnrxFaTIJA02cL61O2lzttRLXM1GmyTXZYHBfHKVuHux4lvbGoOsyor2Jh0BULctspcILaJggkJZYDtW2qJ2fbl5B0M+gTFCenf4y8ZIZRkGYmcctZCa2RwErCe4fygo5nmsCNXCH4u5z4XHzOLToV47XBnF7SafKVoo42onfF9D417L0rAg1s3P7MU04ucItjAQY26QLYznuP3PNFd7rDjgT3yUl//dMW28Jo2tfYjOvcsjhamyAxPtm8b9rOMLM1jxKgPqOSsYISE8V9/BLHfGUwxk54QCUD7zoQ9PLZA+/5Mqet1c5dpO52WXKjUs4IkQtB/7diAbDLLdFWfQe8CY3dHtePVjpB4KrgfA4qiwSCYj0Syt1Go5xdJBlQIH9cyjiCpC8PlS/Ajqg91NFN/54cndTwmXDJBlyNYig00rLjNUaUyO/p5ayR0TuyIEjVJWV8pok= 47 | on: 48 | branch: master -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE README.md MANIFEST.in 2 | include django_nameko/VERSION -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # django-nameko 2 | 3 | ## Travis-CI [![Coverage Status](https://coveralls.io/repos/github/and3rson/django-nameko/badge.svg)](https://coveralls.io/github/and3rson/django-nameko) 4 | | Branch | Build status | 5 | | ------- | ---------------------------------------- | 6 | | master | [![Build Status](https://travis-ci.org/and3rson/django-nameko.svg?branch=master)](https://travis-ci.org/and3rson/django-nameko) | 7 | | develop | [![Build Status](https://travis-ci.org/and3rson/django-nameko.svg?branch=develop)](https://travis-ci.org/and3rson/django-nameko) | 8 | 9 | 10 | Django wrapper for [Nameko] microservice framework. 11 | 12 | 13 | # support 14 | tested with 15 | 16 | - python 2.7, 3.5, 3.6, 3.7 17 | - django 1.11, 2.0, 2.1, 2.2 18 | - nameko 2.11, 2.12 19 | 20 | # How to use 21 | 22 | ```python 23 | from django_nameko import get_pool 24 | 25 | # Within some view or model: 26 | with get_pool().next() as rpc: 27 | rpc.mailer.send_mail(foo='bar') 28 | ``` 29 | 30 | # Installation 31 | 32 | ```sh 33 | pip install django-nameko 34 | ``` 35 | 36 | # Configuration 37 | 38 | ```python 39 | # Config to be passed to ClusterRpcProxy 40 | NAMEKO_CONFIG = { 41 | 'AMQP_URI': 'amqp://127.0.0.1:5672/' 42 | } 43 | 44 | # Number of proxies to create 45 | # Each proxy is a single threaded standalone ClusterRpcProxy 46 | NAMEKO_POOL_SIZE = 4 47 | # Set timeout for RPC 48 | NAMEKO_TIMEOUT = 15 # timeout 15 seconds 49 | # Add this dictionary to context_data of every RPC 50 | NAMEKO_CONTEXT_DATA = { 51 | 'hostname': "my.example.com" 52 | } 53 | 54 | # Create multiple ClusterRpcProxy pool each one assoiate with a name 55 | # Every pool with pool name different than 'default' will use 'default' pool config as default configuration 56 | NAMEKO_CONFIG={ 57 | 'default': { 58 | 'AMQP_URI': 'amqp://', 59 | 'POOL_SIZE': 4, 60 | 'POOL_CONTEXT_DATA': {"common": "multi"}, 61 | 'POOL_TIMEOUT': None 62 | }, 63 | 'pool1': { 64 | 'AMQP_URI': 'amqp://pool2', 65 | 'POOL_CONTEXT_DATA': {"name": "pool1", "data": 123}, 66 | }, 67 | 'pool2': { 68 | 'AMQP_URI': 'amqp://pool3', 69 | 'POOL_CONTEXT_DATA': {"name": "pool2", "data": 321}, 70 | 'POOL_TIMEOUT': 60 71 | }, 72 | 'pool3': { 73 | 'POOL_SIZE': 8, 74 | 'POOL_TIMEOUT': 60 75 | } 76 | } 77 | # Use multi pool by putting pool name in get_pool(..) 78 | from django_nameko import get_pool 79 | 80 | with get_pool('pool1').next() as rpc: 81 | rpc.mailer.send_mail(foo='bar') 82 | 83 | # call get_pool() without argument will return the 'default' pool 84 | # but you can override the rpc context data before call, example below. 85 | # it will auto revert back to POOL_CONTEXT_DATA when exit the with block 86 | with get_pool().next() as rpc: 87 | rpc._worker_ctx.data['SMTP_SECRET'] = 'SECRETXXX' 88 | rpc.mailer.send_mail(foo='bar') 89 | 90 | # try to call rpc outside of with statement block will raise an AttributeError exception 91 | rpc.mailer.send_mail(bar='foo') 92 | # File "/usr/local/lib/python2.7/site-packages/django_nameko/rpc.py", line 69, in __getattr__ 93 | # raise AttributeError(item) 94 | # AttributeError: mailer 95 | 96 | # New feature (from 0.7.0): 97 | # To dispatch event to any service event listener, for example you have this nameko service: 98 | from nameko.events import event_handler 99 | class EchoService(object): 100 | name = 'echo' 101 | 102 | @event_handler("echo", "ping") 103 | def handle_event(self, payload): 104 | print("service echo received:%s", payload) 105 | # You can sent an event signal to all service listener like this 106 | from django_nameko import dispatch 107 | dispatch("echo", "ping", {"payload": {"data": 0}}) 108 | 109 | 110 | ``` 111 | 112 | # contribute 113 | 114 | to run the tests: 115 | 1. run a local rabbitmq 116 | 2. execute tox 117 | ```bash 118 | docker run --rm -p 15672:15672 -p 5672:5672 -p 5671:5671 --name nameko-rabbitmq nameko/nameko-rabbitmq:3.6.6 119 | # open another shell then run 120 | python setup.py test 121 | # to run full test with coverage use 122 | tox 123 | ``` 124 | 125 | # Credits 126 | Thanks to guys who made an awesome [Nameko] framework. 127 | 128 | Maintainers: 129 | - Andrew Dunai ([@and3rson](https://github.com/and3rson)) 130 | - Vincent Anh Tran ([@tranvietanh1991](https://github.com/tranvietanh1991)) 131 | 132 | [Nameko]: https://github.com/nameko/nameko 133 | -------------------------------------------------------------------------------- /django_nameko/VERSION: -------------------------------------------------------------------------------- 1 | 0.8.2 2 | -------------------------------------------------------------------------------- /django_nameko/__init__.py: -------------------------------------------------------------------------------- 1 | from __future__ import absolute_import, unicode_literals 2 | 3 | from .rpc import ClusterRpcProxyPool, destroy_pool, get_pool, dispatch, get_event_dispatcher 4 | 5 | __all__ = [ 6 | 'ClusterRpcProxyPool', 7 | 'get_pool', 8 | 'destroy_pool', 9 | 'get_event_dispatcher', 10 | 'dispatch', 11 | ] 12 | -------------------------------------------------------------------------------- /django_nameko/rpc.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | # -*- coding: utf-8 -*- 3 | # 4 | # __init__.py 5 | # 6 | # 7 | # Created by Vincent Anh Tran on 21/03/2018 8 | # Copyright (c) Vincent Anh Tran - maintain this project since 0.1.1 9 | # 10 | from __future__ import absolute_import 11 | 12 | import copy 13 | import logging 14 | import weakref 15 | from threading import Lock, Thread 16 | import time 17 | import socket 18 | from amqp.exceptions import ConnectionError # heartbeat failed will raise this error: ConnectionForced 19 | from django.conf import settings 20 | from django.core.exceptions import ImproperlyConfigured 21 | from nameko.standalone.rpc import ClusterRpcProxy 22 | from nameko.standalone.events import event_dispatcher 23 | from nameko.constants import AMQP_URI_CONFIG_KEY, HEARTBEAT_CONFIG_KEY 24 | from six.moves import queue as queue_six 25 | from six.moves import xrange as xrange_six 26 | import atexit 27 | import math 28 | 29 | _logger = logging.getLogger(__name__) 30 | 31 | 32 | class ClusterRpcProxyPool(object): 33 | """ Connection pool for Nameko RPC cluster. 34 | 35 | Pool size can be customized by passing `pool_size` kwarg to constructor. 36 | Default size is 4. 37 | 38 | *Usage* 39 | 40 | pool = ClusterRpcProxyPool(config) 41 | pool.start() 42 | 43 | # ... 44 | 45 | with pool.next() as rpc: 46 | rpc.mailer.send_mail(foo='bar') 47 | 48 | # ... 49 | 50 | pool.stop() 51 | 52 | This class is thread-safe and designed to work with GEvent. 53 | """ 54 | 55 | class RpcContext(object): 56 | def __init__(self, pool, config): 57 | self._pool = weakref.proxy(pool) 58 | self._proxy = ClusterRpcProxy(config, context_data=copy.deepcopy(pool.context_data), timeout=pool.timeout) 59 | self._rpc = None 60 | self._enable_rpc_call = False 61 | 62 | def __del__(self): 63 | if self._proxy: 64 | try: 65 | self._proxy.stop() 66 | except: # ignore any error since the object is being garbage collected 67 | pass 68 | self._proxy = None 69 | self._rpc = None 70 | 71 | def __getattr__(self, item): 72 | """ This will return the service proxy instance 73 | 74 | :param item: name of the service 75 | :return: Service Proxy 76 | """ 77 | if not self._enable_rpc_call: 78 | raise AttributeError(item) 79 | return getattr(self._rpc, item) 80 | 81 | def __enter__(self): 82 | if self._proxy is None: 83 | self._pool._reload(1) # reload 1 worker and raise error 84 | self.__del__() 85 | raise RuntimeError("This RpcContext has been stopped already") 86 | elif self._rpc is None: 87 | # try to start the RPC proxy if it haven't been started yet (first RPC call of this connection) 88 | try: 89 | self._rpc = self._proxy.start() 90 | except (IOError, ConnectionError): # if failed then reload 1 worker and reraise 91 | self._pool._reload(1) # reload 1 worker 92 | self.__del__() 93 | raise 94 | self._enable_rpc_call = True 95 | return weakref.proxy(self) 96 | 97 | def __exit__(self, exc_type, exc_value, traceback, **kwargs): 98 | self._enable_rpc_call = False 99 | try: 100 | if exc_type == RuntimeError and str(exc_value) in ( 101 | "This consumer has been stopped, and can no longer be used", 102 | "This consumer has been disconnected, and can no longer be used", 103 | "This RpcContext has been stopped already"): 104 | self._pool._reload(1) # reload all worker 105 | self.__del__() 106 | elif exc_type == ConnectionError: 107 | self._pool._reload(1) # reload atmost 1 worker 108 | self.__del__() 109 | else: 110 | if self._rpc._worker_ctx.data is not None: 111 | if self._pool.context_data is None: 112 | # clear all key since there is no.pool context_data 113 | for key in list(self._rpc._worker_ctx.data.keys()): 114 | del self._rpc._worker_ctx.data[key] 115 | elif len(self._rpc._worker_ctx.data) != len(self._pool.context_data) \ 116 | or self._rpc._worker_ctx.data != self._pool.context_data: 117 | # ensure that worker_ctx.data is revert back to original 118 | # pool.context_data when exit of block 119 | for key in list(self._rpc._worker_ctx.data.keys()): 120 | if key not in self._pool.context_data: 121 | del self._rpc._worker_ctx.data[key] 122 | else: 123 | self._rpc._worker_ctx.data[key] = self._pool.context_data[key] 124 | self._pool._put_back(self) 125 | except ReferenceError: # pragma: no cover 126 | # We're detached from the parent, so this context 127 | # is going to silently die. 128 | self.__del__() 129 | 130 | def __init__(self, config, pool_size=None, context_data=None, timeout=0): 131 | if pool_size is None: # keep this for compatiblity 132 | pool_size = getattr(settings, 'NAMEKO_POOL_SIZE', 4) 133 | if context_data is None: # keep this for compatiblity 134 | context_data = getattr(settings, 'NAMEKO_CONTEXT_DATA', None) 135 | if timeout is not None and timeout <= 0: # keep this for compatiblity 136 | timeout = getattr(settings, 'NAMEKO_TIMEOUT', None) 137 | self.config = copy.deepcopy(config) 138 | self.pool_size = pool_size 139 | self.context_data = copy.deepcopy(context_data) 140 | self.timeout = timeout 141 | self.heartbeat = self.config.get(HEARTBEAT_CONFIG_KEY) 142 | self._heartbeat_check_thread = None 143 | self.state = 'NOT_STARTED' 144 | self.queue = None 145 | 146 | def start(self): 147 | """ Populate pool with connections. 148 | """ 149 | self.queue = queue_six.Queue() 150 | for i in xrange_six(self.pool_size): 151 | ctx = ClusterRpcProxyPool.RpcContext(self, self.config) 152 | self.queue.put(ctx) 153 | self.state = 'STARTED' 154 | if self.heartbeat: 155 | self._heartbeat_check_thread = Thread(target=self.heartbeat_check) 156 | self._heartbeat_check_thread.daemon = True 157 | self._heartbeat_check_thread.start() 158 | _logger.debug("Heart beat check thread started") 159 | 160 | @property 161 | def is_started(self): 162 | return self.state != 'NOT_STARTED' 163 | 164 | def _clear(self): 165 | count = 0 166 | while self.queue.empty() is False: 167 | self.next(block=False).__del__() 168 | count += 1 169 | _logger.debug("Clear %d connection", count) 170 | 171 | def _reload(self, num_of_worker=0): 172 | """ Reload into pool's queue with number of new worker 173 | 174 | :param int num_of_worker: 175 | :return: None 176 | """ 177 | if num_of_worker <= 0: 178 | num_of_worker = self.pool_size 179 | count = 0 180 | for i in xrange_six(num_of_worker): 181 | if self.queue.full() is False: 182 | ctx = ClusterRpcProxyPool.RpcContext(self, self.config) 183 | self.queue.put_nowait(ctx) 184 | count += 1 185 | _logger.debug("Reload %d connection", count) 186 | 187 | def next(self, block=True, timeout=None): 188 | """ Fetch next connection. 189 | 190 | This method is thread-safe. 191 | :rtype: ClusterRpcProxyPool.RpcContext 192 | """ 193 | if timeout is None: 194 | timeout = self.timeout 195 | return self.queue.get(block=block, timeout=timeout) 196 | 197 | def _put_back(self, ctx): 198 | self.queue.put(ctx) 199 | 200 | def stop(self): 201 | """ Stop queue and remove all connections from pool. 202 | """ 203 | self.state = 'STOPPED' 204 | if self.queue: 205 | while True: 206 | try: 207 | ctx = self.queue.get_nowait() 208 | ctx.__del__() 209 | except queue_six.Empty: 210 | break 211 | self.queue.queue.clear() 212 | self.queue = None 213 | # if self._heartbeat_check_thread: 214 | # self._heartbeat_check_thread.join() 215 | # _logger.debug("Heart beat check thread stopped") 216 | 217 | def heartbeat_check(self): 218 | RATE = 2 + math.log(self.heartbeat, 30) if self.heartbeat > 30 else 2. 219 | MIN_SLEEP = 3 # better sleep between 3 seconds, if this loop is running too frequent it may affect performance 220 | loop_count = 0 221 | REPLIES_CLEAN_UP_CYCLE = 10 # how many loop cycle to perform replies clean up 222 | replies_timestamp = {} # hash of correlation_id of replies and its timestamp when first detected 223 | sleep_duration = max(self.heartbeat / abs(RATE), MIN_SLEEP) 224 | while self.heartbeat and self.state == 'STARTED': 225 | for i in range(10): 226 | # breakdown sleep in smaller step 227 | time.sleep(sleep_duration/10.0) 228 | if self.state == 'STOPPED': 229 | return 230 | count_ok = 0 231 | cleared = set() 232 | try: 233 | for _ in xrange_six(self.pool_size): 234 | if self.state == 'STOPPED': 235 | return 236 | ctx = None 237 | try: 238 | ctx = self.queue.get_nowait() 239 | except (queue_six.Empty, AttributeError): 240 | break 241 | else: 242 | if ctx and ctx._rpc and id(ctx) not in cleared: 243 | try: 244 | try: 245 | ctx._rpc._reply_listener.queue_consumer.connection.drain_events(timeout=0.1) 246 | except socket.timeout: 247 | pass 248 | ctx._rpc._reply_listener.queue_consumer.connection.heartbeat_check() 249 | except (ConnectionError, socket.error, IOError) as exc: 250 | _logger.info("Heart beat failed. System will discard broken connection and replenish " 251 | "pool with a new connection, %s: %s", 252 | type(exc).__name__, exc.args[0]) 253 | ctx.__del__() 254 | ctx = ClusterRpcProxyPool.RpcContext(self, self.config) 255 | else: 256 | count_ok += 1 257 | # this allow only one RPCProxy connection to be cleanup at a time 258 | d = loop_count - count_ok 259 | if d > 0 and d % REPLIES_CLEAN_UP_CYCLE == 0: 260 | count_clean = 0 261 | now = time.time() 262 | # perform cleanup on this RpcProxy connection replies 263 | for msg_correlation_id in list(ctx._rpc._reply_listener.queue_consumer.replies.keys()): 264 | if self.state == 'STOPPED': 265 | return 266 | timestamp = replies_timestamp.get(msg_correlation_id) 267 | if timestamp is None: 268 | replies_timestamp[msg_correlation_id] = now 269 | else: 270 | # clean up the reply if its has stay in replies 271 | if now - timestamp > self.timeout: 272 | del ctx._rpc._reply_listener.queue_consumer.replies[msg_correlation_id] 273 | del replies_timestamp[msg_correlation_id] 274 | count_clean += 1 275 | _logger.debug("Perform cleanup remove %d message", count_clean) 276 | finally: 277 | if ctx is not None and self.queue is not None: 278 | self.queue.put_nowait(ctx) 279 | cleared.add(id(ctx)) 280 | elif ctx is not None: 281 | # unable to put it back, probaly due to system exit so better just delete the connection 282 | ctx.__del__() 283 | except Exception as exc: 284 | _logger.error("%s: %s", type(exc).__name__, exc.args[0]) 285 | # just log the error out without raise to keep the heartbeat thread going 286 | _logger.debug("Heart beat %d OK", count_ok) 287 | loop_count += 1 288 | 289 | def __del__(self): 290 | if self.state != 'STOPPED': 291 | try: 292 | self.stop() 293 | except: # ignore any error since the object is being garbage collected 294 | pass 295 | 296 | 297 | nameko_global_pools = None 298 | create_pool_lock = Lock() 299 | 300 | WRONG_CONFIG_MSG = 'NAMEKO_CONFIG must be specified and should include at least "default" config with "%s"' % ( 301 | AMQP_URI_CONFIG_KEY) 302 | 303 | 304 | def mergedicts(dict1, dict2): 305 | for k in set(dict1.keys()).union(dict2.keys()): 306 | if k in dict1 and k in dict2: 307 | if isinstance(dict1[k], dict) and isinstance(dict2[k], dict): 308 | yield (k, dict(mergedicts(dict1[k], dict2[k]))) 309 | else: 310 | # If one of the values is not a dict, you can't continue merging it. 311 | # Value from second dict overrides one in first and we move on. 312 | yield (k, dict2[k]) 313 | # Alternatively, replace this with exception raiser to alert you of value conflicts 314 | elif k in dict1: 315 | yield (k, dict1[k]) 316 | else: 317 | yield (k, dict2[k]) 318 | 319 | 320 | def get_pool(pool_name=None): 321 | """ 322 | Use this method to acquire a connection pool from nameko_global_pools. 323 | 324 | Example usage: 325 | 326 | from coreservices.core.rpc import get_pool 327 | # ... 328 | with get_pool().next() as rpc: 329 | rpc.mailer.send_mail(foo='bar') 330 | :rtype: ClusterRpcProxyPool 331 | """ 332 | 333 | global nameko_global_pools 334 | 335 | if not nameko_global_pools: 336 | NAMEKO_CONFIG = getattr(settings, 'NAMEKO_CONFIG', {}) 337 | if not NAMEKO_CONFIG: 338 | raise ImproperlyConfigured('NAMEKO_CONFIG must be specified') 339 | NAMEKO_MULTI_POOL = [name for name in NAMEKO_CONFIG.keys() if name.islower()] 340 | # Lazy instantiation, acquire lock first to prevent dupication init 341 | with create_pool_lock: 342 | if not nameko_global_pools: # double check inside lock is importance 343 | if NAMEKO_MULTI_POOL: 344 | nameko_global_pools = dict() 345 | 346 | if 'default' not in NAMEKO_CONFIG: 347 | raise ImproperlyConfigured(WRONG_CONFIG_MSG) 348 | else: 349 | if 'AMQP_URL' in NAMEKO_CONFIG['default']: # compatible code to prevent typo mistake 350 | NAMEKO_CONFIG['default'][AMQP_URI_CONFIG_KEY] = NAMEKO_CONFIG['default'].pop('AMQP_URL') 351 | if AMQP_URI_CONFIG_KEY not in NAMEKO_CONFIG['default']: 352 | raise ImproperlyConfigured(WRONG_CONFIG_MSG) 353 | 354 | default_config = NAMEKO_CONFIG['default'] 355 | # default_context_data = NAMEKO_CONFIG['default']['POOL'].get('CONTEXT_DATA', dict()) 356 | # multi_context_data = getattr(settings, 'NAMEKO_MULTI_CONTEXT_DATA', dict()) 357 | for name, _config in NAMEKO_CONFIG.items(): 358 | # each nameko_global_pools will have different config with default config as default 359 | if name != 'default': 360 | # overide default config with nameko_global_pools config by merging 2 dict 361 | pool_config = dict(mergedicts(default_config.copy(), _config)) 362 | else: 363 | # default nameko_global_pools 364 | pool_config = default_config.copy() 365 | # extract nameko_global_pools config from RpcCluster config 366 | pool_size = pool_config.pop('POOL_SIZE', None) 367 | pool_context_data = pool_config.pop('POOL_CONTEXT_DATA', None) 368 | pool_timeout = pool_config.pop('POOL_TIMEOUT', 0) 369 | # init nameko_global_pools 370 | _pool = ClusterRpcProxyPool(pool_config, pool_size=pool_size, context_data=pool_context_data, 371 | timeout=pool_timeout) 372 | # assign nameko_global_pools to corresponding name 373 | nameko_global_pools[name] = _pool 374 | else: 375 | # single nameko_global_pools with old style configuration 376 | nameko_global_pools = ClusterRpcProxyPool(settings.NAMEKO_CONFIG) 377 | 378 | # Finish instantiation, release lock 379 | 380 | if pool_name is not None: 381 | if isinstance(nameko_global_pools, dict) is False or pool_name not in nameko_global_pools: 382 | raise ImproperlyConfigured( 383 | 'NAMEKO_CONFIG must include this nameko_global_pools name "%s" config' % pool_name) 384 | else: 385 | _pool = nameko_global_pools[pool_name] 386 | else: 387 | if isinstance(nameko_global_pools, dict): 388 | if len(nameko_global_pools) == 0: # pragma: nocover 389 | # this code is unreachable, it's not passilbe to have a dict without a key in it. 390 | raise ImproperlyConfigured(WRONG_CONFIG_MSG) 391 | _pool = nameko_global_pools.get('default', next(iter(nameko_global_pools.values()))) 392 | else: 393 | _pool = nameko_global_pools 394 | if not _pool.is_started: 395 | _pool.start() 396 | return _pool 397 | 398 | 399 | @atexit.register 400 | def destroy_pool(): 401 | global nameko_global_pools 402 | if isinstance(nameko_global_pools, dict): 403 | for pool in nameko_global_pools.values(): 404 | pool.stop() 405 | elif nameko_global_pools is not None: 406 | nameko_global_pools.stop() 407 | nameko_global_pools = None 408 | _logger.info("nameko_global_pools are destroyed") 409 | 410 | 411 | # setup a singleton event dispatcher for current worker 412 | nameko_event_dispatcher = None 413 | create_event_dispatcher_lock = Lock() 414 | 415 | 416 | def get_event_dispatcher(): 417 | global nameko_event_dispatcher 418 | if not nameko_event_dispatcher: 419 | NAMEKO_CONFIG = getattr(settings, 'NAMEKO_CONFIG', {}) 420 | if not NAMEKO_CONFIG: 421 | raise ImproperlyConfigured('NAMEKO_CONFIG must be specified') 422 | # Lazy instantiation, acquire lock first to prevent dupication init 423 | with create_event_dispatcher_lock: 424 | if not nameko_event_dispatcher: # double check inside lock is importance 425 | # init nameko_event_dispatcher 426 | nameko_event_dispatcher = event_dispatcher( 427 | NAMEKO_CONFIG['default'] if 'default' in NAMEKO_CONFIG else NAMEKO_CONFIG 428 | ) 429 | # Finish instantiation, lock will be released automaticaly when exit this block 430 | return nameko_event_dispatcher 431 | 432 | 433 | def dispatch(service_name, event_type, event_data): 434 | """ Dispatch an event claiming to originate from `service_name` with 435 | the given `event_type` and `event_data`. 436 | """ 437 | _dispatch = get_event_dispatcher() 438 | return _dispatch(service_name, event_type, event_data) 439 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | django>=1.10 2 | nameko==2.11.* -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md 3 | license-file = LICENSE 4 | [nosetests] 5 | verbosity=1 6 | detailed-errors=1 7 | # with-coverage=1 8 | # cover-package=coverage 9 | # debug=nose.loader 10 | # pdb=1 11 | # pdb-failures=1 12 | stop=1 13 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python2 2 | import os 3 | 4 | from os import path 5 | this_directory = path.abspath(path.dirname(__file__)) 6 | with open(path.join(this_directory, 'README.md'), 'rb') as f: 7 | long_description = f.read().decode('utf8') 8 | 9 | with open(os.path.join(os.path.dirname(os.path.abspath(__file__)), 'django_nameko/VERSION')) as f: 10 | __version__ = f.read() 11 | 12 | from setuptools import setup 13 | 14 | setup( 15 | name='django-nameko', 16 | version=__version__, 17 | description=' Django wrapper for nameko microservice framework.', 18 | long_description=long_description, 19 | long_description_content_type='text/markdown', 20 | url='http://github.com/and3rson/django-nameko', 21 | author='Andrew Dunai', 22 | author_email='andrew@dun.ai', 23 | maintainer='Vincent Anh Tran', 24 | maintainer_email='tranvietanh1991@gmail.com', 25 | license='GPLv2', 26 | packages=['django_nameko'], 27 | zip_safe=False, 28 | install_requires=[ 29 | 'nameko>=2.11.0', 30 | 'django>=1.10' 31 | ], 32 | test_suite='nose.collector', 33 | tests_require=['nose'], 34 | classifiers=[ 35 | 'Development Status :: 4 - Beta', 36 | 'Intended Audience :: Developers', 37 | 'Programming Language :: Python :: 2', 38 | 'Programming Language :: Python :: 2.7', 39 | 'Programming Language :: Python :: 3', 40 | 'Programming Language :: Python :: 3.5', 41 | 'Programming Language :: Python :: 3.6', 42 | 'Programming Language :: Python :: 3.7', 43 | "Operating System :: OS Independent", 44 | "Topic :: Software Development :: Libraries :: Python Modules", 45 | ], 46 | ) 47 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | -------------------------------------------------------------------------------- /tests/config.yaml: -------------------------------------------------------------------------------- 1 | AMQP_URI: amqp://guest:guest@localhost/ 2 | 3 | max_workers: 1 4 | -------------------------------------------------------------------------------- /tests/services.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | import logging 3 | 4 | from nameko.rpc import rpc 5 | from nameko.events import event_handler 6 | import os 7 | import shutil 8 | 9 | logger = logging.getLogger(__name__) 10 | 11 | 12 | class EchoService(object): 13 | name = 'echo' 14 | 15 | @rpc 16 | def echo(self, *attrs): 17 | return tuple(attrs) 18 | 19 | @event_handler("echo", "touch") 20 | def handle_event_touch(self, payload): 21 | logger.debug("service echo received:%s", payload) 22 | if 'path' in payload and os.path.exists(payload['path']): 23 | os.unlink(payload['path']) 24 | 25 | @event_handler("echo", "clone") 26 | def handle_event_clone1(self, payload): 27 | logger.debug("service echo received:%s", payload) 28 | if 'path' in payload and os.path.exists(payload['path']): 29 | shutil.copy(payload['path'], payload['path'] + '.copy') 30 | 31 | @event_handler("echo", "clone") 32 | def handle_event_clone2(self, payload): 33 | logger.debug("service echo received:%s", payload) 34 | if 'path' in payload and os.path.exists(payload['path']): 35 | os.link(payload['path'], payload['path'] + '.link') 36 | -------------------------------------------------------------------------------- /tests/test_rpc.py: -------------------------------------------------------------------------------- 1 | import logging 2 | 3 | from amqp import ConnectionError 4 | from django.conf import settings 5 | from django.core.exceptions import ImproperlyConfigured 6 | from django.test.utils import override_settings 7 | from mock import call, patch 8 | from six.moves import queue as queue_six 9 | 10 | from django_nameko import destroy_pool, get_pool, rpc 11 | from nose import tools 12 | 13 | settings.configure() 14 | logger = logging.getLogger(__name__) 15 | 16 | 17 | @override_settings(NAMEKO_CONFIG=dict(AMQP_URI='amqp://')) 18 | def test_cluster_proxy_pool(): 19 | with patch('django_nameko.rpc.ClusterRpcProxy') as FakeClusterRpcProxy: 20 | pool = rpc.ClusterRpcProxyPool(dict(), pool_size=2) 21 | pool.start() 22 | assert pool.queue.qsize() == 2 23 | 24 | with pool.next() as client: 25 | assert pool.queue.qsize() == 1 26 | 27 | client.foo.bar() 28 | assert call().start().foo.bar() in FakeClusterRpcProxy.mock_calls 29 | 30 | with pool.next(): 31 | assert pool.queue.qsize() == 0 32 | 33 | tools.assert_raises(queue_six.Empty, pool.next, timeout=1) 34 | 35 | assert pool.queue.qsize() == 1 36 | assert pool.queue.qsize() == 2 37 | 38 | pool.stop() 39 | 40 | 41 | @override_settings(NAMEKO_CONFIG=dict(AMQP_URI='amqp://')) 42 | def test_get_pool(): 43 | with patch('django_nameko.rpc.ClusterRpcProxy') as FakeClusterRpcProxy: 44 | pool = get_pool() 45 | with pool.next() as client: 46 | client.foo.bar() 47 | assert call().start().foo.bar() in FakeClusterRpcProxy.mock_calls 48 | destroy_pool() 49 | 50 | 51 | @override_settings(NAMEKO_CONFIG=dict(AMQP_URI='amqp://'), NAMEKO_POOL_SIZE=5) 52 | def test_custom_pool_size(): 53 | with patch('django_nameko.rpc.ClusterRpcProxy') as FakeClusterRpcProxy: 54 | pool = get_pool() 55 | assert pool.queue.qsize() == 5 56 | destroy_pool() 57 | 58 | 59 | @override_settings(NAMEKO_CONFIG=None) 60 | def test_no_settings(): 61 | tools.assert_raises(ImproperlyConfigured, get_pool) 62 | destroy_pool() 63 | 64 | 65 | @override_settings(NAMEKO_CONFIG={'badkey': 'amqp://'}) 66 | def test_bad_settings(): 67 | tools.assert_raises(ImproperlyConfigured, get_pool) 68 | destroy_pool() 69 | 70 | 71 | @override_settings(NAMEKO_CONFIG={}) 72 | def test_abd_settings(): 73 | tools.assert_raises(ImproperlyConfigured, get_pool) 74 | destroy_pool() 75 | 76 | 77 | @override_settings(NAMEKO_CONFIG={'pool1': dict(AMQP_URI='amqp://')}) 78 | def test_missing_default_settings(): 79 | tools.assert_raises(ImproperlyConfigured, get_pool) 80 | destroy_pool() 81 | 82 | 83 | @override_settings(NAMEKO_CONFIG=dict(AMQP_URI='amqp://'), NAMEKO_CONTEXT_DATA={"data": 123}) 84 | def test_context_data(): 85 | with patch('django_nameko.rpc.ClusterRpcProxy') as FakeClusterRpcProxy: 86 | pool = get_pool() 87 | assert pool.context_data.get("data") == 123 88 | # ctx = pool.queue.get_nowait() 89 | # context_data = ctx.proxy._worker_ctx.data 90 | # assert context_data.get("data") == 123 91 | # ctx.stop() 92 | destroy_pool() 93 | 94 | 95 | @override_settings(NAMEKO_CONFIG=dict(AMQP_URI='amqp://')) 96 | def test_runtime_error(): 97 | with patch('django_nameko.rpc.ClusterRpcProxy') as FakeClusterRpcProxy: 98 | pool = get_pool() 99 | assert pool.queue.qsize() == 4, pool.queue.qsize() 100 | client = pool.next() 101 | # getting client out of pool without using context will make 1 connection go missing 102 | assert pool.queue.qsize() == 3, pool.queue.qsize() 103 | 104 | with client: 105 | client.foo.bar() 106 | assert call().start().foo.bar() in FakeClusterRpcProxy.mock_calls 107 | client._proxy = None # this line will make this client become unusable as it is stopped 108 | 109 | assert pool.queue.qsize() == 4, pool.queue.qsize() 110 | with tools.assert_raises(RuntimeError): 111 | # try to loop through all connection in pool, the last one will failed due to RuntimeError 112 | for i in range(4): 113 | with pool.next(): 114 | assert pool.queue.qsize() == 3, pool.queue.qsize() 115 | # expect the pool to recover the stopped client 116 | assert pool.queue.qsize() == 4, pool.queue.qsize() 117 | 118 | destroy_pool() 119 | 120 | 121 | @override_settings(NAMEKO_CONFIG=dict(AMQP_URI='amqp://')) 122 | def test_connection_error(): 123 | with patch('django_nameko.rpc.ClusterRpcProxy') as FakeClusterRpcProxy: 124 | pool = get_pool() 125 | assert pool.queue.qsize() == 4, pool.queue.qsize() 126 | client = pool.next() 127 | assert pool.queue.qsize() == 3, pool.queue.qsize() 128 | with tools.assert_raises(ConnectionError): 129 | with pool.next(): 130 | assert pool.queue.qsize() == 2, pool.queue.qsize 131 | raise ConnectionError("connection closed") 132 | assert pool.queue.qsize() == 3, pool.queue.qsize 133 | # this has cleared all 4 proxy since runtimeerror is expected to broke them all 134 | with client: 135 | assert pool.queue.qsize() == 3, pool.queue.qsize() 136 | client.foo.bar() 137 | assert call().start().foo.bar() in FakeClusterRpcProxy.mock_calls 138 | assert pool.queue.qsize() == 4, pool.queue.qsize() 139 | 140 | destroy_pool() 141 | 142 | 143 | @override_settings(NAMEKO_CONFIG={ 144 | 'default': { 145 | 'AMQP_URI': 'amqp://' 146 | }, 147 | 'pool1': { 148 | 'POOL_SIZE': 8, 149 | }, 150 | 'pool2': { 151 | 'AMQP_URI': 'amqp://pool2' 152 | } 153 | }) 154 | def test_multi_pool(): 155 | with patch('django_nameko.rpc.ClusterRpcProxy') as FakeClusterRpcProxy: 156 | pool_default = get_pool('default') 157 | pool_0 = get_pool() 158 | pool1 = get_pool('pool1') 159 | pool2 = get_pool('pool2') 160 | assert pool1 != pool2 161 | assert pool1.is_started and pool2.is_started 162 | assert pool_0.is_started and pool_default == pool_0 163 | assert pool1.config == pool_0.config 164 | assert pool1.queue.qsize() == 8 165 | assert pool2.config != pool_0.config 166 | tools.assert_raises(ImproperlyConfigured, lambda: get_pool('pool3')) 167 | 168 | destroy_pool() 169 | 170 | 171 | @override_settings(NAMEKO_CONFIG=dict(AMQP_URI='amqp://')) 172 | def test_multi_pool_no_config(): 173 | with patch('django_nameko.rpc.ClusterRpcProxy') as FakeClusterRpcProxy: 174 | tools.assert_raises(ImproperlyConfigured, lambda: get_pool('pool1')) 175 | destroy_pool() 176 | 177 | 178 | @override_settings(NAMEKO_CONFIG={ 179 | 'default': { 180 | 'AMQP_URI': 'amqp://', 181 | 'POOL_SIZE': 4, 182 | 'POOL_CONTEXT_DATA': {"common": "multi"}, 183 | 'POOL_TIMEOUT': None 184 | }, 185 | 'pool1': { 186 | 'AMQP_URI': 'amqp://pool2', 187 | 'POOL_CONTEXT_DATA': {"name": "pool1", "data": 123}, 188 | }, 189 | 'pool2': { 190 | 'AMQP_URI': 'amqp://pool3', 191 | 'POOL_CONTEXT_DATA': {"name": "pool2", "data": 321}, 192 | 'POOL_TIMEOUT': 60 193 | }, 194 | 'pool3': { 195 | 'POOL_SIZE': 8, 196 | 'POOL_TIMEOUT': 60 197 | } 198 | }) 199 | def test_multi_pool_context_data(): 200 | with patch('django_nameko.rpc.ClusterRpcProxy') as FakeClusterRpcProxy: 201 | pool1 = get_pool('pool1') 202 | pool2 = get_pool('pool2') 203 | assert pool1.context_data.get("common") == "multi" 204 | assert pool2.context_data.get("common") == "multi" 205 | assert pool1.context_data.get("name") == "pool1" 206 | assert pool2.context_data.get("name") == "pool2" 207 | assert pool1.context_data.get("data") == 123 208 | assert pool2.context_data.get("data") == 321 209 | pool3 = get_pool('pool3') 210 | assert pool3.context_data.get("common") == "multi" 211 | assert pool3.context_data.get("name") is None 212 | assert pool3.queue.qsize() == 8 213 | assert pool1.is_started and pool2.is_started and pool3.is_started 214 | tools.assert_raises(ImproperlyConfigured, lambda: get_pool('pool4')) 215 | 216 | destroy_pool() 217 | 218 | 219 | @override_settings(NAMEKO_CONFIG=dict(AMQP_URI='amqp://')) 220 | def test_pool_call_rpc_out_of_with_statement(): 221 | with patch('django_nameko.rpc.ClusterRpcProxy') as FakeClusterRpcProxy: 222 | pool = get_pool() 223 | with pool.next() as client: 224 | client.foo.bar() 225 | assert call().start().foo.bar() in FakeClusterRpcProxy.mock_calls 226 | # try to call RPC out of with statement 227 | tools.assert_raises(AttributeError, lambda: client.foo.bar()) 228 | try: 229 | client.bar.foo() 230 | except AttributeError: 231 | pass 232 | else: # pragma: nocover 233 | raise AssertionError("AttributeError is expected when call rpc out of with statement") 234 | # try again inside with statement 235 | with pool.next() as client: 236 | client.bar.foo() 237 | assert call().start().bar.foo() in FakeClusterRpcProxy.mock_calls 238 | 239 | destroy_pool() 240 | -------------------------------------------------------------------------------- /tests/test_running_services.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | from __future__ import absolute_import, unicode_literals 3 | 4 | import logging 5 | import os 6 | import socket 7 | import subprocess 8 | import time 9 | import unittest 10 | import sys 11 | 12 | from amqp import AccessRefused 13 | from django.conf import settings 14 | from django.test.utils import override_settings 15 | from nameko.exceptions import MethodNotFound, UnknownService 16 | import tempfile 17 | from django_nameko import destroy_pool, get_pool, dispatch 18 | from nose import tools 19 | from tests.services import EchoService 20 | 21 | logger = logging.getLogger(__name__) 22 | 23 | if not settings.configured: # pragma: nocover 24 | settings.configure() 25 | 26 | config = { 27 | 'AMQP_URI': 'amqp://guest:guest@localhost', 28 | 'TIMEOUT': 1 29 | } 30 | 31 | 32 | class RealServiceTest(unittest.TestCase): 33 | runner = None # type: subprocess.Popen 34 | 35 | @classmethod 36 | def setUpClass(cls): 37 | """ 38 | run the service while in the context 39 | :return: 40 | """ 41 | localdir = os.path.dirname(__file__) 42 | config = os.path.join(localdir, 'config.yaml') 43 | if not sys.version_info > (3, 6): 44 | cls.runner = subprocess.Popen(('nameko', 'run', '--config', config, 'services'), cwd=localdir) 45 | time.sleep(1) 46 | 47 | @classmethod 48 | def tearDownClass(cls): 49 | if not sys.version_info > (3, 6): 50 | cls.runner.kill() 51 | 52 | def test_echo_no_rpc(self): 53 | assert EchoService().echo(42) == (42,) 54 | 55 | @override_settings(NAMEKO_CONFIG={ 56 | 'AMQP_URI': 'amqp://guest:badpassword@localhost' 57 | }) 58 | def test_pool_call_bad_rabbitmq_cred(self): 59 | with tools.assert_raises(AccessRefused): 60 | pool = get_pool() 61 | with pool.next() as client: 62 | client.echo.echo(42) 63 | 64 | destroy_pool() 65 | 66 | @unittest.skip("for some reason this test is broken and make tox hang forerver") 67 | @override_settings(NAMEKO_CONFIG={ 68 | 'AMQP_URI': 'amqp://guest:guest@localhost', 69 | 'TIMEOUT': 1 70 | }) 71 | def test_pool_call_unknown_service(self): 72 | with tools.assert_raises(UnknownService): 73 | pool = get_pool() 74 | with pool.next() as client: 75 | client.unknown_service.echo(42) 76 | 77 | destroy_pool() 78 | 79 | @unittest.skipIf(sys.version_info > (3, 6), "currently eventlet is broken on python 3.7+") 80 | @override_settings(NAMEKO_CONFIG=config) 81 | def test_pool_call_method_notdefined(self): 82 | with tools.assert_raises(MethodNotFound): 83 | pool = get_pool() 84 | with pool.next() as client: 85 | client.echo.unknown_method() 86 | 87 | destroy_pool() 88 | 89 | @unittest.skipIf(sys.version_info > (3, 6), "currently eventlet is broken on python 3.7+") 90 | @override_settings(NAMEKO_CONFIG={ 91 | 'AMQP_URI': 'amqp://guest:guest@localhost:6666' 92 | }) 93 | def test_pool_call_no_rabbitmq_server(self): 94 | with tools.assert_raises(socket.error): 95 | pool = get_pool() 96 | with pool.next() as client: 97 | client.echo.echo(42) 98 | 99 | destroy_pool() 100 | 101 | @unittest.skipIf(sys.version_info > (3, 6), "currently eventlet is broken on python 3.7+") 102 | @override_settings(NAMEKO_CONFIG=config) 103 | def test_pool_call_existing_service(self): 104 | pool = get_pool() 105 | with pool.next() as client: 106 | assert client.echo.echo(42) == [42] 107 | 108 | # try to call RPC out of with statement 109 | tools.assert_raises(AttributeError, lambda: client.echo.echo(42)) 110 | # try again inside with statement 111 | with pool.next() as client: 112 | assert client.echo.echo(42) == [42] 113 | 114 | destroy_pool() 115 | 116 | @unittest.skipIf(sys.version_info > (3, 6), "currently eventlet is broken on python 3.7+") 117 | @override_settings(NAMEKO_CONFIG=config) 118 | def test_pool_destroy_and_recreate(self): 119 | pool = get_pool() 120 | with pool.next() as client: 121 | assert client.echo.echo(42) == [42] 122 | 123 | destroy_pool() 124 | pool = get_pool() 125 | with pool.next() as client: 126 | assert client.echo.echo(42) == [42] 127 | 128 | destroy_pool() 129 | 130 | @unittest.skipIf(sys.version_info > (3, 6), "currently eventlet is broken on python 3.7+") 131 | @override_settings(NAMEKO_CONFIG=config, NAMEKO_CONTEXT_DATA={"data": 123}) 132 | def test_error_clear_context(self): 133 | pool = get_pool() 134 | with tools.assert_raises(Exception): 135 | with pool.next() as client: 136 | client.service.method() 137 | raise Exception("oops") 138 | 139 | destroy_pool() 140 | 141 | @unittest.skipIf(sys.version_info > (3, 6), "currently eventlet is broken on python 3.7+") 142 | @override_settings(NAMEKO_CONFIG=config) 143 | def test_pool_dispatch_event_existing_service(self): 144 | # create a tempfile 145 | f = tempfile.NamedTemporaryFile(delete=False) 146 | payload = dict(path=f.name) 147 | f.close() 148 | assert os.path.exists(f.name) is True 149 | # dispatch the event with path of the temp file included in the payload 150 | dispatch("echo", 'touch', payload) 151 | time.sleep(1) # wait for 1 second 152 | # check file has been removed by the listener service 153 | assert os.path.exists(f.name) is False 154 | 155 | @unittest.skipIf(sys.version_info > (3, 6), "currently eventlet is broken on python 3.7+") 156 | @override_settings(NAMEKO_CONFIG=config) 157 | def test_pool_dispatch_event_multi_service(self): 158 | # create a tempfile 159 | f = tempfile.NamedTemporaryFile(delete=False) 160 | payload = dict(path=f.name) 161 | f.close() 162 | assert os.path.exists(f.name) is True 163 | # dispatch the event with path of the temp file included in the payload 164 | dispatch("echo", 'clone', payload) 165 | time.sleep(2) # wait for 2 second 166 | # check file has been cloned by the listener services (2 services) 167 | assert os.path.exists(f.name + '.copy') is True 168 | assert os.path.exists(f.name + '.link') is True 169 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | # Tox (http://codespeak.net/~hpk/tox/) is a tool for running tests 2 | # in multiple virtualenvs. This configuration file will run the 3 | # test suite on all supported python versions. To use it, "pip install tox" 4 | # and then run "tox" from this directory. 5 | [flake8] 6 | max-line-length=119 7 | exclude = .tox,testsettings*,docs/,bin/,include/,lib/,.git/,*/migrations/*,build/ 8 | 9 | 10 | 11 | [tox] 12 | minversion=1.8.0 13 | envlist = 14 | 15 | py{27}-django{111}-nameko{211,212} 16 | py{35}-django{111,20,21,22}-nameko{211,212} 17 | py{36,37}-django{111,20,21,22}-nameko{211,212,213} 18 | isort 19 | flake8 20 | 21 | toxworkdir = {toxinidir}/.tox 22 | 23 | [testenv] 24 | commands = 25 | coverage run --source=django_nameko setup.py test 26 | coverage report -m 27 | deps = 28 | coverage 29 | django111: django >=1.11a1,<1.12 30 | django20: django >=2.0a1,<2.1 31 | django21: django >=2.1a1,<2.2 32 | django22: django >=2.2a1,<2.3 33 | nameko211: nameko >=2.11,<2.12 34 | nameko212: nameko >=2.12,<2.13 35 | nameko213: nameko >=2.13,<2.14 36 | 37 | 38 | [testenv:package] 39 | 40 | deps = twine 41 | commands = 42 | python setup.py sdist 43 | twine check dist/* 44 | 45 | [testenv:flake8] 46 | basepython = python3 47 | usedevelop = false 48 | deps = flake8 49 | changedir = {toxinidir} 50 | commands = flake8 django_nameko 51 | 52 | 53 | [testenv:isort] 54 | basepython = python3 55 | usedevelop = false 56 | deps = isort 57 | changedir = {toxinidir} 58 | commands = isort --recursive --check-only --diff django_nameko 59 | --------------------------------------------------------------------------------