Skip to content
This repository was archived by the owner on Oct 21, 2022. It is now read-only.

Set status to UNKNOWN when package is not in whitelist #185

Merged
liyanhui1228 merged 7 commits into from
Nov 17, 2018
Merged

Set status to UNKNOWN when package is not in whitelist #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d5bfe7c
Set status to UNKNOWN when package not in whitelist
liyanhui1228 Nov 16, 2018
5393a87
Add tests
liyanhui1228 Nov 16, 2018
6d09b8e
return unknown as soon as possible
liyanhui1228 Nov 16, 2018
23409a2
update tests
liyanhui1228 Nov 17, 2018
83d1e22
Merge branch 'master' into unknown_deps
liyanhui1228 Nov 17, 2018
8eda99a
update
liyanhui1228 Nov 17, 2018
007db17
Merge branch 'unknown_deps' of https://github.com/liyanhui1228/cloud-…
liyanhui1228 Nov 17, 2018
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
158 changes: 81 additions & 77 deletions badge_server/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
from compatibility_lib import dependency_highlighter
from compatibility_lib import deprecated_dep_finder
from compatibility_lib import package as package_module
from compatibility_lib import utils


app = flask.Flask(__name__)
Expand Down Expand Up @@ -97,46 +98,20 @@
'CONVERSION_ERROR': 'orange',
}

DEFAULT_COMPATIBILITY_RESULT = {
'py2': {
'status': 'CALCULATING',
'details': {},
},
'py3': {
'status': 'CALCULATING',
'details': {},
}
}

DEFAULT_DEPENDENCY_RESULT = {
'status': 'CALCULATING',
'details': {},
}

CONVERSION_ERROR_RES = {
'py2': {
'status': 'CONVERSION_ERROR',
'details': None,
},
'py3': {
'status': 'CONVERSION_ERROR',
'details': None,
}
}

DEP_STATUS_COLOR_MAPPING = {
'CALCULATING': 'blue',
'CONVERSION_ERROR': 'purple',
'UNKNOWN': 'purple',
priority_level.UP_TO_DATE.name: 'green',
priority_level.LOW_PRIORITY.name: 'yellow',
priority_level.HIGH_PRIORITY.name: 'red'
}

DEP_CONVERSION_ERROR_RES = {
'status': 'CONVERSION_ERROR',
'details': None,
}

GITHUB_HEAD_NAME = 'github head'

SVG_CONTENT_TYPE = 'image/svg+xml'
Expand All @@ -148,7 +123,27 @@
GOOGLE_COMP_BADGE = 'google_comp_badge'
API_BADGE = 'api_badge'

CACHED_PACKAGES = configs.PKG_LIST + configs.THIRD_PARTY_PACKAGE_LIST
PACKAGE_NOT_SUPPORTED = "The package is not supported by checker server."


def _build_result(status, details):
"""Build the default result for different conditions."""
result = {
'py2': {
'status': 'CALCULATING',
'details': {},
},
'py3': {
'status': 'CALCULATING',
'details': {},
}
}
result['py2']['status'] = status
result['py3']['status'] = status
result['py2']['details'] = details
result['py3']['details'] = details

return result


def _get_pair_status_for_packages(pkg_sets):
Expand Down Expand Up @@ -216,27 +211,39 @@ def _get_badge(res, badge_name):


def _get_self_compatibility_from_cache(package_name):
result_dict = CACHE.get(
'{}_self_comp_badge'.format(package_name))
if not utils._is_package_in_whitelist([package_name]):
result_dict = _build_result('UNKNOWN', PACKAGE_NOT_SUPPORTED)
else:
result_dict = CACHE.get(
'{}_self_comp_badge'.format(package_name))

if result_dict is None:
result_dict = DEFAULT_COMPATIBILITY_RESULT
result_dict = _build_result('CALCULATING', {})
return result_dict


def _get_google_compatibility_from_cache(package_name):
result_dict = CACHE.get(
'{}_google_comp_badge'.format(package_name))
if not utils._is_package_in_whitelist([package_name]):
result_dict = _build_result('UNKNOWN', {})
else:
result_dict = CACHE.get(
'{}_google_comp_badge'.format(package_name))

if result_dict is None:
result_dict = DEFAULT_COMPATIBILITY_RESULT
result_dict = _build_result('CALCULATING', {})

return result_dict


def _get_dependency_result_from_cache(package_name):
result_dict = CACHE.get(
'{}_dependency_badge'.format(package_name))
if not utils._is_package_in_whitelist([package_name]):
result_dict = {
'status': 'UNKNOWN',
'details': PACKAGE_NOT_SUPPORTED,
}
else:
result_dict = CACHE.get(
'{}_dependency_badge'.format(package_name))

if result_dict is None:
result_dict = DEFAULT_DEPENDENCY_RESULT
Expand All @@ -259,6 +266,12 @@ def _get_all_results_from_cache(package_name):
dependency_res['status']
):
status = 'CALCULATING'
elif 'UNKNOWN' in (
self_compat_res['py3']['status'],
google_compat_res['py3']['status'],
dependency_res['status']
):
status = 'UNKNOWN'
else:
status = 'CHECK_WARNING'

Expand Down Expand Up @@ -345,16 +358,7 @@ def self_compatibility_badge_image():
if badge_name is None:
badge_name = 'self compatibility'

version_and_res = {
'py2': {
'status': 'CALCULATING',
'details': None,
},
'py3': {
'status': 'CALCULATING',
'details': None,
}
}
version_and_res = _build_result('CALCULATING', None)

def run_check():
# First see if this package is already stored in BigQuery.
Expand Down Expand Up @@ -387,19 +391,18 @@ def run_check():
CACHE.set(
'{}_self_comp_badge'.format(package_name), version_and_res)

