CrossBrowserTesting to BitBar Migration

By following these steps, you can set up your test results and see them in the BitBar UI. If you run many tests, it's simpler to find them on the test results page. It saves you time scrolling through all the test run logs. This way you can find the tests that failed and analyze them much faster. To set your test result score in BitBar, log in to your BitBar account and check the POST request that you need to implement in your code. To do that, you need:

Here are the steps to follow:

You can set your test result score with a simple curl command, or with Swagger Inspector, or write it in your code (see Python example).

To see your test results in the BitBar UI, open your test run and click the panel on the upper right corner. It opens a panel giving Device Execution Status. There are numerous possible statuses. You can edit your script to use more than Succeeded and Failed status if you want to. You make those API calls the same way they’re made in the script, just change the test result variable.

To make your CrossBrowserTesting script work in BitBar you’ll have to change the following:

Additionally, go to BitBar test creator and click on ‘Show full sample script’ checkbox for the desired language to see working sample code. It doesn’t have API calls to set test results, but you can use methods from the script below.

FULL SCRIPT:

# Please visit http://selenium-python.readthedocs.io/ for detailed installation and instructions# Getting started: http://docs.seleniumhq.org/docs/03_webdriver.jsp# API details: https://github.com/SeleniumHQ/selenium#selenium# Requests is the easiest way to make RESTful API calls in Python. You can install it by following the instructions here:# http://docs.python-requests.org/en/master/user/install/import unittest
from selenium import webdriver
import requests


class BasicTest(unittest.TestCase):
    def setUp(self):

        #get rid of the old way of doing auth with just an API key
        
        self.apiKey = '<insert your BitBar API key here>'

        self.api_session = requests.Session()

        self.test_result = None
        
        #old platformName has been split into platformName and osVersion
        capabilities = {
            'platformName': 'Linux',
            'browserName': 'firefox',
            'browserVersion': '96',
            'bitbar:options': {
                'apiKey': '<insert your BitBar API key here>',
                'resolution': '2560x1920',
                'osVersion': '18.04'
                }
            }


        # start the remote browser on our server
        self.driver = webdriver.Remote(
            desired_capabilities=capabilities,
            #the hub is changed, also not sending the user and pass through the hub anymore
            #US hub url: https://appium-us.bitbar.com/wd/hub
            command_executor="https://appium.bitbar.com/wd/hub" #EU hub url
        )

        self.driver.implicitly_wait(20)

    def test_CBT(self):
        # We wrap this all in a try/except so we can set pass/fail at the end
        try:
            # load the page url
            print('Loading Url')
            self.driver.get('http://crossbrowsertesting.github.io/selenium_example_page.html')

            # maximize the window - DESKTOPS ONLY
            #print('Maximizing window')
            #self.driver.maximize_window()
            
            #check the title
            print('Checking title')
            self.assertEqual("Selenium Test Example Page", self.driver.title)

            # change pass to SUCCEEDED
            self.test_result = 'SUCCEEDED'

        except AssertionError as e:

            # delete cbt api calls
  
            # change fail to FAILED
            self.test_result = 'FAILED'
            raise

    def tearDown(self):
        print("Done with session %s" % self.driver.session_id)
        if self.test_result is not None:
            #get all necessary IDs of current session
            response = requests.get('https://appium.bitbar.com/sessions/' + self.driver.session_id, auth=(self.apiKey, '')).json()
            deviceRunID = str(response["deviceRunId"])
            projectID = str(response["projectId"])
            RunId = str(response["testRunId"])

            # Here we make the api call to set the test's score
            requests.post('https://cloud.bitbar.com/api/v2/me/projects/' + projectID + '/runs/' +
            RunId + '/device-sessions/' + deviceRunID, params={'state': self.test_result},
            auth=(self.apiKey, ''))
            
        self.driver.quit()

if __name__ == '__main__':
    unittest.main()

To make your CrossBrowserTesting script work in BitBar you’ll have to change the following:

FULL SCRIPT:

using System;
using System.Collections.Generic;
using OpenQA.Selenium;
using OpenQA.Selenium.Remote;
using OpenQA.Selenium.Support.UI;
using NUnit.Framework;

namespace BasicTest
{
    class BasicTest
    {
        //deleted username and authkey, bitbar uses apikey in capabilities

