flok 0.0.12 → 0.0.14

data/spec/kern/debug_spec.rb

@@ -0,0 +1,38 @@
+Dir.chdir File.join File.dirname(__FILE__), '../../'
+require './spec/env/kern.rb'
+require './spec/lib/helpers.rb'
+require './spec/lib/io_extensions.rb'
+require './spec/lib/rspec_extensions.rb'
+
+#The debug controller / ui spec
+
+RSpec.describe "kern:debug_spec" do
+  include_context "kern"
+
+ it "Can retreive the controller's context" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller_context.rb')
+
+    #Do not run anything
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["my_view", {}, base+1, ["main"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {"hello" => "world"}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "index"}])
+
+    #Request context for view controller
+    @driver.int "int_debug_controller_context", [base]
+    @driver.mexpect("if_event", [-333, "debug_controller_context_res", {
+      "hello" => "world"
+    }])
+  end
+end

data/spec/kern/debug_ui_spec.rb

@@ -0,0 +1,243 @@
+Dir.chdir File.join File.dirname(__FILE__), '../../'
+require './spec/env/kern.rb'
+require './spec/lib/helpers.rb'
+require './spec/lib/io_extensions.rb'
+require './spec/lib/rspec_extensions.rb'
+
+#The debug controller / ui spec
+
+RSpec.describe "kern:debug_ui_spec" do
+  include_context "kern"
+
+it "Can call int_debug_dump_ui and get back root view hierarchy" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller_bare.rb')
+
+    #Do not run anything
+    ctx.eval %{
+      int_dispatch([]);
+    }
+
+    @driver.int "int_debug_dump_ui", []
+
+    @driver.mexpect("if_event", [-333, "debug_dump_ui_res", {
+      "type" => "spot",
+      "name" => "root",
+      "ptr" => 0,
+      "children" => []
+    }])
+  end
+
+ it "Can call int_debug_dump_ui for one controller correctly" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller_bare.rb')
+
+    #Do not run anything
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["my_view", {}, base+1, ["main"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "index"}])
+
+    @driver.int "int_debug_dump_ui", []
+    @driver.mexpect("if_event", [-333, "debug_dump_ui_res", {
+      "type" => "spot",
+      "name" => "root",
+      "ptr" => 0,
+      "children" => [
+        {
+          "name" => "my_controller",
+          "ptr" => base,
+          "type" => "vc",
+          "action" => "index",
+          "children" => [
+            {
+              "type" => "view",
+              "name" => "my_view",
+              "ptr" => base+1,
+              "children" => []
+            }
+          ]
+        }
+      ]
+    }])
+  end
+
+  it "Can call int_debug_dump_ui for one controller correctly with spots" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller_spots.rb')
+
+    #Do not run anything
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["my_view", {}, base+1, ["main", "one", "two"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "index"}])
+
+    @driver.int "int_debug_dump_ui", []
+    @driver.mexpect("if_event", [-333, "debug_dump_ui_res", {
+      "type" => "spot",
+      "name" => "root",
+      "ptr" => 0,
+      "children" => [
+        {
+          "name" => "my_controller",
+          "ptr" => base,
+          "type" => "vc",
+          "action" => "index",
+          "children" => [
+            {
+              "type" => "view",
+              "name" => "my_view",
+              "ptr" => base+1,
+              "children" => [
+                {"name" => "one", "type" => "spot", "children" => [], "ptr" => base+2},
+                {"name" => "two", "type" => "spot", "children" => [], "ptr" => base+3},
+              ]
+            }
+          ]
+        }
+      ]
+    }])
+  end
+
+  it "Can call int_debug_dump_ui for one controller correctly with spots and one embedded" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller_spots_embed.rb')
+
+    #Do not run anything
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["my_view", {}, base+1, ["main", "one", "two"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_init_view", ["my_other_view", {}, base+5, ["main"]])
+    @driver.mexpect("if_controller_init", [base+4, base+5, "my_other_controller", {}])
+    @driver.mexpect("if_attach_view", [base+5, base+2])
+    @driver.mexpect("if_event", [base+4, "action", {"from" => nil, "to" => "index"}])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "index"}])
+
+    @driver.int "int_debug_dump_ui", []
+    @driver.mexpect("if_event", [-333, "debug_dump_ui_res", {
+      "type" => "spot",
+      "name" => "root",
+      "ptr" => 0,
+      "children" => [
+        {
+          "name" => "my_controller",
+          "ptr" => base,
+          "type" => "vc",
+          "action" => "index",
+          "children" => [
+            {
+              "type" => "view",
+              "name" => "my_view",
+              "ptr" => base+1,
+              "children" => [
+                {"name" => "one", "type" => "spot", "children" => [
+                  {
+                    "name" => "my_other_controller",
+                    "ptr" => base+4,
+                    "type" => "vc",
+                    "action" => "index",
+                    "children" => [
+                      {
+                        "type" => "view",
+                        "ptr" => base+5,
+                        "name" => "my_other_view",
+                        "children" => [],
+                      }
+                    ]
+                  }
+                ], "ptr" => base+2},
+                {"name" => "two", "type" => "spot", "children" => [], "ptr" => base+3},
+              ]
+            }
+          ]
+        }
+      ]
+    }])
+  end
+
+  it "Can call int_debug_dump_ui for one controller correctly with spots and one embedded that was later removed" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/controller_spots_embed_removed.rb')
+
+    #Do not run anything
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue
+      int_dispatch([3, "int_event", base, "next", {}]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["my_view", {}, base+1, ["main", "one", "two"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_init_view", ["my_other_view", {}, base+5, ["main"]])
+    @driver.mexpect("if_controller_init", [base+4, base+5, "my_other_controller", {}])
+    @driver.mexpect("if_attach_view", [base+5, base+2])
+    @driver.mexpect("if_event", [base+4, "action", {"from" => nil, "to" => "index"}])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "index"}])
+
+    #Expect the view to be removed, and for our action to switch
+    @driver.mexpect("if_free_view", [base+5])
+    @driver.mexpect("if_event", [base, "action", {"from" => "index", "to" => "other"}])
+
+    @driver.int "int_debug_dump_ui", []
+    @driver.mexpect("if_event", [-333, "debug_dump_ui_res", {
+      "type" => "spot",
+      "name" => "root",
+      "ptr" => 0,
+      "children" => [
+        {
+          "name" => "my_controller",
+          "ptr" => base,
+          "type" => "vc",
+          "action" => "other",
+          "children" => [
+            {
+              "type" => "view",
+              "name" => "my_view",
+              "ptr" => base+1,
+              "children" => [
+                {"name" => "one", "type" => "spot", "children" => [], "ptr" => base+2},
+                {"name" => "two", "type" => "spot", "children" => [], "ptr" => base+3},
+              ]
+            }
+          ]
+        }
+      ]
+    }])
+  end
+
+end

