Add TTY check and argument to disable it (#50603)

[Soldann]

SUMMARY

Fixes #50603

Runs a TTY check before launching the editor and raises an error if false. One can add the --no-check flag to override this check and launch the editor anyways.

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

ansible-vault create

ADDITIONAL INFORMATION

Running the command

bash $(ansible-vault --vault-password-file=key create file.yaml) 

now returns the following output instead of creating an invisible editor window.

~/ansible$ bash $(ansible-vault create --vault-password-file=key file.yaml)
[WARNING]: You are running the development version of Ansible. You should only run Ansible from "devel" if you are
modifying the Ansible engine, or trying out features under development. This is a rapidly changing source of code and
can become unstable at any point.
ERROR! not a tty, editor cannot be opened
bash: usage:: No such file or directory

[ansibot]

The test ansible-test sanity --test pylint [explain] failed with 3 errors:

lib/ansible/cli/vault.py:79:39: bad-whitespace: Exactly one space required after comma         create_parser.add_argument('-n','--no-check',default=False, help='skip TTY check', dest='no_check', action='store_true')                                        ^
lib/ansible/cli/vault.py:79:52: bad-whitespace: Exactly one space required after comma         create_parser.add_argument('-n','--no-check',default=False, help='skip TTY check', dest='no_check', action='store_true')                                                     ^
lib/ansible/cli/vault.py:462:0: trailing-newlines: Trailing newlines

The test ansible-test sanity --test pep8 [explain] failed with 4 errors:

lib/ansible/cli/vault.py:79:40: E231: missing whitespace after ','
lib/ansible/cli/vault.py:79:53: E231: missing whitespace after ','
lib/ansible/cli/vault.py:433:33: E128: continuation line under-indented for visual indent
lib/ansible/cli/vault.py:462:1: W391: blank line at end of file

click here for bot help

[sivel]

This PR should also contain a changelog fragment (see changelogs/fragments) as well as tests to verify this functionality.

[sivel]

This argument name should be more descriptive, such as --skip-tty-check. We also recommend dropping the shortopt of -n as that is overloaded and would lead to more confusion.

[Soldann]

Is AnsibleOptionsError the correct error type, or should it be changed?

[mattclay]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 1 pipeline(s).