Skip to content

Adding check for project-version-violations and report back#55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jmvanryn wants to merge 6 commits into
base:master
Choose a base branch
from
Open

Adding check for project-version-violations and report back #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2b96b12
Adding in example to report on project violations.
Jul 24, 2019
481371b
Adding in example to report on project violations.
Jul 24, 2019
345d2f2
Merge remote-tracking branch 'upstream/master'
Feb 12, 2020
42b3032
Updates as per review
Feb 12, 2020
bda7092
revert change
Feb 13, 2020
0594ef6
Merge pull request #1 from blackducksoftware/master
jmvanryn Feb 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,3 +102,5 @@ venv.bak/

# mypy
.mypy_cache/
/.idea/
/examples/.restconfig.json
27 changes: 27 additions & 0 deletions blackduck/HubRestApi.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -697,6 +697,7 @@ def get_projects(self, limit=100, parameters={}):
headers['Accept'] = 'application/vnd.blackducksoftware.project-detail-4+json'
logger.debug(f"Retrieving projects using url {url}")
response = requests.get(url, headers=headers, verify = not self.config['insecure'])
## @SMELL need to gracfully handle not finding the project
jsondata = response.json()
return jsondata

Expand DownExpand Up@@ -1255,6 +1256,32 @@ def get_project_info(self, project_name, link_name):
else:
return {} # nada

def get_project_violation_status(self, project_name, version):

project = self.get_project_by_name(project_name)

@gsnyder2007gsnyder2007Jul 24, 2019

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you consider using self.get_project_version_by_name? would replace use of get_project_by_name and the subsequent code to retrieve the version if present, e.g. this method would then become,

def get_project_violation_status(self, project_name, version):
version = self.get_project_version_by_name(project_name, version)
if version:
return version.get('policyStatus', None)
else:
return "{}:{} not found".format(project_name, version)

or something along those lines?

@jmvanrynjmvanrynFeb 12, 2020

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, well I believe I was looking at it this way because it is a more precise error. If I remember get_project_version_by_name will return a non 200 on both missing projects or versions. and I wanted to tell my users what was missing the project or the version or if the server was just miss-behaving

if (project is None):
logging.debug("Project " + project_name + " not found")
return ("NO_PROJECT")

link = self.get_link(project, "versions")
if link:
response = self.execute_get(link)
if response.status_code == 200:
versions_list = json.loads(response.text)
for version_item in versions_list['items']:
logging.debug("Got version in file "+version_item['versionName'])
if version == 'empty':
version = version_item['versionName']
if version_item['versionName'] == version:
logging.debug("Found " + version)
return version_item['policyStatus']
else:
return ("VERSION_NOT_SCANNED")
else:
return ("SERVER_NOT_RETURNED_200")
else:
return {} # nada

def get_project_roles(self):
all_project_roles = self.get_roles(parameters={"filter":"scope:project"})
return all_project_roles['items']
Expand Down
4 changes: 2 additions & 2 deletions examples/get_project.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@

project = hub.get_project_by_name(args.project_name)

print(json.dumps(project))
print(json.dumps(project, indent=4, sort_keys=True))

if args.link:
print(json.dumps(hub.get_project_info(args.project_name, args.link)))
print(json.dumps(hub.get_project_info(args.project_name, args.link), indent=4))
32 changes: 32 additions & 0 deletions examples/get_project_violations.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
'''
Created on Nov 14, 2018

@author: gsnyder

Print a project given its name

'''

from blackduck.HubRestApi import HubInstance

import argparse
import json

parser = argparse.ArgumentParser(description='Use this to check the status of a given version for a given project. If no version is given then it will return the status of the highest version.')

parser.add_argument("--limit")
parser.add_argument("project_name")
parser.add_argument("--version", default="empty", help="If provided, will result in if that version passed policy check")

args = parser.parse_args()

hub = HubInstance()

status=hub.get_project_violation_status(args.project_name, args.version)
print(status)
if(status == "IN_VIOLATION"):
exit(0)
elif(status == "NOT_IN_VIOLATION"):
exit(0)
else:
exit(0)
10 changes: 5 additions & 5 deletions examples/purge.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -19,20 +19,20 @@
print ("total projects found: %s" % projects['totalCount'])

for project in projects['items']:
print(project['name'])
print(project['name'])
versions = hub.get_project_versions(project)
print("\t versions found %s" % versions['totalCount'])
print("\t versions found %s" % versions['totalCount'])
versionlist = versions['items']
if len(versionlist) == 1:
continue
for index in range(len(versionlist) - 1):
print("index is ".format(index))
print("index is ".format(index))
va = versionlist[index]
components = hub.get_version_components(va)
codelocations = hub.get_version_codelocations(va)
# hub.execute_delete(va['_meta']['href'])
print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
if codelocations > 0:
print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
if codelocations['totalCount'] > 0:
Comment thread
jmvanryn marked this conversation as resolved.
for codelocation in codelocations['items']:
print (codelocation['_meta']['href'])
locationid = codelocation['_meta']['href'].split("/")[5]
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Adding check for project-version-violations and report back by jmvanryn · Pull Request #55 · blackducksoftware/hub-rest-api-python · GitHub
Skip to content
Adding check for project-version-violations and report back#55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

jmvanryn
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


