Make Capistrano respect --dry-run in run_locally

[edspc]

Summary

As there is no solution for issue #1822, I suggest updating run_locally to respect dry_run and adding run_locally! to ignore it and keep original behaviour.

Based on @tycooon answer.

Short checklist

• Did you run bundle exec rubocop -a to fix linter issues?
• If relevant, did you create a test?
• Did you confirm that the RSpec tests pass?

Other Information

I need this to use a custom SCM plugin that manages the git repository locally and creates a tar archive also locally. So during dry_run, I don't need to create an archive, but some git commands still should be executed.

[mattbrictson]

@edspc thanks for the PR!

I don't see any unit tests so I assume you have been testing this manually. Can you describe your approach to testing this code, and some samples of the dry-run output you get? I'd like to work with you to get some automated test coverage in place for this behavior.

Also, we should update the documentation so people know about this behavior. Is there a place in the README or at https://capistranorb.com where it makes sense to mention it?

[edspc]

Hi @mattbrictson!

I've added some tests and the notice to the docs.
Please feel free to update them if necessary)

[mattbrictson]

@edspc Thanks! The structure of the tests looks good. I may make some tweaks before merging, but this is very helpful.

[mattbrictson]

@edspc I redid the specs to remove the mocks while hopefully still testing what's important. What do you think?