As I’m sure most of us are aware, Rails recently had some security holes brought to light and fixed.
These are my notes after upgrading about a dozen applications, many of them twice in the past month or two.
If you don’t have a solid batch of unit tests, then the odds of my spending any time on patching your open source project are nil. Well, not quite: I’ve done a few.
But seriously, with tests, my workflow looks something like this:
read README. Make note of any special dependencies, like elasticsearch or postgres in development.
create new rvm gemset.
config/database.yml, change if needed to work with my setup. Changes are normally limited to things like the database name, the database user, password, etc.
rake db:migrate && rake db:seed && rake db:test:prepare
and then I run the tests – either
rake spec. I’ve seen all three of them, and I’m sure I’ll see more variations as time goes on. Side note: For Rails applications, we should always alias
rake testto the testing framework that is being used.
if the tests all pass before I upgrade, I upgrade with
bundle update rails && rake test, if they don’t, then I try to make them pass (I normally can), but if I can’t, I and then update Rails, re-run the tests, and make sure they are either all green, or that there are no new failures. (No more than 5% of the tests can fail).
commit, submit a pull request, ping the maintainer on twitter after 24 hours if it isn’t merged.
- git clone
- poke around in the browser.
- spend my time going through weird stacktaces and weird errors, or worse, not knowing if I broke something.
So, the take aways are:
Documentation on how to get a fully functional dev environment, having tests, and having the code on github.
Test suites rule.
Readable code is also important – there were a few situations where the tests were failing, and I had to go through and read the code to understand why, and it was surprisingly easy to debug these applications – I’m sure that the test-driven design was also a big part of it, but there was also a certain element of “this is readable code, I can understand this”.
Oh, and if you’re looking for someone to update your Rails applications with critical security fixes in the future, lets talk.