Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 76 lines (50 sloc) 2.542 kb
f69e4bf @vistik updated README
authored
1 #Selenium framework for PHP (called Pelenium)
2
6191d34 @vistik updated README
authored
3 ## Current version
4
5 See VERSION.txt
6
f69e4bf @vistik updated README
authored
7 ## Structure of Pelenium
747e9c1 @vistik changed 'name' of the framework to pelenium. added more example (using a...
authored
8
9 This is a simple framework for selenium. It contains following:
10
11 conf/
5118fc4 @vistik updated README
authored
12
f69e4bf @vistik updated README
authored
13 configuration files - you can add your own or use the defaults
14
747e9c1 @vistik changed 'name' of the framework to pelenium. added more example (using a...
authored
15 core/
5118fc4 @vistik updated README
authored
16
f69e4bf @vistik updated README
authored
17 contains the 'core' of the framework
18 Pelenium_CommonElementFunctions.php - shared functions for all the elements
19 Pelenium_Framework.php - the framework file that contains both Pelenium_Framework and Pelenium_Framework_SauceLabs class. Used for localhost and saucelabs
20 Pelenium_Exception.php - Exception used in the framework
21
22 elements/
5118fc4 @vistik updated README
authored
23
f69e4bf @vistik updated README
authored
24 should contain your elements
25
26 results/
5118fc4 @vistik updated README
authored
27
f69e4bf @vistik updated README
authored
28 the test results
29
30 tests/
5118fc4 @vistik updated README
authored
31
f69e4bf @vistik updated README
authored
32 your tests
33
34 ## Requirements
35
be46f3d @vistik updated README
authored
36 * PHP
f69e4bf @vistik updated README
authored
37 * PHPUnit 3.5.15
38 * Running selenium server (on port 4444)
be46f3d @vistik updated README
authored
39 * PHP in your exec path (so you can run commandline php)
f69e4bf @vistik updated README
authored
40
41 ## Idea behind the framework
42
43 The main idea is to create reuseable selenium code by dividing a website into elements, like the login part is called login element etc. So every time you need to login, navigate to the login page
44 and use the login element you have created. See my examples if you wanna see some code.
45
46 ## Cool features
47
48 * The structure (yes is a feature :), it makes sure that you do it the same way everytime)
be46f3d @vistik updated README
authored
49 * a lot of waitFor functions - Make the code nicer
f69e4bf @vistik updated README
authored
50 * assertPrestate function - this function can help your detect error due to being at the wrong page. See example in LoginElement line 13
be46f3d @vistik updated README
authored
51 * run the same tests with different configurations
52 * switch from running locally to saucelabs with a simple change in each test (yes i know it should one change in all but i'm working on it :) )
f69e4bf @vistik updated README
authored
53
be46f3d @vistik updated README
authored
54 ## How to get started
55
56 * Clone this project to your computer to a folder eg. /pelenium
57 * Navigate to the main dir of the framework /pelenium
58 * run "php Runner.php localhost" - this will run pelenium with the configuration file 'localhost'
59
60 ## Configuration files
61
62 The configuration files contains alot of settings to your test run
63
64 * combinations to run the test in
65 * url to run test on
66 * where to find the tests, relative to runner.php's location
67 * where to put test results
68 * delete old testreports when starting a new run
69 * type of test run (saucelabs or localhost)
70 * saucelabs username, only needed if running saucelabs mode
71 * saucelabs apikey, only needed if running saucelabs mode
72 * debugmode. output to the console what the runner does, can be used for debugging
73 * delay (in sec) between starting tests (useful when running locally so test don't timeout)
74 * selenium host
6191d34 @vistik updated README
authored
75 * selenium port
Something went wrong with that request. Please try again.