Getting Started Guide - SystematicTesting/QDOS GitHub Wiki

Steps

To quickly start using QDOS framework or to see it working, follow the below steps :

  1. Create your account with QDOS Console.
  2. Add Site - after login in QDOS Console.
  3. Add Version of Test Catalog and Test Suites in it.
  4. Install latest JAVA 1.8 in your local machine.
  5. Get QDOS.jar file.
  6. Execute Version of Test Catalog via QDOS.jar
  7. Verify Test Execution Report in QDOS Console.

Done.

1. Create your account with QDOS Console

Create an account on QDOS Console via registering yourself on website.

  1. Open the URL : http://qdos.systematictesting.com/#/
  2. Click "Register" Button
  3. Fill out all the mandatory params.
  4. Click "Register" Button again.
  5. Check for account confirmation email in your email box and click confirm the account.
  6. Once confirmed, you can login with registered credentials in QDOS Console.

2. Add Site - after login in QDOS Console.

In order to perform automation testing, you must create a "Site" in QDOS Console, which will contain all of your "Test Catalogs" tracked in version format. So, to create a "Site" in QDOS Console, follow below steps:

  1. Login to QDOS Console with your registered console.

  2. Click on the "Sites" Menu item from Side Bar.

  3. Click "Add Site" button from Site - Top menu bar.

  4. Fill out mandatory parameters as shown below:

    • Site Name : This field should contain your site name which will be referred in future to run test automation against this site name. Example : www.sharadtech.com

    • Description : Small Description of website like "Production Site" or "Staging Site" etc.

    • Share Status :

      • Public : If public option is selected, then your created site and its test suites will be visible to everyone who are registered to QDOS Console (irrespective to your company). So, please be careful before making your site public. It is recommended to NOT TO USE THIS STATUS.
      • Company : If company option is selected, then your created site and its test suites will only be visible to you and the members who share the same company name as of yours in your account creation process.
      • Private : If private option is selected, then your created site and its test suites will only be visible to you.

  5. Submit the form to create a site.

3. Add Version of Test Catalog and Test Suites in it.

Version of Test Catalog in a site is represented with a character prefix "C" followed by a number like C1, C2 etc. A version of "Test Catalog" can contain multiple number of test suites which intern can have multiple number of test cases which will be executed by the QDOS Framework.

Below are the steps to "Add Version" of "Test Catalog" in a Site:

  1. Click "Sites" menu item in Side Bar.
  2. If your site status is set to "Company" or "Public" then your created site should be visible to you. If your site status is set to "Private" then your created site will be visible if you select - "My Sites" menu option from Site - Top Menu Bar.
  3. Once your Site is visible to you, click the button "Add Version" to add Test Catalog inside your created site.
  4. Now, click "Upload Suites from Local Drive" to upload a Test Suite in your Test Catalog from your local machine. Test Suites uploaded from here must be in an Excel Sheet format. For example : "Sample Test Suite" Excel Sheet can be downloaded by clicking the link "Sample TestSuite" from Top Menu Bar of QDOS Console.
  5. Upload the "SampleTestSuite.xlsx" file and click "Upload" button.
  6. Once uploaded successfully without any errors, then close the light box.
  7. You will notice now, that your uploaded Test Suite is visible and you will receive option to "Commit" the "Test Catalog" Version.
  8. If you finished uploading your "Test Suites" then click the "Commit Version" button and it will commit your test catalog version and will update the version number in your site like "C1".
  9. In order to verify, that you have successfully created "Test Catalog" in your site, click the "Site" menu item from Side Bar menu and you will notice that your site will have version allocated to it like "C1". By clicking on version you can see the details of Test Catalog and its test suites including all of the test cases inside it.

4. Install latest JAVA 1.8 in your local machine.

To install Java 8 runtime environment or Java 8 SDK in your local system, follow the standard steps listed on Oracle Website.

5. Get QDOS.jar file.

