cleanup and notes

Signed-off-by: Justin Cinkelj <[email protected]>

Author: justinc1

.ansible-lint

@@ -9,3 +9,4 @@ exclude_paths:
   - examples/vm_os_upgrade/main.yml
   - .github/workflows
   - changelogs
+  - .tox

.gitignore

@@ -8,6 +8,7 @@ child-pipeline-gitlab-ci.yml
 # developer instance, including credentials
 tests/integration/integration_config.yml
 tests/integration/inventory
+collections
 
 docs/build
 docs/source/modules

DEVELOPMENT.md

@@ -147,6 +147,18 @@ sanity:  ## Run sanity tests
 units:  ## Run unit tests
 ```
 
+Tox based testing was added as we want to use linters from ansible-network/github_actions.
+Sample commands :
+
+```
+tox list
+tox -e ansible-sanity
+tox -m lint
+tox -e flake8-lint,pylint
+tox -e black,flake8  # will reformat code
+tox -e ansible2.18-py312-with_constraints
+```
+
 If you want to run tests with a single python version (e.g. not with whole test matrix), use:
 
 ```

plugins/inventory/hypercore.py

@@ -140,6 +140,7 @@
 import os
 
 import yaml
+
 from ansible.plugins.inventory import BaseInventoryPlugin
 from ansible.plugins.inventory import Cacheable
 from ansible.plugins.inventory import Constructable

pyproject.toml

@@ -94,6 +94,7 @@ src_paths = [
 ]
 
 #sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "ANSIBLE_CORE", "ANSIBLE_AMAZON_AWS", "ANSIBLE_COMMUNITY_AWS", "LOCALFOLDER"]
+sections = ["FUTURE", "STDLIB", "THIRDPARTY", "FIRSTPARTY", "ANSIBLE_CORE", "LOCALFOLDER"]
 #known_third_party = ["botocore", "boto3"]
 known_ansible_core = ["ansible"]
 #known_ansible_amazon_aws = ["ansible_collections.amazon.aws"]

tests/unit/plugins/conftest.py

@@ -14,14 +14,15 @@
 from unittest.mock import MagicMock
 
 import pytest
-from ansible.module_utils import basic
-from ansible.module_utils._text import to_bytes
 from ansible_collections.scale_computing.hypercore.plugins.module_utils.client import Client
 from ansible_collections.scale_computing.hypercore.plugins.module_utils.hypercore_version import HyperCoreVersion
 from ansible_collections.scale_computing.hypercore.plugins.module_utils.rest_client import RestClient
 from ansible_collections.scale_computing.hypercore.plugins.module_utils.task_tag import TaskTag
 from ansible_collections.scale_computing.hypercore.plugins.module_utils.vm import VM
 
+from ansible.module_utils import basic
+from ansible.module_utils._text import to_bytes
+
 
 @pytest.fixture
 def client(mocker):

tests/unit/plugins/module_utils/test_client.py

@@ -13,14 +13,15 @@
 import sys
 
 import pytest
+from ansible_collections.scale_computing.hypercore.plugins.module_utils import client
+from ansible_collections.scale_computing.hypercore.plugins.module_utils import errors
+from ansible_collections.scale_computing.hypercore.plugins.module_utils.utils import MIN_PYTHON_VERSION
+
 from ansible.module_utils.common.text.converters import to_text
 from ansible.module_utils.six.moves.urllib.error import HTTPError
 from ansible.module_utils.six.moves.urllib.error import URLError
 from ansible.module_utils.six.moves.urllib.parse import parse_qs
 from ansible.module_utils.six.moves.urllib.parse import urlparse
-from ansible_collections.scale_computing.hypercore.plugins.module_utils import client
-from ansible_collections.scale_computing.hypercore.plugins.module_utils import errors
-from ansible_collections.scale_computing.hypercore.plugins.module_utils.utils import MIN_PYTHON_VERSION
 
 pytestmark = pytest.mark.skipif(
     sys.version_info < MIN_PYTHON_VERSION,