cassie 1.0.0.beta.33 → 1.0.0.1

data/lib/cassie/support/{command_runner.rb → system_command.rb}

@@ -1,6 +1,6 @@
 module Cassie
   module Support
-    class CommandRunner
+    class SystemCommand
       attr_reader :binary, :args, :command, :status, :duration, :output
 
       # When a block is given, the command runs before yielding
@@ -17,6 +17,7 @@ module Cassie
       end
 
       # Runs the command
+      # @return [Boolean] true if execution completed without crashing
       def run
         t1=Time.now
 
@@ -29,36 +30,38 @@ module Cassie
         completed?
       end
 
-      # Runs the command, raising if program
-      # was not run successfully
-      def run!
-        unless run && success?
-          raise RuntimeError.new(failure_message)
-        end
+      # Runs the command, expecting an exit status of 0
+      # @return [Boolean] true if execution completed without crashing
+      # @raise [RuntimeError] if program was not run successfully
+      def succeed
+        fail unless run && success?
+
         true
       end
 
-      # Returns false if the command hasn't been executed yet
+      # @return [Boolean] false if the command hasn't been run yet
       def run?
         !!@duration
       end
 
-      # Returns the exit code for the command. Runs the command if it hasn't run yet.
+      # Runs the command if it hasn't been run yet.
+      # @return [Fixnum] the exit code for the command.
       def exitcode
         status.exitstatus
       end
 
-      # Returns true if exited 0
+      # @return [Boolean] true if command has been run, and exited with status of 0,
+      #                   otherwise returns false.
       def success?
         return false unless run?
         exitcode == 0
       end
 
-      # Returns true if the command completed execution and success bits were set.
-      # Will return false if the command hasn't been executed
+      # @return [Boolean] true if the command completed execution and success bits were set, regardless of the exit status code.
+      #                   false if the command hasn't been executed, failed to exit, or crashed.
       def completed?
         return false unless run?
-        status.exited? && @status.success?
+        status.exited? && @status.success? #status.success is NOT the exit code == 0!
       end
 
       def failure_message
@@ -72,6 +75,12 @@ module Cassie
 
       protected
 
+      # raise a Runtime error with a failure message
+      # specific to the command
+      def fail
+        raise RuntimeError.new(failure_message)
+      end
+
       def red(message)
         "\e[1m\e[31m#{message}\e[0m\e[22m"
       end

data/lib/cassie/support.rb

@@ -1,6 +1,8 @@
 module Cassie
+  # Miscelaneous support classes
   module Support
-    require_relative 'support/command_runner'
+    require_relative 'support/system_command'
     require_relative 'support/statement_parser'
+    require_relative 'support/server_process'
   end
 end

data/lib/cassie/tasks/configuration/generate.rake

@@ -0,0 +1,35 @@
+require 'optparse'
+
+namespace :cassie do
+  namespace :configuration do
+    desc "Generate a sample cassandra configuration file"
+    task :generate do
+      include Cassie::Tasks::IO
+
+      begin
+        opts = {}
+        OptionParser.new do |args|
+          args.on("-p", "--path", "Path to place configuration file. Defaults to './config/cassandra.yml'") do |p|
+            opts[:destination_path] = if path[0] == "/"
+              path
+            else
+              File.join(Dir.pwd, path)
+            end
+          end
+          args.on("-n", "--name", "Application name. Used as prefix for keyspace names. Defaults to 'my_app'") do |n|
+            opts[:app_name] = n
+          end
+        end.parse!(argv)
+
+        puts "-- Generating sample cassie cluster configuration file"
+        generator = Cassie::Configuration::Generator.new(opts)
+        generator.save
+        puts "   > #{green("created")} #{generator.destination_path}"
+        puts "-- done"
+      rescue => e
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+  end
+end

data/lib/cassie/tasks/io.rb

@@ -0,0 +1,15 @@
+module Cassie::Tasks
+  module IO
+    def puts(*args)
+      io.puts(*args)
+    end
+
+    def io
+      $stdout
+    end
+
+    def argv
+      ARGV
+    end
+  end
+end

data/lib/cassie/tasks/migration/create.rake