Adding check for project-version-violations and report back
#55
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2b96b12

Adding in example to report on project violations.

Jul 24, 2019
481371b

Adding in example to report on project violations.

Jul 24, 2019
345d2f2

Merge remote-tracking branch 'upstream/master'

Feb 12, 2020
42b3032

Updates as per review

Feb 12, 2020
bda7092

revert change

Feb 13, 2020
0594ef6

Merge pull request #1 from blackducksoftware/master


jmvanryn Feb 8, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,3 +102,5 @@ venv.bak/

# mypy
.mypy_cache/
/.idea/
/examples/.restconfig.json

27 changes: 27 additions & 0 deletions
blackduck/HubRestApi.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -697,6 +697,7 @@ def get_projects(self, limit=100, parameters={}):
 headers['Accept'] = 'application/vnd.blackducksoftware.project-detail-4+json'
 logger.debug(f"Retrieving projects using url {url}")
 response = requests.get(url, headers=headers, verify = not self.config['insecure'])
 ## @SMELL need to gracfully handle not finding the project
 jsondata = response.json()
 return jsondata

Expand DownExpand Up@@ -1255,6 +1256,32 @@ def get_project_info(self, project_name, link_name):
 else:
 return {} # nada

 def get_project_violation_status(self, project_name, version):

 project = self.get_project_by_name(project_name)
@gsnyder2007gsnyder2007Jul 24, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you consider using self.get_project_version_by_name? would replace use of get_project_by_name and the subsequent code to retrieve the version if present, e.g. this method would then become,
def get_project_violation_status(self, project_name, version):

version = self.get_project_version_by_name(project_name, version)

if version:

return version.get('policyStatus', None)

else:

return "{}:{} not found".format(project_name, version)
or something along those lines?
@jmvanrynjmvanrynFeb 12, 2020

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, well I believe I was looking at it this way because it is a more precise error. If I remember get_project_version_by_name will return a non 200 on both missing projects or versions. and I wanted to tell my users what was missing the project or the version or if the server was just miss-behaving
 if (project is None):
 logging.debug("Project " + project_name + " not found")
 return ("NO_PROJECT")

 link = self.get_link(project, "versions")
 if link:
 response = self.execute_get(link)
 if response.status_code == 200:
 versions_list = json.loads(response.text)
 for version_item in versions_list['items']:
 logging.debug("Got version in file "+version_item['versionName'])
 if version == 'empty':
 version = version_item['versionName']
 if version_item['versionName'] == version:
 logging.debug("Found " + version)
 return version_item['policyStatus']
 else:
 return ("VERSION_NOT_SCANNED")
 else:
 return ("SERVER_NOT_RETURNED_200")
 else:
 return {} # nada

 def get_project_roles(self):
 all_project_roles = self.get_roles(parameters={"filter":"scope:project"})
 return all_project_roles['items']
Expand Down

4 changes: 2 additions & 2 deletions
examples/get_project.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@

project = hub.get_project_by_name(args.project_name)

print(json.dumps(project))
print(json.dumps(project, indent=4, sort_keys=True))

if args.link:
	print(json.dumps(hub.get_project_info(args.project_name, args.link)))
	print(json.dumps(hub.get_project_info(args.project_name, args.link), indent=4))

32 changes: 32 additions & 0 deletions
examples/get_project_violations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
'''
Created on Nov 14, 2018

@author: gsnyder

Print a project given its name

'''

from blackduck.HubRestApi import HubInstance

import argparse
import json

parser = argparse.ArgumentParser(description='Use this to check the status of a given version for a given project. If no version is given then it will return the status of the highest version.')

parser.add_argument("--limit")
parser.add_argument("project_name")
parser.add_argument("--version", default="empty", help="If provided, will result in if that version passed policy check")

args = parser.parse_args()

hub = HubInstance()

status=hub.get_project_violation_status(args.project_name, args.version)
print(status)
if(status == "IN_VIOLATION"):
 exit(0)
elif(status == "NOT_IN_VIOLATION"):
 exit(0)
else:
 exit(0)

10 changes: 5 additions & 5 deletions
examples/purge.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,20 +19,20 @@
print ("total projects found: %s" % projects['totalCount'])

for project in projects['items']:
 print(project['name'])
 print(project['name'])
 versions = hub.get_project_versions(project)
 print("\t versions found %s" % versions['totalCount'])
 print("\t versions found %s" % versions['totalCount'])
 versionlist = versions['items']
 if len(versionlist) == 1:
 continue
 for index in range(len(versionlist) - 1):
 print("index is ".format(index))
 print("index is ".format(index))
 va = versionlist[index]
 components = hub.get_version_components(va)
 codelocations = hub.get_version_codelocations(va)
 # hub.execute_delete(va['_meta']['href'])
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations > 0:
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations['totalCount'] > 0:
Comment thread
jmvanryn marked this conversation as resolved.

 for codelocation in codelocations['items']:
 print (codelocation['_meta']['href'])
 locationid = codelocation['_meta']['href'].split("/")[5]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Adding check for project-version-violations and report back by jmvanryn · Pull Request #55 · blackducksoftware/hub-rest-api-python · GitHub
Skip to content
Adding check for project-version-violations and report back#55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

jmvanryn
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


