fixing header issue and adding sample code showing how to work with custom fields and custom field options

Author: Glenn Snyder

blackduck/HubRestApi.py

@@ -181,6 +181,7 @@ def get_headers(self):
             return {
                 'X-CSRF-TOKEN': self.csrf_token, 
                 'Authorization': 'Bearer {}'.format(self.token), 
+                'Accept': 'application/json',
                 'Content-Type': 'application/json'}
         else:
             if self.bd_major_version == "3":

examples/add_custom_field_options.py

@@ -0,0 +1,42 @@
+
+#!/usr/bin/env python
+
+import argparse
+import json
+import logging
+import sys
+
+from blackduck.HubRestApi import HubInstance
+
+parser = argparse.ArgumentParser("Modify a custom field")
+parser.add_argument("object", choices=["BOM Component", "Component", "Component Version", "Project", "Project Version"], help="The object that the custom field should be attached to")
+parser.add_argument("field_id", help="The ID of the custom field to modify")
+parser.add_argument("-o", "--options", action='append', nargs=2, metavar=('label', 'position'), help="The options to add. To add more than one option repeat the -o option, supply a label and position for each possible selection. Used for DROPDOWN, MULTISELECT, and RADIO field types.")
+args = parser.parse_args()
+
+
+logging.basicConfig(format='%(asctime)s:%(levelname)s:%(message)s', stream=sys.stderr, level=logging.DEBUG)
+logging.getLogger("requests").setLevel(logging.DEBUG)
+logging.getLogger("urllib3").setLevel(logging.WARNING)
+
+options = [{"label": io[0], "position": io[1]} for io in args.options]
+
+hub = HubInstance()
+
+# delete all custom fields for the specified object type
+custom_fields = hub.get_custom_fields(args.object).get('items', [])
+for custom_field in custom_fields:
+    url = custom_field['_meta']['href']
+    field_id = url.split("/")[-1]
+    if field_id == args.field_id:
+        field_obj = hub.execute_get(url).json()
+
+        options_url = hub.get_link(field_obj, "custom-field-option-list")
+        for option in options:
+            response = hub.execute_post(options_url, data=option)
+            if response.status_code == 201:
+                print("Successfully added option {} to custom field {}".format(option, url))
+            else:
+                print("Failed to add option {} for custom field {}, status code: {}".format(
+                    option, url, response.status_code))
+

examples/delete_custom_field_option.py

@@ -0,0 +1,42 @@
+
+#!/usr/bin/env python
+
+import argparse
+import json
+import logging
+import sys
+
+from blackduck.HubRestApi import HubInstance
+
+parser = argparse.ArgumentParser("Modify a custom field option")
+parser.add_argument("object", choices=["BOM Component", "Component", "Component Version", "Project", "Project Version"], help="The object that the custom field should be attached to")
+parser.add_argument("field_id", help="The ID of the custom field to modify")
+parser.add_argument("option_id", help="The ID of the custom field option to modify")
+args = parser.parse_args()
+
+
+logging.basicConfig(format='%(asctime)s:%(levelname)s:%(message)s', stream=sys.stderr, level=logging.DEBUG)
+logging.getLogger("requests").setLevel(logging.DEBUG)
+logging.getLogger("urllib3").setLevel(logging.WARNING)
+
+hub = HubInstance()
+
+# delete all custom fields for the specified object type
+custom_fields = hub.get_custom_fields(args.object).get('items', [])
+for custom_field in custom_fields:
+    field_url = custom_field['_meta']['href']
+    field_id = field_url.split("/")[-1]
+    if field_id == args.field_id:
+        field_obj = hub.execute_get(field_url).json()
+
+        options_url = hub.get_link(field_obj, "custom-field-option-list")
+        options = hub.execute_get(options_url).json().get('items', [])
+        for option in options:
+            option_url = option['_meta']['href']
+            option_id = option_url.split("/")[-1]
+            if option_id == args.option_id:
+                response = hub.execute_delete(option_url)
+                if response.status_code == 204:
+                    print("Deleted option {}".format(option_url))
+                else:
+                    print("Failed to delete option {}, status code: {}".format(option_url, response.status_code))

