Add more examples

Author: skiyooka

examples/client/crud_project.py

@@ -0,0 +1,77 @@
+from blackduck import Client
+
+import argparse
+import logging
+import requests
+
+logging.basicConfig(
+    level=logging.DEBUG,
+    format="[%(asctime)s] {%(module)s:%(lineno)d} %(levelname)s - %(message)s"
+)
+
+parser = argparse.ArgumentParser("Create, read, update, and delete a project")
+parser.add_argument("--base-url", required=True, help="Hub server URL e.g. https://your.blackduck.url")
+parser.add_argument("--token-file", dest='token_file', required=True, help="containing access token")
+parser.add_argument("--no-verify", dest='verify', action='store_false', help="disable TLS certificate verification")
+parser.add_argument("--project", required=True, help="Project name")
+args = parser.parse_args()
+
+with open(args.token_file, 'r') as tf:
+    access_token = tf.readline().strip()
+
+bd = Client(
+    base_url=args.base_url,
+    token=access_token,
+    verify=args.verify
+)
+
+project_name = args.project
+
+# POST
+project_data = {
+    'name': project_name,
+    'description': "some description",
+    'projectLevelAdjustments': True,
+}
+
+try:
+    r = bd.session.post("/api/projects", json=project_data)
+    r.raise_for_status()
+    print(f"created project {r.links['project']['url']}")
+except requests.HTTPError as err:
+    # more fine grained error handling here; otherwise:
+    bd.http_error_handler(err)
+
+# GET
+params = {
+    'q': [f"name:{project_name}"]
+}
+project_url = None
+for project in bd.get_items("/api/projects", params=params):
+    if project['name'] == project_name:
+        project_url = bd.list_resources(project)['href']
+        print(f"project url: {project_url}")
+
+# PUT
+project_data = {
+    'name': project_name,
+    'description': "a different description"
+}
+
+try:
+    r = bd.session.put(project_url, json=project_data)
+    r.raise_for_status()
+    print("updated project")
+except requests.HTTPError as err:
+    bd.http_error_handler(err)
+
+# DELETE
+try:
+    r = bd.session.delete(project_url)
+    r.raise_for_status()
+    print("deleted project")
+except requests.HTTPError as err:
+    if err.response.status_code == 404:
+        print("not found")
+    else:
+        bd.http_error_handler(err)

examples/client/get_component_vulnerabilities.py

@@ -0,0 +1,34 @@
+from blackduck import Client
+
+import argparse
+import logging
+from pprint import pprint
+
+logging.basicConfig(
+    level=logging.DEBUG,
+    format="[%(asctime)s] {%(module)s:%(lineno)d} %(levelname)s - %(message)s"
+)
+
+parser = argparse.ArgumentParser("Get a specific component and list its vulnerabilities")
+parser.add_argument("--base-url", required=True, help="Hub server URL e.g. https://your.blackduck.url")
+parser.add_argument("--token-file", dest='token_file', required=True, help="containing access token")
+parser.add_argument("--no-verify", dest='verify', action='store_false', help="disable TLS certificate verification")
+args = parser.parse_args()
+
+with open(args.token_file, 'r') as tf:
+    access_token = tf.readline().strip()
+
+bd = Client(base_url=args.base_url, token=access_token, verify=args.verify)
+
+params = {
+    'q': ["maven:commons-beanutils:commons-beanutils:1.9.3"]
+}
+search_results = bd.get_items("/api/components", params=params)
+for result in search_results:
+    pprint(result)
+    print(f"{result['componentName']} {result['versionName']}")
+    url = result['version']
+    component_version = bd.get_json(url)
+
+    for vulnerability in bd.get_resource('vulnerabilities', component_version):
+        print(vulnerability['name'])

examples/client/get_vulnerability.py

@@ -0,0 +1,26 @@
+from blackduck import Client
+
+import argparse
+import logging
+from pprint import pprint
+
+logging.basicConfig(
+    level=logging.DEBUG,
+    format="[%(asctime)s] {%(module)s:%(lineno)d} %(levelname)s - %(message)s"
+)
+
+parser = argparse.ArgumentParser("Get a single vulnerability by id")
+parser.add_argument("--base-url", required=True, help="Hub server URL e.g. https://your.blackduck.url")
+parser.add_argument("--token-file", dest='token_file', required=True, help="containing access token")
+parser.add_argument("--no-verify", dest='verify', action='store_false', help="disable TLS certificate verification")
+parser.add_argument("--vulnerability", help="vulnerability id e.g. CVE-2016-4009 or BDSA-2014-0129")
+args = parser.parse_args()
+
+with open(args.token_file, 'r') as tf:
+    access_token = tf.readline().strip()
+
+bd = Client(base_url=args.base_url, token=access_token, verify=args.verify)
+
+vulnerability = bd.get_json(f"/api/vulnerabilities/{args.vulnerability}")
+print(f"Details about {vulnerability['name']}")
+pprint(vulnerability)

examples/client/password.py

@@ -11,23 +11,17 @@
     format="[%(asctime)s] {%(module)s:%(lineno)d} %(levelname)s - %(message)s"
 )
 
-parser = argparse.ArgumentParser()
+parser = argparse.ArgumentParser("Authenticate using username/password credentials")
 parser.add_argument("--base-url", required=True, help="Hub server URL e.g. https://your.blackduck.url")
 parser.add_argument("--username", required=True, help="Hub user")
 parser.add_argument("--password", required=True, help="Hub user")
 parser.add_argument("--no-verify", dest='verify', action='store_false', help="disable TLS certificate verification")
 args = parser.parse_args()
 
-verify = args.verify
 base_url = args.base_url
-session = HubSession(base_url, timeout=15.0, retries=3, verify=verify)
-auth = CookieAuth(session, username=args.username, password=args.password)
+session = HubSession(base_url, timeout=15.0, retries=3, verify=args.verify)
+auth = CookieAuth(session, args.username, args.password)
 
-bd = Client(
-    base_url=base_url,
-    session=session,
-    auth=auth,
-    verify=verify
-)
+bd = Client(base_url=base_url, session=session, auth=auth)
 
 pprint(bd.list_resources())

examples/client/quickstart.py

@@ -9,7 +9,7 @@
     format="[%(asctime)s] {%(module)s:%(lineno)d} %(levelname)s - %(message)s"
 )
 
-parser = argparse.ArgumentParser()
+parser = argparse.ArgumentParser("Quickstart demonstration with Client")
 parser.add_argument("--base-url", required=True, help="Hub server URL e.g. https://your.blackduck.url")
 parser.add_argument("--token-file", dest='token_file', required=True, help="containing access token")
 parser.add_argument("--no-verify", dest='verify', action='store_false', help="disable TLS certificate verification")