Eliminating Friction, Part 2: The Build Script

image_thumb7

Having talked about scripting your way to success, build scripts deserve a special mention.

At Blade we have components of our product in four different solutions but those solutions have a lot of shared code between them.  When we make changes to that shared code we really need to build each of the four solutions to verify that we didn’t break anything.  Unfortunately it was up to each developer to load and manually build each solution, which as a practical matter didn’t often happen.  I also started adding unit tests to one of the solutions which added another manual step.  Clearly we needed an automated build script that would do all of those tasks for us and report with a simple pass/fail result.

I’ve used a few different build frameworks in the past to automate builds.  I’ve used straight MSBuild, which is a very powerful tool that’s seriously hampered by its reliance on XML.  The fact of the matter is that XML is a terrible scripting language.  It’s really, really painful to write and debug anything even moderately complex.  Build scripts can have very complex logic and should be treated as first-class development citizens.  I don’t recommend writing MSBuild scripts directly if you can avoid it.

psake is a pretty nice Powershell-based build automation tool that I’ve used on a couple of projects.  It works as advertised and I didn’t have any particular issues with it, though I haven’t really fallen in love with Powershell as a programming language.  I love the object-based command line system but don’t really care for the language syntax.  psake is a good choice if you want to avoid MSBuild but your team is uncomfortable with non-Microsoft environments.

For creating the build script at Blade I chose to try out Ruby, Rake, and Albacore and I’m very pleased with my experience so far.  It was ridiculously easy to set up a script that builds all four solutions, runs our unit tests, and reports any errors.  It was even easier to add variations for doing a single step (clean, build, or test) for all solutions or performing all steps for a single solution.  The Ruby language is succinct and expressive, the Rake build system is powerful, and Albacore streamlines some common Windows/.Net operations.

I won’t spend time writing a step-by-step guide to Ruby/Rake/Albacore as that’s already been done very well by others.  The point of this blog post is simply to encourage you to write a build script for your project if you don’t already have one.  There are tools available that make it easy – embarrassingly easy.  Just do it.  There’s absolutely no excuse not to.

Advertisements

Eliminating Friction, Part 1– Anything Worth Doing is Worth Scripting

imageI’ve been with Blade Games World working on Jumala for a couple of months now and I’m having a blast.  The team is fun and the work is very interesting.  However, as is often true in startups, there’s just so much work to do that infrastructure and tooling has sometimes gone by the wayside.  I can understand that – things that contribute directly to attracting new users and impressing investors always rank higher than things that don’t – but it’s also true that the only way to go fast is to go well.  I thought I’d write a series of blog posts about the things I’m doing to help the Jumala team go fast.  There isn’t going to be any genuinely new thoughts here but I hope my rehashing of the same old thoughts will help others who are still in the same boat.

No time to sharpen the saw

It’s always amazing to me how much time a team can waste doing things in a very error-prone and tedious manual fashion just because no one makes the time to stop and write a script to do it automatically.  I mean, we build software for a living, right?  We sit around all day writing code that makes computers automatically perform jobs and solve problems for other people but we find it difficult to do the same thing for ourselves.

I fall into that pit quite often myself.  I’ll find myself repeating the same manual steps over and over again, having to remember how to do it every time, and probably overlooking or messing up some parts, and part of my brain says, “You know, we really ought to write a script to do this for us.”  The rest of my brain responds, “Shut up, we’re too busy too fool around with that right now and just doing it by hand takes less time than building some automated widget.”  Well, yeah, that’s often true for a one-time event, but by the third or fourth or twentieth time I’m muddling through the same problem by hand, the first part of my brain starts snarkily reminding me that if I’d just scripted it back in the beginning I’d be way ahead on time now.

If you did it twice by hand, script it

Of course I don’t want to waste time building tools that won’t ever pay back what I invested into them.  Many times I do something by hand that’s truly a one-time task and that’s fine.  But quite often those “one-time” tasks pop up again and again and I discover to my chagrin that they’re not so one-time after all.  Whenever I find myself doing the same manual thing that I’ve already done twice before, I’ll try to find a way to automate it or at least put it on my hit list of things that need to be automated.

It’s important to recognize these scripting candidates early, before they become invisible.  Most of us are creatures of habit and if we do something often enough, even if it’s inefficient and dumb, it becomes invisible and “just the way it is.”  It takes real discipline (or a fresh set of eyes) to catch these sorts of things and realize that there’s a better way.

I’ve already written about one example of this sort of thing in regard to setting up and configuring new installations of Windows.  That’s something I don’t do often so it never seemed like something that was worth automating, but at some point I realized that my list of configurations and customizations had gotten so long that I’d starting writing them down in a manual “script” so I wouldn’t overlook any of them or forget how to do them.  Um, yeah, time to automate some of this nonsense.

