first commit

jagdeep-jain · jagdeep-jain · commit 1c1fb60fb3c8 · 2020-02-28T17:25:23.000+05:30
diff --git a/README.md b/README.md
@@ -1 +1,47 @@
-# python-selenium-docker-tests
+# Python + Selenium + Docker
+This sample project demonstrates how we can utilize docker container for running python selenium ui tests.
+
+Script does the Docker Container start before the test gets executed and once execution is completed it will get stopped/removed.
+
+Test script file `ui-test.py` has `setUpClass()` which instantiate the selenium container and `tearDownClass()` stop/remove the selenium container.
+
+## Requirements
+### Mac OS
+
+Docker is installed and running.
+
+### Lunux/Windows OS
+
+* Docker is installed and running.
+* docker-compose is installed and running. 
+
+## pip 
+
+```
+pip install subprocess.run
+pip install selenium 
+```
+
+## Test Run
+
+```
+python ui-test.py
+```
+
+## Output
+
+```
+Creating network "ui_test_default" with the default driver
+Creating ui_test_chrome_standalone_1 ... done
+test_case_1 (__main__.TestTemplate)
+Find and click top-right button ... ok
+test_case_2 (__main__.TestTemplate)
+Find and click Learn more button ... ok
+Removing ui_test_chrome_standalone_1...
+removed...
+
+----------------------------------------------------------------------
+Ran 2 tests in 15.363s
+
+OK
+```
diff --git a/clean.sh b/clean.sh
@@ -0,0 +1,8 @@
+#!/bin/sh
+if [[ $(docker ps -aq) ]]; then
+    echo "Removing $(docker ps --format "{{.Names}}")..."
+    running_container="$(docker ps --format "{{.Names}}")"
+    docker rm -f $running_container | echo "removed..."
+else
+    echo "nothing to stop/remove..."
+fi
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,12 @@
+version: '3'
+services:
+    chrome_standalone:
+        restart: always
+        image: selenium/standalone-chrome-debug:latest
+        volumes:
+            - /dev/shm:/dev/shm
+        ports:
+            - 1111:4444
+            - "5900"
+        stdin_open: true
+
diff --git a/sample-docker-start-stop.py b/sample-docker-start-stop.py
@@ -0,0 +1,20 @@
+import os.path
+import subprocess
+from subprocess import PIPE
+
+import time
+
+def start():
+    p = subprocess.Popen(['docker-compose', '-p ui_test', 'up', '-d'])
+    time.sleep(5)
+    p.wait()
+    print("docker started....")
+
+def stop():
+    p = subprocess.Popen(['sh', './clean.sh'])
+    time.sleep(5)
+    p.wait()
+
+start_docker()
+clean_docker_container()
+
diff --git a/ui-test.py b/ui-test.py
@@ -0,0 +1,64 @@
+"""
+A simple selenium test example demonstrating docker container usage.
+Thanks to @joyzoursky for the test script https://github.com/joyzoursky/docker-python-chromedriver
+"""
+
+import unittest
+from selenium import webdriver
+from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
+from selenium.common.exceptions import NoSuchElementException
+
+import os.path
+import subprocess
+from subprocess import PIPE
+
+import time
+
+class TestTemplate(unittest.TestCase):
+
+    @classmethod
+    def setUpClass(self):
+        """Start web driver and start the docker container"""
+        p = subprocess.Popen(['docker-compose', '-p ui_test', 'up', '-d'])
+        time.sleep(5)
+        p.wait()
+        chrome_options =  webdriver.ChromeOptions()
+        chrome_options.add_argument('--no-sandbox')
+        chrome_options.add_argument("--disable-setuid-sandbox")
+        """uncomment below for running in headless mode"""
+        """chrome_options.add_argument('--headless')"""
+        chrome_options.add_argument('--disable-gpu')
+        chrome_options.add_argument("--disable-extensions")
+        """selenium docker container is set to run on port 1111"""
+        self.driver = webdriver.Remote(desired_capabilities=chrome_options.to_capabilities(), command_executor='http://localhost:1111/wd/hub')
+        self.driver.implicitly_wait(10)
+
+    @classmethod
+    def tearDownClass(self):
+        """Stop web driver and remove the docker container"""
+        self.driver.quit()
+        p = subprocess.Popen(['sh', './clean.sh'])
+        time.sleep(5)
+        p.wait()
+
+    def test_case_1(self):
+        """Find and click top-right button"""
+        try:
+            self.driver.get('https://www.oursky.com/')
+            el = self.driver.find_element_by_class_name('btn-header')
+            el.click()
+        except NoSuchElementException as ex:
+            self.fail(ex.msg)
+
+    def test_case_2(self):
+        """Find and click Learn more button"""
+        try:
+            self.driver.get('https://www.oursky.com/')
+            el = self.driver.find_element_by_xpath(".//*[@id='tag-line-wrap']/span/a")
+            el.click()
+        except NoSuchElementException as ex:
+            self.fail(ex.msg)
+
+if __name__ == '__main__':
+    suite = unittest.TestLoader().loadTestsFromTestCase(TestTemplate)
+    unittest.TextTestRunner(verbosity=2).run(suite)
