ruby - 如何测试生成文件的脚本

Question

我正在创建一个 Rubygem，它可以让我生成 jekyll post 文件。我开发这个项目的原因之一是学习 TDD。这个 gem 在命令行上是严格起作用的，它必须进行一系列检查以确保它找到 _posts 目录。这取决于两件事:

1. 是否传递了 location 选项
   • 该位置选项是否有效？
2. 位置选项未通过
   • 帖子目录是否在当前目录下？
   • posts 目录是当前工作目录吗？

那时，我真的很难测试应用程序的那部分。所以我有两个问题:

• 像上面描述的那样跳过应用程序的一小部分测试是否可以接受/可以？
• 如果没有，您如何使用 minitest 在 ruby​​ 中测试文件操作？

Answer 1

我见过的一些项目将它们的命令行工具实现为 Command 对象(例如:Rubygems 和 my linebreak gem)。这些对象是用 ARGV 初始化的，只有一个调用或执行方法，然后启动整个过程。这使这些项目能够将其命令行应用程序放入虚拟环境中。例如，它们可以将输入和输出流对象保存在命令对象的实例变量中，以使应用程序独立于使用 STDOUT/STDIN。因此，可以测试命令行应用程序的输入/输出。与我想象的一样，您可以将当前工作目录保存在一个实例变量中，以使您的命令行应用程序独立于您的实际工作目录。然后，您可以为每个测试创建一个临时目录，并将其设置为您的 Command 对象的工作目录。

现在是一些代码:

require 'pathname'

class MyCommand
  attr_accessor :input, :output, :error, :working_dir

  def initialize(options = {})
    @input = options[:input] ? options[:input] : STDIN
    @output = options[:output] ? options[:output] : STDOUT
    @error = options[:error] ? options[:error] : STDERR
    @working_dir = options[:working_dir] ? Pathname.new(options[:working_dir]) : Pathname.pwd
  end

  # Override the puts method to use the specified output stream
  def puts(output = nil)
    @output.puts(output)
  end

  def execute(arguments = ARGV)
    # Change to the given working directory
    Dir.chdir(working_dir) do
      # Analyze the arguments
      if arguments[0] == '--readfile'
        posts_dir = Pathname.new('posts')
        my_file = posts_dir + 'myfile'
        puts my_file.read
      end
    end
  end
end

# Start the command without mockups if the ruby script is called directly
if __FILE__ == $PROGRAM_NAME
  MyCommand.new.execute
end

现在在测试的设置和拆卸方法中，您可以执行以下操作:

require 'pathname'
require 'tmpdir'
require 'stringio'

def setup
  @working_dir = Pathname.new(Dir.mktmpdir('mycommand'))
  @output = StringIO.new
  @error = StringIO.new

  @command = MyCommand.new(:working_dir => @working_dir, :output => @output, :error => @error)
end

def test_some_stuff
  @command.execute(['--readfile'])

  # ...
end

def teardown
  @working_dir.rmtree
end

(在示例中，我使用了 Pathname，它是来自 Ruby 标准库的一个非常好的面向对象的文件系统 API 和 StringIO，它对于模拟 STDOUT 很有用，因为它是一个 IO 对象，可以流式传输到一个简单的字符串中)

在实际测试中，您现在可以使用@working_dir 变量来测试文件的存在或内容:

path = @working_dir + 'posts' + 'myfile'
path.exist?
path.file?
path.directory?
path.read == "abc\n"