Merge branch 'master' of https://github.com/blackducksoftware/hub-rest-api-python

Author: Glenn Snyder

blackduck/HubRestApi.py

@@ -243,8 +243,8 @@ def _get_role_url(self):
     def get_roles(self, parameters={}):
         url = self._get_role_url() + self._get_parameter_string(parameters)
         response = self.execute_get(url)
-        return response.json()
-
+        return response.json()  
+    
     def get_roles_url_from_user_or_group(self, user_or_group):
         # Given a user or user group object, return the 'roles' url
         roles_url = None
@@ -358,6 +358,14 @@ def reset_user_password(self, user_id, new_password):
         headers = {'Content-Type':'application/vnd.blackducksoftware.user-1+json', 'Accept': 'application/json'}
         data = {'password': new_password}
         return self.execute_put(url, data, headers)
+    
+    def get_last_login(self,sinceDays=60):
+        url = self.config['baseurl'] + "/api/dormant-users"
+        param_string = self._get_parameter_string({'sinceDays': sinceDays})
+        url = "{}{}".format(url, param_string)
+        headers = {'Accept': 'application/vnd.blackducksoftware.user-4+json'}
+        response = self.execute_get(url, custom_headers=headers)
+        return response.json()
 
     ###
     #
@@ -374,8 +382,8 @@ def get_user_groups(self, parameters={}):
         return response.json()
 
     def get_user_group_by_name(self, group_name):
-        groups = self.get_user_groups()
-        for group in groups['items']:
+        group_list = self.get_user_groups({"q": f"name:{group_name}"})
+        for group in group_list['items']:
             if group['name'] == group_name:
                 return group
 
