File Manager

Viewing File: shell_spec.rb

#
# Author:: Daniel DeLeo (<dan@chef.io>)
# Copyright:: Copyright (c) Chef Software Inc.
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

require "spec_helper"
require "chef/version"
require "chef/shell"

describe Shell do

  # chef-shell's unit tests are by necessity very mock-heavy, and frequently do
  # not catch cases where chef-shell fails to boot because of changes in
  # chef/client.rb
  describe "smoke tests", unix_only: true do

    TIMEOUT = 300

    def read_until(io, expected_value)
      start = Time.new
      buffer = ""
      until buffer.include?(expected_value)
        begin
          buffer << io.read_nonblock(1)
        rescue Errno::EWOULDBLOCK, Errno::EAGAIN, Errno::EIO, EOFError
          sleep 0.01
        end
        if Time.new - start > TIMEOUT
          raise "did not read expected value `#{expected_value}' within #{TIMEOUT}s\n" +
            "Buffer so far: `#{buffer}'"
        end
      end
      buffer
    end

    def flush_output(io)
      start = Time.new
      loop do
        begin
          io.read_nonblock(1)
        rescue Errno::EWOULDBLOCK, Errno::EAGAIN
          sleep 0.01
        rescue EOFError, Errno::EIO
          break
        end
        if Time.new - start > TIMEOUT
          raise "timed out after #{TIMEOUT}s waiting for output to end"
        end
      end
    end

    def wait_or_die(pid)
      start = Time.new

      until exitstatus = Process.waitpid2(pid, Process::WNOHANG)
        if Time.new - start > 5
          STDERR.puts("chef-shell tty did not exit cleanly, killing it")
          Process.kill(:KILL, pid)
        end
        sleep 0.01
      end
      exitstatus[1]
    end

    def run_chef_shell_with(options)
      # Windows ruby installs don't (always?) have PTY,
      # so hide the require here

      require "pty"
      config = File.expand_path("shef-config.rb", CHEF_SPEC_DATA)
      reader, writer, pid = PTY.spawn("bundle exec chef-shell --no-multiline --no-singleline --no-colorize -c #{config} #{options}")
      read_until(reader, "chef (#{Chef::VERSION})>")
      yield reader, writer if block_given?
      writer.puts('"done"')
      output = read_until(reader, '=> "done"')
      writer.print("exit\n")
      flush_output(reader)
      writer.close

      exitstatus = wait_or_die(pid)

      [output, exitstatus]
    rescue PTY::ChildExited => e
      [output, e.status]
    end

    it "boots correctly with -lauto", :executables do
      output, exitstatus = run_chef_shell_with("-lauto")
      expect(output).to include("done")
      expect(exitstatus).to eq(0)
    end

    it "sets the log_level from the command line", :executables do
      output, exitstatus = run_chef_shell_with("-lfatal") do |out, keyboard|
        show_log_level_code = %q[puts "===#{Chef::Log.level}==="]
        keyboard.puts(show_log_level_code)
        read_until(out, show_log_level_code)
      end
      expect(output).to include("===fatal===")
      expect(exitstatus).to eq(0)
    end

    context "on solo mode" do
      it "starts correctly", :executables do
        output, exitstatus = run_chef_shell_with("--solo")
        expect(output).to include("done")
        expect(exitstatus).to eq(0)
      end

      it "should be able to use the API", :executables do
        output, exitstatus = run_chef_shell_with("-s") do |out, keyboard|
          simple_api_get = "api.get('data')"
          keyboard.puts(simple_api_get)
          read_until(out, simple_api_get)
        end
        expect(output).to include("{}")
        expect(exitstatus).to eq(0)
      end
    end

    it "sets the override_runlist from the command line", :executables do
      output, exitstatus = run_chef_shell_with("-o 'override::foo,override::bar'") do |out, keyboard|
        show_recipes_code = %q[puts "#{node["recipes"].inspect}"]
        keyboard.puts(show_recipes_code)
        read_until(out, show_recipes_code)
      end
      expect(output).to include(%q{["override::foo", "override::bar"]})
      expect(exitstatus).to eq(0)
    end
  end
end