geordi 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c07036b9657ebe6dfccf09dbc5c74e9b449b1eed88fc04ca5e880284dcbdc1e7
-  data.tar.gz: 1bf48b1318b06182ccfe8bc0e294c7344195ed654e28c983f6c44bdea0bde7cf
+  metadata.gz: 70f9242df556d6b8259f341827cc8996f6970de1e9d51c5ff13cbc44307a7ee7
+  data.tar.gz: 59e54eca6438f61af0c7640f88771e5f7f67008237445a0d25521b3adea4f0fd
 SHA512:
-  metadata.gz: ae4590a4eb870deec8055b6e4cea3e433b85dc202b94be155fa78d2b8ce8f05b9126c73c2151b04ccf1d09fd5cedf2e80b2f49b80b3efabba61fe551cf5e92e2
-  data.tar.gz: 2829290660f89550294c2f83423bfa5608533f6f952b951def2ccf39fec167a5146dfe9d84b94eb40f6707085d7a1ba27cc81b0014892d86092e1c9eb05f8602
+  metadata.gz: d143f1c68d472cc9918d6de6d2271b6633d0f9f01182d835b9667d872d65c495cc85b6c2752545e670b4bc685367baeb7122a32b7e4d3265ea8cc6412629be5d
+  data.tar.gz: ec93583e23658f4c1c69febc903f8d3d05c98b6e0e7ec7066c4c678277161fcc9d4e8f365e79e38792ee0c7a5b8bb9deec07408983c50c694a3884be254d2124

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geordi (1.7.1)
+    geordi (1.9.0)
       thor (>= 0.18.0)
 
 GEM

data/README.md

@@ -75,6 +75,18 @@ to use an `=` instead of a space to separate parameter name and value,
 e.g. `--format=pretty`.
 
 
+### geordi delete_dumps [DIRECTORY]
+
+Delete database dump files (`*.dump`).
+
+Example: `geordi delete_dumps` or `geordy delete_dumps ~/tmp/dumps`
+
+Recursively search for files ending in `*.dump` and offer to delete those. When
+no argument is given, two default directories are searched for dump files: the
+current working directory and `~/dumps` (for dumps created with geordi).
+
+Geordi will ask for confirmation before actually deleting files.
+
 ### `geordi deploy [STAGE]`
 
 Guided deployment across branches.
@@ -105,6 +117,26 @@ instead of `cap deploy:migrations`. You can force using `deploy` by passing the
 -M option: `geordi deploy -M staging`.
 
 
+### `geordi drop_databases`
+
+Delete local MySQL/MariaDB and Postgres databases that are not whitelisted.
+
+Example: `geordi drop_databases`
+
+Check both MySQL/MariaDB and Postgres on the machine running geordi for databases
+and offer to delete them. Excluded are databases that are whitelisted. This comes
+in handy when you're keeping your currently active projects in the whitelist files
+and perform regular housekeeping with Geordi.
+
+When called with `-P` or `-M` options, only handles Postgres resp. MySQL/MariaDB.
+
+When called with `--postgres <port or local socket>` or `--mysql <port or local socket>`,
+will instruct the underlying management commands to use those connection methods
+instead of the defaults. This is useful when running multiple installations.
+
+Geordi will ask for confirmation before actually dropping databases and will
+offer to edit the whitelist instead.
+
 ### `geordi dump [TARGET]`
 
 Handle dumps (see `geordi help dump` for details).

data/features/cucumber.feature

@@ -97,7 +97,7 @@ Feature: The cucumber command
 
     When I run `geordi cucumber --verbose features`
     Then the output should contain "# Running features"
-      And the output should match /^> .*cucumber .*--tags ~@solo/
+      And the output should match /^> .*cucumber .*--tags \"~@solo\"/
       And the output should contain "# Running @solo features"
       And the output should match /^> .*cucumber .*--tags @solo/
 
@@ -122,7 +122,7 @@ Feature: The cucumber command
 
     When I run `geordi cucumber features/no_solo --verbose`
     Then the output should contain "# Running features"
-      And the output should match /^> .*cucumber .*--tags ~@solo/
+      And the output should match /^> .*cucumber .*--tags \"~@solo\"/
     But the output should not contain "# Running @solo features"
 
 

data/lib/geordi/commands/db_clean.rb

