web-console 1.0.4 → 2.0.0.beta1

data/lib/web_console/engine.rb

@@ -1,77 +0,0 @@
-require 'ipaddr'
-require 'active_support/core_ext/numeric/time'
-require 'rails/engine'
-
-require 'active_model'
-require 'sprockets/rails'
-
-module WebConsole
-  class Engine < ::Rails::Engine
-    isolate_namespace WebConsole
-
-    config.web_console = ActiveSupport::OrderedOptions.new.tap do |c|
-      c.automount          = true
-      c.command            = nil
-      c.default_mount_path = '/console'
-      c.timeout            = 0.seconds
-      c.term               = 'xterm-color'
-      c.whitelisted_ips    = '127.0.0.1'
-
-      c.style = ActiveSupport::OrderedOptions.new.tap do |s|
-        s.colors = 'light'
-        s.font   = 'large DejaVu Sans Mono, Liberation Mono, monospace'
-      end
-    end
-
-    initializer 'web_console.add_default_route' do |app|
-      # While we don't need the route in the test environment, we define it
-      # there as well, so we can easily test it.
-      if config.web_console.automount && (Rails.env.development? || Rails.env.test?)
-        app.routes.append do
-          mount WebConsole::Engine => app.config.web_console.default_mount_path
-        end
-      end
-    end
-
-    initializer 'web_console.process_whitelisted_ips' do
-      config.web_console.tap do |c|
-        # Ensure that it is an array of IPAddr instances and it is defaulted to
-        # 127.0.0.1 if not precent. Only unique entries are left in the end.
-        c.whitelisted_ips = Array(c.whitelisted_ips).map do |ip|
-          ip.is_a?(IPAddr) ? ip : IPAddr.new(ip.presence || '127.0.0.1')
-        end.uniq
-
-        # IPAddr instances can cover whole networks, so simplify the #include?
-        # check for the most common case.
-        def (c.whitelisted_ips).include?(ip)
-          ip.is_a?(IPAddr) ? super : any? { |net| net.include?(ip.to_s) }
-        end
-      end
-    end
-
-    initializer 'web_console.process_command' do
-      config.web_console.tap do |c|
-        # +Rails.root+ is not available while we set the default values of the
-        # other options. Default it during initialization.
-
-        # Not all people created their Rails 4 applications with the Rails 4
-        # generator, so bin/rails may not be available.
-        if c.command.blank?
-          local_rails = Rails.root.join('bin/rails')
-          c.command = "#{local_rails.executable? ? local_rails : 'rails'} console"
-        end
-      end
-    end
-
-    initializer 'web_console.process_colors' do
-      config.web_console.style.tap do |c|
-        case colors = c.colors
-        when Symbol, String
-          c.colors = Colors[colors] || Colors.default
-        else
-          c.colors = Colors.new(colors)
-        end
-      end
-    end
-  end
-end

data/lib/web_console/slave.rb

