Skip to content
This repository was archived by the owner on Jul 10, 2024. It is now read-only.

Commit 036d43a

Browse files
Update README docs with v1.0.0-beta11 changes
1 parent f7b6125 commit 036d43a

File tree

1 file changed

+24
-37
lines changed

1 file changed

+24
-37
lines changed

README.md

Lines changed: 24 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,32 @@
66
<i><strong>Appium plugin that provides complete test logs, video recording of test and device logs(logcat and syslogs) for easy debugging of tests.</strong></i>
77
<p>
88

9-
## Sample Preview
9+
## Features
1010

11-
Check the sample video [here](https://gfycat.com/sharpincompletehorsechestnutleafminer)
11+
### Complete Session Log: (IOS and Android)
12+
Monitor all webdriver session api calls made by the test will full request and response details.
1213

13-
### Screenshot
14+
https://user-images.githubusercontent.com/20136913/153456977-6032ed52-2437-495c-afe6-6e02825354d0.mov
1415

15-
<p align="center">
16-
<a href="https://gfycat.com/sharpincompletehorsechestnutleafminer">
17-
<img src="./assets/preview.png"/>
18-
</a></p>
16+
### Live video stream: (IOS and Android)
17+
Watch the live video of the test execution
18+
19+
https://user-images.githubusercontent.com/20136913/153455978-26cb7820-bf03-47dc-a5c6-af26724efe2c.mp4
20+
21+
### Device Logs: (IOS and Android)
22+
View device logs from android(logcat) and Ios(syslogs) devices/emulators.
23+
24+
### App Profiling: (Android)
25+
Get insignts on the performance of the application by analysing the CPU and Memory usage during the test execution.
26+
27+
![Screenshot 2022-02-10 at 10 32 17 PM](https://user-images.githubusercontent.com/20136913/153458372-3d572b6a-04f1-4396-8440-667f6a6226e6.png)
28+
29+
### Network Logs: (Android)
30+
Monitor the network requests made by native/hybrid appilcation(inside WebView) and web based tests that runs on chrome browser
31+
32+
https://user-images.githubusercontent.com/20136913/153460750-7dd49ef6-4451-464a-8084-f18a3d128b40.mov
33+
34+
### And lot more yet to come....
1935

2036
## Installation
2137

@@ -33,35 +49,6 @@ Once the installion is done, the plugin needs to be activated each time when the
3349
appium --use-plugin=appium-dashboard
3450
```
3551

36-
Now navigate to `http://localhost:4723/dashboard` to open the client web app which will show the complete list of tests and its details that are being executed.
52+
Now navigate to `http://localhost:4723/dashboard` to open the web app which will show the complete list of tests and its details that are being executed.
3753

3854
NOTE: This plugin is still in beta phase and heavy testing is being done to eliminate all possible issues along with lot other new features.
39-
40-
## Troubleshooting
41-
42-
### Migrating from 1.x to 2.0
43-
44-
If you are migrating from 1.0 to 2.0 to try out this plugin, be aware that 2.0 has breaking changes as listed below.
45-
46-
> https://appiumpro.com/editions/123-migrating-to-appium-20-part-1-capability-prefixes
47-
48-
If your tests stop working, you may think that it has got something to do with this plugin, but maybe it is not.
49-
50-
To fix/rule out the breaking changes due to 2.0; you have to make the below two minor changes in your code, for it to continue working on both 1.x and 2.0.
51-
52-
- Run this command `appium --base-path /wd/hub` to start the server (assuming your baseURL in 1.2 has /wd/hub as a part of hostURl)
53-
- Reference: https://github.com/appium/appium/issues/15261
54-
- A quote From appium 2.0 `With Appium 2.0, the Appium server will enforce strict compability with the W3C WebDriver specification when it comes to Capabilities`
55-
. Which means the existing appium capabilities are not supported in 2.0 and there are a couple of "easy" workarounds that users can do
56-
to make tests run in both 2.0 and 1.x. For example, if you run your tests and you get an error similar to below.
57-
`org.openqa.selenium.SessionNotCreatedException: Unable to create a new remote session. Please check the server log for more details. Original error: All non-standard capabilities should have a vendor prefix. The following capabilities did not have one: systemPort `.
58-
You can prefix `appium:` in front of the capability and your tests should work fine. For example, in above case adding appium in front of systemPort `capabilities.setCapability("appium:systemPort ", 8200);`, fixes
59-
the issue and tests run fine.
60-
61-
Once you have ruled out issues due to 1.0 to 2.0 migration, you can then:
62-
63-
- Close the server that you started without loading plugin above `appium --base-path /wd/hub`.
64-
- Now run the server with plugin loaded as `appium --base-path /wd/hub --plugins=appium-dashboard`
65-
- Open the dashboard `http://localhost:4723/dashboard`
66-
- Run the tests again and if you now get any errors, there is now a high probability that you have found an issue with the dashboard-plugin.
67-
- In that case, report it on the issues page of this repository: https://github.com/sudharsan-selvaraj/appium-dashboard-plugin/issues

0 commit comments

Comments
 (0)