@@ -0,0 +1,60 @@
+desc 'drop-databases', 'Delete local non-whitelisted databases'
+long_desc <<-LONGDESC
+
+Delete local MySQL/MariaDB and Postgres databases that are not whitelisted.
+
+Example: `geordi drop_databases`
+
+Check both MySQL/MariaDB and Postgres on the machine running geordi for databases
+and offer to delete them. Excluded are databases that are whitelisted. This comes
+in handy when you're keeping your currently active projects in the whitelist files
+and perform regular housekeeping with Geordi.
+
+When called with `-P` or `-M` options, only handles Postgres resp. MySQL/MariaDB.
+
+When called with `--postgres <port or local socket>` or `--mysql <port or local socket>`,
+will instruct the underlying management commands to use those connection methods
+instead of the defaults. This is useful when running multiple installations.
+LONGDESC
+
+option :postgres_only, :aliases => '-P', :type => :boolean,
+  :desc => 'Only clean Postgres', :default => false
+option :mysql_only, :aliases => '-M', :type => :boolean,
+  :desc => 'Only clean MySQL/MariaDB', :default => false
+option :postgres, :banner => 'PORT_OR_SOCKET',
+  :desc => 'Use Postgres port or socket'
+option :mysql, :banner => 'PORT_OR_SOCKET',
+  :desc => 'Use MySQL/MariaDB port or socket'
+
+def drop_databases
+  require 'geordi/db_cleaner'
+  fail '-P and -M are mutually exclusive' if options.postgres_only and options.mysql_only
+  mysql_flags = nil
+  postgres_flags = nil
+
+  unless options.mysql.nil?
+    begin
+      mysql_port = Integer(options.mysql)
+      mysql_flags = "--port=#{mysql_port} --protocol=TCP"
+    rescue AttributeError
+      unless File.exist? options.mysql
+        fail "Path #{options.mysql} is not a valid MySQL socket"
+      end
+      mysql_flags = "--socket=#{options.mysql}"
+    end
+  end
+
+  unless options.postgres.nil?
+    postgres_flags = "--port=#{options.postgres}"
+  end
+
+  extra_flags = {'mysql' => mysql_flags,
+                 'postgres' => postgres_flags
+  }
+  cleaner = DBCleaner.new(extra_flags)
+  cleaner.clean_mysql unless options.postgres_only
+  cleaner.clean_postgres unless options.mysql_only
+
+  success 'Done.'
+end
+

data/lib/geordi/commands/delete_dumps.rb

@@ -0,0 +1,46 @@
+desc 'delete_dumps [DIRECTORY]', 'delete database dump files (*.dump)'
+long_desc <<-LONGDESC
+Delete database dump files (`*.dump`).
+
+Example: `geordi delete_dumps` or `geordy delete_dumps ~/tmp/dumps`
+
+Recursively search for files ending in `*.dump` and offer to delete those. When
+no argument is given, two default directories are searched for dump files: the
+current working directory and `~/dumps` (for dumps created with geordi).
+
+Geordi will ask for confirmation before actually deleting files.
+
+LONGDESC
+
+def delete_dumps(dump_directory = nil)
+  deletable_dumps = []
+  if dump_directory.nil?
+    dump_directories = [
+      File.join(Dir.home, 'dumps'),
+      Dir.pwd
+    ]
+  else
+    dump_directories = [dump_directory]
+  end
+  announce 'Looking for *.dump in ' << dump_directories.join(',')
+  dump_directories.each do |d|
+    d2 = File.expand_path(d)
+    unless File.directory? File.realdirpath(d2)
+      warn "Directory #{d2} does not exist"
+      next
+    end
+    deletable_dumps.concat(Dir.glob("#{d2}/**/*.dump"))
+  end
+  if deletable_dumps.empty?
+    success 'No dumps to delete' if deletable_dumps.empty?
+    exit 0
+  end
+  deletable_dumps.uniq!
+  note 'The following dumps can be deleted:'
+  puts
+  puts deletable_dumps
+  prompt 'Delete those dumps', 'n', /y|yes/ or fail 'Cancelled.'
+  deletable_dumps.each do |dump|
+    File.delete dump unless File.directory? dump
+  end
+end

data/lib/geordi/db_cleaner.rb