@@ -1,139 +0,0 @@
-require 'pty'
-require 'io/console'
-
-module WebConsole
-  # = Slave\ Process\ Wrapper
-  #
-  # Creates and communicates with slave processses.
-  #
-  # The communication happens through an input with attached psuedo-terminal.
-  # All of the communication is done in asynchrouns way, meaning that when you
-  # send input to the process, you have get the output by polling for it.
-  class Slave
-    # Different OS' and platforms raises different errors when trying to read
-    # on output end of a closed process.
-    READING_ON_CLOSED_END_ERRORS = [ Errno::EIO, EOFError ]
-
-    # Raised when trying to read from a closed (exited) process.
-    Closed = Class.new(IOError)
-
-    # The slave process id.
-    attr_reader :pid
-
-    def initialize(command = WebConsole.config.command, options = {})
-      using_term(options[:term] || WebConsole.config.term) do
-        @output, @input, @pid = PTY.spawn(command.to_s)
-      end
-      configure(options)
-    end
-
-    # Configure the psuedo terminal properties.
-    #
-    # Options:
-    #   :width  The width of the terminal in number of columns.
-    #   :height The height of the terminal in number of rows.
-    #
-    # If any of the width or height is missing (or zero), the termininal size
-    # won't be set.
-    def configure(options = {})
-      dimentions = options.values_at(:height, :width).collect(&:to_i)
-      @input.winsize = dimentions unless dimentions.any?(&:zero?)
-    end
-
-    # Sends input to the slave process STDIN.
-    #
-    # Returns immediately.
-    def send_input(input)
-      raise ArgumentError if input.nil? or input.try(:empty?)
-      input.each_char { |char| @input.putc(char) }
-    end
-
-    # Returns whether the slave process has any pending output in +wait+
-    # seconds.
-    #
-    # By default, the +timeout+ follows +config.web_console.timeout+. Usually,
-    # it is zero, making the response immediate.
-    def pending_output?(timeout = WebConsole.config.timeout)
-      # JRuby's select won't automatically coerce ActiveSupport::Duration.
-      !!IO.select([@output], [], [], timeout.to_i)
-    end
-
-    # Gets the pending output of the process.
-    #
-    # The pending output is read in an non blocking way by chunks, in the size
-    # of +chunk_len+. By default, +chunk_len+ is 49152 bytes.
-    #
-    # Returns +nil+, if there is no pending output at the moment. Otherwise,
-    # returns the output that hasn't been read since the last invocation.
-    #
-    # Raises Errno:EIO on closed output stream. This can happen if the
-    # underlying process exits.
-    def pending_output(chunk_len = 49152)
-      # Returns nil if there is no pending output.
-      return unless pending_output?
-
-      pending = String.new
-      while chunk = @output.read_nonblock(chunk_len)
-        pending << chunk
-      end
-      pending.force_encoding('UTF-8')
-    rescue IO::WaitReadable
-      pending.force_encoding('UTF-8')
-    rescue
-      raise Closed if READING_ON_CLOSED_END_ERRORS.any? { |exc| $!.is_a?(exc) }
-    end
-
-    # Dispose the underlying process, sending +SIGTERM+.
-    #
-    # After the process is disposed, it is detached from the parent to prevent
-    # zombies.
-    #
-    # If the process is already disposed an Errno::ESRCH will be raised and
-    # handled internally. If you want to handle Errno::ESRCH yourself, pass
-    # +{raise: true}+ as options.
-    #
-    # Returns a thread, which can be used to wait for the process termination.
-    def dispose(options = {})
-      dispose_with(:SIGTERM, options)
-    end
-
-    # Dispose the underlying process, sending +SIGKILL+.
-    #
-    # After the process is disposed, it is detached from the parent to prevent
-    # zombies.
-    #
-    # If the process is already disposed an Errno::ESRCH will be raised and
-    # handled internally. If you want to handle Errno::ESRCH yourself, pass
-    # +{raise: true}+ as options.
-    #
-    # Returns a thread, which can be used to wait for the process termination.
-    def dispose!(options = {})
-      dispose_with(:SIGKILL, options)
-    end
-
-    private
-
-      LOCK = Mutex.new
-
-      def using_term(term)
-        if term.nil?
-          yield
-        else
-          LOCK.synchronize do
-            begin
-              (previous_term, ENV['TERM'] = ENV['TERM'], term) and yield
-            ensure
-              ENV['TERM'] = previous_term
-            end
-          end
-        end
-      end
-
-      def dispose_with(signal, options = {})
-        Process.kill(signal, @pid)
-        Process.detach(@pid)
-      rescue Errno::ESRCH
-        raise if options[:raise]
-      end
-  end
-end

data/test/controllers/web_console/console_sessions_controller_test.rb

