web-console 2.0.0 → 2.1.0

data/test/support/scenarios/bad_custom_error_scenario.rb

@@ -0,0 +1,17 @@
+module WebConsole
+  class BadCustomErrorScenario
+    class Error < StandardError
+      def initialize(*)
+        # Bad exceptions are exceptions that don't call super in there
+        # #initialize method.
+      end
+    end
+
+    def call
+      raise Error
+    rescue => exc
+      exc
+    end
+  end
+end
+

data/test/support/scenarios/basic_nested_scenario.rb

@@ -0,0 +1,15 @@
+module WebConsole
+  class BasicNestedScenario
+    def call
+      raise_an_error
+    rescue => exc
+      exc
+    end
+
+    private
+
+    def raise_an_error
+      raise
+    end
+  end
+end

data/test/support/scenarios/custom_error_scenario.rb

@@ -0,0 +1,11 @@
+module WebConsole
+  class CustomErrorScenario
+    Error = Class.new(StandardError)
+
+    def call
+      raise Error
+    rescue => exc
+      exc
+    end
+  end
+end

data/test/support/scenarios/eval_nested_scenario.rb

@@ -0,0 +1,15 @@
+module WebConsole
+  class EvalNestedScenario
+    def call
+      tap { raise_an_error_in_eval }
+    rescue => exc
+      exc
+    end
+
+    private
+
+    def raise_an_error_in_eval
+      eval 'raise', binding, __FILE__, __LINE__
+    end
+  end
+end

data/test/support/scenarios/flat_scenario.rb

@@ -0,0 +1,9 @@
+module WebConsole
+  class FlatScenario
+    def call
+      raise
+    rescue => exc
+      exc
+    end
+  end
+end

data/test/support/scenarios/reraised_scenario.rb

@@ -0,0 +1,21 @@
+module WebConsole
+  class ReraisedScenario
+    def call
+      reraise_an_error
+    rescue => exc
+      exc
+    end
+
+    private
+
+    def raise_an_error_in_eval
+      method_that_raises
+    rescue => exc
+      raise exc
+    end
+
+    def method_that_raises
+      raise
+    end
+  end
+end

data/test/test_helper.rb

@@ -1,5 +1,8 @@
-require 'simplecov'
-SimpleCov.start 'rails'
+case RUBY_ENGINE
+when 'ruby', 'rbx'
+  require 'simplecov'
+  SimpleCov.start 'rails'
+end
 
 # Configure Rails Environment
 ENV["RAILS_ENV"] = "test"
@@ -19,10 +22,54 @@ module SilenceRailsDomTesting
   end
 end
 
-ActionController::TestCase.class_eval do
+# Allows you to specify test to run only on specific Ruby platforms.
+#
+# Example:
+#
+#   test 'CRuby specific feature', only: :ruby
+#   test 'CRuby and JRuby specific feature', only: %w(ruby jruby)
+#
+# If the :only option isn't present, the test is defined for all the platforms.
+module PlatformSpecificTestMacro
+  def test(name, options = {})
+    platforms = Array(options[:only]).map(&:to_s)
+
+    if platforms.blank? || RUBY_ENGINE.in?(platforms)
+      super(name)
+    end
+  end
+end
+
+ActiveSupport::TestCase.class_eval do
+  extend PlatformSpecificTestMacro
+end
+
+ActionDispatch::IntegrationTest.class_eval do
   include SilenceRailsDomTesting
 end
 
+# A copy of Kernel#capture in active_support/core_ext/kernel/reporting.rb as
+# its getting deprecated past 4.2. Its not thread safe, but I don't need it to
+# be in the tests
+def capture(stream)
+  stream = stream.to_s
+  captured_stream = Tempfile.new(stream)
+  stream_io = eval("$#{stream}")
+  origin_stream = stream_io.dup
+  stream_io.reopen(captured_stream)
+
+  yield
+
+  stream_io.rewind
+  return captured_stream.read
+ensure
+  captured_stream.close
+  captured_stream.unlink
+  stream_io.reopen(origin_stream)
+end
+
+alias silence capture
+
 # Load fixtures from the engine
 if ActiveSupport::TestCase.method_defined?(:fixture_path=)
   ActiveSupport::TestCase.fixture_path = File.expand_path("../fixtures", __FILE__)