@@ -0,0 +1,239 @@
+require 'fileutils'
+require 'open3'
+require 'tempfile'
+
+module Geordi
+  class DBCleaner
+    include Geordi::Interaction
+
+    def initialize(extra_flags)
+      puts 'Please enter your sudo password if asked, for db operations as system users'
+      puts "We're going to run `sudo -u postgres psql` for PostgreSQL"
+      puts '               and `sudo mysql`            for MariaDB (which uses PAM auth)'
+      `sudo true`
+      fail 'sudo access is required for database operations as database users' if $? != 0
+      @derivative_dbname = /_(test\d?|development|cucumber)$/
+      base_directory = ENV['XDG_CONFIG_HOME']
+      base_directory = "#{Dir.home}" if base_directory.nil?
+      @whitelist_directory = File.join(base_directory, '.config', 'geordi', 'whitelists')
+      FileUtils.mkdir_p(@whitelist_directory) unless File.directory? @whitelist_directory
+      @mysql_command = decide_mysql_command(extra_flags['mysql'])
+      @postgres_command = decide_postgres_command(extra_flags['postgres'])
+    end
+
+    def edit_whitelist(dbtype)
+      whitelist = whitelist_fname(dbtype)
+      if File.exist? whitelist
+        whitelisted_dbs = Geordi::Util.stripped_lines(File.read(whitelist))\
+          .delete_if { |l| l.start_with? '#' }
+      else
+        whitelisted_dbs = Array.new
+      end
+      all_dbs = list_all_dbs(dbtype)
+      tmp = Tempfile.open("geordi_whitelist_#{dbtype}")
+      tmp.write <<-HEREDOC
+# Put each whitelisted database on a new line.
+# System databases will never be deleted.
+# When you whitelist foo, foo_development and foo_test\\d? are whitelisted, too.
+# This works even if foo does not exist. Also, you will only see foo in this list.
+#
+# Syntax: keep foo
+#         drop bar
+HEREDOC
+      tmpfile_content = Array.new
+      all_dbs.each do |db|
+        next if is_whitelisted?(dbtype, db)
+        next if is_protected?(dbtype, db)
+        db.sub!(@derivative_dbname, '')
+        tmpfile_content.push(['drop', db])
+      end
+      whitelisted_dbs.each do |db|
+        tmpfile_content.push(['keep', db])
+      end
+      tmpfile_content.sort_by! { |k| k[1] }
+      tmpfile_content.uniq!
+      tmpfile_content.each do |line|
+        tmp.write("#{line[0]} #{line[1]}\n")
+      end
+      tmp.close
+      texteditor = Geordi::Util.decide_texteditor
+      system("#{texteditor} #{tmp.path}")
+      File.open(tmp.path, 'r') do |wl_edited|
+        whitelisted_dbs = Array.new
+        whitelist_storage = File.open(whitelist, 'w')
+        lines = Geordi::Util.stripped_lines(wl_edited.read)
+        lines.each do |line|
+          next if line.start_with?('#')
+          fail 'Invalid edit to whitelist file' unless line.split.length == 2
+          fail 'Invalid edit to whitelist file' unless %w[keep drop k d].include? line.split[0]
+          db_status, db_name = line.split
+          if db_status == 'keep'
+            whitelisted_dbs.push db_name
+            whitelist_storage.write(db_name << "\n")
+          end
+        end
+        whitelist_storage.close
+      end
+    end
+
+    def decide_mysql_command(extra_flags)
+      cmd = 'sudo mysql'
+      unless extra_flags.nil?
+        if extra_flags.include? 'port'
+          port = Integer(extra_flags.split('=')[1].split()[0])
+          fail "Port #{port} is not open" unless Geordi::Util.is_port_open? port
+        end
+        cmd << " #{extra_flags}"
+      end
+      Open3.popen3("#{cmd} -e 'QUIT'") do |stdin, stdout, stderr, thread|
+        break if thread.value.exitstatus == 0
+        # sudo mysql was not successful, switching to mysql-internal user management
+        mysql_error = stderr.read.lines[0].chomp.strip.split[1]
+        if %w[1045 1698].include? mysql_error  # authentication failed
+          cmd = 'mysql -uroot'
+          cmd << " #{extra_flags}" unless extra_flags.nil?
+          unless File.exist? File.join(Dir.home, '.my.cnf')
+            puts "Please enter your MySQL/MariaDB password for account 'root'."
+            warn "You should create a ~/.my.cnf file instead, or you'll need to enter your MySQL root password for each db."
+            warn "See https://makandracards.com/makandra/50813-store-mysql-passwords-for-development for more information."
+            cmd << ' -p'  # need to ask for password now
+          end
+          Open3.popen3("#{cmd} -e 'QUIT'") do |stdin2, stdout2, stderr2, thread2|
+            fail 'Could not connect to MySQL/MariaDB' unless thread2.value.exitstatus == 0
+          end
+        elsif mysql_error == '2013'  # connection to port or socket failed
+          fail 'MySQL/MariaDB connection failed, is this the correct port?'
+        end
+      end
+      return cmd
+    end
+    private :decide_mysql_command
+
+    def decide_postgres_command(extra_flags)
+      cmd = 'sudo -u postgres psql'
+      unless extra_flags.nil?
+        begin
+          port = Integer(extra_flags.split('=')[1])
+          fail "Port #{port} is not open" unless Geordi::Util.is_port_open? port
+        rescue ArgumentError
+          socket = extra_flags.split('=')[1]
+          fail "Socket #{socket} does not exist" unless File.exist? socket
+        end
+        cmd << " #{extra_flags}"
+      end
+      return cmd
+    end
+    private :decide_postgres_command
+
+    def list_all_dbs(dbtype)
+      if dbtype == 'postgres'
+        return list_all_postgres_dbs
+      else
+        return list_all_mysql_dbs
+      end
+    end
+
+    def list_all_postgres_dbs
+      `#{@postgres_command} -t -A -c 'SELECT DATNAME FROM pg_database WHERE datistemplate = false'`.split
+    end
+
+    def list_all_mysql_dbs
+      if @mysql_command.include? '-p'
+        puts "Please enter your MySQL/MariaDB account 'root' for: list all databases"
+      end
+      `#{@mysql_command} -B -N -e 'show databases'`.split
+    end
+
+    def clean_mysql
+      announce 'Checking for MySQL databases'
+      database_list = list_all_dbs('mysql')
+      # confirm_deletion includes option for whitelist editing
+      deletable_dbs = confirm_deletion('mysql', database_list)
+      return if deletable_dbs.nil?
+      deletable_dbs.each do |db|
+        if @mysql_command.include? '-p'
+          puts "Please enter your MySQL/MariaDB account 'root' for: DROP DATABASE #{db}"
+        else
+          note "Dropping MySQL/MariaDB database #{db}"
+        end
+        `#{@mysql_command} -e 'DROP DATABASE \`#{db}\`;'`
+      end
+    end
+
+    def clean_postgres
+      announce 'Checking for Postgres databases'
+      database_list = list_all_dbs('postgres')
+      deletable_dbs = confirm_deletion('postgres', database_list)
+      return if deletable_dbs.nil?
+      deletable_dbs.each do |db|
+        note "Dropping PostgreSQL database `#{db}`."
+        `#{@postgres_command} -c 'DROP DATABASE "#{db}";'`
+      end
+    end
+
+    def whitelist_fname(dbtype)
+      File.join(@whitelist_directory, dbtype) << '.txt'
+    end
+
+    def confirm_deletion(dbtype, database_list)
+      proceed = ''
+      until %w[y n].include? proceed
+        deletable_dbs = filter_whitelisted(dbtype, database_list)
+        if deletable_dbs.empty?
+          note "No #{dbtype} databases found that were not whitelisted"
+          if prompt('Edit the whitelist? [y]es or [n]o') == 'y'
+            proceed = 'e'
+          else
+            return []
+          end
+        end
+        if proceed.empty?
+          note "The following #{dbtype} databases are not whitelisted and could be deleted:"
+          deletable_dbs.sort.each do |db|
+            puts db
+          end
+          note "Those #{dbtype} databases are not whitelisted and could be deleted."
+          proceed = prompt('Proceed? [y]es, [n]o or [e]dit whitelist')
+        end
+        case proceed
+        when 'e'
+          proceed = ''  # reset user selection
+          edit_whitelist dbtype
+        when 'n'
+          success 'Not deleting anything'
+          return []
+        when 'y'
+          return deletable_dbs
+        end
+      end
+    end
+    private :confirm_deletion
+
+    def is_protected?(dbtype, database_name)
+      protected = {
+        'mysql'    => %w[mysql information_schema performance_schema sys],
+        'postgres' => ['postgres'],
+      }
+      protected[dbtype].include? database_name
+    end
+
+    def is_whitelisted?(dbtype, database_name)
+      if File.exist? whitelist_fname(dbtype)
+        whitelist_content = Geordi::Util.stripped_lines(File.open(whitelist_fname(dbtype), 'r').read)
+      else
+        whitelist_content = Array.new
+      end
+      whitelist_content.include? database_name.sub(@derivative_dbname, '')
+    end
+
+    def filter_whitelisted(dbtype, database_list)
+      # n.b. `delete` means 'delete from list of dbs that should be deleted in this context
+      # i.e. `delete` means 'keep this database'
+      deletable_dbs = database_list.dup
+      deletable_dbs.delete_if { |db| is_whitelisted?(dbtype, db) if File.exist? whitelist_fname(dbtype) }
+      deletable_dbs.delete_if { |db| is_protected?(dbtype, db) }
+      deletable_dbs.delete_if { |db| db.start_with? '#' }
+    end
+    private :filter_whitelisted
+  end
+end

