Merge pull request #482 from adorton-adobe/feature/click

Feature - CLI Refactor

Author: adorton-adobe

.build/pre_build.py

@@ -1,2 +1,23 @@
+import os
+import shutil
+
+
+def cd():
+    os.chdir(os.path.realpath(os.path.join(os.path.dirname(__file__), '..')))
+
+
+def bundle_example_config():
+    examples_dir = os.path.join('examples', 'config files - basic')
+    files = [os.path.join(examples_dir, f) for f in os.listdir(examples_dir) if
+             os.path.isfile(os.path.join(examples_dir, f))]
+    bundle_dir = os.path.join('user_sync', 'resources', 'examples')
+    if not os.path.exists(bundle_dir):
+        os.mkdir(bundle_dir)
+    for f in files:
+        dest = os.path.join(bundle_dir, os.path.split(f)[-1])
+        shutil.copy(f, dest)
+
+
 if __name__ == '__main__':
-    pass
+    cd()
+    bundle_example_config()

.gitignore

@@ -95,3 +95,8 @@ ENV/
 _site
 .sass-cache
 .jekyll-metadata
+
+user_sync/resources/*
+!user_sync/resources/__init__.py
+!user_sync/resources/README.md
+!user_sync/resources/manual_url

Makefile

@@ -18,6 +18,7 @@ endif
 pex:
 	python -m pip install --upgrade pip
 	python -m pip install --upgrade 'wheel<0.30.0' requests pex==1.5.3
+	python .build/pre_build.py
 	-$(RM) $(output_dir)
 	pex -v -o $(output_dir)/$(output_filename)$(output_file_extension) -m user_sync.app \
 		-f $(prebuilt_dir) \

setup.py

@@ -18,7 +18,7 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-from setuptools import setup
+from setuptools import setup, find_packages
 
 version_namespace = {}
 with open('user_sync/version.py') as f:
@@ -44,7 +44,7 @@
       maintainer='Daniel Brotsky',
       maintainer_email='[email protected]',
       license='MIT',
-      packages=['user_sync', 'user_sync.connector'],
+      packages=find_packages(),
       install_requires=[
           'keyring',
           'okta==0.0.3.1',
@@ -54,6 +54,8 @@
           'PyYAML',
           'six',
           'umapi-client>=2.12',
+          'click',
+          'click-default-group',
       ],
       extras_require={
           ':sys_platform=="linux" or sys_platform=="linux2"': [
@@ -73,4 +75,5 @@
               'user_sync = user_sync.app:main'
           ]
       },
+      package_data={'user_sync.resources': ['*', 'examples/*']},
       zip_safe=False)

tests/conftest.py

@@ -1,9 +1,27 @@
 import os
 import pytest
+from user_sync import config
 
 
 @pytest.fixture
 def fixture_dir():
     return os.path.abspath(
            os.path.join(
              os.path.dirname(__file__), 'fixture'))
+
+
+@pytest.fixture
+def cli_args():
+    def _cli_args(args_in):
+        """
+        :param dict args:
+        :return dict:
+        """
+
+        args_out = {}
+        for k in config.ConfigLoader.invocation_defaults:
+            args_out[k] = None
+        for k, v in args_in.items():
+            args_out[k] = v
+        return args_out
+    return _cli_args

tests/test_config.py

@@ -82,13 +82,13 @@ def test_load_root(root_config_file):
             'invocation_defaults' in config)
 
 
-def test_max_adobe_percentage(modify_root_config, caplog):
+def test_max_adobe_percentage(modify_root_config, cli_args):
     root_config_file = modify_root_config(['limits', 'max_adobe_only_users'], "50%")
     config = ConfigFileLoader.load_root_config(root_config_file)
     assert ('limits' in config and 'max_adobe_only_users' in config['limits'] and
             config['limits']['max_adobe_only_users'] == "50%")
 
-    args = app.process_args(['-c', root_config_file])
+    args = cli_args({'config_filename': root_config_file})
     options = ConfigLoader(args).get_rule_options()
     assert 'max_adobe_only_users' in options and options['max_adobe_only_users'] == '50%'
 
@@ -97,7 +97,7 @@ def test_max_adobe_percentage(modify_root_config, caplog):
         ConfigLoader(args).get_rule_options()
 
 
-def test_additional_groups_config(modify_root_config, caplog):
+def test_additional_groups_config(modify_root_config, cli_args):
     addl_groups = [
         {"source": r"ACL-(.+)", "target": r"ACL-Grp-(\1)"},
         {"source": r"(.+)-ACL", "target": r"ACL-Grp-(\1)"},
@@ -107,17 +107,17 @@ def test_additional_groups_config(modify_root_config, caplog):
     assert ('additional_groups' in config['directory_users'] and
             len(config['directory_users']['additional_groups']) == 2)
 
-    args = app.process_args(['-c', root_config_file])
+    args = cli_args({'config_filename': root_config_file})
     options = ConfigLoader(args).get_rule_options()
     assert addl_groups[0]['source'] in options['additional_groups'][0]['source'].pattern
     assert addl_groups[1]['source'] in options['additional_groups'][1]['source'].pattern
 
 
-def test_twostep_config(tmp_config_files, modify_ldap_config, caplog):
+def test_twostep_config(tmp_config_files, modify_ldap_config, cli_args):
     (root_config_file, ldap_config_file, _) = tmp_config_files
     modify_ldap_config(['two_steps_lookup'], {})
 
-    args = app.process_args(['-c', root_config_file])
+    args = cli_args({'config_filename': root_config_file})
 
     # test invalid "two_steps_lookup" config
     with pytest.raises(AssertionException):
@@ -138,9 +138,9 @@ def test_twostep_config(tmp_config_files, modify_ldap_config, caplog):
     assert options['two_steps_lookup']['group_member_attribute_name'] == 'member'
 
 
-def test_adobe_users_config(tmp_config_files, modify_root_config):
+def test_adobe_users_config(tmp_config_files, modify_root_config, cli_args):
     (root_config_file, _, _) = tmp_config_files
-    args = app.process_args(['-c', root_config_file])
+    args = cli_args({'config_filename': root_config_file})
 
     # test default
     config_loader = ConfigLoader(args)
@@ -157,7 +157,7 @@ def test_adobe_users_config(tmp_config_files, modify_root_config):
 
     # test command line param
     modify_root_config(['invocation_defaults', 'adobe_users'], "all")
-    args = app.process_args(['-c', root_config_file, '--adobe-users', 'mapped'])
+    args = cli_args({'config_filename': root_config_file, 'adobe_users': ['mapped']})
     config_loader = ConfigLoader(args)
     options = config_loader.load_invocation_options()
     assert 'adobe_users' in options