Skip to content

Commit

Permalink
Merge pull request #116 from arista-eosplus/release-0.5.1
Browse files Browse the repository at this point in the history
Release rbeapi 0.5.1
  • Loading branch information
jerearista committed Feb 16, 2016
2 parents 3ca991f + 5267123 commit 986a785
Show file tree
Hide file tree
Showing 90 changed files with 13,779 additions and 2,080 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,6 @@ Gemfile.lock
rpmbuild
rpms
*.spec

# Other
/spec/fixtures/dut.conf
24 changes: 24 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,30 @@
Ruby Client for eAPI
====================

## v0.5.1, February, 2016

- Fix issue where vlans API was not returning all configured vlan trunk_groups.

## v0.5.0, January, 2016

- Add optional ‘mode’ parameter to set_members() method in port-channel
interfaces API
- Add support for trunk groups
- Ensure multiple connections based on the wildcard settings do not clobber
each other.
- Add ‘terminal’ to the ‘configure’ command to workaround AAA issue
- Fix issue where ‘enablepw’ in the eapi.conf was not properly used
- Catch errors and syslog them when parsing eapi conf file.
In the event of an unparsable eapi.conf, a syslog warning will be generated
but the app will continue to attempt to utilize the default localhost conn.
- Ensure that nil is returned when getting nonexistent username
- Ensure all parse methods are private
- Add tests for timeout values
- Update framework tests
- Add unit tests for switchports
- Address code coverage gaps


## v0.4.0, November, 2015

- New users API
Expand Down
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ group :development, :test do
gem 'pry', require: false
gem 'pry-doc', require: false
gem 'pry-stack_explorer', require: false
gem 'rbeapi', '0.4.0', path: '.'
gem 'rbeapi', '0.5.1', path: '.'
gem 'ci_reporter_rspec', require: false
gem 'simplecov-json', require: false
gem 'simplecov-rcov', require: false
Expand Down
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@
6. [Testing] (#testing)
7. [License] (#license)

## Build status

Style/package build: [![Start Build Status](https://revproxy.arista.com/eosplus/ci/buildStatus/icon?job=rbeapi_start&style=plastic)](https://revproxy.arista.com/eosplus/ci/job/rbeapi_start)

Unit/System spec/coverage: [![Spec Build Status](https://revproxy.arista.com/eosplus/ci/buildStatus/icon?job=rbeapi_spec&style=plastic)](https://revproxy.arista.com/eosplus/ci/job/rbeapi_spec)

# Overview

Expand Down Expand Up @@ -230,21 +235,21 @@ Copy the RPMs to an EOS device then run the 'swix create' command.
Examples:
Puppet Open Source:
cd /mnt/flash; \
swix create rbeapi-0.4.0-1.swix \
rubygem-rbeapi-0.4.0-1.eos4.noarch.rpm \
swix create rbeapi-0.5.1-1.swix \
rubygem-rbeapi-0.5.1-1.eos4.noarch.rpm \
rubygem-inifile-3.0.0-3.eos4.noarch.rpm \
rubygem-netaddr-1.5.0-2.eos4.noarch.rpm \
rubygem-net_http_unix-0.2.1-3.eos4.noarch.rpm
Puppet-enterprise agent (3.x):
cd/mnt/flash; \
swix create rbeapi-puppet3-0.4.0-1.swix \
rubygem-rbeapi-puppet3-0.4.0-1.eos4.noarch.rpm \
swix create rbeapi-puppet3-0.5.1-1.swix \
rubygem-rbeapi-puppet3-0.5.1-1.eos4.noarch.rpm \
rubygem-inifile-puppet3-3.0.0-3.eos4.noarch.rpm \
rubygem-netaddr-puppet3-1.5.0-2.eos4.noarch.rpm
Puppet-All-in-one agent (2015.x/4.x):
cd/mnt/flash; \
swix create rbeapi-puppet-aio-0.4.0-1.swix \
rubygem-rbeapi-puppet-aio-0.4.0-1.eos4.noarch.rpm \
swix create rbeapi-puppet-aio-0.5.1-1.swix \
rubygem-rbeapi-puppet-aio-0.5.1-1.eos4.noarch.rpm \
rubygem-inifile-puppet-aio-3.0.0-3.eos4.noarch.rpm \
rubygem-netaddr-puppet-aio-1.5.0-2.eos4.noarch.rpm \
rubygem-net_http_unix-puppet-aio-0.2.1-3.eos4.noarch.rpm
Expand All @@ -255,13 +260,13 @@ Copy the RPMs to an EOS device then run the 'swix create' command.
Arista# copy <URI-to-RPMs> flash:
Arista# bash
-bash-4.1# cd /mnt/flash/
-bash-4.1# swix create rbeapi-puppet3-0.4.0-1.swix \
rubygem-rbeapi-puppet3-0.4.0-1.eos4.noarch.rpm \
-bash-4.1# swix create rbeapi-puppet3-0.5.1-1.swix \
rubygem-rbeapi-puppet3-0.5.1-1.eos4.noarch.rpm \
rubygem-inifile-puppet3-3.0.0-1.eos4.noarch.rpm \
rubygem-netaddr-puppet3-1.5.0-1.eos4.noarch.rpm
-bash-4.1# exit
Arista# copy flash:rbeapi-puppet3-0.4.0-1.swix extension:
Arista# extension rbeapi-puppet3-0.4.0-1.swix
Arista# copy flash:rbeapi-puppet3-0.5.1-1.swix extension:
Arista# extension rbeapi-puppet3-0.5.1-1.swix
Arista# copy installed-extensions boot-extensions
```

Expand All @@ -270,7 +275,7 @@ Copy the RPMs to an EOS device then run the 'swix create' command.
On EOS:
```
Arista# no extension pe-rbeapi-0.3.0-1.swix
Arista# extension rbeapi-puppet3-0.4.0-1.swix
Arista# extension rbeapi-puppet3-0.5.1-1.swix
Arista# copy installed-extensions boot-extensions
```

Expand All @@ -291,7 +296,7 @@ corresponding test cases otherwise the pull request will be rejected.

# License

Copyright (c) 2015, Arista Networks, Inc. All rights reserved.
Copyright (c) 2016, Arista Networks, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Expand Down
19 changes: 19 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -155,3 +155,22 @@ task ci_spec: [:ci_prep, 'ci:setup:rspec', :spec]

require 'rspec/core/rake_task'
RSpec::Core::RakeTask.new(:spec)

desc 'Generate typedoc.rst for the guide'
task :typedoc do
system 'rbeapi doc -r type \
| awk \'/This page/{flag=1}/augeas/{flag=0}/eos_/{flag=1}/ exec/\
{flag=0}/\*This page/{flag=1}flag\' \
| pandoc --from=markdown --to=rst --output=- \
> guide/typedoc.rst'
end

desc 'Generate Getting Started Guide HTML'
task guide: [:typedoc] do
system 'make -C guide html'
end

desc 'Clean Getting Started docs'
task :guide_clean do
system 'make -C guide clean'
end
2 changes: 2 additions & 0 deletions guide/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Sphinx build env
_build
177 changes: 177 additions & 0 deletions guide/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,177 @@
# 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 gettext

help:
@echo "Please use \`make <target>' where <target> 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 " 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)"

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/Rbeapi.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Rbeapi.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/Rbeapi"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Rbeapi"
@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."

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."
Binary file added guide/_static/arista_logo_11-trans-w.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added guide/_static/arista_logo_jpg-11.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added guide/_static/favicon.ico
Binary file not shown.
Loading

0 comments on commit 986a785

Please sign in to comment.