debugger-xml 0.0.1

data/test/frame_test.rb

@@ -0,0 +1,29 @@
+require_relative 'test_helper'
+
+describe "Frame Command" do
+  include TestDsl
+  temporary_change_method_value(Debugger, :printer, Printers::Xml.new)
+
+  it "must print current stack frame when without arguments" do
+    enter 'break 25', 'cont', 'up', 'frame'
+    debug_file('frame')
+    check_output_includes %{<frame no="0" file="#{fullpath('frame')}" line="25" current="false"/>}
+  end
+
+  describe "full path settings" do
+    temporary_change_hash_value(Debugger::Command.settings, :full_path, false)
+
+    it "must display current backtrace with full path = true" do
+      enter 'set fullpath', 'break 25', 'cont', 'where'
+      debug_file('frame')
+      check_output_includes(Regexp.new(
+        "<frames>" +
+          %{<frame no="0" file="#{fullpath('frame')}" line="25" current="true"/>} +
+          %{<frame no="1" file="#{fullpath('frame')}" line="21" current="false"/>} +
+          %{<frame no="2" file="#{fullpath('frame')}" line="17" current="false"/>} +
+          %{<frame no="3" file="#{fullpath('frame')}" line="14" current="false"/>.*} +
+        "</frames>",
+      Regexp::MULTILINE))
+    end
+  end
+end

data/test/help_test.rb

@@ -0,0 +1,13 @@
+require_relative 'test_helper'
+
+describe "Help Command" do
+  include TestDsl
+  temporary_change_method_value(Debugger, :printer, Printers::Xml.new)
+
+  it "must be unsupported for XML printer" do
+    enter 'help'
+    debug_file 'help'
+    check_output_includes "<error>Unsupported command 'help'</error>", interface.error_queue
+  end
+
+end

data/test/ide_control_command_processor_test.rb

@@ -0,0 +1,62 @@
+require_relative 'test_helper'
+require 'debugger/xml/ide_processor'
+
+describe Debugger::Xml::IdeControlCommandProcessor do
+  include TestDsl
+
+  let(:klass) { Debugger::Xml::IdeControlCommandProcessor }
+  let(:interface) { Debugger.handler.interface }
+  let(:file) { fullpath('jump') }
+  let(:context) { stub(frame_binding: stub, stop_reason: nil, thread: stub, thnum: 1, stack_size: 2, dead?: false) }
+  subject { klass.new(interface) }
+  temporary_change_method_value(Debugger, :handler, Debugger::Xml::IdeProcessor.new(TestInterface.new))
+
+  before do
+    Thread.stubs(:stop)
+    Debugger.handler.instance_variable_set("@context", context)
+    Debugger.handler.instance_variable_set("@file", file)
+    Debugger.handler.instance_variable_set("@line", 30)
+  end
+
+  it "must process a control command" do
+    Debugger::AddBreakpoint.any_instance.expects(:execute).with()
+    enter 'break 5'
+    subject.process_commands
+  end
+
+  it "must process several commands, separated by ;" do
+    Debugger::AddBreakpoint.any_instance.expects(:execute).with()
+    Debugger::DeleteBreakpointCommand.any_instance.expects(:execute).with()
+    enter 'break 5; delete 1'
+    subject.process_commands
+  end
+
+  it "must show error if there is no such command" do
+    enter 'bla'
+    subject.process_commands
+    check_output_includes "Unknown command: bla"
+  end
+
+  it "must show error if context is dead" do
+    context.expects(:dead?).returns(true)
+    enter 'step'
+    subject.process_commands
+    check_output_includes "Command is unavailable"
+  end
+
+  it "must show error if no suspended thread" do
+    Debugger.handler.stubs(:at_line?).returns(false)
+    enter 'step'
+    subject.process_commands
+    check_output_includes(
+      "There is no thread suspended at the time and therefore no context to execute 'step'",
+    interface.error_queue)
+  end
+
+  it "must run stopped thread after stepping command" do
+    context.expects(:step).with(1, false)
+    context.thread.expects(:run)
+    enter 'step'
+    subject.process_commands
+  end
+end

data/test/ide_processor_test.rb

