Skip to content

Commit

Permalink
Updated README with new server option info
Browse files Browse the repository at this point in the history
  • Loading branch information
joergschultzelutter authored Aug 8, 2022
1 parent 4b598a9 commit 072cd22
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@ options:
Robot Framework log file name. Default value: remote_log.html
--report-file ROBOT_REPORT_FILE
Robot Framework report file name. Default value: remote_report.html
--always-upgrade-server-packages
If your Robot Framework suite depends on external pip packages, always upgrade these packages
on the remote XMLRPC server even if they are already installed. This is the equivalent to
the server's 'always-upgrade-packages' option which allows you to control a forced update
through the client.
--debug Run in debug mode. This will enable debug logging and does not cleanup the workspace directory
on the remote machine after test execution
```
Expand Down Expand Up @@ -96,8 +101,10 @@ options:
Robot Framework log level. Valid values = TRACE, DEBUG, INFO, WARN, NONE.
Default value = WARN
--always-upgrade-packages
If your Robot Framework suite depends on external pip packages,
always upgrade these packages even if they are already installed
If your Robot Framework suite depends on external pip packages, always
upgrade these packages on the XMLRPC server even if they are already
installed. Similar to the client argument 'always-upgrade-server-packages'
but forces the upgrade for each test (regardless of the client settings).
--debug Enables debug logging and will not delete the temporary directory
after a robot run
```
Expand Down Expand Up @@ -197,7 +204,7 @@ Library AppriseLibrary ##### Hello @pip:robotframework-apr
- Each entry in this directory will be checked against the PyPi packages that are installed on the server's Python environment.
- If the package is detected as 'installed', the ```Server``` process will not reinstall the package.
- A version check between installed package version on the ```Server``` and expected package version from the ```Client's``` test suite will __NOT__ be performed
- If you depend on always using the correct PyPi package version (regardless of whether the PyPi package is installed on the server or not), then activate the ```Server's``` ```--always-upgrade-packages``` option. __Note that this option might cause unintended side effects in case you run more than one test in parallel and re-install PyPi dependencies which are in use by one of your running tasks.__
- If you depend on always using the correct PyPi package version (regardless of whether the PyPi package is installed on the server or not), then activate the ```Server's``` ```--always-upgrade-packages``` and/or the ```Client's``` ```--always-upgrade-server-packages``` option. __Note that any use of these options might cause unintended side effects in case you run more than one test in parallel and re-install PyPi dependencies while running tasks at the same time which are dependent on these packages.__
- If PyPi packages were detected to be installed, the ```Server``` temporarily unsets both ```SSL_CERT_FILE``` and ```REQUESTS_CA_BUNDLE``` environment variables as otherwise, the installation process would fail.
- The ```Server``` now installs the requested PyPi packages and restores both ```SSL_CERT_FILE``` and ```REQUESTS_CA_BUNDLE``` environment variables' values
- Finally, the Robot Framework Suite(s) are executed as usual
Expand Down

0 comments on commit 072cd22

Please sign in to comment.