From: Andrew Grimberg <agrimberg@linuxfoundation.org>
Date: Tue, 2 Jul 2019 22:36:42 +0000 (-0700)
Subject: Change out lfidapi module print statements
X-Git-Tag: v0.25.3~4
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F59%2F16059%2F6;p=releng%2Flftools.git

Change out lfidapi module print statements

Switch to using the logging facility so that we can more easily switch
our output streams and also not through debugging output when we don't
need it.

Also add in some useful log.info where it is appropriate.

Change-Id: I76a5db63d584ab84a1ad12bfde1daffde0b619b0
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
---

diff --git a/lftools/lfidapi.py b/lftools/lfidapi.py
index 05a6a825..1b69759b 100755
--- a/lftools/lfidapi.py
+++ b/lftools/lfidapi.py
@@ -11,6 +11,7 @@
 """Use the LFIDAPI to add, remove and list members as well as create groups."""
 
 import json
+import logging
 
 from email_validator import validate_email
 import requests
@@ -19,6 +20,8 @@ import yaml
 
 from lftools.oauth2_helper import oauth_helper
 
+log = logging.getLogger(__name__)
+
 PARSE = urllib.parse.urljoin
 
 
@@ -49,7 +52,7 @@ def helper_search_members(group):
     check_response_code(response)
     result = (response.json())
     members = result["members"]
-    print(json.dumps(members, indent=4, sort_keys=True))
+    log.debug(json.dumps(members, indent=4, sort_keys=True))
     return members
 
 
@@ -60,12 +63,14 @@ def helper_user(user, group, delete):
     headers = {'Authorization': 'Bearer ' + access_token}
     data = {"username": user}
     if delete:
+        log.info('Deleting %s from %s' % (user, group))
         response = requests.delete(url, json=data, headers=headers)
     else:
+        log.info('Adding %s to %s' % (user, group))
         response = requests.put(url, json=data, headers=headers)
     check_response_code(response)
     result = (response.json())
-    print(json.dumps(result, indent=4, sort_keys=True))
+    log.debug(json.dumps(result, indent=4, sort_keys=True))
 
 
 def helper_invite(email, group):
@@ -75,31 +80,34 @@ def helper_invite(email, group):
     url = PARSE(url, prejoin)
     headers = {'Authorization': 'Bearer ' + access_token}
     data = {"mail": email}
-    print('Validating email', email)
+    log.info('Validating email %s' % email)
     if validate_email(email):
+        log.info('Inviting %s to join %s' % (email, group))
         response = requests.post(url, json=data, headers=headers)
         check_response_code(response)
         result = (response.json())
-        print(json.dumps(result, indent=4, sort_keys=True))
+        log.debug(json.dumps(result, indent=4, sort_keys=True))
     else:
-        print("Email is not valid")
+        log.error("Email '%s' is not valid, not inviting to %s" %
+                  (email, group))
 
 
 def helper_create_group(group):
     """Create group."""
     response_code = helper_check_group_exists(group)
     if response_code == 200:
-        print("Group {} already exists exiting...".format(group))
+        log.error("Group %s already exists exiting..." % group)
     else:
         access_token, url = oauth_helper()
         url = '{}/'.format(url)
         headers = {'Authorization': 'Bearer ' + access_token}
         data = {"title": group, "type": "group"}
-        print(data)
+        log.debug(data)
+        log.info('Creating group %s' % group)
         response = requests.post(url, json=data, headers=headers)
         check_response_code(response)
         result = (response.json())
-        print(json.dumps(result, indent=4, sort_keys=True))
+        log.debug(json.dumps(result, indent=4, sort_keys=True))
 
 
 def helper_match_ldap_to_info(info_file, group, noop):
@@ -130,14 +138,14 @@ def helper_match_ldap_to_info(info_file, group, noop):
     for user in all_users:
         removed_by_patch = [item for item in ldap_committers if item not in info_committers]
         if (user in removed_by_patch):
-            print(" {} found in group {} ".format(user, group))
+            log.info("%s found in group %s " % (user, group))
             if noop is False:
-                print(" removing user {} from group {}".format(user, group))
+                log.info(" removing user %s from group %s" % (user, group))
                 helper_user(user, group, "--delete")
 
         added_by_patch = [item for item in info_committers if item not in ldap_committers]
         if (user in added_by_patch):
-            print(" {} not found in group {} ".format(user, group))
+            log.info("%s not found in group %s" % (user, group))
             if noop is False:
-                print(" adding user {} to group {}".format(user, group))
+                log.info(" adding user %s to group %s" % (user, group))
                 helper_user(user, group, "")
diff --git a/releasenotes/notes/lfidapi-logger-cbd6457298f0718e.yaml b/releasenotes/notes/lfidapi-logger-cbd6457298f0718e.yaml
new file mode 100644
index 00000000..adf63706
--- /dev/null
+++ b/releasenotes/notes/lfidapi-logger-cbd6457298f0718e.yaml
@@ -0,0 +1,6 @@
+---
+fixes:
+  - |
+    Change out lfidapi module print statements to use the logger facility. This
+    allows us to split appart information, debugging, and error log statements
+    so that they can be easily enabled and captured on the correct streams.