@@ -0,0 +1,49 @@
+require 'optparse'
+
+namespace :cassie do
+  namespace :migration do
+    desc "Generates an empty migration file prefixed with the next semantic version number"
+     task :create do
+      include Cassie::Tasks::IO
+
+      opts = {}
+      OptionParser.new do |args|
+        args.on("-b", "--build", "Bump build version number") do
+          opts[:bump_type] = :build
+        end
+        args.on("-p", "--patch", "Bump patch version number") do
+          opts[:bump_type] = :patch
+        end
+        args.on("-m", "--minor", "Bump minor version number") do
+          opts[:bump_type] = :minor
+        end
+        args.on("-M", "--major", "Bump major version number") do
+          opts[:bump_type] = :major
+        end
+        args.on("-v", "--version VERSION", "Explicitly set version") do |v|
+          opts[:version] = v
+        end
+      end.parse!(argv)
+
+      begin
+        raise("A migration description is required.\n\nUsage:\n  cassie migration:create simple description") if argv.empty?
+        name = argv.join(" ")
+
+        version = Cassie::Schema::Version.new(opts[:version]) if opts[:version]
+        version ||= Cassie::Schema.next_version(opts[:bump_type])
+        version.description = name
+        puts("-- Creating migration file for version #{version.number}")
+
+        writer = Cassie::Schema::VersionWriter.new(version)
+        writer.write
+        rel_path = writer.filename.sub(Dir.pwd, "")
+        puts "   > #{green('created')} #{rel_path}"
+        puts "-- done"
+      rescue => e
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+  end
+end
+

data/lib/cassie/tasks/migration/import.rake

@@ -0,0 +1,39 @@
+require 'optparse'
+require 'cassie/schema/cassandra_migrations/importer'
+
+namespace :cassie do
+  namespace :migrations do
+    desc "Imports existing `cassandra_migrations` migration files and converts to semantic versioning"
+    task :import do
+      include Cassie::Tasks::IO
+
+      begin
+        puts "-- Importing `cassandra_migrations` migration files"
+        opts = {}
+        OptionParser.new do |args|
+          args.on("-p", "--path", "Directory containing existing migrations. Defaults to 'db/cassandra_migrate'.") do |p|
+            opts[:path] = p
+          end
+        end.parse!(argv)
+
+        importer = Cassie::Schema::CassandraMigrations::Importer.new(opts[:path])
+        importer.before_each = Proc.new do |migration_file|
+          rel_path = migration_file.filename.sub(Dir.pwd, "")
+          puts "   - Importing #{rel_path}"
+        end
+        importer.after_each = Proc.new do |version|
+          rel_path = version.migration.path.sub(Dir.pwd, "")
+          puts "     > #{green('created')} #{rel_path}"
+          puts "     > #{white('recorded')} version #{version}"
+          puts "   - done"
+        end
+
+        importer.import
+        puts "-- done"
+      rescue => e
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+  end
+end

data/lib/cassie/tasks/migration/reset.rake

@@ -0,0 +1,9 @@
+require 'optparse'
+
+namespace :cassie do
+  namespace :migrate do
+    desc "Drop and reload the schema, then migrate"
+    task :reset => ["cassie:schema:reset", "cassie:migrate"]
+  end
+end
+

data/lib/cassie/tasks/restart.rake

@@ -0,0 +1,5 @@
+namespace :cassie do
+  desc "Stop and restart the cassandra server process"
+  task :restart => [:stop, :start] do
+  end
+end

data/lib/cassie/tasks/schema/drop.rake

@@ -0,0 +1,28 @@
+namespace :cassie do
+  namespace :schema do
+    desc "drop default keyspace and schema versioning keyspace"
+    task :drop do
+      include Cassie::Tasks::IO
+      begin
+        query = Cassie::Schema::DropKeyspaceQuery.new
+        keyspaces = [Cassie.configuration[:keyspace], Cassie::Schema.schema_keyspace]
+
+        puts "-- Dropping #{keyspaces.count} keyspaces"
+        keyspaces.each do |keyspace|
+          query.keyspace = keyspace
+          puts "   - Dropping '#{keyspace}'"
+          if Cassie.keyspace_exists?(keyspace)
+            query.execute
+          else
+            puts "     > '#{keyspace}' does not exist"
+          end
+          puts "   - done"
+        end
+        puts "-- done"
+      rescue => e
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+  end
+end

