seafoam 0.2

data/spec/seafoam/command_spec.rb

@@ -0,0 +1,252 @@
+require 'stringio'
+require 'tempfile'
+
+require 'seafoam'
+
+require 'rspec'
+
+describe Seafoam::Commands do
+  before :all do
+    @fib_java = File.expand_path('../../examples/fib-java.bgv', __dir__)
+  end
+
+  before :each do
+    @out = StringIO.new
+    @commands = Seafoam::Commands.new(@out, {})
+  end
+
+  describe '#info' do
+    it 'prints format and version' do
+      @commands.send :info, @fib_java
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines.first).to eq 'BGV 6.1'
+    end
+
+    it 'does not work on a graph' do
+      expect { @commands.send :info, "#{@fib_java}:0" }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#list' do
+    it 'prints graphs' do
+      @commands.send :list, @fib_java
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines.take(5)).to eq [
+        "#{@fib_java}:0  2:Fib.fib(int)/After phase org.graalvm.compiler.java.GraphBuilderPhase",
+        "#{@fib_java}:1  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.PhaseSuite",
+        "#{@fib_java}:2  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.DeadCodeEliminationPhase",
+        "#{@fib_java}:3  2:Fib.fib(int)/After parsing",
+        "#{@fib_java}:4  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.CanonicalizerPhase"
+      ]
+      expect(lines.drop(lines.length - 5)).to eq [
+        "#{@fib_java}:46  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.PropagateDeoptimizeProbabilityPhase",
+        "#{@fib_java}:47  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.common.InsertMembarsPhase",
+        "#{@fib_java}:48  2:Fib.fib(int)/After phase org.graalvm.compiler.phases.schedule.SchedulePhase",
+        "#{@fib_java}:49  2:Fib.fib(int)/After phase org.graalvm.compiler.core.phases.LowTier",
+        "#{@fib_java}:50  2:Fib.fib(int)/After low tier"
+      ]
+    end
+
+    it 'does not work on a graph' do
+      expect { @commands.send :list, "#{@fib_java}:0" }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#search' do
+    it 'finds terms in files' do
+      @commands.send :search, @fib_java, 'MethodCallTarget'
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines.take(5)).to eq [
+        "#{@fib_java}:0:12  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir...",
+        "#{@fib_java}:0:17  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir...",
+        "#{@fib_java}:1:12  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir...",
+        "#{@fib_java}:1:17  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir...",
+        "#{@fib_java}:2:12  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir..."
+      ]
+    end
+
+    it 'finds terms in graphs' do
+      @commands.send :search, "#{@fib_java}:0", 'MethodCallTarget'
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines).to eq [
+        "#{@fib_java}:0:12  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir...",
+        "#{@fib_java}:0:17  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir..."
+      ]
+    end
+
+    it 'is case-insensitive' do
+      @commands.send :search, @fib_java, 'methodcalltarget'
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines.take(5)).to eq [
+        "#{@fib_java}:0:12  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir...",
+        "#{@fib_java}:0:17  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir...",
+        "#{@fib_java}:1:12  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir...",
+        "#{@fib_java}:1:17  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir...",
+        "#{@fib_java}:2:12  ...class\":\"org.graalvm.compiler.nodes.java.MethodCallTargetNode\",\"name_template\":\"\",\"inputs\":[{\"dir..."
+      ]
+    end
+
+    it 'does not work on a node' do
+      expect { @commands.send :search, "#{@fib_java}:0:0" }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#edges' do
+    it 'prints the number of edges and nodes for a graph' do
+      @commands.send :edges, "#{@fib_java}:0"
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines.first).to eq '22 nodes, 30 edges'
+    end
+
+    it 'prints the edges for a node' do
+      @commands.send :edges, "#{@fib_java}:0:13"
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines).to eq [
+        'Input:',
+        '  13 (Call Fib.fib) <-() 6 (Begin)',
+        '  13 (Call Fib.fib) <-() 14 (FrameState Fib#fib Fib.java:20)',
+        '  13 (Call Fib.fib) <-() 12 (MethodCallTarget)',
+        'Output:',
+        '  13 (Call Fib.fib) ->() 18 (Call Fib.fib)',
+        '  13 (Call Fib.fib) ->(values) 14 (FrameState Fib#fib Fib.java:20)',
+        '  13 (Call Fib.fib) ->(values) 19 (FrameState Fib#fib Fib.java:20)',
+        '  13 (Call Fib.fib) ->(x) 20 (+)'
+      ]
+    end
+
+    it 'prints details for an edge' do
+      @commands.send :edges, "#{@fib_java}:0:13-18"
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines.first).to eq '13 (Call Fib.fib) ->() 18 (Call Fib.fib)'
+    end
+
+    it 'does not work on a file' do
+      expect { @commands.send :edges, @fib_java }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#props' do
+    it 'prints properties for a file' do
+      @commands.send :props, @fib_java.to_s
+      expect(@out.string.gsub(/\n\n/, "\n")).to eq "{\n}\n"
+    end
+
+    it 'prints properties for a graph' do
+      @commands.send :props, "#{@fib_java}:0"
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines[3]).to include '"name": "2:Fib.fib(int)"'
+    end
+
+    it 'prints properties for a node' do
+      @commands.send :props, "#{@fib_java}:0:13"
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines[3]).to include '"declaring_class": "Fib"'
+    end
+
+    it 'prints properties for an edge' do
+      @commands.send :props, "#{@fib_java}:0:13-18"
+      lines = @out.string.lines.map(&:rstrip)
+      expect(lines[2]).to include '"name": "next"'
+    end
+  end
+
+  describe '#render' do
+    it 'does not work on a file' do
+      expect { @commands.send :render, @fib_java }.to raise_error(ArgumentError)
+    end
+
+    it 'can render all BGV files to dot' do
+      Seafoam::SpecHelpers::SAMPLE_BGV.each do |file|
+        @commands.send :render, "#{file}:7", '--out', 'out.dot'
+      end
+    end
+
+    it 'supports -o out.pdf' do
+      @commands.send :render, "#{@fib_java}:0", '--out', 'out.pdf'
+      expect(`file out.pdf`).to start_with 'out.pdf: PDF document'
+    end
+
+    it 'supports -o out.svg' do
+      @commands.send :render, "#{@fib_java}:0", '--out', 'out.svg'
+      expect(`file out.svg`).to start_with 'out.svg: SVG Scalable Vector Graphics image'
+    end
+
+    it 'supports -o out.png' do
+      @commands.send :render, "#{@fib_java}:0", '--out', 'out.png'
+      expect(`file out.png`).to start_with 'out.png: PNG image data'
+    end
+
+    it 'supports -o out.dot' do
+      @commands.send :render, "#{@fib_java}:0", '--out', 'out.dot'
+      expect(`file out.dot`).to start_with 'out.dot: ASCII text'
+    end
+
+    it 'supports spotlighting nodes' do
+      @commands.send :render, "#{@fib_java}:0", '--spotlight', '13'
+    end
+
+    it 'does not work on a node' do
+      expect { @commands.send :render, "#{@fib_java}:0:13" }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#debug' do
+    it 'does not work with a graph' do
+      expect { @commands.send :debug, "#{@fib_java}:0" }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#help' do
+    it 'does not take any arguments' do
+      expect { @commands.send :help, 'foo' }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#version' do
+    it 'does not take any arguments' do
+      expect { @commands.send :help, 'foo' }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#parse_name' do
+    it 'parses file.bgv' do
+      file, graph, node, edge = @commands.send(:parse_name, 'file.bgv')
+      expect(file).to eq 'file.bgv'
+      expect(graph).to be_nil
+      expect(node).to be_nil
+      expect(edge).to be_nil
+    end
+
+    it 'parses file.bgv:14' do
+      file, graph, node, edge = @commands.send(:parse_name, 'file.bgv:14')
+      expect(file).to eq 'file.bgv'
+      expect(graph).to eq 14
+      expect(node).to be_nil
+      expect(edge).to be_nil
+    end
+
+    it 'parses file.bgv:14:12' do
+      file, graph, node, edge = @commands.send(:parse_name, 'file.bgv:14:12')
+      expect(file).to eq 'file.bgv'
+      expect(graph).to eq 14
+      expect(node).to eq 12
+      expect(edge).to be_nil
+    end
+
+    it 'parses file.bgv:14:12-81' do
+      file, graph, node, edge = @commands.send(:parse_name, 'file.bgv:14:12-81')
+      expect(file).to eq 'file.bgv'
+      expect(graph).to eq 14
+      expect(node).to eq 12
+      expect(edge).to eq 81
+    end
+
+    it 'parses a realistic knarly BGV file name' do
+      file, graph, node, edge = @commands.send(:parse_name, '../graal_dumps/2019.11.03.19.35.03.828/TruffleHotSpotCompilation-13320[while_loop_at__Users_chrisseaton_src_github.com_Shopify_truffleruby-shopify_src_main_ruby_truffleruby_core_kernel.rb:360<OSR>].bgv:14:12-81')
+      expect(file).to eq '../graal_dumps/2019.11.03.19.35.03.828/TruffleHotSpotCompilation-13320[while_loop_at__Users_chrisseaton_src_github.com_Shopify_truffleruby-shopify_src_main_ruby_truffleruby_core_kernel.rb:360<OSR>].bgv'
+      expect(graph).to eq 14
+      expect(node).to eq 12
+      expect(edge).to eq 81
+    end
+  end
+end

