cknife 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83aba2bc52997c794e3eadab342a6ec8339bd828
-  data.tar.gz: dab6ec5e7f2d89a5e0259601b4d1c70ee4ab35ba
+  metadata.gz: 42b1aec5549d2d6e08113f9d867e4faad1cf3954
+  data.tar.gz: b30a5ad505f0c656eaf4fb800704a5d4824492b1
 SHA512:
-  metadata.gz: 0fd636788f7d6888014b955e4dd63c36fe418b6240faf46b8a6fad48b2b56223df959cca63358c044d672b3b068a6f80b7017e184a88255aaebba0802fbd7c9a
-  data.tar.gz: b8892ac926673ef19c386d2d3cc5d3519f50b6590bc4e78ed08c67ea3949ee3159893209c2fb49c052942564e721f87e9723062999ca6bacadd67e0eb59efb05
+  metadata.gz: 9e023ec2bb2a311ea6afabe95b7325de60e94de53f2854b018160aa99f4fa30d301b48c5266bfa07e60107a21f5575538187e7a6b464167be188fd8638bcc92c
+  data.tar.gz: ddc7b4e2541e650e1b3df6d28e110c63972aff17baf38ac4d4e48735519a62a8c4a13893c58ae6342ebd120f2a563a01f8fa59d4b0806422f4302897dfd135ee

data/Gemfile.lock

@@ -116,7 +116,7 @@ GEM
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
     semver2 (3.4.2)
-    thor (0.14.6)
+    thor (0.20.0)
     thread_safe (0.3.6)
     treetop (1.4.15)
       polyglot

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0

data/cknife.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: cknife 1.1.2 ruby lib
+# stub: cknife 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "cknife".freeze
-  s.version = "1.1.2"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Michael Rivera".freeze]
-  s.date = "2018-10-09"
+  s.date = "2018-10-10"
   s.description = "A collection of command line tools, especially for popular API services.".freeze
   s.email = "soymrmike@gmail.com".freeze
   s.executables = ["cknifeaws".freeze, "cknifedub".freeze, "cknifemail".freeze, "cknifemon".freeze, "cknifemysql".freeze, "cknifenowtimestamp".freeze, "cknifepg".freeze, "cknifewcdir".freeze, "cknifezerigo".freeze]

data/lib/cknife/cknife_pg.rb

@@ -23,34 +23,61 @@ class CKnifePg < Thor
       "-h #{conf[:host]} -p #{conf[:port]} -U #{conf[:username]} --no-password"
     end
 
+    # Leaves out options to simplify output.
+    def psql_easy
+      "psql #{connection_options} -d #{conf[:database]}"
+    end
+
     def psql_invocation
-      "psql #{connection_options} -d #{conf[:database]} --no-align --tuples-only"
+      "#{psql_easy} --no-align --tuples-only"
     end
 
     def pg_pass_file
       @pg_pass_file = ".pgpass"
     end
 
+    def dc(cmd)
+      puts "PGPASSFILE=#{pg_pass_file} #{cmd}"
+    end
+
     def pg_pass_file_execute(cmd, input = nil)
       return if !@session_ok
-      puts cmd
+      dc(cmd) if options[:verbose]
       stdin, stdout, stderr, wait_thread = Open3.popen3({'PGPASSFILE' => pg_pass_file}, cmd)
       if input
-        puts input
+        puts input if options[:verbose]
         stdin.write input
         stdin.close
       end
       output = stdout.read
       output += stderr.read
-      $stdout.write output
+      $stdout.write output if options[:verbose]
       stdout.close
       stderr.close
       result = wait_thread.value.to_i
-      @session_ok = @session_ok && (result == 0)
+
+      if result != 0
+        @session_ok = false
+        msg = "An error occurred."
+        msg += " If the --verbose flag is available for this command, you may try turning it on." if !options[:verbose]
+        say(msg, :red)
+      end
+
+      # I'm not sure why I use the block to this method. 2018-10-09
       yield if block_given?
       output
     end
 
