opsconsole 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b1449525d723c920fe00c28c941adad147a816a3549d7880ca179562f798e76a
+  data.tar.gz: 97e546eef1d4ab5634a5ec12231f61d7dd8204f270d13a52e9afbde23a2652a7
+SHA512:
+  metadata.gz: f7bf6c0731a7ff250ad34cd8e042b339fe2be7da652525511b9cd83ad9f2fe1e10a4974bcc77a2f67f33809e1820828982b51958ac1bd9d0bd2949de3f5c87b8
+  data.tar.gz: 9d4eee4e0041bafe5f9031a5d9a768a353b55bc6be8f0402303fabdecb8d247e7fac4beb2e4c6deba5d942e926455d6597dbdd455bc001f7f600bd02b2684e2b

data/.gitignore

@@ -0,0 +1,14 @@
+*.swp
+.DS_Store
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+.rspec_status
+/*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,19 @@
+Metrics/AbcSize:
+  Max: 18
+
+Metrics/BlockLength:
+  Max: 64
+
+Metrics/ClassLength:
+  CountComments: false
+  Max: 256
+
+Metrics/LineLength:
+  Max: 128
+
+Metrics/MethodLength:
+  CountComments: false
+  Max: 128
+
+Metrics/ParameterLists:
+  Max: 8

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Rafal Mierzwiak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+# opsconsole
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'opsconsole'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install opsconsole
+
+## Overview
+
+Tool to simultaneously access and interact with multiple remote machines.
+
+Tool to access and interact with multiple remote machines at once. Console can be detached and re-attached at will. Terminals presented within current window can be accessed simultaneously.
+
+**NOTES**
+
+Console consists of sessions, windows and panes:
+
+* Remote terminals are presented in panes, e.g. single pane shows output of a command running on a remote host.
+
+* Multiple panes are organised in windows, this way operator is able to observe multiple terminals on one screen, also may organize certain commands and hosts into groups (e.g. a window called 'sysperf' showing 'iostat' and 'vmstat' commands running on database servers, another window called 'netperf' showing 'curl' and 'ping' commands running on web servers.
+
+* Multiple windows are organized in sessions, this way operator may further organize and separate panes based on custom criteria, say keep 'staging' and 'production' session.
+
+Console organises hosts in columns, commands in rows. Terminals are displayed on a single screen hence considerable amount of screen real estate is required for the tool to be usable.
+
+tmux controls the console and the terminals, console can be detached and later re-attached at will. Terminals presented within current window can be accessed simultaneously. Refer to tmux documentation in regards to its configuration, in particular useful key bindings.
+
+Upon creation console connects to remote server(s) via SSH using operators credentials and executes specified command(s). SSH connects to remote servers as $USER, that is unless different username is requested via $SSH_USER or tool's --user option. Make sure SSH keys are in place.
+
+Command may be anything that works with with:
+
+    $ tmux new-window ssh host '<command>'
+
+for example:
+
+    $ opsconsole create ... -c 'htop'
+
+    $ opsconsole create ... -c 'ping google.com'
+
+    $ opsconsole create ... -c 'while true; do echo $(date) $(nc -zw 2 google.com 80); sleep 1; done'
+
+## Usage
+
+Situations when you may want to use it...
+
+* Checking your servers vitals
+
+```
+$ opsconsole create -w sysperf --hosts={host1,host2} -c 'iostat -d -p vda 1' -c 'vmstat 1' -c 'mpstat 1'
+```
+
+![screenshot-sysperf](examples/screenshot-sysperf.png)
+
+* Checking whether your servers can connect to the outside world just fine
+
+```
+$ opsconsole create -w netperf --hosts={host1,host2} -c 'mtr google.com' -c 'while true; do echo $(date) $(nc -zvw 2 google.com 80); sleep 1; done'
+```
+
+![screenshot-netperf](examples/screenshot-netperf.png)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and merge requests are welcome on GitLab at [gitlab.com/rafalmierzwiak/opsconsole](https://gitlab.com/rafalmierzwiak/opsconsole).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'opsconsole'
+
+require 'pry'
+Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/opsconsole

@@ -0,0 +1,159 @@
+#!/usr/bin/env ruby
+
+require 'gli'
+require 'opsconsole'
+
+include GLI::App
+
+program_desc 'Remote terminal multiplexer'
+program_long_desc <<-EOS
+  Tool to simultaneously access and interact with multiple remote machines.
+EOS
+version Opsconsole::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+desc 'Attach console'
+long_desc <<-EOS
+  If session not provided console active session will be attached.
+
+  If window not provided console active window will be attached.
+EOS
+
+command :attach do |c|
+  c.flag :s,
+         :session,
+         desc: 'Session name'
+  c.flag :w,
+         :window,
+         desc: 'Window name'
+
+  c.action do |_global, options, _args|
+    Console.attach(session: options.fetch(:session),
+                   window: options.fetch(:window))
+  end
+end
+
+desc 'Create console'
+long_desc <<-EOS
+  Console consists of sessions, windows and panes. Remote terminals are presented
+  in panes, e.g. single pane shows output of a command running on a remote host.
+  Multiple panes are organised in windows, this way operator is able to observe
+  multiple terminals on one screen, also may organize certain commands and hosts
+  into groups (e.g. a window called 'sysperf' showing 'iostat' and 'vmstat'
+  commands running on database servers, another window called 'netperf' showing
+  'curl' and 'ping' commands running on web servers. Multiple windows are
+  organized in sessions, this way operator may further organize and separate panes
+  based on custom criteria, say keep 'staging' and 'production' session.
+
+  Console organises hosts in columns, commands in rows. Terminals are displayed on
+  a single screen hence considerable amount of screen real estate is required for
+  the tool to be usable.
+
+  tmux controls the console and the terminals, console can be detached and later
+  re-attached at will. Terminals presented within current window can be accessed
+  simultaneously. Refer to tmux documentation in regards to its configuration,
+  in particular useful key bindings.
+
+  Upon creation console connects to remote server(s) via SSH using operators
+  credentials and executes specified command(s). SSH connects to remote servers
+  as $USER, that is unless different username is requested via $SSH_USER or
+  tool's --user option. Make sure SSH keys are in place.
+
+  Command may be anything that works with:
+
+  tmux new-window ssh host '<command>'
+
+  for example:
+
+  -c 'htop'
+
+  -c 'ping google.com'
+
+  -c 'while true; do echo $(date) $(nc -zw 2 google.com 80); sleep 1; done'
+EOS
+command :create do |c|
+  c.flag :s,
+         :session,
+         desc: 'Session name',
+         default_value: 'opsconsole'
+  c.flag :w,
+         :window,
+         desc: 'Window name',
+         default_value: 'default'
+  c.flag :h,
+         :host,
+         desc: 'Host name',
+         required: true,
+         multiple: true
+  c.flag :c,
+         :command,
+         desc: 'Command',
+         required: true,
+         multiple: true
+  c.flag :u,
+         :user,
+         desc: 'Username',
+         default_value: ENV['SSH_USER'] ? ENV['SSH_USER'] : ENV['USER']
+  c.switch :synchronize,
+           desc: 'Synchronize panes',
+           default_value: true
+  c.switch :attach,
+           desc: 'Attach to console',
+           default_value: true
+
+  c.action do |_global, options, _args|
+    Console.create(session: options.fetch(:session),
+                   window: options.fetch(:window),
+                   user: options.fetch(:user),
+                   hosts: options.fetch(:host, []),
+                   commands: options.fetch(:command, []),
+                   synchronize: options.fetch(:synchronize))
+    if options.fetch(:attach)
+      Console.attach(session: options.fetch(:session),
+                     window: options.fetch(:window))
+    end
+  end
+end
+
+desc 'Destroy console'
+long_desc <<-EOS
+  If window name provided all panes of the given window will be destroyed.
+
+  If session name provided all windows and panes of the given session will be
+  destroyed.
+EOS
+
+command :destroy do |c|
+  c.flag :s,
+         :session,
+         desc: 'Session name'
+  c.flag :w,
+         :window,
+         desc: 'Window name'
+
+  c.action do |_global, options, _args|
+    Console.destroy(session: options.fetch(:session),
+                    window: options.fetch(:window))
+  end
+end
+
+desc 'List consoles panes'
+long_desc <<-EOS
+  List columns contain the following information:
+
+  Session name, Window name, Window active, Pane index, Pane active
+EOS
+command :list do |c|
+  c.action do |_global, _options, _args|
+    Console.list
+  end
+end
+
+unless system('which', 'tmux', out: File::NULL, err: File::NULL)
+  STDERR.puts('Please install tmux, opsconsole depends on it.')
+  exit 1
+end
+
+exit run(ARGV)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/opsconsole/console.rb

@@ -0,0 +1,183 @@
+# Tmux integration
+#
+class Console
+  def self.attach_session(session:, window: nil, pane: nil)
+    sh(%W[attach -t =#{session}:#{window}.#{pane}])
+  end
+
+  def self.sh(args)
+    system('tmux', '-L', 'opsconsole', *args)
+  end
+
+  def self.kill_session(session:)
+    sh(%W[kill-session -t =#{session}:])
+  end
+
+  def self.kill_pane(session:, window:, pane:)
+    sh(%W[killp -t =#{session}:#{window}.#{pane}])
+  end
+
+  def self.kill_window(session:, window:)
+    sh(%W[killw -t =#{session}:#{window}.])
+  end
+
+  def self.list_panes
+    fmt = ['#{session_name}',
+           '#{window_name}',
+           '#{window_active}',
+           '#{pane_index}',
+           '#{pane_active}'].join(' ')
+    sh(%W[lsp -a -F #{fmt}])
+  end
+
+  def self.new_session(session:, window:)
+    sh(%W[new -d -s #{session} -n #{window}])
+  end
+
+  def self.new_window(session:, window:)
+    sh(%W[neww -t #{session} -n #{window}])
+  end
+
+  def self.present?(target:)
+    sh(%W[has -t #{target}].push(err: File::NULL))
+  end
+
+  def self.set_option(session:, option:, value:)
+    sh(%W[set -t =#{session}: #{option} #{value}])
+  end
+
+  def self.set_window_option(session:, window:, option:, value:)
+    sh(%W[setw -t =#{session}:#{window}. #{option} #{value}])
+  end
+
+  def self.split_window(session:, window:, pane:, direction:, size:, command: nil)
+    if command.nil?
+      sh(%W[splitw -t =#{session}:#{window}.#{pane} -#{direction} -p #{size}])
+    else
+      sh(%W[splitw -t =#{session}:#{window}.#{pane} -#{direction} -p #{size} #{command}])
+    end
+  end
+
+  def self.select_pane(session:, window:, pane:)
+    sh(%W[selectp -t =#{session}:#{window}.#{pane}])
+  end
+
+  def self.select_window(session:, window:)
+    sh(%W[selectw -t =#{session}:#{window}.])
+  end
+
+  def self.attach(session:, window: nil, pane: nil)
+    select_pane(session: session,
+                window: window,
+                pane: pane)
+    attach_session(session: session,
+                   window: window,
+                   pane: pane)
+  end
+
+  def self.destroy(session:, window:)
+    if session.nil?
+      STDERR.puts 'can not find session'
+    elsif window.nil?
+      kill_session(session: session)
+    else
+      kill_window(session: session,
+                  window: window)
+    end
+  end
+
+  def self.list
+    list_panes
+  end
+
+  def self.create(session:, window:, user:, hosts:, commands:, synchronize:)
+    return if present?(target: "=#{session}:#{window}.1")
+
+    if present?(target: "=#{session}:")
+      create_window(session: session,
+                    window: window)
+    else
+      create_session(session: session,
+                     window: window)
+    end
+
+    create_panes(session: session,
+                 window: window,
+                 user: user,
+                 hosts: hosts,
+                 commands: commands)
+
+    set_window_option(session: session,
+                      window: window,
+                      option: 'synchronize-panes',
+                      value: synchronize ? 'on' : 'off')
+  end
+
+  def self.create_panes(session:, window:, user:, hosts:, commands:)
+    hosts.size.downto(2) do |h|
+      width = 100 / h
+      split_window(session: session,
+                   window: window,
+                   pane: 1,
+                   direction: 'h',
+                   size: width)
+    end
+
+    hosts.size.downto(1) do |h|
+      host = hosts[h - 1]
+      ssh = "ssh -tt -o ConnectTimeout=2 #{user}@#{host}"
+      commands = [ssh] if commands.empty?
+      commands.size.downto(1) do |c|
+        command = "#{ssh} '#{commands[c - 1]}'"
+        split_window(session: session,
+                     window: window,
+                     pane: h,
+                     direction: 'v',
+                     size: 100 / c,
+                     command: command)
+      end
+      kill_pane(session: session,
+                window: window,
+                pane: h)
+    end
+
+    select_pane(session: session,
+                window: window,
+                pane: 1)
+  end
+
+  def self.create_session(session:, window:)
+    new_session(session: session,
+                window: window)
+    set_option(session: session,
+               option: 'base-index',
+               value: 1)
+    set_option(session: session,
+               option: 'pane-border-status',
+               value: 'top')
+    set_option(session: session,
+               option: 'pane-border-format',
+               value: '#{pane_index}')
+    set_option(session: session,
+               option: 'status-left-length',
+               value: session.size + 4)
+    set_option(session: session,
+               option: 'status-right',
+               value: ['#{session_name}',
+                       '#{window_name}',
+                       '#{pane_index}'].join(':'))
+    set_window_option(session: session,
+                      window: window,
+                      option: 'pane-base-index',
+                      value: 1)
+  end
+
+  def self.create_window(session:, window:)
+    new_window(session: session,
+               window: window)
+    set_window_option(session: session,
+                      window: window,
+                      option: 'pane-base-index',
+                      value: 1)
+  end
+end

data/lib/opsconsole/version.rb

@@ -0,0 +1,3 @@
+module Opsconsole
+  VERSION = '0.1.6'.freeze
+end

data/lib/opsconsole.rb

@@ -0,0 +1,2 @@
+require 'opsconsole/console'
+require 'opsconsole/version'

data/opsconsole.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'opsconsole/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'opsconsole'
+  spec.version = Opsconsole::VERSION
+  spec.authors = ['Rafal Mierzwiak']
+  spec.email = ['rm@rm.pl']
+
+  spec.summary = <<-EOS
+  Remote terminal multiplexer.
+  EOS
+  spec.description = <<-EOS
+  Handy tool for server operators. Uses SSH to access remote hosts and execute commands on them. Uses tmux to present a consolidated console showing remote hosts terminals and allow for simultaneous interaction with the remote hosts.
+  EOS
+  spec.homepage = 'https://gitlab.com/rafalmierzwiak/opsconsole'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir = 'bin'
+  spec.executables = 'opsconsole'
+
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.2.15'
+  spec.add_development_dependency 'rake', '~> 13.0.3'
+  spec.add_development_dependency 'rspec', '~> 3.10.0'
+
+  spec.add_runtime_dependency('gli', '2.20.0')
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: opsconsole
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Rafal Mierzwiak
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.15
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.15
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.20.0
+description: "  Handy tool for server operators. Uses SSH to access remote hosts and
+  execute commands on them. Uses tmux to present a consolidated console showing remote
+  hosts terminals and allow for simultaneous interaction with the remote hosts.\n"
+email:
+- rm@rm.pl
+executables:
+- opsconsole
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/opsconsole
+- bin/setup
+- examples/screenshot-netperf.png
+- examples/screenshot-sysperf.png
+- lib/opsconsole.rb
+- lib/opsconsole/console.rb
+- lib/opsconsole/version.rb
+- opsconsole.gemspec
+homepage: https://gitlab.com/rafalmierzwiak/opsconsole
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Remote terminal multiplexer.
+test_files: []