Adding check for project-version-violations and report back
#55
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2b96b12

Adding in example to report on project violations.

Jul 24, 2019
481371b

Adding in example to report on project violations.

Jul 24, 2019
345d2f2

Merge remote-tracking branch 'upstream/master'

Feb 12, 2020
42b3032

Updates as per review

Feb 12, 2020
bda7092

revert change

Feb 13, 2020
0594ef6

Merge pull request #1 from blackducksoftware/master


jmvanryn Feb 8, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,3 +102,5 @@ venv.bak/

# mypy
.mypy_cache/
/.idea/
/examples/.restconfig.json

27 changes: 27 additions & 0 deletions
blackduck/HubRestApi.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -697,6 +697,7 @@ def get_projects(self, limit=100, parameters={}):
 headers['Accept'] = 'application/vnd.blackducksoftware.project-detail-4+json'
 logger.debug(f"Retrieving projects using url {url}")
 response = requests.get(url, headers=headers, verify = not self.config['insecure'])
 ## @SMELL need to gracfully handle not finding the project
 jsondata = response.json()
 return jsondata

Expand DownExpand Up@@ -1255,6 +1256,32 @@ def get_project_info(self, project_name, link_name):
 else:
 return {} # nada

 def get_project_violation_status(self, project_name, version):

 project = self.get_project_by_name(project_name)
@gsnyder2007gsnyder2007Jul 24, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you consider using self.get_project_version_by_name? would replace use of get_project_by_name and the subsequent code to retrieve the version if present, e.g. this method would then become,
def get_project_violation_status(self, project_name, version):

version = self.get_project_version_by_name(project_name, version)

if version:

return version.get('policyStatus', None)

else:

return "{}:{} not found".format(project_name, version)
or something along those lines?
@jmvanrynjmvanrynFeb 12, 2020

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, well I believe I was looking at it this way because it is a more precise error. If I remember get_project_version_by_name will return a non 200 on both missing projects or versions. and I wanted to tell my users what was missing the project or the version or if the server was just miss-behaving
 if (project is None):
 logging.debug("Project " + project_name + " not found")
 return ("NO_PROJECT")

 link = self.get_link(project, "versions")
 if link:
 response = self.execute_get(link)
 if response.status_code == 200:
 versions_list = json.loads(response.text)
 for version_item in versions_list['items']:
 logging.debug("Got version in file "+version_item['versionName'])
 if version == 'empty':
 version = version_item['versionName']
 if version_item['versionName'] == version:
 logging.debug("Found " + version)
 return version_item['policyStatus']
 else:
 return ("VERSION_NOT_SCANNED")
 else:
 return ("SERVER_NOT_RETURNED_200")
 else:
 return {} # nada

 def get_project_roles(self):
 all_project_roles = self.get_roles(parameters={"filter":"scope:project"})
 return all_project_roles['items']
Expand Down

4 changes: 2 additions & 2 deletions
examples/get_project.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@

project = hub.get_project_by_name(args.project_name)

print(json.dumps(project))
print(json.dumps(project, indent=4, sort_keys=True))

if args.link:
	print(json.dumps(hub.get_project_info(args.project_name, args.link)))
	print(json.dumps(hub.get_project_info(args.project_name, args.link), indent=4))

32 changes: 32 additions & 0 deletions
examples/get_project_violations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
'''
Created on Nov 14, 2018

@author: gsnyder

Print a project given its name

'''

from blackduck.HubRestApi import HubInstance

import argparse
import json

parser = argparse.ArgumentParser(description='Use this to check the status of a given version for a given project. If no version is given then it will return the status of the highest version.')

parser.add_argument("--limit")
parser.add_argument("project_name")
parser.add_argument("--version", default="empty", help="If provided, will result in if that version passed policy check")

args = parser.parse_args()

hub = HubInstance()

status=hub.get_project_violation_status(args.project_name, args.version)
print(status)
if(status == "IN_VIOLATION"):
 exit(0)
elif(status == "NOT_IN_VIOLATION"):
 exit(0)
else:
 exit(0)

10 changes: 5 additions & 5 deletions
examples/purge.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,20 +19,20 @@
print ("total projects found: %s" % projects['totalCount'])

for project in projects['items']:
 print(project['name'])
 print(project['name'])
 versions = hub.get_project_versions(project)
 print("\t versions found %s" % versions['totalCount'])
 print("\t versions found %s" % versions['totalCount'])
 versionlist = versions['items']
 if len(versionlist) == 1:
 continue
 for index in range(len(versionlist) - 1):
 print("index is ".format(index))
 print("index is ".format(index))
 va = versionlist[index]
 components = hub.get_version_components(va)
 codelocations = hub.get_version_codelocations(va)
 # hub.execute_delete(va['_meta']['href'])
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations > 0:
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations['totalCount'] > 0:
Comment thread
jmvanryn marked this conversation as resolved.

 for codelocation in codelocations['items']:
 print (codelocation['_meta']['href'])
 locationid = codelocation['_meta']['href'].split("/")[5]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Adding check for project-version-violations and report back by jmvanryn · Pull Request #55 · blackducksoftware/hub-rest-api-python · GitHub
Skip to content
Adding check for project-version-violations and report back#55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

jmvanryn
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