self_comp_res = CACHE.get(
'{}_self_comp_badge'.format(package_name))
if not utils._is_package_in_whitelist([package_name]):
self_comp_res = _build_result('UNKNOWN', PACKAGE_NOT_SUPPORTED)
else:
self_comp_res = CACHE.get('{}_self_comp_badge'.format(package_name))

if self_comp_res is None:
details = version_and_res
else:
details = self_comp_res

# Run the check if there is not cached result or forced to populate the
# cache or package not in cached package list.
if self_comp_res is None or \
force_run_check is not None or \
package_name not in CACHED_PACKAGES:
# Run the check if forced to populate the cache.
if force_run_check is not None:
threading.Thread(target=run_check).start()

badge = _get_badge(details, badge_name)
Expand Down Expand Up @@ -447,15 +450,16 @@ def self_dependency_badge_image():
if badge_name is None:
badge_name = 'dependency status'

res = {
'status': 'CALCULATING',
'details': {},
}

def run_check():
res = {
'status': 'CALCULATING',
'details': {},
}
details = {}
outdated = highlighter.check_package(package_name)
deprecated_deps_list = finder.get_deprecated_dep(package_name)[1]
deprecated_deps = ', '.join(deprecated_deps_list)
details = {}

max_level = priority_level.UP_TO_DATE
for dep in outdated:
Expand All @@ -468,28 +472,28 @@ def run_check():
dep_detail['priority'] = dep.priority.level.name
dep_detail['detail'] = dep.priority.details
details[dep.name] = dep_detail

res['status'] = max_level.name
res['details'] = details
res['deprecated_deps'] = deprecated_deps
res['status'] = max_level.name
res['details'] = details
res['deprecated_deps'] = deprecated_deps

# Write the result to Cloud Datastore
CACHE.set(
'{}_dependency_badge'.format(package_name), res)

dependency_res = CACHE.get(
'{}_dependency_badge'.format(package_name))
if not utils._is_package_in_whitelist([package_name]):
res['status'] = 'UNKNOWN'
dependency_res = res
else:
dependency_res = CACHE.get(
'{}_dependency_badge'.format(package_name))

if dependency_res is None:
details = DEFAULT_DEPENDENCY_RESULT
else:
details = dependency_res

# Run the check if there is not cached result or forced to populate the
# cache or package not in cached package list.
if dependency_res is None or \
force_run_check is not None or \
package_name not in CACHED_PACKAGES:
# Run the check if forced to populate the cache.
if force_run_check is not None:
threading.Thread(target=run_check).start()

badge = _get_badge(details, badge_name)
Expand Down Expand Up @@ -581,18 +585,18 @@ def run_check():
google_comp_res = CACHE.get(
'{}_google_comp_badge'.format(package_name))

if not utils._is_package_in_whitelist([package_name]):
google_comp_res = _build_result('UNKNOWN', {})

if google_comp_res is None:
details = DEFAULT_COMPATIBILITY_RESULT
else:
details = google_comp_res
google_comp_res = _build_result('CALCULATING', {})

# Run the check if there is not cached result or forced to populate the
# cache or package not in cached package list.
if google_comp_res is None or \
force_run_check is not None or \
package_name not in CACHED_PACKAGES:
# Run the check if forced to populate the cache.
if force_run_check is not None:
threading.Thread(target=run_check).start()

details = google_comp_res

badge = _get_badge(details, badge_name)
response = flask.make_response(badge)
response.content_type = SVG_CONTENT_TYPE
Expand Down
14 changes: 8 additions & 6 deletions compatibility_lib/compatibility_lib/compatibility_checker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,10 @@
import retrying

from compatibility_lib import configs
from compatibility_lib import utils

SERVER_URL = 'http://104.197.8.72'

PACKAGE_NOT_IN_WHITELIST = 'Request contains third party github head packages.'

UNKNOWN_STATUS_RESULT = {
'result': 'UNKNOWN',
}
Expand All @@ -38,16 +37,19 @@ def __init__(self, max_workers=20):

def check(self, packages, python_version):
"""Call the checker server to get back status results."""
if not utils._is_package_in_whitelist(packages):

UNKNOWN_STATUS_RESULT['packages'] = packages
UNKNOWN_STATUS_RESULT['description'] = 'Package is not supported' \
' by our checker server.'
return UNKNOWN_STATUS_RESULT

data = {
'python-version': python_version,
'package': packages
}
result = requests.get(SERVER_URL, params=data)
content = result.content.decode('utf-8')
if content == PACKAGE_NOT_IN_WHITELIST:
UNKNOWN_STATUS_RESULT['packages'] = packages
UNKNOWN_STATUS_RESULT['description'] = PACKAGE_NOT_IN_WHITELIST
return UNKNOWN_STATUS_RESULT

return json.loads(content)

Expand Down
1 change: 1 addition & 0 deletions compatibility_lib/compatibility_lib/dependency_highlighter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ def check_package(self, package_name):
"""
dependency_info = self._dependency_info_getter.get_dependency_info(
package_name)

outdated_dependencies = []
for name, info in dependency_info.items():
if name in configs.IGNORED_DEPENDENCIES:
Expand Down
4 changes: 1 addition & 3 deletions compatibility_lib/compatibility_lib/test_compatibility_checker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@
class TestCompatibilityChecker(unittest.TestCase):

def test_check(self):
import json

checker = compatibility_checker.CompatibilityChecker()

packages = 'test_pkg'
packages = ['opencensus']
python_version = 3
expected_server_url = 'http://104.197.8.72'

Expand Down
Loading