There are two ways to get the QDOS.jar file which will ultimately execute test cases defined in the "Test Catalog" Version of Site.

  1. Download the QDOS.jar file from the QDOS Console from Top Menu Bar which has menu item "Download QDOS".

  2. Checkout the source code from this github repository and follow below steps:

    • Install Java 8 SDK in your local system.
    • Install Maven 3.x in your local system.
    • Checkout codebase from Github Repository
    • Open terminal or command prompt.
    • Go to project directory which contains pom.xml file and fire command "mvn clean install".
    • Once build is success, simply go to the target directory of QDOS client like "/st-qdos-client/target", you will notice jar file with dependencies has been created for you. For example : st-qdos-client--jar-with-dependencies.jar
    • Run command "java -jar st-qdos-client--jar-with-dependencies.jar" in your terminal or command prompt, QDOS will start working.

6. Execute Version of Test Catalog via QDOS.jar

To see test automation in action like executing test cases from "Test Catalog" version of a "Site" follow below mentioned steps:

  1. Open terminal or command prompt on your local system.

  2. Go to folder where QDOS.jar file has been stored.

  3. Run QDOS.jar file with command "java -jar QDOS.jar". Please remember - filename of jar file and its location path must not contain any special characters including space.

  4. After running QDOS.jar file on terminal, system will open a window which will ask for a form to be filled.

  5. Fill the form fields as described below :

    • Email : Email address used to register your account on QDOS Console.
    • API Key : API Key of the account can be fetched from QDOS Console. Simple login in QDOS Console and go to your account "Settings" menu, you will notice a sub-menu item called as "API Key". Copy the API Key from there and paste it in QDOS.jar form.
    • Proxy for Browser (server:port) : This field is an optional field and only required if your system needs proxy server details to access internet. For example, sometimes your office machine is in closed network which needs proxy server details including its port number to access internet. So to make sure Selenium Web Driver browser can access internet, its mandatory to provide proxy server details.
    • Proxy for Report Collector (server:port) : This field is an optional field and only required if your system needs proxy server details to access internet. For example, sometimes your office machine is in closed network which needs proxy server details including its port number to access internet. So to make sure QDOS Jar can communicate with QDOS Console App, its mandatory to provide proxy server details.
    • Report Collector Server URL : QDOS Console URL must be the value of this field which is http://qdos.systematictesting.com. If your company has the QDOS Console in premise installation, then it has to be the value of your in house hosted QDOS Console App.
    • Tracer Window : By default this button is set to "ON" and displays the live logs of Selenium Web Driver Testing with in QDOS Window. But it can be turned "OFF".
    • Operating System : Please select your operating system on which you are running QDOS.jar.
    • Browser : Please select the browser in which you want to run your automation test suite via QDOS.jar.
    • Site Name : Enter the "Site Name" which you created in QDOS Console under STEP - 2.
    • Version Number : Enter the "Version" of "Site Name" which you created in QDOS Console under STEP - 3.
    • Suite Name : This is an optional field. If left blank, all the test suites will be executed which are stored in Site Version. If you want to run specific Test Suite, then add the test suite name as value here.
    • Capture Screenshot : Please select the relevant check boxes which will take screenshot on each steps of test execution and uploads them in QDOS Console.

  6. Save the configuration by clicking "SAVE" Button for future reference.

  7. Click "RUN" button to execute the Test Suites stored inside Site Name. You will notice configured browser is in action and running your test cases and Tracer Window will be displaying live logs on your system.

7. Verify Test Execution Report in QDOS Console.

To test execution report, you need to open QDOS Console. QDOS Console is capable of displaying live test results in it. Here are the steps to view Test Execution Report :

  1. Login to QDOS Console with your registered console.
  2. Click on the "Reports" Menu item from Side Bar.
  3. Select your Site.
  4. Select the Version you want to view and follow the on screen options to view the test results including screenshots.
⚠️ **GitHub.com Fallback** ⚠️