Skip to content

Commit 4b47a32

Browse files
kobenguyentkobenguyent
committed
DRY
1 parent db2b080 commit 4b47a32

File tree

4 files changed

+253
-39
lines changed

4 files changed

+253
-39
lines changed

‎docs/saucelabs-troubleshooting.md‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
# Sauce Labs Troubleshooting Guide
2+
3+
This guide helps resolve common Sauce Labs infrastructure errors when running CodeceptJS tests with Appium.
4+
5+
## Common Error: "Infrastructure Error -- The Sauce VMs failed to start the browser or device"
6+
7+
This error typically occurs due to:
8+
9+
### 1. Missing or Invalid Credentials
10+
```bash
11+
# Set these environment variables before running tests
12+
export SAUCE_USERNAME="your_sauce_username"
13+
export SAUCE_ACCESS_KEY="your_sauce_access_key"
14+
```
15+
16+
### 2. Outdated Platform/Device Combinations
17+
The error often occurs when requesting deprecated or unavailable devices/OS versions.
18+
19+
**Updated Android Configuration:**
20+
```javascript
21+
{
22+
helpers: {
23+
Appium: {
24+
host: 'ondemand.us-west-1.saucelabs.com',
25+
port: 443,
26+
protocol: 'https',
27+
user: process.env.SAUCE_USERNAME,
28+
key: process.env.SAUCE_ACCESS_KEY,
29+
desiredCapabilities: {
30+
'sauce:options': {
31+
appiumVersion: '2.0.0',
32+
name: 'Your Test Name',
33+
build: process.env.BUILD_NUMBER || 'local-build',
34+
tags: ['codeceptjs', 'appium', 'android'],
35+
recordVideo: false,
36+
recordScreenshots: false,
37+
idleTimeout: 300,
38+
newCommandTimeout: 300,
39+
},
40+
browserName: '',
41+
platformName: 'Android',
42+
platformVersion: '12.0', // Use recent versions
43+
deviceName: 'Google Pixel 6 GoogleAPI Emulator',
44+
automationName: 'UiAutomator2',
45+
autoGrantPermissions: true,
46+
noReset: true,
47+
app: 'sauce-storage:your-app.apk'
48+
}
49+
}
50+
}
51+
}
52+
```
53+
54+
**Updated iOS Configuration:**
55+
```javascript
56+
{
57+
helpers: {
58+
Appium: {
59+
host: 'ondemand.us-west-1.saucelabs.com',
60+
port: 443,
61+
protocol: 'https',
62+
user: process.env.SAUCE_USERNAME,
63+
key: process.env.SAUCE_ACCESS_KEY,
64+
desiredCapabilities: {
65+
'sauce:options': {
66+
appiumVersion: '2.0.0',
67+
name: 'Your iOS Test',
68+
build: process.env.BUILD_NUMBER || 'local-build',
69+
tags: ['codeceptjs', 'appium', 'ios'],
70+
recordVideo: false,
71+
recordScreenshots: false,
72+
idleTimeout: 300,
73+
newCommandTimeout: 300,
74+
},
75+
browserName: '',
76+
platformName: 'iOS',
77+
platformVersion: '16.0', // Use recent versions
78+
deviceName: 'iPhone 14 Simulator',
79+
automationName: 'XCUITest',
80+
autoAcceptAlerts: true,
81+
noReset: true,
82+
app: 'sauce-storage:your-ios-app.ipa'
83+
}
84+
}
85+
}
86+
}
87+
```
88+
89+
### 3. Regional Endpoint Issues
90+
Use specific regional endpoints instead of the generic one:
91+
- US West: `ondemand.us-west-1.saucelabs.com`
92+
- US East: `ondemand.us-east-1.saucelabs.com`
93+
- EU: `ondemand.eu-central-1.saucelabs.com`
94+
95+
### 4. App Upload Issues
96+
Ensure your app is properly uploaded to Sauce Storage:
97+
```bash
98+
# Upload app to Sauce Labs
99+
curl -u "$SAUCE_USERNAME:$SAUCE_ACCESS_KEY" \
100+
-X POST "https://api.us-west-1.saucelabs.com/rest/v1/storage/upload" \
101+
-H "Content-Type: application/octet-stream" \
102+
--data-binary @your-app.apk
103+
```
104+
105+
### 5. Capability Validation
106+
Before running tests, validate your capabilities using Sauce Labs Platform Configurator:
107+
https://saucelabs.com/platform/platform-configurator
108+
109+
### 6. Alternative Workarounds
110+
111+
**Local Testing Fallback:**
112+
```javascript
113+
const sauceConfig = {
114+
// Sauce Labs configuration
115+
};
116+
117+
const localConfig = {
118+
host: 'localhost',
119+
port: 4723,
120+
protocol: 'http',
121+
desiredCapabilities: {
122+
platformName: 'Android',
123+
platformVersion: '11.0',
124+
deviceName: 'Android Emulator',
125+
automationName: 'UiAutomator2',
126+
app: '/path/to/your/app.apk'
127+
}
128+
};
129+
130+
// Use local config if Sauce Labs credentials are missing
131+
const config = (process.env.SAUCE_USERNAME && process.env.SAUCE_ACCESS_KEY)
132+
? sauceConfig
133+
: localConfig;
134+
```
135+
136+
### 7. Debugging Steps
137+
138+
1. **Check Sauce Labs service status:**
139+
```bash
140+
curl -s "https://saucelabs.com/rest/v1/info/status"
141+
```
142+
143+
2. **Verify account limits:**
144+
- Check concurrent session limits
145+
- Verify account is not suspended
146+
- Ensure sufficient credits/minutes
147+
148+
3. **Test with basic capabilities:**
149+
Start with minimal capabilities and add complexity gradually.
150+
151+
4. **Monitor Sauce Labs dashboard:**
152+
Check real-time test execution in the Sauce Labs dashboard for detailed error messages.
153+
154+
### 8. Best Practices
155+
156+
- Use HTTPS protocol for better security
157+
- Set appropriate timeouts (300+ seconds for mobile tests)
158+
- Use specific device names rather than generic ones
159+
- Keep platform versions current (within 2-3 major versions)
160+
- Use `sauce:options` for Sauce Labs specific configurations
161+
- Enable `noReset: true` to speed up test execution
162+
- Set meaningful test names and builds for better organization
163+
164+
### 9. Contact Support
165+
166+
If issues persist after following this guide:
167+
- Check Sauce Labs status page: https://status.saucelabs.com/
168+
- Contact Sauce Labs support with your session ID and error details
169+
- Consider using alternative cloud providers (BrowserStack, etc.)

