huginn/spec/models/agents/shell_command_agent_spec.rb

require 'rails_helper'

describe Agents::ShellCommandAgent do
  before do
    @valid_path = Dir.pwd

    @valid_params = {
      path: @valid_path,
      command: 'pwd',
      expected_update_period_in_days: '1',
    }

    @valid_params2 = {
      path: @valid_path,
      command: [RbConfig.ruby, '-e', 'puts "hello, #{STDIN.eof? ? "world" : STDIN.read.strip}."; STDERR.puts "warning!"'],
      stdin: "{{name}}",
      expected_update_period_in_days: '1',
    }

    @checker = Agents::ShellCommandAgent.new(name: 'somename', options: @valid_params)
    @checker.user = users(:jane)
    @checker.save!

    @checker2 = Agents::ShellCommandAgent.new(name: 'somename2', options: @valid_params2)
    @checker2.user = users(:jane)
    @checker2.save!

    @event = Event.new
    @event.agent = agents(:jane_weather_agent)
    @event.payload = {
      'name' => 'Huginn',
      'cmd' => 'ls',
    }
    @event.save!

    stub(Agents::ShellCommandAgent).should_run? { true }
  end

  describe "validation" do
    before do
      expect(@checker).to be_valid
      expect(@checker2).to be_valid
    end

    it "should validate presence of necessary fields" do
      @checker.options[:command] = nil
      expect(@checker).not_to be_valid
    end

    it "should validate path" do
      @checker.options[:path] = 'notarealpath/itreallyisnt'
      expect(@checker).not_to be_valid
    end

    it "should validate path" do
      @checker.options[:path] = '/'
      expect(@checker).to be_valid
    end
  end

  describe "#working?" do
    it "generating events as scheduled" do
      stub(@checker).run_command(@valid_path, 'pwd', nil, {}) { ["fake pwd output", "", 0] }

      expect(@checker).not_to be_working
      @checker.check
      expect(@checker.reload).to be_working
      three_days_from_now = 3.days.from_now
      stub(Time).now { three_days_from_now }
      expect(@checker).not_to be_working
    end
  end

  describe "#check" do
    before do
      orig_run_command = @checker.method(:run_command)
      stub(@checker).run_command(@valid_path, 'pwd', nil, {}) { ["fake pwd output", "", 0] }
      stub(@checker).run_command(@valid_path, 'empty_output', nil, {}) { ["", "", 0] }
      stub(@checker).run_command(@valid_path, 'failure', nil, {}) { ["failed", "error message", 1] }
      stub(@checker).run_command(@valid_path, 'echo $BUNDLE_GEMFILE', nil, unbundle: true) { orig_run_command.(@valid_path, 'echo $BUNDLE_GEMFILE', nil, unbundle: true) }
      [[], [{}], [{ unbundle: false }]].each do |rest|
        stub(@checker).run_command(@valid_path, 'echo $BUNDLE_GEMFILE', nil, *rest) { [ENV['BUNDLE_GEMFILE'].to_s, "", 0] }
      end
    end

    it "should create an event when checking" do
      expect { @checker.check }.to change { Event.count }.by(1)
      expect(Event.last.payload[:path]).to eq(@valid_path)
      expect(Event.last.payload[:command]).to eq('pwd')
      expect(Event.last.payload[:output]).to eq("fake pwd output")
    end

    it "should create an event when checking (unstubbed)" do
      expect { @checker2.check }.to change { Event.count }.by(1)
      expect(Event.last.payload[:path]).to eq(@valid_path)
      expect(Event.last.payload[:command]).to eq([RbConfig.ruby, '-e', 'puts "hello, #{STDIN.eof? ? "world" : STDIN.read.strip}."; STDERR.puts "warning!"'])
      expect(Event.last.payload[:output]).to eq('hello, world.')
      expect(Event.last.payload[:errors]).to eq('warning!')
    end

    describe "with suppress_on_empty_output" do
      it "should suppress events on empty output" do
        @checker.options[:suppress_on_empty_output] = true
        @checker.options[:command] = 'empty_output'
        expect { @checker.check }.not_to change { Event.count }
      end

      it "should not suppress events on non-empty output" do
        @checker.options[:suppress_on_empty_output] = true
        @checker.options[:command] = 'failure'
        expect { @checker.check }.to change { Event.count }.by(1)
      end
    end

    describe "with suppress_on_failure" do
      it "should suppress events on failure" do
        @checker.options[:suppress_on_failure] = true
        @checker.options[:command] = 'failure'
        expect { @checker.check }.not_to change { Event.count }
      end

      it "should not suppress events on success" do
        @checker.options[:suppress_on_failure] = true
        @checker.options[:command] = 'empty_output'
        expect { @checker.check }.to change { Event.count }.by(1)
      end
    end

    it "does not run when should_run? is false" do
      stub(Agents::ShellCommandAgent).should_run? { false }
      expect { @checker.check }.not_to change { Event.count }
    end

    describe "with unbundle" do
      before do
        @checker.options[:command] = 'echo $BUNDLE_GEMFILE'
        if ENV['TRAVIS'] == 'true'
          stub.proxy(Bundler).original_env { |env| env.except('BUNDLE_GEMFILE') }
        end
      end

      context "unspecified" do
        it "should be run inside of our bundler context" do
          expect { @checker.check }.to change { Event.count }.by(1)
          expect(Event.last.payload[:output].strip).to eq(ENV['BUNDLE_GEMFILE'])
        end
      end

      context "explicitly set to false" do
        before do
          @checker.options[:unbundle] = false
        end

        it "should be run inside of our bundler context" do
          expect { @checker.check }.to change { Event.count }.by(1)
          expect(Event.last.payload[:output].strip).to eq(ENV['BUNDLE_GEMFILE'])
        end
      end

      context "set to true" do
        before do
          @checker.options[:unbundle] = true
        end

        it "should be run outside of our bundler context" do
          expect { @checker.check }.to change { Event.count }.by(1)
          expect(Event.last.payload[:output].strip).to eq('') # not_to eq(ENV['BUNDLE_GEMFILE']
        end
      end
    end
  end

  describe "#receive" do
    before do
      stub(@checker).run_command(@valid_path, @event.payload[:cmd], nil, {}) { ["fake ls output", "", 0] }
    end

    it "creates events" do
      @checker.options[:command] = "{{cmd}}"
      @checker.receive([@event])
      expect(Event.last.payload[:path]).to eq(@valid_path)
      expect(Event.last.payload[:command]).to eq(@event.payload[:cmd])
      expect(Event.last.payload[:output]).to eq("fake ls output")
    end

    it "creates events (unstubbed)" do
      @checker2.receive([@event])
      expect(Event.last.payload[:path]).to eq(@valid_path)
      expect(Event.last.payload[:output]).to eq('hello, Huginn.')
      expect(Event.last.payload[:errors]).to eq('warning!')
    end

    it "does not run when should_run? is false" do
      stub(Agents::ShellCommandAgent).should_run? { false }

      expect {
        @checker.receive([@event])
      }.not_to change { Event.count }
    end
  end
end