diff --git a/.gitignore b/.gitignore index 9193453..a392642 100644 --- a/.gitignore +++ b/.gitignore @@ -23,6 +23,7 @@ lib64/ parts/ sdist/ var/ +temp/ *.egg-info/ .installed.cfg *.egg diff --git a/drivers/deployment_drivers/openstack_nova_image_instance/__init__.py b/drivers/deployment_drivers/openstack_nova_image_instance/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/drivers/deployment_drivers/openstack_nova_image_instance/driver.py b/drivers/deployment_drivers/openstack_nova_image_instance/driver.py new file mode 100644 index 0000000..5affe64 --- /dev/null +++ b/drivers/deployment_drivers/openstack_nova_image_instance/driver.py @@ -0,0 +1,20 @@ +from cloudshell.shell.core.resource_driver_interface import ResourceDriverInterface +import jsonpickle + +class DeployOSNovaImageInstance(ResourceDriverInterface): + + def __init__(self): + pass # Empty right now + + def cleanup(self): + pass + + def initialize(self, context): + pass # TODO : Figure out what is to be done next? + + def Deploy(self, context, Name=None): + # FIXME: Just copy pasting hard-coded deploy_ami output. + return str(jsonpickle.encode({"vm_name": "testvm", "vm_uuid": "1234-5678", + "cloud_provider_resource_name" : "openstack"}, + unpicklable=False)) + diff --git a/drivers/deployment_drivers/openstack_nova_image_instance/drivermetadata.xml b/drivers/deployment_drivers/openstack_nova_image_instance/drivermetadata.xml new file mode 100644 index 0000000..e993cf9 --- /dev/null +++ b/drivers/deployment_drivers/openstack_nova_image_instance/drivermetadata.xml @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/drivers/deployment_drivers/openstack_nova_image_instance/requirements.txt b/drivers/deployment_drivers/openstack_nova_image_instance/requirements.txt new file mode 100644 index 0000000..e972330 --- /dev/null +++ b/drivers/deployment_drivers/openstack_nova_image_instance/requirements.txt @@ -0,0 +1,2 @@ +cloudshell-shell-core>=2.0.0,<2.1.0 +jsonpickle diff --git a/drivers/install.bat b/drivers/install.bat index 994cbba..a2b9fb3 100644 --- a/drivers/install.bat +++ b/drivers/install.bat @@ -1,3 +1,3 @@ @echo off python -m pip install qpm --no-cache-dir --upgrade -python -m qpm install --package_name aws_shell +python -m qpm install --package_name openstack_shell diff --git a/drivers/openstack_shell/docs/Makefile b/drivers/openstack_shell/docs/Makefile new file mode 100644 index 0000000..f7b288c --- /dev/null +++ b/drivers/openstack_shell/docs/Makefile @@ -0,0 +1,192 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/cookiecutter-pypackage.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/cookiecutter-pypackage.qhc" + +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/cookiecutter-pypackage" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/cookiecutter-pypackage" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/drivers/openstack_shell/docs/conf.py b/drivers/openstack_shell/docs/conf.py new file mode 100644 index 0000000..2089fc3 --- /dev/null +++ b/drivers/openstack_shell/docs/conf.py @@ -0,0 +1,291 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# cookiecutter-pypackage documentation build configuration file, created by +# sphinx-quickstart on Sun Dec 13 09:13:01 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. + +import sys +import os +import shlex + +# 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 = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.doctest', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +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 = 'cookiecutter-pypackage' +copyright = '2015, Audrey Roy Greenfeld' +author = 'Audrey Roy Greenfeld' + +# 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. +version = '0.9.0' +# The full version, including alpha/beta/rc tags. +release = '0.9.0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +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 = ['_build'] + +# 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 infoMessage" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- 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 = 'alabaster' + +# 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 +# " v 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 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 + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'cookiecutter-pypackagedoc' + +# -- 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': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# 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 = [ + (master_doc, 'cookiecutter-pypackage.tex', 'cookiecutter-pypackage Documentation', + 'Audrey Roy Greenfeld', '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 = [ + (master_doc, 'cookiecutter-pypackage', 'cookiecutter-pypackage Documentation', + [author], 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 = [ + (master_doc, 'cookiecutter-pypackage', 'cookiecutter-pypackage Documentation', + author, 'cookiecutter-pypackage', '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 diff --git a/drivers/openstack_shell/docs/index.rst b/drivers/openstack_shell/docs/index.rst new file mode 100644 index 0000000..3ae8ef6 --- /dev/null +++ b/drivers/openstack_shell/docs/index.rst @@ -0,0 +1,41 @@ +.. cookiecutter-pypackage documentation master file, created by + sphinx-quickstart on Sun Dec 13 09:13:01 2015. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to cookiecutter-pypackage's documentation! +================================================== + +Getting Started +--------------- + +.. toctree:: + :maxdepth: 2 + + readme + tutorial + +Basics +------ + +.. toctree:: + :maxdepth: 2 + + prompts + +Advanced Features +----------------- + +.. toctree:: + :maxdepth: 2 + + travis_pypi_setup + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/drivers/openstack_shell/docs/make.bat b/drivers/openstack_shell/docs/make.bat new file mode 100644 index 0000000..4dc8d21 --- /dev/null +++ b/drivers/openstack_shell/docs/make.bat @@ -0,0 +1,263 @@ +@ECHO OFF + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set BUILDDIR=_build +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . +set I18NSPHINXOPTS=%SPHINXOPTS% . +if NOT "%PAPER%" == "" ( + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% +) + +if "%1" == "" goto help + +if "%1" == "help" ( + :help + echo.Please use `make ^` where ^ is one of + echo. html to make standalone HTML files + echo. dirhtml to make HTML files named index.html in directories + echo. singlehtml to make a single large HTML file + echo. pickle to make pickle files + echo. json to make JSON files + echo. htmlhelp to make HTML files and a HTML help project + echo. qthelp to make HTML files and a qthelp project + echo. devhelp to make HTML files and a Devhelp project + echo. epub to make an epub + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter + echo. text to make text files + echo. man to make manual pages + echo. texinfo to make Texinfo files + echo. gettext to make PO message catalogs + echo. changes to make an overview over all changed/added/deprecated items + echo. xml to make Docutils-native XML files + echo. pseudoxml to make pseudoxml-XML files for display purposes + echo. linkcheck to check all external links for integrity + echo. doctest to run all doctests embedded in the documentation if enabled + echo. coverage to run coverage check of the documentation if enabled + goto end +) + +if "%1" == "clean" ( + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i + del /q /s %BUILDDIR%\* + goto end +) + + +REM Check if sphinx-build is available and fallback to Python version if any +%SPHINXBUILD% 1>NUL 2>NUL +if errorlevel 9009 goto sphinx_python +goto sphinx_ok + +:sphinx_python + +set SPHINXBUILD=python -m sphinx.__init__ +%SPHINXBUILD% 2> nul +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +:sphinx_ok + + +if "%1" == "html" ( + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/html. + goto end +) + +if "%1" == "dirhtml" ( + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. + goto end +) + +if "%1" == "singlehtml" ( + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. + goto end +) + +if "%1" == "pickle" ( + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the pickle files. + goto end +) + +if "%1" == "json" ( + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can process the JSON files. + goto end +) + +if "%1" == "htmlhelp" ( + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run HTML Help Workshop with the ^ +.hhp project file in %BUILDDIR%/htmlhelp. + goto end +) + +if "%1" == "qthelp" ( + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; now you can run "qcollectiongenerator" with the ^ +.qhcp project file in %BUILDDIR%/qthelp, like this: + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\cookiecutter-pypackage.qhcp + echo.To view the help file: + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\cookiecutter-pypackage.ghc + goto end +) + +if "%1" == "devhelp" ( + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. + goto end +) + +if "%1" == "epub" ( + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The epub file is in %BUILDDIR%/epub. + goto end +) + +if "%1" == "latex" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + if errorlevel 1 exit /b 1 + echo. + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdf" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "latexpdfja" ( + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex + cd %BUILDDIR%/latex + make all-pdf-ja + cd %~dp0 + echo. + echo.Build finished; the PDF files are in %BUILDDIR%/latex. + goto end +) + +if "%1" == "text" ( + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The text files are in %BUILDDIR%/text. + goto end +) + +if "%1" == "man" ( + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The manual pages are in %BUILDDIR%/man. + goto end +) + +if "%1" == "texinfo" ( + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. + goto end +) + +if "%1" == "gettext" ( + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The message catalogs are in %BUILDDIR%/locale. + goto end +) + +if "%1" == "changes" ( + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes + if errorlevel 1 exit /b 1 + echo. + echo.The overview file is in %BUILDDIR%/changes. + goto end +) + +if "%1" == "linkcheck" ( + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck + if errorlevel 1 exit /b 1 + echo. + echo.Link check complete; look for any errors in the above output ^ +or in %BUILDDIR%/linkcheck/output.txt. + goto end +) + +if "%1" == "doctest" ( + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest + if errorlevel 1 exit /b 1 + echo. + echo.Testing of doctests in the sources finished, look at the ^ +results in %BUILDDIR%/doctest/output.txt. + goto end +) + +if "%1" == "coverage" ( + %SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage + if errorlevel 1 exit /b 1 + echo. + echo.Testing of coverage in the sources finished, look at the ^ +results in %BUILDDIR%/coverage/python.txt. + goto end +) + +if "%1" == "xml" ( + %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The XML files are in %BUILDDIR%/xml. + goto end +) + +if "%1" == "pseudoxml" ( + %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml + if errorlevel 1 exit /b 1 + echo. + echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. + goto end +) + +:end diff --git a/drivers/openstack_shell/docs/prompts.rst b/drivers/openstack_shell/docs/prompts.rst new file mode 100644 index 0000000..456ef5f --- /dev/null +++ b/drivers/openstack_shell/docs/prompts.rst @@ -0,0 +1,47 @@ +Prompts +======= + +When you create a package, you are prompted to enter these values. + +Templated Values +---------------- + +The following appear in various parts of your generated project. + +full_name + Your full name. + +email + Your email address. + +github_username + Your GitHub username. + +project_name + The name of your new Python package project. This is used in documentation, so spaces and any characters are fine here. + +project_slug + The namespace of your Python package. This should be Python import-friendly. Typically, it is the slugified version of project_name. + +project_short_description + A 1-sentence description of what your Python package does. + +release_date + The date of the first release. + +pypi_username + Your Python Package Index account username. + +year + The year of the initial package copyright in the license file. + +version + The starting version number of the package. + +Options +------- + +The following package configuration options set up different features for your project. + +use_pypi_deployment_with_travis + Whether to use PyPI deployment with Travis. diff --git a/drivers/openstack_shell/docs/readme.rst b/drivers/openstack_shell/docs/readme.rst new file mode 100644 index 0000000..4dc0eb5 --- /dev/null +++ b/drivers/openstack_shell/docs/readme.rst @@ -0,0 +1,3 @@ +.. _readme: + +.. include:: ../README.rst diff --git a/drivers/openstack_shell/docs/travis_pypi_setup.rst b/drivers/openstack_shell/docs/travis_pypi_setup.rst new file mode 100644 index 0000000..c813c3f --- /dev/null +++ b/drivers/openstack_shell/docs/travis_pypi_setup.rst @@ -0,0 +1,59 @@ +.. _travis-pypi-setup: + + +Travis/PyPI Setup +================= + +Optionally, your package can automatically be released on PyPI whenever you +push a new tag to the master branch. + +How It Works +------------ + +Your project comes with a script called `travis_pypi_setup.py`. + +This script does the following: + +* Encrypt your PyPI password and save it in your Travis config +* Activate automated deployment on PyPI when you push a new tag to master. + +The encryption is done using RSA encryption, you can `read more +about Travis encryption here `_. +In short, the encrypted password can only be decrypted by Travis, +using the private key it associates with your repo. + + +Using the Travis command-line tool instead +------------------------------------------ + +If you have the `travis` command - line tool installed, instead of using +the `travis_pypi_setup.py` script you can do:: + + travis encrypt --add deploy.password + +Which does essentially the same thing. + + +Your Release Process +-------------------- + +If you are using this feature, this is how you would do a patch release: + +.. code-block:: bash + + bumpversion patch + git push --tags + +This will result in: + +* mypackage 0.1.1 showing up in your GitHub tags/releases page +* mypackage 0.1.1 getting released on PyPI + +You can also replace patch with `minor` or `major`. + + +More Details +------------ + +You can read more about using Travis for PyPI deployment at: +https://docs.travis-ci.com/user/deployment/pypi/ diff --git a/drivers/openstack_shell/docs/tutorial.rst b/drivers/openstack_shell/docs/tutorial.rst new file mode 100644 index 0000000..fb32b98 --- /dev/null +++ b/drivers/openstack_shell/docs/tutorial.rst @@ -0,0 +1,69 @@ +Tutorial +======== + +.. note:: Did you find any of these instructions confusing? `Edit this file`_ + and submit a pull request with your improvements! + +.. _`Edit this file`: https://github.com/audreyr/cookiecutter-pypackage/blob/master/docs/tutorial.rst + +Step 1: Install Cookiecutter +---------------------------- + +First, create a virtualenv for your new package and install cookiecutter: + +.. code-block:: bash + + virtualenv ~/.virtualenvs/mypackage + pip install cookiecutter + +Here, `mypackage` is the name of the package that you'll create. + +Step 2: Generate Your Package +----------------------------- + +Now it's time to generate your Python package. + +Use cookiecutter, pointing it at the cookiecutter-pypackage repo: + +.. code-block:: bash + + cookiecutter https://github.com/audreyr/cookiecutter-pypackage.git + +You'll be asked to enter a bunch of values. If you don't know what to enter, +stick with the defaults. + +Step 3: Create a GitHub Repo +---------------------------- + +Create a repo and put your package there. + +Step 4: Set Up Travis CI +------------------------ + +Log into `Travis CI`_. + +Add the repo to your Travis CI account. + +Run the script `travis_pypi_setup.py`. It will: + +* Encrypt your PyPI password in your Travis config. +* Activate automated deployment on PyPI when you push a new tag to master branch. + +See :ref:`travis-pypi-setup`. + +.. _`Travis CI`: https://travis-ci.org/ + +Step 5: Set Up ReadTheDocs +-------------------------- + +Add the repo to your ReadTheDocs account. + +In your GitHub repo settings, turn on the ReadTheDocs service hook. + +Step 6: Release on PyPI +------------------------ + +Release your package the standard Python way. + +Here's a release checklist: + https://gist.github.com/audreyr/5990987 diff --git a/drivers/openstack_shell/src/__init__.py b/drivers/openstack_shell/src/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/drivers/openstack_shell/src/driver.py b/drivers/openstack_shell/src/driver.py new file mode 100644 index 0000000..34b8147 --- /dev/null +++ b/drivers/openstack_shell/src/driver.py @@ -0,0 +1,36 @@ +from cloudshell.shell.core.resource_driver_interface import ResourceDriverInterface +import jsonpickle + + +class OpenStackShellDriver(ResourceDriverInterface): + def cleanup(self): + pass + + def __init__(self): + """ + ctor must be without arguments, it is created with reflection at run time + """ + pass + + def initialize(self, context): + pass + + def deploy_from_image(self, context, request): + return str(jsonpickle.encode({"vm_name": "testvm", "vm_uuid": "1234-5678", + "cloud_provider_resource_name" : "openstack"}, + unpicklable=False)) + + def PowerOn(self, context, ports): + return str(jsonpickle.encode(True, unpicklable=False)) + + def PowerOff(self, context, ports): + return str(jsonpickle.encode(True, unpicklable=False)) + + def PowerCycle(self, context, ports, delay): + pass + + def destroy_vm_only(self, context, ports): + return str(jsonpickle.encode(True, unpicklable=False)) + + def remote_refresh_ip(self, context, ports, cancellation_context): + pass diff --git a/drivers/openstack_shell/src/drivermetadata.xml b/drivers/openstack_shell/src/drivermetadata.xml new file mode 100644 index 0000000..af92504 --- /dev/null +++ b/drivers/openstack_shell/src/drivermetadata.xml @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/drivers/openstack_shell/src/requirements.txt b/drivers/openstack_shell/src/requirements.txt new file mode 100644 index 0000000..e972330 --- /dev/null +++ b/drivers/openstack_shell/src/requirements.txt @@ -0,0 +1,2 @@ +cloudshell-shell-core>=2.0.0,<2.1.0 +jsonpickle diff --git a/drivers/openstack_shell/src/tests/__init__.py b/drivers/openstack_shell/src/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/drivers/openstack_shell_specs/aws_shell.ini b/drivers/openstack_shell_specs/aws_shell.ini new file mode 100644 index 0000000..5e8b67f --- /dev/null +++ b/drivers/openstack_shell_specs/aws_shell.ini @@ -0,0 +1,6 @@ +[Packaging] +is_driver: True +driver_folder: openstack_shell\src +include_dirs: +target_name: OpenStack Shell Driver +target_dir: Resource Drivers - Python diff --git a/drivers/openstack_shell_specs/deploy_openstack_nova_image_instance.ini b/drivers/openstack_shell_specs/deploy_openstack_nova_image_instance.ini new file mode 100644 index 0000000..bfff7ad --- /dev/null +++ b/drivers/openstack_shell_specs/deploy_openstack_nova_image_instance.ini @@ -0,0 +1,6 @@ +[Packaging] +is_driver: True +driver_folder: deployment_drivers\openstack_nova_image_instance +include_dirs: +target_name: Deploy OpenStack Nova Image Instance +target_dir: Resource Drivers - Python diff --git a/drivers/pack.bat b/drivers/pack.bat index 31144d6..69cdb50 100644 --- a/drivers/pack.bat +++ b/drivers/pack.bat @@ -1,3 +1,3 @@ @echo off python -m pip install qpm --no-cache-dir --upgrade -python -m qpm pack --package_name aws_shell \ No newline at end of file +python -m qpm pack --package_name openstack_shell diff --git a/package/cloudshell/__init__.py b/package/cloudshell/__init__.py new file mode 100644 index 0000000..5ad884c --- /dev/null +++ b/package/cloudshell/__init__.py @@ -0,0 +1,3 @@ +__author__ = 'quali' +from pkgutil import extend_path +__path__ = extend_path(__path__, __name__) diff --git a/package/cloudshell/cp/__init__.py b/package/cloudshell/cp/__init__.py new file mode 100644 index 0000000..5ad884c --- /dev/null +++ b/package/cloudshell/cp/__init__.py @@ -0,0 +1,3 @@ +__author__ = 'quali' +from pkgutil import extend_path +__path__ = extend_path(__path__, __name__) diff --git a/package/cloudshell/cp/openstack/__init__.py b/package/cloudshell/cp/openstack/__init__.py new file mode 100644 index 0000000..5ad884c --- /dev/null +++ b/package/cloudshell/cp/openstack/__init__.py @@ -0,0 +1,3 @@ +__author__ = 'quali' +from pkgutil import extend_path +__path__ = extend_path(__path__, __name__) diff --git a/package/cloudshell/cp/openstack/common/__init__.py b/package/cloudshell/cp/openstack/common/__init__.py new file mode 100644 index 0000000..5ad884c --- /dev/null +++ b/package/cloudshell/cp/openstack/common/__init__.py @@ -0,0 +1,3 @@ +__author__ = 'quali' +from pkgutil import extend_path +__path__ = extend_path(__path__, __name__) diff --git a/package/cloudshell/cp/openstack/common/deploy_data_holder.py b/package/cloudshell/cp/openstack/common/deploy_data_holder.py new file mode 100644 index 0000000..a41e097 --- /dev/null +++ b/package/cloudshell/cp/openstack/common/deploy_data_holder.py @@ -0,0 +1,53 @@ +class DeployDataHolder(object): + def __init__(self, d): + for a, b in d.items(): + if isinstance(b, dict): + setattr(self, a, DeployDataHolder(b)) + elif isinstance(b, list): + items = [self._create_obj_by_type(item) for item in b] + setattr(self, a, items) + else: + setattr(self, a, self._create_obj_by_type(b)) + + @staticmethod + def _create_obj_by_type(obj): + obj_type = type(obj) + if obj_type == dict: + return DeployDataHolder(obj) + if obj_type == list: + return [DeployDataHolder._create_obj_by_type(item) for item in obj] + if DeployDataHolder._is_primitive(obj): + return obj_type(obj) + return obj + + @staticmethod + def _is_primitive(thing): + primitive = (int, str, bool, float, unicode) + return isinstance(thing, primitive) + + @classmethod + def create_from_params(cls, template_model, datastore_name, vm_cluster_model, ip_regex, refresh_ip_timeout, + auto_power_on, auto_power_off, wait_for_ip, auto_delete): + """ + :param VCenterTemplateModel template_model: + :param str datastore_name: + :param VMClusterModel vm_cluster_model: + :param str ip_regex: Custom regex to filter IP addresses + :param refresh_ip_timeout: + :param bool auto_power_on: + :param bool auto_power_off: + :param bool wait_for_ip: + :param bool auto_delete: + """ + dic = { + 'template_model': template_model, + 'datastore_name': datastore_name, + 'vm_cluster_model': vm_cluster_model, + 'ip_regex': ip_regex, + 'refresh_ip_timeout': refresh_ip_timeout, + 'auto_power_on': auto_power_on, + 'auto_power_off': auto_power_off, + 'wait_for_ip': wait_for_ip, + 'auto_delete': auto_delete + } + return cls(dic) diff --git a/package/cloudshell/cp/openstack/common/driver_helper.py b/package/cloudshell/cp/openstack/common/driver_helper.py new file mode 100644 index 0000000..9f05fc6 --- /dev/null +++ b/package/cloudshell/cp/openstack/common/driver_helper.py @@ -0,0 +1,21 @@ +from cloudshell.api.cloudshell_api import CloudShellAPISession + + +class CloudshellDriverHelper(object): + def __init__(self): + self.session_class = CloudShellAPISession + + def get_session(self, server_address, token, reservation_domain): + """ + gets the current session + + :param str reservation_domain: reservation domain + :param token: the admin authentication token + :param server_address: cloudshell server address + :return CloudShellAPISession + """ + return self.session_class(host=server_address, + token_id=token, + username=None, + password=None, + domain=reservation_domain) diff --git a/package/cloudshell/cp/openstack/domain/__init__.py b/package/cloudshell/cp/openstack/domain/__init__.py new file mode 100644 index 0000000..5ad884c --- /dev/null +++ b/package/cloudshell/cp/openstack/domain/__init__.py @@ -0,0 +1,3 @@ +__author__ = 'quali' +from pkgutil import extend_path +__path__ = extend_path(__path__, __name__) diff --git a/package/cloudshell/cp/openstack/models/__init__.py b/package/cloudshell/cp/openstack/models/__init__.py new file mode 100644 index 0000000..5ad884c --- /dev/null +++ b/package/cloudshell/cp/openstack/models/__init__.py @@ -0,0 +1,3 @@ +__author__ = 'quali' +from pkgutil import extend_path +__path__ = extend_path(__path__, __name__) diff --git a/package/requirements.txt b/package/requirements.txt index 3070e54..dd0bccb 100644 --- a/package/requirements.txt +++ b/package/requirements.txt @@ -1,6 +1,2 @@ -boto3==1.3.1 cloudshell-automation-api>=7.0.0.0,<7.1.0.0 cloudshell-core>=2.0.0,<2.1.0 -jsonpickle==0.9.3 -enum==0.4.6 -pycrypto==2.6.1 \ No newline at end of file diff --git a/package/setup.py b/package/setup.py index e191a2d..6d00d82 100644 --- a/package/setup.py +++ b/package/setup.py @@ -14,8 +14,8 @@ name="cloudshell-cp-openstack", author="Quali", author_email="support@qualisystems.com", - description=("A repository for projects providing out of the box capabilities within CloudShell to define Openstack " - "instances in CloudShell and leverage Openstack (Liberty and above) capabilities to deploy and connect " + description=("A repository for projects providing out of the box capabilities within CloudShell to define OpenStack " + "instances in CloudShell and leverage OpenStack (Liberty and above) capabilities to deploy and connect " "apps in CloudShell sandboxes."), packages=find_packages(), test_suite='nose.collector',