Merge lp:~percona-toolkit-dev/percona-toolkit/pt-online-schema-change--doesnt-honor--ask-pass-1396868 into lp:~percona-toolkit-dev/percona-toolkit/release-2.2.13

[Frank Cizmich]

Cxn for some strange reason did not honor --ask-pass, (since at least 2.2.9) while fat-packed version in tools did.
Fixed Cxn and synced with rest of tools.

Also fixed pt-online-schema problem when pressing ctl+c while being prompted for password.
Terminal would end up in an inconsistent state.
Used Term::ReadKey to restore previous state.

Also made simpler solution to pt-online-schema-change repeated request for password

[Daniel Nichter (daniel-nichter)]

review: Needs Fixing

[Daniel Nichter (daniel-nichter)]

review: Needs Fixing

[lp:~percona-toolkit-dev/percona-toolkit/pt-online-schema-change--doesnt-honor--ask-pass-1396868]

614. By Frank Cizmich on 2015-01-12

used ReadKeyMini. Moved double password logic to Cxn. Removed {ask_pass} from Cxn

[Frank Cizmich (frank-cizmich)]

- Removed the args{ask_pass} since it's not used. It's the way the module was coded before, which is strange since it doesn't work. So I left it in as a fallback initially just in case it served a purpose. But since it's not used, let's simplify.

- Including ReadKeyMini solved the ctl+c problem by itself. Nice :-)
Called ReadMode explicitly anyway just to ensure it's known to be used within the code.

- Passed double ask-pass handling logic into Cxn, which was how I did it before for pt-osc.

=== modified file 'bin/pt-config-diff'
--- bin/pt-config-diff	2014-11-11 13:28:27 +0000
+++ bin/pt-config-diff	2015-01-13 14:19:09 +0000
@@ -2295,7 +2295,7 @@
       set             => $args{set},
       NAME_lc         => defined($args{NAME_lc}) ? $args{NAME_lc} : 1,
       dbh_set         => 0,
-      ask_pass        => $args{ask_pass},
+      ask_pass        => $o->get('ask-pass'),
       DSNParser       => $dp,
       is_cluster_node => undef,
       parent          => $args{parent},
