Monthly Archives: February 2015

Automated Site Setup Scripts (Sitecore / Umbraco)

We wanted a simple way to get a new environment set up on a developer machine, but without the hassle of Virtual Machines.

Enter, Microsoft’s appcmd.

This lets you manipulate IIS7 via command line calls. There is lots of documentation on the IIS site but it takes a while to figure out which commands you need to do everything to set up a site. So I’ve put together a selection of the useful commands below in a sample site setup script.

We save these as batch files (.bat) and put them in a shared folder.

Prerequisites:

  • You work on Windows using IIS7
  • (if Sitecore) You have all relevant Sitecore installation zips in a shared network folder
  • (if Umbraco) You use Nuget package to distribute Umbraco CMS (or you could do the zip thing)
  • You run sites locally with custom host name, using a shared DB
  • All team members setup sites in the same folder path e.g. c:\work
  • You have admin rights on the local machine

Sample setup script:

Put this in a .bat file and save in a shared folder. Keep as many steps as required, and replace the relevant placeholders. To run, right click Run as Administrator.

@ECHO OFF

ECHO *** MUST BE RUN AS ADMIN - IF NOT PLEASE CLOSE AND RUN AGAIN, OTHERWISE: ***
PAUSE

ECHO *** CHECKING OUT FROM SVN ***

IF not exist c:\PATH_TO_TRUNK svn checkout -q https://SVN_PATH_TO_TRUNK c:\PATH_TO_TRUNK

ECHO *** EXTRACTING SITECORE ***

"C:\Program Files\7-Zip\7z" x -y "PATH_TO_SITECORE_ZIPS\Sitecore 7.0 rev. 140120.zip" -oc:\PATH_TO_TRUNK "Sitecore 7.0 rev. 140120\Data" "Sitecore 7.0 rev. 140120\Website"

ECHO *** RENAMING SITECORE ***

rename "c:\PATH_TO_TRUNK\Sitecore 7.0 rev. 140120" www

ECHO *** COPY LICENSE ***

copy PATH_TO_LICENSE\license.xml c:\PATH_TO_TRUNK\www\Data

ECHO *** CREATING APP POOL ***

C:\Windows\System32\inetsrv\appcmd add apppool /name:"APP_POOL_NAME" -managedRuntimeVersion:v4.0

ECHO *** CREATING SITE ***

C:\Windows\System32\inetsrv\appcmd add site /name:"APP_POOL_NAME" /bindings:http://site.localhost:80 /physicalPath:"c:\PATH_TO_TRUNK\www\Website" -applicationDefaults.applicationPool:APP_POOL_NAME

ECHO *** CREATING VIRTUAL DIRECTORIES ***

C:\Windows\System32\inetsrv\appcmd add vdir /app.name:"APP_POOL_NAME/" /path:/siteAssets /physicalPath:c:\PATH_TO_TRUNK\siteAssets

ECHO *** ADDING TO HOSTS FILE ***

find /c "	site.localhost" c:\windows\system32\drivers\etc\hosts
if %errorlevel% equ 1 goto notfound
echo Already there
goto done
:notfound
ECHO 127.0.0.1	site.localhost >> c:\windows\system32\drivers\etc\hosts
goto done
:done
  
ECHO *** BUILDING SOLUTION ***

C:\Windows\Microsoft.NET\Framework\v4.0.30319\MSBuild.exe c:\PATH_TO_TRUNK\src\Site.sln /verbosity:quiet

ECHO *** OPENING SITE ***

start http://site.localhost/

PAUSE

Hope that’s helpful to someone!

Selenium Automated Testing using C# and TeamCity

Introduction

Our QA team have started creating Selenium scripts to automate browser functional testing. These allow us to automatically run through a set of actions on a website and flag up any issues.

Running Scripts Manually

You will need:

To create/open/run a script:

  1. Open Firefox
  2. Open Selenium (should be button on toolbar otherwise ctrl+alt+s or alt, Tools, Selenium IDE)
  3. Follow selenium documentation to record/playback scripts

Automating Scripts via Unit Tests

We can convert the scripts into C# unit tests and run them via TeamCity. This explains how to set this up. You will need:

  • First follow the above to create the test suite you wish to convert and ensure you can run scripts manually
  • Download Selenium Server from http://www.seleniumhq.org/download/ and store the .jar somewhere you can run it from. 
  • Run Selenium Server using Java (put this in a .bat file next to the .jar file and double click it:
    • “C:\Program Files\Java\jdk1.8.0_20\bin\java” -jar selenium-server-standalone-2.43.1.jar
  • Visual Studio 2013
  • Install NUnit from http://www.nunit.org/
  • NUnit Test Adapter (extension for VS 2013)
  • A .NET solution open to add the unit tests into

First prepare the solution for selenium unit tests:

  1. Add a new project (C# Class Library) suggest something like SiteName.SeleniumTests
  2. Right click the new project, Manage Nuget Packages, install the following:
    1. NUnit
    2. Selenium Remote Control (RC)
  3. Create a folder in which to place the unit tests (e.g. grouped like NewUserTests or just Tests)
  4. In Selenium IDE, choose File, Batch convert test cases, C#/Nunit/Remote Control
  5. Select your Tests folder as the destination folder
  6. Select all the test cases you wish to convert (html files) and they should be saved as C# files in the Tests folder
  7. In Visual Studio, show existing files, and Include in project all the generated .cs files
  8. Build (fix any compilation errors)
  9. Open Test > Windows > Test Explorer, this should show your tests (if not, rebuild)
  10. Close all Firefox windows (they can interfere with Selenium Server)
  11. Click Run All. Selenium Server should log the commands and launch Firefox to run the test.

To capture screenshots at the end of each test:

  1. Create a Screenshots folder in your unit test project
  2. In each .cs file, in Teardown method add the following line of code before selenium.Stop():
    1. selenium.CaptureEntirePageScreenshot(System.IO.Path.Combine(System.Environment.CurrentDirectory, @”..\..\Screenshots\” + this.GetType().Name + “.png”), “”);
  3. Run the test, screenshot should be saved into the Screenshots folder with same name as the test class.

Integration with TeamCity

To integrate into TeamCity, set up a build configuration to run the NUnit test with the following build steps:

  1. Compile selenium tests – Msbuild runner, point at Selenium.csproj file
  2. Run selenium tests – Nunit runner, run tests from (path to compiled DLL)

Set the Artifact paths setting on the build settings to point to the Screenshots folder to save the screenshots after each run.

To run via TeamCity the Selenium server must be running. You could start this manually same as above, hopefully this can be made to run automatically as a service but I’m not sure how.

Gotchas

Each test must be independent of any other as they may be run in any order, or perhaps only failed tests might be run. Also the server will restart the browser between each test so they can’t depend on the final state of the previous script (like they can in the IDE).

We’re going to try using New Relic Synthetics which has a feature for test automation – apparently you can upload a Selenium script and it can automatically run as and when, we have yet to try this out though!