examples/get_custom_field_options.py

@@ -0,0 +1,35 @@
+
+#!/usr/bin/env python
+
+import argparse
+import json
+import logging
+from pprint import pprint
+import sys
+
+from blackduck.HubRestApi import HubInstance
+
+parser = argparse.ArgumentParser("Get custom field options")
+parser.add_argument("object", choices=["BOM Component", "Component", "Component Version", "Project", "Project Version"], help="The object that the custom field should be attached to")
+parser.add_argument("field_id", help="The ID of the custom field to modify")
+args = parser.parse_args()
+
+
+logging.basicConfig(format='%(asctime)s:%(levelname)s:%(message)s', stream=sys.stderr, level=logging.DEBUG)
+logging.getLogger("requests").setLevel(logging.DEBUG)
+logging.getLogger("urllib3").setLevel(logging.WARNING)
+
+hub = HubInstance()
+
+# delete all custom fields for the specified object type
+custom_fields = hub.get_custom_fields(args.object).get('items', [])
+for custom_field in custom_fields:
+    field_url = custom_field['_meta']['href']
+    field_id = field_url.split("/")[-1]
+    if field_id == args.field_id:
+        field_obj = hub.execute_get(field_url).json()
+
+        options_url = hub.get_link(field_obj, "custom-field-option-list")
+        options = hub.execute_get(options_url).json().get('items', [])
+        options_info = [{'option_url': o['_meta']['href'], 'label': o['label'], 'position': o['position']} for o in options]
+        pprint(options_info)

examples/get_policy.py

@@ -20,8 +20,11 @@
 logging.getLogger("urllib3").setLevel(logging.WARNING)
 
 hub = HubInstance()
-policies = hub.get_policies()
-for policy in policies.get('items', []):
+policies_url = hub.get_apibase() + "/policy-rules"
+# policies = hub.get_policies()
+policies = hub.execute_get(policies_url).json().get('items', [])
+
+for policy in policies:
     if policy['name'] == args.name:
         if args.prep:
             for attribute in ['createdAt', 'createdBy', 'createdByUser', 'updatedAt', 'updatedBy', 'updatedByUser', '_meta']:

examples/modify_custom_field.py

@@ -0,0 +1,41 @@
+
+#!/usr/bin/env python
+
+import argparse
+import json
+import logging
+import sys
+
+from blackduck.HubRestApi import HubInstance
+
+parser = argparse.ArgumentParser("Modify a custom field")
+parser.add_argument("object", choices=["BOM Component", "Component", "Component Version", "Project", "Project Version"], help="The object that the custom field should be attached to")
+parser.add_argument("field_id", help="The ID of the custom field to modify")
+parser.add_argument("-l", "--label", help="The new label to apply")
+parser.add_argument("-d", "--description", help="The new description to apply")
+args = parser.parse_args()
+
+
+logging.basicConfig(format='%(asctime)s:%(levelname)s:%(message)s', stream=sys.stderr, level=logging.DEBUG)
+logging.getLogger("requests").setLevel(logging.DEBUG)
+logging.getLogger("urllib3").setLevel(logging.WARNING)
+
+
+hub = HubInstance()
+
+# delete all custom fields for the specified object type
+custom_fields = hub.get_custom_fields(args.object).get('items', [])
+for custom_field in custom_fields:
+    url = custom_field['_meta']['href']
+    field_id = url.split("/")[-1]
+    if field_id == args.field_id:
+        field_obj = hub.execute_get(url).json()
+        if args.label:
+            field_obj['label'] = args.label
+        if args.description:
+            field_obj['description'] = args.description
+        response = hub.execute_put(url, data=field_obj)
+        if response.status_code == 200:
+            print("Successfully updated field {}".format(url))
+        else:
+            print("Failed to update field {}, status code: {}".format(response.status_code))