Initial commit

.coveragerc

@@ -0,0 +1,6 @@
+[run]
+branch = True
+source = sushy
+
+[report]
+ignore_errors = True

.gitignore

@@ -0,0 +1,58 @@
+*.py[cod]
+
+# C extensions
+*.so
+
+# Packages
+*.egg*
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+cover/
+.coverage*
+!.coveragerc
+.tox
+nosetests.xml
+.testrepository
+.venv
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# Complexity
+output/*.html
+output/*/index.html
+
+# Sphinx
+doc/build
+
+# pbr generates these
+AUTHORS
+ChangeLog
+
+# Editors
+*~
+.*.swp
+.*sw?
+
+# Files created by releasenotes build
+releasenotes/build

.gitreview

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

.mailmap

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

.testr.conf

@@ -0,0 +1,7 @@
+[DEFAULT]
+test_command=OS_STDOUT_CAPTURE=${OS_STDOUT_CAPTURE:-1} \
+             OS_STDERR_CAPTURE=${OS_STDERR_CAPTURE:-1} \
+             OS_TEST_TIMEOUT=${OS_TEST_TIMEOUT:-60} \
+             ${PYTHON:-python} -m subunit.run discover -t ./ . $LISTOPT $IDOPTION
+test_id_option=--load-list $IDFILE
+test_list_option=--list

CONTRIBUTING.rst

@@ -0,0 +1,17 @@
+If you would like to contribute to the development of OpenStack, you must
+follow the steps in this page:
+
+   http://docs.openstack.org/infra/manual/developers.html
+
+If you already have a good understanding of how the system works and your
+OpenStack accounts are set up, you can skip to the development workflow
+section of this documentation to learn how changes to OpenStack should be
+submitted for review via the Gerrit tool:
+
+   http://docs.openstack.org/infra/manual/developers.html#development-workflow
+
+Pull requests submitted through GitHub will be ignored.
+
+Bugs should be filed on Launchpad, not GitHub:
+
+   https://bugs.launchpad.net/sushy

HACKING.rst

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

LICENSE

@@ -0,0 +1,176 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+

MANIFEST.in

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

README.rst

@@ -0,0 +1,39 @@
+=====
+Sushy
+=====
+
+Sushy is a Python library to communicate with `Redfish`_ based systems.
+
+The goal of the library is to be extremely simple, small, have as few
+dependencies as possible and be very conservative when dealing with BMCs
+by issuing just enough requests to it (BMCs are very flaky).
+
+Therefore, the scope of the library has been limited to what is supported
+by the `OpenStack Ironic <https://wiki.openstack.org/wiki/Ironic>`_
+project. As the project grows and more features from `Redfish`_ are
+needed we can expand Sushy to fullfil those requirements.
+
+* Free software: Apache license
+* Documentation: https://readthedocs.org/projects/sushy
+* Source: http://git.openstack.org/cgit/openstack/sushy
+* Bugs: http://bugs.launchpad.net/sushy
+
+Features
+--------
+
+* Abstraction around the SystemCollection and System resources (Basic
+  server identification and asset information)
+* Systems power management (Both soft and hard; Including NMI injection)
+* Changing systems boot device, frequency (Once or permanently) and mode
+  (UEFI or BIOS)
+
+Check out the :ref:`usage` page.
+
+TODO
+----
+
+* Collect sensor data (Health state, temperature, fans etc...)
+* System inspection (Number of CPUs, memory and disk size)
+* Serial console
+
+.. _Redfish: http://www.dmtf.org/standards/redfish

babel.cfg

@@ -0,0 +1,2 @@
+[python: **.py]
+

doc/source/conf.py

@@ -0,0 +1,75 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('../..'))
+# -- General configuration ----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    #'sphinx.ext.intersphinx',
+    'oslosphinx'
+]
+
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
+# text edit cycles.
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'sushy'
+copyright = u'2016, OpenStack Foundation'
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+add_module_names = True
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# -- Options for HTML output --------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+# html_theme_path = ["."]
+# html_theme = '_theme'
+# html_static_path = ['static']
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = '%sdoc' % project
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass
+# [howto/manual]).
+latex_documents = [
+    ('index',
+     '%s.tex' % project,
+     u'%s Documentation' % project,
+     u'OpenStack Foundation', 'manual'),
+]
+
+# Example configuration for intersphinx: refer to the Python standard library.
+#intersphinx_mapping = {'http://docs.python.org/': None}

doc/source/contributing.rst

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

doc/source/index.rst

@@ -0,0 +1,25 @@
+.. sushy documentation master file, created by
+   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Sushy's documentation!
+=================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   readme
+   installation
+   usage
+   contributing
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

doc/source/installation.rst

