mirror of
https://github.com/YunoHost/package_linter.git
synced 2024-09-03 20:06:12 +02:00
[mod] autopep8: two tabs converted to four spaces.
This commit is contained in:
Moul
parent
141b9284cb
commit
5dad4c184c
1 changed files with 179 additions and 132 deletions
|
|
@ -4,6 +4,7 @@ import sys
|
|||
import os
|
||||
import json
|
||||
|
||||
|
||||
class c:
|
||||
HEADER = '\033[95m'
|
||||
OKBLUE = '\033[94m'
|
||||
|
|
@ -14,41 +15,51 @@ class c:
|
|||
BOLD = '\033[1m'
|
||||
UNDERLINE = '\033[4m'
|
||||
|
||||
|
||||
def header(app_path):
|
||||
print(c.UNDERLINE + c.HEADER + c.BOLD + "YUNOHOST APP PACKAGE LINTER\n" + c.END)
|
||||
print(c.UNDERLINE + c.HEADER + c.BOLD +
|
||||
"YUNOHOST APP PACKAGE LINTER\n" + c.END)
|
||||
print("App packaging documentation: https://yunohost.org/#/packaging_apps")
|
||||
print("App package example: https://github.com/YunoHost/example_ynh\n")
|
||||
print("Checking " + c.BOLD + app_path + c.END + " package\n")
|
||||
|
||||
|
||||
def print_right(str):
|
||||
print(c.OKGREEN + "✔", str, c.END)
|
||||
|
||||
|
||||
def print_wrong(str):
|
||||
print(c.FAIL + "✘", str, c.END)
|
||||
|
||||
|
||||
def check_files_exist(app_path):
|
||||
"""
|
||||
Check files exist
|
||||
"""
|
||||
print (c.BOLD + c.HEADER + ">>>> MISSING FILES <<<<" + c.END);
|
||||
fname = ("manifest.json", "scripts/install", "scripts/remove", \
|
||||
print (c.BOLD + c.HEADER + ">>>> MISSING FILES <<<<" + c.END)
|
||||
fname = ("manifest.json", "scripts/install", "scripts/remove",
|
||||
"scripts/upgrade", "scripts/backup", "scripts/restore", "LICENSE", "README.md")
|
||||
i = 0;
|
||||
i = 0
|
||||
while (i < len(fname)):
|
||||
if (check_file_exist(app_path + "/" + fname[i])): print_right(fname[i])
|
||||
else: print_wrong(fname[i])
|
||||
if (check_file_exist(app_path + "/" + fname[i])):
|
||||
print_right(fname[i])
|
||||
else:
|
||||
print_wrong(fname[i])
|
||||
i += 1
|
||||
|
||||
|
||||
def check_file_exist(file_path):
|
||||
return 1 if os.path.isfile(file_path) and os.stat(file_path).st_size > 0 else 0
|
||||
|
||||
|
||||
def read_file(file_path):
|
||||
with open(file_path) as f:
|
||||
file = f.read().splitlines()
|
||||
return file
|
||||
|
||||
|
||||
def check_manifest(manifest):
|
||||
print (c.BOLD + c.HEADER + "\n>>>> MANIFEST <<<<" + c.END);
|
||||
print (c.BOLD + c.HEADER + "\n>>>> MANIFEST <<<<" + c.END)
|
||||
"""
|
||||
Check if there is no comma syntax issue
|
||||
"""
|
||||
|
|
@ -56,12 +67,17 @@ def check_manifest(manifest):
|
|||
with open(manifest, encoding='utf-8') as data_file:
|
||||
manifest = json.loads(data_file.read())
|
||||
print_right("Manifest syntax is good.")
|
||||
except: print_wrong("Syntax (comma) or encoding issue with manifest.json. Can't check file."); return
|
||||
i, fields = 0, ("name", "id", "packaging_format", "description", "url", \
|
||||
except:
|
||||
print_wrong(
|
||||
"Syntax (comma) or encoding issue with manifest.json. Can't check file.")
|
||||
return
|
||||
i, fields = 0, ("name", "id", "packaging_format", "description", "url",
|
||||
"license", "maintainer", "requirements", "multi_instance", "services", "arguments")
|
||||
while (i < len(fields)):
|
||||
if fields[i] in manifest: print_right("\"" + fields[i] + "\" field is present")
|
||||
else: print_wrong("\"" + fields[i] + "\" field is missing")
|
||||
if fields[i] in manifest:
|
||||
print_right("\"" + fields[i] + "\" field is present")
|
||||
else:
|
||||
print_wrong("\"" + fields[i] + "\" field is missing")
|
||||
i += 1
|
||||
"""
|
||||
Check values in keys
|
||||
|
|
@ -72,19 +88,31 @@ def check_manifest(manifest):
|
|||
# manifest["maintainer"]["email"]
|
||||
# manifest["arguments"]["install"]
|
||||
pf = 1
|
||||
if "packaging_format" not in manifest: print_wrong("\"packaging_format\" key is missing"); pf = 0
|
||||
if pf == 1 and isinstance(manifest["packaging_format"], int) != 1: print_wrong("\"packaging_format\": value isn't an integer type"); pf = 0
|
||||
if pf == 1 and manifest["packaging_format"] != 1: print_wrong("\"packaging_format\" field: current format value is '1'"); pf = 0
|
||||
if pf == 1: print_right("\"packaging_format\" field is good")
|
||||
if "packaging_format" not in manifest:
|
||||
print_wrong("\"packaging_format\" key is missing")
|
||||
pf = 0
|
||||
if pf == 1 and isinstance(manifest["packaging_format"], int) != 1:
|
||||
print_wrong("\"packaging_format\": value isn't an integer type")
|
||||
pf = 0
|
||||
if pf == 1 and manifest["packaging_format"] != 1:
|
||||
print_wrong("\"packaging_format\" field: current format value is '1'")
|
||||
pf = 0
|
||||
if pf == 1:
|
||||
print_right("\"packaging_format\" field is good")
|
||||
|
||||
if "license" in manifest and manifest["license"] != "free" and manifest["license"] != "non-free":
|
||||
print_wrong("You should specify 'free' or 'non-free' software package in the license field.")
|
||||
elif "license" in manifest: print_right("\"licence\" key value is good")
|
||||
print_wrong(
|
||||
"You should specify 'free' or 'non-free' software package in the license field.")
|
||||
elif "license" in manifest:
|
||||
print_right("\"licence\" key value is good")
|
||||
if "multi_instance" in manifest and manifest["multi_instance"] != 1 and manifest["multi_instance"] != 0:
|
||||
print_wrong("\"multi_instance\" field must be boolean type values 'true' or 'false' and not string type")
|
||||
elif "multi_instance" in manifest: print_right("\"multi_instance\" field is good")
|
||||
print_wrong(
|
||||
"\"multi_instance\" field must be boolean type values 'true' or 'false' and not string type")
|
||||
elif "multi_instance" in manifest:
|
||||
print_right("\"multi_instance\" field is good")
|
||||
if "services" in manifest:
|
||||
services = ("nginx", "php5-fpm", "mysql", "uwsgi", "metronome", "postfix", "dovecot") #, "rspamd", "rmilter")
|
||||
services = ("nginx", "php5-fpm", "mysql", "uwsgi", "metronome",
|
||||
"postfix", "dovecot") # , "rspamd", "rmilter")
|
||||
i = 0
|
||||
while (i < len(manifest["services"])):
|
||||
if manifest["services"][i] not in services:
|
||||
|
|
@ -103,24 +131,31 @@ def check_manifest(manifest):
|
|||
j += 1
|
||||
i += 1
|
||||
|
||||
|
||||
def check_script(path, script_name):
|
||||
script_path = path + "/scripts/" + script_name
|
||||
if check_file_exist(script_path) == 0: return
|
||||
print (c.BOLD + c.HEADER + "\n>>>>", scripts[i].upper(), "SCRIPT <<<<" + c.END);
|
||||
if check_file_exist(script_path) == 0:
|
||||
return
|
||||
print (c.BOLD + c.HEADER + "\n>>>>",
|
||||
scripts[i].upper(), "SCRIPT <<<<" + c.END)
|
||||
script = read_file(script_path)
|
||||
check_script_header_presence(script)
|
||||
check_sudo_prefix_commands(script)
|
||||
check_verifications_done_before_modifying_system(script)
|
||||
|
||||
|
||||
def check_script_header_presence(script):
|
||||
if "#!/bin/bash" in script[0]: print_right("Script starts with \"#!/bin/bash\"")
|
||||
else: print_wrong("Script must start with \"#!/bin/bash\"")
|
||||
if "#!/bin/bash" in script[0]:
|
||||
print_right("Script starts with \"#!/bin/bash\"")
|
||||
else:
|
||||
print_wrong("Script must start with \"#!/bin/bash\"")
|
||||
|
||||
|
||||
def check_sudo_prefix_commands(script):
|
||||
"""
|
||||
Check if commands are prefix with "sudo"
|
||||
"""
|
||||
cmd = ("rm", "chown", "chmod", "apt-get", "apt", \
|
||||
cmd = ("rm", "chown", "chmod", "apt-get", "apt",
|
||||
"service", "yunohost", "find" "swapon", "mkswap", "useradd") # , "dd") cp, mkdir
|
||||
i, ok = 0, 1
|
||||
while i < len(script):
|
||||
|
|
@ -129,12 +164,16 @@ def check_sudo_prefix_commands(script):
|
|||
if cmd[j] + " " in script[i] and "sudo " + cmd[j] + " " not in script[i] \
|
||||
and "yunohost service" not in script[i] and "-exec " + cmd[j] not in script[i] \
|
||||
and ".service" not in script[i] and script[i][0] != '#':
|
||||
print(c.FAIL + "✘ Line ", i + 1, "you should add \"sudo\" before this command line:", c.END)
|
||||
print(" " + script[i].replace(cmd[j], c.BOLD + c.FAIL + cmd[j] + c.END));
|
||||
print(c.FAIL + "✘ Line ", i + 1,
|
||||
"you should add \"sudo\" before this command line:", c.END)
|
||||
print(" " + script[i].replace(cmd[j],
|
||||
c.BOLD + c.FAIL + cmd[j] + c.END))
|
||||
ok = 0
|
||||
j += 1
|
||||
i += 1
|
||||
if ok == 1: print_right("All commands are prefix with \"sudo\".")
|
||||
if ok == 1:
|
||||
print_right("All commands are prefix with \"sudo\".")
|
||||
|
||||
|
||||
def check_verifications_done_before_modifying_system(script):
|
||||
"""
|
||||
|
|
@ -142,27 +181,35 @@ def check_verifications_done_before_modifying_system(script):
|
|||
"""
|
||||
ex, i = 0, 0
|
||||
while i < len(script):
|
||||
if "exit" in script[i]: ex = i
|
||||
if "exit" in script[i]:
|
||||
ex = i
|
||||
i += 1
|
||||
cmd = ("cp", "mkdir", "rm", "chown", "chmod", "apt-get", "apt", "service", \
|
||||
cmd = ("cp", "mkdir", "rm", "chown", "chmod", "apt-get", "apt", "service",
|
||||
"find", "sed", "mysql", "swapon", "mount", "dd", "mkswap", "useradd") # "yunohost"
|
||||
i, ok = 0, 1
|
||||
while i < len(script):
|
||||
if i >= ex: break
|
||||
if i >= ex:
|
||||
break
|
||||
j = 0
|
||||
while (j < len(cmd)):
|
||||
if cmd[j] in script[i] and script[i][0] != '#': ok = 0
|
||||
if cmd[j] in script[i] and script[i][0] != '#':
|
||||
ok = 0
|
||||
j += 1
|
||||
i += 1
|
||||
if ok == 0:
|
||||
print(c.FAIL + "✘ At line", ex + 1, "'exit' command is executed with system modification before.")
|
||||
print(c.FAIL + "✘ At line", ex + 1,
|
||||
"'exit' command is executed with system modification before.")
|
||||
print("This system modification is an issue if a verification exit the script.")
|
||||
print("You should move this verification before any system modification." + c.END);
|
||||
else: print_right("Verifications (with exit commands) are done before any system modification.")
|
||||
print("You should move this verification before any system modification." + c.END)
|
||||
else:
|
||||
print_right(
|
||||
"Verifications (with exit commands) are done before any system modification.")
|
||||
|
||||
if __name__ == '__main__':
|
||||
os.system("clear")
|
||||
if len(sys.argv) != 2: print("Give one app package path."); exit()
|
||||
if len(sys.argv) != 2:
|
||||
print("Give one app package path.")
|
||||
exit()
|
||||
app_path = sys.argv[1]
|
||||
header(app_path)
|
||||
check_files_exist(app_path)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue