diff --git a/docs/libdoc.sh b/docs/libdoc.sh index 5ad5078b..725499c0 100755 --- a/docs/libdoc.sh +++ b/docs/libdoc.sh @@ -4,10 +4,8 @@ LIBDOC="../bin/libdoc -F REST" $LIBDOC --name="Plone User Keywords" plone/app/robotframework/keywords.robot source/libdoc/user_keywords.html $LIBDOC --name="Zope2Server User Keywords" plone/app/robotframework/server.robot source/libdoc/user_server.html $LIBDOC --name="Selenium User Keywords" plone/app/robotframework/selenium.robot source/libdoc/user_selenium.html -$LIBDOC --name="SauceLabs User Keywords" plone/app/robotframework/saucelabs.robot source/libdoc/user_saucelabs.html $LIBDOC --name="Zope2Server Library" plone.app.robotframework.Zope2Server source/libdoc/python_zope2server.html -$LIBDOC --name="SauceLabs Library" plone.app.robotframework.SauceLabs source/libdoc/python_saucelabs.html $LIBDOC --name="Debugging Library" plone.app.robotframework.Debugging source/libdoc/python_debugging.html $LIBDOC --name="LayoutMath Library" plone.app.robotframework.LayoutMath source/libdoc/python_layoutmath.html diff --git a/docs/source/examples.rst b/docs/source/examples.rst index b2c19527..1311aa8f 100644 --- a/docs/source/examples.rst +++ b/docs/source/examples.rst @@ -5,13 +5,6 @@ A minimal example **plone.app.robotramework**-example: - https://github.com/datakurre/example.product/tree/p.a.robotframework - https://travis-ci.org/datakurre/example.product -- https://saucelabs.com/u/exampleproduct - -This is how we used this for Plomino to run some robot tests at SauceLabs: - -- https://github.com/plomino/Plomino/pull/322/files -- https://travis-ci.org/fulv/Plomino -- https://saucelabs.com/u/fulv_plomino More examples which already contain robotframework tests in collective: diff --git a/docs/source/happy.rst b/docs/source/happy.rst index 5fd8002b..6515f3db 100644 --- a/docs/source/happy.rst +++ b/docs/source/happy.rst @@ -167,7 +167,6 @@ Here is a more complicated example with some user keywords in action: Force Tags wip-not_in_docs - Resource plone/app/robotframework/saucelabs.robot Resource plone/app/robotframework/selenium.robot Library Remote ${PLONE_URL}/RobotRemote diff --git a/docs/source/index.rst b/docs/source/index.rst index f600831c..95b4806d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -62,7 +62,6 @@ Advanced topics debugging travis-ci - saucelabs reload ride @@ -74,7 +73,6 @@ User keywords as resource files: - :download:`libdoc/user_keywords.html` -- :download:`libdoc/user_saucelabs.html` - :download:`libdoc/user_selenium.html` - :download:`libdoc/user_server.html` @@ -118,7 +116,6 @@ dependent on Plone code base). - :download:`libdoc/python_debugging.html` - :download:`libdoc/python_layoutmath.html` -- :download:`libdoc/python_saucelabs.html` - :download:`libdoc/python_zope2server.html` Each Python keyword library can be included as with ``Library diff --git a/docs/source/libdoc/python_debugging.html b/docs/source/libdoc/python_debugging.html index 0da14491..d377d47d 100644 --- a/docs/source/libdoc/python_debugging.html +++ b/docs/source/libdoc/python_debugging.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/python_layoutmath.html b/docs/source/libdoc/python_layoutmath.html index 97356fed..2fd45b42 100644 --- a/docs/source/libdoc/python_layoutmath.html +++ b/docs/source/libdoc/python_layoutmath.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/python_zope2server.html b/docs/source/libdoc/python_zope2server.html index 634cac2e..f6d404b8 100644 --- a/docs/source/libdoc/python_zope2server.html +++ b/docs/source/libdoc/python_zope2server.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/remote_autologin.html b/docs/source/libdoc/remote_autologin.html index 673199cb..d9b46aff 100644 --- a/docs/source/libdoc/remote_autologin.html +++ b/docs/source/libdoc/remote_autologin.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/remote_content.html b/docs/source/libdoc/remote_content.html index c19ccbfc..32787d76 100644 --- a/docs/source/libdoc/remote_content.html +++ b/docs/source/libdoc/remote_content.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/remote_genericsetup.html b/docs/source/libdoc/remote_genericsetup.html index 5a478d02..f4976c18 100644 --- a/docs/source/libdoc/remote_genericsetup.html +++ b/docs/source/libdoc/remote_genericsetup.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/remote_i18n.html b/docs/source/libdoc/remote_i18n.html index 970e0b4a..9dc45bc6 100644 --- a/docs/source/libdoc/remote_i18n.html +++ b/docs/source/libdoc/remote_i18n.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/remote_mockmailhost.html b/docs/source/libdoc/remote_mockmailhost.html index 962eb517..a4128ed0 100644 --- a/docs/source/libdoc/remote_mockmailhost.html +++ b/docs/source/libdoc/remote_mockmailhost.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/remote_quickinstaller.html b/docs/source/libdoc/remote_quickinstaller.html index fd713c5e..a7c619df 100644 --- a/docs/source/libdoc/remote_quickinstaller.html +++ b/docs/source/libdoc/remote_quickinstaller.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/remote_users.html b/docs/source/libdoc/remote_users.html index fef16e93..45d55498 100644 --- a/docs/source/libdoc/remote_users.html +++ b/docs/source/libdoc/remote_users.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/remote_zope2server.html b/docs/source/libdoc/remote_zope2server.html index e4c539fe..2d48e8d3 100644 --- a/docs/source/libdoc/remote_zope2server.html +++ b/docs/source/libdoc/remote_zope2server.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/user_keywords.html b/docs/source/libdoc/user_keywords.html index 990f5417..909f1eec 100644 --- a/docs/source/libdoc/user_keywords.html +++ b/docs/source/libdoc/user_keywords.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/user_selenium.html b/docs/source/libdoc/user_selenium.html index 3b8b8f11..e341df47 100644 --- a/docs/source/libdoc/user_selenium.html +++ b/docs/source/libdoc/user_selenium.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/libdoc/user_server.html b/docs/source/libdoc/user_server.html index 523d80e5..7a05f95f 100644 --- a/docs/source/libdoc/user_server.html +++ b/docs/source/libdoc/user_server.html @@ -1,86 +1,554 @@ - + + - - + + + + @@ -478,7 +1190,7 @@

