Skip to main content

Testing Sitecore with Selenium NUnit

Pretty much all the Sitecore development is happening in Agile. Hence, code is released more frequently to live servers than it used to be in waterfall models. This also means there is a need of testing after each release. A regression in QA environment and a smoke test in STAGE environment is required to ensure that the development done in sprint does not break any thing else.

This is the job of QA team. Why are we talking about it here?

If your team is testing Sitecore functionalities manually, then it is wise to automate at least some of your test cases. Testing some basic Sitecore functionalities like login, publishing etc. manually is something QA team can easily do but when one needs to automate it, QA developers needs to have some knowledge of Sitecore also and vice-versa.  Hence, here is a simple blog on guiding how to develop some basic automated test cases in Sitecore.

Lets get started..

In this blog, I am taking example of a basic scenario which includes testing that your users should have the ability to log in to your Sitecore instance with correct credentials and shall be redirected back to login screen if incorrect credentials are provided.

Since we are going to log in to Sitecore using browsers, we will have to make use of any tool that supports browser automation and Selenium is one of them. So Selenium is our pick for this example.

We are using Asp.Net MVC in Sitecore. Hence, it makes sense to use NUnit as unit-test framework. You may use a different unit-test framework based on your project needs.

Step 1 - 

This involves creating an NUnit project and then importing Selenium NuGets into it. Then, we also need to download Chrome webdrivers for Selenium to work with Chrome browsers. This is standard stuff and if you dont know about it, there are lots of online blogs available guiding you to do that. Here is one which you can make use of - https://testguild.com/selenium-webdriver-visual-studio/


Step 2 - 

This is where our NUnit project is setup with Selenium and Chrome web drivers based on step 1. Now, we need to write code to make our test scenarios work. Create a class called Tests.cs in your NUnit project and add below code to it - 

//Inside SeleniumTest.cs

using NUnit.Framework;

using OpenQA.Selenium;

using OpenQA.Selenium.Chrome;

using OpenQA.Selenium.Firefox;

using System;

using System.Collections.ObjectModel;

using System.IO;


namespace SeleniumCsharp

{

    public class Tests

    {

        IWebDriver driver;

        [OneTimeSetUp]

        public void Setup()

        {

            //Below code is to get the drivers folder path dynamically.

            //You can also specify chromedriver.exe path dircly ex: C:/MyProject/Project/drivers

            string path = Directory.GetParent(Environment.CurrentDirectory).Parent.Parent.FullName;

            //Creates the ChomeDriver object, Executes tests on Google Chrome

            ChromeOptions options = new ChromeOptions();

            options.AddArguments("--start=maximized");

            options.AddArguments("--lang=en");


            driver = new ChromeDriver(path + @"\drivers\", options);

            //If you want to Execute Tests on Firefox uncomment the below code

            // Specify Correct location of geckodriver.exe folder path. Ex: C:/Project/drivers

            //driver= new FirefoxDriver(path + @"\drivers\");

        }


        [Test]

        public void verifyLogin()

        {

            driver.Navigate().GoToUrl("https://<sitecore instance hostname>/sitecore");

            var uName = driver.FindElement(By.Id("Username"));

            uName.SendKeys("admin");

            var password = driver.FindElement(By.Id("Password"));

            password.SendKeys("b");

            var loginButton = driver.FindElement(By.Name("button"));            loginButton.Click();

            driver.Manage().Timeouts().ImplicitWait = TimeSpan.FromSeconds(10);

            Assert.IsTrue(driver.FindElement(By.ClassName("sc-accountInformation"))!=null);//this ensure that after login, url is redirected to a page which has account information presents which means login was succussfull

        }


        [Test]

        public void returnToLoginOnInvalidCreds()

        {

            driver.Navigate().GoToUrl("https://<sitecore instance hostname>/sitecore");

            var uName = driver.FindElement(By.Id("Username"));

            uName.SendKeys("admin");

            var password = driver.FindElement(By.Id("Password"));

            password.SendKeys("abcd");//incorrect credentials given intentionally for login to fail

            var loginButton = driver.FindElement(By.Name("button"));

            loginButton.Click();

            driver.Manage().Timeouts().ImplicitWait = TimeSpan.FromSeconds(10);

            Assert.IsTrue(driver.FindElement(By.Id("Username")) != null);//On login failure, user is redirected to login page in Sitecore which again asks user to input Username. Hence, checking for that element.

        }


        [OneTimeTearDown]

        public void TearDown()

        {

            driver.Quit();

        }

    }

}


In the above class, there are two methods with evident names to test if a valid login succeeds in Sitecore or not and if an invalid login fails correctly in Sitecore or not.

After adding this code, build your project and open it using Test Explorer and Run the Tests.

You will see the magic happening. Selenium will open the browsers, perform the steps mentioned in the steps and then report if the login failed or succeeded in Sitecore.


This was a small introduction to a huge world of possibilities. Hope you liked it!

 

Labels:

Popular posts from this blog

Sitecore PowerShell Script to create all language versions for an item from en version

