add missing test for all existing custom types (#1)

* increase tests for ansible param type * use tempfile for vault * check vault data after managing it * implement tests for net param type * add github test workflow * parametrize tests as needed

Author: cmeissner

.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+- push
+
+jobs:
+ tests:
+
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v2
+ - name: Set up Python
+ uses: actions/setup-python@v2
+ with:
+ python-version: '3.x'
+ - name: Prepare test environment
+ run: |
+ python -m pip install --upgrade pip
+ make test-setup
+ - name: Run all tests
+ run:
+ make test-all

tests/conftest.py

@@ -1,7 +1,10 @@
 """Provide some base configurations for tests."""
+import os
 import pytest
 import py.path # pyright: reportMissingModuleSource=false
 
+from ansible.errors import AnsibleError
+from ansible_vault import Vault
 
 TEST_CASES_PATH = py.path.local(__file__).realpath() / '..' / 'test_cases'
 
@@ -56,3 +59,28 @@ def vcrmode(request):
 def cassette_name(test_name=None):
  """Generate cassette_name."""
  return 'tests/fixtures/{0}.yml'.format(test_name)
+
+
+def open_vault(vault: str = None, secret: str = None):
+ s = os.getenv(secret)
+ v = Vault(s)
+
+ try:
+ return dict(v.load(open(vault).read()))
+ except (AnsibleError, Exception) as e:
+ raise Exception(f"failed to open vault '{vault}': {str(e)}")
+
+
+def get_value_from_key(data: dict = None, keys: list = None):
+
+ if keys:
+
+ key = keys[0]
+
+ if isinstance(key, str) and len(keys) > 1:
+ if key in data:
+ return get_value_from_key(data[key], keys[1:])
+ else:
+ raise Exception(f"key '{key}' not in dictionary")
+ elif isinstance(key, str):
+ return data[key]

tests/test_cases/ansible_types.py

@@ -2,14 +2,16 @@
 import os
 import random
 import string
+import tempfile
 
+from tests.conftest import open_vault, get_value_from_key
 from click.testing import CliRunner
 from click_types.ansible import AnsibleVaultParamType as vault
 
 
 sec_env = 'TEST_VAULT_PASSPHRASE'
 key_path = 'key.subkey.subsubkey'
-vault_file = '/tmp/xyz.yml'
+vault_file = tempfile.NamedTemporaryFile().name
 os.environ[sec_env] = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits) for _ in range(10))
 
 runner = CliRunner()
@@ -21,14 +23,27 @@ def vault_wrapper():
 
 
 def test_create_value():
- response = runner.invoke(vault_wrapper, input='initial value')
+ value = 'initial value'
+ response = runner.invoke(vault_wrapper, input=value)
+
+ decrypted_data = open_vault(vault_file, sec_env)
+
  assert response.exit_code == 0
+ assert get_value_from_key(decrypted_data, key_path.split('.')) == value
 
 
 def test_update_value():
- response = runner.invoke(vault_wrapper, input='updated value')
+ value = 'updated value'
+ response = runner.invoke(vault_wrapper, input=value)
+
+ decrypted_data = open_vault(vault_file, sec_env)
+
  assert response.exit_code == 0
+ assert get_value_from_key(decrypted_data, key_path.split('.')) == value
+
 
+def test_missing_env_var():
+ del os.environ[sec_env]
+ response = runner.invoke(vault_wrapper, input='dummy')
 
-if __name__ == "__main__":
- vault_wrapper()
+ assert response.exit_code != 0

tests/test_cases/coding_types.py

@@ -1,4 +1,5 @@
 import click
+import pytest
 
 from click.testing import CliRunner
 from click_types.coding import SemVerParamType
@@ -13,27 +14,15 @@ def semver_wrapper(version):
  pass
 
 
-def test_success():
+@pytest.mark.parametrize('param', ['1.2.3', '1.2.3-alpha', '1.2.3-beta+build1337'])
+def test_success(param):
 
- positive_semvers = [
- '1.2.3',
- '1.2.3-alpha',
- '1.2.3-beta+build1337'
- ]
- for s in positive_semvers:
- print(s)
- response = runner.invoke(semver_wrapper, ['--version', s])
- assert response.exit_code == 0
+ response = runner.invoke(semver_wrapper, ['--version', param])
+ assert response.exit_code == 0
 
 
-def test_failure():
+@pytest.mark.parametrize('param', ['1.2', '1.2.3+build1337', '1.2.3-alpha-build4711'])
+def test_failure(param):
 
- negative_semvers = [
- '1.2',
- '1.2.3+build1337',
- '1.2.3-alpha-build4711'
- ]
-
- for s in negative_semvers:
- response = runner.invoke(semver, ['--version', s])
- assert response.exit_code == 1
+ response = runner.invoke(semver, ['--version', param])
+ assert response.exit_code != 0

tests/test_cases/net_types.py

@@ -0,0 +1,53 @@
+import click
+import pytest
+
+from click.testing import CliRunner
+from click_types.net import CIDRParamType, VlanIDParamType
+
+cidr = CIDRParamType()
+vlan = VlanIDParamType()
+runner = CliRunner()
+
+
+@click.command()
+@click.option('--cidr', type=cidr)
+def cidr_wrapper(cidr):
+ pass
+
+
+@click.command()
+@click.option('--vlan', type=vlan)
+def vlan_wrapper(vlan):
+ pass
+
+
+@pytest.mark.parametrize('param', ['192.0.2.0/24', '2001:db8::/32'])
+def test_cidr_success(param):
+
+ response = runner.invoke(cidr_wrapper, ['--cidr', param])
+ print(response.output)
+ assert response.exit_code == 0
+
+
+@pytest.mark.parametrize('param', ['192.0.2.0', 'fe80::250/56'])
+def test_cidr_failure(param):
+
+ response = runner.invoke(cidr_wrapper, ['--cidr', param])
+ print(response.output)
+ assert response.exit_code != 0
+
+
+@pytest.mark.parametrize('param', ['1', '1234', '4094'])
+def test_vlan_success(param):
+
+ response = runner.invoke(vlan_wrapper, ['--vlan', param])
+ print(response.stdout)
+ assert response.exit_code == 0
+
+
+@pytest.mark.parametrize('param', ['0', '4095', -1, 0.1, 'ABCD'])
+def test_vlan_failure(param):
+
+ response = runner.invoke(vlan_wrapper, ['--vlan', param])
+ print(response.output)
+ assert response.exit_code != 0