data/lib/cassie/tasks/schema/dump.rake

@@ -0,0 +1,21 @@
+namespace :cassie do
+  namespace :schema do
+    desc "Dumps the schema for all non-system keyspaces in CQL format (`db/cassandra/schema.cql` by default)"
+    task :dump do
+      include Cassie::Tasks::IO
+
+      begin
+        puts "-- Dumping Cassandra schema (version #{Cassie::Schema.version})"
+        dumper = Cassie::Schema::StructureDumper.new
+        puts "   - Writing to #{dumper.destination_path}"
+        dumper.dump
+        puts "   - done"
+        puts "-- done"
+
+      rescue => e
+        puts red("Error:  \n#{e.message}")
+        abort
+      end
+    end
+  end
+end

data/lib/cassie/tasks/schema/history.rake

@@ -0,0 +1,18 @@
+require_relative 'version_display'
+
+namespace :cassie do
+  namespace :schema do
+    desc "Print the history of applied schema migrations"
+    task :history do
+      include Cassie::Tasks::IO
+      include Cassie::Tasks::Schema::VersionDisplay
+
+      begin
+        print_versions(Cassie::Schema.applied_versions)
+      rescue Cassie::Schema::UninitializedError => e
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+  end
+end

data/lib/cassie/tasks/schema/import.rake

@@ -0,0 +1,40 @@
+namespace :cassie do
+  namespace :schema do
+    desc "Create an initial schema version based on the current schema"
+    task :import => :init do
+      include Cassie::Tasks::IO
+
+      begin
+        version = Cassie::Schema.next_version
+        keyspace = Cassie.configuration[:keyspace]
+
+        puts "-- Importing Schema from Cassandra"
+
+        version.description = "import #{keyspace}"
+        dumper = Cassie::Schema::StructureDumper.new
+        writer = Cassie::Schema::VersionWriter.new(version)
+        contents = dumper.keyspace_structure.gsub(/\n\n/, "")
+        contents = contents.gsub(/(\A\n|\n\z)/, "")
+        writer.up_code = "cql = <<-EOS\n#{contents}\nEOS\n"
+        writer.up_code += "    execute(cql)"
+        writer.down_code = "execute('DROP KEYSPACE #{Cassie.configuration[:keyspace]};')"
+
+        puts "   - Creating initial version"
+        rel_path = writer.filename.sub(Dir.pwd, "")
+        writer.write
+        puts "     > #{green("created")} #{rel_path}"
+        Cassie::Schema.record_version(version)
+        puts "     > #{white('recorded')} version #{version}"
+        puts "   - done"
+        puts "-- done"
+      rescue => e
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+  end
+end
+
+Rake::Task["cassie:schema:import"].enhance do
+  Rake::Task["cassie:schema:dump"].invoke
+end

data/lib/cassie/tasks/schema/init.rake

@@ -0,0 +1,54 @@
+namespace :cassie do
+  namespace :schema do
+
+    desc "Initialize versioning schema and the keyspace for this environment"
+    task :init => [:init_versioning, :init_keyspace]
+
+    desc "Initialize cassie schema versioning"
+    task :init_versioning do
+      include Cassie::Tasks::IO
+
+      begin
+        puts "-- Initializing Cassie Versioning"
+        Cassie::Schema.initialize_versioning
+        puts "-- done"
+      rescue Cassie::Schema::AlreadyInitiailizedError
+        puts "   > Cassie Versioning already initialized "
+        puts "   > Schema is at version #{Cassie::Schema.version}"
+        puts "-- done"
+      rescue => e
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+
+    desc "Initialize the keyspace for the current environment"
+    task :init_keyspace do
+      include Cassie::Tasks::IO
+      Cassie.keyspace = nil
+
+      begin
+        name = Cassie.configuration[:keyspace]
+        puts "-- Initializing '#{name}' Keyspace"
+        query = Cassie::Schema::CreateKeyspaceQuery.new
+        query.name = name
+        if Cassie.configuration[:replication]
+          #@todo fill in
+        end
+
+        if Cassie.keyspace_exists?(query.name)
+          puts "   > '#{name}' already exists"
+        else
+          query.execute
+        end
+        puts "-- done"
+
+      rescue => e
+        puts red("Couldn't create keyspace, check #{Cassie.paths[:cluster_configurations]}:\n#{query.to_cql}")
+        puts "\t"
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+  end
+end