‎test/helper/AppiumWeb_test.js‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,25 @@ describe('Appium Web', function () {
1616
desiredCapabilities: {
1717
'sauce:options': {
1818
appiumVersion: '2.0.0',
19+
name: 'CodeceptJS Appium Web Test',
20+
build: process.env.BUILD_NUMBER || 'local-build',
21+
tags: ['codeceptjs', 'appium', 'web', 'android'],
22+
recordVideo: false,
23+
recordScreenshots: false,
24+
idleTimeout: 300,
25+
newCommandTimeout: 300,
1926
},
20-
recordVideo: 'false',
21-
recordScreenshots: 'false',
27+
browserName: 'Chrome',
2228
platformName: 'Android',
23-
platformVersion: '6.0',
24-
deviceName: 'Android Emulator',
29+
platformVersion: '12.0',
30+
deviceName: 'Google Pixel 6 GoogleAPI Emulator',
2531
automationName: 'UiAutomator2',
32+
autoGrantPermissions: true,
33+
noReset: true,
2634
},
27-
host: 'ondemand.saucelabs.com',
28-
port: 80,
35+
protocol: 'https',
36+
host: 'ondemand.us-west-1.saucelabs.com',
37+
port: 443,
2938
// port: 4723,
3039
// host: 'localhost',
3140
user: process.env.SAUCE_USERNAME,

‎test/helper/Appium_ios_test.js‎

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ global.codeceptjs = require('../../lib')
1111

1212
let app
1313
// iOS test app is built from https://github.com/appium/ios-test-app and uploaded to Saucelabs
14-
const apk_path = 'storage:filename=TestApp-iphonesimulator.zip'
14+
const ios_app_path = 'storage:filename=TestApp-iphonesimulator.zip'
1515
const smallWait = 3
1616

1717
describe('Appium iOS Tests', function () {
@@ -20,24 +20,32 @@ describe('Appium iOS Tests', function () {
2020
before(async () => {
2121
global.codecept_dir = path.join(__dirname, '/../data')
2222
app = new Appium({
23-
app: apk_path,
23+
app: ios_app_path,
2424
desiredCapabilities: {
2525
'sauce:options': {
2626
appiumVersion: '2.0.0',
27+
name: 'CodeceptJS Appium iOS Test',
28+
build: process.env.BUILD_NUMBER || 'local-build',
29+
tags: ['codeceptjs', 'appium', 'ios'],
30+
recordVideo: false,
31+
recordScreenshots: false,
32+
idleTimeout: 300,
33+
newCommandTimeout: 300,
2734
},
2835
browserName: '',
29-
recordVideo: 'false',
30-
recordScreenshots: 'false',
3136
platformName: 'iOS',
32-
platformVersion: '12.2',
33-
deviceName: 'iPhone 8 Simulator',
37+
platformVersion: '16.0',
38+
deviceName: 'iPhone 14 Simulator',
39+
automationName: 'XCUITest',
3440
androidInstallTimeout: 90000,
3541
appWaitDuration: 300000,
42+
autoAcceptAlerts: true,
43+
noReset: true,
3644
},
3745
restart: true,
38-
protocol: 'http',
39-
host: 'ondemand.saucelabs.com',
40-
port: 80,
46+
protocol: 'https',
47+
host: 'ondemand.us-west-1.saucelabs.com',
48+
port: 443,
4149
user: process.env.SAUCE_USERNAME,
4250
key: process.env.SAUCE_ACCESS_KEY,
4351
})

‎test/helper/Appium_test.js‎

Lines changed: 52 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,31 +19,59 @@ describe('Appium', function () {
1919

2020
before(async () => {
2121
global.codecept_dir = path.join(__dirname, '/../data')
22-
app = new Appium({
23-
app: apk_path,
24-
desiredCapabilities: {
25-
'sauce:options': {
26-
appiumVersion: '2.0.0',
22+
23+
// Check if Sauce Labs credentials are available
24+
if (!process.env.SAUCE_USERNAME || !process.env.SAUCE_ACCESS_KEY) {
25+
console.warn('Sauce Labs credentials not found. Skipping Sauce Labs tests.')
26+
console.warn('Set SAUCE_USERNAME and SAUCE_ACCESS_KEY environment variables to run Sauce Labs tests.')
27+
app = new Appium({
28+
app: apk_path,
29+
desiredCapabilities: {
30+
browserName: '',
31+
platformName: 'Android',
32+
platformVersion: '11.0',
33+
deviceName: 'Android Emulator',
34+
automationName: 'UiAutomator2',
35+
androidInstallTimeout: 90000,
36+
appWaitDuration: 300000,
2737
},
28-
browserName: '',
29-
recordVideo: 'false',
30-
recordScreenshots: 'false',
31-
platformName: 'Android',
32-
platformVersion: '7.0',
33-
deviceName: 'Android GoogleAPI Emulator',
34-
androidInstallTimeout: 90000,
35-
appWaitDuration: 300000,
36-
automationName: 'UiAutomator2',
37-
},
38-
restart: true,
39-
protocol: 'http',
40-
host: 'ondemand.saucelabs.com',
41-
port: 80,
42-
// port: 4723,
43-
// host: 'localhost',
44-
user: process.env.SAUCE_USERNAME,
45-
key: process.env.SAUCE_ACCESS_KEY,
46-
})
38+
restart: true,
39+
protocol: 'http',
40+
host: 'localhost',
41+
port: 4723,
42+
})
43+
} else {
44+
app = new Appium({
45+
app: apk_path,
46+
desiredCapabilities: {
47+
'sauce:options': {
48+
appiumVersion: '2.0.0',
49+
name: 'CodeceptJS Appium Test',
50+
build: process.env.BUILD_NUMBER || 'local-build',
51+
tags: ['codeceptjs', 'appium', 'android'],
52+
recordVideo: false,
53+
recordScreenshots: false,
54+
idleTimeout: 300,
55+
newCommandTimeout: 300,
56+
},
57+
browserName: '',
58+
platformName: 'Android',
59+
platformVersion: '12.0', // Updated to more recent Android version
60+
deviceName: 'Google Pixel 6 GoogleAPI Emulator', // More specific device
61+
automationName: 'UiAutomator2',
62+
androidInstallTimeout: 90000,
63+
appWaitDuration: 300000,
64+
autoGrantPermissions: true,
65+
noReset: true,
66+
},
67+
restart: true,
68+
protocol: 'https', // Use HTTPS for better security
69+
host: 'ondemand.us-west-1.saucelabs.com', // Use specific regional endpoint
70+
port: 443,
71+
user: process.env.SAUCE_USERNAME,
72+
key: process.env.SAUCE_ACCESS_KEY,
73+
})
74+
}
4775
await app._beforeSuite()
4876
app.isWeb = false
4977
await app._before()

0 commit comments

Comments
 (0)