@@ -0,0 +1,12 @@
+============
+Installation
+============
+
+At the command line::
+
+    $ pip install sushy
+
+Or, if you have virtualenvwrapper installed::
+
+    $ mkvirtualenv sushy
+    $ pip install sushy

doc/source/readme.rst

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

doc/source/usage.rst

@@ -0,0 +1,70 @@
+..  _usage:
+
+=====
+Usage
+=====
+
+To use sushy in a project:
+
+.. code-block:: python
+
+  import sushy
+
+  s = sushy.Sushy('http://127.0.0.1:8000/redfish/v1',
+                  username='foo', password='bar')
+
+  # Get the Redfish version
+  print(s.redfish_version)
+
+  # Instantiate a system object
+  sys_inst = s.get_system('437XR1138R2')
+
+
+  # Using system collections
+
+
+  # Instantiate a SystemCollection object
+  sys_col = s.get_system_collection()
+
+  # Print the ID of the systems available in the collection
+  print(sys_col.members_identities)
+
+  # Get a list of systems objects available in the collection
+  sys_col_insts = sys_col.get_members()
+
+  # Instantiate a system object, same as getting it directly
+  # from the s.get_system()
+  sys_inst = sys_col.get_member(sys_col.members_identities[0])
+
+  # Refresh the system collection object
+  sys_col.refresh()
+
+
+  # Using system actions
+
+
+  # Power the system ON
+  sys_inst.reset_system(sushy.RESET_ON)
+
+  # Get a list of allowed reset values
+  print(sys_inst.get_allowed_reset_system_values())
+
+  # Refresh the system object
+  sys_inst.refresh()
+
+  # Get the current power state
+  print(sys_inst.power_state)
+
+  # Set the next boot device to boot once from PXE in UEFI mode
+  sys_inst.set_system_boot_source(sushy.BOOT_SOURCE_TARGET_PXE,
+                                  enabled=sushy.BOOT_SOURCE_ENABLED_ONCE,
+                                  mode=sushy.BOOT_SOURCE_MODE_UEFI)
+
+  # Get the current boot source information
+  print(sys_inst.boot)
+
+  # Get a list of allowed boot source target values
+  print(sys_inst.get_allowed_system_boot_source_values())
+
+.. TODO: Get current boot source device, enabled and mode
+.. TODO: Document how to setup the Redfish mockup server

releasenotes/source/conf.py

