iface.rb

require './spec/env/global.rb'
require 'json'
require './spec/lib/rspec_extensions'
require 'open3'
require 'timeout'
require 'securerandom'
require './lib/flok'
require './spec/lib/io_extensions'
require './spec/lib/helpers'

shared_context "iface:kern" do
  before(:each) do
    @pipe = IO.popen("rake pipe:kern", "r+")
    @pid = @pipe.pid
    @mods = Flok::Platform.mods ENV['FLOK_ENV']
  end

  after(:each) do
    begin
      Process.kill(:KILL, @pid)
    rescue Errno::ESRCH
    end
  end
end

shared_context "iface:driver" do
  include SpecHelpers
  before(:each) do 
    @pipe = IO.popen("rake pipe:driver", "r+") 
    wait_for_load = @pipe.readline
    $stderr.puts "waiting for LOADED from pipe"
    raise "Your pipe should have emitted LOADED at the start when it was ready, instead got #{wait_for_load.inspect}" if wait_for_load.strip != "LOADED"
    $stderr.puts "got LOADED from pipe"
    @pid = @pipe.pid
    @mods = Flok::Platform.mods ENV['FLOK_ENV']
  end

  after(:each) do
    begin
      @pipe.close
      Process.kill(:INT, @pid)
    rescue Errno::ESRCH
    rescue IOError => e
      $stderr.puts "WARNING: while closing pipe got: #{e.inspect}"
    end
  end
end

#Get a list of modules based on the platform and environment
def mods
  Flok::Platform.mods ENV['FLOK_ENV']
end

def defines
  Flok::Platform.defines ENV['FLOK_ENV']
end

def config_yml
  Flok::Platform.config_yml ENV['FLOK_ENV']
end

#Ensure this platform supports a module, or skip the test (used inside before(:each) describe block, or `it` block)
def module_dep name
  before(:each) do
    skip "#{ENV["PLATFORM"].inspect} does not support #{name.inspect} module in config.yml" unless mods.include? name
  end
end

#Similar to module_dep this checks for a defines as well, useful for optional specs
def module_dep_defines(name:, defines:)
  before(:each) do
    if mods.include? name
      unless (Flok::Platform.defines ENV["FLOK_ENV"])[defines]
        skip "#{ENV["PLATFORM"].inspect} does support #{name.inspect} module but does not define #{defines} in config.yml"
      end
    else
        skip "#{ENV["PLATFORM"].inspect} does not support #{name.inspect} module in config.yml"
    end
  end
end


#Require a key value to be a apart of the config yml
def settings_dep key, value
  raise "#{ENV["PLATFORM"].inspect} does not support #{key.inspect} configuration in config.yml" unless config_yml.include? key
  skip "#{ENV["PLATFORM"].inspect} #{key.inspect} is not #{value.inspect} in config.yml; it is #{config_yml[key].inspect}"  unless value == config_yml[key]
end

#Restart the driver but persist any data that was saved
def restart_driver_but_persist
  #Ensure the pipe is fully drained before sending RESTART
  @pipe.puts [[0, 0, "ping"]].to_json; @pipe.readline_timeout

  @pipe.puts "RESTART"
  begin
    Timeout::timeout(10) do
      expect(@pipe.readline).to eq("RESTART OK\n")
    end
  rescue Timeout::Error
    raise "Tried to restart driver but timed out waiting for 'RESTART OK'"
  end
end

#Do not persist
def hard_restart_driver
  #Ensure the pipe is fully drained before sending RESTART
  @pipe.puts [[0, 0, "ping"]].to_json; @pipe.readline_timeout

  @pipe.puts "HARD_RESTART"
  begin
    Timeout::timeout(10) do
      expect(@pipe.readline).to eq("RESTART OK\n")
    end
  rescue Timeout::Error
    raise "Tried to HARD restart driver but timed out waiting for 'RESTART OK'"
  end
end