Merge pull request #246 from blackducksoftware/eriktest

Eriktest

Author: mkumykov

examples/client/update_project_with_component_licenses.py

@@ -26,7 +26,82 @@
 
 from pprint import pprint
 from blackduck import Client
-from collections import defaultdict
+
+licenselist = []
+
+def checkforsubprojects(s):
+    #Simple Check to see if subproject also has child subprojects
+    subcomponents = getcomponents(s,"Sub")
+    if len(subcomponents)>0:
+        check = True
+    else:
+        check= False
+    return check
+
+def getcomponents(spj, test):
+    #Returns Versions of a given project
+    if test == "Version":
+        components = [ sp for sp in bd.get_resource('components',spj) if sp['componentType'] == "SUB_PROJECT" ]
+    #Returns Subprojects for a given Project Version
+    elif test == "Sub":
+        version = bd.session.get(returnsubprojecturl(spj)).json()
+        components = [ sp for sp in bd.get_resource('components',version) if sp['componentType'] == "SUB_PROJECT" ]
+    #Returns license data for a given Project Version
+    elif test == "License":
+        version = bd.session.get(returnsubprojecturl(spj)).json()
+        components = bd.get_resource('components',version)
+    return components
+
+def getlicensesfromprojectversion(subproject):
+    license_components = getcomponents(subproject,"License")
+    #check for subprojects
+    if checkforsubprojects(subproject) == True:
+        #First Process Licenses of the components
+        for license_component in license_components:  
+            for license in license_component['licenses']:
+                if license.get("licenseType",None) :
+                    for innerlicense in license['licenses']:
+                        licenselist.append(innerlicense)   
+                else:
+                    licenselist.append(license)
+        #Now Loop Through the nested projects
+        loops = getcomponents(subproject,"Sub")
+        for loop in loops:
+            getlicensesfromprojectversion(loop)
+    #When No SubProjects
+    else:
+        for license_component in license_components:
+            for license in license_component['licenses']:
+                if license.get("licenseType",None):
+                    for innerlicense in license['licenses']:
+                        licenselist.append(innerlicense)
+                else:
+                    licenselist.append(license)
+    return licenselist
+
+def getprojects(project_name):
+    #Returns all Projects for a given Project Name
+    params = {
+        'q': [f"name:{project_name}"]
+    }
+    projects = [p for p in bd.get_resource('projects', params=params) if p['name'] == project_name]
+    return projects
+
+def getversions(project, version_name):
+    #Returns all Versions from a Project with given Version Name
+    params = {
+        'q': [f"versionName:{version_name}"]
+    }
+    versions = [v for v in bd.get_resource('versions', project, params=params) if v['versionName'] == version_name]
+    return versions
+
+def main():
+    args = parse_command_args()
+    with open(args.token_file, 'r') as tf:
+        access_token = tf.readline().strip()
+    global bd
+    bd = Client(base_url=args.base_url, token=access_token, verify=args.no_verify, timeout=60.0, retries=4)
+    process_project_version(args)
 
 def parse_command_args():
     parser = argparse.ArgumentParser("update_project_with_component_licenses.py [-h] -u BASE_URL -t TOKEN_FILE [-nv] ")
@@ -37,97 +112,52 @@ def parse_command_args():
     parser.add_argument("-v", "--version_name"). help="Provide Project Version here"
     return parser.parse_args()
 
-def main():
-    args = parse_command_args()
-    with open(args.token_file, 'r') as tf:
-        access_token = tf.readline().strip()
-    global bd
-    bd = Client(base_url=args.base_url, token=access_token, verify=args.no_verify, timeout=60.0, retries=4)
-    process_project_version(args.project_name, args.version_name, args)
-
-def process_project_version(project_name, version_name, args):
+def process_project_version(args):
     #Validating only 1 Project
-    params = {
-        'q': [f"name:{args.project_name}"]
-    }
-    projects = [p for p in bd.get_resource('projects', params=params) if p['name'] == args.project_name]
+    projects = getprojects(args.project_name)
     assert len(projects) == 1, f"There should be one, and only one project named {args.project_name}. We found {len(projects)}"
     project = projects[0]
 
     #Validates only 1 Version
-    params = {
-        'q': [f"versionName:{args.version_name}"]
-    }
-    versions = [v for v in bd.get_resource('versions', project, params=params) if v['versionName'] == args.version_name]
+    versions = getversions(project, args.version_name)
     assert len(versions) == 1, f"There should be one, and only one version named {args.version_name}. We found {len(versions)}"
     version = versions[0]
 