@@ -535,8 +543,8 @@ def find_component_info_for_protex_component(self, protex_component_id, protex_c
     #
     ##
 
-    valid_categories = ['VERSION','CODE_LOCATIONS','COMPONENTS','SECURITY','FILES']
-    valid_report_formats = ["CSV"]
+    valid_categories = ['VERSION','CODE_LOCATIONS','COMPONENTS','SECURITY','FILES', 'ATTACHMENTS', 'CRYPTO_ALGORITHMS', 'PROJECT_VERSION_CUSTOM_FIELDS', 'BOM_COMPONENT_CUSTOM_FIELDS', 'LICENSE_TERM_FULFILLMENT']
+    valid_report_formats = ["CSV", "JSON"]
     def create_version_reports(self, version, report_list, format="CSV"):
         assert all(list(map(lambda k: k in HubInstance.valid_categories, report_list))), "One or more selected report categories in {} are not valid ({})".format(
             report_list, HubInstance.valid_categories)
@@ -810,7 +818,7 @@ def get_version_components(self, projectversion, limit=1000):
         paramstring = self.get_limit_paramstring(limit)
         url = projectversion['_meta']['href'] + "/components" + paramstring
         headers = self.get_headers()
-        headers['Accept'] = 'application/vnd.blackducksoftware.bill-of-materials-4+json'
+        headers['Accept'] = 'application/vnd.blackducksoftware.bill-of-materials-6+json'
         response = requests.get(url, headers=headers, verify = not self.config['insecure'])
         jsondata = response.json()
         return jsondata
@@ -854,7 +862,7 @@ def update_project_version_settings(self, project_name, version_name, new_settin
     def get_version_by_id(self, project_id, version_id, limit=100):
         headers = self.get_headers()
         paramstring = self.get_limit_paramstring(limit)
-        url = self._get_projects_url() + project_id + "/versions/" + version_id
+        url = self._get_projects_url() + "/" + project_id + "/versions/" + version_id
         headers['Accept'] = 'application/vnd.blackducksoftware.project-detail-4+json'
         response = requests.get(url, headers=headers, verify = not self.config['insecure'])
         jsondata = response.json()
@@ -1028,7 +1036,7 @@ def assign_user_group_to_project(self, project_name, user_group_name, project_ro
             project_url = project['_meta']['href']
             assignable_user_groups_link = self.get_link(project, 'assignable-usergroups')
             if assignable_user_groups_link:
-                assignable_user_groups_response = self.execute_get(assignable_user_groups_link)
+                assignable_user_groups_response = self.execute_get(f"{assignable_user_groups_link}?q=name:{user_group_name}")
                 assignable_user_groups = assignable_user_groups_response.json()
 
                 # TODO: What to do if the user group is already assigned to the project, and therefore
@@ -1072,6 +1080,20 @@ def assign_user_group_to_project(self, project_name, user_group_name, project_ro
         else:
             logger.warning("Did not find a project by the name {}".format(project_name))
 
+    def delete_user_group_from_project(self, project_name, user_group_name):
+        project = self.get_project_by_name(project_name)
+        
+        if project:
+            project_url = project['_meta']['href']
+            
+            user_group = self.get_user_group_by_name(user_group_name)
+            if user_group:
+                user_group_url = user_group['_meta']['href']
+                user_group_id = user_group_url.rsplit('/', 1)[-1]
+            
+                project_user_group_url = f"{project_url}/usergroups/{user_group_id}"
+                self.execute_delete(project_user_group_url)    
+    
     def assign_user_to_project(self, user_name, project_name, project_roles, limit=1000):
         # Assign users to projects
         project = self.get_project_by_name(project_name)

examples/deactivateUser.py

@@ -0,0 +1,137 @@
+from blackduck.HubRestApi import HubInstance
+import json
+import csv
+import argparse
+
+username = "sysadmin"
+password = "blackduck"
+urlbase = "https://blackduck.local"
+inactiveLog = r"c:\temp\inactive.csv"  #add a location to your CSV log file
+
+parser = argparse.ArgumentParser("Enter a number of days since last logged?")
+parser.add_argument("-d", "--days", dest="days", type=int, default=30,
+                    help="Specify the number of days that a user has not logged in the console.")
+
+args = parser.parse_args()
+
+hub = HubInstance(urlbase, username, password, insecure=True)
+
+last_login = hub.get_last_login(sinceDays=args.days)
+
+print("********************************************")
+print("Print every user who should be inactive.")
+print("********************************************")
+print("")
+print(last_login) 
+print("")
+print("")
+
+##################################################################################################################################
+# 1) - If System Users (anonymous, sysadmin, blackduck_system, default-authenticated user) are in this list, remove them from it #
+# 2) - Remove users who have never logged in before 
+##################################################################################################################################
+
+last_login['items'] = [x for x in last_login['items'] if x['username'] not in ('sysadmin', 'anonymous', 'blackduck_system', 'default-authenticated-user')] #1
+last_login['items'] = [x for x in last_login['items'] if 'lastLogin' in x] #2
+
+print("********************************************")
+print("Filter List: Users never logged in and system users: anonymous, sysadmin, blackduck_system, default-authenticated user")
+print("********************************************")
+print("")
+print(last_login['items']) 
+print("")
+print("")
+
+#############################################################
+# Create a new last-login list based on the remaining users #
+#############################################################
+
+new_last_login = last_login['items']
+
+###############################################
+# Move (href:) key/value pair outside of meta #
+###############################################
+
+for index in range(len(new_last_login)):
+  d = new_last_login[index] # Fetch the Dictionary element
+  _meta = d['_meta'] # Fetch _Meta Key
+  href = _meta['href'] # Fetch href
+  d['href'] = href # Add to Main List
+  del _meta['href'] # Delete from _Meta
+
+
+print("********************************************")
+print("Print updated list ")
+print("********************************************")
+print("")
+print(new_last_login)
+print("")
+print("")
+ 
+#######################################################
+# 1) deletes (lastLogin) and *(_meta) keypairs        #
+# 2) remove the '/last-login' from the HREF URL value #
+# 3) grab the user data from current user in loop     #
+# 4) create json data set with updated info for user  #
+# 5) deactivate user                                  #
+# 6) print user update status                         #
+#######################################################
+
+header = ['username','first name', 'last name', 'last login']
+
+with open(inactiveLog, "w+", newline='') as f:
+  writer = csv.writer(f, delimiter=',')
+  writer.writerow(header) # write the header
+
+for i in range(len(new_last_login)):
+
+    del new_last_login[i]['_meta'] #1
+    #del new_last_login[i]['lastLogin'] #1
+    new_last_login[i]['lastLogin'] #1
+    new_last_login[i]['href'] = new_last_login[i]['href'].replace("/last-login", "") #2
+
+    user_url = new_last_login[i]['href'] #3
+    user_info = hub.get_user_by_url(user_url) #3
+    
+    #print ("")
+    #print(user_info)
+    #print ("")
+
+    print ("***getting user data***")
+    print ("")
+
+
+    data_set = {"active" : False, "userName" :new_last_login[i]['username'],"firstName" :user_info['firstName'], "lastName" :user_info['lastName']} #4
+    json_dump = json.dumps(data_set) #4
+    update_json=json_dump #4
+    
+    #print(user_url)
+    #print(json_dump)
+
+    print ("***deactivating user***")
+    print ("")
+    
+    updateuser = hub.update_user_by_url(user_url,update_json) #5
+       
+    print("Result for user:" + new_last_login[i]['username'])
+    print(updateuser) #6
+
+    log = [new_last_login[i]['username'], user_info['firstName'], user_info['lastName'], new_last_login[i]['lastLogin']]
+    
+    with open(inactiveLog, mode='a', newline='') as f:
+      writer = csv.writer(f, delimiter=',')
+      writer.writerow(log) #write the inactive user data
+    
+    i=i+1
+
+
+
+
+
+    
+    
+
+
+
+
+