YunoHost/package_linter
1
0
Fork 0
mirror of https://github.com/YunoHost/package_linter.git synced 2024-09-03 20:06:12 +02:00
Code Issues Projects Releases Packages Wiki Activity

Move general checks as methods of App class

Browse source
This commit is contained in:
Alexandre Aubin 2019-03-02 01:43:29 +01:00
parent a0e435c271
commit 0c4e86d098
1 changed files with 185 additions and 185 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

370
package_linter.py
View file

@ -93,212 +93,223 @@ class App():
self.scripts = { f: Script(self.path, f) for f in scripts } self.scripts = { f: Script(self.path, f) for f in scripts }
def misc_file_checks(app_path): def analyze(self):
print_header("MISC FILE CHECKS") self.misc_file_checks()
self.check_source_management()
self.check_manifest()
# for script in self.scripts.values():
# Check for recommended and mandatory files if script.exists:
# script.analyze()
filenames = ("manifest.json", "LICENSE", "README.md",
"scripts/install", "scripts/remove",
"scripts/upgrade",
"scripts/backup", "scripts/restore")
non_mandatory = ("script/backup", "script/restore")
for filename in filenames:
if file_exists(app_path + "/" + filename):
continue
elif filename in non_mandatory:
print_warning("Consider adding a file %s" % filename)
else:
print_error("File %s is mandatory" % filename)
#
# Deprecated php-fpm.ini thing
#
if file_exists(app_path + "/conf/php-fpm.ini"):
print_warning("Using a separate php-fpm.ini file is deprecated. Please merge your php-fpm directives directly in the pool file. (c.f. https://github.com/YunoHost-Apps/nextcloud_ynh/issues/138 )")
#
# Deprecated usage of 'add_header' in nginx conf
#
for filename in os.listdir(app_path + "/conf"):
if not os.path.isfile(filename):
continue
content = open(app_path + "/conf/" + filename).read()
if "location" in content and "add_header" in content:
print_warning("Do not use 'add_header' in the nginx conf. Use 'more_set_headers' instead. (See https://www.peterbe.com/plog/be-very-careful-with-your-add_header-in-nginx and https://github.com/openresty/headers-more-nginx-module#more_set_headers )")
def check_source_management(app_path): def misc_file_checks(self):
print_header("SOURCES MANAGEMENT")
DIR = os.path.join(app_path, "sources") print_header("MISC FILE CHECKS")
# Check if there is more than six files on 'sources' folder
if os.path.exists(os.path.join(app_path, "sources")) \ #
and len([name for name in os.listdir(DIR) if os.path.isfile(os.path.join(DIR, name))]) > 5: # Check for recommended and mandatory files
print_warning("[YEP-3.3] Upstream app sources shouldn't be stored on this " #
"'sources' folder of this git repository as a copy/paste."
"\nAt installation, the package should download sources " filenames = ("manifest.json", "LICENSE", "README.md",
"from upstream via 'ynh_setup_source'.\nSee the helper" "scripts/install", "scripts/remove",
"documentation. Original discussion happened here : " "scripts/upgrade",
"https://github.com/YunoHost/issues/issues/201#issuecomment-391549262") "scripts/backup", "scripts/restore")
non_mandatory = ("script/backup", "script/restore")
for filename in filenames:
if file_exists(self.path + "/" + filename):
continue
elif filename in non_mandatory:
print_warning("Consider adding a file %s" % filename)
else:
print_error("File %s is mandatory" % filename)
#
# Deprecated php-fpm.ini thing
#
if file_exists(self.path + "/conf/php-fpm.ini"):
print_warning("Using a separate php-fpm.ini file is deprecated. Please merge your php-fpm directives directly in the pool file. (c.f. https://github.com/YunoHost-Apps/nextcloud_ynh/issues/138 )")
#
# Deprecated usage of 'add_header' in nginx conf
#
for filename in os.listdir(self.path + "/conf"):
if not os.path.isfile(filename):
continue
content = open(self.path + "/conf/" + filename).read()
if "location" in content and "add_header" in content:
print_warning("Do not use 'add_header' in the nginx conf. Use 'more_set_headers' instead. (See https://www.peterbe.com/plog/be-very-careful-with-your-add_header-in-nginx and https://github.com/openresty/headers-more-nginx-module#more_set_headers )")
def check_manifest(path): def check_source_management(self):
manifest = os.path.join(path, 'manifest.json') print_header("SOURCES MANAGEMENT")
if not os.path.exists(manifest): DIR = os.path.join(self.path, "sources")
return # Check if there is more than six files on 'sources' folder
print_header("MANIFEST") if os.path.exists(os.path.join(self.path, "sources")) \
""" and len([name for name in os.listdir(DIR) if os.path.isfile(os.path.join(DIR, name))]) > 5:
Check if there is no comma syntax issue print_warning("[YEP-3.3] Upstream app sources shouldn't be stored on this "
""" "'sources' folder of this git repository as a copy/paste."
"\nAt installation, the package should download sources "
"from upstream via 'ynh_setup_source'.\nSee the helper"
"documentation. Original discussion happened here : "
"https://github.com/YunoHost/issues/issues/201#issuecomment-391549262")
try:
with open(manifest, encoding='utf-8') as data_file:
manifest = json.loads(data_file.read())
except:
print_error("[YEP-2.1] Syntax (comma) or encoding issue with manifest.json. "
"Can't check file.")
fields = ("name", "id", "packaging_format", "description", "url", "version", def check_manifest(self):
"license", "maintainer", "requirements", "multi_instance", manifest = os.path.join(self.path, 'manifest.json')
"services", "arguments") if not os.path.exists(manifest):
return
print_header("MANIFEST")
"""
Check if there is no comma syntax issue
"""
for field in fields: try:
if field not in manifest: with open(manifest, encoding='utf-8') as data_file:
print_warning("[YEP-2.1] \"" + field + "\" field is missing") manifest = json.loads(data_file.read())
except:
print_error("[YEP-2.1] Syntax (comma) or encoding issue with manifest.json. "
"Can't check file.")
""" fields = ("name", "id", "packaging_format", "description", "url", "version",
Check values in keys "license", "maintainer", "requirements", "multi_instance",
""" "services", "arguments")
if "packaging_format" not in manifest: for field in fields:
print_error("[YEP-2.1] \"packaging_format\" key is missing") if field not in manifest:
elif not isinstance(manifest["packaging_format"], int): print_warning("[YEP-2.1] \"" + field + "\" field is missing")
print_error("[YEP-2.1] \"packaging_format\": value isn't an integer type")
elif manifest["packaging_format"] != 1:
print_error("[YEP-2.1] \"packaging_format\" field: current format value is '1'")
# YEP 1.1 Name is app """
if "id" in manifest: Check values in keys
if not re.match('^[a-z1-9]((_|-)?[a-z1-9])+$', manifest["id"]): """
print_error("[YEP-1.1] 'id' field '%s' should respect this regex "
"'^[a-z1-9]((_|-)?[a-z1-9])+$'")
if "name" in manifest: if "packaging_format" not in manifest:
if len(manifest["name"]) > 22: print_error("[YEP-2.1] \"packaging_format\" key is missing")
print_warning("[YEP-1.1] The 'name' field shouldn't be too long to be" elif not isinstance(manifest["packaging_format"], int):
" able to be with one line in the app list. The most " print_error("[YEP-2.1] \"packaging_format\": value isn't an integer type")
"current bigger name is actually compound of 22 characters.") elif manifest["packaging_format"] != 1:
print_error("[YEP-2.1] \"packaging_format\" field: current format value is '1'")
# YEP 1.2 Put the app in a weel known repo # YEP 1.1 Name is app
if "id" in manifest: if "id" in manifest:
official_list_url = "https://raw.githubusercontent.com/YunoHost/apps/master/official.json" if not re.match('^[a-z1-9]((_|-)?[a-z1-9])+$', manifest["id"]):
official_list = json.loads(urlopen(official_list_url)['content']) print_error("[YEP-1.1] 'id' field '%s' should respect this regex "
community_list_url = "https://raw.githubusercontent.com/YunoHost/apps/master/community.json" "'^[a-z1-9]((_|-)?[a-z1-9])+$'")
community_list = json.loads(urlopen(community_list_url)['content'])
if manifest["id"] not in official_list and manifest["id"] not in community_list:
print_warning("[YEP-1.2] This app is not registered in official or community applications")
# YEP 1.3 License if "name" in manifest:
def license_mentionned_in_readme(path): if len(manifest["name"]) > 22:
readme_path = os.path.join(path, 'README.md') print_warning("[YEP-1.1] The 'name' field shouldn't be too long to be"
if os.path.isfile(readme_path): " able to be with one line in the app list. The most "
return "LICENSE" in open(readme_path).read() "current bigger name is actually compound of 22 characters.")
return False
if "license" in manifest: # YEP 1.2 Put the app in a weel known repo
for license in manifest['license'].replace('&', ',').split(','): if "id" in manifest:
code_license = '<code property="spdx:licenseId">' + license + '</code>' official_list_url = "https://raw.githubusercontent.com/YunoHost/apps/master/official.json"
link = "https://spdx.org/licenses/" official_list = json.loads(urlopen(official_list_url)['content'])
if license == "nonfree": community_list_url = "https://raw.githubusercontent.com/YunoHost/apps/master/community.json"
print_warning("[YEP-1.3] The correct value for non free license in license" community_list = json.loads(urlopen(community_list_url)['content'])
" field is 'non-free' and not 'nonfree'") if manifest["id"] not in official_list and manifest["id"] not in community_list:
license = "non-free" print_warning("[YEP-1.2] This app is not registered in official or community applications")
if license in ["free", "non-free", "dep-non-free"]:
if not license_mentionned_in_readme(path):
print_warning("[YEP-1.3] The use of '%s' in license field implies to "
"write something about the license in your "
"README.md" % (license))
if license in ["non-free", "dep-non-free"]:
print_warning("[YEP-1.3] 'non-free' apps can't be officialized."
"Their integration is still being discussed,"
"especially for apps with non-free dependencies")
elif code_license not in urlopen(link)['content']:
print_warning("[YEP-1.3] The license '%s' is not registered in "
"https://spdx.org/licenses/ . It can be a typo error. "
"If not, you should replace it by 'free' or 'non-free'"
"and give some explanations in the README.md." % (license))
# YEP 1.4 Inform if we continue to maintain the app # YEP 1.3 License
# YEP 1.5 Update regularly the app status def license_mentionned_in_readme():
# YEP 1.6 Check regularly the evolution of the upstream readme_path = os.path.join(path, 'README.md')
if os.path.isfile(readme_path):
return "LICENSE" in open(readme_path).read()
return False
# YEP 1.7 - Add an app to the YunoHost-Apps organization if "license" in manifest:
if "id" in manifest: for license in manifest['license'].replace('&', ',').split(','):
repo = "https://github.com/YunoHost-Apps/%s_ynh" % (manifest["id"]) code_license = '<code property="spdx:licenseId">' + license + '</code>'
is_not_added_to_org = urlopen(repo)['code'] == 404 link = "https://spdx.org/licenses/"
if license == "nonfree":
print_warning("[YEP-1.3] The correct value for non free license in license"
" field is 'non-free' and not 'nonfree'")
license = "non-free"
if license in ["free", "non-free", "dep-non-free"]:
if not license_mentionned_in_readme(self.path):
print_warning("[YEP-1.3] The use of '%s' in license field implies to "
"write something about the license in your "
"README.md" % (license))
if license in ["non-free", "dep-non-free"]:
print_warning("[YEP-1.3] 'non-free' apps can't be officialized."
"Their integration is still being discussed,"
"especially for apps with non-free dependencies")
elif code_license not in urlopen(link)['content']:
print_warning("[YEP-1.3] The license '%s' is not registered in "
"https://spdx.org/licenses/ . It can be a typo error. "
"If not, you should replace it by 'free' or 'non-free'"
"and give some explanations in the README.md." % (license))
if is_not_added_to_org: # YEP 1.4 Inform if we continue to maintain the app
print_warning("[YEP-1.7] You should add your app in the " # YEP 1.5 Update regularly the app status
"YunoHost-Apps organisation.") # YEP 1.6 Check regularly the evolution of the upstream
# YEP 1.8 Publish test request # YEP 1.7 - Add an app to the YunoHost-Apps organization
# YEP 1.9 Document app if "id" in manifest:
if "description" in manifest: repo = "https://github.com/YunoHost-Apps/%s_ynh" % (manifest["id"])
descr = manifest["description"] is_not_added_to_org = urlopen(repo)['code'] == 404
if isinstance(descr, dict):
descr = descr.get("en", None)
if descr is None or descr == manifest.get("name", None): if is_not_added_to_org:
print_warning("[YEP-1.9] You should write a good description of the app, at least in english (1 line is enough).") print_warning("[YEP-1.7] You should add your app in the "
"YunoHost-Apps organisation.")
elif "for yunohost" in descr.lower(): # YEP 1.8 Publish test request
print_warning("[YEP-1.9] The 'description' should explain what the app actually does. No need to say that it is 'for YunoHost' - this is a YunoHost app so of course we know it is for YunoHost ;-).") # YEP 1.9 Document app
if "description" in manifest:
descr = manifest["description"]
if isinstance(descr, dict):
descr = descr.get("en", None)
# TODO test a specific template in README.md if descr is None or descr == manifest.get("name", None):
print_warning("[YEP-1.9] You should write a good description of the app, at least in english (1 line is enough).")
# YEP 1.10 Garder un historique de version propre elif "for yunohost" in descr.lower():
print_warning("[YEP-1.9] The 'description' should explain what the app actually does. No need to say that it is 'for YunoHost' - this is a YunoHost app so of course we know it is for YunoHost ;-).")
# YEP 1.11 Cancelled # TODO test a specific template in README.md
# YEP 2.1 # YEP 1.10 Garder un historique de version propre
if "multi_instance" in manifest and manifest["multi_instance"] != 1 and manifest["multi_instance"] != 0:
print_error(
"[YEP-2.1] \"multi_instance\" field must be boolean type values 'true' or 'false' and not string type")
if "services" in manifest: # YEP 1.11 Cancelled
services = ("nginx", "mysql", "uwsgi", "metronome",
"php5-fpm", "php7.0-fpm", "php-fpm",
"postfix", "dovecot", "rspamd")
for service in manifest["services"]: # YEP 2.1
if service not in services: if "multi_instance" in manifest and manifest["multi_instance"] != 1 and manifest["multi_instance"] != 0:
# FIXME : wtf is it supposed to mean ... print_error(
print_warning("[YEP-2.1] " + service + " service may not exist") "[YEP-2.1] \"multi_instance\" field must be boolean type values 'true' or 'false' and not string type")
if "install" in manifest["arguments"]: if "services" in manifest:
services = ("nginx", "mysql", "uwsgi", "metronome",
"php5-fpm", "php7.0-fpm", "php-fpm",
"postfix", "dovecot", "rspamd")
recognized_types = ("domain", "path", "boolean", "app", "password", "user", "string") for service in manifest["services"]:
if service not in services:
# FIXME : wtf is it supposed to mean ...
print_warning("[YEP-2.1] " + service + " service may not exist")
for argument in manifest["arguments"]["install"]: if "install" in manifest["arguments"]:
if "type" not in argument.keys():
print_warning("[YEP-2.1] You should specify the type of the argument '%s'. You can use : %s." % (argument["name"], ', '.join(recognized_types)))
elif argument["type"] not in recognized_types:
print_warning("[YEP-2.1] The type '%s' for argument '%s' is not recognized... it probably doesn't behave as you expect ? Choose among those instead : %s" % (argument["type"], argument["name"], ', '.join(recognized_types)))
if "choices" in argument.keys(): recognized_types = ("domain", "path", "boolean", "app", "password", "user", "string")
choices = [c.lower() for c in argument["choices"]]
if len(choices) == 2:
if ("true" in choices and "false" in choices) or ("yes" in choices and "no" in choices):
print_warning("Argument %s : you might want to simply use a boolean-type argument. No need to specify the choices list yourself." % argument["name"])
if "url" in manifest and manifest["url"].endswith("_ynh"): for argument in manifest["arguments"]["install"]:
print_warning("'url' is not meant to be the url of the yunohost package, but rather the website or repo of the upstream app itself...") if "type" not in argument.keys():
print_warning("[YEP-2.1] You should specify the type of the argument '%s'. You can use : %s." % (argument["name"], ', '.join(recognized_types)))
elif argument["type"] not in recognized_types:
print_warning("[YEP-2.1] The type '%s' for argument '%s' is not recognized... it probably doesn't behave as you expect ? Choose among those instead : %s" % (argument["type"], argument["name"], ', '.join(recognized_types)))
if "choices" in argument.keys():
choices = [c.lower() for c in argument["choices"]]
if len(choices) == 2:
if ("true" in choices and "false" in choices) or ("yes" in choices and "no" in choices):
print_warning("Argument %s : you might want to simply use a boolean-type argument. No need to specify the choices list yourself." % argument["name"])
if "url" in manifest and manifest["url"].endswith("_ynh"):
print_warning("'url' is not meant to be the url of the yunohost package, but rather the website or repo of the upstream app itself...")
def check_verifications_done_before_modifying_system(script): def check_verifications_done_before_modifying_system(script):
@ -469,18 +480,7 @@ def main():
app_path = sys.argv[1] app_path = sys.argv[1]
header(app_path) header(app_path)
App(app_path).analyze()
# Global checks
app = App(app_path)
misc_file_checks(app_path)
check_source_management(app_path)
check_manifest(app_path)
# Scripts checks
for script in app.scripts.values():
if script.exists:
script.analyze()
sys.exit(return_code) sys.exit(return_code)