qa tool summary

The qatool is a ruby gem command-line utility that generates three things:

  1. qa html file (__qatool.html). Here's an example of the qatool.
  2. banner preview html file (__preview.html). Here's an example of the preview page.
  3. swf summary (__summary.html) page which outlines and compares meta data against a specs excel sheet. Here's an example of the summary.

You can see a screencast demo here

Everything that it generates is "static," meaning that if you change a spec sheet, add or remove swf's from the directory being qa'd. You need to re-run the qatool command to re-generate the files.

excel spec sheets

The qatool searches for a "specs.xls" or "specs.xlsx" file in the working directory. The spec sheet contains expected meta data for each swf, like K size, dimensions, frame-rate, etc.

Spec sheets must be a certain format in order for the qatool to read. Below is a template excel sheet you can download and inspect, and use for further spec sheets.

Spec sheets are not required for the qatool to function, the __summary.html file will not be generated if a spec sheet isn't present.

Example spec sheet

installation steps

Installation is a fairly painless process - but you will need administration rights.

windows:

  1. Install "Ruby" with this installer. Make sure to "Enable RubyGems" from the "Choose Components" screen during installation.
  2. Download "Console 2", which is a different console application. You should use this instead of the built in windows DOS command prompt
  3. Unzip the console 2 file, and run the "Console.exe" executable.
  4. Add gems.codeendeavor.com to the gem sources, run this command: gem sources --add http://gems.codeendeavor.com [ENTER]
  5. Install the builder gem, run command: gem install builder [ENTER]
  6. Install the roo gem, run command: gem install roo [ENTER]
  7. Install the spreadsheet gem, run command: gem install spreadsheet [ENTER]
  8. Install the nokogiri gem, run command: gem install nokogiri [ENTER]
  9. Install the rubyzip gem, run command: gem install rubyzip [ENTER]
  10. Install the google-spreadsheet-ruby gem, run command: gem install google-spreadsheet-ruby [ENTER]
  11. Install the qatool gem, run command: gem install qatool [ENTER]
  12. Shed a tear - it was so simple, and you're just that happy.

mac:

  1. Ruby and RubyGems are installed by default on mac. Go to next step.
  2. Open a terminal window (/Applications/Utilities/Terminal)
  3. Update RubyGems, run command: sudo gem update --system
  4. Add gems.codeendeavor.com to the gem sources, run this command: gem sources --add http://gems.codeendeavor.com [ENTER]
  5. Install the builder gem, run command: sudo gem install builder [ENTER]
  6. Install the roo gem, run command: gem install roo [ENTER]
  7. Install the spreadsheet gem, run command: gem install spreadsheet [ENTER]
  8. Install the nokogiri gem, run command: gem install nokogiri [ENTER]
  9. Install the rubyzip gem, run command: gem install rubyzip [ENTER]
  10. Install the google-spreadsheet-ruby gem, run command: gem install google-spreadsheet-ruby [ENTER]
  11. Install the "qatool" gem, run command: gem install qatool [ENTER]
  12. Enter your password
  13. Shed a tear - it was so simple, and you're just that happy.

using the qatool

The general steps for windows and mac are outlined below, followed by an example "session" that you can follow.

windows:

  1. Start the "Console 2" application, (see windows installation step 2) if you don't already have console 2.
  2. use the "cd" command to "change directory" into a directory that contains the swf's you want to QA.
  3. run the qatool command: qatool [ENTER]
  4. Two new files will be created: __qatool.html and __preview.html
  5. An additional file will be created (__summary.html) if the directory contained a spec excel sheet.

mac:

  1. open a terminal window (/Applications/Utilities/Terminal)
  2. use the "cd" command to "change directory" into a directory that contains the swf's you want to QA.
  3. run the qatool command: qatool [ENTER]
  4. Two new files will be create: __qatool.html and __preview.html
  5. An additional file will be created (__summary.html) if the directory contained a spec excel sheet.

step-by-step working session

  1. Download this example zip file.
  2. Unzip the file, and place the folder on your desktop.
  3. Open "console 2" (win), or terminal (mac).
  4. "cd" inside of the folder that is now on your desktop:
    • win: cd "C:/Documents and Settings/[USER_NAME]/Desktop/qatool_example/" [ENTER] - replace [USER_NAME] with your windows user name.
    • mac: cd ~/Desktop/qatool_example [ENTER]
  5. Run the "qatool" command: qatool [ENTER]
  6. Now use windows explorer or the finder, and look inside of the "qatool_example" directory, there will be a few new files. (__qatool.html, __preview.html, __summary.html)
    7. You can open all of those files to see the generated output.

what just happened?

  • You ran the "qatool" command from a directory that contained swf's you wanted to QA.
  • The qatool generated three files (__summary.html, __qatool.html, __preview.html)

workflow summary

This is the workflow you can repeat for any other set of swf's you need to QA. Just "cd" into whichever directory contains swf's, run the command, and view the output.

Installing Updates

Now and then, we may update the qatool, which will require you to install an update. All you have to do is run the below command.

  • Windows: gem update qatool
  • Mac: sudo gem update qatool

conclusion

The qatool is simple! One thing to remember is that it generates "static" files, which means a few things:

  • The files are portable, they can be sent to anyone, anywhere.
  • No server needed to generate them. But you can place them on a server and they will still work.
  • Files must be re-generated if swf's are added or removed from a directory, or if the spec sheet changes.

The qatool works even without a spec sheet - it won't generate the __summary.html page if a spec sheet isn't found.

Technology Information

If you want more information about Ruby, RubyGems, SWF Header Gem, or the Roo Gem, here are some links:

Problems?

If you have problems, or find that the qatool is not generating any files - but it indeed should be, contact aaron.smith@mccannsf.com

Changelog