@@ -1,95 +0,0 @@
-require 'test_helper'
-
-module WebConsole
-  class ConsoleSessionsControllerTest < ActionController::TestCase
-    setup do
-      PTY.stubs(:spawn).returns([StringIO.new, StringIO.new, Random.rand(20000)])
-      @request.stubs(:remote_ip).returns('127.0.0.1')
-    end
-
-    test 'index is successful' do
-      get :index, use_route: 'web_console'
-      assert_response :success
-    end
-
-    test 'GET index creates new console session' do
-      assert_difference 'ConsoleSession::INMEMORY_STORAGE.size' do
-        get :index, use_route: 'web_console'
-      end
-    end
-
-    test 'PUT input validates for missing input' do
-      get :index, use_route: 'web_console'
-
-      assert_not_nil console_session = assigns(:console_session)
-
-      console_session.instance_variable_get(:@slave).stubs(:send_input).raises(ArgumentError)
-      put :input, id: console_session.pid, use_route: 'web_console'
-
-      assert_response :unprocessable_entity
-    end
-
-    test 'PUT input sends input to the slave' do
-      get :index, use_route: 'web_console'
-
-      assert_not_nil console_session = assigns(:console_session)
-
-      console_session.expects(:send_input)
-      put :input, input: ' ', id: console_session.pid, use_route: 'web_console'
-    end
-
-    test 'GET pending_output gives the slave pending output' do
-      get :index, use_route: 'web_console'
-
-      assert_not_nil console_session = assigns(:console_session)
-      console_session.expects(:pending_output)
-
-      get :pending_output, id: console_session.pid, use_route: 'web_console'
-    end
-
-    test 'GET pending_output raises 410 on exitted slave processes' do
-      get :index, use_route: 'web_console'
-
-      assert_not_nil console_session = assigns(:console_session)
-      console_session.stubs(:pending_output).raises(ConsoleSession::Unavailable)
-
-      get :pending_output, id: console_session.pid, use_route: 'web_console'
-      assert_response :gone
-    end
-
-    test 'PUT configuration adjust the terminal size' do
-      get :index, use_route: 'web_console'
-
-      assert_not_nil console_session = assigns(:console_session)
-      console_session.expects(:configure).with('id' => console_session.pid.to_s, 'width' => '80', 'height' => '24')
-
-      put :configuration, id: console_session.pid, width: 80, height: 24, use_route: 'web_console'
-      assert_response :success
-    end
-
-    test 'blocks requests from non-whitelisted ips' do
-      @request.stubs(:remote_ip).returns('128.0.0.1')
-      get :index, use_route: 'web_console'
-      assert_response :unauthorized
-    end
-
-    test 'allows requests from whitelisted ips' do
-      @request.stubs(:remote_ip).returns('127.0.0.1')
-      get :index, use_route: 'web_console'
-      assert_response :success
-    end
-
-    test 'index generated path' do
-      assert_generates mount_path, {
-        use_route: 'web_console',
-        controller: 'console_sessions'
-      }, {}, {controller: 'console_sessions'}
-    end
-
-    private
-
-      def mount_path
-        WebConsole::Engine.config.web_console.default_mount_path
-      end
-  end
-end

data/test/helpers/web_console/console_session_helper_test.rb

@@ -1,6 +0,0 @@
-require 'test_helper'
-
-module WebConsole
-  class ConsoleHelperTest < ActionView::TestCase
-  end
-end

data/test/models/console_session_test.rb

