swift-manager 0.0.4

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/*
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,19 @@
+#
+# Author:: Murali Raju (<murali.raju@.com>)
+# Copyright:: Copyright (c) 2011 Murali Raju.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+source :rubygems
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                              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 [yyyy] [name of copyright owner]
+
+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,56 @@
+swift-manager (beta)
+===== 
+
+swift-manager aims to be a Ruby based OpenStack Swift Client with a git-like interface used to test and manage native Swift and AWS S3 APIs. This version builds on the excellent Ruby Fog gem. Furture versions may use native JSON/XML. Currently uses JSON for configuration files located under ~/.swift-manager.
+
+##Audience
+
+swift-manager is targeted towards Developers to test Swift or S3 APIs. However, anyone wanting to use it to test a Swift Cloud or S3 semantics may find it useful.
+
+##Features
+
+
+Supported on Ruby 1.9.3-p125 and JRuby-1.6.7
+
+1. Ability to create/delete containers and objects in S3 and Swift native APIs. No CDN is supported at this time.
+2. Ability to list containers and objects (files)
+3. Batch jobs:
+	a. create containers at scale by providing a container prefix and the number of containers to create
+	b. upload files to a container (can be used for backups)
+4. Unix-like(read-only) shell to browse containers with TAB completion (very basic)
+
+**Assumptions: The current implementation requires SSL at the Swift Proxy server due to Ruby Fog dependencies. Make sure to have the following in /etc/swift/proxy-server.conf
+
+[DEFAULT]
+
+cert_file = /etc/swift/cert.crt
+
+key_file = /etc/swift/cert.key
+
+
+##Install
+
+After installing Ruby or JRuby, run:
+
+gem install swift-manager
+
+##Documentation
+
+1. swift-manager help command
+2. Read examples.txt in the docs directory
+
+####ToDos (Patches are Welcome!)
+
+In addition to continued improvement in documentation...
+
+1. CDN support and CDN enable existing containers
+2. Shell support for listing objects
+3. Write support for Shell. Example, implement"create or touch commands" to create containers and objects
+4. More granulor metrics for create and delete containers/objects in order to test large requests (millions)
+5. Implement port, URL, and other parameters for Authentiation Configuration JSON
+
+
+
+
+
+

data/README.rdoc

@@ -0,0 +1,8 @@
+= swift-manager
+
+A Ruby OpenStack Swift Client
+
+:include:sling.rdoc
+
+
+

data/Rakefile

@@ -0,0 +1,38 @@
+#
+# Author:: Murali Raju (<murali.raju@.com>)
+# Copyright:: Copyright (c) 2011 Murali Raju.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+require 'rake/clean'
+require 'rubygems'
+require 'rdoc/task'
+require "bundler/gem_tasks"
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+  rd.title = 'swift-manager'
+end
+
+
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/tc_*.rb']
+end
+
+task :default => :test

data/bin/swift-manager

@@ -0,0 +1,337 @@
+#!/usr/bin/env ruby
+#
+# Author:: Murali Raju (<murali.raju@.com>)
+# Copyright:: Copyright (c) 2011 Murali Raju.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+unless File.respond_to? :realpath
+  class File #:nodoc:
+    def self.realpath path
+      return realpath(File.readlink(path)) if symlink?(path)
+      path
+    end
+  end
+end
+$: << File.expand_path(File.dirname(File.realpath(__FILE__)) + '/../lib')
+
+require 'rubygems'
+require 'irb'
+require 'gli'
+require 'swift-manager_version'
+require 'rainbow'
+require 'json'
+require 'fog'
+require 'progress_bar'
+require 'terminal-table'
+require 'configurator'
+require 'parser'
+require 'swift_client'
+require 'cloud_shell'
+require 'formatter'
+
+include GLI
+program_desc '[             OpenStack Swift Manager         ]'.bright.color(:blue)
+puts ''
+
+version SwiftManager::VERSION
+
+# desc 'Log output to ~/.swift-manager/log'
+# switch [:l,:log]
+
+
+desc 'Create Object Storage'
+arg_name 'storage'
+command :create do |c|
+
+  c.desc 'Type: s3 or swift'
+  c.flag [:t, :type]
+  c.desc 'Name: a prefix for the container. The result will be [prefix+timestamp] to be unique'
+  c.flag [:n, :name]
+  c.desc 'Auth Config'
+  c.flag [:f, :file]
+  c.desc 'Item: container, file'
+  c.flag [:i, :item]
+ 
+
+  c.action do |global_options,options,args|
+    type            = options[:type]
+    name            = options[:name]
+    file            = options[:file]
+    item            = options[:item]
+
+    case type
+    when 'swift', 's3'
+      swift_client = SwiftClient.new(type, file)
+      if item == 'container'
+        swift_client.create_container_no_cdn(name)
+        swift_client.list_containers
+      end
+    else
+      raise 'Incorrect options. Please try again or type \'swift-manager help create\''
+    end
+
+  end
+end
+
+desc 'Generate auth configurations'
+arg_name 'config'
+command :generate do |c|
+
+  c.desc 'Type: auth'
+  c.flag [:t, :type]
+  c.desc 'Provider: aws, rackspace (for swift)'
+  c.flag [:p, :provider]
+  c.desc 'Service: s3, swift'
+  c.flag [:s, :service]
+  c.desc 'Auth URL ip address: Swift '
+  c.flag [:i, :ip]
+  c.desc 'Secret Access Key or Swift API Key'
+  c.flag [:k, :secret_access_key]
+  c.desc 'Access Key ID or Swift Username: <user>:<user>'
+  c.flag [:a, :access_key_id]
+  c.desc 'Tag: Assign a tag for later use'
+  c.flag :tag
+
+  c.action do |global_options,options,args|
+
+      config_type       = options[:type]
+      provider          = options[:provider]
+      service           = options[:service]
+      secret_access_key = options[:secret_access_key]
+      access_key_id     = options[:access_key_id]
+      tag               = options[:tag]
+      url_ip            = options[:ip]
+      
+      case config_type
+      when 'auth'
+        auth_config = Configurator.new
+        auth_hash   = { :provider => provider, :service => service, :url_ip => url_ip, 
+                        :secret_access_key => secret_access_key, :access_key_id => access_key_id, :tag => tag }
+        auth_config.create_auth_config(auth_hash)
+      else
+        raise 'Incorrect options. Please try again or type \'swift-manager help setup\''
+      end 
+
+ 
+
+  end
+end
+
+desc 'Delete Object Storage'
+arg_name 'storage'
+command :delete do |c|
+
+
+  c.desc 'Type: s3 or swift'
+  c.flag [:t, :type]
+  c.desc 'Auth Config'
+  c.flag [:f, :file]
+  c.desc 'Item: container, objects (all objects)'
+  c.flag [:i, :item]
+  c.desc 'Prefix of container'
+  c.flag [:p, :prefix]
+
+
+  c.action do |global_options,options,args|
+    type = options[:type]
+    file = options[:file]
+    item = options[:item]
+    prefix = options[:prefix]
+
+    case type
+    when 'swift', 's3'
+      swift_client = SwiftClient.new(type, file)
+      if item == 'container'
+        swift_client.delete_container(prefix)
+      elsif item == 'files'
+        swift_client.delete_objects(prefix)
+      end
+    else
+      raise 'Incorrect options. Please try again or type \'swift-manager help delete\''
+    end
+
+ 
+  end
+end
+
+desc 'Interactive Shell (Read-Only)'
+arg_name 'container'
+command :shell do |c|
+
+  c.desc 'Type: s3, swift'
+  c.flag [:t, :type]
+  c.desc 'Auth Config'
+  c.flag [:f, :file]
+
+  c.action do |global_options,options,args|
+    type = options[:type]
+    file = options[:file]
+
+    case type
+    when 'swift', 's3'
+      swift_client = SwiftClient.new(type, file)
+      swift_client.generate_json_output
+      shell = CloudShell.new
+      json  = File.read(Dir.home + "/.swift-manager/shell/container.json")
+      shell.run(json)
+    end
+
+  end
+end
+
+
+desc 'List: configs, storage. Read examples.txt for more information'
+arg_name 'config, storage'
+command :list do |c|
+  
+  c.desc 'Type: auth, s3, swift'
+  c.flag [:t, :type]
+  c.desc 'Authentication file (auth_file.json)'
+  c.flag [:f, :file]
+  c.desc 'Item: container, objects'
+  c.flag [:i, :item]
+  c.desc 'Name: container name used only when listing objects'
+  c.flag [:n, :name]
+
+  c.action do |global_options,options,args|
+    type            = options[:type]
+    item            = options[:item]
+    file            = options[:file]
+    container_name  = options[:name]
+
+    case type
+    when 'auth'
+      auth_config = Parser.new
+      auth_config.list_auth_configs
+    when 'swift', 's3'
+      swift_client = SwiftClient.new(type, file)
+      if item == 'container'
+        swift_client.list_containers
+        puts ''
+      elsif item == 'objects'
+        swift_client.list_objects(container_name)
+        puts ''
+      end
+    else
+      raise 'Incorrect option. Type \'swift-manager help list\' to see options'
+    end
+ 
+  end
+end
+
+desc 'Show Configuration Parameters'
+arg_name 'config'
+command :show do |c|
+  
+  c.desc 'Type: auth'
+  c.flag [:t, :type]
+  c.desc 'File: config file'
+  c.flag [:f, :file]
+
+  c.action do |global_options,options,args|
+    type = options[:type]
+    file = options[:file]
+
+    case type
+    when 'auth'
+      config = Parser.new
+      config.show_auth_config(file)
+    end
+
+  end
+end
+
+desc 'Run batch jobs. Type \'swift-manager help run\' to see options '
+arg_name 'job'
+command :run do |c|
+
+
+  c.desc 'Type: s3, swift'
+  c.flag [:t, :type]
+  c.desc 'Auth Config'
+  c.flag [:f, :file]
+  c.desc 'Job: clean, create-containers, create-objects'
+  c.flag [:j, :job]
+  c.desc 'Source: Path to local directory containing the files. Make sure to include "" for the path'
+  c.flag [:s, :source]
+  c.desc 'Name of container to backup to. Run \'swift-manager list storage -t s3 -f <auth> -i container\''
+  c.flag [:d, :destination]
+  c.desc 'Prefix for containers or files'
+  c.flag [:p, :prefix]
+  c.desc 'N number'
+  c.flag [:n, :number]
+
+  c.action do |global_options,options,args|
+    type        = options[:type]
+    file        = options[:file]
+    job         = options[:job]
+    source      = options[:source].to_s
+    destination = options[:destination].to_s
+    number_of   = options[:number].to_i
+    prefix      = options[:prefix]
+
+    case type
+    when 'swift', 's3'
+      if job == 'create-objects'
+        swift_client = SwiftClient.new(type, file)
+        swift_client.create_objects(source, destination)
+      elsif job == 'clean'
+        swift_client = SwiftClient.new(type, file)
+        swift_client.delete_containers
+      elsif job == 'create-containers'
+        swift_client = SwiftClient.new(type, file)
+        puts "Creating #{number_of} containers...please wait".color(:green)
+        swift_client.create_containers_no_cdn(prefix, number_of)
+        puts ''
+        puts 'Create containers completed'.color(:green)
+        puts ''
+      end
+    else
+      raise 'Incorrect option. Type \'swift-manager help run\' to see options'
+    end
+
+
+  end
+end
+
+
+
+pre do |global,command,options,args|
+  # Pre logic here
+  # Return true to proceed; false to abourt and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+
+
+
+  true
+ 
+end
+
+post do |global,command,options,args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only 
+
+end
+
+on_error do |exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit GLI.run(ARGV)