data/lib/geordi/interaction.rb

@@ -1,31 +1,42 @@
+# Use the methods in this file to communicate with the user
+#
 module Geordi
   module Interaction
 
+    # Start your command by `announce`-ing what you're about to do
     def announce(text)
       message = "\n# #{text}"
       puts "\e[4;34m#{message}\e[0m" # blue underline
     end
 
+    # Any hints, comments, infos or explanations should be `note`d. Please do
+    # not print any output (data, file contents, lists) with `note`.
     def note(text)
       puts '> ' + text
     end
 
+    # Like `note`, but yellow. Use to warn the user.
     def warn(text)
       message = "> #{text}"
       puts "\e[33m#{message}\e[0m" # yellow
     end
 
+    # Like `note`, but pink. Use to print (bash) commands.
+    # Also see Util.system!
     def note_cmd(text)
       message = "> #{text}"
       puts "\e[35m#{message}\e[0m" # pink
     end
 
+    # Exit execution with status code 1 and give a short note what happened,
+    # e.g. "Failed" or "Cancelled"
     def fail(text)
       message = "\nx #{text}"
       puts "\e[31m#{message}\e[0m" # red
       exit(1)
     end
 
+    # When you're done, inform the user with a `success` and a short message
     def success(text)
       message = "\n> #{text}"
       puts "\e[32m#{message}\e[0m" # green

