knife ssh interactive mode via tmux fails on OS X when search queries contain a colon

Details

  • Type: Bug Bug
  • Status: Closed Closed
  • Priority: Unknown Unknown
  • Resolution: Fixed
  • Affects Version/s: 0.10.4
  • Fix Version/s: 0.10.6
  • Component/s: Knife
  • Labels:
    None
  • Environment:

    MacOS X 10.7, tmux 1.5 (via homebrew)

Description

When attempting to use knife ssh "roles:core" tmux (or any other query containing a colon) on OS X 10.7 with tmux 1.5 (via homebrew), tmux reports "bad session name."

Example knife -VV output follows:

DEBUG: Using configuration from /Users/user/.chef/knife.rb
DEBUG: Signing the request as user
DEBUG: Sending HTTP Request via GET to api.opscode.com:443/organizations/someorg/search/node
DEBUG: Adding ec2-obfuscated.compute-1.amazonaws.com
DEBUG: Adding ec2-obfuscated.compute-1.amazonaws.com
DEBUG: Adding ec2-obfuscated.compute-1.amazonaws.com
DEBUG: Adding ec2-obfuscated.compute-1.amazonaws.com
DEBUG: Adding ec2-obfuscated.compute-1.amazonaws.com
DEBUG: Adding ec2-obfuscated.compute-1.amazonaws.com
DEBUG: Adding ec2-obfuscated.compute-1.amazonaws.com
DEBUG: Adding ec2-obfuscated.compute-1.amazonaws.com
DEBUG: Adding ec2-obfuscated.compute-1.amazonaws.com
DEBUG: Executing tmux new-session -d -s 'knife ssh roles:core' -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com'
DEBUG: ---- Begin output of tmux new-session -d -s 'knife ssh roles:core' -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' ----
DEBUG: STDOUT:
DEBUG: STDERR: bad session name: knife ssh roles:core
DEBUG: ---- End output of tmux new-session -d -s 'knife ssh roles:core' -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' ----
DEBUG: Ran tmux new-session -d -s 'knife ssh roles:core' -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' \; new-window -a -n 'ec2-obfuscated.compute-1.amazonaws.com' 'ssh user@ec2-obfuscated.compute-1.amazonaws.com' returned 1

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Cameron Johnston added a comment -

Neglected to mention that I have tested creating tmux sessions at the command line and found that using a session name containing a colon resulted in the same "bad session name" error.

Show
Cameron Johnston added a comment - Neglected to mention that I have tested creating tmux sessions at the command line and found that using a session name containing a colon resulted in the same "bad session name" error.
Hide
Permalink
Stuart Glenn added a comment -

Quick fix in https://github.com/glennsb/chef/tree/CHEF-2573

Just replacing all the colons with spaces in string used for the tmux session name

Show
Stuart Glenn added a comment - Quick fix in https://github.com/glennsb/chef/tree/CHEF-2573 Just replacing all the colons with spaces in string used for the tmux session name
Hide
Permalink
Seth Falcon added a comment -

Looking at the tmux source code it looks like ':' is the only disallowed character:

// session.c from tmux 1.5
session_check_name(const char *name)
{
        return (*name != '\0' && strchr(name, ':') == NULL);
}

Would '=' be a better replacement than ' '?

Show
Seth Falcon added a comment - Looking at the tmux source code it looks like ':' is the only disallowed character: // session.c from tmux 1.5 session_check_name( const char *name) { return (*name != '\0' && strchr(name, ':') == NULL); } Would '=' be a better replacement than ' '?
Hide
Permalink
Stuart Glenn added a comment -

I doesn't matter to me. In either case if the user's query had a colon in it, the final session name will not match. I just went for the quick patch that I knew would work

Show
Stuart Glenn added a comment - I doesn't matter to me. In either case if the user's query had a colon in it, the final session name will not match. I just went for the quick patch that I knew would work
Hide
Permalink
Bryan McLellan [Opscode] added a comment -

We're a little worried about the next case where there is an illegal character. How about something like:

.gsub(/[^\w]/, ' ')
Show
Bryan McLellan [Opscode] added a comment - We're a little worried about the next case where there is an illegal character. How about something like: .gsub(/[^\w]/, ' ')
Hide
Permalink
Bryan McLellan [Opscode] added a comment -

Changed the replacement to '=' as Seth suggested, since this ':' is a unique use case.

Merged to master.

Thanks guys!

Show
Bryan McLellan [Opscode] added a comment - Changed the replacement to '=' as Seth suggested, since this ':' is a unique use case. Merged to master. Thanks guys!
Hide
Permalink
Bryan McLellan [Opscode] added a comment -

https://github.com/opscode/chef/pull/155

Show
Bryan McLellan [Opscode] added a comment - https://github.com/opscode/chef/pull/155

People

  • Assignee:
    Stuart Glenn
    Reporter:
    Cameron Johnston
Vote (0)
Watch (1)

Dates

  • Created:
    Updated:
    Resolved: