mattbrictson/airbrussh

It would be nice to have a capistrano+airbrussh integration test

Open

#37 opened on Jul 5, 2015

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Ruby (33 forks)github user discovery
chorehelp wanted

Repository metrics

Stars
 (524 stars)
PR merge metrics
 (PR metrics pending)

Description

Airbrussh works by hooking into capistrano, and these hooks are currently not integration tested. If capistrano were to change its APIs, there could be a situation where the airbrussh unit tests continue to pass even though it no longer works in practice. Therefore an integration test would be nice to have.

Perhaps the test would create a sample app in a temporary directory with a Gemfile containing capistrano and airbrussh (the latter would point to the version of airbrussh under test using path), then:

  • bundle exec cap install STAGES=test
  • Add require "airbrussh/capistrano" to the generated Capfile
  • Comment out set :format, :pretty in the generated deploy.rb (if necessary)
  • Add a sample rake task to deploy.rb that executes something with the local backend
  • bundle exec cap test sample_task

Verify that that output is indeed airbrussh-formatted and that cap exited successfully.

Contributor guide

Research direction
Create a temporary directory, set up a sample Capistrano app with a Gemfile pointing to the local airbrussh, install dependencies, run 'cap install STAGES=test', add 'require "airbrussh/capistrano"' to the Capfile, comment out the format setting in deploy.rb, add a sample rake task using the local backend, execute 'bundle exec cap test sample task', and verify the output is airbrussh formatted and the exit code is successful.
Tech stack
ruby
Domain
backenddevops
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RubyCapistrano
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65