data/test/web_console/evaluator_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+module WebConsole
+  class EvaluatorTest < ActiveSupport::TestCase
+    class TestError < StandardError
+      def backtrace
+        [
+          "/web-console/lib/web_console/repl.rb:16:in `eval'",
+          "/web-console/lib/web_console/repl.rb:16:in `eval'"
+        ]
+      end
+    end
+
+    class BadlyDefinedError < StandardError
+      def backtrace
+        nil
+      end
+    end
+
+    setup do
+      @repl1 = @repl = Evaluator.new
+      @repl2         = Evaluator.new
+    end
+
+    test 'sending input returns the result as output' do
+      assert_equal "=> 42\n", @repl.eval('foo = 42')
+    end
+
+    test 'preserves the session in the binding' do
+      assert_equal "=> 42\n", @repl.eval('foo = 42')
+      assert_equal "=> 50\n", @repl.eval('foo + 8')
+    end
+
+    test 'session preservation requires same bindings' do
+      assert_equal "=> 42\n", @repl1.eval('foo = 42')
+      assert_equal "=> 42\n", @repl2.eval('foo')
+    end
+
+    test 'formats exceptions similarly to IRB' do
+      repl = Evaluator.new(binding)
+
+      assert_equal <<-END.strip_heredoc, repl.eval("raise TestError, 'panic'")
+        #{TestError.name}: panic
+        \tfrom /web-console/lib/web_console/repl.rb:16:in `eval'
+        \tfrom /web-console/lib/web_console/repl.rb:16:in `eval'
+      END
+    end
+
+    test 'no backtrace is shown if exception backtrace is blank' do
+      repl = Evaluator.new(binding)
+
+      assert_equal <<-END.strip_heredoc, repl.eval("raise BadlyDefinedError")
+        #{BadlyDefinedError.name}: #{BadlyDefinedError.name}
+      END
+    end
+
+    test 'Evaluator callers are cleaned up of unneeded backtraces', only: :ruby do
+      # Those have to be on the same line to get the same trace.
+      repl, trace = Evaluator.new(binding), current_trace
+
+      assert_equal <<-END.strip_heredoc, repl.eval("raise")
+        RuntimeError: 
+        \tfrom #{trace}
+      END
+    end
+
+    private
+
+      def current_trace
+        caller.first
+      end
+  end
+end

data/test/web_console/helper_test.rb

@@ -0,0 +1,76 @@
+require 'test_helper'
+
+module WebConsole
+  class HelperTest < ActionDispatch::IntegrationTest
+    class BaseApplication
+      include Helper
+
+      def call(env)
+        Rack::Response.new(<<-HTML.strip_heredoc).finish
+          <html>
+            <head>
+              <title>Hello world</title>
+            </head>
+            <body>
+              <p id="hello-world">Hello world</p>
+            </body>
+          </html>
+        HTML
+      end
+
+      private
+
+        def request
+          Request.new(@env)
+        end
+    end
+
+    class SingleConsoleApplication < BaseApplication
+      def call(env)
+        @env = env
+
+        console
+
+        super
+      end
+    end
+
+    class MultipleConsolesApplication < BaseApplication
+      def call(env)
+        @env = env
+
+        console
+        console
+
+        super
+      end
+    end
+
+    setup do
+      Request.stubs(:whitelisted_ips).returns(IPAddr.new('0.0.0.0/0'))
+
+      @app = Middleware.new(SingleConsoleApplication.new)
+    end
+
+    test 'renders a console into a view' do
+      get '/', nil, 'CONTENT_TYPE' => 'text/html'
+
+      assert_select '#console'
+    end
+
+    test 'raises an error when trying to spawn a console more than once' do
+      @app = Middleware.new(MultipleConsolesApplication.new)
+
+      assert_raises(DoubleRenderError) do
+        get '/', nil, 'CONTENT_TYPE' => 'text/html'
+      end
+    end
+
+    test "doesn't hijack current view" do
+      get '/', nil, 'CONTENT_TYPE' => 'text/html'
+
+      assert_select '#hello-world'
+      assert_select '#console'
+    end
+  end
+end

data/test/web_console/integration_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+module WebConsole
+  class IntegrationTest < ActiveSupport::TestCase
+    test 'Exception#bindings returns all the bindings of where the error originated' do
+      exc = FlatScenario.new.call
+
+      assert_equal 4, exc.bindings.first.eval('__LINE__')
+    end
+
+    test 'Exception#bindings returns all the bindings for a custom error' do
+      exc = CustomErrorScenario.new.call
+
+      assert_equal 6, exc.bindings.first.eval('__LINE__')
+    end
+
+    test 'Exception#bindings returns all the bindings for a bad custom error' do
+      exc = BadCustomErrorScenario.new.call
+
+      assert_equal 11, exc.bindings.first.eval('__LINE__')
+    end
+
+    test 'Exception#bindings goes down the stack' do
+      exc = BasicNestedScenario.new.call
+
+      assert_equal 12, exc.bindings.first.eval('__LINE__')
+    end
+
+    test 'Exception#bindings inside of an eval' do
+      exc = EvalNestedScenario.new.call
+
+      assert_equal 12, exc.bindings.first.eval('__LINE__')
+    end
+
+    test "re-raising doesn't lose Exception#bindings information" do
+      exc = ReraisedScenario.new.call
+
+      assert_equal 4, exc.bindings.first.eval('__LINE__')
+    end
+
+    test 'Exception#bindings is empty when exception is still not raised' do
+      exc = RuntimeError.new
+
+      assert_equal [], exc.bindings
+    end
+  end
+end