@@ -1,58 +0,0 @@
-require 'test_helper'
-
-module WebConsole
-  class ConsoleSessionTest < ActionView::TestCase
-    include ActiveModel::Lint::Tests
-
-    setup do
-      PTY.stubs(:spawn).returns([StringIO.new, StringIO.new, Random.rand(20000)])
-      ConsoleSession::INMEMORY_STORAGE.clear
-      @model1 = @model = ConsoleSession.new
-      @model2 = ConsoleSession.new
-    end
-
-    test 'raises ConsoleSession::Unavailable on not found sessions' do
-      assert_raises(ConsoleSession::Unavailable) { ConsoleSession.find(-1) }
-    end
-
-    test 'find coerces ids' do
-      assert_equal @model.persist, ConsoleSession.find("#{@model.pid}")
-    end
-
-    test 'not found exceptions are json serializable' do
-      exception = assert_raises(ConsoleSession::Unavailable) { ConsoleSession.find(-1) }
-      assert_equal '{"error":"Session unavailable"}', exception.to_json
-    end
-
-    test 'can be used as slave as the methods are delegated' do
-      slave_methods = Slave.instance_methods - @model.methods
-      slave_methods.each { |method| assert @model.respond_to?(method) }
-    end
-
-    test 'slave methods are cached on the singleton' do
-      assert_not @model.singleton_methods.include?(:pending_output?)
-      @model.pending_output? rescue nil
-      assert @model.singleton_methods.include?(:pending_output?)
-    end
-
-    test 'persisted models knows that they are in memory' do
-      assert_not @model.persisted?
-      @model.persist
-      assert @model.persisted?
-    end
-
-    test 'persisted models knows about their keys' do
-      assert_nil @model.to_key
-      @model.persist
-      assert_not_nil @model.to_key
-    end
-
-    test 'create gives already persisted models' do
-      assert ConsoleSession.create.persisted?
-    end
-
-    test 'no gives not persisted models' do
-      assert_not ConsoleSession.new.persisted?
-    end
-  end
-end

data/test/web_console/colors_test.rb