  We have lots of media items and our business wants to copy the data from en version of media item to all other language versions defined in System/Languages. This ensures that media is available in all the languages. So, we created the below powershell script to achieve the same -  #Get all language versions defined in System/Languages $languages = Get-ChildItem /sitecore/System/Languages -recurse | Select $_.name | Where-Object {$_.name -ne "en"} | Select Name #Ensuring correct items are updated by comparing the template ID  $items = Get-ChildItem -Path "/sitecore/media library/MyProjects" -Recurse | Where-Object {'<media item template id>' -contains $_.TemplateID} #Bulk update context to improve performance New-UsingBlock (New-Object Sitecore.Data.BulkUpdateContext) { foreach($item in $items){    foreach($language in $languages){ $languageVersion = Get-Item -Path $item.Paths.Path -Language $language.Name #Check if language versi
Read more

Export Sitecore media library files to zip using SPE

If you ever require to export Sitecore media files to zip (may be to optimize them), SPE (Sitecore Powershell Extension) has probably the easiest way to do this for you. It's as easy as the below 3 steps -  1. Right click on your folder (icons folder in snap)>Click on Scripts> Click on Download 2. SPE will start zipping all the media files placed within this folder. 3. Once zipping is done, you will see the Download option in the next screen. Click Download Zip containing the media files within is available on your local machine. You can play around with the images now. Hope this helps!! Like and Share ;)
Read more

Make Sitecore instance faster using Roslyn Compiler

When we install the Sitecore instance on local, the first load is slow. After each code deploy also, it takes a while for the Sitecore instance to load and experience editor to come up. For us, the load time for Sitecore instance on local machines was around 4 minutes. We started looking for ways to minimize it and found that if we update our Web.config to use Roslyn compiler and include the relevant Nugets into the project, our load times will improve. We followed the simple steps - Go to the Project you wish to add the NuGet package and right click the project and click 'Manage NuGet Packages'. Make sure your 'Package Source' is set to nuget.org and go to the 'Browse' Tab and search Microsoft.CodeDom.Providers.DotNetCompilerPlatform. Install whichever version you desire, make sure you note which version you installed. You can learn more about it  here . After installation, deploy your project, make sure the Microsoft.CodeDom.Providers.DotNetCompilerPlatform.d
Read more

Experience of a first time Sitecore MVP

The Journey I have been working in Sitecore for almost 10 years now. When I was a beginner in Sitecore, I was highly impressed by the incredible community support. In fact, my initial Sitecore learning path was entirely based on community written blogs on Sitecore. During a discussion with my then technology lead Neeraj Gulia , he proposed the idea that I should start giving back to developer community whenever I get chance. Just like I have been helped by many developers via online blogs, stackoverflow etc., I should also try to help others. Fast forward a few years and I met  Nehemiah Jeyakumar  (now an MVP). He had a big archive of his technical notes in the form Sitecore blogs. I realized my first blog dont have to be perfect and it can be as simple as notes to a specific problem for reference in future. That's when I probably created my first blog post on Sitecore. At that time, I didn't knew about the Sitecore MVP program. Over the years, I gained more confidence to write
Read more

Clean Coding Principles in CSharp

A code shall be easy to read and understand. In this post, I am outlining basic principles  about clean coding after researching through expert recommended books, trainings and based on my experience. A common example to start with is a variable declaration like - int i  The above statement did not clarify the purpose of variable i. However,  the same variable can be declared as -  int pageNumber The moment we declared the variable as int pageNumber, our brain realized that the variable is going to store the value for number of pages. We have set the context in our brain now and it is ready to understand what the code is going to do next with these page numbers. This is one of the basic advantages of clean coding. Reasons for clean coding -  • Reading clean code is easier - Every code is revisited after certain amount of time either by the same or different developer who created it. In both the cases, if the code is unclean, its difficult to understand and update it. • To avoid s
Read more