vcoworkflows 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0db2d5004d39e1e915ed6951c54a2dad6301f06
+  data.tar.gz: 93b6739926461ec0504308166cdf227bf0fbcc12
+SHA512:
+  metadata.gz: d2782bfa11dc901f086ed0e80c5dc3b00fb10551d7bf6e0a16e01ea778549eb57c9faddfed25b6208d3566bb2e550f8fbc9a47b6c6c32d1ba478ea14f24f27be
+  data.tar.gz: 671989455477f0555aca1c0b5d677994b2f11a5bbb6c44307916806719668c849af13d90db548b30ddecc3b2c3c0b9ca9814c1ffdf178f130e5d0199b1c38e5f

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,19 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+*.sw?
+
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - Guardfile
+    - vendor/**/*
+    - example.rb
+Metrics/AbcSize:
+  Enabled: false
+Style/SpecialGlobalVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - "2.1.5"

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+vcoworkflows CHANGELOG
+================
+
+## 0.1.0
+
+* Initial setup of gem framework.
+
+*note, at this point the guard implementation throws errors when running. Not sure what the cause is...
+
+
+Check the [Markdown Syntax Guide](http://daringfireball.net/projects/markdown/syntax) for help with Markdown.
+The [Github Flavored Markdown page](http://github.github.com/github-flavored-markdown/) describes the differences between markdown on github and standard markdown.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vcoworkflows.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,203 @@
+
+                                 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.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+      Copyright 2014 
+
+   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.
+   -

data/README.md

@@ -0,0 +1,290 @@
+# Vcoworkflows
+
+[![Build Status](https://travis-ci.org/ActiveSCM/vcoworkflows.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/ActiveSCM/vcoworkflows.svg)](https://gemnasium.com/ActiveSCM/vcoworkflows)
+[![Coverage Status](https://coveralls.io/repos/ActiveSCM/vcoworkflows/badge.svg)](https://coveralls.io/r/ActiveSCM/vcoworkflows)
+[![Inline docs](http://inch-ci.org/github/ActiveSCM/vcoworkflows.png?branch=master)][inch]
+
+[travis]: http://travis-ci.org/ActiveSCM/vcoworkflows
+[gemnasium]: https://gemnasium.com/ActiveSCM/vcoworkflows
+[coveralls]: https://coveralls.io/r/ActiveSCM/vcoworkflows
+[inch]: http://inch-ci.org/github/ActiveSCM/vcoworkflows
+
+`vcoworkflows` provides a Ruby API for finding and executing vCenter
+Orchestrator workflows. You can search for a workflow either by name or
+by GUID, populate the resulting `VcoWorkflows::Workflow` object's
+`inputParameters` with the required values, and then request that the
+the configured workflow be executed by vCenter Orchestrator.
+
+Under the hood, communcations with vCenter Orchestrator is done via its
+REST API, and all the REST heavy-lifting here is done by the fine and reliable
+[`rest-client`](https://rubygems.org/gems/rest-client) gem. HTTP Basic
+authentication is used with vCenter Orchestrator, and the username and
+password can either be passed as command-line arguments or set as environment
+variables (`$VCO_USER` and `$VCO_PASSWD`).
+
+## Requirements
+
+- [rest-client](https://github.com/rest-client/rest-client) is used for all the
+communications with vCenter Orchestrator.
+- [thor](http://whatisthor.com) is used for the command-line utilities.
+
+The only external dependency is vCenter Orchestrator.
+
+## Installation
+
+`vcoworkflows` is distributed as a ruby gem.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vcoworkflows'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vcoworkflows
+
+## Usage
+
+Quick example:
+
+```ruby
+require 'vcoworkflows'
+my_workflow = VcoWorkflows::Workflow.new(
+    'Request Component,
+    url: 'https://vco.example.com:8281/vco/api',
+    username: 'jdoe',
+    password: 's3cr3t',
+
+)
+
+```
+
+All the necessary interactions with a Workflow in vCenter Orchestrator are
+available via the [`VcoWorkflows::Workflow`](lib/vcoworkflows/Workflow.rb)
+class.
+
+### Selecting a Workflow
+
+It is possible to select a Workflow by GUID (as divined by the vCenter
+Orchestrator client) or by specifying the Workflow's name. If specifying by
+name, however, an exeption will be raised if either no workflows are found,
+or multiple workflows are found. Therefor, GUID is likely "safer". In either
+case, however, the workflow name must be given, as in the example above.
+
+Selecting a workflow by GUID is done by adding the `id:` parameter when
+creating a new `Workflow` object:
+
+```ruby
+my_workflow = VcoWorkflows::Workflow.new(
+    'Request Component,
+    id: '6e04a460-4a45-4e16-9603-db2922c24462',
+    url: 'https://vco.example.com:8281/vco/api',
+    username: 'jdoe',
+    password: 's3cr3t',
+    verify_ssl: false
+)
+```
+
+### Executing a workflow
+
+To execute a workflow, set any input parameters to appropriate values (if
+required), then send call `execute`. This will return an execution ID from
+vCenter Orchestrator, which identifies the run you have requested. The
+execution ID is also preserved in the `Workflow` object for simplicity.
+
+```ruby
+input_parameters = { 'name'    => 'a string value',
+                     'version' => '2',
+                     'words'   => %w(fe fi fo fum) }
+# ...
+input_parameters.each { |k, v| workflow.set_parameter(k, v) }
+workflow.execute
+```
+
+### Checking an execution status
+
+You can then get a Workflow Token from the Workflow, which will contain
+state and result information for the execution.
+
+```ruby
+wf_token = workflow.token(workflow.execute)
+```
+
+The `WorkflowToken` can be used to determine the current state and disposition
+of a Workflow execution. This can be used to periodically check up on the
+execution, if you want to follow its status:
+
+```ruby
+finished = false
+until finished
+  sleep 5
+  # Fetch a new workflow token to check the status of the workflow execution
+  wftoken = workflow.token
+  # If the execution is no longer alive, exit the loop and report the results.
+  unless wftoken.alive?
+    finished = true
+    wftoken.output_parameters.each { |k, v| puts " #{k}: #{v}" }
+  end
+end
+```
+
+### Fetching the execution log
+
+For any workflow execution, you can fetch the log:
+
+```ruby
+workflow.execute
+# ... some time later
+log = workflow.log
+puts log
+```
+
+If you have the execution ID from a previous execution:
+
+```ruby
+log = workflow.log(execution_id)
+puts log
+```
+
+### Querying a Workflow from the command line
+
+The `vcoworkflows` command line allows you to query a vCO server for a
+workflow, as well as executions and details on a specific execution.
+
+```
+$ vcoworkflows query "Request Component" \
+    --server=https://vco.example.com:8281/
+
+Retrieving workflow 'Request Component' ...
+
+Workflow:    Request Component
+ID:          6e04a460-4a45-4e16-9603-db2922c24462
+Description:
+Version:     0.0.33
+
+Input Parameters:
+ coreCount (string) [required]
+ ramMB (string) [required]
+ onBehalfOf (string) [required]
+ machineCount (string) [required]
+ businessUnit (string) [required]
+ reservation (string) [required]
+ location (string) [required]
+ environment (string) [required]
+ image (string) [required]
+ runlist (Array/string) [required]
+ nodename (string) [required]
+ component (string) [required]
+ attributesJS (string) [required]
+
+Output Parameters:
+ result (string) [required]
+ requestNumber (number) [required]
+ requestCompletionDetails (string) [required]
+```
+
+You can also retrieve a full list of executions, or only the last N:
+
+```
+$ vcoworkflows query "Request Component" \
+    --server=https://vco.example.com:8281/ \
+    --executions --last 5
+
+Retrieving workflow 'Request Component' ...
+
+
+Workflow:   Request Component
+ID:           6e04a460-4a45-4e16-9603-db2922c24462
+Description:
+Version:      0.0.33
+
+Executions:
+2014-12-19T20:38:18.457Z [ff8080814a1cb55c014a6445b85b7714] completed
+2014-12-19T20:49:04.087Z [ff8080814a1cb55c014a644f925577cf] completed
+2014-12-19T21:00:25.587Z [ff8080814a1cb55c014a6459f87278c0] completed
+2014-12-19T21:25:04.170Z [ff8080814a1cb55c014a64708829797f] completed
+2014-12-19T21:43:46.833Z [ff8080814a1cb55c014a6481a9927a78] completed
+```
+
+To get the logs from a specific execution:
+
+```
+vcoworkflows query "Request Component" \
+    --server=https://vco.example.com:8281/ \
+    --execution-id ff8080814a1cb55c014a6481a9927a78 \
+    --log
+
+Retrieving workflow 'Request Component' ...
+
+Fetching data for execution ff8080814a1cb55c014a6481a9927a78...
+
+Execution ID:      ff8080814a1cb55c014a6481a9927a78
+Name:              Request Component
+Workflow ID:       6e04a460-4a45-4e16-9603-db2922c24462
+State:             completed
+Start Date:        2014-12-19 13:43:46 -0800
+End Date:          2014-12-19 13:55:24 -0800
+Started By:        user@example.com
+
+Input Parameters:
+ coreCount = 2
+ ramMB = 2048
+ onBehalfOf = service_account@example.com
+ machineCount = 1
+ businessUnit = aw
+ reservation = nonprodlinux
+ location = us_east
+ environment = dev1
+ image = centos-6.6-x86_64-20141203-1
+ runlist =
+  - role[base]
+  - role[api]
+ nodename =
+ component = api
+ attributesJS =
+
+Output Parameters:
+ result = SUCCESSFUL
+ requestNumber = 326.0
+ requestCompletionDetails = Request succeeded. Created vm00378.
+
+2014-12-19 13:43:46 -0800 info: gruiz-ade: Workflow 'Request Component' has started
+2014-12-19 13:43:59 -0800 info: gruiz-ade: Workflow is paused; Workflow 'Request Component' has paused while waiting on signal
+2014-12-19 13:55:23 -0800 info: gruiz-ade: Workflow 'Request Component' has resumed
+2014-12-19 13:55:24 -0800 info: gruiz-ade: Workflow 'Request Component' has completed
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/ActiveSCM/vcoworkflows/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+### License and Authors
+
+- [Gregory Ruiz-Ade](https://github.com/gkra)
+
+```
+Copyright 2014 Active Network, LLC
+
+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.
+```
+