Run tests with PR (KC-244) (#487)

* Add test_imports.py smoke test of keeper imports

* Sort setup.py dependencies and add extras_require

* Fix setup.py setup formatting

* Add Github action workflow for testing with pytest

Author: kihneman

.github/workflows/test-with-pytest.yml

@@ -0,0 +1,30 @@
+name: Test with pytest
+
+on: pull_request
+
+env:
+  PYTHONUNBUFFERED: 1
+
+jobs:
+  test-with-pytest:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.6, 3.9]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v2
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install package with test dependencies
+        run: pip install .[test]
+
+      - name: Run import tests
+        run: pytest tests/test_imports.py

pytest.ini

@@ -4,5 +4,7 @@ norecursedirs = venv
 # unit-tests/test_login.py fails due to connection errors
 addopts = --disable-warnings -m "not cross_enterprise" --ignore unit-tests/test_command_utils.py --ignore unit-tests/test_login.py
 markers =
+    quicktest: at the moment an alias for the "keeper_imports" marker
+    keeper_imports: smoke test to make sure all packages and modules in keeper can be imported
     integration: tests using internal dev.keepersecurity.com test accounts stored in config.json
     cross_enterprise: created to test a specific issue with cross-enterprise and not normally run

setup.py

@@ -10,41 +10,50 @@
     long_description = f.read()
 
 install_requires = [
+    'asciitree',
     'colorama',
     'cryptography>=3.4.8',
-    'pycryptodomex>=3.7.2',
-    'libkeepass',
-    'requests',
-    'tabulate',
     'prompt_toolkit>=2.0.4,<=2.0.10',
-    'asciitree',
     'protobuf>=3.13.0',
+    'pycryptodomex>=3.7.2',
     'pyperclip'
+    'requests',
+    'tabulate',
 ]
+adpasswd_requires = ['ldap3']
+keepass_requires = ['libkeepass']
+test_requires = ['pytest', 'testfixtures']
 
-setup(name='keepercommander',
-      version=keepercommander.__version__,
-      description='Keeper Commander for Python 3',
-      long_description=long_description,
-      long_description_content_type="text/markdown",
-      author='Craig Lurey',
-      author_email='[email protected]',
-      url='https://github.com/Keeper-Security/Commander',
-      license='MIT',
-      classifiers=["Development Status :: 4 - Beta",
-                   "License :: OSI Approved :: MIT License",
-                   "Operating System :: OS Independent",
-                   "Programming Language :: Python :: 3.6",
-                   "Topic :: Security"],
-      keywords='security password',
+setup(
+    name='keepercommander',
+    version=keepercommander.__version__,
+    description='Keeper Commander for Python 3',
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    author='Craig Lurey',
+    author_email='[email protected]',
+    url='https://github.com/Keeper-Security/Commander',
+    license='MIT',
+    classifiers=["Development Status :: 4 - Beta",
+                 "License :: OSI Approved :: MIT License",
+                 "Operating System :: OS Independent",
+                 "Programming Language :: Python :: 3.6",
+                 "Topic :: Security"],
+    keywords='security password',
 
-      packages=find_packages(),
-      include_package_data=True,
-      python_requires='>=3.6',
-      entry_points={
-          "console_scripts": [
-              "keeper=keepercommander.__main__:main",
-          ],
-      },
-      install_requires=install_requires
-      )
+    packages=find_packages(),
+    include_package_data=True,
+    python_requires='>=3.6',
+    entry_points={
+        "console_scripts": [
+            "keeper=keepercommander.__main__:main",
+        ],
+    },
+    install_requires=install_requires,
+    extras_require={
+        'adpasswd': adpasswd_requires,
+        'keepass': keepass_requires,
+        'test': test_requires,
+        'all': adpasswd_requires + keepass_requires + test_requires
+    }
+)

tests/test_imports.py

@@ -0,0 +1,38 @@
+from pkgutil import walk_packages
+from setuptools import find_packages, find_packages
+
+import pytest
+
+import keepercommander
+
+
+SKIP_PKG_IMPORT = ['keepercommander.yubikey', ]
+SKIP_PLUGIN_IMPORT = ['azureadpwd', 'mssql', 'mysql', 'oracle', 'postgresql', 'ssh', 'unixpasswd']
+SKIP_PKG_IMPORT += [f'keepercommander.plugins.{p}' for p in SKIP_PLUGIN_IMPORT]
+
+
+def pkg_import_error(pkg):
+    if pkg not in SKIP_PKG_IMPORT:
+        print(f"ERROR: Couldn't import {pkg}")
+
+
+def get_modules():
+    return [
+        m.name for m in
+        walk_packages(keepercommander.__path__, keepercommander.__name__ + '.', onerror=pkg_import_error)
+        if m.name not in SKIP_PKG_IMPORT
+    ]
+
+
+@pytest.mark.quicktest
+@pytest.mark.keeper_imports
+@pytest.mark.parametrize('pkg_name', [p for p in find_packages() if p not in SKIP_PKG_IMPORT])
+def test_keeper_import_pkg(pkg_name):
+    __import__(pkg_name)
+
+
+@pytest.mark.quicktest
+@pytest.mark.keeper_imports
+@pytest.mark.parametrize('module_name', get_modules())
+def test_keeper_import_module(module_name):
+    __import__(module_name)