@@ -0,0 +1,118 @@
+require_relative 'test_helper'
+require 'debugger/xml/ide_processor'
+
+describe Debugger::Xml::IdeProcessor do
+  include TestDsl
+
+  before { Thread.stubs(:stop) }
+
+  let(:klass) { Debugger::Xml::IdeProcessor }
+  let(:interface) { TestInterface.new }
+  let(:breakpoint) { stub }
+  let(:context) { stub(thread: nil, stop_reason: nil, thnum: 1, stack_size: 2) }
+  let(:file) { fullpath('jump') }
+  subject { klass.new(interface) }
+
+  describe "#at_breakpoint" do
+    it "must assign breakpoint to instance variable" do
+      subject.at_breakpoint(context, breakpoint)
+      subject.instance_variable_get("@last_breakpoint").must_equal breakpoint
+    end
+
+    it "must raise error if @last_breakpoint is already assigned" do
+      subject.instance_variable_set("@last_breakpoint", breakpoint)
+      subject.at_breakpoint(context, breakpoint)
+      check_output_includes /INTERNAL ERROR!!!/
+    end
+
+    it "must not print anything" do
+      subject.at_breakpoint(context, breakpoint)
+      interface.must_be_empty
+    end
+  end
+
+  describe "#at_line" do
+    describe "print current position" do
+      it "must print if context is nil" do
+        subject.at_line(nil, file, 30)
+        check_output_includes "#{file}:30"
+      end
+
+      it "must print in xml" do
+        temporary_change_method_value(Debugger, :printer, Printers::Xml.new) do
+          subject.at_line(nil, file, 30)
+          check_output_includes %{<suspended file="#{file}" line="30" threadId="" frames=""/>}
+        end
+      end
+
+      it "must print if stop reason is :step" do
+        context.stubs(:stop_reason).returns(:step)
+        subject.at_line(context, file, 30)
+        check_output_includes "#{file}:30"
+      end
+
+      it "must clear instance variables after resuming thread" do
+        subject.instance_variable_set("@line", 10)
+        subject.at_line(context, file, 30)
+        subject.instance_variable_get("@line").must_be_nil
+      end
+
+      describe "print breakpoint after at_breakpoint" do
+        before do
+          Debugger.stubs(:breakpoints).returns([breakpoint])
+          Debugger.stubs(:current_context).returns(stub(thnum: 1))
+          subject.instance_variable_set("@last_breakpoint", breakpoint)
+        end
+
+        it "must print in plain text" do
+          subject.at_line(context, file, 30)
+          check_output_includes "Breakpoint 1 at #{file}:30"
+        end
+
+        it "must print in xml" do
+          temporary_change_method_value(Debugger, :printer, Printers::Xml.new) do
+            subject.at_line(context, file, 30)
+            check_output_includes %{<breakpoint file="#{file}" line="30" threadId="1"/>}
+          end
+        end
+      end
+
+      it "must show error if current thread is DebugThread" do
+        context.stubs(:thread).returns(Debugger::DebugThread.new {})
+        subject.at_line(context, file, 30)
+        check_output_includes /DebuggerThread are not supposed to be traced/
+      end
+    end
+  end
+
+  describe "#at_line?" do
+    it "returns false if #at_line was not called yet" do
+      subject.at_line?.must_equal false
+    end
+
+    it "returns true if #at_line was called already" do
+      subject.instance_variable_set("@line", 10)
+      subject.at_line?.must_equal true
+    end
+  end
+
+  describe "#at_return?" do
+    before { context.stubs(:stop_frame=).with(-1) }
+
+    it "sets stop_frame to -1" do
+      context.expects(:stop_frame=).with(-1)
+      subject.at_return(context, file, 30)
+    end
+
+    it "prints current file and line" do
+      subject.at_return(context, file, 30)
+      check_output_includes "#{file}:30"
+    end
+
+    it "stops the thread" do
+      Thread.expects(:stop)
+      subject.at_return(context, file, 30)
+    end
+  end
+
+end

data/test/info_test.rb

@@ -0,0 +1,12 @@
+require_relative 'test_helper'
+
+describe "Info Command" do
+  include TestDsl
+  temporary_change_method_value(Debugger, :printer, Printers::Xml.new)
+
+  it "must be unsupported for XML printer" do
+    enter 'info line'
+    debug_file 'info'
+    check_output_includes "<error>Unsupported command 'info'</error>", interface.error_queue
+  end
+end

data/test/irb_test.rb

@@ -0,0 +1,12 @@
+require_relative 'test_helper'
+
+describe "Irb Command" do
+  include TestDsl
+  temporary_change_method_value(Debugger, :printer, Printers::Xml.new)
+
+  it "must be unsupported for XML printer" do
+    enter 'irb'
+    debug_file 'irb'
+    check_output_includes "<error>Unsupported command 'irb'</error>", interface.error_queue
+  end
+end

data/test/jump_test.rb