@@ -0,0 +1,275 @@
+# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Glance Release Notes documentation build configuration file, created by
+# sphinx-quickstart on Tue Nov  3 17:40:50 2015.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+# sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'oslosphinx',
+    'reno.sphinxext',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+# source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'sushy Release Notes'
+copyright = u'2016, OpenStack Foundation'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+# The full version, including alpha/beta/rc tags.
+release = ''
+# The short X.Y version.
+version = ''
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+# language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+# today = ''
+# Else, today_fmt is used as the format for a strftime call.
+# today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all
+# documents.
+# default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+# add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+# add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+# show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+# modindex_common_prefix = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+# keep_warnings = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+# html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+# html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+# html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+# html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+# html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+# html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Add any extra paths that contain custom files (such as robots.txt or
+# .htaccess) here, relative to this directory. These files are copied
+# directly to the root of the documentation.
+# html_extra_path = []
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+# html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+# html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+# html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# html_additional_pages = {}
+
+# If false, no module index is generated.
+# html_domain_indices = True
+
+# If false, no index is generated.
+# html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+# html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+# html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+# html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+# html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+# html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+# html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'GlanceReleaseNotesdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    ('index', 'GlanceReleaseNotes.tex', u'Glance Release Notes Documentation',
+     u'Glance Developers', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+# latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+# latex_use_parts = False
+
+# If true, show page references after internal links.
+# latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+# latex_domain_indices = True
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'glancereleasenotes', u'Glance Release Notes Documentation',
+     [u'Glance Developers'], 1)
+]
+
+# If true, show URL addresses after external links.
+# man_show_urls = False
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    ('index', 'GlanceReleaseNotes', u'Glance Release Notes Documentation',
+     u'Glance Developers', 'GlanceReleaseNotes',
+     'One line description of project.',
+     'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+# texinfo_appendices = []
+
+# If false, no module index is generated.
+# texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+# texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+# texinfo_no_detailmenu = False
+
+# -- Options for Internationalization output ------------------------------
+locale_dirs = ['locale/']

releasenotes/source/index.rst

@@ -0,0 +1,8 @@
+============================================
+ sushy Release Notes
+============================================
+
+.. toctree::
+   :maxdepth: 1
+
+   unreleased

releasenotes/source/unreleased.rst

@@ -0,0 +1,5 @@
+==============================
+ Current Series Release Notes
+==============================
+
+.. release-notes::

requirements.txt

@@ -0,0 +1,7 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+
+pbr>=1.8 # Apache-2.0
+requests>=2.10.0,!=2.12.2 # Apache-2.0
+six>=1.9.0 # MIT

setup.cfg

@@ -0,0 +1,50 @@
+[metadata]
+name = sushy
+summary = Sushy is a small Python library to communicate with Redfish based systems
+description-file =
+    README.rst
+author = OpenStack
+author-email = openstack-dev@lists.openstack.org
+home-page = http://www.openstack.org/
+classifier =
+    Environment :: OpenStack
+    Intended Audience :: Information Technology
+    Intended Audience :: System Administrators
+    License :: OSI Approved :: Apache Software License
+    Operating System :: POSIX :: Linux
+    Programming Language :: Python
+    Programming Language :: Python :: 2
+    Programming Language :: Python :: 2.7
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.5
+
+[files]
+packages =
+    sushy
+
+[build_sphinx]
+source-dir = doc/source
+build-dir = doc/build
+all_files = 1
+
+[upload_sphinx]
+upload-dir = doc/build/html
+
+[compile_catalog]
+directory = sushy/locale
+domain = sushy
+
+[update_catalog]
+domain = sushy
+output_dir = sushy/locale
+input_file = sushy/locale/sushy.pot
+
+[extract_messages]
+keywords = _ gettext ngettext l_ lazy_gettext
+mapping_file = babel.cfg
+output_file = sushy/locale/sushy.pot
+
+[build_releasenotes]
+all_files = 1
+build-dir = releasenotes/build
+source-dir = releasenotes/source

setup.py

@@ -0,0 +1,29 @@
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
+import setuptools
+
+# In python < 2.7.4, a lazy loading of package `pbr` will break
+# setuptools if some other modules registered functions in `atexit`.
+# solution from: http://bugs.python.org/issue15881#msg170215
+try:
+    import multiprocessing  # noqa
+except ImportError:
+    pass
+
+setuptools.setup(
+    setup_requires=['pbr>=1.8'],
+    pbr=True)

sushy/__init__.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+import pbr.version
+
+from sushy.main import Sushy
+from sushy.resources.system.constants import *  # noqa
+
+__all__ = ('Sushy',)
+__version__ = pbr.version.VersionInfo(
+    'sushy').version_string()

sushy/connector.py

@@ -0,0 +1,55 @@
+# Copyright 2017 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import json
+import os
+
+import requests
+
+
+class Connector(object):
+
+    def __init__(self, url, username=None, password=None, verify=True):
+        self._url = url
+        self._auth = (username, password)
+        self._verify = verify
+
+    def _op(self, method, path='', data=None, headers=None):
+        if headers is None:
+            headers = {}
+
+        headers['Content-Type'] = 'application/json'
+
+        with requests.Session() as session:
+            session.headers = headers
+            session.verify = self._verify
+
+            if all(self._auth):
+                session.auth = self._auth
+
+            if data is not None:
+                data = json.dumps(data)
+
+            url = os.path.join(self._url, path)
+            return session.request(method, url, data=data)
+
+    def get(self, path='', data=None, headers=None):
+        return self._op('GET', path, data, headers)
+
+    def post(self, path='', data=None, headers=None):
+        return self._op('POST', path, data, headers)
+
+    def patch(self, path='', data=None, headers=None):
+        return self._op('PATCH', path, data, headers)

sushy/exceptions.py

@@ -0,0 +1,43 @@
+# Copyright 2017 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+
+class SushyError(Exception):
+    message = None
+
+    def __init__(self, message=None, **kwargs):
+        if self.message and kwargs:
+            self.message = self.message % kwargs
+        else:
+            self.message = message
+
+        super(SushyError, self).__init__(self.message)
+
+
+class ResourceNotFoundError(SushyError):
+    message = 'Resource %(resource)s not found'
+
+
+class MissingAttributeError(SushyError):
+    message = 'The attribute %(attribute)s is missing in %(resource)s'
+
+
+class MissingActionError(SushyError):
+    message = 'The action %(action)s is missing in %(resource)s'
+
+
+class InvalidParameterValueError(SushyError):
+    message = ('The parameter "%(parameter)s" value "%(value)s" is invalid. '
+               'Valid values are: %(valid_values)s')

sushy/main.py

@@ -0,0 +1,60 @@
+# Copyright 2017 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+from sushy import connector
+from sushy.resources import base
+from sushy.resources.system import system
+
+
+class Sushy(base.ResourceBase):
+
+    identity = None
+    """The Redfish system identity"""
+
+    name = None
+    """The Redfish system name"""
+
+    redfish_version = None
+    """The Redfish system version"""
+
+    uuid = None
+    """The Redfish system UUID"""
+
+    def __init__(self, url, username=None, password=None, verify=False):
+        super(Sushy, self).__init__(
+            connector.Connector(url, username, password, verify))
+
+    def _parse_attributes(self):
+        self.identity = self.json.get('Id')
+        self.name = self.json.get('Name')
+        self.redfish_version = self.json.get('RedfishVersion')
+        self.uuid = self.json.get('UUID')
+
+    def get_system_collection(self):
+        """Get the SystemCollection object
+
+        :returns: a SystemCollection object
+        """
+        return system.SystemCollection(self._conn,
+                                       redfish_version=self.redfish_version)
+
+    def get_system(self, identity):
+        """Given the identity return a System object
+
+        :param identity: The identity of the System resource
+        :returns: The System object
+        """
+        return system.System(self._conn, identity,
+                             redfish_version=self.redfish_version)

sushy/resources/base.py

@@ -0,0 +1,55 @@
+# Copyright 2017 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import abc
+
+import six
+from six.moves import http_client
+
+from sushy import exceptions
+
+
+@six.add_metaclass(abc.ABCMeta)
+class ResourceBase(object):
+
+    def __init__(self, connector, path=''):
+        self._conn = connector
+        self._path = path
+        self._json = None
+        self.refresh()
+
+    def refresh(self):
+        resp = self._conn.get(path=self._path)
+        if resp.status_code == http_client.NOT_FOUND:
+            raise exceptions.ResourceNotFoundError(resource=self._path)
+
+        self._json = resp.json()
+        self._parse_attributes()
+
+    @property
+    def json(self):
+        return self._json
+
+    @property
+    def path(self):
+        return self._path
+
+    @abc.abstractmethod
+    def _parse_attributes(self):
+        """Parse the attributes of a resource
+
+        This method should be overwritten and is responsible for parsing
+        all the attributes of a resource.
+        """

sushy/resources/system/constants.py

@@ -0,0 +1,98 @@
+# Copyright 2017 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+# Values comes from the Redfish System json-schema 1.0.0:
+# http://redfish.dmtf.org/schemas/v1/ComputerSystem.v1_0_0.json#/definitions/ComputerSystem  # noqa
+
+# Reset action constants
+
+RESET_ON = 'on'
+RESET_FORCE_OFF = 'force off'
+RESET_GRACEFUL_SHUTDOWN = 'graceful shutdown'
+RESET_GRACEFUL_RESTART = 'graceful restart'
+RESET_FORCE_RESTART = 'force restart'
+RESET_NMI = 'nmi'
+RESET_FORCE_ON = 'force on'
+RESET_PUSH_POWER_BUTTON = 'push power button'
+
+# System' PowerState constants
+
+SYSTEM_POWER_STATE_ON = 'on'
+"""The system is powered on"""
+
+SYSTEM_POWER_STATE_OFF = 'off'
+"""The system is powered off, although some components may continue to
+   have AUX power such as management controller"""
+
+SYSTEM_POWER_STATE_POWERING_ON = 'powering on'
+"""A temporary state between Off and On. This temporary state can
+   be very short"""
+
+SYSTEM_POWER_STATE_POWERING_OFF = 'powering off'
+"""A temporary state between On and Off. The power off action can take
+   time while the OS is in the shutdown process"""
+
+# Boot source target constants
+
+BOOT_SOURCE_TARGET_NONE = 'none'
+"""Boot from the normal boot device"""
+
+BOOT_SOURCE_TARGET_PXE = 'pxe'
+"""Boot from the Pre-Boot EXecution (PXE) environment"""
+
+BOOT_SOURCE_TARGET_FLOPPY = 'floppy'
+"""Boot from the floppy disk drive"""
+
+BOOT_SOURCE_TARGET_CD = 'cd'
+"""Boot from the CD/DVD disc"""
+
+BOOT_SOURCE_TARGET_USB = 'usb'
+"""Boot from a USB device as specified by the system BIOS"""
+
+BOOT_SOURCE_TARGET_HDD = 'hdd'
+"""Boot from a hard drive"""
+
+BOOT_SOURCE_TARGET_BIOS_SETUP = 'bios setup'
+"""Boot to the BIOS Setup Utility"""
+
+BOOT_SOURCE_TARGET_UTILITIES = 'utilities'
+"""Boot the manufacturer's Utilities program(s)"""
+
+BOOT_SOURCE_TARGET_DIAGS = 'diags'
+"""Boot the manufacturer's Diagnostics program"""
+
+BOOT_SOURCE_TARGET_SD_CARD = 'sd card'
+"""Boot from an SD Card"""
+
+BOOT_SOURCE_TARGET_UEFI_TARGET = 'uefi target'
+"""Boot to the UEFI Device specified in the
+   UefiTargetBootSourceOverride property"""
+
+BOOT_SOURCE_TARGET_UEFI_SHELL = 'uefi shell'
+"""Boot to the UEFI Shell"""
+
+BOOT_SOURCE_TARGET_UEFI_HTTP = 'uefi http'
+"""Boot from a UEFI HTTP network location"""
+
+# Boot source mode constants
+
+BOOT_SOURCE_MODE_BIOS = 'bios'
+BOOT_SOURCE_MODE_UEFI = 'uefi'
+
+# Boot source enabled constants
+
+BOOT_SOURCE_ENABLED_ONCE = 'once'
+BOOT_SOURCE_ENABLED_CONTINUOUS = 'continuous'
+BOOT_SOURCE_ENABLED_DISABLED = 'disabled'

sushy/resources/system/mappings.py

@@ -0,0 +1,73 @@
+# Copyright 2017 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+from sushy.resources.system import constants as sys_cons
+from sushy import utils
+
+
+RESET_SYSTEM_VALUE_MAP = {
+    'On': sys_cons.RESET_ON,
+    'ForceOff': sys_cons.RESET_FORCE_OFF,
+    'GracefulShutdown': sys_cons.RESET_GRACEFUL_SHUTDOWN,
+    'GracefulRestart': sys_cons.RESET_GRACEFUL_RESTART,
+    'ForceRestart': sys_cons.RESET_FORCE_RESTART,
+    'Nmi': sys_cons.RESET_NMI,
+    'ForceOn': sys_cons.RESET_FORCE_ON,
+    'PushPowerButton': sys_cons.RESET_PUSH_POWER_BUTTON,
+}
+
+RESET_SYSTEM_VALUE_MAP_REV = utils.revert_dictionary(RESET_SYSTEM_VALUE_MAP)
+
+SYSTEM_POWER_STATE_MAP = {
+    'On': sys_cons.SYSTEM_POWER_STATE_ON,
+    'Off': sys_cons.SYSTEM_POWER_STATE_OFF,
+    'PoweringOn': sys_cons.SYSTEM_POWER_STATE_POWERING_ON,
+    'PoweringOff': sys_cons.SYSTEM_POWER_STATE_POWERING_OFF,
+}
+
+SYSTEM_POWER_STATE_MAP_REV = utils.revert_dictionary(SYSTEM_POWER_STATE_MAP)
+
+BOOT_SOURCE_TARGET_MAP = {
+    'None': sys_cons.BOOT_SOURCE_TARGET_NONE,
+    'Pxe': sys_cons.BOOT_SOURCE_TARGET_PXE,
+    'Floppy': sys_cons.BOOT_SOURCE_TARGET_FLOPPY,
+    'Cd': sys_cons.BOOT_SOURCE_TARGET_CD,
+    'Usb': sys_cons.BOOT_SOURCE_TARGET_USB,
+    'Hdd': sys_cons.BOOT_SOURCE_TARGET_HDD,
+    'BiosSetup': sys_cons.BOOT_SOURCE_TARGET_BIOS_SETUP,
+    'Utilities': sys_cons.BOOT_SOURCE_TARGET_UTILITIES,
+    'Diags': sys_cons.BOOT_SOURCE_TARGET_DIAGS,
+    'SDCard': sys_cons.BOOT_SOURCE_TARGET_SD_CARD,
+    'UefiTarget': sys_cons.BOOT_SOURCE_TARGET_UEFI_TARGET,
+    'UefiShell': sys_cons.BOOT_SOURCE_TARGET_UEFI_SHELL,
+    'UefiHttp': sys_cons.BOOT_SOURCE_TARGET_UEFI_HTTP,
+}
+
+BOOT_SOURCE_TARGET_MAP_REV = utils.revert_dictionary(BOOT_SOURCE_TARGET_MAP)
+
+BOOT_SOURCE_MODE_MAP = {
+    'BIOS': sys_cons.BOOT_SOURCE_MODE_BIOS,
+    'UEFI': sys_cons.BOOT_SOURCE_MODE_UEFI,
+}
+
+BOOT_SOURCE_MODE_MAP_REV = utils.revert_dictionary(BOOT_SOURCE_MODE_MAP)
+
+BOOT_SOURCE_ENABLED_MAP = {
+    'Once': sys_cons.BOOT_SOURCE_ENABLED_ONCE,
+    'Continuous': sys_cons.BOOT_SOURCE_ENABLED_CONTINUOUS,
+    'Disabled': sys_cons.BOOT_SOURCE_ENABLED_DISABLED,
+}
+
+BOOT_SOURCE_ENABLED_MAP_REV = utils.revert_dictionary(BOOT_SOURCE_ENABLED_MAP)

sushy/resources/system/system.py

@@ -0,0 +1,248 @@
+# Copyright 2017 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import os
+
+from sushy import exceptions
+from sushy.resources import base
+from sushy.resources.system import constants as sys_cons
+from sushy.resources.system import mappings as sys_maps
+from sushy import utils
+
+
+class System(base.ResourceBase):
+
+    redfish_version = None
+    """The Redfish version"""
+
+    asset_tag = None
+    """The system asset tag"""
+
+    bios_version = None
+    """The system BIOS version"""
+
+    boot = None
+    """A dictionary containg the current boot device, frequency and mode"""
+
+    description = None
+    """The system description"""
+
+    hostname = None
+    """The system hostname"""
+
+    identity = None
+    """The system identity string"""
+
+    indicator_led = None
+    """Whether the indicator LED is lit or off"""
+
+    manufacturer = None
+    """The system manufacturer"""
+
+    name = None
+    """The system name"""
+
+    part_number = None
+    """The system part number"""
+
+    power_state = None
+    """The system power state"""
+
+    serial_number = None
+    """The system serial number"""
+
+    sku = None
+    """The system stock-keeping unit"""
+
+    system_type = None
+    """The system type"""
+
+    uuid = None
+    """The system UUID"""
+
+    def __init__(self, connector, identity, redfish_version=None):
+        """A class representing a ComputerSystem
+
+        :param connector: A Connector instance
+        :param identity: The id of the ComputerSystem
+        :param redfish_version: The version of RedFish. Used to construct
+            the object according to schema of the given version.
+        """
+        super(System, self).__init__(connector, 'Systems/%s' % identity)
+        self.redfish_version = redfish_version
+
+    def _parse_attributes(self):
+        self.asset_tag = self.json.get('AssetTag')
+        self.bios_version = self.json.get('BiosVersion')
+        self.description = self.json.get('Description')
+        self.hostname = self.json.get('HostName')
+        self.identity = self.json.get('Id')
+        self.indicator_led = self.json.get('IndicatorLED')
+        self.manufacturer = self.json.get('Manufacturer')
+        self.name = self.json.get('Name')
+        self.part_number = self.json.get('PartNumber')
+        self.serial_number = self.json.get('SerialNumber')
+        self.sku = self.json.get('SKU')
+        self.system_type = self.json.get('SystemType')
+        self.uuid = self.json.get('UUID')
+        self.power_state = sys_maps.SYSTEM_POWER_STATE_MAP.get(
+            self.json.get('PowerState'))
+
+        # Parse the boot attribute
+        self.boot = {}
+        boot_attr = self.json.get('Boot')
+        if boot_attr is not None:
+            self.boot['target'] = sys_maps.BOOT_SOURCE_TARGET_MAP.get(
+                boot_attr['BootSourceOverrideTarget'])
+            self.boot['enabled'] = sys_maps.BOOT_SOURCE_ENABLED_MAP.get(
+                boot_attr['BootSourceOverrideEnabled'])
+            self.boot['mode'] = sys_maps.BOOT_SOURCE_MODE_MAP.get(
+                boot_attr['BootSourceOverrideMode'])
+
+    def get_allowed_reset_system_values(self):
+        actions = self.json.get('Actions')
+        if not actions:
+            raise exceptions.MissingAttributeError(attribute='Actions',
+                                                   resource=self._path)
+
+        reset_action = actions.get('#ComputerSystem.Reset')
+        if not reset_action:
+            raise exceptions.MissingActionError(action='#ComputerSystem.Reset',
+                                                resource=self._path)
+
+        allowed_values = reset_action.get('ResetType@Redfish.AllowableValues')
+        if not allowed_values:
+            return []
+
+        return [sys_maps.RESET_SYSTEM_VALUE_MAP[v] for v in
+                set(sys_maps.RESET_SYSTEM_VALUE_MAP.keys()).
+                intersection(allowed_values)]
+
+    def reset_system(self, value):
+        valid_resets = self.get_allowed_reset_system_values()
+        if value not in valid_resets:
+            raise exceptions.InvalidParameterValueError(
+                parameter='value', value=value, valid_values=valid_resets)
+
+        value = sys_maps.RESET_SYSTEM_VALUE_MAP_REV[value]
+        path = self.path + '/Actions/ComputerSystem.Reset'
+        # TODO(lucasagomes): Check the return code and response body ?
+        #                    Probably we should call refresh() as well.
+        self._conn.post(path, data={'ResetType': value})
+
+    def get_allowed_system_boot_source_values(self):
+        boot = self.json.get('Boot')
+        if not boot:
+            raise exceptions.MissingAttributeError(attribute='Boot',
+                                                   resource=self._path)
+
+        allowed_values = boot.get(
+            'BootSourceOverrideTarget@Redfish.AllowableValues')
+
+        if not allowed_values:
+            return []
+
+        return [sys_maps.BOOT_SOURCE_TARGET_MAP[v] for v in
+                set(sys_maps.BOOT_SOURCE_TARGET_MAP.keys()).
+                intersection(allowed_values)]
+
+    def set_system_boot_source(self, target,
+                               enabled=sys_cons.BOOT_SOURCE_ENABLED_ONCE,
+                               mode=None):
+        valid_targets = self.get_allowed_system_boot_source_values()
+        if target not in valid_targets:
+            raise exceptions.InvalidParameterValueError(
+                parameter='target', value=target, valid_values=valid_targets)
+
+        if enabled not in sys_maps.BOOT_SOURCE_ENABLED_MAP_REV:
+            raise exceptions.InvalidParameterValueError(
+                parameter='enabled', value=enabled,
+                valid_values=sys_maps.BOOT_SOURCE_TARGET_MAP_REV.keys())
+
+        data = {
+            'Boot': {
+                'BootSourceOverrideTarget':
+                    sys_maps.BOOT_SOURCE_TARGET_MAP_REV[target],
+                'BootSourceOverrideEnabled':
+                    sys_maps.BOOT_SOURCE_ENABLED_MAP_REV[enabled]
+            }
+        }
+
+        if mode is not None:
+            if mode not in sys_maps.BOOT_SOURCE_MODE_MAP_REV:
+                raise exceptions.InvalidParameterValueError(
+                    parameter='mode', value=mode,
+                    valid_values=sys_maps.BOOT_SOURCE_MODE_MAP_REV.keys())
+
+            data['Boot']['BootSourceOverrideMode'] = (
+                sys_maps.BOOT_SOURCE_MODE_MAP_REV[mode])
+
+        # TODO(lucasagomes): Check the return code and response body ?
+        #                    Probably we should call refresh() as well.
+        self._conn.patch(self.path, data=data)
+
+    # TODO(lucasagomes): All system have a Manager and Chassis object,
+    # include a get_manager() and get_chassis() once we have an abstraction
+    # for those resources.
+
+
+class SystemCollection(base.ResourceBase):
+
+    redfish_version = None
+    """The Redfish version"""
+
+    name = None
+    """The name of the collection"""
+
+    members_identities = None
+    """A tuple with the members identities"""
+
+    def __init__(self, connector, redfish_version=None):
+        """A class representing a ComputerSystemCollection
+
+        :param connector: A Connector instance
+        :param redfish_version: The version of RedFish. Used to construct
+            the object according to schema of the given version.
+        """
+        super(SystemCollection, self).__init__(connector, 'Systems')
+        self.redfish_version = redfish_version
+
+    def _parse_attributes(self):
+        self.name = self.json.get('Name')
+        self.members_identities = (
+            utils.get_members_ids(self.json.get('Members', [])))
+
+    def get_member(self, identity):
+        """Given the identity return a System object
+
+        :param identity: The identity of the System resource
+        :returns: The System object
+        """
+        return System(self._conn, identity,
+                      redfish_version=self.redfish_version)
+
+    def get_members(self):
+        """Return a list of System objects present in the collection
+
+        :returns: A list of System objects
+        """
+        members = []
+        for member in self.json.get('Members', []):
+            ident = member.get('@odata.id')
+            if ident is not None:
+                ident = os.path.basename(ident)
+                members.append(self.get_member(ident))
+
+        return members

sushy/tests/unit/base.py

@@ -0,0 +1,22 @@
+# -*- coding: utf-8 -*-
+
+# Copyright 2010-2011 OpenStack Foundation
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+
+from oslotest import base
+
+
+class TestCase(base.BaseTestCase):
+    """Test case base class for all unit tests"""

sushy/tests/unit/test_connector.py

@@ -0,0 +1,63 @@
+# Copyright 2017 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import mock
+
+from sushy import connector
+from sushy.tests.unit import base
+
+
+class ConnectorTestCase(base.TestCase):
+
+    def setUp(self):
+        super(ConnectorTestCase, self).setUp()
+        self.conn = connector.Connector(
+            'http://foo.bar:1234/redfish/v1', username='user',
+            password='pass', verify=True)
+        self.data = {'fake': 'data'}
+        self.headers = {'X-Fake': 'header'}
+
+    @mock.patch.object(connector.Connector, '_op', autospec=True)
+    def test_get(self, mock__op):
+        self.conn.get(path='fake/path', data=self.data, headers=self.headers)
+        mock__op.assert_called_once_with(mock.ANY, 'GET', 'fake/path',
+                                         self.data, self.headers)
+
+    @mock.patch.object(connector.Connector, '_op', autospec=True)
+    def test_post(self, mock__op):
+        self.conn.post(path='fake/path', data=self.data, headers=self.headers)
+        mock__op.assert_called_once_with(mock.ANY, 'POST', 'fake/path',
+                                         self.data, self.headers)
+
+    @mock.patch.object(connector.Connector, '_op', autospec=True)
+    def test_patch(self, mock__op):
+        self.conn.patch(path='fake/path', data=self.data, headers=self.headers)
+        mock__op.assert_called_once_with(mock.ANY, 'PATCH', 'fake/path',
+                                         self.data, self.headers)
+
+    @mock.patch('sushy.connector.requests.Session', autospec=True)
+    def test__op(self, mock_session):
+        fake_session = mock.Mock()
+        mock_session.return_value.__enter__.return_value = fake_session
+
+        self.conn._op('GET', path='fake/path', data=self.data,
+                      headers=self.headers)
+        mock_session.assert_called_once_with()
+        fake_session.request.assert_called_once_with(
+            'GET', 'http://foo.bar:1234/redfish/v1/fake/path',
+            data='{"fake": "data"}')
+        expected_headers = {'Content-Type': 'application/json',
+                            'X-Fake': 'header'}
+        self.assertEqual(expected_headers, fake_session.headers)

sushy/tests/unit/test_utils.py

@@ -0,0 +1,32 @@
+# Copyright 2017 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+
+from sushy.tests.unit import base
+from sushy import utils
+
+
+class UtilsTestCase(base.TestCase):
+
+    def test_revert_dictionary(self):
+        source = {'key0': 'value0', 'key1': 'value1'}
+        expected = {'value0': 'key0', 'value1': 'key1'}
+        self.assertEqual(expected, utils.revert_dictionary(source))
+
+    def test_get_members_ids(self):
+        members = [{"@odata.id": "/redfish/v1/Systems/FOO"},
+                   {"@odata.id": "/redfish/v1/Systems/BAR"}]
+        expected = ('FOO', 'BAR')
+        self.assertEqual(expected, utils.get_members_ids(members))

sushy/utils.py

@@ -0,0 +1,43 @@
+# Copyright 2017 Red Hat, Inc.
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+import os
+
+
+def revert_dictionary(dictionary):
+    """Given a dictionary revert it's mapping
+
+    :param dictionary: A dictionary to be reverted
+    :returns: A dictionary with the keys and values reverted
+
+    """
+    return {v: k for k, v in dictionary.items()}
+
+
+def get_members_ids(members):
+    """Extract and return a tuple of members identities
+
+    :param members: A list of members in JSON format
+    :returns: A tuple containing the members identities
+
+    """
+    members_list = []
+    for member in members:
+        identity = member.get('@odata.id')
+        if not identity:
+            continue
+        members_list.append(os.path.basename(identity))
+
+    return tuple(members_list)

test-requirements.txt

@@ -0,0 +1,17 @@
+# The order of packages is significant, because pip processes them in the order
+# of appearance. Changing the order has an impact on the overall integration
+# process, which may cause wedges in the gate later.
+
+hacking>=0.12.0,<0.13 # Apache-2.0
+
+coverage>=4.0 # Apache-2.0
+python-subunit>=0.0.18 # Apache-2.0/BSD
+sphinx>=1.2.1,!=1.3b1,<1.4 # BSD
+oslosphinx>=4.7.0 # Apache-2.0
+oslotest>=1.10.0 # Apache-2.0
+testrepository>=0.0.18  # Apache-2.0/BSD
+testscenarios>=0.4  # Apache-2.0/BSD
+testtools>=1.4.0 # MIT
+
+# releasenotes
+reno>=1.8.0 # Apache-2.0

tox.ini

@@ -0,0 +1,40 @@
+[tox]
+minversion = 2.0
+envlist = py36,py35,py27,pypy,pep8
+skipsdist = True
+
+[testenv]
+usedevelop = True
+install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
+setenv =
+   VIRTUAL_ENV={envdir}
+   PYTHONWARNINGS=default::DeprecationWarning
+deps = -r{toxinidir}/test-requirements.txt
+commands = python setup.py test --slowest --testr-args='{posargs}'
+
+[testenv:pep8]
+commands = flake8 {posargs}
+
+[testenv:venv]
+commands = {posargs}
+
+[testenv:cover]
+commands = python setup.py test --coverage --testr-args='{posargs}'
+
+[testenv:docs]
+commands = python setup.py build_sphinx
+
+[testenv:releasenotes]
+commands =
+  sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
+
+[testenv:debug]
+commands = oslo_debug_helper {posargs}
+
+[flake8]
+# E123, E125 skipped as they are invalid PEP-8.
+
+show-source = True
+ignore = E123,E125
+builtins = _
+exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build