Module environment

source code

Rules for checking ROS environment state.

Functions

[str]

paths(path)
Returns: paths contained in path variable.

source code

bool

is_executable(path)
Returns: True if path has executable permissions

source code

str

invalid_url(url)
Returns: error message if url is not a valid url.

source code

ros_root_check(ctx, ros_root=None)

source code

ros_home_check(ctx)

source code

ros_log_dir_check(ctx)

source code

ros_test_results_dir_check(ctx)

source code

pythonpath_check(ctx)

source code

rosconsole_config_file_check(ctx)

source code

path_check(ctx)

source code

ros_master_uri_hostname(ctx)

source code

wtf_check_environment(ctx)

source code

Variables
	environment_warnings = `[(<__builtin__.function object>, 'PATH ...`
	environment_errors = `[(<__builtin__.function object>, 'ROS_ROO...`
	__package__ = `'roswtf'`

Function Details

paths(path)

source code

Returns: [str]: paths contained in path variable. path must conform to OS conventions for path separation (i.e. colon-separated on Unix)

is_executable(path)

source code

Returns: bool: True if path has executable permissions

invalid_url(url)

source code

Returns: str: error message if url is not a valid url. url is allowed to be empty as that check is considered separately.

ros_root_check(ctx, ros_root=None)

source code

Parameters:

ros_root (str) - override ctx, useful for when ctx is not created yet

Variables Details

environment_warnings

Value:

[(<__builtin__.function object>,
  'PATH has /usr/bin set before ROS_ROOT/bin, which can cause problems
 as there is system install of ROS on this machine. You may wish to pu
t ROS_ROOT/bin first'),
 (<__builtin__.function object>,
  'ROS_PACKAGE_PATH is not set. This is not required, but is unusual')
,
 (<__builtin__.function object>, 'ROS_PACKAGE_PATH is empty. This is n
...

environment_errors

Value:

[(<__builtin__.function object>,
  'ROS_ROOT [%(ros_root)s] does not point to a directory'),
 (<__builtin__.function object>, 'ROS_ROOT is invalid: '),
 (<__builtin__.function object>,
  'Path(s) in ROS_PACKAGE_PATH [%(ros_package_path)s] points to a file
 instead of a directory: '),
 (<__builtin__.function object>,
  'Not all paths in ROS_PACKAGE_PATH [%(ros_package_path)s] point to a
...