@@ -0,0 +1,22 @@
+require_relative 'test_helper'
+
+describe "Jump Command" do
+  include TestDsl
+  temporary_change_method_value(Debugger, :printer, Printers::Xml.new)
+
+  describe "successful" do
+    describe "jumping to the same line" do
+      it "must show show the same position" do
+        enter 'break 6', 'cont', "jump 6 #{fullpath('jump')}"
+        debug_file('jump')
+        check_output_includes /<suspended file="#{fullpath('jump')}" line="6" threadId="\d+" frames="\d+"\/>/
+      end
+    end
+
+    it "must show message after jump" do
+      enter 'break 6', 'cont', "jump 8 #{fullpath('jump')}"
+      debug_file('jump')
+      check_output_includes /<suspended file="#{fullpath('jump')}" line="8" threadId="\d+" frames="\d+"\/>/
+    end
+  end
+end

data/test/kill_test.rb

@@ -0,0 +1,13 @@
+require_relative 'test_helper'
+
+describe "Kill Command" do
+  include TestDsl
+  temporary_change_method_value(Debugger, :printer, Printers::Xml.new)
+
+  it "must be unsupported for XML printer" do
+    enter 'kill'
+    debug_file 'kill'
+    check_output_includes "<error>Unsupported command 'kill'</error>", interface.error_queue
+  end
+
+end

data/test/method_test.rb

@@ -0,0 +1,36 @@
+require_relative 'test_helper'
+
+describe "Method Command" do
+  include TestDsl
+  temporary_change_method_value(Debugger, :printer, Printers::Xml.new)
+
+  describe "show instance method of a class" do
+    it "must show using full command name" do
+      enter 'break 15', 'cont', 'm MethodEx'
+      debug_file 'method'
+      check_output_includes '<methods><method name="bla"/></methods>'
+    end
+  end
+
+  describe "show methods of an object" do
+    it "must show using full command name" do
+      enter 'break 15', 'cont', 'method instance a'
+      debug_file 'method'
+      check_output_includes /<methods>.*<method name="bla"\/>.*<\/methods>/
+    end
+  end
+
+  describe "show instance variables of an object" do
+    it "must show using full name command" do
+      enter 'break 15', 'cont', 'method iv a'
+      debug_file 'method'
+      check_output_includes(Regexp.new(
+        %{<variables>} +
+          %{<variable name="@a" kind="instance" value="b" type="String" hasChildren="false" objectId=".*?"/>} +
+          %{<variable name="@c" kind="instance" value="d" type="String" hasChildren="false" objectId=".*?"/>} +
+        %{</variables>}
+      ))
+    end
+  end
+
+end

data/test/printers/xml_test.rb

