starlingx/update
Code Issues Proposed changes

Convert software CLI commands to argparse

Browse Source 
- converted CLI to use argparse
- added stubbed CLI commands for:
 - software
   - deploy
     - activate
     - complete
     - host
     - list
     - query
     - start
   - release
     - delete
     - list
     - show
     - upload
     - upload-dir
- added in the gir dependency used by ostree commands to
unblock enabling the CLI command functions.

Test Plan:
  PASS: tox
  PASS: software commands passing (-h)

Story: 2010676
Task: 47945
Signed-off-by: Al Bailey <al.bailey@windriver.com>
Change-Id: I28023b690dea312e78eb4e4b4ef1c9be9c2af69e
This commit is contained in:
Al Bailey 2023-05-02 16:46:59 +00:00
parent 3c395fa898
commit 5015668dd7
4 changed files with 366 additions and 456 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
software/debian/deb_folder/control
View File

@ -16,7 +16,9 @@ Rules-Requires-Root: no
Package: software
Architecture: all
Depends: ${python3:Depends}, ${misc:Depends}
Depends: ${python3:Depends},
${misc:Depends},
gir1.2-ostree-1.0
Description: StarlingX unified software deployment and management
StarlingX unified software deployment and management.

780
software/software/software_client.py
View File

File diff suppressed because it is too large Load Diff

36
software/software/tests/test_software_client.py
View File

@ -128,28 +128,40 @@ class SoftwareClientNonRootMixin(object):
class SoftwareClientHelpTestCase(SoftwareClientTestCase, SoftwareClientNonRootMixin):
"""Test the sw-patch CLI calls that invoke 'help'
'check_for_os_region_name' is mocked to help determine
which code path is used since many code paths can short
circuit and invoke 'help' in failure cases.
'check_for_os_region_name' is the first method called
after args are parsed
print_help is invoked when there is a failure.
"""
@mock.patch('software.software_client.check_for_os_region_name')
def test_main_no_args_calls_help(self, mock_check):
"""When no arguments are called, this should invoke print_help"""
@mock.patch('argparse.ArgumentParser.print_help')
@mock.patch('argparse.ArgumentParser.print_usage')
def test_main_no_args(self, mock_usage, mock_help, mock_check):
"""When no arguments are called, it should call print_usage"""
shell_args = [self.PROG, ]
self._test_method(shell_args=shell_args)
mock_usage.assert_called()
mock_help.assert_not_called()
mock_check.assert_not_called()
@mock.patch('software.software_client.check_for_os_region_name')
def test_main_help(self, mock_check):
"""When no arguments are called, this should invoke print_help"""
shell_args = [self.PROG, "--help"]
@mock.patch('argparse.ArgumentParser.print_help')
@mock.patch('argparse.ArgumentParser.print_usage')
def test_main_help(self, mock_usage, mock_help, mock_check):
"""When -h is passed in, this should invoke print_help"""
shell_args = [self.PROG, "-h"]
self._test_method(shell_args=shell_args)
mock_check.assert_called()
mock_usage.assert_not_called()
mock_help.assert_called()
mock_check.assert_not_called()
@mock.patch('software.software_client.check_for_os_region_name')
def test_main_invalid_action_calls_help(self, mock_check):
"""invalid args should invoke print_help"""
@mock.patch('argparse.ArgumentParser.print_help')
@mock.patch('argparse.ArgumentParser.print_usage')
def test_main_invalid_action_calls_help(self, mock_usage, mock_help, mock_check):
"""invalid args should invoke print_usage"""
shell_args = [self.PROG, "invalid_arg"]
self._test_method(shell_args=shell_args)
mock_check.assert_called()
mock_usage.assert_called()
mock_help.assert_not_called()
mock_check.assert_not_called()

2
software/tox.ini
View File

@ -5,7 +5,7 @@
#
[tox]
envlist = pep8,py39,pylint,bandit,cover
envlist = pep8,py39,pylint
minversion = 2.3.2
skipsdist = True
stxdir = {toxinidir}/../..