data/spec/kern/net_spec.rb

@@ -0,0 +1,14 @@
+#Anything and everything to do with networking above the driver level
+
+Dir.chdir File.join File.dirname(__FILE__), '../../'
+require './spec/env/kern.rb'
+require './spec/lib/helpers.rb'
+require './spec/lib/io_extensions.rb'
+require './spec/lib/rspec_extensions.rb'
+
+RSpec.describe "kern:net_spec" do
+  include_context "kern"
+
+  it "can call get_req() and returns to the correct callback" do
+  end
+end

data/spec/kern/rest_service_spec.rb

@@ -0,0 +1,45 @@
+#Anything and everything to do with view controllers (not directly UI) above the driver level
+
+Dir.chdir File.join File.dirname(__FILE__), '../../'
+require './spec/env/kern.rb'
+require './spec/lib/helpers.rb'
+require './spec/lib/io_extensions.rb'
+require './spec/lib/rspec_extensions.rb'
+
+RSpec.describe "kern:rest_service_spec" do
+  include_context "kern"
+
+  #Can initialize a controller via embed and have the correct if_dispatch messages
+  it "Can initiate a controller via _embed" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/rest_service.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue with a test event
+      int_dispatch([3, "int_event", base, "start_request", {}]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["test_view", {}, base+1, ["main", "hello", "world"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "my_action"}])
+
+    #Emulate the if_net driver
+    if_net_req = @driver.get("if_net_req", 1) #1 is the network queue
+
+    #int_net_cb(tp, success, info)
+    secret = SecureRandom.hex
+    @driver.int "int_net_cb", [if_net_req[3], true, {:secret => secret}] #if_net_req[3] is the telepointer
+
+    #Now we expect to have 'response' set as the controller event handler "request_response"
+    #should have been called
+    response = JSON.parse(ctx.eval("JSON.stringify(response)"))
+    expect(response).to eq({"success"=> true, "info" => {"secret" => secret}})
+  end
+end