@@ -1,58 +0,0 @@
-require 'test_helper'
-
-module WebConsole
-  class ColorsTest < ActiveSupport::TestCase
-    setup do
-      @colors = Colors.new %w( #7f7f7f #ff0000 #00ff00 #ffff00 #5c5cff #ff00ff #00ffff #ffffff )
-    end
-
-    test '.[] is an alias for .themes#[]' do
-      @colors.class.themes.expects(:[]).with(:light).once
-      @colors.class[:light]
-    end
-
-    test '.register_theme creates Colors instance for the block' do
-      @colors.class.register_theme(:test) { |c| assert c.is_a?(Colors) }
-    end
-
-    test '#background is the first color if not specified' do
-      assert_equal '#7f7f7f', @colors.background
-    end
-
-    test '#background can be explicitly specified' do
-      @colors.background '#00ff00'
-      assert_equal '#00ff00', @colors.background
-    end
-
-    test '#background= is an alias of #background' do
-      @colors.background = '#00ff00'
-      assert_equal '#00ff00', @colors.background
-    end
-
-    test '#foreground is the last color if not specified' do
-      assert_equal '#ffffff', @colors.foreground
-    end
-
-    test '#foreground can be explicitly specified' do
-      @colors.foreground '#f0f0f0'
-      assert_equal '#f0f0f0', @colors.foreground
-    end
-
-    test '#foreground= is an alias of #foreground' do
-      @colors.foreground = '#f0f0f0'
-      assert_equal '#f0f0f0', @colors.foreground
-    end
-
-    test '#to_json includes the background and the foreground' do
-      @colors.background = '#00ff00'
-      @colors.foreground = '#f0f0f0'
-
-      expected_json = '["#7f7f7f","#ff0000","#00ff00","#ffff00","#5c5cff","#ff00ff","#00ffff","#ffffff","#00ff00","#f0f0f0"]'
-      assert_equal expected_json, @colors.to_json
-    end
-
-    test '#default is :light' do
-      assert_equal @colors.class.default, @colors.class.themes[:light]
-    end
-  end
-end

data/test/web_console/engine_test.rb

@@ -1,136 +0,0 @@
-require 'test_helper'
-
-module WebConsole
-  class EngineTest < ActiveSupport::TestCase
-    test 'custom default_mount_path' do
-      new_uninitialized_app do |app|
-        app.config.web_console.default_mount_path = '/shell'
-        app.initialize!
-
-        assert app.routes.named_routes['web_console'].path.match('/shell')
-      end
-    end
-
-    test 'disabling automounting' do
-      new_uninitialized_app do |app|
-        app.config.web_console.automount = false
-        app.initialize!
-
-        assert_not app.routes.named_routes['web_console']
-      end
-    end
-
-    test 'blank commands are expanded to the rails console' do
-      new_uninitialized_app do |app|
-        app.config.web_console.command = ' '
-        app.initialize!
-
-        expected_path = Rails.root.join('bin/rails console').to_s
-        assert_equal expected_path, app.config.web_console.command
-      end
-    end
-
-    test 'present commands are not processed' do
-      new_uninitialized_app do |app|
-        app.config.web_console.command = '/bin/login'
-        app.initialize!
-
-        assert_equal '/bin/login', app.config.web_console.command
-      end
-    end
-
-    test 'whitelisted ips are courced to IPAddr' do
-      new_uninitialized_app do |app|
-        app.config.web_console.whitelisted_ips = '127.0.0.1'
-        app.initialize!
-
-        assert_equal [ IPAddr.new('127.0.0.1') ], app.config.web_console.whitelisted_ips
-      end
-    end
-
-    test 'whitelisted ips are normalized and unique IPAddr' do
-      new_uninitialized_app do |app|
-        app.config.web_console.whitelisted_ips = [ '127.0.0.1', '127.0.0.1', nil, '', ' ' ]
-        app.initialize!
-
-        assert_equal [ IPAddr.new('127.0.0.1') ], app.config.web_console.whitelisted_ips
-      end
-    end
-
-    test 'whitelisted_ips.include? coerces to IPAddr' do
-      new_uninitialized_app do |app|
-        app.config.web_console.whitelisted_ips = '127.0.0.1'
-        app.initialize!
-
-        assert app.config.web_console.whitelisted_ips.include?('127.0.0.1')
-      end
-    end
-
-    test 'whitelisted_ips.include? works with IPAddr' do
-      new_uninitialized_app do |app|
-        app.config.web_console.whitelisted_ips = '127.0.0.1'
-        app.initialize!
-
-        assert app.config.web_console.whitelisted_ips.include?(IPAddr.new('127.0.0.1'))
-      end
-    end
-
-    test 'whitelist whole networks' do
-      new_uninitialized_app do |app|
-        app.config.web_console.whitelisted_ips = '172.16.0.0/12'
-        app.initialize!
-
-        1.upto(255).each do |n|
-          assert_includes app.config.web_console.whitelisted_ips, "172.16.0.#{n}"
-        end
-      end
-    end
-
-    test 'whitelist multiple networks' do
-      new_uninitialized_app do |app|
-        app.config.web_console.whitelisted_ips = %w( 172.16.0.0/12 192.168.0.0/16 )
-        app.initialize!
-
-        1.upto(255).each do |n|
-          assert_includes app.config.web_console.whitelisted_ips, "172.16.0.#{n}"
-          assert_includes app.config.web_console.whitelisted_ips, "192.168.0.#{n}"
-        end
-      end
-    end
-
-    private
-
-      def new_uninitialized_app(root = File.expand_path('../../dummy', __FILE__))
-        skip if Rails::VERSION::MAJOR == 3
-
-        old_app = Rails.application
-
-        FileUtils.mkdir_p(root)
-        Dir.chdir(root) do
-          Rails.application = nil
-
-          app = Class.new(Rails::Application)
-          app.config.eager_load = false
-          app.config.time_zone = 'UTC'
-          app.config.middleware ||= Rails::Configuration::MiddlewareStackProxy.new
-          app.config.active_support.deprecation = :notify
-
-          yield app
-        end
-      ensure
-        Rails.application = old_app
-      end
-
-      def teardown_fixtures(*)
-        super
-      rescue
-        # This is nasty hack to prevent a connection to the database in JRuby's
-        # activerecord-jdbcsqlite3-adapter. We don't really require a database
-        # connection, for the tests to run.
-        #
-        # The sad thing is that I couldn't figure out why does it only happens
-        # on activerecord-jdbcsqlite3-adapter and how to actually prevent it,
-        # rather than work-around it.
-      end
-  end
-end