+    def pg_str
+      "#{conf[:host]}:#{conf[:port]}:*:#{conf[:username]}:#{conf[:password]}"
+    end
+
+    def write_pg_pass_file
+      # pgpass format
+      File.open(pg_pass_file, "w", 0600) { |f| f.write pg_str }
+      pg_pass_file
+    end
+
     def with_pg_pass_file
       if @session_live
         return yield
@@ -59,41 +86,55 @@ class CKnifePg < Thor
       @session_live = true
       @session_ok = true
 
+      existing_pgpass = false
       if File.exists?(pg_pass_file)
-        say("This generates a pgpass file but one is already on disk. Exiting.")
-        return
+        existing_pgpass = true
+        s = File.read(pg_pass_file)
+        if s != pg_str
+          say("A .pgpass file is present, but it does not match your database configuration. The contents of the .pgpass file must exactly match what this tool would generate. Please reconcile the .pgpass file with your configuration, and then try again. You can also delete the .pgpass file since this tool generates one in order to do its job (and removes it after finishing).", :red)
+          return
+        end
       end
 
-      # pgpass format
-      File.open(pg_pass_file, "w", 0600) { |f| f.write "#{conf[:host]}:#{conf[:port]}:*:#{conf[:username]}:#{conf[:password]}" }
-
-      result = yield # don't know what we're planning to do with the result here...
+      write_pg_pass_file
 
-      FileUtils.rm(pg_pass_file)
-      if File.exists?(pg_pass_file)
-        say("Failed to remove pg_pass file. Please remove it for security purposes.")
+      result = nil
+      begin
+        result = yield # don't know what we're planning to do with the result here...
+      ensure
+        if !existing_pgpass
+          FileUtils.rm(pg_pass_file)
+          if File.exists?(pg_pass_file)
+            say("Failed to remove .pgpass file. Please remove it for your infrastructure's security.")
+          end
+        else
+          say("Left existing .pgpass file on disk.", :yellow)
+        end
       end
 
-      say
-      say("Command failed.", :red) if !@session_ok
       @session_live = false
-
       result
     end
-  end
 
-  desc "disconnect", "Disconnect all sessions from the database. You must have a superuser configured for this to work."
-  def disconnect
-    with_pg_pass_file do
-      my_pid = pg_pass_file_execute(psql_invocation, "select pg_backend_pid();").split.first
-      ids = pg_pass_file_execute(psql_invocation, "SELECT procpid FROM pg_stat_activity WHERE datname = '#{conf[:database]}' AND procpid != #{my_pid};")
-      ids.split.each do |pid|
-        pg_pass_file_execute(psql_invocation, "select pg_terminate_backend(#{pid});")
-      end
+    # Created to check for 9.2 system schema changes.
+    # Returns [9, 5, 12] for "9.5.12"
+    #
+    def pg_version
+      return @version if @version
+      output, stderr = Open3.capture2("psql --version")
+      output =~ Regexp.new("([0-9]+).([0-9]+)(.([0-9]+))")
+      v1, v2, v3 = $1, $2, $4
+      @version = [v1.to_i, v2.to_i, v3.to_i]
+    end
+
+    def pid_col_name
+      (pg_version[0] >= 9 and pg_version[1] >= 2) ? "pid" : "procpid"
     end
+
   end
 
   desc "capture", "Capture a dump of the database to db(current timestamp).dump."
+  method_option :verbose, :default => false, :type => :boolean, :desc => "Show which commands are invoked, any input given to them, and any output they give back."
   def capture
     file_name = "db" + Time.now.strftime("%Y%m%d%H%M%S") + ".dump"
 
@@ -104,29 +145,39 @@ class CKnifePg < Thor
     end
   end
 
-  desc "sessions", "List active sessions in this database and provide a string suitable for giving to kill for stopping those sessions."
+  desc "sessions", "List active sessions connected to this database. Also see the --kill option."
+  method_option :verbose, :default => false, :type => :boolean, :desc => "Show which commands are invoked, any input given to them, and any output they give back."
+  method_option :kill, :default => false, :type => :boolean, :desc => "Kill all active sessions found. You must have sufficient privileges or correct process ownership for this to work."
   def sessions
     with_pg_pass_file do