-    
-
+    pprint("Currently processing SubProjectes of Project " + project['name'] + " version " + version['versionName'])
     #Return only sub-projects, not components
-    components = (
-        c for c in bd.get_resource('components',version) if c['componentType'] == "SUB_PROJECT"
-        )
-    for components in components:
-        #JSON body
-        body =  defaultdict(list)
-               
-        existing_licenses = []
-
-        #Defining subcomponents 
-        body["componentName"]=components['componentName']
-        body["componentVersionName"]=components['componentVersionName']
-        body["component"]=components['component']
-        body["componentVersion"]=components['componentVersion']
-        body["componentType"]="SUB_PROJECT"
-        pprint(components['componentName'])
-        pprint(components['componentVersionName'])
-        url = components['_meta']['href']
-        #Capture current License statement of components to add to
-        if len(components['licenses'][0]['licenses']) > 0:
-            for i, v in enumerate(components['licenses'][0]['licenses']):
-                parent_license_display = components['licenses'][0]['licenses'][i]['licenseDisplay']
-                parent_license = components['licenses'][0]['licenses'][i]['license']
-                addlicense ={"licenseDisplay":parent_license_display,"license": parent_license }
-                body['licenses'].append(addlicense)
-                if parent_license_display not in existing_licenses:
-                    existing_licenses.append(parent_license_display)
-        else:
-            parent_license_display = components['licenses'][0]['licenses'][0]['licenseDisplay']
-            parent_license = components['licenses'][0]['licenses'][0]['license']
-            addlicense ={"licenseDisplay":parent_license_display,"license": parent_license }
-            body['licenses'].append(addlicense)
-            if parent_license_display not in existing_licenses:
-                existing_licenses.append(parent_license_display)
-        #Retrieving componentName values
-        subprojects = [p for p in bd.get_resource('projects') if p['name'] == components['componentName']]
-        subproject = subprojects[0]
-        subversions = [v for v in bd.get_resource('versions', subproject) if v['versionName'] == components['componentVersionName']]
-        subversion = subversions[0]
-        for subcomponent in bd.get_resource('components',subversion):
-            #Parse through multiple licenses
-            if len(subcomponent['licenses'][0]['licenses']) > 0:
-                for i, v in enumerate(subcomponent['licenses'][0]['licenses']):
-                    child_license_display = subcomponent['licenses'][0]['licenses'][i]['licenseDisplay']
-                    child_license = subcomponent['licenses'][0]['licenses'][i]['license']
-                    addlicense ={"licenseDisplay":child_license_display,"license": child_license }
-                    if child_license_display not in existing_licenses:
-                        body['licenses'].append(addlicense)
-                        existing_licenses.append(child_license_display)
-            #When only one license return it
-            else:
-                child_license_display = subcomponent['licenses'][0]['licenseDisplay']
-                child_license = subcomponent['licenses'][0]['license']
-                addlicense ={"licenseDisplay":child_license_display,"license": child_license }
-                if child_license_display not in existing_licenses:
-                        body['licenses'].append(addlicense)
-                        existing_licenses.append(child_license_display)
-        pprint(dict(body))
-        try:
-            r = bd.session.put(url,json=(dict(body)))
-            if r.status_code == 200:
-                print("updated project")
-        except requests.HTTPError as err:
-            bd.http_error_handler(err)
+    components = getcomponents(version, "Version")  
+
+    for subproject in components:
+        #Setting URL for API call
+        url = subproject['_meta']['href']
+        #Retrieve Licenses
+        subprojectlicenses = getlicensesfromprojectversion(subproject)
+        #Defaulting licenseblock to correct format
+        licenseblock = [
+        {
+            "licenseType": "CONJUNCTIVE",
+            "licenses": subproject['licenses'][0]['licenses']}]
+        #Adding each license to array
+        for license in subprojectlicenses:
+            licenseblock[0]['licenses'].append(license)
+        #Adding licenses to JSON body
+        subproject['licenses']=licenseblock
+        try: 
+            r = bd.session.put(url,json=subproject)
+            print("Updated SubProject " + subproject['componentName'] + " with child licenses")
+        except KeyError as err:
+            pprint (err)
+            
+
+def returnsubprojecturl(x):
+    xurl=x['_meta']['href']
+    x = xurl.split("/")
+    del x[5]
+    del x[5]
+    del x[5]
+    del x[5]
+    xurl = "/".join(x)
+    return xurl
+
 if __name__ == "__main__":
     sys.exit(main())