Adding check for project-version-violations and report back
#55
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2b96b12

Adding in example to report on project violations.

Jul 24, 2019
481371b

Adding in example to report on project violations.

Jul 24, 2019
345d2f2

Merge remote-tracking branch 'upstream/master'

Feb 12, 2020
42b3032

Updates as per review

Feb 12, 2020
bda7092

revert change

Feb 13, 2020
0594ef6

Merge pull request #1 from blackducksoftware/master


jmvanryn Feb 8, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,3 +102,5 @@ venv.bak/

# mypy
.mypy_cache/
/.idea/
/examples/.restconfig.json

27 changes: 27 additions & 0 deletions
blackduck/HubRestApi.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -697,6 +697,7 @@ def get_projects(self, limit=100, parameters={}):
 headers['Accept'] = 'application/vnd.blackducksoftware.project-detail-4+json'
 logger.debug(f"Retrieving projects using url {url}")
 response = requests.get(url, headers=headers, verify = not self.config['insecure'])
 ## @SMELL need to gracfully handle not finding the project
 jsondata = response.json()
 return jsondata

Expand DownExpand Up@@ -1255,6 +1256,32 @@ def get_project_info(self, project_name, link_name):
 else:
 return {} # nada

 def get_project_violation_status(self, project_name, version):

 project = self.get_project_by_name(project_name)
@gsnyder2007gsnyder2007Jul 24, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you consider using self.get_project_version_by_name? would replace use of get_project_by_name and the subsequent code to retrieve the version if present, e.g. this method would then become,
def get_project_violation_status(self, project_name, version):

version = self.get_project_version_by_name(project_name, version)

if version:

return version.get('policyStatus', None)

else:

return "{}:{} not found".format(project_name, version)
or something along those lines?
@jmvanrynjmvanrynFeb 12, 2020

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, well I believe I was looking at it this way because it is a more precise error. If I remember get_project_version_by_name will return a non 200 on both missing projects or versions. and I wanted to tell my users what was missing the project or the version or if the server was just miss-behaving
 if (project is None):
 logging.debug("Project " + project_name + " not found")
 return ("NO_PROJECT")

 link = self.get_link(project, "versions")
 if link:
 response = self.execute_get(link)
 if response.status_code == 200:
 versions_list = json.loads(response.text)
 for version_item in versions_list['items']:
 logging.debug("Got version in file "+version_item['versionName'])
 if version == 'empty':
 version = version_item['versionName']
 if version_item['versionName'] == version:
 logging.debug("Found " + version)
 return version_item['policyStatus']
 else:
 return ("VERSION_NOT_SCANNED")
 else:
 return ("SERVER_NOT_RETURNED_200")
 else:
 return {} # nada

 def get_project_roles(self):
 all_project_roles = self.get_roles(parameters={"filter":"scope:project"})
 return all_project_roles['items']
Expand Down

4 changes: 2 additions & 2 deletions
examples/get_project.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@

project = hub.get_project_by_name(args.project_name)

print(json.dumps(project))
print(json.dumps(project, indent=4, sort_keys=True))

if args.link:
	print(json.dumps(hub.get_project_info(args.project_name, args.link)))
	print(json.dumps(hub.get_project_info(args.project_name, args.link), indent=4))

32 changes: 32 additions & 0 deletions
examples/get_project_violations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
'''
Created on Nov 14, 2018

@author: gsnyder

Print a project given its name

'''

from blackduck.HubRestApi import HubInstance

import argparse
import json

parser = argparse.ArgumentParser(description='Use this to check the status of a given version for a given project. If no version is given then it will return the status of the highest version.')

parser.add_argument("--limit")
parser.add_argument("project_name")
parser.add_argument("--version", default="empty", help="If provided, will result in if that version passed policy check")

args = parser.parse_args()

hub = HubInstance()

status=hub.get_project_violation_status(args.project_name, args.version)
print(status)
if(status == "IN_VIOLATION"):
 exit(0)
elif(status == "NOT_IN_VIOLATION"):
 exit(0)
else:
 exit(0)

10 changes: 5 additions & 5 deletions
examples/purge.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,20 +19,20 @@
print ("total projects found: %s" % projects['totalCount'])

for project in projects['items']:
 print(project['name'])
 print(project['name'])
 versions = hub.get_project_versions(project)
 print("\t versions found %s" % versions['totalCount'])
 print("\t versions found %s" % versions['totalCount'])
 versionlist = versions['items']
 if len(versionlist) == 1:
 continue
 for index in range(len(versionlist) - 1):
 print("index is ".format(index))
 print("index is ".format(index))
 va = versionlist[index]
 components = hub.get_version_components(va)
 codelocations = hub.get_version_codelocations(va)
 # hub.execute_delete(va['_meta']['href'])
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations > 0:
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations['totalCount'] > 0:
Comment thread
jmvanryn marked this conversation as resolved.

 for codelocation in codelocations['items']:
 print (codelocation['_meta']['href'])
 locationid = codelocation['_meta']['href'].split("/")[5]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Adding check for project-version-violations and report back by jmvanryn · Pull Request #55 · blackducksoftware/hub-rest-api-python · GitHub
Skip to content
Adding check for project-version-violations and report back#55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

jmvanryn
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


Adding check for project-version-violations and report back
#55
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2b96b12