-      my_pid = pg_pass_file_execute(psql_invocation, "select pg_backend_pid();").split.first
-      ids_output = pg_pass_file_execute(psql_invocation, "SELECT procpid, application_name FROM pg_stat_activity WHERE datname = '#{conf[:database]}' AND procpid != #{my_pid};")
+      if !options[:kill]
+        my_pid = pg_pass_file_execute(psql_invocation, "select pg_backend_pid();").split.first
+        ids_output = pg_pass_file_execute(psql_invocation, "SELECT #{pid_col_name}, application_name FROM pg_stat_activity WHERE datname = '#{conf[:database]}' AND #{pid_col_name} != #{my_pid};")
+
+        return if ids_output.nil?
 
-      if ids_output.nil?
-        say("Error while looking for session information. Possibly a failed login.")
-      else
         table = ids_output.split.map { |line| line.split("|") }
         print_table([["PID", "Application Name"]] + table, :indent => 2)
-        ids = table.map { |row| row.first }
+        say("To kill all active sessions connected to this database, you can use the --kill option with this command.")
+      else
+        sql = "SELECT pg_terminate_backend(pg_stat_activity.#{pid_col_name})
+FROM pg_stat_activity
+WHERE pg_stat_activity.datname = '#{conf[:database]}'
+      AND pid <> pg_backend_pid();"
 
-        say("If you would like to kill these sessions, you can do so with this command:")
-        say("kill -9 #{ids.join(' ')}")
+        with_pg_pass_file do
+          pg_pass_file_execute(psql_invocation, sql) do
+            say("Terminated all sessions.") if @session_ok
+          end
+        end
       end
     end
   end
 
-  desc "restore", "Restore a file. Use the one with the most recent mtime by default. Searches for db*.dump files in the CWD."
-  method_options :filename => nil
-  def restore
-    to_restore = options[:filename] if options[:filename]
+  desc "restore [FILENAME]?", "Restore a file. If no filename is provided, searches for db*.dump files in the $CWD. It will pick the one with the most recent mtime."
+  method_option :verbose, :default => false, :type => :boolean, :desc => "Show which commands are invoked, any input given to them, and any output they give back."
+  def restore(filename=nil)
+    to_restore = filename if filename
     if to_restore.nil?
       files = Dir["db*.dump"]
       with_mtime = files.map { |f| [f, File.mtime(f)] }
@@ -136,7 +187,7 @@ class CKnifePg < Thor
     end
 
     if to_restore.nil?
-      say("No backups file to restore. None given on the command line and none could be found in the CWD.", :red)
+      say("No backups file to restore. No file given on the command line, and no files could be found in the $CWD.", :red)
       return
     else
       if !yes?("Restore #{to_restore}?", :green)
@@ -163,4 +214,133 @@ class CKnifePg < Thor
       end
     end
   end
