web-console 2.0.0.beta2 → 2.0.0.beta3

data/test/models/console_session_test.rb

@@ -0,0 +1,58 @@
+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

@@ -0,0 +1,58 @@
+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

@@ -0,0 +1,136 @@
+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

data/test/web_console/slave_test.rb

@@ -0,0 +1,71 @@
+require 'stringio'
+require 'test_helper'
+
+module WebConsole
+  class SlaveTest < ActiveSupport::TestCase
+    setup do
+      PTY.stubs(:spawn).returns([StringIO.new, StringIO.new, Random.rand(20000)])
+      @slave = Slave.new
+    end
+
+    test '#send_input raises ArgumentError on bad input' do
+      assert_raises(ArgumentError) { @slave.send_input(nil) }
+      assert_raises(ArgumentError) { @slave.send_input('') }
+    end
+
+    test '#pending_output returns nil on no pending output' do
+      @slave.stubs(:pending_output?).returns(false)
+      assert_nil @slave.pending_output
+    end
+
+    test '#pending_output returns a string with the current output' do
+      @slave.stubs(:pending_output?).returns(true)
+      @slave.instance_variable_get(:@output).stubs(:read_nonblock).returns('foo', nil)
+      assert_equal 'foo', @slave.pending_output
+    end
+
+    test '#pending_output always encodes output in UTF-8' do
+      @slave.stubs(:pending_output?).returns(true)
+      @slave.instance_variable_get(:@output).stubs(:read_nonblock).returns('foo', nil)
+      assert_equal Encoding::UTF_8, @slave.pending_output.encoding
+    end
+
+    Slave::READING_ON_CLOSED_END_ERRORS.each do |exception|
+      test "#pending_output raises Slave::Closed when the end raises #{exception}" do
+        @slave.stubs(:pending_output?).returns(true)
+        @slave.instance_variable_get(:@output).stubs(:read_nonblock).raises(exception)
+
+        assert_raises(Slave::Closed) { @slave.pending_output }
+      end
+    end
+
+    test '#configure changes @input dimentions' do
+      @slave.instance_variable_get(:@input).expects(:winsize=).with([32, 64])
+      @slave.configure(height: 32, width: 64)
+    end
+
+    test '#configure only changes the @input dimentions if width is zero' do
+      @slave.instance_variable_get(:@input).expects(:winsize=).never
+      @slave.configure(height: 32, width: 0)
+    end
+
+    test '#configure only changes the @input dimentions if height is zero' do
+      @slave.instance_variable_get(:@input).expects(:winsize=).never
+      @slave.configure(height: 0, width: 64)
+    end
+
+    { dispose: :SIGTERM, dispose!: :SIGKILL }.each do |method, signal|
+      test "##{method} sends #{signal} to the process and detaches it" do
+        Process.expects(:kill).with(signal, @slave.pid)
+        @slave.send(method)
+      end
+
+      test "##{method} can reraise Errno::ESRCH if requested" do
+        Process.expects(:kill).with(signal, @slave.pid)
+        Process.stubs(:detach).raises(Errno::ESRCH)
+
+        assert_raises(Errno::ESRCH) { @slave.send(method, raise: true) }
+      end
+    end
+  end
+end