scout-camp 0.1.13 → 0.1.14

data/scout_commands/glob

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+require 'scout-camp'
+
+$0 = "scout #{$previous_commands.any? ? $previous_commands*" " + " " : "" }#{ File.basename(__FILE__) }" if $previous_commands
+
+options = SOPT.setup <<EOF
+
+Find files
+
+$ #{$0} [<options>] (<resource> <path>|<path>)
+
+-h--help Print this help
+-r--requires* Files to require; 'all' for all in Scout.etc.requires
+-lw--load_workflow* Files to require; 'all' for all in Scout.etc.requires
+-w--where* Where to look for the path
+EOF
+if options[:help]
+  if defined? scout_usage
+    scout_usage 
+  else
+    puts SOPT.doc
+  end
+  exit 0
+end
+
+resource, path = ARGV
+path, resource = resource, nil if path.nil?
+
+raise MissingParameterException.new(:path) if path.nil?
+
+case options[:workflows]
+when nil, false, "false", "none"
+when "all"
+  Scout.etc.workflows.list.each do |workflow|
+    Workflow.require_workflow file
+  end if Scout.etc.workflows.exists?
+else
+  options[:workflows].split(/[ ,;|]/).each do |workflow|
+    Workflow.require_workflow workflow
+  end
+end
+
+case options[:requires]
+when nil, false, "false", "none"
+when "all"
+  Scout.etc.requires.list.each do |file|
+    require file
+  end if Scout.etc.requires.exists?
+else
+  options[:requires].split(/[ ,;|]/).each do |file|
+    require file
+  end
+end
+
+location = nil
+where = options[:where]
+all = options[:all]
+
+begin
+  resource = Workflow.require_workflow resource
+rescue
+  begin
+    resource = Kernel.const_get(resource)
+  rescue
+    raise "Resource not found: #{ resource }"
+  end
+end if resource
+
+path = (resource || Scout)[path.dup]
+
+if where.nil? || where == 'all' || path.path_maps.include?(where.to_sym)
+  case where
+  when nil
+    location = path.glob
+  when 'all'
+    location = path.glob_all
+  else
+    location = path.find(where).glob
+  end
+
+  if Array === location
+    puts location * "\n"
+  else
+    location = nil if ! Open.exists?(location)
+    puts location
+  end
+else
+  puts SSHLine.command(where, $0, ARGV, options.merge("where" => :all, add_option_dashes: true))
+end

data/share/aws/lambda_function.rb

@@ -4,21 +4,19 @@ def lambda_handler(event:, context:)
   Path.path_maps[:bucket] = "s3://#{ENV["AWS_BUCKET"]}/{TOPLEVEL}/{SUBPATH}"
   Path.path_maps[:default] = :bucket
 
+
   require 'scout/workflow'
   require 'scout/aws/s3'
 
-  TmpFile.tmpdir = Path.setup('/tmp')
-  Open.sensible_write_dir = Path.setup('/tmp/sensible_write')
 
   Log.info "Payload: #{Log.fingerprint(event)}"
 
-  workflow, task_name, jobname, inputs, clean, queue, info = IndiferentHash.process_options event,
-    :workflow, :task_name, :jobname, :inputs, :clean, :queue, :info
+  workflow, task_name, jobname, inputs, clean, queue, info, path = IndiferentHash.process_options event,
+    :workflow, :task_name, :jobname, :inputs, :clean, :queue, :info, :path
 
+  task_name = "path" if path
   raise ParameterException, "No workflow specified" if workflow.nil?
 
-  workflow = Workflow.require_workflow workflow
-
   case task_name
   when nil
     return {tasks: workflow.tasks.keys, documentation: workflow.documentation}
@@ -28,7 +26,20 @@ def lambda_handler(event:, context:)
   else
     Workflow.job_cache.clear
 
