Refactor: Pytest refactoring and fixes for system test cases

[KonikaChaurasiya-GSLab]

Change Summary

Pytest refactoring

Related Issue(s)

Fixes #N/A

Component(s) name

Pytest

Proposed changes

Define a clear structure to separate:

• Unit test with no CV interaction to test component: tests/unit
• System test to run module backend component and which requires CV connection: tests/system
• lib to provides a safe place for fixtures, parametrizes, mook data: tests/lib

How to test

# Go to test folder
$ cd tests/

# Run Pytest
$ pytest --html=report.html --self-contained-html --cov=. --cov-report=html --capture=tee-sys --color yes system

Checklist

User Checklist

• N/A

Repository Checklist

• My code has been rebased from devel before I start
• I have read the CONTRIBUTING document.
• My change requires a change to the documentation and documentation have been updated accordingly. (check the box if not applicable)
• I have updated molecule CI testing accordingly. (check the box if not applicable)

[guillaumeVilar]

Thanks a lot for the PR! Please find below my comments.

1. The Makefile config.py rule did not get updated (still create the config.py for the on-prem CVP).
   We should update it to move away from on-prem IMHO - i.e. remove username, password and just have 2 fields:
   server and token.

2. The git pre-commit validation failed because an extra line has been added at the end of the file tests/system/test_cv_device_tools_fqdn.py

3. system/test_cv_container_tools.py > OK

4. system/test_cv_device_tools_fqdn.py > OK

5. system/test_cv_device_tools_generic.py > OK

6. system/test_cv_device_tools_serial.py > OK

7. system/test_cv_device_tools.py > OK but 2 skip.
   As mentionned, we can move one of the device to the undefinied container before running those tests by removing them from the inventory (CVaaS now automatically add the devices to the provisioning page).
   Sample example:

>>> from lib import config
>>> from cvprac.cvp_client import CvpClient
>>> cvp_client.connect(
...     nodes=[config.server],
...     username=config.username,
...     password=config.password,
...     is_cvaas=True,
...     api_token=config.user_token
... )
>>> cvp_client.api.delete_device('50:00:00:cb:38:c2')
{'result': 'success'}

8. As a future improvement (maybe in a future PR), we could also add tests for device search by:

• hostname
• serial number
  This is not yet covered by the test suite as of now.

[KonikaChaurasiya-GSLab]

@guillaumeVilar : Thanks for the code review. I have updated the PR as per your suggestions.
For Comment No. 8 As a future improvement : We already have the tests cases for device search_by hostname and serial number. I have set the self.inventory.search_by = FIELD_HOSTNAME and self.inventory.search_by = FIELD_SERIAL in the respective tests.

[titom73]

See comments

[guillaumeVilar]

Hi, thanks for the PR. System tests now all passed, awesome!

A small detail, the Makefile was not updated with the changes:

AUTH_CONFIG_FILE = lib/config.py

define AUTH_CONFIG
#!/usr/bin/python
# coding: utf-8 -*-

username = "< username >"
password = "< password >"
server = "< cloudvision ip >"
endef
export AUTH_CONFIG

Moreover, I tried the other rules and are not triggering the system tests:

• make ci > only run the unit tests
• make test > same
• make test-api > Give error:

===================================================================================================== no tests ran in 0.88s ======================================================================================================
ERROR: Wrong expression passed to '-m': generic,api: at column 8: unexpected character ","

make: *** [Makefile:32: test-api] Error 4

[guillaumeVilar]

LGTM

[titom73]

LGTM! Awesome work!