Bug 10752 - Add test to verify help option in oe scripts and ensure it's displayed when no required arguments are specified
Summary: Add test to verify help option in oe scripts and ensure it's displayed when n...
Status: RESOLVED INVALID
Alias: None
Product: Build Testing
Classification: QA/Testing
Component: general (show other bugs)
Version: 2.3.2
Hardware: All Multiple
: Medium enhancement
Target Milestone: 2.5
Assignee: Jair Gonzalez
QA Contact:
URL:
Whiteboard:
Depends on:
Blocks:
 
Reported: 2016-11-30 23:14 UTC by Jair Gonzalez
Modified: 2017-12-07 14:47 UTC (History)
4 users (show)

See Also:
OS type for building Yocto: ---
Type of Regression: ---
Verified:
Documentation change: Don't know


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jair Gonzalez 2016-11-30 23:14:03 UTC
The following oe* scripts exported to the path by oe-init-build-env do NOT provide any help option (either '-h' or '--help' or showing it after missing a required argument):
- oe-buildenv-internal
- oe-find-native-sysroot
- oe-git-proxy
- oe-gnome-terminal-phonehome
- oepydevshell-internal.py
- oe-setup-builddir
- oe-setup-rpmrepo
- oe-trim-schemas

The following scripts provide a help option and display help when executed without arguments:
- oe-check-sstate
- oe-pkgdata-util
- oe-publish-sdk
- oe-selftest
- oe-run-native (this displays an usage message when missing and argument)

On the following one all parameters are optional and help is displayed on demand:
- oe-build-perf-test


The behavior should be standard for all scripts we export to the path. According to this it's necessary to add tests to validate the following scenarios:
- The help option works and usage, description and options details are displayed for exported oe* scripts.
- Help is displayed if a script is executed without any required arguments.
Comment 1 Jair Gonzalez 2017-08-29 21:49:10 UTC
Moving to 2.5, due to limited resources.
Comment 2 Jair Gonzalez 2017-08-29 22:13:33 UTC
Returning version to 2.3.
Comment 3 Joshua Lock 2017-12-07 14:47:29 UTC
This is an ambiguous bug, we'll accept defects for specific issues but this bug is too encompassing. 

For example, several of the scripts in question are internal helper scripts which aren't as important to have tests for.