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

Merge pull request #88 from YunoHost/small-typos

Browse source 
Update package_linter.py
This commit is contained in:
Alexandre Aubin 2020-12-05 15:54:49 +01:00 committed by GitHub
commit 371237c093
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 30 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
package_linter.py
View file

@ -738,7 +738,7 @@ class Configurations(TestSuite):
content = open(app.path + "/conf/" + filename).read()
if "location" in content and "add_header" in content:
yield Error(
"Do not use 'add_header' in the nginx conf. Use 'more_set_headers' instead. "
"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 )"
)
@ -764,7 +764,7 @@ class Configurations(TestSuite):
if any(not right_syntax(line) for line in more_set_headers_lines):
yield Warning(
"It looks like the syntax for the more_set_headers "
"instruction is incorrect in the nginx conf (N.B. "
"instruction is incorrect in the NGINX conf (N.B. "
": it's different than the add_header syntax!)... "
"The syntax should look like: "
"more_set_headers \"Header-Name: value\""
@ -837,22 +837,22 @@ class Configurations(TestSuite):
_print("Failed :[ : %s" % str(e))
if not do_path_traversal_check:
_print("N.B.: The package linter need you to run 'pip3 install pyparsing six' if you want it to be able to check for path traversal issue in nginx confs")
_print("N.B.: The package linter need you to run 'pip3 install pyparsing six' if you want it to be able to check for path traversal issue in NGINX confs")
if do_path_traversal_check:
from lib.nginxparser import nginxparser
try:
nginxconf = nginxparser.load(open(app.path + "/conf/" + filename))
except Exception as e:
_print("Could not parse nginx conf ... : " + str(e))
_print("Could not parse NGINX conf...: " + str(e))
nginxconf = []
for location in find_path_traversal_issue(nginxconf):
yield Error(
"The nginx configuration (especially location %s) "
"The NGINX configuration (especially location %s) "
"appears vulnerable to path traversal issues as explained in\n"
" https://www.acunetix.com/vulnerabilities/web/path-traversal-via-misconfigured-nginx-alias/\n"
" To fix it, look at the first lines of the nginx conf of the example app : \n"
" To fix it, look at the first lines of the NGINX conf of the example app : \n"
" https://github.com/YunoHost/example_ynh/blob/master/conf/nginx.conf" % location
)
@ -914,7 +914,7 @@ class Manifest(TestSuite):
def yunohost_version_requirement(self):
if not self.manifest.get("requirements", {}).get("yunohost", ""):
yield Critical("You should add a yunohost version requirement in the manifest")
yield Critical("You should add a YunoHost version requirement in the manifest")
@test()
def yunohost_version_requirement_superold(app):
@ -939,7 +939,7 @@ class Manifest(TestSuite):
if "license" not in self.manifest:
return
# Turns out there may be multiple licenses ... (c.f. seafile)
# Turns out there may be multiple licenses... (c.f. Seafile)
licenses = self.manifest["license"].split(",")
for license in licenses:
@ -1005,7 +1005,7 @@ class Manifest(TestSuite):
def url(self):
if self.manifest.get("url", "").endswith("_ynh"):
yield Info(
"'url' is not meant to be the url of the yunohost package, "
"'url' is not meant to be the URL of the YunoHost package, "
"but rather the website or repo of the upstream app itself..."
)
@ -1135,7 +1135,7 @@ class AppCatalog(TestSuite):
if repo_url.lower() not in [repo_org.lower(), repo_brique.lower()]:
if repo_url.lower().startswith("https://github.com/YunoHost-Apps/"):
yield Warning("The url for this app in the catalog should be %s" % repo_org)
yield Warning("The URL for this app in the catalog should be %s" % repo_org)
else:
yield Warning("Consider adding your app to the YunoHost-Apps organization to allow the community to contribute more easily")
@ -1337,14 +1337,14 @@ class Script(TestSuite):
yield Warning(
"Argument --installed ain't needed anymore when using "
"'yunohost app list'. It directly returns the list of installed "
"apps.. Also beware that option -f is obsolete as well .. "
"apps.. Also beware that option -f is obsolete as well... "
"Use grep -q 'id: $appname' to check a specific app is installed"
)
@test()
def normalize_url_path(self):
if self.contains("ynh_normalize_url_path"):
yield Info("You probably don't need to call ynh_normalize_url_path ... this is only relevant for upgrades from super-old versions (like 3 years ago or so...)")
yield Info("You probably don't need to call 'ynh_normalize_url_path'... this is only relevant for upgrades from super-old versions (like 3 years ago or so...)")
@test()
def safe_rm(self):
@ -1355,7 +1355,7 @@ class Script(TestSuite):
def nginx_restart(self):
if self.contains("systemctl restart nginx") or self.contains("service nginx restart"):
yield Error(
"Restarting nginx is quite dangerous (especially for web installs) "
"Restarting NGINX is quite dangerous (especially for web installs) "
"and should be avoided at all cost. Use 'reload' instead."
)
@ -1396,7 +1396,7 @@ class Script(TestSuite):
or (os.path.exists(self.app_path + "/scripts/_common.sh") and "/etc/apt/sources.list" in open(self.app_path+"/scripts/_common.sh").read() and "ynh_add_repo" not in open(self.app_path+"/scripts/_common.sh").read()):
yield Error(
"Manually messing with apt's sources.lists is strongly discouraged "
"and should be avoided. Please use ynh_install_extra_app_dependencies is you "
"and should be avoided. Please use 'ynh_install_extra_app_dependencies' if you "
"need to install dependencies from a custom apt repo."
)
@ -1463,8 +1463,8 @@ class Script(TestSuite):
yield Info(
"We recommend to *not* use 'ynh_script_progression' in backup "
"scripts because no actual work happens when running the script "
" : yunohost only fetches the list of things to backup (apart "
"from the DB dumps which effectively happens during the script..). "
" : YunoHost only fetches the list of things to backup (apart "
"from the DB dumps which effectively happens during the script...). "
"Consider using a simple message like this instead: 'ynh_print_info \"Declaring files to be backed up...\"'"
)
@ -1501,7 +1501,7 @@ class Script(TestSuite):
@test(only=["install", "_common.sh"])
def php_deps(self):
if self.containsregex("dependencies.*php-"):
yield Warning("You should avoid having dependencies like 'php-foobar'. Instead, specify the exact version you want like 'php7.0-foobar'. Otherwise, the *wrong* version of the dependency may be installed if sury is also installed. Note that for Stretch/Buster/Bullseye/... transition, Yunohost will automatically patch your file so there's no need to care about that.")
yield Warning("You should avoid having dependencies like 'php-foobar'. Instead, specify the exact version you want like 'php7.0-foobar'. Otherwise, the *wrong* version of the dependency may be installed if sury is also installed. Note that for Stretch/Buster/Bullseye/... transition, YunoHost will automatically patch your file so there's no need to care about that.")
@test(only=["backup"])
def systemd_during_backup(self):