Adding in example to report on project violations.

Jul 24, 2019
481371b

Adding in example to report on project violations.

Jul 24, 2019
345d2f2

Merge remote-tracking branch 'upstream/master'

Feb 12, 2020
42b3032

Updates as per review

Feb 12, 2020
bda7092

revert change

Feb 13, 2020
0594ef6

Merge pull request #1 from blackducksoftware/master


jmvanryn Feb 8, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,3 +102,5 @@ venv.bak/

# mypy
.mypy_cache/
/.idea/
/examples/.restconfig.json

27 changes: 27 additions & 0 deletions
blackduck/HubRestApi.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -697,6 +697,7 @@ def get_projects(self, limit=100, parameters={}):
 headers['Accept'] = 'application/vnd.blackducksoftware.project-detail-4+json'
 logger.debug(f"Retrieving projects using url {url}")
 response = requests.get(url, headers=headers, verify = not self.config['insecure'])
 ## @SMELL need to gracfully handle not finding the project
 jsondata = response.json()
 return jsondata

Expand DownExpand Up@@ -1255,6 +1256,32 @@ def get_project_info(self, project_name, link_name):
 else:
 return {} # nada

 def get_project_violation_status(self, project_name, version):

 project = self.get_project_by_name(project_name)
@gsnyder2007gsnyder2007Jul 24, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you consider using self.get_project_version_by_name? would replace use of get_project_by_name and the subsequent code to retrieve the version if present, e.g. this method would then become,
def get_project_violation_status(self, project_name, version):

version = self.get_project_version_by_name(project_name, version)

if version:

return version.get('policyStatus', None)

else:

return "{}:{} not found".format(project_name, version)
or something along those lines?
@jmvanrynjmvanrynFeb 12, 2020

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, well I believe I was looking at it this way because it is a more precise error. If I remember get_project_version_by_name will return a non 200 on both missing projects or versions. and I wanted to tell my users what was missing the project or the version or if the server was just miss-behaving
 if (project is None):
 logging.debug("Project " + project_name + " not found")
 return ("NO_PROJECT")

 link = self.get_link(project, "versions")
 if link:
 response = self.execute_get(link)
 if response.status_code == 200:
 versions_list = json.loads(response.text)
 for version_item in versions_list['items']:
 logging.debug("Got version in file "+version_item['versionName'])
 if version == 'empty':
 version = version_item['versionName']
 if version_item['versionName'] == version:
 logging.debug("Found " + version)
 return version_item['policyStatus']
 else:
 return ("VERSION_NOT_SCANNED")
 else:
 return ("SERVER_NOT_RETURNED_200")
 else:
 return {} # nada

 def get_project_roles(self):
 all_project_roles = self.get_roles(parameters={"filter":"scope:project"})
 return all_project_roles['items']
Expand Down

4 changes: 2 additions & 2 deletions
examples/get_project.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@

project = hub.get_project_by_name(args.project_name)

print(json.dumps(project))
print(json.dumps(project, indent=4, sort_keys=True))

if args.link:
	print(json.dumps(hub.get_project_info(args.project_name, args.link)))
	print(json.dumps(hub.get_project_info(args.project_name, args.link), indent=4))

32 changes: 32 additions & 0 deletions
examples/get_project_violations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
'''
Created on Nov 14, 2018

@author: gsnyder

Print a project given its name

'''

from blackduck.HubRestApi import HubInstance

import argparse
import json

parser = argparse.ArgumentParser(description='Use this to check the status of a given version for a given project. If no version is given then it will return the status of the highest version.')

parser.add_argument("--limit")
parser.add_argument("project_name")
parser.add_argument("--version", default="empty", help="If provided, will result in if that version passed policy check")

args = parser.parse_args()

hub = HubInstance()

status=hub.get_project_violation_status(args.project_name, args.version)
print(status)
if(status == "IN_VIOLATION"):
 exit(0)
elif(status == "NOT_IN_VIOLATION"):
 exit(0)
else:
 exit(0)

10 changes: 5 additions & 5 deletions
examples/purge.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,20 +19,20 @@
print ("total projects found: %s" % projects['totalCount'])

for project in projects['items']:
 print(project['name'])
 print(project['name'])
 versions = hub.get_project_versions(project)
 print("\t versions found %s" % versions['totalCount'])
 print("\t versions found %s" % versions['totalCount'])
 versionlist = versions['items']
 if len(versionlist) == 1:
 continue
 for index in range(len(versionlist) - 1):
 print("index is ".format(index))
 print("index is ".format(index))
 va = versionlist[index]
 components = hub.get_version_components(va)
 codelocations = hub.get_version_codelocations(va)
 # hub.execute_delete(va['_meta']['href'])
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations > 0:
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations['totalCount'] > 0:
Comment thread
jmvanryn marked this conversation as resolved.

 for codelocation in codelocations['items']:
 print (codelocation['_meta']['href'])
 locationid = codelocation['_meta']['href'].split("/")[5]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Adding check for project-version-violations and report back by jmvanryn · Pull Request #55 · blackducksoftware/hub-rest-api-python · GitHub
Skip to content
Adding check for project-version-violations and report back#55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

jmvanryn
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


Adding check for project-version-violations and report back
#55
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2b96b12