+
+  desc "schema [TABLE]?", "Dump the schema for all tables, or one table you specify."
+  method_option :verbose, :default => false, :type => :boolean, :desc => "Show which commands are invoked, any input given to them, and any output they give back."
+  def schema(table=nil)
+    table_string = table.nil? ? "" : "--table=#{table.strip}"
+    with_pg_pass_file do
+      output = pg_pass_file_execute("pg_dump #{connection_options} --no-owner --clean --if-exists --schema-only #{table_string} #{conf[:database]}")
+
+      # This command is so verbose that we only print the output if
+      # we didn't already do so in verbose mode.
+      puts output if !options[:verbose]
+    end
+  end
+
+  desc "tables", "List all tables."
+  method_option :verbose, :default => false, :type => :boolean, :desc => "Show which commands are invoked, any input given to them, and any output they give back."
+  def tables(table=nil)
+    sql = "SELECT
+    table_schema || '.' || table_name
+FROM
+    information_schema.tables
+WHERE
+    table_type = 'BASE TABLE'
+AND
+    table_schema NOT IN ('pg_catalog', 'information_schema');"
+
+    with_pg_pass_file do
+      output = pg_pass_file_execute(psql_invocation, sql)
+      say ("removing public. prefixes.") if options[:verbose]
+      tables = output.split.map do |ts|
+        ts =~ /^public\.(.*)$/
+        $1
+      end
+      print_in_columns(tables)
+    end
+  end
+
+  desc "fexec [FILE]", "Execute a SQL script from a file on disk."
+  method_option :verbose, :default => false, :type => :boolean, :desc => "Show which commands are invoked, any input given to them, and any output they give back."
+  def fexec(file)
+    if !File.exists?(file)
+      say("'#{file}' does not exist.")
+      return
+    end
+
+    with_pg_pass_file do
+      pg_pass_file_execute("#{psql_invocation} -f #{file}") do
+        say("Ran #{file} SQL script.")
+      end
+    end
+  end
+
+  desc "createdb", "Create a database having the name specified in your configuration. Assumes you have privileges to do this."
+  method_option :verbose, :default => false, :type => :boolean, :desc => "Show which commands are invoked, any input given to them, and any output they give back."
+  def createdb
+    with_pg_pass_file do
+      pg_pass_file_execute("createdb #{connection_options} #{conf[:database]}") do
+        say("Created #{conf[:database]} database.") if @session_ok
+      end
+    end
+  end
+
+  desc "dropdb", "Drop the database specified in your configuration."
+  method_option :verbose, :default => false, :type => :boolean, :desc => "Show which commands are invoked, any input given to them, and any output they give back."
+  def dropdb
+    with_pg_pass_file do
+      pg_pass_file_execute("dropdb #{connection_options} #{conf[:database]};") do
+        say("Dropped #{conf[:database]} database.") if @session_ok
+      end
+    end
+  end
+
+  desc "perms", "List all users (roles) for the database, and their attributes (which approximate privileges)."
+  method_option :verbose, :default => false, :type => :boolean, :desc => "Show which commands are invoked, any input given to them, and any output they give back."
+  def perms
+    with_pg_pass_file do
+      output = pg_pass_file_execute("#{psql_easy}", "\\du")
+      puts output if !options[:verbose]
+    end
+  end
+
+  desc "passfile", "Write a .pgpass file in $CWD. Useful for starting a psql session on your own."
+  def passfile
+    connect_msg = "Connect command: PGPASSFILE=.pgpass #{psql_easy}"
+    if File.exists?(pg_pass_file)
+      say("A .pgpass file is already present.")
+      say(connect_msg)
+      return
+    end
+
+    f = write_pg_pass_file
+    say("Wrote #{pg_pass_file} to $CWD.")
+    say(connect_msg)
+    say("Remember to delete the .pgpass file when you are finished.")
+  end
+
+  desc "dpassfile", "Delete the .pgpass file in $CWD, assuming it exactly matches what would be generated by this tool."
+  def dpassfile
+    if !File.exists?(pg_pass_file)
+      say("No .pgpass file to delete.")
+      return
+    end
+
+    s = File.read(pg_pass_file)
+    if s == pg_str
+      File.unlink(pg_pass_file)
+      say("Deleted .pgpass file.")
+    else
+      say("The .pgpass file's contents do not match what this tool would have generated. Assuming you are trying to delete a .pgpass file that this tool did not generate, please inspect the file to ensure it contains what you expect, and then delete it yourself.", :red)
+    end
+  end
+
+  desc "psql", "Launches a psql session. Requires that you prepare a .pgpass file, unless you use --passfile. You can create a .pgpass file with the passfile command."
+  method_option :passfile, :type => :boolean, :default => false, :desc => "Write .pgpass file if it doesn't exist."
+  method_option :verbose, :default => false, :type => :boolean, :desc => "Show which commands are invoked, any input given to them, and any output they give back."
+  def psql
+    if !File.exists?(pg_pass_file)
+      if !options[:passfile]
+        say("You must prepare a .pgpass file for this command, or use --passfile to have this tool create it for you. Alternatively, you can create a .pgpass file with the passfile command and delete it later with the dpassfile command.")
+        return
+      end
+
+      write_pg_pass_file
+    end
+
+    dc(psql_easy) if options[:verbose]
+    exec({'PGPASSFILE' => pg_pass_file}, psql_easy)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cknife
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Michael Rivera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-09 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client