data/spec/seafoam/graph_spec.rb

@@ -0,0 +1,172 @@
+require 'seafoam'
+
+require 'rspec'
+
+describe Seafoam::Graph do
+  describe '#initialize' do
+    it 'set properties' do
+      graph = Seafoam::Graph.new(a: 12)
+      expect(graph.props[:a]).to eq 12
+    end
+  end
+
+  describe '#create_node' do
+    it 'adds a node to the graph' do
+      graph = Seafoam::Graph.new
+      node = graph.create_node(14)
+      expect(graph.nodes.values).to include node
+    end
+
+    it 'set properties' do
+      graph = Seafoam::Graph.new
+      node = graph.create_node(14, a: 12)
+      expect(node.props[:a]).to eq 12
+    end
+
+    it 'returns the node' do
+      graph = Seafoam::Graph.new
+      node = graph.create_node(14)
+      expect(node.id).to eq 14
+    end
+  end
+
+  describe '#create_edge' do
+    it 'adds an edge to the graph' do
+      graph = Seafoam::Graph.new
+      from = graph.create_node(14)
+      to = graph.create_node(2)
+      edge = graph.create_edge(from, to)
+      expect(graph.edges).to include edge
+    end
+
+    it 'set properties' do
+      graph = Seafoam::Graph.new
+      from = graph.create_node(14)
+      to = graph.create_node(2)
+      edge = graph.create_edge(from, to, a: 12)
+      expect(edge.props[:a]).to eq 12
+    end
+
+    it 'returns the edge' do
+      graph = Seafoam::Graph.new
+      from = graph.create_node(14)
+      to = graph.create_node(2)
+      edge = graph.create_edge(from, to)
+      expect(edge.from).to eq from
+      expect(edge.to).to eq to
+    end
+  end
+end
+
+describe Seafoam::Node do
+  describe '#inputs' do
+    it 'returns only input edges' do
+      graph = Seafoam::Graph.new
+      node_a = graph.create_node(1)
+      node_b = graph.create_node(2)
+      node_c = graph.create_node(3)
+      node_d = graph.create_node(4)
+      in_edge = graph.create_edge(node_a, node_b)
+      out_edge = graph.create_edge(node_b, node_c)
+      unrelated_edge = graph.create_edge(node_c, node_d)
+      expect(node_b.inputs).to include in_edge
+      expect(node_b.inputs).to_not include out_edge
+      expect(node_b.inputs).to_not include unrelated_edge
+    end
+  end
+
+  describe '#outputs' do
+    it 'returns only output edges' do
+      graph = Seafoam::Graph.new
+      node_a = graph.create_node(1)
+      node_b = graph.create_node(2)
+      node_c = graph.create_node(3)
+      node_d = graph.create_node(4)
+      in_edge = graph.create_edge(node_a, node_b)
+      out_edge = graph.create_edge(node_b, node_c)
+      unrelated_edge = graph.create_edge(node_c, node_d)
+      expect(node_b.outputs).to_not include in_edge
+      expect(node_b.outputs).to include out_edge
+      expect(node_b.outputs).to_not include unrelated_edge
+    end
+  end
+
+  describe '#edges' do
+    it 'returns both input and output edges' do
+      graph = Seafoam::Graph.new
+      node_a = graph.create_node(1)
+      node_b = graph.create_node(2)
+      node_c = graph.create_node(3)
+      node_d = graph.create_node(4)
+      in_edge = graph.create_edge(node_a, node_b)
+      out_edge = graph.create_edge(node_b, node_c)
+      unrelated_edge = graph.create_edge(node_c, node_d)
+      expect(node_b.edges).to include in_edge
+      expect(node_b.edges).to include out_edge
+      expect(node_b.edges).to_not include unrelated_edge
+    end
+  end
+
+  describe '#adjacent' do
+    it 'returns nodes from both input and output edges' do
+      graph = Seafoam::Graph.new
+      node_a = graph.create_node(1)
+      node_b = graph.create_node(2)
+      node_c = graph.create_node(3)
+      node_d = graph.create_node(4)
+      graph.create_edge node_a, node_b
+      graph.create_edge node_b, node_c
+      graph.create_edge node_c, node_d
+      expect(node_b.adjacent).to include node_a
+      expect(node_b.adjacent).to include node_c
+      expect(node_b.adjacent).to_not include node_d
+    end
+  end
+
+  describe '#id_and_label' do
+    it 'returns an id and label if there is one' do
+      node = Seafoam::Node.new(14, label: 'foo')
+      expect(node.id_and_label).to eq '14 (foo)'
+    end
+
+    it 'returns just an id if there is no label' do
+      node = Seafoam::Node.new(14)
+      expect(node.id_and_label).to eq '14'
+    end
+  end
+end
+
+describe Seafoam::Edge do
+  describe '#from' do
+    it 'returns the from node' do
+      graph = Seafoam::Graph.new
+      node_a = graph.create_node(1)
+      node_b = graph.create_node(2)
+      edge = graph.create_edge(node_a, node_b)
+      expect(edge.from).to eq node_a
+    end
+  end
+
+  describe '#to' do
+    it 'returns the to node' do
+      graph = Seafoam::Graph.new
+      node_a = graph.create_node(1)
+      node_b = graph.create_node(2)
+      edge = graph.create_edge(node_a, node_b)
+      expect(edge.to).to eq node_b
+    end
+  end
+
+  describe '#nodes' do
+    it 'returns both the from and to node' do
+      graph = Seafoam::Graph.new
+      node_a = graph.create_node(1)
+      node_b = graph.create_node(2)
+      node_c = graph.create_node(3)
+      edge = graph.create_edge(node_a, node_b)
+      expect(edge.nodes).to include node_a
+      expect(edge.nodes).to include node_b
+      expect(edge.nodes).to_not include node_c
+    end
+  end
+end

