Merge pull request #738 from adobe-apiplatform/feature/info

Platform and environment info

Author: adorton-adobe

.build/pre_build.py

@@ -20,6 +20,9 @@
 
 import os
 import shutil
+import json
+import pkg_resources
+from pathlib import Path
 from backports import configparser
 
 
@@ -61,7 +64,14 @@ def bundle_feature_flag_config():
         flag_cfg.write(flag_cfg_file)
 
 
+def pkg_meta():
+    pkg_meta_path = Path('user_sync', 'resources', 'pkg_meta.json')
+    with open(pkg_meta_path, 'w') as f:
+        json.dump({p.project_name: p.version for p in pkg_resources.working_set}, f)
+
+
 if __name__ == '__main__':
     cd()
     bundle_example_config('config files - basic')
     bundle_example_config('sign')
+    pkg_meta()

.changelog/latest.md

@@ -1,3 +1,7 @@
+# Features
+
+* #738 Platform and environment info
+
 # Fixes
 
 * df8b33d Prevent dynamic attribute error

user-sync.spec

@@ -6,6 +6,7 @@ a = Analysis(['user_sync/app.py'],
              binaries=[],
              datas=[
                     ('user_sync/resources/*.cfg', 'resources'),
+                    ('user_sync/resources/*.json', 'resources'),
                     ('user_sync/resources/manual_url', 'resources'),
                     ('user_sync/resources/README.md', 'resources'),
                     ('user_sync/resources/examples/*', 'resources/examples'),

user_sync/app.py

@@ -21,6 +21,7 @@
 import os
 import platform
 import sys
+import json
 from datetime import datetime
 from pathlib import Path
 
@@ -40,7 +41,7 @@
 import user_sync.engine.umapi
 import user_sync.helper
 import user_sync.lockfile
-import user_sync.resource
+from user_sync import resource
 from user_sync.config.user_sync import UMAPIConfigLoader
 from user_sync.config.sign_sync import SignConfigLoader
 from user_sync.config import user_sync as config
@@ -100,6 +101,26 @@ def main():
     pass
 
 
+@main.command()
+@click.help_option('-h', '--help')
+def info():
+    """Get a dump of environmental information"""
+    click.echo(f"Python: {platform.python_version()}")
+    plat = platform.platform()
+    click.echo(f"Platform: {plat}")
+    if 'linux' in plat.lower():
+        click.echo("OS Release Info:")
+        with open('/etc/os-release') as f:
+            for l in f:
+                click.echo(f"  {l.strip()}")
+    click.echo("Packages:")
+    pkg_meta_file = resource.get_resource('pkg_meta.json')
+    with open(pkg_meta_file) as f:
+        pkg_meta = json.load(f) 
+        for p in sorted(pkg_meta):
+            click.echo(f"  {p}: {pkg_meta[p]}")
+
+
 @main.command()
 @click.help_option('-h', '--help')
 @click.option('--config-file-encoding', 'encoding_name',
@@ -493,7 +514,7 @@ def shell_scripts(platform):
     """Generate invocation shell scripts for the given platform."""
     if platform is None:
         platform = 'win' if 'win' in sys.platform.lower() else 'linux'
-    shell_scripts = user_sync.resource.get_resource_dir('shell_scripts/{}'.format(platform))
+    shell_scripts = resource.get_resource_dir('shell_scripts/{}'.format(platform))
     for script in shell_scripts:
         with open(script, 'r') as fh:
             content = fh.read()
@@ -509,7 +530,7 @@ def shell_scripts(platform):
 @click.help_option('-h', '--help')
 def docs():
     """Open user manual in browser"""
-    res_file = user_sync.resource.get_resource('manual_url')
+    res_file = resource.get_resource('manual_url')
     assert res_file is not None, "User Manual URL file not found"
     with click.open_file(res_file) as f:
         url = f.read().strip()
@@ -535,7 +556,7 @@ def example_config(**kwargs):
     for k, fname in kwargs.items():
         target = Path.cwd() / fname
         assert k in res_files, "Invalid option specified"
-        res_file = user_sync.resource.get_resource(res_files[k])
+        res_file = resource.get_resource(res_files[k])
         assert res_file is not None, "Resource file '{}' not found".format(res_files[k])
         if target.exists() and not click.confirm('\nWarning - file already exists: \n{}\nOverwrite?'.format(target)):
             continue
@@ -565,7 +586,7 @@ def example_config_sign(**kwargs):
     for k, fname in kwargs.items():
         target = Path.cwd() / fname
         assert k in res_files, "Invalid option specified"
-        res_file = user_sync.resource.get_resource(res_files[k])
+        res_file = resource.get_resource(res_files[k])
         assert res_file is not None, "Resource file '{}' not found".format(res_files[k])
         if target.exists() and not click.confirm('\nWarning - file already exists: \n{}\nOverwrite?'.format(target)):
             continue