Adding in example to report on project violations.

Jul 24, 2019
481371b

Adding in example to report on project violations.

Jul 24, 2019
345d2f2

Merge remote-tracking branch 'upstream/master'

Feb 12, 2020
42b3032

Updates as per review

Feb 12, 2020
bda7092

revert change

Feb 13, 2020
0594ef6

Merge pull request #1 from blackducksoftware/master


jmvanryn Feb 8, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,3 +102,5 @@ venv.bak/

# mypy
.mypy_cache/
/.idea/
/examples/.restconfig.json

27 changes: 27 additions & 0 deletions
blackduck/HubRestApi.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -697,6 +697,7 @@ def get_projects(self, limit=100, parameters={}):
 headers['Accept'] = 'application/vnd.blackducksoftware.project-detail-4+json'
 logger.debug(f"Retrieving projects using url {url}")
 response = requests.get(url, headers=headers, verify = not self.config['insecure'])
 ## @SMELL need to gracfully handle not finding the project
 jsondata = response.json()
 return jsondata

Expand DownExpand Up@@ -1255,6 +1256,32 @@ def get_project_info(self, project_name, link_name):
 else:
 return {} # nada

 def get_project_violation_status(self, project_name, version):

 project = self.get_project_by_name(project_name)
@gsnyder2007gsnyder2007Jul 24, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you consider using self.get_project_version_by_name? would replace use of get_project_by_name and the subsequent code to retrieve the version if present, e.g. this method would then become,
def get_project_violation_status(self, project_name, version):

version = self.get_project_version_by_name(project_name, version)

if version:

return version.get('policyStatus', None)

else:

return "{}:{} not found".format(project_name, version)
or something along those lines?
@jmvanrynjmvanrynFeb 12, 2020

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, well I believe I was looking at it this way because it is a more precise error. If I remember get_project_version_by_name will return a non 200 on both missing projects or versions. and I wanted to tell my users what was missing the project or the version or if the server was just miss-behaving
 if (project is None):
 logging.debug("Project " + project_name + " not found")
 return ("NO_PROJECT")

 link = self.get_link(project, "versions")
 if link:
 response = self.execute_get(link)
 if response.status_code == 200:
 versions_list = json.loads(response.text)
 for version_item in versions_list['items']:
 logging.debug("Got version in file "+version_item['versionName'])
 if version == 'empty':
 version = version_item['versionName']
 if version_item['versionName'] == version:
 logging.debug("Found " + version)
 return version_item['policyStatus']
 else:
 return ("VERSION_NOT_SCANNED")
 else:
 return ("SERVER_NOT_RETURNED_200")
 else:
 return {} # nada

 def get_project_roles(self):
 all_project_roles = self.get_roles(parameters={"filter":"scope:project"})
 return all_project_roles['items']
Expand Down

4 changes: 2 additions & 2 deletions
examples/get_project.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@

project = hub.get_project_by_name(args.project_name)

print(json.dumps(project))
print(json.dumps(project, indent=4, sort_keys=True))

if args.link:
	print(json.dumps(hub.get_project_info(args.project_name, args.link)))
	print(json.dumps(hub.get_project_info(args.project_name, args.link), indent=4))

32 changes: 32 additions & 0 deletions
examples/get_project_violations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
'''
Created on Nov 14, 2018

@author: gsnyder

Print a project given its name

'''

from blackduck.HubRestApi import HubInstance

import argparse
import json

parser = argparse.ArgumentParser(description='Use this to check the status of a given version for a given project. If no version is given then it will return the status of the highest version.')

parser.add_argument("--limit")
parser.add_argument("project_name")
parser.add_argument("--version", default="empty", help="If provided, will result in if that version passed policy check")

args = parser.parse_args()

hub = HubInstance()

status=hub.get_project_violation_status(args.project_name, args.version)
print(status)
if(status == "IN_VIOLATION"):
 exit(0)
elif(status == "NOT_IN_VIOLATION"):
 exit(0)
else:
 exit(0)

10 changes: 5 additions & 5 deletions
examples/purge.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,20 +19,20 @@
print ("total projects found: %s" % projects['totalCount'])

for project in projects['items']:
 print(project['name'])
 print(project['name'])
 versions = hub.get_project_versions(project)
 print("\t versions found %s" % versions['totalCount'])
 print("\t versions found %s" % versions['totalCount'])
 versionlist = versions['items']
 if len(versionlist) == 1:
 continue
 for index in range(len(versionlist) - 1):
 print("index is ".format(index))
 print("index is ".format(index))
 va = versionlist[index]
 components = hub.get_version_components(va)
 codelocations = hub.get_version_codelocations(va)
 # hub.execute_delete(va['_meta']['href'])
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations > 0:
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations['totalCount'] > 0:
Comment thread
jmvanryn marked this conversation as resolved.

 for codelocation in codelocations['items']:
 print (codelocation['_meta']['href'])
 locationid = codelocation['_meta']['href'].split("/")[5]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Adding check for project-version-violations and report back by jmvanryn · Pull Request #55 · blackducksoftware/hub-rest-api-python · GitHub
Skip to content
Adding check for project-version-violations and report back#55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

jmvanryn
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


Adding check for project-version-violations and report back
#55
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2b96b12