data/lib/geordi/util.rb

@@ -1,4 +1,5 @@
 require 'geordi/interaction'
+require 'socket'
 
 module Geordi
   class Util
@@ -79,6 +80,37 @@ module Geordi
         end
       end
 
+      # try to guess user's favorite cli text editor
+      def decide_texteditor
+        %w[$VISUAL $EDITOR /usr/bin/editor vi].each do |texteditor|
+          if cmd_exists? texteditor and texteditor.start_with? '$'
+            return ENV[texteditor[1..-1]]
+          elsif cmd_exists? texteditor
+            return texteditor
+          end
+        end
+      end
+
+      # check if given cmd is executable. Absolute path or command in $PATH allowed.
+      def cmd_exists? cmd
+        system("which #{cmd} > /dev/null")
+        return $?.exitstatus.zero?
+      end
+
+      def is_port_open?(port)
+        begin
+          socket = TCPSocket.new('127.0.0.1', port)
+          socket.close
+          return true
+        rescue Errno::ECONNREFUSED
+          return false
+        end
+      end
+
+      # splint lines e.g. read from a file into lines and clean those up
+      def stripped_lines(input_string)
+        input_string.lines.map(&:chomp).map(&:strip)
+      end
     end
   end
 end

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '1.8.0'
+  VERSION = '1.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -97,6 +97,8 @@ files:
 - lib/geordi/commands/create_database_yml.rb
 - lib/geordi/commands/create_databases.rb
 - lib/geordi/commands/cucumber.rb
+- lib/geordi/commands/db_clean.rb
+- lib/geordi/commands/delete_dumps.rb
 - lib/geordi/commands/deploy.rb
 - lib/geordi/commands/dump.rb
 - lib/geordi/commands/eurest.rb
@@ -117,6 +119,7 @@ files:
 - lib/geordi/commands/vnc.rb
 - lib/geordi/commands/with_rake.rb
 - lib/geordi/cucumber.rb
+- lib/geordi/db_cleaner.rb
 - lib/geordi/dump_loader.rb
 - lib/geordi/firefox_for_selenium.rb
 - lib/geordi/gitpt.rb