data/lib/cassie/tasks/schema/load.rake

@@ -0,0 +1,19 @@
+namespace :cassie do
+  namespace :schema do
+    desc "Creates the schema by executing the CQL in the schema file (`db/cassandra/schema.cql` by default)"
+    task :load do
+      include Cassie::Tasks::IO
+
+      begin
+        loader = Cassie::Schema::StructureLoader.new
+        puts "-- Loading Schema from #{loader.source_path}"
+        loader.load
+        puts "   > Schema is now at version #{Cassie::Schema.version}"
+        puts "-- done"
+      rescue => e
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+  end
+end

data/lib/cassie/tasks/schema/migrate.rake

@@ -0,0 +1,42 @@
+namespace :cassie do
+  namespace :schema do
+    desc "Migrates the schema by running the `up` methods for any migrations starting after the current schema version"
+    task :migrate do
+      include Cassie::Tasks::IO
+
+      begin
+        version = argv[0]
+
+        migrator = Cassie::Schema::Migrator.new(version)
+        puts "-- Migrating to version #{migrator.target_version}"
+
+        if migrator.commands.count == 0
+          if migrator.target_version == migrator.current_version
+            puts "   > Already at #{migrator.target_version}, nothing to do..."
+            abort
+          else
+            raise "No migration files found to migrate to #{migrator.target_version}, staying at #{migrator.current_version}"
+          end
+        else
+          migrator.before_each = Proc.new do |v, direction|
+            puts "   - Migragting version #{v} #{direction.upcase}"
+          end
+          migrator.after_each = Proc.new do |_migration, duration|
+            puts "   - done (#{duration} ms)"
+          end
+          migrator.migrate
+          puts "-- done"
+        end
+      rescue => e
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+  end
+  desc "alias for schema:migrate"
+  task :migrate => "schema:migrate"
+end
+
+Rake::Task["cassie:schema:migrate"].enhance do
+  Rake::Task["cassie:schema:dump"].invoke
+end

data/lib/cassie/tasks/schema/reset.rake

@@ -0,0 +1,6 @@
+namespace :cassie do
+  namespace :schema do
+    desc "Creates the schema by executing the CQL in the schema file (`db/cassandra/schema.cql` by default)"
+    task :reset => [:drop, :load]
+  end
+end

data/lib/cassie/tasks/schema/status.rake

@@ -0,0 +1,19 @@
+require_relative 'version_display'
+
+namespace :cassie do
+  namespace :schema do
+    desc "Prints the migration status of all schema migrations, local and applied"
+    task :status do
+      include Cassie::Tasks::IO
+      include Cassie::Tasks::Schema::VersionDisplay
+
+      begin
+        all_versions = Cassie::Schema.applied_versions.to_a | Cassie::Schema.local_versions.to_a
+        print_statuses(all_versions.sort.reverse)
+      rescue Cassie::Schema::UninitializedError => e
+        puts red("Error:\n  #{e.message}")
+        abort
+      end
+    end
+  end
+end

data/lib/cassie/tasks/schema/version.rake

@@ -0,0 +1,18 @@
+require_relative 'version_display'
+
+namespace :cassie do
+  namespace :schema do
+    desc "Print the history of applied schema migrations"
+    task :version do
+      include Cassie::Tasks::IO
+      include Cassie::Tasks::Schema::VersionDisplay
+
+      begin
+        print_versions([Cassie::Schema.version])
+      rescue Cassie::Schema::UninitializedError => e
+        puts red("Error:\n#{e.message}")
+        abort
+      end
+    end
+  end
+end