Adding in example to report on project violations.

Jul 24, 2019
481371b

Adding in example to report on project violations.

Jul 24, 2019
345d2f2

Merge remote-tracking branch 'upstream/master'

Feb 12, 2020
42b3032

Updates as per review

Feb 12, 2020
bda7092

revert change

Feb 13, 2020
0594ef6

Merge pull request #1 from blackducksoftware/master


jmvanryn Feb 8, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,3 +102,5 @@ venv.bak/

# mypy
.mypy_cache/
/.idea/
/examples/.restconfig.json

27 changes: 27 additions & 0 deletions
blackduck/HubRestApi.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -697,6 +697,7 @@ def get_projects(self, limit=100, parameters={}):
 headers['Accept'] = 'application/vnd.blackducksoftware.project-detail-4+json'
 logger.debug(f"Retrieving projects using url {url}")
 response = requests.get(url, headers=headers, verify = not self.config['insecure'])
 ## @SMELL need to gracfully handle not finding the project
 jsondata = response.json()
 return jsondata

Expand DownExpand Up@@ -1255,6 +1256,32 @@ def get_project_info(self, project_name, link_name):
 else:
 return {} # nada

 def get_project_violation_status(self, project_name, version):

 project = self.get_project_by_name(project_name)
@gsnyder2007gsnyder2007Jul 24, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you consider using self.get_project_version_by_name? would replace use of get_project_by_name and the subsequent code to retrieve the version if present, e.g. this method would then become,
def get_project_violation_status(self, project_name, version):

version = self.get_project_version_by_name(project_name, version)

if version:

return version.get('policyStatus', None)

else:

return "{}:{} not found".format(project_name, version)
or something along those lines?
@jmvanrynjmvanrynFeb 12, 2020

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, well I believe I was looking at it this way because it is a more precise error. If I remember get_project_version_by_name will return a non 200 on both missing projects or versions. and I wanted to tell my users what was missing the project or the version or if the server was just miss-behaving
 if (project is None):
 logging.debug("Project " + project_name + " not found")
 return ("NO_PROJECT")

 link = self.get_link(project, "versions")
 if link:
 response = self.execute_get(link)
 if response.status_code == 200:
 versions_list = json.loads(response.text)
 for version_item in versions_list['items']:
 logging.debug("Got version in file "+version_item['versionName'])
 if version == 'empty':
 version = version_item['versionName']
 if version_item['versionName'] == version:
 logging.debug("Found " + version)
 return version_item['policyStatus']
 else:
 return ("VERSION_NOT_SCANNED")
 else:
 return ("SERVER_NOT_RETURNED_200")
 else:
 return {} # nada

 def get_project_roles(self):
 all_project_roles = self.get_roles(parameters={"filter":"scope:project"})
 return all_project_roles['items']
Expand Down

4 changes: 2 additions & 2 deletions
examples/get_project.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@

project = hub.get_project_by_name(args.project_name)

print(json.dumps(project))
print(json.dumps(project, indent=4, sort_keys=True))

if args.link:
	print(json.dumps(hub.get_project_info(args.project_name, args.link)))
	print(json.dumps(hub.get_project_info(args.project_name, args.link), indent=4))

32 changes: 32 additions & 0 deletions
examples/get_project_violations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
'''
Created on Nov 14, 2018

@author: gsnyder

Print a project given its name

'''

from blackduck.HubRestApi import HubInstance

import argparse
import json

parser = argparse.ArgumentParser(description='Use this to check the status of a given version for a given project. If no version is given then it will return the status of the highest version.')

parser.add_argument("--limit")
parser.add_argument("project_name")
parser.add_argument("--version", default="empty", help="If provided, will result in if that version passed policy check")

args = parser.parse_args()

hub = HubInstance()

status=hub.get_project_violation_status(args.project_name, args.version)
print(status)
if(status == "IN_VIOLATION"):
 exit(0)
elif(status == "NOT_IN_VIOLATION"):
 exit(0)
else:
 exit(0)

10 changes: 5 additions & 5 deletions
examples/purge.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,20 +19,20 @@
print ("total projects found: %s" % projects['totalCount'])

for project in projects['items']:
 print(project['name'])
 print(project['name'])
 versions = hub.get_project_versions(project)
 print("\t versions found %s" % versions['totalCount'])
 print("\t versions found %s" % versions['totalCount'])
 versionlist = versions['items']
 if len(versionlist) == 1:
 continue
 for index in range(len(versionlist) - 1):
 print("index is ".format(index))
 print("index is ".format(index))
 va = versionlist[index]
 components = hub.get_version_components(va)
 codelocations = hub.get_version_codelocations(va)
 # hub.execute_delete(va['_meta']['href'])
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations > 0:
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations['totalCount'] > 0:
Comment thread
jmvanryn marked this conversation as resolved.

 for codelocation in codelocations['items']:
 print (codelocation['_meta']['href'])
 locationid = codelocation['_meta']['href'].split("/")[5]
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Adding check for project-version-violations and report back by jmvanryn · Pull Request #55 · blackducksoftware/hub-rest-api-python · GitHub
Skip to content
Adding check for project-version-violations and report back#55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Open

jmvanryn
wants to merge
6
commits into

base:master
Choose a base branch

from

 Open