@@ -0,0 +1,193 @@
+require_relative '../test_helper'
+
+describe "Printers::Xml" do
+  include PrinterHelpers
+
+  let(:klass) { Printers::Xml }
+  let(:printer) { klass.new }
+  let(:yaml_xml) do
+    {
+      "foo" => {
+        "errors" => {
+          "bad" => "bad behavior"
+        },
+        "confirmations" => {
+          "okay" => "Okay?"
+        },
+        "debug" => {
+          "dbg" => "Debug message"
+        },
+        "bar" => {
+          "tag" => "xmltag",
+          "attributes" => {
+            "boo" => "{zee} > {uga}",
+            "agu" => "bew"
+          }
+        }
+      },
+      "variable" => {
+        "variable" => {
+          "tag" => "variable",
+          "attributes" => {
+            "name" => "{name}",
+            "kind" => "{kind}",
+            "value" => "{value}",
+            "type" => "{type}",
+            "hasChildren" => "{has_children}",
+            "objectId" => "{id}"
+          }
+        }
+      }
+    }
+  end
+
+  before do
+    YAML.stubs(:load_file).with(yaml_file_path('xml')).returns(yaml_xml)
+    YAML.stubs(:load_file).with(yaml_file_path('base')).returns({})
+  end
+
+  describe "#print" do
+    it "must return correctly translated string" do
+      xml = ::Builder::XmlMarkup.new.xmltag(boo: "zuu > aga", agu: "bew")
+      printer.print("foo.bar", zee: "zuu", uga: "aga").must_equal xml
+    end
+
+    it "must return error string" do
+      printer.print("foo.errors.bad").must_equal "<error>bad behavior</error>"
+    end
+
+    it "must return confirmation string" do
+      printer.print("foo.confirmations.okay").must_equal "<confirmation>Okay?</confirmation>"
+    end
+
+    it "must return debug string" do
+      printer.print("foo.debug.dbg").must_equal "Debug message"
+    end
+  end
+
+  describe "#print_collection" do
+    it "must print collection" do
+      expected = ::Builder::XmlMarkup.new.xmltags do |x|
+        x.xmltag(boo: "0 > a", agu: "bew") + x.xmltag(boo: "1 > b", agu: "bew")
+      end
+      result = printer.print_collection("foo.bar", [{uga: 'a'}, {uga: 'b'}]) do |item, index|
+        item.merge(zee: index)
+      end
+      result.must_equal expected
+    end
+  end
+
+  describe "#print_variables" do
+    it "must print variables" do
+      vars = [["a", "b"], ["c", "d"]]
+      expected = ::Builder::XmlMarkup.new.variables do |x|
+        vars.map do |key, value|
+          x.variable(name: key, kind: "instance", value: value, type: "String", hasChildren: "false", objectId: "%#+x" % value.object_id)
+        end.join("")
+      end
+      result = printer.print_variables(vars, 'instance')
+      result.must_equal expected
+    end
+  end
+
+  describe "Printers::Xml::Variable" do
+    let(:klass) { Printers::Xml::Variable }
+
+    describe "#has_children?" do
+      describe "value is Array" do
+        it("must be true for non-empty") { klass.new('bla', ['a']).has_children?.must_equal(true) }
+        it("must be false for empty") { klass.new('bla', []).has_children?.must_equal(false) }
+      end
+
+      describe "value is Hash" do
+        it("must be true for non-empty") { klass.new('bla', {a: 'b'}).has_children?.must_equal(true) }
+        it("must be false for empty") { klass.new('bla', {}).has_children?.must_equal(false) }
+      end
+
+      describe "value is some random class" do
+        unless const_defined?("VariableExampleWithInstanceVars")
+          class VariableExampleWithInstanceVars; def initialize; @a = '1'; end; end
+        end
+        unless const_defined?("VariableExampleWithClassVars")
+          class VariableExampleWithClassVars; def initialize; @@a = '1'; end; end
+        end
+        unless const_defined?("VariableExampleWithoutVars")
+          class VariableExampleWithoutVars; end
+        end
+        it("must be true if has instance variables") { klass.new('bla', VariableExampleWithInstanceVars.new).has_children?.must_equal(true) }
+        it("must be true if has class variables") { klass.new('bla', VariableExampleWithClassVars.new).has_children?.must_equal(true) }
+        it("must be false if has no any variables") { klass.new('bla', VariableExampleWithoutVars.new).has_children?.must_equal(false) }
+        it("must be false as a fallback") { klass.new('bla', BasicObject.new).has_children?.must_equal(false) }
+      end
+    end
+
+    describe "#value" do
+      describe "value is a Array" do
+        it("must return string for empty") { klass.new('bla', []).value.must_equal("Empty Array") }
+        it("must return result for non-empty") { klass.new('bla', [1, 2]).value.must_equal("Array (2 element(s))") }
+      end
+
+      describe "value is a Hash" do
+        it("must return string for empty") { klass.new('bla', {}).value.must_equal("Empty Hash") }
+        it("must return result for non-empty") { klass.new('bla', {a: 'b', c: 'd'}).value.must_equal("Hash (2 element(s))") }
+      end
+
+      describe "value is some random class" do
+        unless const_defined?("ToSReturnNotAString")
+          class ToSReturnNotAString; def to_s; {}; end; end
+        end
+        it("must return nil for nil") { klass.new('bla', nil).value.must_equal("nil") }
+        it("must return #to_s for any other class") do
+          klass.new('bla', OpenStruct.new(a: 'b')).value.must_equal '#<OpenStruct a="b">'
+        end
+        it("must be able to show error") do
+          klass.new('bla', BasicObject.new).value.must_match /<raised exception: undefined method/
+        end
+        it("must get rid of quotes") { klass.new('bla', '"foo"').value.must_equal 'foo' }
+        it("must return special message for binary") { klass.new('bla', "\xFF\x12").value.must_equal '[Binary Data]' }
+        it("must show error if returned value is not a string") do
+          klass.new('bla', ToSReturnNotAString.new).value.must_equal(
+            'ERROR: ToSReturnNotAString.to_s method returns Hash. Should return String.'
+          )
+        end
+      end
+    end
+
+    describe "#id" do
+      it "must show object_id" do
+        object = Object.new
+        klass.new('bla', object).id.must_equal("%#+x" % object.object_id)
+      end
+
+      it "must return nil as a fallback" do
+        klass.new('bla', BasicObject.new).id.must_be_nil
+      end
+    end
+
+    describe "#type" do
+      it "must return class" do
+        klass.new('bla', Object.new).type.must_equal(Object.new.class)
+      end
+
+      it "must return 'Undefined' as a callback" do
+        klass.new('bla', BasicObject.new).type.must_equal "Undefined"
+      end
+    end
+
+    describe "#name" do
+      it "must return name as a string" do
+        klass.new(:bla, "value").name.must_equal "bla"
+      end
+    end
+
+    describe "#to_hash" do
+      it "must return a hash with values" do
+        var = "foo"
+        klass.new(:bla, var).to_hash.must_equal(
+          {name: "bla", kind: nil, value: var, type: String, has_children: false, id: "%#+x" % var.object_id}
+        )
+      end
+    end
+
+  end
+end