gizzmo 0.1.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,177 @@
+Copyright (c) 2010 Twitter, Inc.
+
+
+                              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.

data/README.rdoc

@@ -0,0 +1,45 @@
+= gizzmo
+
+Gizzmo is a command-line client for managing gizzard clusters.
+
+== Installation and setup
+
+Installation is a simple gem install.  You may find it useful to create a ~/.gizzmorc file, which is simply YAML key/values.  The keys are the long-style command line option keys converted into Ruby-style variables.  A common .gizzmorc will simply be:
+
+    host: localhost
+    port: 7917
+
+== Usage
+
+Run `gizzmo help` for up-to-date usage.
+
+== Recipes
+
+=== Block and unblock a shard
+
+    BLOCKER=`gizzmo wrap com.twitter.gizzard.shards.BlockedShard a_shard`
+    
+    gizzmo unwrap $BLOCKER
+
+=== Reweight a shard safely (the hard way)
+
+    NEW_WEIGHT=1
+    REPL=`gizzmo wrap com.twitter.service.flock.edges.ReplicatingShard a_shard`
+    PARENT=`gizzmo links $REPL | cut -f 1 | grep -v $REPL | head -1`
+    gizzmo addlink $PARENT a_shard $NEW_WEIGHT
+    gizzmo unwrap $REPL
+
+== Running tests
+
+The tests may be somewhat difficult to run outside of Twitter.  They assume the following:
+
+1. You have a running FlockDB development environment exposing a ShardManager over thrift on localhost:7917
+2. You don't mind blowing away the data in your dev environment.
+3. Your MySQL username and password are in the environment variables DB_USERNAME and DB_PASSWORD
+
+Assuming you've put together the dependencies, ./test/test.sh should run fine.
+ 
+== Copyright
+
+Copyright (c) 2010 Twitter, Inc. See LICENSE for details.
+ 

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "gizzmo"
+    gem.summary = %Q{Gizzmo is a command-line client for managing gizzard clusters.}
+    gem.description = %Q{Gizzmo is a command-line client for managing gizzard clusters.}
+    gem.email = "kmaxwell@twitter.com"
+    gem.homepage = "http://github.com/twitter/gizzmo"
+    gem.authors = ["Kyle Maxwell"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test do
+  puts 
+  puts "=" * 79
+  puts "You might want to read the README before running tests."
+  puts "=" * 79
+  sleep 2
+  exec File.join(File.dirname(__FILE__), "test", "test.sh")
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gizzmo #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.4

data/bin/gizzmo

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+$: << File.dirname(__FILE__) + "/../lib"
+load "gizzmo.rb"

data/gizzmo.gemspec

@@ -0,0 +1,72 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gizzmo}
+  s.version = "0.1.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kyle Maxwell"]
+  s.date = %q{2010-06-30}
+  s.default_executable = %q{gizzmo}
+  s.description = %q{Gizzmo is a command-line client for managing gizzard clusters.}
+  s.email = %q{kmaxwell@twitter.com}
+  s.executables = ["gizzmo"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/gizzmo",
+     "gizzmo.gemspec",
+     "lib/gizzard.rb",
+     "lib/gizzard/commands.rb",
+     "lib/gizzard/thrift.rb",
+     "lib/gizzmo.rb",
+     "lib/vendor/thrift_client/simple.rb",
+     "test/config.yaml",
+     "test/expected/dry-wrap-table_b_0.txt",
+     "test/expected/empty-file.txt",
+     "test/expected/find-only-sql-shard-type.txt",
+     "test/expected/help-info.txt",
+     "test/expected/info.txt",
+     "test/expected/links-for-replicating_table_b_0.txt",
+     "test/expected/links-for-table_b_0.txt",
+     "test/expected/links-for-table_repl_0.txt",
+     "test/expected/original-find.txt",
+     "test/expected/subtree.txt",
+     "test/expected/unwrapped-replicating_table_b_0.txt",
+     "test/expected/unwrapped-table_b_0.txt",
+     "test/expected/wrap-table_b_0.txt",
+     "test/helper.rb",
+     "test/recreate.sql",
+     "test/test.sh"
+  ]
+  s.homepage = %q{http://github.com/twitter/gizzmo}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Gizzmo is a command-line client for managing gizzard clusters.}
+  s.test_files = [
+    "test/helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/gizzard.rb

@@ -0,0 +1,4 @@
+$: << File.dirname(__FILE__)
+module Gizzard; end
+require "gizzard/thrift"
+require "gizzard/commands"

data/lib/gizzard/commands.rb

@@ -0,0 +1,195 @@
+require "pp"
+module Gizzard
+  class Command
+    include Thrift
+
+    def self.run(command_name, *args)
+      Gizzard.const_get("#{classify(command_name)}Command").new(*args).run
+    end
+
+    def self.classify(string)
+      string.split(/\W+/).map{|s| s.capitalize }.join("")
+    end
+
+    attr_reader :service, :global_options, :argv, :command_options
+    def initialize(service, global_options, argv, command_options)
+      @service         = service
+      @global_options  = global_options
+      @argv            = argv
+      @command_options = command_options
+    end
+
+    def help!(message = nil)
+      raise HelpNeededError, message
+    end
+  end
+  
+  class SubtreeCommand < Command
+    def run
+      @roots = []
+      argv.each do |arg|
+        @id = ShardId.parse(arg)
+        @roots << up(@id)
+      end
+      @roots.uniq.each do |root|
+        puts root.to_unix
+        down(root, 1)          
+      end
+    end
+    
+    def up(id)
+      links = service.list_upward_links(id)
+      if links.empty?
+        id
+      else
+        links.map{|link| link.up_id }.find{|up_id| up(up_id) }
+      end
+    end
+
+    def down(id, depth = 0)
+      service.list_downward_links(id).map do |link|
+        printable = "  " * depth + link.down_id.to_unix
+        puts printable
+        down(link.down_id, depth + 1)
+      end
+    end
+  end
+
+  class ReloadCommand < Command
+    def run
+      puts "Are you sure? Reloading will affect production services immediately! (Type 'yes')"
+      if gets.chomp == "yes"
+        service.reload_forwardings
+      else
+        STDERR.puts "aborted"
+      end
+    end
+  end
+
+  class DeleteCommand < Command
+    def run
+      argv.each do |arg|
+        id  = ShardId.parse(arg)
+        service.delete_shard(id)
+        puts id.to_unix
+      end
+    end
+  end
+
+  class AddlinkCommand < Command
+    def run
+      up_id, down_id, weight = argv
+      help! if argv.length != 3
+      weight = weight.to_i
+      up_id  = ShardId.parse(up_id)
+      down_id  = ShardId.parse(down_id)
+      link = LinkInfo.new(up_id, down_id, weight)
+      service.add_link(link.up_id, link.down_id, link.weight)
+      puts link.to_unix
+    end
+  end
+
+  class UnlinkCommand < Command
+    def run
+      up_id, down_id = argv
+      up_id  = ShardId.parse(up_id)
+      down_id  = ShardId.parse(down_id)
+      service.remove_link(up_id, down_id)
+    end
+  end
+
+  class UnwrapCommand < Command
+    def run
+      shard_ids = argv
+      help! "No shards specified" if shard_ids.empty?
+      shard_ids.each do |shard_id_string|
+        shard_id   = ShardId.parse(shard_id_string)
+        service.list_upward_links(shard_id).each do |uplink|
+          service.list_downward_links(shard_id).each do |downlink|
+            service.add_link(uplink.up_id, downlink.down_id, uplink.weight)
+            new_link = LinkInfo.new(uplink.up_id, downlink.down_id, uplink.weight)
+            service.remove_link(uplink.up_id, uplink.down_id)
+            service.remove_link(downlink.up_id, downlink.down_id)
+            puts new_link.to_unix
+          end
+        end
+        service.delete_shard shard_id
+      end
+    end
+  end
+
+  class CreateCommand < Command
+    def run
+      help! if argv.length != 3
+      host, table, class_name = argv
+      busy = 0
+      source_type = command_options.source_type || ""
+      destination_type = command_options.destination_type || ""
+      service.create_shard(ShardInfo.new(shard_id = ShardId.new(host, table), class_name, source_type, destination_type, busy))
+      service.get_shard(shard_id)
+      puts shard_id.to_unix
+    end
+  end
+
+  class LinksCommand < Command
+    def run
+      shard_ids = @argv
+      shard_ids.each do |shard_id_text|
+        shard_id = ShardId.parse(shard_id_text)
+        service.list_upward_links(shard_id).each do |link_info|
+          puts link_info.to_unix
+        end
+        service.list_downward_links(shard_id).each do |link_info|
+          puts link_info.to_unix
+        end
+      end
+    end
+  end
+
+  class InfoCommand < Command
+    def run
+      shard_ids = @argv
+      shard_ids.each do |shard_id|
+        shard_info = service.get_shard(ShardId.parse(shard_id))
+        puts shard_info.to_unix
+      end
+    end
+  end
+
+  class WrapCommand < Command
+    def self.derive_wrapper_shard_id(shard_info, wrapping_class_name)
+      prefix_prefix = wrapping_class_name.split(".").last.downcase.gsub("shard", "") + "_"
+      ShardId.new("localhost", prefix_prefix + shard_info.id.table_prefix)
+    end
+
+    def run
+      class_name, *shard_ids = @argv
+      help! "No shards specified" if shard_ids.empty?
+      shard_ids.each do |shard_id_string|
+        shard_id   = ShardId.parse(shard_id_string)
+        shard_info = service.get_shard(shard_id)
+        service.create_shard(ShardInfo.new(wrapper_id = self.class.derive_wrapper_shard_id(shard_info, class_name), class_name, "", "", 0))
+
+        existing_links = service.list_upward_links(shard_id)
+        unless existing_links.include?(LinkInfo.new(wrapper_id, shard_id, 1))
+          service.add_link(wrapper_id, shard_id, 1)
+          existing_links.each do |link_info|
+            service.add_link(link_info.up_id, wrapper_id, link_info.weight)
+            service.remove_link(link_info.up_id, link_info.down_id)
+          end
+        end
+        puts wrapper_id.to_unix
+      end
+    end
+  end
+
+  class FindCommand < Command
+    def run
+      help!("host is a required option") unless command_options.shard_host
+      service.shards_for_hostname(command_options.shard_host).each do |shard|
+        next if command_options.shard_type && shard.class_name !~ Regexp.new(command_options.shard_type)
+        puts shard.id.to_unix
+      end
+    end
+  end
+end