data/spec/seafoam/graphviz_writer_spec.rb

@@ -0,0 +1,63 @@
+require 'stringio'
+
+require 'seafoam'
+
+require 'rspec'
+
+require_relative 'spec_helpers'
+
+describe Seafoam::GraphvizWriter do
+  describe '#write_graph' do
+    before :all do
+      file = File.expand_path('../../examples/fib-java.bgv', __dir__)
+      parser = Seafoam::BGV::BGVParser.new(File.new(file))
+      parser.read_file_header
+      parser.read_graph_preheader
+      parser.read_graph_header
+      @fib_java_graph = parser.read_graph
+    end
+
+    before :each do
+      @stream = StringIO.new
+      @writer = Seafoam::GraphvizWriter.new(@stream)
+    end
+
+    it 'writes the header' do
+      @writer.write_graph @fib_java_graph
+      expect(@stream.string).to start_with 'digraph G {'
+    end
+
+    it 'writes all graphs' do
+      Seafoam::SpecHelpers::SAMPLE_BGV.each do |file|
+        parser = Seafoam::BGV::BGVParser.new(File.new(file))
+        parser.read_file_header
+        parser.skip_document_props
+        parser.skip_document_props
+        loop do
+          index, = parser.read_graph_preheader
+          break unless index
+
+          parser.read_graph_header
+          @writer.write_graph parser.read_graph
+        end
+      end
+    end
+  end
+
+  describe '#quote' do
+    it 'adds quotes' do
+      writer = Seafoam::GraphvizWriter.new(nil)
+      expect(writer.send(:quote, 'foo')).to eq '"foo"'
+    end
+
+    it 'escapes an existing quote' do
+      writer = Seafoam::GraphvizWriter.new(nil)
+      expect(writer.send(:quote, 'foo"bar')).to eq '"foo\"bar"'
+    end
+
+    it 'escapes an existing escape' do
+      writer = Seafoam::GraphvizWriter.new(nil)
+      expect(writer.send(:quote, 'foo\bar')).to eq '"foo\\bar"'
+    end
+  end
+end