        static void Main(string[] args)
        {
            //deleted CBTApi constructor

            var caps = new OpenQA.Selenium.RemoteSessionSettings();

            //setting capabilities the same way like in cbt script, but using bitbar ones (they differ a little)
            caps.AddMetadataSetting("platform", "Linux");
            caps.AddMetadataSetting("osVersion", "18.04");
            caps.AddMetadataSetting("browserName", "firefox");
            caps.AddMetadataSetting("version", "96");
            caps.AddMetadataSetting("resolution", "2560x1920");
            caps.AddMetadataSetting("bitbar_apiKey", "<insert your BitBar API key here>");

            //just change hub url in arguments, ure EU or US one, caps argument stays the same
            //US hub URL-https://appium-us.bitbar.com/wd/hub
            RemoteWebDriver driver = new RemoteWebDriver(new Uri("https://appium.bitbar.com/wd/hub"), caps, TimeSpan.FromSeconds(180));

            try
            {
                //write your code here

                driver.Navigate().GoToUrl("http://crossbrowsertesting.github.io/selenium_example_page.html");
                // Check the title
                Console.WriteLine(driver.Title);
                Assert.AreEqual(driver.Title, "Selenium Test Example Pageafkjhekfj");

                //deleted setScore CBTApi method, used temporary WriteLine function
                Console.WriteLine("pass");
            }
            catch (Exception ex)
            {
                //deleted takeSnapshot, setDescription and setScore CBTApi methods, used temporary WriteLine function
                Console.Error.WriteLine(ex.Message);
                Console.WriteLine("fail");
            }
            finally
            {
                driver.Quit();

            }
        }
    }
    //deleted CBTApi class
}

To make your CrossBrowserTesting script work in BitBar you’ll have to change the following:

// Getting started: http://docs.seleniumhq.org/docs/03_webdriver.jsp
// API details: https://github.com/SeleniumHQ/selenium#selenium
// Unirest is the recommended way to interact with RESTful APIs in Java
// http://unirest.io/java.html
// runs test against http://crossbrowsertesting.github.io/selenium_example_page.html

import java.net.URL;
import org.openqa.selenium.remote.DesiredCapabilities;
import org.openqa.selenium.remote.RemoteWebDriver;
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.JsonNode;
import com.mashape.unirest.http.Unirest;
import com.mashape.unirest.http.exceptions.UnirestException;

import static org.junit.Assert.*;

class BasicTest {

    // deleted username, authkey
    String testScore = "unset";
    
    public static void main(String[] args) throws Exception {
        
        BasicTest myTest = new BasicTest();
        // bitbar uses DesiredCapabilities as well, just copy them
        DesiredCapabilities capabilities = new DesiredCapabilities();
        capabilities.setCapability("platform", "Linux");
        capabilities.setCapability("osVersion", "18.04");
        capabilities.setCapability("browserName", "firefox");
        capabilities.setCapability("version", "96");
        capabilities.setCapability("resolution", "2560x1920");
        capabilities.setCapability("bitbar_apiKey", ""); //<insert your BitBar API key here>
        
        // changed hub url, variable caps changed to capabilities
        // US hub - https://appium-us.bitbar.com/wd/hub
        RemoteWebDriver driver = new RemoteWebDriver(new URL("https://appium.bitbar.com/wd/hub"), capabilities);
        
        System.out.println(driver.getSessionId());
        
        // we wrap the test in a try catch loop so we can log assert failures in our system
        try {

            // load the page url
            System.out.println("Loading Url");
            driver.get("http://crossbrowsertesting.github.io/selenium_example_page.html");
            // maximize the window - DESKTOPS ONLY
            //System.out.println("Maximizing window");
            //driver.manage().window().maximize();
            // Check the page title (try changing to make the assertion fail!)
            System.out.println("Checking title");
            assertEquals(driver.getTitle(), "Selenium Test Example Page");
            
            // if we get to this point, then all the assertions have passed
            // that means that we can set the score to pass in our system
            myTest.testScore = "pass";
            }
        catch(AssertionError ae) {
            //deleted takeSnapshot call
            //deleted setDescription call
            // if we have an assertion error set the score to "fail"
            myTest.testScore = "fail";
            }
        finally {

            System.out.println("Test complete: " + myTest.testScore);
            // simple print function instead of api call to set the score - future bitbar api call
            System.out.println(myTest.testScore);
            
            // and quit the driver
            driver.quit();
            }
    }

    //deleted setScore, takeSnapshot and setDescription functions}