-    job = workflow.job(task_name, jobname, inputs)
+    TmpFile.tmpdir = Path.setup('/tmp')
+    Open.sensible_write_dir = Path.setup('/tmp/sensible_write')
+
+    if path
+      job = Step.load path
+      task_name = job.task_name
+      workflow = job.workflow
+      wait = true
+    else
+      workflow = Workflow.require_workflow workflow
+      job = workflow.job(task_name, jobname, inputs)
+    end
+
+    Log.info "Job info: #{job.info}"
 
     case clean
     when true, 'true'
@@ -37,29 +48,41 @@ def lambda_handler(event:, context:)
       job.recursive_clean
     end
 
-    if info
-      info = job.info.dup
-      info["path"] = job.path
-      info
-    elsif job.done?
-      job.load
-    elsif job.error?
-      raise job.exception
-    elsif job.started?
-      {
-        statusCode: 202,
-        body: job.path
-      }
-    elsif queue
-      save_inputs = Scout.var.queue[workflow.to_s][task_name][job.name].find :bucket
-      job.save_input_bundle(save_inputs) unless save_inputs.exists?
-      {
-        statusCode: 202,
-        body: job.path
-      }
-    else
-      job.produce
-      job.load
+    begin
+      if info
+        info = job.info.dup
+        info["path"] = job.path
+        {info: info}
+      elsif job.done?
+        job.load_info unless job.status == :done
+        {result: job.load}
+      elsif job.error?
+        {exception: job.exception, error: job.messages.last}
+      elsif job.started?
+        {job: job.path, info: job.info, status: job.info[:status] }
+      elsif queue
+        save_inputs = Scout.var.queue[workflow.to_s][task_name][job.name].find :bucket
+
+        job.save_info status: :queue 
+        job.save_input_bundle(save_inputs) unless save_inputs.exists?
+
+        Log.info "Queue: #{save_inputs}"
+
+        {job: job.path}
+      elsif wait
+        save_inputs = Scout.var.queue[workflow.to_s][task_name][job.name].find :bucket
+        if not save_inputs.exists?
+          job.join
+          raise TryAgain 
+        else
+          {job: job.path}
+        end
+      else
+        job.produce
+        raise TryAgain
+      end
+    rescue TryAgain
+      retry
     end
   end
 end

data/share/terraform/aws/efs_host/data.tf

@@ -2,10 +2,9 @@ data "aws_ami" "amazon_linux_2" {
   most_recent = true
   owners      = ["amazon"]
 
-  # Filter for Amazon Linux 2 AMIs
   filter {
     name   = "name"
-    values = ["amzn2-ami-hvm-*-x86_64-gp2"]
+    values = ["al2023-ami-*-x86_64"]
   }
 }
 

data/share/terraform/aws/efs_host/main.tf

