如何测试生成文件的脚本

时间:2011-02-19 18:54:32

标签: ruby tdd directory command-line-interface minitest

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

  1. 是否通过了location选项
    • 该位置选项有效吗?
  2. 未通过位置选项
    • 帖子目录是否在当前目录中?
    • 帖子是否是当前工作目录?
  3. 那时,我真的很难测试应用程序的这一部分。所以我有两个问题:

    • 是否可以跳过测试应用程序的小部分,如上所述?
    • 如果没有,你如何使用minitest在ruby中测试文件操作?

2 个答案:

答案 0 :(得分:2)

我见过的一些项目将命令行工具实现为Command对象(例如:Rubygemsmy 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,这是一个非常好的面向对象的文件系统API,来自Ruby的标准库和StringIO,这对于模拟STDOUT非常有用,因为它是一个流入简单字符串的IO对象)< / p>

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

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

答案 1 :(得分:1)

根据我的经验(因此这是非常主观的),我认为有时候在一些难以测试的领域跳过单元测试是可以的。您需要了解您获得的回报以及测试成本与否。我的经验法则是,不测试课程的决定应该是非常不寻常的(300个课程中不到1个)

如果您要测试的内容非常困难,由于与文件系统的依赖关系,我认为您可以尝试提取与文件系统交互的所有位。