Adding check for project-version-violations and report back
#55
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
2b96b12

Adding in example to report on project violations.

Jul 24, 2019
481371b

Adding in example to report on project violations.

Jul 24, 2019
345d2f2

Merge remote-tracking branch 'upstream/master'

Feb 12, 2020
42b3032

Updates as per review

Feb 12, 2020
bda7092

revert change

Feb 13, 2020
0594ef6

Merge pull request #1 from blackducksoftware/master


jmvanryn Feb 8, 2021

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 2 additions & 0 deletions
.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -102,3 +102,5 @@ venv.bak/

# mypy
.mypy_cache/
/.idea/
/examples/.restconfig.json

27 changes: 27 additions & 0 deletions
blackduck/HubRestApi.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -697,6 +697,7 @@ def get_projects(self, limit=100, parameters={}):
 headers['Accept'] = 'application/vnd.blackducksoftware.project-detail-4+json'
 logger.debug(f"Retrieving projects using url {url}")
 response = requests.get(url, headers=headers, verify = not self.config['insecure'])
 ## @SMELL need to gracfully handle not finding the project
 jsondata = response.json()
 return jsondata

Expand DownExpand Up@@ -1255,6 +1256,32 @@ def get_project_info(self, project_name, link_name):
 else:
 return {} # nada

 def get_project_violation_status(self, project_name, version):

 project = self.get_project_by_name(project_name)
@gsnyder2007gsnyder2007Jul 24, 2019

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you consider using self.get_project_version_by_name? would replace use of get_project_by_name and the subsequent code to retrieve the version if present, e.g. this method would then become,
def get_project_violation_status(self, project_name, version):

version = self.get_project_version_by_name(project_name, version)

if version:

return version.get('policyStatus', None)

else:

return "{}:{} not found".format(project_name, version)
or something along those lines?
@jmvanrynjmvanrynFeb 12, 2020

Copy link


Copy Markdown

Author
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, well I believe I was looking at it this way because it is a more precise error. If I remember get_project_version_by_name will return a non 200 on both missing projects or versions. and I wanted to tell my users what was missing the project or the version or if the server was just miss-behaving
 if (project is None):
 logging.debug("Project " + project_name + " not found")
 return ("NO_PROJECT")

 link = self.get_link(project, "versions")
 if link:
 response = self.execute_get(link)
 if response.status_code == 200:
 versions_list = json.loads(response.text)
 for version_item in versions_list['items']:
 logging.debug("Got version in file "+version_item['versionName'])
 if version == 'empty':
 version = version_item['versionName']
 if version_item['versionName'] == version:
 logging.debug("Found " + version)
 return version_item['policyStatus']
 else:
 return ("VERSION_NOT_SCANNED")
 else:
 return ("SERVER_NOT_RETURNED_200")
 else:
 return {} # nada

 def get_project_roles(self):
 all_project_roles = self.get_roles(parameters={"filter":"scope:project"})
 return all_project_roles['items']
Expand Down

4 changes: 2 additions & 2 deletions
examples/get_project.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -34,7 +34,7 @@

project = hub.get_project_by_name(args.project_name)

print(json.dumps(project))
print(json.dumps(project, indent=4, sort_keys=True))

if args.link:
	print(json.dumps(hub.get_project_info(args.project_name, args.link)))
	print(json.dumps(hub.get_project_info(args.project_name, args.link), indent=4))

32 changes: 32 additions & 0 deletions
examples/get_project_violations.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
'''
Created on Nov 14, 2018

@author: gsnyder

Print a project given its name

'''

from blackduck.HubRestApi import HubInstance

import argparse
import json

parser = argparse.ArgumentParser(description='Use this to check the status of a given version for a given project. If no version is given then it will return the status of the highest version.')

parser.add_argument("--limit")
parser.add_argument("project_name")
parser.add_argument("--version", default="empty", help="If provided, will result in if that version passed policy check")

args = parser.parse_args()

hub = HubInstance()

status=hub.get_project_violation_status(args.project_name, args.version)
print(status)
if(status == "IN_VIOLATION"):
 exit(0)
elif(status == "NOT_IN_VIOLATION"):
 exit(0)
else:
 exit(0)

10 changes: 5 additions & 5 deletions
examples/purge.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -19,20 +19,20 @@
print ("total projects found: %s" % projects['totalCount'])

for project in projects['items']:
 print(project['name'])
 print(project['name'])
 versions = hub.get_project_versions(project)
 print("\t versions found %s" % versions['totalCount'])
 print("\t versions found %s" % versions['totalCount'])
 versionlist = versions['items']
 if len(versionlist) == 1:
 continue
 for index in range(len(versionlist) - 1):
 print("index is ".format(index))
 print("index is ".format(index))
 va = versionlist[index]
 components = hub.get_version_components(va)
 codelocations = hub.get_version_codelocations(va)
 # hub.execute_delete(va['_meta']['href'])
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations > 0:
 print("version {} has {} codelocations".format(va['versionName'], codelocations['totalCount']))
 if codelocations['totalCount'] > 0:
Comment thread
jmvanryn marked this conversation as resolved.

 for codelocation in codelocations['items']:
 print (codelocation['_meta']['href'])
 locationid = codelocation['_meta']['href'].split("/")[5]
Expand Down