@@ -2311,7 +2311,7 @@
 
    my $dbh = $self->{dbh};
    if ( !$dbh || !$dbh->ping() ) {
-      if ( $self->{ask_pass} && !$self->{asked_for_pass} ) {
+      if ( $self->{ask_pass} && !$self->{asked_for_pass} && !defined $dsn->{p} ) {
          $dsn->{p} = OptionParser::prompt_noecho("Enter MySQL password: ");
          $self->{asked_for_pass} = 1;
       }

=== modified file 'bin/pt-deadlock-logger'
--- bin/pt-deadlock-logger	2014-11-11 13:28:27 +0000
+++ bin/pt-deadlock-logger	2015-01-13 14:19:09 +0000
@@ -2639,7 +2639,7 @@
       set             => $args{set},
       NAME_lc         => defined($args{NAME_lc}) ? $args{NAME_lc} : 1,
       dbh_set         => 0,
-      ask_pass        => $args{ask_pass},
+      ask_pass        => $o->get('ask-pass'),
       DSNParser       => $dp,
       is_cluster_node => undef,
       parent          => $args{parent},
@@ -2655,7 +2655,7 @@
 
    my $dbh = $self->{dbh};
    if ( !$dbh || !$dbh->ping() ) {
-      if ( $self->{ask_pass} && !$self->{asked_for_pass} ) {
+      if ( $self->{ask_pass} && !$self->{asked_for_pass} && !defined $dsn->{p} ) {
          $dsn->{p} = OptionParser::prompt_noecho("Enter MySQL password: ");
          $self->{asked_for_pass} = 1;
       }

=== modified file 'bin/pt-fk-error-logger'
--- bin/pt-fk-error-logger	2014-11-11 13:28:27 +0000
+++ bin/pt-fk-error-logger	2015-01-13 14:19:09 +0000
@@ -1791,7 +1791,7 @@
       set             => $args{set},
       NAME_lc         => defined($args{NAME_lc}) ? $args{NAME_lc} : 1,
       dbh_set         => 0,
-      ask_pass        => $args{ask_pass},
+      ask_pass        => $o->get('ask-pass'),
       DSNParser       => $dp,
       is_cluster_node => undef,
       parent          => $args{parent},
@@ -1807,7 +1807,7 @@
 
    my $dbh = $self->{dbh};
    if ( !$dbh || !$dbh->ping() ) {
-      if ( $self->{ask_pass} && !$self->{asked_for_pass} ) {
+      if ( $self->{ask_pass} && !$self->{asked_for_pass} && !defined $dsn->{p} ) {
          $dsn->{p} = OptionParser::prompt_noecho("Enter MySQL password: ");
          $self->{asked_for_pass} = 1;
       }

=== modified file 'bin/pt-kill'
--- bin/pt-kill	2014-11-11 13:28:27 +0000
+++ bin/pt-kill	2015-01-13 14:19:09 +0000
@@ -5158,7 +5158,7 @@
       set             => $args{set},
       NAME_lc         => defined($args{NAME_lc}) ? $args{NAME_lc} : 1,
       dbh_set         => 0,
-      ask_pass        => $args{ask_pass},
+      ask_pass        => $o->get('ask-pass'),
       DSNParser       => $dp,
       is_cluster_node => undef,
       parent          => $args{parent},
@@ -5174,7 +5174,7 @@
 
    my $dbh = $self->{dbh};
    if ( !$dbh || !$dbh->ping() ) {
-      if ( $self->{ask_pass} && !$self->{asked_for_pass} ) {
+      if ( $self->{ask_pass} && !$self->{asked_for_pass} && !defined $dsn->{p} ) {
          $dsn->{p} = OptionParser::prompt_noecho("Enter MySQL password: ");
          $self->{asked_for_pass} = 1;
       }

=== modified file 'bin/pt-online-schema-change'
--- bin/pt-online-schema-change	2014-11-11 13:28:27 +0000
+++ bin/pt-online-schema-change	2015-01-13 14:19:09 +0000
@@ -40,6 +40,7 @@
       HTTP::Micro
       VersionCheck
       Percona::XtraDB::Cluster
+      ReadKeyMini
    ));
 }
 
@@ -3755,7 +3756,7 @@
       set             => $args{set},
       NAME_lc         => defined($args{NAME_lc}) ? $args{NAME_lc} : 1,
       dbh_set         => 0,
-      ask_pass        => $args{ask_pass},
+      ask_pass        => $o->get('ask-pass'),
       DSNParser       => $dp,
       is_cluster_node => undef,
       parent          => $args{parent},
@@ -3771,7 +3772,7 @@
 
    my $dbh = $self->{dbh};
    if ( !$dbh || !$dbh->ping() ) {
-      if ( $self->{ask_pass} && !$self->{asked_for_pass} ) {
+      if ( $self->{ask_pass} && !$self->{asked_for_pass} && !defined $dsn->{p} ) {
          $dsn->{p} = OptionParser::prompt_noecho("Enter MySQL password: ");
          $self->{asked_for_pass} = 1;
       }
@@ -7758,6 +7759,162 @@
 # ###########################################################################
 
 # ###########################################################################
+# ReadKeyMini package
+# This package is a copy without comments from the original.  The original
+# with comments and its test file can be found in the Bazaar repository at,
+#   lib/ReadKeyMini.pm
+#   t/lib/ReadKeyMini.t
+# See https://launchpad.net/percona-toolkit for more information.
+# ###########################################################################
+{
+
+BEGIN {
+
+package ReadKeyMini;
+BEGIN { $INC{"ReadKeyMini.pm"} ||= 1 }
+
+use warnings;
+use strict;
+use English qw(-no_match_vars);
+use constant PTDEBUG => $ENV{PTDEBUG} || 0;
+
+use POSIX qw( :termios_h );
+use Fcntl qw( F_SETFL F_GETFL );
+
+use base  qw( Exporter );
+
+BEGIN {
+   our @EXPORT_OK = qw( GetTerminalSize ReadMode );
+   *ReadMode        = *Term::ReadKey::ReadMode        = \&_ReadMode;
+   *GetTerminalSize = *Term::ReadKey::GetTerminalSize = \&_GetTerminalSize;
+}
+
+my %modes = (
+   original    => 0,
+   restore     => 0,
+   normal      => 1,
+   noecho      => 2,
+   cbreak      => 3,
+   raw         => 4,
+   'ultra-raw' => 5,
+);
+
+{
+   my $fd_stdin = fileno(STDIN);
+   my $flags;
+   unless ( $PerconaTest::DONT_RESTORE_STDIN ) {
+      $flags = fcntl(STDIN, F_GETFL, 0)
+         or warn "Error getting STDIN flags with fcntl: $OS_ERROR";
+   }
+   my $term     = POSIX::Termios->new();
+   $term->getattr($fd_stdin);
+   my $oterm    = $term->getlflag();
+   my $echo     = ECHO | ECHOK | ICANON;
+   my $noecho   = $oterm & ~$echo;
+
+   sub _ReadMode {
+      my $mode = $modes{ $_[0] };
+      if ( $mode == $modes{normal} ) {
+         cooked();
+      }
+      elsif ( $mode == $modes{cbreak} || $mode == $modes{noecho} ) {
+         cbreak( $mode == $modes{noecho} ? $noecho : $oterm );
+      }
+      else {
+         die("ReadMore('$_[0]') not supported");
+      }
+   }
+
+   sub cbreak {
+      my ($lflag) = $_[0] || $noecho; 
+      $term->setlflag($lflag);
+      $term->setcc( VTIME, 1 );
+      $term->setattr( $fd_stdin, TCSANOW );
+   }
+
+   sub cooked {
+      $term->setlflag($oterm);
+      $term->setcc( VTIME, 0 );
+      $term->setattr( $fd_stdin, TCSANOW );
+      if ( !$PerconaTest::DONT_RESTORE_STDIN ) {
+         fcntl(STDIN, F_SETFL, int($flags))
+            or warn "Error restoring STDIN flags with fcntl: $OS_ERROR";
+      }
+   }
+
+   END { cooked() }
+}
+
+sub readkey {
+   my $key = '';
+   cbreak();
+   sysread(STDIN, $key, 1);
+   my $timeout = 0.1;
+   if ( $key eq "\033" ) {
+      my $x = '';
+      STDIN->blocking(0);
+      sysread(STDIN, $x, 2);
+      STDIN->blocking(1);
+      $key .= $x;
+      redo if $key =~ /\[[0-2](?:[0-9];)?$/
+   }
+   cooked();
+   return $key;
+}
+
+
+BEGIN {
+   eval { no warnings; local $^W; require 'sys/ioctl.ph' };
+   if ( !defined &TIOCGWINSZ ) {
+      *TIOCGWINSZ = sub () {
+              $^O eq 'linux'   ? 0x005413
+            : $^O eq 'solaris' ? 0x005468
+            :                    0x40087468;
+      };
+   }
+}
+
+sub _GetTerminalSize {
+   if ( @_ ) {
+      die "My::Term::ReadKey doesn't implement GetTerminalSize with arguments";
+   }
+
+   my $cols = $ENV{COLUMNS} || 80;
+   my $rows = $ENV{LINES}   || 24;
+
+   if ( open( TTY, "+<", "/dev/tty" ) ) { # Got a tty
+      my $winsize = '';
+      if ( ioctl( TTY, &TIOCGWINSZ, $winsize ) ) {
+         ( $rows, $cols, my ( $xpixel, $ypixel ) ) = unpack( 'S4', $winsize );
+         return ( $cols, $rows, $xpixel, $ypixel );
+      }
+   }
+
+   if ( $rows = `tput lines 2>/dev/null` ) {
+      chomp($rows);
+      chomp($cols = `tput cols`);
+   }
+   elsif ( my $stty = `stty -a 2>/dev/null` ) {
+      ($rows, $cols) = $stty =~ /([0-9]+) rows; ([0-9]+) columns;/;
+   }
+   else {
+      ($cols, $rows) = @ENV{qw( COLUMNS LINES )};
+      $cols ||= 80;
+      $rows ||= 24;
+   }
+
+   return ( $cols, $rows );
+}
+
+}
+
+1;
+}
+# ###########################################################################
+# End ReadKeyMini package
+# ###########################################################################
+
+# ###########################################################################
 # This is a combination of modules and programs in one -- a runnable module.
 # http://www.perl.com/pub/a/2006/07/13/lightning-articles.html?page=last
 # Or, look it up in the Camel book on pages 642 and 643 in the 3rd edition.
@@ -10484,6 +10641,12 @@
    my ( $signal ) = @_;
    $oktorun = 0;  # flag for cleanup tasks
    print STDERR "# Exiting on SIG$signal.\n";
+   # restore terminal to normal state in case CTL+C issued while 
+   # asking for password
+   # https://bugs.launchpad.net/percona-toolkit/+bug/1396870
+   # note: just including ReadKeyMini seems to solve the bug, 
+   # but lets use it explicitly  so we don't forget why we need it
+   ReadKeyMini::ReadMode 0;
    exit 1;
 }
 

=== modified file 'bin/pt-table-checksum'
--- bin/pt-table-checksum	2014-11-11 13:28:27 +0000
+++ bin/pt-table-checksum	2015-01-13 14:19:09 +0000
@@ -3533,7 +3533,7 @@
       set             => $args{set},
       NAME_lc         => defined($args{NAME_lc}) ? $args{NAME_lc} : 1,
       dbh_set         => 0,
-      ask_pass        => $args{ask_pass},
+      ask_pass        => $o->get('ask-pass'),
       DSNParser       => $dp,
       is_cluster_node => undef,
       parent          => $args{parent},
@@ -3549,7 +3549,7 @@
 
    my $dbh = $self->{dbh};
    if ( !$dbh || !$dbh->ping() ) {
-      if ( $self->{ask_pass} && !$self->{asked_for_pass} ) {
+      if ( $self->{ask_pass} && !$self->{asked_for_pass} && !defined $dsn->{p} ) {
          $dsn->{p} = OptionParser::prompt_noecho("Enter MySQL password: ");
          $self->{asked_for_pass} = 1;
       }

=== modified file 'bin/pt-upgrade'
--- bin/pt-upgrade	2014-11-11 13:28:27 +0000
+++ bin/pt-upgrade	2015-01-13 14:19:09 +0000
@@ -2464,7 +2464,7 @@
       set             => $args{set},
       NAME_lc         => defined($args{NAME_lc}) ? $args{NAME_lc} : 1,
       dbh_set         => 0,
-      ask_pass        => $args{ask_pass},
+      ask_pass        => $o->get('ask-pass'),
       DSNParser       => $dp,
       is_cluster_node => undef,
       parent          => $args{parent},
@@ -2480,7 +2480,7 @@
 
    my $dbh = $self->{dbh};
    if ( !$dbh || !$dbh->ping() ) {
-      if ( $self->{ask_pass} && !$self->{asked_for_pass} ) {
+      if ( $self->{ask_pass} && !$self->{asked_for_pass} && !defined $dsn->{p} ) {
          $dsn->{p} = OptionParser::prompt_noecho("Enter MySQL password: ");
          $self->{asked_for_pass} = 1;
       }

=== modified file 'lib/Cxn.pm'
--- lib/Cxn.pm	2014-11-05 22:21:51 +0000
+++ lib/Cxn.pm	2015-01-13 14:19:09 +0000
@@ -108,7 +108,7 @@
       set             => $args{set},
       NAME_lc         => defined($args{NAME_lc}) ? $args{NAME_lc} : 1,
       dbh_set         => 0,
-      ask_pass        => $args{ask_pass},
+      ask_pass        => $o->get('ask-pass'),
       DSNParser       => $dp,
       is_cluster_node => undef,
       parent          => $args{parent},
@@ -125,7 +125,7 @@
    my $dbh = $self->{dbh};
    if ( !$dbh || !$dbh->ping() ) {
       # Ask for password once.
-      if ( $self->{ask_pass} && !$self->{asked_for_pass} ) {
+      if ( $self->{ask_pass} && !$self->{asked_for_pass} && !defined $dsn->{p} ) {
          $dsn->{p} = OptionParser::prompt_noecho("Enter MySQL password: ");
          $self->{asked_for_pass} = 1;
       }