OLD | NEW |
---|---|
(Empty) | |
1 This file contains high-level info about how to use password manager tests and | |
2 how to create new ones. | |
3 | |
4 The password manager tests purpose is to allow automatic password manager | |
5 checking and avoiding to do so manually. | |
6 The tests are written in python using selenium Webdriver library. | |
7 | |
8 | |
9 =====Getting started===== | |
10 | |
11 Build ChromeDriver by building the 'chromedriver' target. This will | |
12 create an executable binary in the build folder named 'chromedriver[.exe]'. | |
13 | |
14 Build chrome too by building the 'chrome' target. This will | |
15 create an executable binary in the build folder named 'chrome[.exe]'. | |
16 | |
17 Install Selenium (the version tested was 2.41.0): | |
18 pip install -U selenium | |
19 | |
20 | |
21 For security reasons, we didn't publish the passwords and the usernames we | |
22 used to test. So we put them to an xml file (websites.xml). The structure of | |
23 the file is the following: | |
24 <websites> | |
25 <website name = "website name"> | |
26 <username>username</username> | |
27 <password>password</password> | |
28 </website> | |
29 <websites> | |
30 You can ask someone to give you the websites.xml file and put it in the same | |
31 folder as the tests. You can also create your own websites.xml with your | |
32 personal accounts. | |
33 WARNING: All the content of the PROFILEPATH is going to be deleted. | |
34 Show the help: | |
35 python tests.py --help | |
36 Run all the working tests tests by executing: | |
37 python tests.py --chrome-path CHROMEPATH --chromedriver-path CHROMEDRIVERPATH | |
38 --profile-path PROFILEPATH [--passwords_path PASSWORDSPATH] | |
39 | |
40 Run all the tests by executing: | |
41 python tests.py --all --chrome-path CHROMEPATH --chromedriver-path | |
42 CHROMEDRIVERPATH --profile-path PROFILEPATH [--passwords_path PASSWORDSPATH] | |
43 | |
44 Run one or many tests by executing: | |
45 python tests.py google --chrome-path CHROMEPATH --chromedriver-path | |
46 CHROMEDRIVERPATH profile-path PROFILEPATH [--passwords_path PASSWORDSPATH] | |
47 | |
48 python tests.py google facebook --chrome-path CHROMEPATH --chromedriver-path | |
49 CHROMEDRIVERPATH --profile-path PROFILEPATH [--passwords_path PASSWORDSPATH] | |
50 | |
51 python tests.py google facebook amazon --chrome-path CHROMEPATH | |
52 --chromedriver-path CHROMEDRIVERPATH --profile-path PROFILEPATH | |
53 [--passwords_path PASSWORDSPATH] | |
54 | |
55 To display the debugging messages on the screen, use: | |
56 python tests.py --log DEBUG|INFO|WARNING|ERROR|CRITICAL --log-screen | |
57 To save debugging messages into a file, use: | |
58 python tests.py --log DEBUG|INFO|WARNING|ERROR|CRITICAL --log-file LOG_FILE | |
59 | |
60 | |
61 =====Creating new test===== | |
62 | |
63 1) Open tests.py. | |
64 | |
65 2) Add tests like this: | |
66 | |
67 class NewWebsiteTest(WebsiteTest): | |
68 | |
69 def Login(self): | |
70 # Add login steps for the website, for example: | |
71 self.GoTo("http://url") | |
72 self.FillUsernameInto("Username CSS selector") | |
73 self.FillPasswordInto("Password CSS selector") | |
74 self.Submit("Password CSS selector") | |
75 | |
76 def Logout(self): | |
77 # Add logout steps for the website, for example: | |
78 self.Click("Logout button CSS selector") | |
79 | |
80 Then, to create the new test, you need just to add: | |
81 | |
82 environment.AddWebsiteTest(NewWebsiteTest("website name")) | |
83 | |
84 * For security reasons, you have to use websites.xml which is a private to | |
vabr (Chromium)
2014/05/22 13:39:24
The name websites.xml is not fixed, so please do n
rchtara
2014/05/22 15:20:56
Done.
| |
85 keep your passwords. You need to add the following line to the xml file: | |
86 | |
87 <website name = "website name"> | |
88 <username>username</username> | |
89 <password>password</password> | |
90 </website> | |
91 | |
92 The "website name" is only used to find the username and password in the xml | |
93 file. | |
94 | |
95 | |
96 Use the flowing methods to perform the login and logout: | |
97 The methods that you can use are: | |
98 | |
99 * Click: find an element using CSS Selector and click on it. Throw an | |
100 exception if the element is not visible. | |
101 self.Click("css_selector") | |
102 * ClickIfClickable: find an element using CSS Selector and click on it if it's | |
103 possible to do that. | |
104 self.ClickIfClickable("css_selector") | |
105 * GoTo: navigate the main frame to a url. | |
106 self.GoTo("url") | |
107 * HoverOver: find an element using CSS Selector and hover over it. | |
108 self.HoverOver("css_selector") | |
109 * SendEnterTo: find an element using CSS Selector and send enter to it. | |
110 self.SendEnterTo("css_selector") | |
111 | |
112 * IsDisplayed: check if an element is displayed. | |
113 self.IsDisplayed("css_selector") | |
114 * Wait: wait for some amount of time in seconds. | |
115 self.Wait(10) | |
116 * WaitUntilDisplayed: wait for an element defined using CSS Selector to be | |
117 displayed. | |
118 self.WaitUntilDisplayed("css_selector") | |
119 | |
120 * FillPasswordInto: find an input element using CSS Selector and fill it with | |
121 the password. | |
122 self.FillPasswordInto("css_selector") | |
123 * FillUsernameInto: find an input element using CSS Selector and fill it with | |
124 the username. | |
125 self.FillUsernameInto("css_selector") | |
126 * Submit: find an element using CSS Selector and call its submit() handler. | |
127 self.Submit("css_selector") | |
128 | |
129 | |
130 =====Files structure===== | |
131 | |
132 Classes: | |
133 * environment.py: the definition the tests Environment. | |
134 * websitetest.py: WebsiteTest is defined here. You need to create an instance | |
135 of this class for each website you want to test. | |
136 | |
137 Tests: | |
138 * tests.py: the tests setup and the configuration for each website happens | |
139 here. This file contain 3 separate kinds of tests: | |
140 | |
141 1) working tests: tests that are supposed to work. If you have a problem with | |
142 one of them, rerun it again. Or try using the Known Issues section to fix it. | |
143 2) tests that can cause a crash (the cause of the crash is not related to the | |
144 password manager): This means that this set is expected to become a working | |
145 test or failing test when the issue that causes the crash now is solved. | |
146 3) failing tests: tests that fail for known bug related to the password | |
147 manager. When this bug is solved, all the tests that were failing because of | |
148 it are going to be moved to working tests. | |
149 | |
150 Other files: | |
151 * websites.xml : a private file where you can find all the passwords. You can | |
152 ask someone to give it to you or just create your own with your personal | |
153 accounts. | |
154 <websites> | |
155 <website name = "website name"> | |
156 <username>username</username> | |
157 <password>password</password> | |
158 </website> | |
159 </websites> | |
160 | |
161 | |
162 =====Known Issues===== | |
163 | |
164 The tests are very fragile. Here are some suggestions for solving most of the | |
165 problems: | |
166 * Restart the tests. | |
167 * Remove the profile if the tests fail at the beginning for unknown reason. | |
168 * If tests fail, isolate the one that causes problem, read debugging messages | |
169 and keep your eyes on the browser window to understand its causes: | |
170 a) In the tests, we often need to wait for a menu to appear ... If the | |
171 menu takes more time to appear than expected, the tests are going to fail. | |
172 b) The websites change very often. And even if they are not changed, they some | |
173 time show a popup that broke the tests. In the case you need to login manually | |
174 to the website, close all popup and logout. | |
175 * If you are logged in when the tests crashes, don't forget to log out before | |
176 running the tests a second time. | |
OLD | NEW |