data/lib/cassie/tasks/schema/version_display.rb

@@ -0,0 +1,50 @@
+require 'terminal-table'
+
+module Cassie::Tasks
+  module Schema
+    module VersionDisplay
+      # Prints an ASCII table represenation of the versions
+      # to STDOUT in the order given with column headers.
+      def print_versions(versions)
+        # Note: if we end up using this elsewhere, move to Version::VersionList
+        # or something simliar, and have version collection methods return that
+        members = [:number, :description, :executor, :executed_at]
+        titles  = ['Number', 'Description', 'Migrated by', 'Migrated at']
+        table = Terminal::Table.new(headings:  titles)
+        current_version = Cassie::Schema.version
+
+        versions.each.with_index do |v|
+          row = v.to_h.values_at(*members)
+          row[0] = "* #{row[0]}" if v == current_version
+          table.add_row(row)
+        end
+
+        table.align_column(0, :right)
+        puts table
+      end
+
+      def print_statuses(versions)
+        # Note: if we end up using this elsewhere, move to Version::VersionList
+        # or something simliar, and have version collection methods return that
+        members = [:number, :description]
+        titles  = ['Number', 'Description', 'Status', 'Migration File']
+        table = Terminal::Table.new(headings:  titles)
+        current_version = Cassie::Schema.version
+
+        versions.each.with_index do |v|
+          row = []
+          row << v.number
+          row[0] = "* #{row[0]}" if v == current_version
+          row << v.description
+          row << (v.recorded? ? "UP" : "DOWN")
+          row << (v.migration.try(:path) || red("File Not Found")).gsub("#{Dir.pwd}/", "")
+          table.add_row(row)
+        end
+
+        table.align_column(0, :right)
+        table.align_column(2, :center)
+        puts table
+      end
+    end
+  end
+end

data/lib/cassie/tasks/start.rake

@@ -0,0 +1,17 @@
+namespace :cassie do
+  desc "Start the cassandra server process in the background with reduced verbosity"
+  task :start do
+    include Cassie::Tasks::IO
+
+    puts("Starting Cassandra...")
+    process = Cassie::Support::ServerProcess.new
+
+    if process.running?
+      puts "[#{green('✓')}] Cassandra Running"
+    else
+      process.errors.each{|e| puts red("  " + e.gsub("; nested exception is:", "")) }
+      puts "[#{red('✘')}] Cassandra Failed to Start"
+      abort
+    end
+  end
+end

data/lib/cassie/tasks/stop.rake

@@ -0,0 +1,33 @@
+namespace :cassie do
+  desc "Stop the cassandra server process."
+  task :stop do
+    include Cassie::Tasks::IO
+
+    opts = {}
+    OptionParser.new do |args|
+      args.on("-a", "--all", "Stop all cassandra processes, not just the server (e.g. cqlsh). Defaults to false.") do |a|
+        opts[:kill_all] = a || false
+      end
+    end.parse!(argv)
+
+    procs = Cassie::Support::ServerProcess.all
+
+    if procs.empty?
+      puts red("No Cassandra process was found. Is Cassandra running?")
+      abort
+    end
+
+    if procs.length > 1 && !opts[:kill_all]
+      puts red("Couldn't single out a Cassandra process.")
+      puts red("  - Is cqlsh running?")
+      puts red("  - Kill all cassandra processes with --all")
+      abort
+    else
+      puts("Stopping Cassandra...")
+      procs.each do |process|
+        process.stop
+      end
+      puts "[#{green('✓')}] Cassandra Stopped"
+    end
+  end
+end

data/lib/cassie/tasks/tail.rake

@@ -0,0 +1,14 @@
+namespace :cassie do
+  desc "Tail the cassandra server logs"
+  task :tail do
+    include Cassie::Tasks::IO
+
+    log_path = Cassie::Support::ServerProcess.log_path
+    puts white("Tailing Cassandra system log, Ctrl-C to stop...")
+    puts "  #{log_path}:\n\n"
+
+    args = ['-f', log_path, '>', '/dev/tty']
+    tail = Cassie::Support::SystemCommand.new("tail", args)
+    tail.run
+  end
+end