@@ -5,7 +5,7 @@ resource "aws_key_pair" "this" {
 
 resource "aws_instance" "this" {
   ami           = data.aws_ami.amazon_linux_2.id
-  instance_type = "t2.micro"
+  instance_type = var.instance_type
   iam_instance_profile = var.policies.outputs.ec2_host_profile_id
 
   key_name      = aws_key_pair.this.key_name

data/share/terraform/aws/efs_host/variables.tf

@@ -1,7 +1,11 @@
 variable "network" {
   description = "Name of the remote state block to use for the network"
 }
-
+variable "instance_type" {
+  description = "Instance to use"
+  type = string
+  default = "t2.micro"
+}
 variable "efs" {
   description = "Name of the remote state block to use for the EFS"
 }

data/test/scout/render/test_engine.rb

@@ -0,0 +1,88 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+
+class TestRenderStep < Test::Unit::TestCase
+  def test_render_proc
+    out = ScoutRender.render(nil, name: 'Miguel') do |name|
+      "Hi #{name}"
+    end
+    assert_equal 'Hi Miguel', out
+  end
+
+  def test_render_step
+    step = ScoutRender.render_step(nil, name: 'Miguel') do |name|
+      "Hi #{name}"
+    end
+    out = step.run
+    assert_equal 'Hi Miguel', out
+  end
+
+  def test_render_step_template
+    TmpFile.with_path do |dir|
+      dir.share.views['test.haml'].write <<-'EOF'
+%p Hi #{name}
+      EOF
+       
+      ScoutRender.prepend_path :test_temp, dir 
+
+      step = ScoutRender.render_step(dir.share.views['test.haml'], name: 'Miguel')
+      step.clean
+      out = step.run
+      assert_include out, 'Hi Miguel'
+      assert_include out, '<p>'
+    end
+  end
+
+  def test_render_template
+    TmpFile.with_path do |dir|
+      dir.share.views['test.haml'].write <<-'EOF'
+%p Hi #{name}
+      EOF
+       
+      ScoutRender.prepend_path :test_temp, dir 
+
+      out = ScoutRender.render_template('test', name: 'Miguel', layout: nil)
+      assert_include out, 'Hi Miguel'
+      assert_include out, '<p>'
+
+      out = ScoutRender.render_partial('test', name: 'Miguel')
+      assert_include out, 'Hi Miguel'
+      assert_include out, '<p>'
+    end
+  end
+
+  def test_render_template_no_run
+    TmpFile.with_path do |dir|
+      dir.share.views['test.haml'].write <<-'EOF'
+%p Hi #{name}
+      EOF
+       
+      ScoutRender.prepend_path :test_temp, dir 
+
+      job = ScoutRender.render_template('test', name: 'Miguel', layout: nil, run: false)
+      assert Step === job
+
+      out = job.run
+
+      assert_include out, 'Hi Miguel'
+      assert_include out, '<p>'
+    end
+  end
+
+
+  def test_render_template_no_cache
+    TmpFile.with_path do |dir|
+      dir.share.views['test.haml'].write <<-'EOF'
+%p Hi #{name}
+      EOF
+       
+      ScoutRender.prepend_path :test_temp, dir 
+
+      out = ScoutRender.render_template('test', name: 'Miguel', layout: nil, cache: false)
+      assert_include out, 'Hi Miguel'
+      assert_include out, '<p>'
+    end
+  end
+end
+

data/test/scout/render/test_resource.rb

@@ -0,0 +1,29 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+class TestScoutRenderResource < Test::Unit::TestCase
+  def test_find_template_registered_dir
+    TmpFile.with_path do |dir|
+      dir.share.views['test_find_template.haml'].write "Test"
+
+      path = ScoutRender.find_haml('test_find_template')
+      refute path.exists?
+
+      path = ScoutRender.find_resource('test_find_template', extension: 'haml')
+      refute path.exists?
+
+      path = ScoutRender.find_resource('test_find_template', extension: ['haml'])
+      refute path.exists?
+
+      ScoutRender.prepend_path :tmp_dir, dir
+
+      path = ScoutRender.find_haml('test_find_template')
+      assert path.exists?
+
+      ScoutRender.path_maps.delete :tmp_dir
+
+      path = ScoutRender.find_haml('test_find_template')
+      refute path.exists?
+    end
+  end
+end

data/test/scout/sinatra/base/test_headers.rb

@@ -0,0 +1,125 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+require 'scout/render'
+require 'test/unit'
+require 'rack/test'
+require 'json'
+require 'sinatra/base'
+
+class TestSinatraHeaders < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  setup do
+    header 'Host', 'localhost'
+    app.set :protection, false
+  end
+
+  class TestApp < Sinatra::Base
+    helpers ScoutRenderHelpers
+    register SinatraScoutHeaders
+    
+    set :protection, false
+
+    # expose small test routes using the helpers
+    get '/env' do
+      environment.to_s
+    end
+
+    get '/is_production' do
+      production?.to_s
+    end
+
+    get '/is_development' do
+      development?.to_s
+    end
+
+    get '/script' do
+      script_name.to_s
+    end
+
+    get '/xhr' do
+      xhr?.to_s
+    end
+
+    get '/method' do
+      request_method.to_s
+    end
+
+    post '/post_flag' do
+      post?.to_s
+    end
+
+    get '/some/path' do
+      {
+        path_info: path_info,
+        query: query,
+        fullpath: fullpath,
+        original_uri: original_uri
+      }.to_json
+    end
+
+    get '/clean_uri' do
+      clean_uri(request.env['REQUEST_URI']).to_s
+    end
+  end
+
+  def app
+    TestApp
+  end
+
+  def test_environment_helpers
+    get '/env'
+    assert_equal 'development', last_response.body if TestApp.environment == :development
+    # We don't assert strict value across envs, just that it returns a string
+    assert last_response.status == 200
+    assert_kind_of String, last_response.body
+  end
+
+  def test_production_development_flags
+    get '/is_production'
+    assert_equal 'false', last_response.body
+
+    get '/is_development'
+    assert_equal 'true', last_response.body
+  end
+
+  def test_script_name_from_header
+    header 'SCRIPT_NAME', '/my/script'
+    get '/script', {}
+    assert_equal '/my/script', last_response.body
+  end
+
+  def test_xhr_detection
+    # Rack::Test sets X-Requested-With when xhr? helper called in real browsers; emulate header
+    header 'X-Requested-With', 'XMLHttpRequest'
+    get '/xhr'
+    assert_equal 'true', last_response.body
+  ensure
+    # clear header for subsequent tests
+  end
+
+  def test_request_method_and_post_flag
+    get '/method'
+    assert_equal 'GET', last_response.body
+    post '/post_flag'
+    assert_equal 'true', last_response.body
+  end
+
+  def test_uri_helpers_and_clean_uri
+    env = {
+      "PATH_INFO" => "/some/path",
+      "QUERY_STRING" => "a=1&_update=reload&b=2",
+      "REQUEST_URI" => "/some/path?a=1&_update=reload&b=2"
+    }
+    get '/some/path?a=1&_update=reload&b=2', {}
+    assert_equal 200, last_response.status, last_response.errors
+    body = JSON.parse(last_response.body)
+    assert_equal '/some/path', body['path_info']
+    assert_equal 'a=1&_update=reload&b=2', body['query']
+    # fullpath uses clean_uri so _update should be removed from fullpath
+    assert_equal '/some/path?a=1&b=2', body['fullpath']
+    # original_uri uses clean_uri on REQUEST_URI
+
+  end
+end

data/test/scout/sinatra/base/test_parameters.rb

@@ -0,0 +1,88 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+require 'scout/render'
+require 'test/unit'
+require 'rack/test'
+require 'json'
+require 'sinatra/base'
+require 'scout/sinatra/base/headers'
+
+class TestSinatraHeaders < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  setup do
+    header 'Host', 'localhost'
+    app.set :protection, false
+  end
+
+  # register a temporary common parameter for testing
+  SinatraScoutParameters.register_common_parameter(:_flag_test, :boolean, nil) { false }
+
+  class TestApp < Sinatra::Base
+    register SinatraScoutHeaders
+    register SinatraScoutParameters
+
+    # route to inspect consume_parameter
+    get '/consume' do
+      val = consume_parameter('x', params)
+      (val.nil? ? 'nil' : val.to_s)
+    end
+
+    get '/clean' do
+      content_type 'application/json'
+      clean_params.to_json
+    end
+
+    get '/process_common' do
+      # call process_common_parameters and return the value of the helper-generated method
+      process_common_parameters
+      _flag_test.to_s
+    end
+  end
+
+  def app
+    TestApp
+  end
+
+  def test_consume_parameter_blank_becomes_nil
+    get '/consume', { 'x' => '' }
+    assert_equal 'nil', last_response.body
+  end
+
+  def test_clean_params_removes_internal_keys_and_checkbox_false
+    params = {
+      'name' => 'John',
+      '_internal' => 'should_remove',
+      'agree_checkbox_false' => '1'
+    }
+    get '/clean', params
+    assert_equal 200, last_response.status
+    body = JSON.parse(last_response.body)
+    # _internal should not be present
+    assert !body.key?('_internal')
+    # agree_checkbox_false should be removed; agree should be false (since no 'agree' key present)
+    assert_equal false, body['agree']
+    assert_equal 'John', body['name']
+  end
+
+  def test_common_parameter_helper_created_and_defaults_work
+    # no param provided, the registered default block returns false
+    get '/process_common'
+    assert_equal 'false', last_response.body
+  end
+
+  def test_consume_parameter_from_given_source_hash
+    # supply nested hash as source
+    source = { 'a' => '1', 'b' => '' }
+    # create a route to call consume_parameter with a custom source
+    TestApp.get '/consume_custom' do
+      v1 = consume_parameter('a', source)
+      v2 = consume_parameter('b', source)
+      "#{v1}-#{v2.inspect}"
+    end
+
+    get '/consume_custom'
+    assert_equal '1-nil', last_response.body
+  end
+end

data/test/scout/sinatra/test_base.rb

@@ -0,0 +1,27 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+require 'rack/test'
+class TestSinatraBase < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  class TestApp < Sinatra::Base
+    set :protection, false
+    register SinatraScoutBase
+    set :protection, false
+  end
+
+  setup do
+    header 'Host', 'localhost'
+    app.set :protection, false
+  end
+
+  def app
+    TestApp
+  end
+
+  def test_true
+
+  end
+end
+

data/test/scout/sinatra/test_entity.rb

@@ -0,0 +1,44 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+require 'rack/test'
+
+module TestEntity
+  extend Entity
+
+  property :hi do |name=nil|
+    "Hi #{name||self}"
+  end
+end
+
+class TestSinatraWorkflows < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  class TestApp < Sinatra::Base
+    set :protection, false
+    register SinatraScoutBase
+    register SinatraScoutEntity
+    set :protection, false
+  end
+
+  setup do
+    header 'Host', 'localhost'
+  end
+
+  def app
+    TestApp
+  end
+
+  def test_property
+    get '/entity_property/TestEntity/hi/Test', { '_format' => 'json'}
+    assert_equal 200, last_response.status, "expected 200 got #{last_response.status}: #{last_response.errors}"
+    body = IndiferentHash.setup(JSON.parse(last_response.body))
+    assert_equal "Hi Test", body[:message]
+
+    get '/entity_property/TestEntity/hi/Test', { '_format' => 'json', args: "Miguel"}
+    assert_equal 200, last_response.status, "expected 200 got #{last_response.status}: #{last_response.errors}"
+    body = IndiferentHash.setup(JSON.parse(last_response.body))
+    assert_equal "Hi Miguel", body[:message]
+  end
+end
+

data/test/scout/sinatra/test_render.rb

@@ -0,0 +1,44 @@
+require File.expand_path(__FILE__).sub(%r(/test/.*), '/test/test_helper.rb')
+require File.expand_path(__FILE__).sub(%r(.*/test/), '').sub(/test_(.*)\.rb/,'\1')
+
+require 'rack/test'
+
+class TestSinatraRender < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  class TestApp < Sinatra::Base
+    set :protection, false
+    register SinatraScoutRender
+    set :protection, false
+  end
+
+  def app
+    TestApp
+  end
+
+  setup do
+    header 'Host', 'localhost'
+    app.set :protection, false
+  end
+
+
+  def test_get
+    TmpFile.with_path do |dir|
+      dir.share.views.main['test.haml'].write <<-'EOF'
+%p Hi #{name}
+      EOF
+
+      dir.share.views['layout.haml'].write <<-'EOF'
+%H3 Layout
+!= yield
+      EOF
+       
+      ScoutRender.prepend_path :test_temp, dir 
+
+      get '/main/test', { '_format' => 'json', 'name' => "Miguel"}
+      assert_equal 200, last_response.status, "expected 200 got #{last_response.status}: #{last_response.status == 500 ? last_response.errors : last_response.body}"
+      assert_include = last_response.body, 'Miguel'
+    end
+  end
+end
+