data/test/web_console/middleware_test.rb

@@ -0,0 +1,116 @@
+require 'test_helper'
+
+module WebConsole
+  class MiddlewareTest < ActionDispatch::IntegrationTest
+    class Application
+      def call(env)
+        Rack::Response.new(<<-HTML.strip_heredoc).finish
+          <html>
+            <head>
+              <title>Hello world</title>
+            </head>
+            <body>
+              <p id="hello-world">Hello world</p>
+            </body>
+          </html>
+        HTML
+      end
+    end
+
+    setup do
+      Request.stubs(:whitelisted_ips).returns(IPAddr.new('0.0.0.0/0'))
+
+      @app = Middleware.new(Application.new)
+    end
+
+    test 'render console in an html application from web_console.binding' do
+      get '/', nil, 'CONTENT_TYPE' => 'text/html', 'web_console.binding' => binding
+
+      assert_select '#console'
+    end
+
+    test 'render console in an html application from web_console.exception' do
+      get '/', nil, 'CONTENT_TYPE' => 'text/html', 'web_console.exception' => raise_exception
+
+      assert_select '#console'
+    end
+
+    test 'prioritizes web_console.exception over web_console.binding' do
+      exception = raise_exception
+
+      Session.expects(:from_exception).with(exception)
+
+      get '/', nil, 'CONTENT_TYPE' => 'text/html', 'web_console.binding' => binding, 'web_console.exception' => exception
+    end
+
+    test 'render console in an html application with non text/html' do
+      get '/', nil, 'CONTENT_TYPE' => 'application/xhtml+xml', 'web_console.binding' => binding
+
+      assert_select '#console'
+    end
+
+    test "doesn't render console in non html application" do
+      get '/', nil, 'CONTENT_TYPE' => 'application/json', 'web-console.binding' => binding
+
+      assert_select '#console', 0
+    end
+
+    test "doesn't render console from non whitelisted IP" do
+      Request.stubs(:whitelisted_ips).returns(IPAddr.new('127.0.0.1'))
+
+      silence(:stderr) do
+        get '/', nil, 'CONTENT_TYPE' => 'text/html', 'REMOTE_ADDR' => '1.1.1.1', 'web-console.binding' => binding
+      end
+
+      assert_select '#console', 0
+    end
+
+    test "doesn't render console without a web_console.binding or web_console.exception" do
+      get '/', nil, 'CONTENT_TYPE' => 'text/html'
+
+      assert_select '#console', 0
+    end
+
+    test 'can evaluate code and return it as a JSON' do
+      session, line = Session.new(binding), __LINE__
+
+      Session.stubs(:from_binding).returns(session)
+
+      get '/', nil, 'CONTENT_TYPE' => 'text/html', 'web-console.binding' => binding
+      xhr :put, "/repl_sessions/#{session.id}", { input: '__LINE__' }
+
+      assert_equal({ output: "=> #{line}\n" }.to_json, response.body)
+    end
+
+    test 'can switch bindings on error pages' do
+      session = Session.new(exception = raise_exception)
+
+      Session.stubs(:from_exception).returns(session)
+
+      get '/', nil, 'CONTENT_TYPE' => 'text/html', 'web-console.exception' => exception
+      xhr :post, "/repl_sessions/#{session.id}/trace", { frame_id: 1 }
+
+      assert_equal({ ok: true }.to_json, response.body)
+    end
+
+    test 'unavailable sessions respond to the user with a message' do
+      xhr :put, '/repl_sessions/no_such_session', { input: '__LINE__' }
+
+      assert_equal(404, response.status)
+    end
+
+    test 'unavailable sessions can occur on binding switch' do
+      xhr :post, "/repl_sessions/no_such_session/trace", { frame_id: 1 }
+
+      assert_equal(404, response.status)
+    end
+
+    private
+
+      def raise_exception
+        raise
+      rescue => exc
+        exc
+      end
+  end
+end