Opening library documentation failed

@@ -486,26 +1198,74 @@

Opening library documentation failed

- + + + + + + + + + + diff --git a/docs/source/robot.rst b/docs/source/robot.rst index 0729d502..582e5ea9 100644 --- a/docs/source/robot.rst +++ b/docs/source/robot.rst @@ -148,7 +148,6 @@ in a test suite with *Resource*-command in ```*** Settings ***``: Resource plone/app/robotframework/keywords.robot Resource plone/app/robotframework/selenium.robot - Resource plone/app/robotframework/saucelabs.robot BDD-style tests diff --git a/docs/source/saucelabs.rst b/docs/source/saucelabs.rst deleted file mode 100644 index f3cd26cf..00000000 --- a/docs/source/saucelabs.rst +++ /dev/null @@ -1,138 +0,0 @@ -Integrate with Sauce Labs -========================= - -1. Register an account for http://saucelabs.com/ with the *Open Sauce* plan. - Derive username from product name. For example, ``myproduct``. Use your own - contact email for the beginning. It can be changed later. - -2. Install travis-gem for your active Ruby-installation: - - .. code-block:: bash - - $ sudo gem install travis - -3. Log in to Sauce Labs to see your Sauce Labs access key (at the bottom of - the left column). - -4. Encrypt Sauce Labs credentials into ``.travis.yml``: - - .. code-block:: bash - - $ travis encrypt SAUCE_USERNAME=... -r github-user-or-organization/myproduct --add - $ travis encrypt SAUCE_ACCESS_KEY=... -r github-user-or-organization/myproduct --add - -5. Update ``.travis.yml`` to set up the Sauce Labs connection before tests: - - .. code-block:: yaml - - [...] - addons: - sauce_connect: - - username: $SAUCE_USERNAME - - access_key: $SAUCE_ACCESS_KEY - [...] - env: - [...] - global: - - secure: ... - - secure: ... - - ROBOT_BUILD_NUMBER=travis-$TRAVIS_BUILD_NUMBER - - ROBOT_REMOTE_URL=http://$SAUCE_USERNAME:$SAUCE_ACCESS_KEY@ondemand.saucelabs.com:80/wd/hub - - ROBOT_DESIRED_CAPABILITIES=tunnel-identifier:$TRAVIS_JOB_NUMBER - [...] - -.. note:: If you already have an ``env`` section, for instance to define - different versions of Plone like this: - - .. code-block:: yaml - - env: - - PLONE_VERSION=5.0 - - PLONE_VERSION=5.1 - - PLONE_VERSION=5.2 - - you will need to declare those variables in a ``matrix`` section, like this: - - .. code-block:: yaml - - env: - matrix: - - PLONE_VERSION=5.0 - - PLONE_VERSION=5.1 - - PLONE_VERSION=5.2 - global: - - secure: ... - - secure: ... - - ROBOT_BUILD_NUMBER=travis-$TRAVIS_BUILD_NUMBER - - ROBOT_REMOTE_URL=http://$SAUCE_USERNAME:$SAUCE_ACCESS_KEY@ondemand.saucelabs.com:80/wd/hub - - ROBOT_DESIRED_CAPABILITIES=tunnel-identifier:$TRAVIS_JOB_NUMBER - -6. Update your test suites to use SauceLabs test browser by including - ``saucelabs.robot`` resource and updating your *Test Setup* and *Test - Teardown* to use SauceLabs-supporting keywords (with these changes - the test suites will still continue to work also without SauceLabs): - - .. code-block:: robotframework - - *** Settings *** - - Force Tags wip-not_in_docs - ... - - Resource plone/app/robotframework/saucelabs.robot - - Test Setup Open SauceLabs test browser - Test Teardown Run keywords Report test status Close all browsers - - ... - -7. Update ``travis.cfg`` to allow downloading robotframework-packages: - - .. code-block:: ini - - [buildout] - - ... - - allow-hosts += - code.google.com - robotframework.googlecode.com - - -Running Sauce Labs build manually ---------------------------------- - -1. Download and unzip http://saucelabs.com/downloads/Sauce-Connect-latest.zip, - then start Sauce-Connect with: - - .. code-block:: bash - - $ java -jar Sauce-Connect.jar -i manual - -2. Start ``bin/robot-server``: - - .. code-block:: bash - - $ bin/robot-server my.product.testing.ROBOT_TESTING - -3. Run tests with ``bin/robot``: - - .. code-block:: bash - - $ bin/robot -v REMOTE_URL:http://SAUCE_USERNAME:SAUCE_ACCESS_KEY@ondemand.saucelabs.com:80/wd/hub -v BUILD_NUMBER:manual -v DESIRED_CAPABILITIES:tunnel-identifier:manual src/my/product/tests/test_product.robot - -or - -4. Create an argument file, e.g. ``saucelabs_arguments.txt``: - - .. code-block:: bash - - -v REMOTE_URL:http://SAUCE_USERNAME:SAUCE_ACCESS_KEY@ondemand.saucelabs.com:80/wd/hub - -v BUILD_NUMBER:manual - -v DESIRED_CAPABILITIES:tunnel-identifier:manual - -5. Execute ``bin/robot`` with the argument file option: - - .. code-block:: bash - - $ bin/robot -A saucelabs_arguments.txt src/my/product/tests/test_product.robot diff --git a/src/plone/app/robotframework/__init__.py b/src/plone/app/robotframework/__init__.py index ee4b7e68..53440361 100644 --- a/src/plone/app/robotframework/__init__.py +++ b/src/plone/app/robotframework/__init__.py @@ -13,7 +13,6 @@ # Generic remote Python library layer from plone.app.robotframework.remote import RemoteLibraryLayer -from plone.app.robotframework.saucelabs import SauceLabs # Pybot listener for calling Robot Server from pybot # Remote Python libraries diff --git a/src/plone/app/robotframework/saucelabs.py b/src/plone/app/robotframework/saucelabs.py deleted file mode 100644 index 59c92cb3..00000000 --- a/src/plone/app/robotframework/saucelabs.py +++ /dev/null @@ -1,44 +0,0 @@ -from http.client import HTTPConnection -from robot.libraries.BuiltIn import BuiltIn - -import base64 -import json -import os -import re - - -USERNAME_ACCESS_KEY = re.compile(r"^(http|https)://([^:]+):([^@]+)@") - - -class SauceLabs: - def report_sauce_status(self, name, status, tags=[], remote_url=""): - """Report test status and tags to SauceLabs""" - job_id = ( - BuiltIn() - .get_library_instance("Selenium2Library") - .driver - .session_id - ) - - if USERNAME_ACCESS_KEY.match(remote_url): - username, access_key = USERNAME_ACCESS_KEY.findall(remote_url)[0][1:] - else: - username = os.environ.get("SAUCE_USERNAME") - access_key = os.environ.get("SAUCE_ACCESS_KEY") - - if not job_id: - return "No Sauce job id found. Skipping..." - elif not username or not access_key: - return "No Sauce environment variables found. Skipping..." - - token = base64.encodestring(f"{username}:{access_key}")[:-1] - body = json.dumps({"name": name, "passed": status == "PASS", "tags": tags}) - - connection = HTTPConnection("saucelabs.com") - connection.request( - "PUT", - f"/rest/v1/{username}/jobs/{job_id}", - body, - headers={"Authorization": "Basic %s" % token}, - ) - return connection.getresponse().status diff --git a/src/plone/app/robotframework/saucelabs.robot b/src/plone/app/robotframework/saucelabs.robot deleted file mode 100644 index fc1e45d0..00000000 --- a/src/plone/app/robotframework/saucelabs.robot +++ /dev/null @@ -1,38 +0,0 @@ -*** Settings *** - -Resource selenium.robot - -Library String -Library plone.app.robotframework.SauceLabs - -*** Variables *** - -${BUILD_NUMBER} manual -${SELENIUM_VERSION} - -*** Keywords *** - -Open SauceLabs test browser - [Documentation] Open test browser at SauceLabs. The initial test name is - ... composed of suite name and test name, but colons (:) are - ... removed, because *Selenium2Library* reserves colon to be - ... used as a separator in the desired capabilities string. - ${SUITE_INFO} = Replace string ${SUITE_NAME} : ${EMPTY} - ${TEST_INFO} = Replace string ${TEST_NAME} : ${EMPTY} - ${BUILD_INFO} = Set variable - ... build:${BUILD_NUMBER},name:${SUITE_INFO} | ${TEST_INFO} - ${SAUCE_EXTRAS} = Set variable - ... selenium-version:${SELENIUM_VERSION},${BUILD_INFO} - ${SAUCE_CAPABILITIES} = Replace String Using Regexp - ... ${DESIRED_CAPABILITIES},${SAUCE_EXTRAS} - ... ^, ${EMPTY} - Open browser ${START_URL} ${BROWSER} - ... remote_url=${REMOTE_URL} - ... desired_capabilities=${SAUCE_CAPABILITIES} - ... ff_profile_dir=${FF_PROFILE_DIR} - -Report test status - [Documentation] Report test status back to SauceLabs. The final test name - ... is sent to fix test names missing colons (:). - Report sauce status ${SUITE_NAME} | ${TEST_NAME} - ... ${TEST_STATUS} ${TEST_TAGS} ${REMOTE_URL} diff --git a/src/plone/app/robotframework/selenium.robot b/src/plone/app/robotframework/selenium.robot index 6c3d2b18..2891d473 100644 --- a/src/plone/app/robotframework/selenium.robot +++ b/src/plone/app/robotframework/selenium.robot @@ -44,7 +44,7 @@ Wait until location is ... Location should be ${expected_url} Plone Test Setup - Open SauceLabs test browser + Open test browser Run keyword and ignore error Set window size 4096 4096 Plone Test Teardown diff --git a/src/plone/app/robotframework/tests/docs/test_hello.robot b/src/plone/app/robotframework/tests/docs/test_hello.robot index 48d6a13c..60f25e21 100644 --- a/src/plone/app/robotframework/tests/docs/test_hello.robot +++ b/src/plone/app/robotframework/tests/docs/test_hello.robot @@ -2,7 +2,6 @@ Force Tags wip-not_in_docs -Resource plone/app/robotframework/saucelabs.robot Resource plone/app/robotframework/selenium.robot Test Setup Run keywords Plone test setup diff --git a/src/plone/app/robotframework/tests/docs/test_keywords.robot b/src/plone/app/robotframework/tests/docs/test_keywords.robot index d8cffaf7..33a9f002 100644 --- a/src/plone/app/robotframework/tests/docs/test_keywords.robot +++ b/src/plone/app/robotframework/tests/docs/test_keywords.robot @@ -2,7 +2,6 @@ Force Tags wip-not_in_docs -Resource plone/app/robotframework/saucelabs.robot Resource plone/app/robotframework/selenium.robot Library Remote ${PLONE_URL}/RobotRemote diff --git a/src/plone/app/robotframework/tests/test_autologin_library.robot b/src/plone/app/robotframework/tests/test_autologin_library.robot index 2cb8ff0e..ef4c9f32 100644 --- a/src/plone/app/robotframework/tests/test_autologin_library.robot +++ b/src/plone/app/robotframework/tests/test_autologin_library.robot @@ -1,7 +1,6 @@ *** Settings *** Resource plone/app/robotframework/keywords.robot -Resource plone/app/robotframework/saucelabs.robot Resource plone/app/robotframework/selenium.robot Library Remote ${PLONE_URL}/RobotRemote diff --git a/src/plone/app/robotframework/tests/test_content_library.robot b/src/plone/app/robotframework/tests/test_content_library.robot index df8eab07..ec399786 100644 --- a/src/plone/app/robotframework/tests/test_content_library.robot +++ b/src/plone/app/robotframework/tests/test_content_library.robot @@ -1,6 +1,5 @@ *** Settings *** -Resource plone/app/robotframework/saucelabs.robot Resource plone/app/robotframework/selenium.robot Library Remote ${PLONE_URL}/RobotRemote diff --git a/src/plone/app/robotframework/tests/test_i18n_library.robot b/src/plone/app/robotframework/tests/test_i18n_library.robot index f31612bf..3c14413e 100644 --- a/src/plone/app/robotframework/tests/test_i18n_library.robot +++ b/src/plone/app/robotframework/tests/test_i18n_library.robot @@ -1,7 +1,6 @@ *** Settings *** Resource plone/app/robotframework/keywords.robot -Resource plone/app/robotframework/saucelabs.robot Resource plone/app/robotframework/selenium.robot Library Remote ${PLONE_URL}/RobotRemote diff --git a/src/plone/app/robotframework/tests/test_robotfixture.robot b/src/plone/app/robotframework/tests/test_robotfixture.robot index 1475f825..d6acd885 100644 --- a/src/plone/app/robotframework/tests/test_robotfixture.robot +++ b/src/plone/app/robotframework/tests/test_robotfixture.robot @@ -1,7 +1,6 @@ *** Settings *** Resource plone/app/robotframework/keywords.robot -Resource plone/app/robotframework/saucelabs.robot Resource plone/app/robotframework/selenium.robot Library Remote ${PLONE_URL}/RobotRemote diff --git a/src/plone/app/robotframework/tests/test_speakjs_library.robot b/src/plone/app/robotframework/tests/test_speakjs_library.robot index 6e08c718..247421e1 100644 --- a/src/plone/app/robotframework/tests/test_speakjs_library.robot +++ b/src/plone/app/robotframework/tests/test_speakjs_library.robot @@ -1,7 +1,6 @@ *** Settings *** Resource plone/app/robotframework/keywords.robot -Resource plone/app/robotframework/saucelabs.robot Resource plone/app/robotframework/selenium.robot Resource plone/app/robotframework/annotate.robot Resource plone/app/robotframework/speak.robot diff --git a/src/plone/app/robotframework/tests/test_users_library.robot b/src/plone/app/robotframework/tests/test_users_library.robot index 2e8a982c..64dcb96d 100644 --- a/src/plone/app/robotframework/tests/test_users_library.robot +++ b/src/plone/app/robotframework/tests/test_users_library.robot @@ -2,7 +2,6 @@ Resource plone/app/robotframework/keywords.robot Resource plone/app/robotframework/selenium.robot -Resource plone/app/robotframework/saucelabs.robot Library Remote ${PLONE_URL}/RobotRemote