Browse Source

Initial commit

changes/82/394182/1
Monty Taylor 2 years ago
commit
1a69bfa39d
No account linked to committer's email address

+ 7
- 0
.coveragerc View File

@@ -0,0 +1,7 @@
1
+[run]
2
+branch = True
3
+source = oaktree
4
+omit = oaktree/openstack/*
5
+
6
+[report]
7
+ignore_errors = True

+ 57
- 0
.gitignore View File

@@ -0,0 +1,57 @@
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
+
56
+# Protobuf Generated Files
57
+oaktree/rpc/*_pb2.py

+ 4
- 0
.gitreview View File

@@ -0,0 +1,4 @@
1
+[gerrit]
2
+host=review.openstack.org
3
+port=29418
4
+project=openstack/oaktree.git

+ 3
- 0
.mailmap View File

@@ -0,0 +1,3 @@
1
+# Format is:
2
+# <preferred e-mail> <other e-mail 1>
3
+# <preferred e-mail> <other e-mail 2>

+ 7
- 0
.testr.conf View File

@@ -0,0 +1,7 @@
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

+ 17
- 0
CONTRIBUTING.rst View File

@@ -0,0 +1,17 @@
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/oaktree

+ 4
- 0
HACKING.rst View File

@@ -0,0 +1,4 @@
1
+oaktree Style Commandments
2
+===============================================
3
+
4
+Read the OpenStack Style Commandments http://docs.openstack.org/developer/hacking/

+ 176
- 0
LICENSE View File

@@ -0,0 +1,176 @@
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
+

+ 6
- 0
MANIFEST.in View File

@@ -0,0 +1,6 @@
1
+include AUTHORS
2
+include ChangeLog
3
+exclude .gitignore
4
+exclude .gitreview
5
+
6
+global-exclude *.pyc

+ 64
- 0
README.rst View File

@@ -0,0 +1,64 @@
1
+=======
2
+oaktree
3
+=======
4
+
5
+Make your cloud throw some shade
6
+
7
+oaktree is a gRPC interface for interacting with OpenStack clouds that is
8
+inherently interoperable and multi-cloud aware. It is based on the python
9
+shade library, which grew all of the logic needed to interact with OpenStack
10
+clouds and to work around differences in vendor deployment choices. Rather
11
+than keep all of that love in Python Library form, oaktree allows othre
12
+languages to reap the benefits as well.
13
+
14
+oaktree is not a replacement for all of the individual project REST APIs.
15
+Those are all essential for cross-project communication and are well suited
16
+for operators who can be expected to know things about how they have
17
+deployed their clouds - and who in fact WANT to be able to make changes in
18
+the cloud knowing deployment specifics. oaktree will never be for them.
19
+
20
+oaktree is for end-users who do not and should not know what hypervisor, what
21
+storage driver or what network stack the deployer has chosen. The two sets
22
+of people are different audiences, so oaktree is a project to support the
23
+end user.
24
+
25
+Using
26
+-----
27
+
28
+Install oaktreemodel by hand. Then:
29
+
30
+In one window:
31
+
32
+.. code-block:: bash
33
+
34
+  python oaktree/server.py
35
+
36
+oaktree/server.py assumes you have a clouds.yaml accessible.
37
+
38
+In another window:
39
+
40
+.. code-block:: bash
41
+
42
+  python -i devstack/test.py
43
+
44
+You'll have an images and a flavors object you can poke at.
45
+
46
+If you want to operate against a different cloud than `devstack`, you can
47
+pass it to devstack/test.py as the first command line argument.
48
+
49
+Shape of the Project
50
+--------------------
51
+
52
+oaktree should be super simple to deploy, and completely safe for deployers
53
+to upgrade from master constantly. Once it's released as a 1.0, it should
54
+NEVER EVER EVER EVER EVER EVER EVER have a backwards incompatible change.
55
+There is no reason, no justification, no obessession important enough to
56
+inflict such pain on the user.
57
+
58
+The shade library will grow the ability to detect if a cloud has an oaktree
59
+api available, and if it does, it will use it. Hopefully we'll quickly reach
60
+a point where all deployers are deploying oaktree.
61
+
62
+* Documentation: http://docs.openstack.org/developer/oaktree
63
+* Source: http://git.openstack.org/cgit/openstack/oaktree
64
+* Bugs: http://bugs.launchpad.net/oaktree

+ 1
- 0
TODO View File

@@ -0,0 +1 @@
1
+normalize convert_*s to convert_items

+ 120
- 0
devstack/plugin.sh View File

@@ -0,0 +1,120 @@
1
+#!/bin/bash
2
+#
3
+# Copyright 2016 Red Hat, Inc.
4
+#
5
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
6
+# not use this file except in compliance with the License. You may obtain
7
+# a copy of the License at
8
+#
9
+#    http://www.apache.org/licenses/LICENSE-2.0
10
+#
11
+# Unless required by applicable law or agreed to in writing, software
12
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14
+# License for the specific language governing permissions and limitations
15
+# under the License.
16
+
17
+# Install shade from git if requested. If not requested
18
+# oaktree install will pull it in.
19
+function install_shade {
20
+    if use_library_from_git "shade"; then
21
+        GITREPO["shade"]=$SHADE_REPO_URL
22
+        GITDIR["shade"]=$DEST/shade
23
+        GITBRANCH["shade"]=$SHADE_REPO_REF
24
+        git_clone_by_name "shade"
25
+        # Install shade globally, because the job config has LIBS_FROM_GIT
26
+        # and if we don't install it globally, all hell breaks loose
27
+        setup_dev_lib "shade"
28
+    fi
29
+}
30
+
31
+function install_oaktreemodel {
32
+    if use_library_from_git "oaktreemodel"; then
33
+        GITREPO["oaktreemodel"]=$OAKTREEMODEL_REPO_URL
34
+        GITDIR["oaktreemodel"]=$DEST/oaktreemodel
35
+        GITBRANCH["oaktreemodel"]=$OAKTREEMODEL_REPO_REF
36
+        git_clone_by_name "oaktreemodel"
37
+        pushd $DEST/oaktreemodel
38
+        /usr/local/jenkins/slave_scripts/install-distro-packages.sh
39
+        export GOPATH=$DEST/gopath
40
+        mkdir $GOPATH
41
+        export PATH=$GOPATH/bin:$PATH
42
+        go get -u github.com/golang/protobuf/protoc-gen-go
43
+        ./bootstrap.sh
44
+        ./configure
45
+        make
46
+        sudo make install
47
+        sudo pip install -e .
48
+        popd
49
+    fi
50
+}
51
+
52
+# Install oaktree code
53
+function install_oaktree {
54
+    if use_library_from_git "oaktree"; then
55
+        GITREPO["oaktree"]=$OAKTREE_REPO_URL
56
+        GITDIR["oaktree"]=$DEST/shade
57
+        GITBRANCH["oaktree"]=$OAKTREE_REPO_REF
58
+        git_clone_by_name "oaktree"
59
+        setup_dev_lib "oaktree"
60
+    fi
61
+}
62
+
63
+function configure_oaktree {
64
+    :
65
+}
66
+
67
+function start_oaktree {
68
+
69
+    if is_service_enabled statsd; then
70
+        # run a fake statsd so we test stats sending paths
71
+        export STATSD_HOST=localhost
72
+        export STATSD_PORT=8125
73
+        run_process statsd "socat -u udp-recv:$STATSD_PORT -"
74
+    fi
75
+
76
+    run_process oaktree "python -m oaktree.server"
77
+    :
78
+}
79
+
80
+function shutdown_oaktree {
81
+    stop_process oaktree
82
+    :
83
+}
84
+
85
+function cleanup_oaktree {
86
+    :
87
+}
88
+
89
+# check for service enabled
90
+if is_service_enabled oaktree; then
91
+
92
+    if [[ "$1" == "stack" && "$2" == "install" ]]; then
93
+        # Perform installation of service source
94
+        echo_summary "Installing oaktree"
95
+        install_oaktree
96
+
97
+    elif [[ "$1" == "stack" && "$2" == "post-config" ]]; then
98
+        # Configure after the other layer 1 and 2 services have been configured
99
+        echo_summary "Configuring oaktree"
100
+        configure_oaktree
101
+
102
+    elif [[ "$1" == "stack" && "$2" == "extra" ]]; then
103
+        # Initialize and start the oaktree service
104
+        echo_summary "Initializing oaktree"
105
+        start_oaktree
106
+    fi
107
+
108
+    if [[ "$1" == "unstack" ]]; then
109
+        # Shut down oaktree services
110
+        # no-op
111
+        shutdown_oaktree
112
+    fi
113
+
114
+    if [[ "$1" == "clean" ]]; then
115
+        # Remove state and transient data
116
+        # Remember clean.sh first calls unstack.sh
117
+        # no-op
118
+        cleanup_oaktree
119
+    fi
120
+fi

+ 11
- 0
devstack/settings View File

@@ -0,0 +1,11 @@
1
+SHADE_REPO_URL=${SHADE_REPO_URL:-https://git.openstack.org/openstack-infra/shade}
2
+SHADE_REPO_REF=${SHADE_REPO_REF:-master}
3
+
4
+OAKTREE_REPO_URL=${OAKTREE_REPO_URL:-https://git.openstack.org/openstack/oaktree}
5
+OAKTREE_REPO_REF=${OAKTREE_REPO_REF:-master}
6
+
7
+OAKTREEMODEL_REPO_URL=${OAKTREEMODEL_REPO_URL:-https://git.openstack.org/openstack/oaktreemodel}
8
+OAKTREEMODEL_REPO_REF=${OAKTREEMODEL_REPO_REF:-master}
9
+
10
+enable_service statsd
11
+enable_service oaktree

+ 21
- 0
devstack/test.py View File

@@ -0,0 +1,21 @@
1
+# flake8: noqa
2
+import sys
3
+
4
+import grpc
5
+
6
+from oaktreemodel import model
7
+from oaktreemodel import oaktree_pb2
8
+
9
+channel = grpc.insecure_channel('localhost:50051')
10
+stub = oaktree_pb2.OaktreeStub(channel)
11
+
12
+cloud = model.Location()
13
+if len(sys.argv) > 1:
14
+    cloud.cloud = sys.argv[1]
15
+else:
16
+    cloud.cloud = 'devstack'
17
+
18
+flavors = stub.SearchFlavors(model.Filter(location=cloud))
19
+print flavors
20
+images = stub.SearchImages(model.Filter(location=cloud))
21
+print images

+ 75
- 0
doc/source/conf.py View File

@@ -0,0 +1,75 @@
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'oaktree'
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}

+ 4
- 0
doc/source/contributing.rst View File

@@ -0,0 +1,4 @@
1
+============
2
+Contributing
3
+============
4
+.. include:: ../../CONTRIBUTING.rst

+ 25
- 0
doc/source/index.rst View File

@@ -0,0 +1,25 @@
1
+.. oaktree 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 oaktree'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
+

+ 12
- 0
doc/source/installation.rst View File

@@ -0,0 +1,12 @@
1
+============
2
+Installation
3
+============
4
+
5
+At the command line::
6
+
7
+    $ pip install oaktree
8
+
9
+Or, if you have virtualenvwrapper installed::
10
+
11
+    $ mkvirtualenv oaktree
12
+    $ pip install oaktree

+ 1
- 0
doc/source/readme.rst View File

@@ -0,0 +1 @@
1
+.. include:: ../../README.rst

+ 7
- 0
doc/source/usage.rst View File

@@ -0,0 +1,7 @@
1
+========
2
+Usage
3
+========
4
+
5
+To use oaktree in a project::
6
+
7
+    import oaktree

+ 0
- 0
oaktree/__init__.py View File


+ 51
- 0
oaktree/_clouds.py View File

@@ -0,0 +1,51 @@
1
+# Copyright (c) 2016 Red Hat, Inc.
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
+import shade
17
+
18
+all_clouds = {}
19
+
20
+
21
+def _make_cloud_key(cloud, region, domain, project):
22
+    return "{cloud}:{region}:{domain}:{project}".format(
23
+        cloud=cloud, region=region, domain=domain, project=project)
24
+
25
+
26
+def _get_cloud(cloud, region, project=None):
27
+    if project:
28
+        domain_id = project.domain_id
29
+        domain_name = project.domain_name
30
+        project_id = project.id
31
+        project_name = project.name
32
+        kwargs = dict(
33
+            project_domain_id=domain_id,
34
+            project_domain_name=domain_name,
35
+            project_id=project_id,
36
+            project_name=project_name,
37
+        )
38
+    else:
39
+        domain_id = domain_name = project_id = project_name = None
40
+        kwargs = {}
41
+
42
+    key = _make_cloud_key(
43
+        cloud, region,
44
+        domain_id or domain_name,
45
+        project_id or project_name
46
+    )
47
+    if key not in all_clouds:
48
+        all_clouds[key] = shade.openstack_cloud(
49
+            cloud=cloud, region_name=region,
50
+            debug=True, strict=True, **kwargs)
51
+    return all_clouds[key]

+ 251
- 0
oaktree/server.py View File

@@ -0,0 +1,251 @@
1
+# Copyright (c) 2016 Red Hat, Inc.
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
+import shade
17
+
18
+from concurrent import futures
19
+import logging
20
+import time
21
+
22
+from google.protobuf.descriptor import FieldDescriptor
23
+import grpc
24
+
25
+from oaktree import _clouds
26
+from oaktreemodel import model
27
+from oaktreemodel import oaktree_pb2
28
+
29
+# Skipping bytes for now
30
+_BOOL_TYPES = (FieldDescriptor.TYPE_BOOL,)
31
+_ENUM_TYPES = (FieldDescriptor.TYPE_ENUM, )
32
+_STR_TYPES = (FieldDescriptor.TYPE_STRING, )
33
+_INT_TYPES = (
34
+    FieldDescriptor.TYPE_FIXED32, FieldDescriptor.TYPE_FIXED64,
35
+    FieldDescriptor.TYPE_SFIXED32, FieldDescriptor.TYPE_SFIXED64,
36
+    FieldDescriptor.TYPE_INT32, FieldDescriptor.TYPE_INT64,
37
+    FieldDescriptor.TYPE_SINT32, FieldDescriptor.TYPE_SINT64,
38
+    FieldDescriptor.TYPE_UINT32, FieldDescriptor.TYPE_UINT64,
39
+)
40
+_FLOAT_TYPES = (
41
+    FieldDescriptor.TYPE_DOUBLE, FieldDescriptor.TYPE_FLOAT,
42
+)
43
+_FIELDS_TO_STRIP = ('request_ids', 'HUMAN_ID', 'NAME_ATTR', 'human_id')
44
+_ONE_DAY_IN_SECONDS = 60 * 60 * 24
45
+
46
+
47
+def _get_cloud(request):
48
+    return _clouds._get_cloud(
49
+        cloud=request.location.cloud,
50
+        region=request.location.region,
51
+        project=request.location.project)
52
+
53
+
54
+def convert_for_field(value, field):
55
+    if value is None:
56
+        return value
57
+    if field.type in _BOOL_TYPES:
58
+        return bool(value)
59
+    elif field.type in _STR_TYPES:
60
+        return str(value)
61
+    elif field.type in _INT_TYPES:
62
+        if value == '':
63
+            return 0
64
+        return int(value)
65
+    elif field.type in _FLOAT_TYPES:
66
+        return float(value)
67
+    elif field.type in _ENUM_TYPES:
68
+        return field.enum_type.values_by_name[value].number
69
+
70
+
71
+def convert_munch_to_pb(munch, pb):
72
+    for key, value in munch.properties.items():
73
+        pb.properties[key] = str(value)
74
+    munch.pop('properties')
75
+    for key, field in pb.DESCRIPTOR.fields_by_name.items():
76
+        if field.label == field.LABEL_REPEATED:
77
+            for value in munch.pop(key, []):
78
+                converted = convert_for_field(value, field)
79
+                pb.key.append(converted)
80
+        else:
81
+            value = convert_for_field(munch.pop(key, None), field)
82
+            if value:
83
+                setattr(pb, key, value)
84
+    to_strip = set()
85
+    for key, value in munch.items():
86
+        if key in _FIELDS_TO_STRIP:
87
+            to_strip.add(key)
88
+        # TODO(mordred) this will not work for neutron, but it's fine til then
89
+        if ':' in key:
90
+            to_strip.add(key)
91
+    for key in to_strip:
92
+        munch.pop(key)
93
+
94
+
95
+def convert_flavor(flavor):
96
+    flavor_pb = model.Flavor()
97
+    convert_munch_to_pb(flavor, flavor_pb)
98
+    for key, value in flavor.extra_specs.items():
99
+        flavor_pb.properties.setdefault(key, str(value))
100
+    return flavor_pb
101
+
102
+
103
+def convert_flavors(flavors):
104
+    flavor_list = model.FlavorList()
105
+    for flavor in flavors:
106
+        # Why does this require a list extend? That seems silly enough that
107
+        # I feel like I'm doing something wrong
108
+        flavor_list.flavors.extend([convert_flavor(flavor)])
109
+    return flavor_list
110
+
111
+
112
+def convert_image(image):
113
+    image_pb = model.Image()
114
+    tags = image.pop('tags', [])
115
+    for tag in tags:
116
+        image_pb.tags.append(str(tag))
117
+    convert_munch_to_pb(image, image_pb)
118
+    return image_pb
119
+
120
+
121
+def convert_images(images):
122
+    image_list = model.ImageList()
123
+    for image in images:
124
+        # Why does this require a list extend? That seems silly enough that
125
+        # I feel like I'm doing something wrong
126
+        image_list.images.extend([convert_image(image)])
127
+    return image_list
128
+
129
+
130
+def convert_security_groups(security_groups):
131
+    security_group_list = model.SecurityGroupList()
132
+    for security_group in security_groups:
133
+        security_group_list.extend([convert_security_group(security_group)])
134
+    return security_group_list
135
+
136
+
137
+def convert_security_group(security_group):
138
+    secgroup_pb = model.SecurityGroup()
139
+    rules = security_group.pop('security_group_rules', [])
140
+    convert_munch_to_pb(security_group, secgroup_pb)
141
+    for rule in rules:
142
+        secgroup_pb.rules.append(convert_security_group_rule(rule))
143
+
144
+
145
+def convert_security_group_rules(security_group_rules):
146
+    return _convert_dicts(
147
+        security_group_rules,
148
+        model.SecurityGroupRuleList,
149
+        convert_security_group_rule,
150
+        'rules')
151
+
152
+
153
+def _convert_dicts(dicts, list_class, convert_function, attrname):
154
+    pb_list = list_class()
155
+    items = []
156
+    for item in dicts:
157
+        items.append(convert_function(item))
158
+    getattr(pb_list, attrname).extend(items)
159
+    return pb_list
160
+
161
+
162
+def convert_security_group_rule(security_group_rule):
163
+    secgroup_rule_pb = model.SecurityGroupRule()
164
+    convert_munch_to_pb(security_group_rule, secgroup_rule_pb)
165
+    return secgroup_rule_pb
166
+
167
+
168
+class OaktreeServicer(oaktree_pb2.OaktreeServicer):
169
+
170
+    def GetFlavor(self, request, context):
171
+        logging.info('getting flavor')
172
+        cloud = _get_cloud(request)
173
+        return convert_flavor(
174
+            cloud.get_flavor(
175
+                name_or_id=request.name_or_id,
176
+                filters=request.jmespath))
177
+
178
+    def SearchFlavors(self, request, context):
179
+        logging.info('searching flavors')
180
+        cloud = _get_cloud(request)
181
+        return convert_flavors(
182
+            cloud.search_flavors(
183
+                name_or_id=request.name_or_id,
184
+                filters=request.jmespath))
185
+
186
+    def GetImage(self, request, context):
187
+        logging.info('getting image')
188
+        cloud = _get_cloud(request)
189
+        return convert_image(
190
+            cloud.get_image(
191
+                name_or_id=request.name_or_id,
192
+                filters=request.jmespath))
193
+
194
+    def SearchImages(self, request, context):
195
+        logging.info('searching images')
196
+        cloud = _get_cloud(request)
197
+        return convert_images(
198
+            cloud.search_images(
199
+                name_or_id=request.name_or_id,
200
+                filters=request.jmespath))
201
+
202
+    def GetSecurityGroup(self, request, context):
203
+        logging.info('getting security group')
204
+        cloud = _get_cloud(request)
205
+        return convert_security_group(
206
+            cloud.get_security_group(
207
+                name_or_id=request.name_or_id,
208
+                filters=request.jmespath))
209
+
210
+    def SearchSecurityGroups(self, request, context):
211
+        logging.info('searching security groups')
212
+        cloud = _get_cloud(request)
213
+        return convert_security_groups(
214
+            cloud.search_security_groups(
215
+                name_or_id=request.name_or_id,
216
+                filters=request.jmespath))
217
+
218
+    def GetSecurityGroupRule(self, request, context):
219
+        logging.info('getting security group rule')
220
+        cloud = _get_cloud(request)
221
+        return convert_security_group_rule(
222
+            cloud.get_security_group_rule(
223
+                name_or_id=request.name_or_id,
224
+                filters=request.jmespath))
225
+
226
+    def SearchSecurityGroupRules(self, request, context):
227
+        logging.info('searching security group rules')
228
+        cloud = _get_cloud(request)
229
+        return convert_security_group_rules(
230
+            cloud.search_security_group_rules(
231
+                name_or_id=request.name_or_id,
232
+                filters=request.jmespath))
233
+
234
+
235
+def serve():
236
+    shade.simple_logging(debug=True)
237
+    logging.getLogger().setLevel(logging.INFO)
238
+    server = grpc.server(futures.ThreadPoolExecutor(max_workers=10))
239
+    oaktree_pb2.add_OaktreeServicer_to_server(OaktreeServicer(), server)
240
+    server.add_insecure_port('[::]:50051')
241
+    logging.info("Starting server")
242
+    server.start()
243
+    try:
244
+        while True:
245
+            time.sleep(_ONE_DAY_IN_SECONDS)
246
+    except KeyboardInterrupt:
247
+        server.stop(0)
248
+
249
+
250
+if __name__ == '__main__':
251
+    serve()

+ 0
- 0
oaktree/tests/__init__.py View File


+ 23
- 0
oaktree/tests/base.py View File

@@ -0,0 +1,23 @@
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
+from oslotest import base
19
+
20
+
21
+class TestCase(base.BaseTestCase):
22
+
23
+    """Test case base class for all unit tests."""

+ 28
- 0
oaktree/tests/test_shadeapi.py View File

@@ -0,0 +1,28 @@
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_oaktree
17
+----------------------------------
18
+
19
+Tests for `oaktree` module.
20
+"""
21
+
22
+from oaktree.tests import base
23
+
24
+
25
+class TestShadeapi(base.TestCase):
26
+
27
+    def test_something(self):
28
+        pass

+ 8
- 0
requirements.txt View File

@@ -0,0 +1,8 @@
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>=1.6
6
+oaktreemodel
7
+shade>=1.12.0
8
+grpc

+ 32
- 0
setup.cfg View File

@@ -0,0 +1,32 @@
1
+[metadata]
2
+name = oaktree
3
+summary = Sane User-oriented API 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
+    oaktree
25
+
26
+[build_sphinx]
27
+source-dir = doc/source
28
+build-dir = doc/build
29
+all_files = 1
30
+
31
+[upload_sphinx]
32
+upload-dir = doc/build/html

+ 29
- 0
setup.py View File

@@ -0,0 +1,29 @@
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)

+ 15
- 0
test-requirements.txt View File

@@ -0,0 +1,15 @@
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
+python-subunit>=0.0.18
10
+sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2
11
+oslosphinx>=2.5.0 # Apache-2.0
12
+oslotest>=1.10.0 # Apache-2.0
13
+testrepository>=0.0.18
14
+testscenarios>=0.4
15
+testtools>=1.4.0

+ 35
- 0
tox.ini View File

@@ -0,0 +1,35 @@
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,*lib/python*,*egg,build,*_pb2.py

Loading…
Cancel
Save