Lifting quality of a shell script

Introduction

In release cycle of our team at work, we need to perform so-called system tests. In order to do that, we need to log into Artifactory, search for the latest release package, check if it’s up to date, download it, unzip it, install internal configuration recipe, compile, initialize & run it. Not all of that can be easily automated, but I thought that at least searching & downloading phase can be done from the terminal in semi-automated way. That’s why I created ydownloader shell script.

Writing a script and unit tests

I’m not an expert in shell scripting, so I also wanted to learn more about it. In addition, I wanted to apply best software development practices in that script. Someone can say that in the case of a simple shell script proper engineering may be a superfluity, but in my opinion, the simplicity of the project is not an excuse for doing it the right way. Especially, if we want to use it in the future. That’s why I divided this script into smaller functions, added command line arguments handling and help for the users. Moreover, I added unit tests with shunit2 (yes, we can write unit tests for the shell scripts) and Continuous Integration with Travis CI server. In the “Clean Code” book, we can read that code without unit tests is not clean by definition. After dividing script into smaller functions, it was much easier to test it. My script is accepting command line arguments, so I needed to do the following trick to make it testable and include it in testing script:

if [ "$TEST_MODE" == "" ]
then
TEST_MODE=false
fi
if [ "$TEST_MODE" = false ] ; then
# parse command line arguments here...
else
echo "TEST_MODE enabled"
fi

Then, I could write unit tests:

TEST_MODE=true
. ./ydownloader # load script to be tested
echo "RUNNING UNIT TESTS..."
testCutLastChars() {
# given
valueToCut='testString'
expectedValue='testStri'
# when
actualValue=$(echo $valueToCut | cutLastChars 3)
# then
assertEquals $expectedValue $actualValue
}
# more tests goes here...
. ./shunit2/shunit2 # load shunit2

In addition, I prepared simple install script , which allows to install script locally via curl or wget . Of course, project has sufficient documentation in README.md file.

Short recap

It was really nice coding exercise. Now, I feel much more comfortable with shell scripting, but there’s still a lot to learn. I recommend to try applying similar approach in your scripts if you haven’t done it yet.

If you want to browse complete project, check it out in my repository: https://github.com/pwittchen/ydownloader .