Merge pull request #78 from ericyame/update-create-users

Add create_user_from_file.py to user creation from CSV file

Author: Glenn Snyder

blackduck/HubRestApi.py

@@ -891,7 +891,7 @@ def delete_project_version_by_name(self, project_name, version_name, save_scans=
         else:
             logging.debug("Did not find project with name {}".format(project_name))
 
-    def delete_project_by_name(self, project_name, save_scans=False):
+    def delete_project_by_name(self, project_name, save_scans=False, backup_scans=False):
         project = self.get_project_by_name(project_name)
         if project:
             # get project versions
@@ -905,6 +905,9 @@ def delete_project_by_name(self, project_name, save_scans=False):
             if delete_scans:
                 # delete all code locations associated with each version
                 for version in versions:
+                    if backup_scans:
+                        logging.debug("Backup code locations (aka scans) for version {}".format(version['versionName']))
+                        self.download_project_scans(project_name, version['versionName'])
                     logging.debug("Deleting code locations (aka scans) for version {}".format(version['versionName']))
                     self.delete_project_version_codelocations(version)
 
@@ -1285,7 +1288,9 @@ def download_project_scans(self, project_name,version_name, output_folder=None):
                 if output_folder:
                     pathname = os.path.join(output_folder, filename)
                 else:
-                    pathname = filename
+                    if not os.path.exists(project_name):
+                        os.mkdir(project_name)
+                    pathname = os.path.join(project_name, filename)
                 responce = requests.get(url, headers=self.get_headers(), stream=True, verify=False)
                 with open(pathname, "wb") as f:
                     for data in responce.iter_content():

examples/clean_project.json

@@ -0,0 +1,6 @@
+{
+    "clean_project" : [
+        "proftpd",
+        "libiec"
+    ]
+}

examples/create_user_from_file.py

@@ -0,0 +1,50 @@
+'''
+Created on Jan 8, 2020
+
+@author: ylei
+
+Create new users from file (user_list.csv)
+"python create_user_from_file.py -f user_list.csv"
+
+CSV File requires 4 columns titled 'username', 'first', 'last', and 'email'
+A sample user_list.csv is like below:
+username,first,last,email
+flast1,first1,last1,[email protected]
+flast2,first2,last2,[email protected]
+flast3,first3,last3,[email protected]
+
+'''
+import argparse
+import logging
+import sys
+import csv
+
+from blackduck.HubRestApi import HubInstance
+
+
+parser = argparse.ArgumentParser("Create bunch of new users (For example, LDAP users) from file")
+parser.add_argument("-f", "--filename", default="user_list.csv", help="File to store user list")
+
+args = parser.parse_args()
+
+logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
+logging.getLogger("requests").setLevel(logging.WARNING)
+logging.getLogger("urllib3").setLevel(logging.WARNING)
+
+hub = HubInstance()
+
+filename = args.filename
+with open(filename, 'r') as f:
+    rows = csv.DictReader(f)
+    for row in rows:
+        print("Create user: ", row['username'])
+        data = {
+            "userName" : row['username'],
+            "externalUserName" : row['username'],
+            "firstName" : row['first'],
+            "lastName" : row['last'],
+            "email" : row['email'],
+            "active" : True,
+            "type": "EXTERNAL"
+        }
+        hub.create_user(data)

examples/delete_project.py

@@ -16,6 +16,7 @@
 parser = argparse.ArgumentParser("A program that will delete a project along with its scans")
 parser.add_argument("project", help="Project name")
 parser.add_argument("-k", "--keep_scans", action = 'store_true', default=False, help="Use this option if you want to keep scans associated with the project-versions. Default is False, scans will be deleted.")
+parser.add_argument("-b", "--backup_scans", action = 'store_true', default=False, help="Use this option if you want to backup scans associated with the project-versions. Default is False, scans will not be backuped.")
 args = parser.parse_args()
 
 logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
@@ -24,4 +25,4 @@
 
 hub = HubInstance()
 
-hub.delete_project_by_name(args.project, save_scans=args.keep_scans)
+hub.delete_project_by_name(args.project, save_scans=args.keep_scans, backup_scans=args.backup_scans)

examples/delete_projects.py

@@ -0,0 +1,43 @@
+'''
+Created on Nov 8, 2019
+
+@author: ylei
+
+Delete multiple projects and their scans. The project names to be deleted are kept in clean_project.json
+'''
+
+import argparse
+import csv
+import logging
+import sys
+import json
+import arrow
+
+from blackduck.HubRestApi import HubInstance
+
+parser = argparse.ArgumentParser("A program that will delete projects along with their scans")
+#parser.add_argument("project", help="Project name")
+parser.add_argument("-f", "--filename", default="clean_project.json", help="File to keep Project names")
+parser.add_argument("-k", "--keep_scans", action = 'store_true', default=False, help="Use this option if you want to keep scans associated with the project-versions. Default is False, scans will be deleted.")
+parser.add_argument("-b", "--backup_scans", action = 'store_true', default=False, help="Use this option if you want to backup scans associated with the project-versions. Default is False, scans will not be backuped.")
+parser.add_argument("-a", "--age", default=3, help="The age, in days. If a project is older than this age it will be deleted.")
+args = parser.parse_args()
+
+logging.basicConfig(stream=sys.stdout, level=logging.DEBUG)
+logging.getLogger("requests").setLevel(logging.WARNING)
+logging.getLogger("urllib3").setLevel(logging.WARNING)
+
+hub = HubInstance()
+
+filename = args.filename
+with open(filename, 'r+') as f:
+    d = json.load(f)
+print("Projects in maintain json file: ", d['clean_project'])
+for proj in d['clean_project']:
+    now = arrow.now()
+    clean_time = now.to('local').shift(days=-args.age)
+    project = hub.get_project_by_name(proj)
+
+    if clean_time > arrow.get(project['createdAt']).to('local'):
+        print("Project ", project['name'], ' last for more than 3 days. Will be backup abd deleted.')
+        hub.delete_project_by_name(proj, save_scans=args.keep_scans, backup_scans=args.backup_scans)

examples/user_list.csv

@@ -0,0 +1,4 @@
+username,first,last,email
+flast9,first9,last9,[email protected]
+flast7,first7,last7,[email protected]
+flast8,first8,last8,[email protected]