Module `appium.saucetestcase`

Expand source code

#!/usr/bin/env python

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# pylint: disable=import-error,no-member

from __future__ import print_function

import os
import sys
import unittest
from typing import Callable, List

from sauceclient import SauceClient

from appium import webdriver

SAUCE_USERNAME = os.environ.get('SAUCE_USERNAME')
SAUCE_ACCESS_KEY = os.environ.get('SAUCE_ACCESS_KEY')
sauce = SauceClient(SAUCE_USERNAME, SAUCE_ACCESS_KEY)


def on_platforms(platforms: List[str]) -> Callable[[type], None]:
    def decorator(base_class: type) -> None:
        module = sys.modules[base_class.__module__].__dict__
        for i, platform in enumerate(platforms):
            name = "%s_%s" % (base_class.__name__, i + 1)
            d_caps = {'desired_capabilities': platform}
            module[name] = type(name, (base_class,), d_caps)
    return decorator


class SauceTestCase(unittest.TestCase):
    def setUp(self) -> None:
        self.desired_capabilities['name'] = self.id()  # type: ignore
        sauce_url = "http://%s:%s@ondemand.saucelabs.com:80/wd/hub"
        self.driver = webdriver.Remote(
            desired_capabilities=self.desired_capabilities,  # type: ignore
            command_executor=sauce_url % (SAUCE_USERNAME, SAUCE_ACCESS_KEY)
        )
        self.driver.implicitly_wait(30)

    def tearDown(self) -> None:
        print("Link to your job: https://saucelabs.com/jobs/%s" % self.driver.session_id)
        try:
            if sys.exc_info() == (None, None, None):
                sauce.jobs.update_job(self.driver.session_id, passed=True)
            else:
                sauce.jobs.update_job(self.driver.session_id, passed=False)
        finally:
            self.driver.quit()

Functions

def on_platforms(platforms)

Expand source code

def on_platforms(platforms: List[str]) -> Callable[[type], None]:
    def decorator(base_class: type) -> None:
        module = sys.modules[base_class.__module__].__dict__
        for i, platform in enumerate(platforms):
            name = "%s_%s" % (base_class.__name__, i + 1)
            d_caps = {'desired_capabilities': platform}
            module[name] = type(name, (base_class,), d_caps)
    return decorator

Classes

class SauceTestCase (methodName='runTest')

A class whose instances are single test cases.

By default, the test code itself should be placed in a method named 'runTest'.

If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute.

Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment ('fixture') can be implemented by overriding the 'setUp' and 'tearDown' methods respectively.

If it is necessary to override the init method, the base class init method must always be called. It is important that subclasses should not change the signature of their init method, since instances of the classes are instantiated automatically by parts of the framework in order to be run.

When subclassing TestCase, you can set these attributes: * failureException: determines which exception will be raised when the instance's assertion methods fail; test methods raising this exception will be deemed to have 'failed' rather than 'errored'. * longMessage: determines whether long messages (including repr of objects used in assert methods) will be printed on failure in addition to any explicit message passed. * maxDiff: sets the maximum length of a diff in failure messages by assert methods using difflib. It is looked up as an instance attribute so can be configured by individual tests if required.

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Expand source code

class SauceTestCase(unittest.TestCase):
    def setUp(self) -> None:
        self.desired_capabilities['name'] = self.id()  # type: ignore
        sauce_url = "http://%s:%s@ondemand.saucelabs.com:80/wd/hub"
        self.driver = webdriver.Remote(
            desired_capabilities=self.desired_capabilities,  # type: ignore
            command_executor=sauce_url % (SAUCE_USERNAME, SAUCE_ACCESS_KEY)
        )
        self.driver.implicitly_wait(30)

    def tearDown(self) -> None:
        print("Link to your job: https://saucelabs.com/jobs/%s" % self.driver.session_id)
        try:
            if sys.exc_info() == (None, None, None):
                sauce.jobs.update_job(self.driver.session_id, passed=True)
            else:
                sauce.jobs.update_job(self.driver.session_id, passed=False)
        finally:
            self.driver.quit()

Ancestors

unittest.case.TestCase

Methods

def setUp(self)

Hook method for setting up the test fixture before exercising it.

Expand source code

def setUp(self) -> None:
    self.desired_capabilities['name'] = self.id()  # type: ignore
    sauce_url = "http://%s:%s@ondemand.saucelabs.com:80/wd/hub"
    self.driver = webdriver.Remote(
        desired_capabilities=self.desired_capabilities,  # type: ignore
        command_executor=sauce_url % (SAUCE_USERNAME, SAUCE_ACCESS_KEY)
    )
    self.driver.implicitly_wait(30)

def tearDown(self)

Hook method for deconstructing the test fixture after testing it.

Expand source code

def tearDown(self) -> None:
    print("Link to your job: https://saucelabs.com/jobs/%s" % self.driver.session_id)
    try:
        if sys.exc_info() == (None, None, None):
            sauce.jobs.update_job(self.driver.session_id, passed=True)
        else:
            sauce.jobs.update_job(self.driver.session_id, passed=False)
    finally:
        self.driver.quit()