At Blade I’ve run into several manual processes that had become “just the way it is” to the team.  For example, we sometimes want to point the game client to different server environments depending on what we’re working on.  The process of redirecting the client to a different server involved loading the project in Visual Studio, editing multiple URLs in the settings files, building the project, and running it.  Oh, and you had to repeat this for three different projects in order to get everything redirected.  And of course the settings files were checked in to source control so people had to remember not to commit the edited versions with their next changelist.

Fixing this one wasn’t completely trivial.  I spent a few hours figuring out how the Jumala settings system worked and how .Net configuration files worked (hint: the file attribute of the appSettings element is your friend).  It was difficult to make the choice to invest that kind of time when I had so much real work piling up.  But at the end I had a Powershell script that I could invoke with the same of an environment and it would redirect all components without modifying any files under source control.  I added the script to source control so the whole team could use it.  The savings we get from that script is only a minute or so every time anyone uses it but it’s already paid for itself and it’ll continue to save minutes forever.

Resist Stockholm Syndrome

It’s important keep your eyes open and to think critically about your processes at all times.  If you don’t, you’ll eventually succumb to Stockholm Syndrome and begin to accept or even even defend the very things that are holding your productivity hostage.  It’s certainly true that you can’t always fix everything all at once and sometimes you have to pick your battles.  But what I’m really talking about here is developing a spirit of continuous improvement, looking for ways to eliminate waste, and investing for the future as well as for today.  What’s holding back your productivity?  What manual, tedious, error-prone work can you eliminate with a bit of scripting?  Fix it – you’ll be glad you did.

Configuration Scripts For Lazy Developers

Laziness is a virtue

I recently paved my laptop and set it up again from scratch.  (I wanted to get rid of accumulated corporate network goo.)  I always dread doing that because it takes so long to get everything installed and configured the way I like to have it, especially since I use non-default settings for several things.  It’s even more obnoxious because I regularly use multiple computers and I want to have all settings the same across all of them.

Well, in the spirit of “laziness is a virtue”, I decided to start scripting some of this stuff so that I don’t have to do it by hand every time and it’ll be easier to apply a consistent set of settings across all of my machines.  A full-blown automated configuration system would install software and do absolutely everything for me but I’m starting simple with some Powershell scripts that configure the behavior of Windows Explorer, the console, Git, and Notepad++.

(I have a feeling that there are already tools/projects/script libraries out there that do this sort of thing in a much more complete way but I didn’t run across anything during a quick web search.  If there’s something I overlooked, let me know in the comments.)

I thought I’d share my configuration scripts/files, not because the configuration settings I choose to use are all that interesting (they’re not), but because the mechanism of where to find these settings and how to script them may be interesting for others who want to do something similar.  You can find them at http://github.com/SaintGimp/ConfigurationScripts.

How I use them

So here’s the way I’m using these scripts:

  1. I keep them in a Configuration folder inside my WindowsPowershell folder which contains my Powershell profile, Powershell Community Extensions, and other useful Powershell stuff.  I sync the WindowsPowershell folder across all of my computers using Windows Live Mesh so that when I make a change to any of the files on one computer the change shows up on all my other computers automagically.
  2. When setting up a new computer I’ll first install Notepad++, Git, and Windows Live Mesh, then sync the aforementioned WindowsPowershell folder.
  3. I start an elevated Powershell console and cd to the WindowsPowershell\Configuration folder.
  4. I run all of the Configure-[foo] scripts in the folder.
  5. When I change something about my preferred configuration, I’ll update the script files and run them on all my other computers the next time I use them.

What they do

  • Configure-Console.ps1: I like to use the Consolas font and to use several other non-default settings for my console windows and I want my cmd consoles to look different than my Powershell consoles.  To accomplish this I found that I need to copy modified Powershell shortcuts (which contain console settings) into the Start Menu folder, plus load other stuff into the registry for default settings and for Powershell instances that aren’t launched through the shortcuts.  The registry settings are contained in a .reg file I exported from regedit after I got everything set up the way I want it.
  • Configure-Explorer.ps1: I use a command from Powershell Community Extensions to add an “Open Powershell Here” context command to Windows Explorer, then I import a bunch of registry settings for view options and start menu options.  Finally I add Notepad to the Send To menu and remove several other things that I never use from that menu.
  • Configure-Git.ps1: This sets several Git configuration options including a prettified version of log (git lg) and Notepad++ as my default editor.
  • Configure-Notepad++.ps1: I have a small shim that I register as a debugger for Notepad.exe which runs Notepad++.exe instead.  I prefer doing that rather than hunting down every place that Notepad.exe may be invoked in my tools and changing the command.  Next I change a couple of Notepad++ settings to the behavior I prefer.

There’s obviously a lot more that could be added but I’m going to do that on a “pain threshold exceeded” basis; that is, when configuring something by hand annoys me too much then I’ll sit down and figure out how to automate it.