Skip to content

Commit

Permalink
docs: Add a hint on how to skip server version validation (#1025)
Browse files Browse the repository at this point in the history
  • Loading branch information
mykola-mokhnach authored Jul 16, 2024
1 parent f388a0d commit 240739f
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ appium:printPageSourceOnFindFailure | Enforces the server to dump the actual XML
Capability Name | Description
--- | ---
appium:systemPort | The number of the port the Espresso server is listening on. By default the first free port from 8300..8399 range is selected. It is recommended to set this value if you are running [parallel tests](docs/parallel-tests.md) on the same machine.
appium:skipServerInstallation | Skip the Espresso Server component installation on the device under test and all the related checks if set to `true`. This could help to speed up the session startup if you know for sure the correct server version is installed on the device. In case the server is not installed or an incorrect version of it is installed then you may get an unexpected error later. `false` by default
appium:skipServerInstallation | Skip the Espresso Server component installation on the device under test and all the related checks if set to `true`. This could help to speed up the session startup if you know for sure the correct server version is installed on the device. In case the server is not installed or an incorrect version of it is installed then you may get an unexpected error later. Since driver version 3.3.0 the driver automatically verifies the compatibility with the server module on session startup by checking its `/status` response. An error is thrown if the returned server major version does not match to the driver's module major version or the target package name is different from the expected one. You may also skip the server version validation for a prebuilt server module by setting the [VERSION constant](./espresso-server/library/src/main/java/io/appium/espressoserver/lib/helpers/Version.kt) to a non-valid [semver](https://semver.org/) value. `false` by default
appium:espressoServerLaunchTimeout | The maximum number of milliseconds to wait util Espresso server is listening on the device. `45000` ms by default
appium:forceEspressoRebuild | Whether to always enforce Espresso server rebuild (`true`). By default Espresso caches the already built server apk and only rebuilds it when it is necessary, because rebuilding process needs extra time. `false` by default
appium:espressoBuildConfig | Either the full path to build config JSON on the server file system or the JSON content itself serialized to a string. This config allows to customize several important properties of Espresso server. Refer to [Espresso Build Config](#espresso-build-config) for more information on how to properly construct such config.
Expand Down
2 changes: 1 addition & 1 deletion lib/espresso-runner.js
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ class EspressoRunner {
const warnMessage = parsedServerVersion
? `The Espresso driver version '${driverVersion}' ` +
`cannot be parsed. It might be incompatible with the current server '${serverVersion}' ` +
`integrated with the ${appLabel} .`
`integrated with the ${appLabel}.`
: `The Espresso server version '${serverVersion}' integrated with the ${appLabel} ` +
`cannot be parsed. It might be incompatible with the current driver ` +
`version '${driverVersion}'.`;
Expand Down

0 comments on commit 240739f

Please sign in to comment.