├── .coveragerc ├── .gitignore ├── .gitreview ├── .mailmap ├── .testr.conf ├── CONTRIBUTING.rst ├── HACKING.rst ├── LICENSE ├── MANIFEST.in ├── README.rst ├── babel.cfg ├── doc └── source │ ├── conf.py │ ├── contributing.rst │ ├── index.rst │ ├── installation.rst │ ├── readme.rst │ └── usage.rst ├── openstack-common.conf ├── os_http ├── __init__.py ├── shell.py ├── tests │ ├── __init__.py │ ├── base.py │ └── test_os_http.py └── version.py ├── requirements.txt ├── setup.cfg ├── setup.py ├── test-requirements.txt └── tox.ini /.coveragerc: -------------------------------------------------------------------------------- 1 | [run] 2 | branch = True 3 | source = os_http 4 | omit = os_http/openstack/* 5 | 6 | [report] 7 | ignore_errors = True 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.py[cod] 2 | 3 | # C extensions 4 | *.so 5 | 6 | # Packages 7 | *.egg 8 | *.egg-info 9 | dist 10 | build 11 | .eggs 12 | eggs 13 | parts 14 | bin 15 | var 16 | sdist 17 | develop-eggs 18 | .installed.cfg 19 | lib 20 | lib64 21 | 22 | # Installer logs 23 | pip-log.txt 24 | 25 | # Unit test / coverage reports 26 | .coverage 27 | .tox 28 | nosetests.xml 29 | .testrepository 30 | .venv 31 | 32 | # Translations 33 | *.mo 34 | 35 | # Mr Developer 36 | .mr.developer.cfg 37 | .project 38 | .pydevproject 39 | 40 | # Complexity 41 | output/*.html 42 | output/*/index.html 43 | 44 | # Sphinx 45 | doc/build 46 | 47 | # pbr generates these 48 | AUTHORS 49 | ChangeLog 50 | 51 | # Editors 52 | *~ 53 | .*.swp 54 | .*sw? 55 | -------------------------------------------------------------------------------- /.gitreview: -------------------------------------------------------------------------------- 1 | [gerrit] 2 | host=review.opendev.org 3 | port=29418 4 | project=openstack-dev/os-http.git 5 | -------------------------------------------------------------------------------- /.mailmap: -------------------------------------------------------------------------------- 1 | # Format is: 2 | # 3 | # 4 | -------------------------------------------------------------------------------- /.testr.conf: -------------------------------------------------------------------------------- 1 | [DEFAULT] 2 | test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \ 3 | OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \ 4 | OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \ 5 | ${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION 6 | test_id_option=--load-list $IDFILE 7 | test_list_option=--list 8 | -------------------------------------------------------------------------------- /CONTRIBUTING.rst: -------------------------------------------------------------------------------- 1 | If you would like to contribute to the development of OpenStack, you must 2 | follow the steps in this page: 3 | 4 | http://docs.openstack.org/infra/manual/developers.html 5 | 6 | If you already have a good understanding of how the system works and your 7 | OpenStack accounts are set up, you can skip to the development workflow 8 | section of this documentation to learn how changes to OpenStack should be 9 | submitted for review via the Gerrit tool: 10 | 11 | http://docs.openstack.org/infra/manual/developers.html#development-workflow 12 | 13 | Pull requests submitted through GitHub will be ignored. 14 | 15 | Bugs should be filed on Launchpad, not GitHub: 16 | 17 | https://bugs.launchpad.net/os-http 18 | -------------------------------------------------------------------------------- /HACKING.rst: -------------------------------------------------------------------------------- 1 | os-http Style Commandments 2 | =============================================== 3 | 4 | Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/ 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include AUTHORS 2 | include ChangeLog 3 | exclude .gitignore 4 | exclude .gitreview 5 | 6 | global-exclude *.pyc 7 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | =============================== 2 | os-http 3 | =============================== 4 | 5 | Simple HTTP CLI for OpenStack 6 | 7 | A common problem I have in development is needing to make a request against an 8 | authenticated request against an OpenStack API "correctly" (using the catalog, 9 | real authentication, version discovery etc). 10 | 11 | os-http is a httpie_ inspired wrapper around basic keystoneauth_ functionality 12 | that can make and display the response to HTTP requests against openstack 13 | services. 14 | 15 | * Free software: Apache license 16 | * Source: https://git.openstack.org/cgit/openstack-dev/os-http 17 | 18 | .. _httpie: http://httpie.org/ 19 | .. _keystoneauth: https://git.openstack.org/cgit/openstack/keystoneauth 20 | 21 | Usage 22 | ----- 23 | 24 | .. code-block:: bash 25 | 26 | source accrc # load your cloud authentication 27 | os-http --os-service-type image \ 28 | --os-api-version 2 \ 29 | --os-interface public \ 30 | --os-region RegionTwo \ 31 | get /images 32 | -------------------------------------------------------------------------------- /babel.cfg: -------------------------------------------------------------------------------- 1 | [python: **.py] 2 | 3 | -------------------------------------------------------------------------------- /doc/source/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # Licensed under the Apache License, Version 2.0 (the "License"); 3 | # you may not use this file except in compliance with the License. 4 | # You may obtain a copy of the License at 5 | # 6 | # http://www.apache.org/licenses/LICENSE-2.0 7 | # 8 | # Unless required by applicable law or agreed to in writing, software 9 | # distributed under the License is distributed on an "AS IS" BASIS, 10 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 11 | # implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | import os 16 | import sys 17 | 18 | sys.path.insert(0, os.path.abspath('../..')) 19 | # -- General configuration ---------------------------------------------------- 20 | 21 | # Add any Sphinx extension module names here, as strings. They can be 22 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 23 | extensions = [ 24 | 'sphinx.ext.autodoc', 25 | #'sphinx.ext.intersphinx', 26 | 'oslosphinx' 27 | ] 28 | 29 | # autodoc generation is a bit aggressive and a nuisance when doing heavy 30 | # text edit cycles. 31 | # execute "export SPHINX_DEBUG=1" in your terminal to disable 32 | 33 | # The suffix of source filenames. 34 | source_suffix = '.rst' 35 | 36 | # The master toctree document. 37 | master_doc = 'index' 38 | 39 | # General information about the project. 40 | project = u'os-http' 41 | copyright = u'2013, OpenStack Foundation' 42 | 43 | # If true, '()' will be appended to :func: etc. cross-reference text. 44 | add_function_parentheses = True 45 | 46 | # If true, the current module name will be prepended to all description 47 | # unit titles (such as .. function::). 48 | add_module_names = True 49 | 50 | # The name of the Pygments (syntax highlighting) style to use. 51 | pygments_style = 'sphinx' 52 | 53 | # -- Options for HTML output -------------------------------------------------- 54 | 55 | # The theme to use for HTML and HTML Help pages. Major themes that come with 56 | # Sphinx are currently 'default' and 'sphinxdoc'. 57 | # html_theme_path = ["."] 58 | # html_theme = '_theme' 59 | # html_static_path = ['static'] 60 | 61 | # Output file base name for HTML help builder. 62 | htmlhelp_basename = '%sdoc' % project 63 | 64 | # Grouping the document tree into LaTeX files. List of tuples 65 | # (source start file, target name, title, author, documentclass 66 | # [howto/manual]). 67 | latex_documents = [ 68 | ('index', 69 | '%s.tex' % project, 70 | u'%s Documentation' % project, 71 | u'OpenStack Foundation', 'manual'), 72 | ] 73 | 74 | # Example configuration for intersphinx: refer to the Python standard library. 75 | #intersphinx_mapping = {'http://docs.python.org/': None} 76 | -------------------------------------------------------------------------------- /doc/source/contributing.rst: -------------------------------------------------------------------------------- 1 | ============ 2 | Contributing 3 | ============ 4 | .. include:: ../../CONTRIBUTING.rst 5 | -------------------------------------------------------------------------------- /doc/source/index.rst: -------------------------------------------------------------------------------- 1 | .. os-http documentation master file, created by 2 | sphinx-quickstart on Tue Jul 9 22:26:36 2013. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | Welcome to os-http's documentation! 7 | ======================================================== 8 | 9 | Contents: 10 | 11 | .. toctree:: 12 | :maxdepth: 2 13 | 14 | readme 15 | installation 16 | usage 17 | contributing 18 | 19 | Indices and tables 20 | ================== 21 | 22 | * :ref:`genindex` 23 | * :ref:`modindex` 24 | * :ref:`search` 25 | 26 | -------------------------------------------------------------------------------- /doc/source/installation.rst: -------------------------------------------------------------------------------- 1 | ============ 2 | Installation 3 | ============ 4 | 5 | At the command line:: 6 | 7 | $ pip install os-http 8 | 9 | Or, if you have virtualenvwrapper installed:: 10 | 11 | $ mkvirtualenv os-http 12 | $ pip install os-http 13 | -------------------------------------------------------------------------------- /doc/source/readme.rst: -------------------------------------------------------------------------------- 1 | .. include:: ../../README.rst 2 | -------------------------------------------------------------------------------- /doc/source/usage.rst: -------------------------------------------------------------------------------- 1 | ======== 2 | Usage 3 | ======== 4 | 5 | To use os-http in a project:: 6 | 7 | import os_http 8 | -------------------------------------------------------------------------------- /openstack-common.conf: -------------------------------------------------------------------------------- 1 | [DEFAULT] 2 | 3 | # The list of modules to copy from oslo-incubator.git 4 | 5 | # The base module to hold the copy of openstack.common 6 | base=os_http 7 | -------------------------------------------------------------------------------- /os_http/__init__.py: -------------------------------------------------------------------------------- 1 | # Licensed under the Apache License, Version 2.0 (the "License"); you may 2 | # not use this file except in compliance with the License. You may obtain 3 | # a copy of the License at 4 | # 5 | # http://www.apache.org/licenses/LICENSE-2.0 6 | # 7 | # Unless required by applicable law or agreed to in writing, software 8 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 9 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 10 | # License for the specific language governing permissions and limitations 11 | # under the License. 12 | 13 | from os_http import version 14 | 15 | 16 | __version__ = version.version_string 17 | -------------------------------------------------------------------------------- /os_http/shell.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # Licensed under the Apache License, Version 2.0 (the "License"); you may 4 | # not use this file except in compliance with the License. You may obtain 5 | # a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 | # License for the specific language governing permissions and limitations 13 | # under the License. 14 | 15 | from __future__ import print_function 16 | 17 | import argparse 18 | import json 19 | import logging 20 | import sys 21 | 22 | try: 23 | import pygments 24 | import pygments.formatters 25 | import pygments.lexers 26 | import pygments.util 27 | except ImportError: 28 | pygments = None 29 | 30 | from keystoneauth1 import exceptions 31 | from keystoneauth1 import session 32 | import os_client_config 33 | 34 | from os_http import version 35 | 36 | LOG = logging.getLogger(__name__) 37 | 38 | _occ_version = os_client_config.__version__ 39 | 40 | formatter_name = 'console' if sys.stdout.isatty() else 'text' 41 | 42 | 43 | class ErrorExit(Exception): 44 | 45 | def __init__(self, message, exit_code=1): 46 | self.message = message 47 | self.exit_code = exit_code 48 | 49 | 50 | def format_resp(resp): 51 | # I can see no way to get the HTTP version 52 | headers = ["HTTP/1.1 %d %s" % (resp.status_code, resp.reason or '')] 53 | headers.extend('%s: %s' % k for k in resp.headers.items()) 54 | headers = '\n'.join(headers) 55 | 56 | if 'json' in resp.headers.get('Content-Type', '').lower(): 57 | body = json.dumps(resp.json(), sort_keys=True, indent=4) 58 | else: 59 | body = resp.content 60 | 61 | if pygments: 62 | mime = resp.headers.get('Content-Type') 63 | http_lexer = pygments.lexers.get_lexer_by_name('http') 64 | formatter = pygments.formatters.get_formatter_by_name(formatter_name) 65 | 66 | try: 67 | body_lexer = pygments.lexers.get_lexer_for_mimetype(mime) 68 | except pygments.util.ClassNotFound: 69 | body_lexer = pygments.lexers.get_lexer_by_name('text') 70 | 71 | headers = pygments.highlight(headers, http_lexer, formatter) 72 | body = pygments.highlight(body, body_lexer, formatter) 73 | 74 | return '\n'.join([headers, '', body]) 75 | 76 | 77 | def run(argv): 78 | parser = argparse.ArgumentParser( 79 | description='Simple HTTP testing for Openstack') 80 | 81 | parser.add_argument('--debug', 82 | action='store_true', 83 | help='Enable debug output') 84 | 85 | config = os_client_config.OpenStackConfig() 86 | config.register_argparse_arguments(parser, argv) 87 | 88 | positional = parser.add_argument_group('Positional Arguments') 89 | positional.add_argument('method', 90 | metavar='METHOD', 91 | help='The HTTP method to make the request with') 92 | positional.add_argument('url', 93 | metavar='URL', 94 | help='The URL or path to request') 95 | positional.add_argument('items', 96 | metavar='ITEM', 97 | nargs='*', 98 | help='Additional items') 99 | 100 | opts = parser.parse_args(argv) 101 | 102 | if opts.debug: 103 | logging.basicConfig(level=logging.DEBUG) 104 | else: 105 | logging.basicConfig(level=logging.WARN) 106 | 107 | cloud = config.get_one_cloud(argparse=opts) 108 | 109 | adap = cloud.get_session_client(None) 110 | 111 | # FIXME(jamielennox): These things should be handled by os-client-config 112 | adap.logger = LOG 113 | adap.user_agent = 'os-http/%s os-client-config/%s %s' % ( 114 | version.version_string, 115 | _occ_version, 116 | session.DEFAULT_USER_AGENT) 117 | adap.version = opts.os_api_version 118 | 119 | headers = {'Accept': 'application/json'} 120 | 121 | for item in opts.items: 122 | if ':' in item: 123 | key, val = item.split(':', 1) 124 | headers[key] = val 125 | else: 126 | raise ErrorExit("Unknown item: %s" % item) 127 | 128 | try: 129 | resp = adap.request(opts.url, 130 | opts.method.upper(), 131 | headers=headers, 132 | raise_exc=False) 133 | 134 | except exceptions.EmptyCatalog: 135 | message = ("Failed to find an endpoint because the returned service " 136 | "catalog is empty.") 137 | 138 | try: 139 | get_access = adap.session.auth.get_access 140 | except AttributeError: 141 | # not an identity plugin - see if it specifies project_id 142 | scoped = bool(adap.get_project_id()) 143 | else: 144 | scoped = get_access(adap.session).scoped 145 | 146 | if not scoped: 147 | message += (" This seems to be because the credentials provided " 148 | "result in an unscoped token. Please check your " 149 | "authentication credentials.") 150 | 151 | raise ErrorExit(message) 152 | 153 | except exceptions.EndpointNotFound: 154 | service_params = ('service_type', 155 | 'service_name', 156 | 'interface', 157 | 'region_name', 158 | 'version') 159 | 160 | query = ", ".join("%s=%s" % (p, getattr(adap, p)) 161 | for p in service_params if getattr(adap, p)) 162 | raise ErrorExit("Failed to find an endpoint in the service catalog " 163 | "that matches your query: %s" % query) 164 | 165 | return format_resp(resp) 166 | 167 | 168 | def main(argv=sys.argv[1:]): 169 | try: 170 | output = run(argv) 171 | except ErrorExit as e: 172 | LOG.error(e.message) 173 | sys.exit(e.exit_code) 174 | else: 175 | print(output) 176 | -------------------------------------------------------------------------------- /os_http/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/openstack-dev/os-http/13f264e6ac47fa5dc56c5c6d9a3f345fe985a294/os_http/tests/__init__.py -------------------------------------------------------------------------------- /os_http/tests/base.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # Copyright 2010-2011 OpenStack Foundation 4 | # Copyright (c) 2013 Hewlett-Packard Development Company, L.P. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); you may 7 | # not use this file except in compliance with the License. You may obtain 8 | # a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 14 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 15 | # License for the specific language governing permissions and limitations 16 | # under the License. 17 | 18 | import fixtures 19 | from oslotest import base 20 | from requests_mock.contrib import fixture 21 | 22 | 23 | class TestCase(base.BaseTestCase): 24 | 25 | def setUp(self): 26 | super(TestCase, self).setUp() 27 | self.requests_mock = self.useFixture(fixture.Fixture()) 28 | self.logger_mock = self.useFixture(fixtures.FakeLogger()) 29 | -------------------------------------------------------------------------------- /os_http/tests/test_os_http.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | 3 | # Licensed under the Apache License, Version 2.0 (the "License"); you may 4 | # not use this file except in compliance with the License. You may obtain 5 | # a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 11 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 12 | # License for the specific language governing permissions and limitations 13 | # under the License. 14 | 15 | """ 16 | test_os_http 17 | ---------------------------------- 18 | 19 | Tests for `os_http` module. 20 | """ 21 | 22 | import re 23 | import uuid 24 | 25 | import fixtures 26 | from keystoneauth1 import fixture 27 | from testtools import matchers 28 | 29 | from os_http import shell 30 | from os_http.tests import base 31 | 32 | AUTH_URL = 'http://openstack.example.com:5000' 33 | 34 | PUBLIC_SERVICE_URL = 'http://public.example.com:9292' 35 | ADMIN_SERVICE_URL = 'http://admin.example.com:9292' 36 | INTERNAL_SERVICE_URL = 'http://internal.example.com:9292' 37 | SERVICE_REGION = uuid.uuid4().hex 38 | 39 | 40 | class TestInputs(base.TestCase): 41 | 42 | def setUp(self): 43 | super(TestInputs, self).setUp() 44 | 45 | disc = fixture.DiscoveryList(href=AUTH_URL, v2=False) 46 | 47 | self.service_type = uuid.uuid4().hex 48 | self.service_id = uuid.uuid4().hex 49 | self.service_name = uuid.uuid4().hex 50 | 51 | self.user_id = uuid.uuid4().hex 52 | self.username = uuid.uuid4().hex 53 | self.project_id = uuid.uuid4().hex 54 | self.project_name = uuid.uuid4().hex 55 | 56 | self.token = fixture.V3Token(user_id=self.user_id, 57 | user_name=self.username, 58 | project_id=self.project_id, 59 | project_name=self.project_name) 60 | 61 | self.token.add_role() 62 | self.token.add_role() 63 | self.token_id = uuid.uuid4().hex 64 | 65 | service = self.token.add_service(self.service_type, 66 | id=self.service_id, 67 | name=self.service_name) 68 | 69 | service.add_standard_endpoints(public=PUBLIC_SERVICE_URL, 70 | admin=ADMIN_SERVICE_URL, 71 | internal=INTERNAL_SERVICE_URL, 72 | region=SERVICE_REGION) 73 | 74 | self.requests_mock.get(AUTH_URL, json=disc, status_code=300) 75 | self.auth_mock = self.requests_mock.post( 76 | AUTH_URL + '/v3/auth/tokens', 77 | json=self.token, 78 | headers={'X-Subject-Token': self.token_id}) 79 | 80 | # don't do any console formatting markup 81 | m = fixtures.MockPatchObject(shell, 'formatter_name', 'text') 82 | self.useFixture(m) 83 | 84 | def shell(self, *args, **kwargs): 85 | for k, v in kwargs.items(): 86 | args.append('--os-%s' % k.replace('_', '-')) 87 | args.append(v) 88 | 89 | return shell.run(args) 90 | 91 | def test_simple_get(self): 92 | path = '/%s' % uuid.uuid4().hex 93 | public_url = '%s%s' % (PUBLIC_SERVICE_URL, path) 94 | 95 | json_a = uuid.uuid4().hex 96 | json_b = uuid.uuid4().hex 97 | 98 | service_mock = self.requests_mock.get( 99 | public_url, 100 | json={json_a: json_b}, 101 | status_code=200, 102 | reason='OK', 103 | headers={'Content-Type': 'application/json'}) 104 | 105 | resp = self.shell('get', path, 106 | '--os-service-type', self.service_type, 107 | '--os-auth-type', 'password', 108 | '--os-auth-url', AUTH_URL, 109 | '--os-project-id', self.project_id, 110 | '--os-user-id', self.user_id) 111 | 112 | self.assertEqual('GET', self.requests_mock.last_request.method) 113 | self.assertEqual(public_url, self.requests_mock.last_request.url) 114 | 115 | self.assertTrue(service_mock.called) 116 | 117 | self.assertThat(resp, matchers.StartsWith('HTTP/1.1 200 OK')) 118 | self.assertIn('Content-Type: application/json', resp) 119 | 120 | r = '.*{\s*"%s":\s*"%s"\s*}$' % (json_a, json_b) 121 | self.assertThat(resp, matchers.MatchesRegex(r, re.M | re.S)) 122 | 123 | def test_endpoint_not_found(self): 124 | path = '/%s' % uuid.uuid4().hex 125 | 126 | e = self.assertRaises(shell.ErrorExit, 127 | self.shell, 128 | 'get', path, 129 | '--os-service-type', uuid.uuid4().hex, 130 | '--os-auth-type', 'password', 131 | '--os-auth-url', AUTH_URL, 132 | '--os-project-id', self.project_id, 133 | '--os-user-id', self.user_id) 134 | self.assertIn('Failed to find an endpoint in the service ', e.message) 135 | 136 | def test_headers(self): 137 | path = '/%s' % uuid.uuid4().hex 138 | public_url = '%s%s' % (PUBLIC_SERVICE_URL, path) 139 | 140 | self.requests_mock.get(public_url) 141 | 142 | header_key = uuid.uuid4().hex 143 | header_val = uuid.uuid4().hex 144 | 145 | self.shell('get', path, 146 | '%s:%s' % (header_key, header_val), 147 | '--os-service-type', self.service_type, 148 | '--os-auth-type', 'password', 149 | '--os-auth-url', AUTH_URL, 150 | '--os-project-id', self.project_id, 151 | '--os-user-id', self.user_id) 152 | 153 | self.assertEqual('GET', self.requests_mock.last_request.method) 154 | self.assertEqual(public_url, self.requests_mock.last_request.url) 155 | self.assertEqual(header_val, 156 | self.requests_mock.last_request.headers[header_key]) 157 | -------------------------------------------------------------------------------- /os_http/version.py: -------------------------------------------------------------------------------- 1 | # Licensed under the Apache License, Version 2.0 (the "License"); you may 2 | # not use this file except in compliance with the License. You may obtain 3 | # a copy of the License at 4 | # 5 | # http://www.apache.org/licenses/LICENSE-2.0 6 | # 7 | # Unless required by applicable law or agreed to in writing, software 8 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 9 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 10 | # License for the specific language governing permissions and limitations 11 | # under the License. 12 | 13 | import pbr.version 14 | 15 | 16 | version_string = pbr.version.VersionInfo('os_http').version_string() 17 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | # The order of packages is significant, because pip processes them in the order 2 | # of appearance. Changing the order has an impact on the overall integration 3 | # process, which may cause wedges in the gate later. 4 | 5 | pbr<2.0,>=1.4 6 | Babel>=1.3 7 | 8 | keystoneauth1 9 | os-client-config 10 | pygments 11 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | name = os-http 3 | summary = Simple HTTP CLI for OpenStack 4 | description-file = 5 | README.rst 6 | author = OpenStack 7 | author-email = openstack-dev@lists.openstack.org 8 | home-page = http://www.openstack.org/ 9 | classifier = 10 | Environment :: OpenStack 11 | Intended Audience :: Information Technology 12 | Intended Audience :: System Administrators 13 | License :: OSI Approved :: Apache Software License 14 | Operating System :: POSIX :: Linux 15 | Programming Language :: Python 16 | Programming Language :: Python :: 2 17 | Programming Language :: Python :: 2.7 18 | Programming Language :: Python :: 3 19 | Programming Language :: Python :: 3.3 20 | Programming Language :: Python :: 3.4 21 | 22 | [files] 23 | packages = 24 | os_http 25 | 26 | [entry_points] 27 | console_scripts = 28 | os-http = os_http.shell:main 29 | 30 | [build_sphinx] 31 | source-dir = doc/source 32 | build-dir = doc/build 33 | all_files = 1 34 | 35 | [upload_sphinx] 36 | upload-dir = doc/build/html 37 | 38 | [compile_catalog] 39 | directory = os_http/locale 40 | domain = os-http 41 | 42 | [update_catalog] 43 | domain = os-http 44 | output_dir = os_http/locale 45 | input_file = os_http/locale/os-http.pot 46 | 47 | [extract_messages] 48 | keywords = _ gettext ngettext l_ lazy_gettext 49 | mapping_file = babel.cfg 50 | output_file = os_http/locale/os-http.pot 51 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) 2013 Hewlett-Packard Development Company, L.P. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 12 | # implied. 13 | # See the License for the specific language governing permissions and 14 | # limitations under the License. 15 | 16 | # THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT 17 | import setuptools 18 | 19 | # In python < 2.7.4, a lazy loading of package `pbr` will break 20 | # setuptools if some other modules registered functions in `atexit`. 21 | # solution from: http://bugs.python.org/issue15881#msg170215 22 | try: 23 | import multiprocessing # noqa 24 | except ImportError: 25 | pass 26 | 27 | setuptools.setup( 28 | setup_requires=['pbr'], 29 | pbr=True) 30 | -------------------------------------------------------------------------------- /test-requirements.txt: -------------------------------------------------------------------------------- 1 | # The order of packages is significant, because pip processes them in the order 2 | # of appearance. Changing the order has an impact on the overall integration 3 | # process, which may cause wedges in the gate later. 4 | 5 | hacking<0.11,>=0.10.0 6 | 7 | coverage>=3.6 8 | discover 9 | fixtures>=3.0.0 # Apache-2.0/BSD 10 | python-subunit>=0.0.18 11 | sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 12 | oslosphinx>=2.5.0 # Apache-2.0 13 | oslotest>=1.10.0 # Apache-2.0 14 | requests-mock>=0.7.0 # Apache-2.0 15 | testrepository>=0.0.18 16 | testscenarios>=0.4 17 | testtools>=1.4.0 18 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | minversion = 1.6 3 | envlist = py34,py27,pypy,pep8 4 | skipsdist = True 5 | 6 | [testenv] 7 | usedevelop = True 8 | install_command = pip install -U {opts} {packages} 9 | setenv = 10 | VIRTUAL_ENV={envdir} 11 | deps = -r{toxinidir}/test-requirements.txt 12 | commands = python setup.py test --slowest --testr-args='{posargs}' 13 | 14 | [testenv:pep8] 15 | commands = flake8 16 | 17 | [testenv:venv] 18 | commands = {posargs} 19 | 20 | [testenv:cover] 21 | commands = python setup.py test --coverage --testr-args='{posargs}' 22 | 23 | [testenv:docs] 24 | commands = python setup.py build_sphinx 25 | 26 | [testenv:debug] 27 | commands = oslo_debug_helper {posargs} 28 | 29 | [flake8] 30 | # E123, E125 skipped as they are invalid PEP-8. 31 | 32 | show-source = True 33 | ignore = E123,E125 34 | builtins = _ 35 | exclude=.venv,.git,.tox,dist,doc,*openstack/common*,*lib/python*,*egg,build 36 | --------------------------------------------------------------------------------