data/spec/kern/timer_service_spec.rb

@@ -0,0 +1,40 @@
+Dir.chdir File.join File.dirname(__FILE__), '../../'
+require './spec/env/kern.rb'
+require './spec/lib/helpers.rb'
+require './spec/lib/io_extensions.rb'
+require './spec/lib/rspec_extensions.rb'
+
+RSpec.describe "kern:timer_service_spec" do
+  include_context "kern"
+
+  #Can initialize a controller via embed and have the correct if_dispatch messages
+  it "Can initiate a controller via _embed" do
+    #Compile the controller
+    ctx = flok_new_user File.read('./spec/kern/assets/timer_service.rb')
+
+    #Run the embed function
+    ctx.eval %{
+      //Call embed on main root view
+      base = _embed("my_controller", 0, {}, null);
+
+      //Drain queue with a test event
+      int_dispatch([3, "int_event", base, "start_request", {}]);
+    }
+
+    base = ctx.eval("base")
+
+    @driver.mexpect("if_init_view", ["test_view", {}, base+1, ["main", "hello", "world"]])
+    @driver.mexpect("if_controller_init", [base, base+1, "my_controller", {}])
+    @driver.mexpect("if_attach_view", [base+1, 0])
+    @driver.mexpect("if_event", [base, "action", {"from" => nil, "to" => "my_action"}])
+
+    #Emulate the if_timer driver
+    @driver.int("int_timer")
+    @driver.int("int_timer")
+    @driver.int("int_timer")
+    @driver.int("int_timer")
+
+    response = ctx.eval("did_tick")
+    expect(response).to eq(true)
+  end
+end

data/spec/lib/helpers.rb

