diff options
| -rw-r--r-- | docs/testing/user/configguide/configguide.rst | 64 | ||||
| -rwxr-xr-x | functest/ci/prepare_env.py | 44 | ||||
| -rw-r--r-- | functest/cli/cli_base.py | 6 | ||||
| -rw-r--r-- | functest/cli/commands/cli_os.py | 28 | ||||
| -rw-r--r-- | functest/tests/unit/ci/test_prepare_env.py | 15 | ||||
| -rw-r--r-- | functest/tests/unit/cli/commands/test_cli_os.py | 74 | ||||
| -rw-r--r-- | functest/tests/unit/cli/test_cli_base.py | 7 |
7 files changed, 34 insertions, 204 deletions
diff --git a/docs/testing/user/configguide/configguide.rst b/docs/testing/user/configguide/configguide.rst index 12dfd1059..61fc45933 100644 --- a/docs/testing/user/configguide/configguide.rst +++ b/docs/testing/user/configguide/configguide.rst @@ -41,51 +41,24 @@ scope and responsibility of the OPNFV project. Accessing the Openstack credentials ----------------------------------- -OpenStack credentials are mandatory and can be retrieved in different -ways. From inside the running Functest docker container the -"functest env prepare" command will automatically look for the -Openstack credentials file "/home/opnfv/functest/conf/openstack.creds" -and retrieve it unless the file already exists. This Functest -environment preparation step is described later in this document. - -WARNING: When the installer type is "joid" you have to have the -credentials file inside the running container **before** initiating the -functest environment preparation. For that reason you have to choose -either one of the options below, since the automated copying does not -work for "joid". - -You can also specifically pass in the needed file prior to running the -environment preparation either: - - * by using the -v option when creating the Docker container. This is - referred to in docker documentation as "Bind Mounting". See the - usage of this parameter in the following chapter. - * or creating a local file '/home/opnfv/functest/conf/openstack.creds' - inside the running container with the credentials in it. Consult +OpenStack credentials are mandatory and must be provided to Functest. +When running the command "functest env prepare", the framework will +automatically look for the Openstack credentials file +"/home/opnfv/functest/conf/openstack.creds" and will exit with +error if it is not present or it is empty. + +There are 2 ways to provide that file: + + * by using a Docker volume with -v option when creating the Docker container. + This is referred to in docker documentation as "Bind Mounting". + See the usage of this parameter in the following chapter. + * or creating manually the file '/home/opnfv/functest/conf/openstack.creds' + inside the running container and pasting the credentials in it. Consult your installer guide for further details. This is however not instructed in this document. -NOTE: When the installer type is "fuel" and virtualized deployment -is used, there you have to explicitly fetch the credentials file -executing the following sequence - - #. Create a container as described in next chapter but do not - "Bind Mount" the credentials - #. Log in to container and execute the following command. Replace - the IP with installer address after the "-a" parameter:: - - fetch_os_creds.sh \ - -d /home/opnfv/functest/conf/openstack.creds \ - -i fuel \ - -a 10.20.0.2 \ - -v - ( -d specifies the full path to the Openstack credential file - -i specifies the INSTALLER_TYPE - -a specifies the INSTALLER_IP - -v indicates a virtualized environment and takes no arguments ) - - #. Continue with your testing, initiate functest environment - preparation, run tests etc. +There is a default environment variable in the Functest container **$creds** +that points to the credentials absolute path to help the user with this task. In proxified environment you may need to change the credentials file. There are some tips in chapter: `Proxy support`_ @@ -108,9 +81,10 @@ recommended parameters for invoking docker container -e "INSTALLER_IP=<Specific IP Address>" - This IP is needed to fetch RC file from deployment, fetch logs, ... - If not provided, there is no way to fetch the RC file. It must be - provided manually as a volume + These two env variables are useful extract some information + from the deployment. However, for some test cases like + SFC or Barometer they are mandatory since the tests + need to access the installer node and the deployment. #. Credentials for accessing the Openstack. Most convenient way of passing them to container is by having a diff --git a/functest/ci/prepare_env.py b/functest/ci/prepare_env.py index e03bc6547..9e53e30bd 100755 --- a/functest/ci/prepare_env.py +++ b/functest/ci/prepare_env.py @@ -83,11 +83,9 @@ def check_env_variables(): % CONST.__getattribute__('INSTALLER_TYPE')) if CONST.__getattribute__('INSTALLER_IP') is None: - logger.warning("The env variable 'INSTALLER_IP' is not defined. " - "It is needed to fetch the OpenStack credentials. " - "If the credentials are not provided to the " - "container as a volume, please add this env variable " - "to the 'docker run' command.") + logger.warning( + "The env variable 'INSTALLER_IP' is not defined. It is recommended" + " to extract some information from the deployment") else: logger.info(" INSTALLER_IP=%s" % CONST.__getattribute__('INSTALLER_IP')) @@ -177,7 +175,6 @@ def create_directories(): def source_rc_file(): print_separator() - logger.info("Fetching RC file...") if CONST.__getattribute__('openstack_creds') is None: logger.warning("The environment variable 'creds' must be set and" @@ -187,38 +184,17 @@ def source_rc_file(): CONST.__getattribute__('dir_functest_conf'), 'openstack.creds') if not os.path.isfile(CONST.__getattribute__('openstack_creds')): - logger.info("RC file not provided. " - "Fetching it from the installer...") - if CONST.__getattribute__('INSTALLER_IP')is None: - logger.error("The env variable 'INSTALLER_IP' must be provided in" - " order to fetch the credentials from the installer.") - raise Exception("Missing CI_INSTALLER_IP.") - if (CONST.__getattribute__('INSTALLER_TYPE') not in - opnfv_constants.INSTALLERS): - logger.error("Cannot fetch credentials. INSTALLER_TYPE=%s is " - "not a valid OPNFV installer. Available " - "installers are : %s." % - (CONST.__getattribute__('INSTALLER_TYPE'), - opnfv_constants.INSTALLERS)) - raise Exception("Wrong INSTALLER_TYPE.") - - cmd = ("/home/opnfv/repos/releng/utils/fetch_os_creds.sh " - "-d %s -i %s -a %s" - % (CONST.__getattribute__('openstack_creds'), - CONST.__getattribute__('INSTALLER_TYPE'), - CONST.__getattribute__('INSTALLER_IP'))) - logger.debug("Executing command: %s" % cmd) - p = subprocess.Popen(cmd.split(), stdout=subprocess.PIPE) - output = p.communicate()[0] - logger.debug("\n%s" % output) - if p.returncode != 0: - raise Exception("Failed to fetch credentials from installer.") + raise Exception( + "OpenStack credentials file not provided. " + "The OpenStack credentials must be in {}" + .format(CONST.__getattribute__('openstack_creds'))) else: logger.info("RC file provided in %s." % CONST.__getattribute__('openstack_creds')) if os.path.getsize(CONST.__getattribute__('openstack_creds')) == 0: - raise Exception("The file %s is empty." % - CONST.__getattribute__('openstack_creds')) + raise Exception( + "The OpenStack RC file {} is empty." + .format(CONST.__getattribute__('openstack_creds'))) logger.info("Sourcing the OpenStack RC file...") os_utils.source_credentials(CONST.__getattribute__('openstack_creds')) diff --git a/functest/cli/cli_base.py b/functest/cli/cli_base.py index 2104e125c..2f085834c 100644 --- a/functest/cli/cli_base.py +++ b/functest/cli/cli_base.py @@ -86,12 +86,6 @@ def os_show_credentials(): _openstack.show_credentials() -@openstack.command('fetch-rc', help="Fetch the OpenStack RC file from " - "the installer.") -def os_fetch_rc(): - _openstack.fetch_credentials() - - @env.command('prepare', help="Prepares the Functest environment. This step is " "needed run the tests.") def env_prepare(): diff --git a/functest/cli/commands/cli_os.py b/functest/cli/commands/cli_os.py index 5e6e1109a..c66362fce 100644 --- a/functest/cli/commands/cli_os.py +++ b/functest/cli/commands/cli_os.py @@ -47,34 +47,6 @@ class CliOpenStack(object): if key.startswith('OS_'): click.echo("{}={}".format(key, value)) - def fetch_credentials(self): - if os.path.isfile(self.openstack_creds): - answer = raw_input("It seems the RC file is already present. " - "Do you want to overwrite it? [y|n]\n") - while True: - if answer.lower() in ["y", "yes"]: - break - elif answer.lower() in ["n", "no"]: - return - else: - answer = raw_input("Invalid answer. Please type [y|n]\n") - - installer_type = CONST.__getattribute__('INSTALLER_TYPE') - if installer_type is None: - click.echo("The environment variable 'INSTALLER_TYPE' is not" - "defined. Please export it") - installer_ip = CONST.__getattribute__('INSTALLER_IP') - if installer_ip is None: - click.echo("The environment variable 'INSTALLER_IP' is not" - "defined. Please export it") - cmd = ("fetch_os_creds.sh -d %s -i %s -a %s" - % (self.openstack_creds, - installer_type, - installer_ip)) - click.echo("Fetching credentials from installer node '%s' with IP=%s.." - % (installer_type, installer_ip)) - ft_utils.execute_command(cmd, verbose=False) - def check(self): self.ping_endpoint() cmd = os.path.join(CONST.__getattribute__('dir_repo_functest'), diff --git a/functest/tests/unit/ci/test_prepare_env.py b/functest/tests/unit/ci/test_prepare_env.py index 85d1918d8..f3e15a013 100644 --- a/functest/tests/unit/ci/test_prepare_env.py +++ b/functest/tests/unit/ci/test_prepare_env.py @@ -47,14 +47,9 @@ class PrepareEnvTesting(unittest.TestCase): prepare_env.check_env_variables() mock_logger_info.assert_any_call("Checking environment variables" "...") - mock_logger_warn.assert_any_call("The env variable 'INSTALLER_IP'" - " is not defined. It is needed to" - " fetch the OpenStack credentials." - " If the credentials are not" - " provided to the container as a" - " volume, please add this env" - " variable to the 'docker run'" - " command.") + mock_logger_warn.assert_any_call( + "The env variable 'INSTALLER_IP' is not defined. It is recommended" + " to extract some information from the deployment") @mock.patch('functest.ci.prepare_env.logger.info') @mock.patch('functest.ci.prepare_env.logger.warning') @@ -272,8 +267,8 @@ class PrepareEnvTesting(unittest.TestCase): mock.patch('functest.ci.prepare_env.subprocess.Popen') \ as mock_subproc_popen, \ self.assertRaises(Exception): - CONST.__setattr__('openstack_creds', 'test_creds') - CONST.__setattr__('INSTALLER_IP', None) + CONST.__setattr__('openstack_creds', None) + CONST.__setattr__('INSTALLER_IP', 'test_ip') CONST.__setattr__('INSTALLER_TYPE', 'test_type') opnfv_constants.INSTALLERS = ['test_type'] diff --git a/functest/tests/unit/cli/commands/test_cli_os.py b/functest/tests/unit/cli/commands/test_cli_os.py index b551ee4d2..c3285ecbe 100644 --- a/functest/tests/unit/cli/commands/test_cli_os.py +++ b/functest/tests/unit/cli/commands/test_cli_os.py @@ -62,80 +62,6 @@ class CliOpenStackTesting(unittest.TestCase): mock_exit.assert_called_once_with(0) @mock.patch('functest.cli.commands.cli_os.ft_utils.execute_command') - @mock.patch('functest.cli.commands.cli_os.os.path.isfile', - return_value=False) - @mock.patch('functest.cli.commands.cli_os.click.echo') - def test_fetch_credentials_default(self, mock_click_echo, - mock_os_path, - mock_ftutils_execute): - CONST.__setattr__('INSTALLER_TYPE', self.installer_type) - CONST.__setattr__('INSTALLER_IP', self.installer_ip) - cmd = ("fetch_os_creds.sh -d %s -i %s -a %s" - % (self.openstack_creds, - self.installer_type, - self.installer_ip)) - self.cli_os.openstack_creds = self.openstack_creds - self.cli_os.fetch_credentials() - mock_click_echo.assert_called_once_with("Fetching credentials from " - "installer node '%s' with " - "IP=%s.." % - (self.installer_type, - self.installer_ip)) - mock_ftutils_execute.assert_called_once_with(cmd, verbose=False) - - @mock.patch('functest.cli.commands.cli_os.ft_utils.execute_command') - @mock.patch('functest.cli.commands.cli_os.os.path.isfile', - return_value=False) - @mock.patch('functest.cli.commands.cli_os.click.echo') - def test_fetch_credentials_missing_installer_type(self, mock_click_echo, - mock_os_path, - mock_ftutils_execute): - CONST.__setattr__('INSTALLER_TYPE', None) - CONST.__setattr__('INSTALLER_IP', self.installer_ip) - cmd = ("fetch_os_creds.sh -d %s -i %s -a %s" - % (self.openstack_creds, - None, - self.installer_ip)) - self.cli_os.openstack_creds = self.openstack_creds - self.cli_os.fetch_credentials() - mock_click_echo.assert_any_call("The environment variable " - "'INSTALLER_TYPE' is not" - "defined. Please export it") - mock_click_echo.assert_any_call("Fetching credentials from " - "installer node '%s' with " - "IP=%s.." % - (None, - self.installer_ip)) - mock_ftutils_execute.assert_called_once_with(cmd, verbose=False) - - @mock.patch('functest.cli.commands.cli_os.ft_utils.execute_command') - @mock.patch('functest.cli.commands.cli_os.os.path.isfile', - return_value=False) - @mock.patch('functest.cli.commands.cli_os.click.echo') - def test_fetch_credentials_missing_installer_ip(self, mock_click_echo, - mock_os_path, - mock_ftutils_execute): - installer_type = self.installer_type - installer_ip = None - CONST.__setattr__('INSTALLER_TYPE', installer_type) - CONST.__setattr__('INSTALLER_IP', installer_ip) - cmd = ("fetch_os_creds.sh -d %s -i %s -a %s" - % (self.openstack_creds, - installer_type, - installer_ip)) - self.cli_os.openstack_creds = self.openstack_creds - self.cli_os.fetch_credentials() - mock_click_echo.assert_any_call("The environment variable " - "'INSTALLER_IP' is not" - "defined. Please export it") - mock_click_echo.assert_any_call("Fetching credentials from " - "installer node '%s' with " - "IP=%s.." % - (installer_type, - installer_ip)) - mock_ftutils_execute.assert_called_once_with(cmd, verbose=False) - - @mock.patch('functest.cli.commands.cli_os.ft_utils.execute_command') def test_check(self, mock_ftutils_execute): with mock.patch.object(self.cli_os, 'ping_endpoint'): CONST.__setattr__('dir_repo_functest', self.dir_repo_functest) diff --git a/functest/tests/unit/cli/test_cli_base.py b/functest/tests/unit/cli/test_cli_base.py index 896032795..61bd093e6 100644 --- a/functest/tests/unit/cli/test_cli_base.py +++ b/functest/tests/unit/cli/test_cli_base.py @@ -62,13 +62,6 @@ class CliBaseTesting(unittest.TestCase): self.assertEqual(result.exit_code, 0) self.assertTrue(mock_method.called) - def test_os_fetch_rc(self): - with mock.patch.object(self._openstack, 'fetch_credentials') \ - as mock_method: - result = self.runner.invoke(cli_base.os_fetch_rc) - self.assertEqual(result.exit_code, 0) - self.assertTrue(mock_method.called) - def test_env_prepare(self): with mock.patch.object(self._env, 'prepare') as mock_method: result = self.runner.invoke(cli_base.env_prepare) |