Home/ Questions/Q 6602415
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-25T18:52:27+00:00

I work with less technical stakeholders and testers on producing a Rails 3.1 app

  • 0

I work with less technical stakeholders and testers on producing a Rails 3.1 app who benefit greatly from seeing the HTML output rendered by my Cucumber and RSpec tests.

I would like a way to bundle this output with the app when I deploy, but am struggling to find the cleanest way to do this. The repo is on Github and we deploy with Capistrano. I would strongly prefer keep this out of version control.

Is anyone else doing this? Thanks!

Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    I don’t know why the obvious solution didn’t occur to me earlier: gitignore the doc files and add a deployment task to scp the files directly into the app’s public directory.

    .gitignore

    public/doc

    lib/tasks/doc.rake

    namespace :doc do

  desc "run features and specs then generate pages accessible in public/doc"
  task :html do
    # Delete old files
    puts "Clearing out old html files..."
    system("rm -rf public/doc/")
    system("mkdir public/doc/")

    # Generate the feature html files
    puts "Generating Cucumber html files..."
    system("mkdir public/doc/features")
    Dir.glob("features/**/*.feature").each do |story|
      system("bundle exec cucumber #{story} --drb --format=html -o public/doc/#{story.gsub(/(\w*).feature/, '\1.html')}")
      puts "public/doc/#{story}"
    end

    # Generate RSpec html files
    puts "Generating RSpec html files..."
    system("mkdir public/doc/spec/")
    Dir.glob("spec/**/*_spec.rb").each do |spec|
      system("bundle exec rspec #{spec} --drb --format html -o public/doc/#{spec.gsub(/(\w*).rb/, '\1.html')}")
    end

    # Generate the index file
    puts "Writing index file..."
    system("echo \"<html><head><title>Doc</title></head><body>\" > public/doc/index.html")

    # Write test report navigation
    Dir.glob("public/doc/**/*.html").each do |file|
      unless file == 'public/doc/index.html'
        file.gsub!(/\public\/doc\//, '')
        system("echo \"<p><a href='#{file}'>#{file.gsub('.html', '')}</a></p>\" >> public/doc/index.html")
      end
    end

    # Close index.html file
    system("echo \"</body></html>\" >> public/doc/index.html")
    puts "Done!"
  end
end

    config/deploy.rb

    desc "Generate Cucumber & RSpec HTML docs"
task :generate_docs, :roles => :app do
  system("bundle exec rake doc:html")
end

desc "Copy Cucumber & RSpec HTML docs outside of version control with scp"
task :copy_docs, :roles => :app do
  system("tar -zcvf tmp/doc.tar.gz public/doc && rm -rf public/doc")
  system("scp -r -i ~/myKey.pem tmp/doc.tar.gz #{user}@#{hostname}:#{deploy_to}/current/public/doc.tar.gz && rm tmp/doc.tar.gz")
  run "cd #{release_path}; tar -zxvf public/doc.tar.gz && rm public/doc.tar.gz"
end

after 'deploy', 'docs:generate_docs', 'docs:copy_docs'
    • 0