@@ -0,0 +1,318 @@
+require 'securerandom'
+require 'json'
+require 'webrick'
+
+#Duplex pipe
+###################################################################################################################
+class IO
+  def self.duplex_pipe
+    return DuplexPipe.new
+  end
+end
+
+class DuplexPipe
+  def initialize
+    @r0, @w0 = IO.pipe
+    @r1, @w1 = IO.pipe
+  end
+
+  #Choose arbitrary side, just different ones for forked processes
+  def claim_low
+    @r = @r0
+    @w = @w1
+  end
+
+
+
+  def claim_high
+    @r = @r1
+    @w = @w0
+  end
+
+  def write msg
+    @w.write msg
+  end
+
+  def puts msg
+    @w.puts msg
+  end
+
+  def readline
+    @r.readline
+  end
+end
+###################################################################################################################
+
+#RESTful mock
+###################################################################################################################
+module Webbing
+  def self.get path, port=nil, &block
+    Webbing.new "GET", path, port, &block
+  end
+
+  class Webbing
+    attr_accessor :pid
+    attr_accessor :port
+
+    def kill
+      Process.kill(:KILL, @pid)
+    end
+
+    def initialize verb, path, port=nil, &block
+      @verb = verb
+      @path = path
+      @block = block
+      @port = port || rand(30000)+3000
+
+      @pipe = IO.duplex_pipe
+      @pid = fork do
+        @pipe.claim_high
+        @server = ::WEBrick::HTTPServer.new :Port => @port, :DocumentRoot => ".", :StartCallback => Proc.new {
+          @pipe.puts("ready")
+        }
+        @server.mount_proc '/' do |req, res|
+          @pipe.puts req.query.to_json
+          res.body = @pipe.readline
+          res.header["Access-Control-Allow-Origin"] = "*"
+          res.header["Content-Type"] = "json/text"
+        end
+        @server.mount_proc '/404' do |req, res|
+          res.header["Access-Control-Allow-Origin"] = "*"
+
+          raise WEBrick::HTTPStatus::NotFound
+        end
+        @server.start
+      end
+
+      @pipe.claim_low
+      @pipe.readline #Wait for 'ready'
+      Thread.new do
+        begin
+          loop do
+            params = JSON.parse(@pipe.readline)
+            res = @block.call(params)
+            @pipe.puts res.to_json
+          end
+        rescue => e
+          $stderr.puts "Exception: #{e.inspect}"
+        end
+      end
+    end
+  end
+end
+###################################################################################################################
+
+
+require 'open3'
+require 'net/http'
+require 'uri'
+require 'json'
+
+#Services configuration
+GUI_PORT=3333
+DEBUG_CHROME_WS_PORT=4444 #The port WebSocket clients connect to (liek chrome)
+
+module SpecHelpers
+#Run a command from a list of arguments, the last argument, if it is a Regexp,
+#will be waited_for before executing the block.
+def sh *args, &block
+  #If the last argument is a regular expression, wait for that regular expression
+  #before executing the block
+  if args.last.class == Regexp
+    wait_for = args.pop
+  end
+
+  #Keep track of when we are done because the stderr and stdout repeater
+  #will throw an exception which we can ignore at that point
+  finished = false
+
+  #Keep track of when we are done finished waiting so we can signal that we never
+  #finished waiting if the timeout occurrs. Also keep track of the waiting stdout
+  #and stderr messages to display in the timeout during waiting exception
+  finished_waiting = false
+  waiting_out = StringIO.new
+
+  #Start the command, at this poiunt, we poped the regular experssion if there was one
+  Open3.popen3 *args do |inp, out, err, t|
+    pid = t[:pid] #Capture pid now as it will be unavailable later
+    begin
+      Timeout::timeout(10) do
+        #Always Report the $stderr async
+        Thread.new do
+          begin
+            loop do
+              $stderr.puts err.readline
+            end
+          rescue => e
+            next if finished #Pipe was already closed by Process.kill in ensure
+            $stderr.puts "[#{str.inspect} threw an exception]: #{e}"
+          end
+        end
+
+        #Should we wait to execute the block until something appears on stdout?
+        if wait_for
+          raise "wait_for given for chrome #{code.inspect} must be a regex. You passed #{wait_for.inspect}" unless wait_for.class == Regexp
+          begin
+            loop do
+              wait_for_res = out.readline
+              waiting_out << wait_for_res
+              break if wait_for_res =~ wait_for
+            end
+          rescue EOFError
+            msg = StringIO.new
+            msg.puts "While waiting for command #{args[0].inspect} for #{wait_for.inspect}, the command closed the pipe (it terminated) and returned:"
+            msg.puts "-"*100 << "\n"
+            msg.puts  waiting_out.string
+            msg.puts "-"*100
+            raise msg.string
+          end
+        end
+      end
+
+      #Done waiting, timeout is no longer a problem
+      finished_waiting = true
+
+      #Report stdout now
+      Thread.new do
+        begin
+          loop do
+            $stderr.puts out.readline
+          end
+        rescue => e
+          next if finished #Pipe was already closed by Process.kill in ensure
+          $stderr.puts "[#{str.inspect} threw an exception]: #{e}"
+        end
+      end
+
+      #Execute the block
+      block.call
+    rescue Timeout::Error
+      if finished_waiting
+        raise "Timeout for command #{args[0].inspect} during executing your ruby block"
+      else
+        msg = StringIO.new
+        msg.puts "Timeout for command #{args[0].inspect} while waiting for #{wait_for.inspect} received:"
+        msg.puts "-"*100 << "\n"
+        msg.puts  waiting_out.string
+        msg.puts "-"*100
+        raise msg.string
+      end
+    ensure
+      #Kill the process when the block is finished executing
+      begin
+        finished = true
+        Process.kill :INT, pid
+      rescue Errno::ESRCH
+      end
+    end
+  end
+end
+
+#Alot like sh but instead of outputting the stdout, it allows you to read it through the block
+def sh2 *args
+  #If the last argument is a regular expression, wait for that regular expression
+  #before executing the block
+  if args.last.class == Regexp
+    wait_for = args.pop
+  end
+
+  #Keep track of when we are done because the stderr and stdout repeater
+  #will throw an exception which we can ignore at that point
+  finished = false
+
+  #Keep track of when we are done finished waiting so we can signal that we never
+  #finished waiting if the timeout occurrs. Also keep track of the waiting stdout
+  #and stderr messages to display in the timeout during waiting exception
+  finished_waiting = false
+  waiting_out = StringIO.new
+
+  #Start the command, at this poiunt, we poped the regular experssion if there was one
+  Open3.popen3 *args do |inp, out, err, t|
+    pid = t[:pid] #Capture pid now as it will be unavailable later
+    begin
+      Timeout::timeout(10) do
+        #Always Report the $stderr async
+        Thread.new do
+          begin
+            loop do
+              $stderr.puts err.readline
+            end
+          rescue => e
+            next if finished #Pipe was already closed by Process.kill in ensure
+            $stderr.puts "[#{str.inspect} threw an exception]: #{e}"
+          end
+        end
+
+        #Should we wait to execute the block until something appears on stdout?
+        if wait_for
+          raise "wait_for given for chrome #{code.inspect} must be a regex. You passed #{wait_for.inspect}" unless wait_for.class == Regexp
+          begin
+            loop do
+              wait_for_res = out.readline
+              waiting_out << wait_for_res
+              break if wait_for_res =~ wait_for
+            end
+          rescue EOFError
+            msg = StringIO.new
+            msg.puts "While waiting for command #{args[0].inspect} for #{wait_for.inspect}, the command closed the pipe (it terminated) and returned:"
+            msg.puts "-"*100 << "\n"
+            msg.puts  waiting_out.string
+            msg.puts "-"*100
+            raise msg.string
+          end
+        end
+      end
+
+      #Done waiting, timeout is no longer a problem
+      finished_waiting = true
+
+      #Execute the block
+      yield inp, out
+    rescue Timeout::Error
+      if finished_waiting
+        raise "Timeout for command #{args[0].inspect} during executing your ruby block"
+      else
+        msg = StringIO.new
+        msg.puts "Timeout for command #{args[0].inspect} while waiting for #{wait_for.inspect} received:"
+        msg.puts "-"*100 << "\n"
+        msg.puts  waiting_out.string
+        msg.puts "-"*100
+        raise msg.string
+      end
+    ensure
+      #Kill the process when the block is finished executing
+      begin
+        finished = true
+        Process.kill :INT, pid
+      rescue Errno::ESRCH
+      end
+    end
+  end
+end
+
+#Execute some chrome code
+def chrome code, wait_for
+  #Load js assets
+  js_assets = Dir["./spec/assets/*.js"]
+  f = Tempfile.new(SecureRandom.hex)
+  js_assets.each do |fn|
+    f.puts File.read(fn)
+  end
+
+  f.puts code
+  f.close
+  sh "boojs", f.path, wait_for do
+    yield
+  end
+end
+
+#Get the result at an endpoint
+def get endpoint
+  uri = URI.parse(endpoint)
+  http = Net::HTTP.new(uri.host, uri.port)
+  request = Net::HTTP::Get.new(uri.request_uri)
+  response = http.request(request)
+
+  return JSON.parse(response.body)
+end
+end