fdroidserver/lint.py

   1 #!/usr/bin/env python2
   2 # -*- coding: utf-8 -*-
   3 #
   4 # lint.py - part of the FDroid server tool
   5 # Copyright (C) 2013-2014 Daniel Martí <mvdan@mvdan.cc>
   6 #
   7 # This program is free software: you can redistribute it and/or modify
   8 # it under the terms of the GNU Affero General Public License as published by
   9 # the Free Software Foundation, either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # This program is distributed in the hope that it will be useful,
  13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See th
  15 # GNU Affero General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU Affero General Public Licen
  18 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 from optparse import OptionParser
  21 import re
  22 import logging
  23 import common
  24 import metadata
  25 from collections import Counter
  26
  27 config = None
  28 options = None
  29
  30
  31 def enforce_https(domain):
  32     return (re.compile(r'.*[^sS]://[^/]*' + re.escape(domain) + r'/.*'),
  33             domain + " URLs should always use https://")
  34
  35 https_enforcings = [
  36     enforce_https('github.com'),
  37     enforce_https('gitlab.com'),
  38     enforce_https('gitorious.org'),
  39     enforce_https('apache.org'),
  40     enforce_https('google.com'),
  41     enforce_https('svn.code.sf.net'),
  42     enforce_https('googlecode.com'),
  43 ]
  44
  45 http_warnings = https_enforcings + [
  46     (re.compile(r'.*/$'),
  47      "HTTP links shouldn't end with a slash"),
  48     (re.compile(r'.*github\.com/[^/]+/[^/]+\.git'),
  49      "Appending .git is not necessary"),
  50     # TODO enable in August 2015, when Google Code goes read-only
  51     # (re.compile(r'.*://code\.google\.com/.*'),
  52     #  "code.google.com will be soon switching down, perhaps the project moved to github.com?"),
  53 ]
  54
  55 regex_warnings = {
  56     'Web Site': http_warnings + [
  57     ],
  58     'Source Code': http_warnings + [
  59     ],
  60     'Repo': https_enforcings + [
  61     ],
  62     'Issue Tracker': http_warnings + [
  63         (re.compile(r'.*github\.com/[^/]+/[^/]+[/]*$'),
  64          "/issues is missing"),
  65     ],
  66     'Changelog': http_warnings + [
  67     ],
  68     'License': [
  69         (re.compile(r'^(|None|Unknown)$'),
  70          "No license specified"),
  71     ],
  72     'Summary': [
  73         (re.compile(r'^$'),
  74          "Summary yet to be filled"),
  75         (re.compile(r'.*\b(free software|open source)\b.*', re.IGNORECASE),
  76          "No need to specify that the app is Free Software"),
  77         (re.compile(r'.*((your|for).*android|android.*(app|device|client|port|version))', re.IGNORECASE),
  78          "No need to specify that the app is for Android"),
  79         (re.compile(r'.*[a-z0-9][.!?]( |$)'),
  80          "Punctuation should be avoided"),
  81     ],
  82     'Description': [
  83         (re.compile(r'^No description available$'),
  84          "Description yet to be filled"),
  85         (re.compile(r'\s*[*#][^ .]'),
  86          "Invalid bulleted list"),
  87         (re.compile(r'^\s'),
  88          "Unnecessary leading space"),
  89         (re.compile(r'.*\s$'),
  90          "Unnecessary trailing space"),
  91     ],
  92 }
  93
  94 regex_pedantic = {
  95     'Issue Tracker': [
  96         (re.compile(r'.*github\.com/[^/]+/[^/]+/issues/.*'),
  97          "/issues is often enough on its own"),
  98     ],
  99 }
 100
 101
 102 def main():
 103
 104     global config, options, curid, count
 105     curid = None
 106
 107     count = Counter()
 108
 109     def warn(message):
 110         global curid, count
 111         if curid:
 112             print "%s:" % curid
 113             curid = None
 114             count['app'] += 1
 115         print '    %s' % message
 116         count['warn'] += 1
 117
 118     def pwarn(message):
 119         if options.pedantic:
 120             warn(message)
 121
 122     # Parse command line...
 123     parser = OptionParser(usage="Usage: %prog [options] [APPID [APPID ...]]")
 124     parser.add_option("-v", "--verbose", action="store_true", default=False,
 125                       help="Spew out even more information than normal")
 126     parser.add_option("-q", "--quiet", action="store_true", default=False,
 127                       help="Restrict output to warnings and errors")
 128     parser.add_option("-p", "--pedantic", action="store_true", default=False,
 129                       help="Show pedantic warnings that might give false positives")
 130     (options, args) = parser.parse_args()
 131
 132     config = common.read_config(options)
 133
 134     # Get all apps...
 135     allapps = metadata.read_metadata(xref=False)
 136     apps = common.read_app_args(args, allapps, False)
 137
 138     for appid, app in apps.iteritems():
 139         if app['Disabled']:
 140             continue
 141
 142         curid = appid
 143         count['app_total'] += 1
 144
 145         curbuild = None
 146         for build in app['builds']:
 147             if not curbuild or int(build['vercode']) > int(curbuild['vercode']):
 148                 curbuild = build
 149
 150         # Potentially incorrect UCM
 151         if (curbuild and curbuild['commit']
 152                 and app['Update Check Mode'] == 'RepoManifest'
 153                 and curbuild['commit'] != 'unknown - see disabled'
 154                 and any(s in curbuild['commit'] for s in '.,_-/')):
 155             pwarn("Last used commit '%s' looks like a tag, but Update Check Mode is '%s'" % (
 156                 curbuild['commit'], app['Update Check Mode']))
 157
 158         # Dangerous auto updates
 159         if curbuild and app['Auto Update Mode'] != 'None':
 160             for flag in ['target', 'srclibs', 'scanignore']:
 161                 if curbuild[flag]:
 162                     pwarn("Auto Update Mode is enabled but '%s' is manually set at '%s'" % (flag, curbuild[flag]))
 163
 164         # Summary size limit
 165         summ_chars = len(app['Summary'])
 166         if summ_chars > config['char_limits']['Summary']:
 167             warn("Summary of length %s is over the %i char limit" % (
 168                 summ_chars, config['char_limits']['Summary']))
 169
 170         # Redundant info
 171         if app['Web Site'] and app['Source Code']:
 172             if app['Web Site'].lower() == app['Source Code'].lower():
 173                 warn("Website '%s' is just the app's source code link" % app['Web Site'])
 174
 175         # "None" still a category
 176         if 'None' in app['Categories']:
 177             warn("Category 'None' is is still present")
 178         elif not app['Categories']:
 179             warn("Categories are not set")
 180
 181         name = app['Name'] or app['Auto Name']
 182         if app['Summary'] and name:
 183             if app['Summary'].lower() == name.lower():
 184                 warn("Summary '%s' is just the app's name" % app['Summary'])
 185
 186         desc = app['Description']
 187         if app['Summary'] and desc and len(desc) == 1:
 188             if app['Summary'].lower() == desc[0].lower():
 189                 warn("Description '%s' is just the app's summary" % app['Summary'])
 190
 191         # Description size limit
 192         desc_charcount = sum(len(l) for l in desc)
 193         if desc_charcount > config['char_limits']['Description']:
 194             warn("Description of length %s is over the %i char limit" % (
 195                 desc_charcount, config['char_limits']['Description']))
 196
 197         if (not desc[0] or not desc[-1]
 198                 or any(not desc[l - 1] and not desc[l] for l in range(1, len(desc)))):
 199             warn("Description has an extra empty line")
 200
 201         # Regex checks in all kinds of fields
 202         for f in regex_warnings:
 203             for m, r in regex_warnings[f]:
 204                 t = metadata.metafieldtype(f)
 205                 if t == 'string':
 206                     if m.match(app[f]):
 207                         warn("%s '%s': %s" % (f, app[f], r))
 208                 elif t == 'multiline':
 209                     for l in app[f]:
 210                         if m.match(l):
 211                             warn("%s at line '%s': %s" % (f, l, r))
 212
 213         # Regex pedantic checks in all kinds of fields
 214         if options.pedantic:
 215             for f in regex_pedantic:
 216                 for m, r in regex_pedantic[f]:
 217                     if m.match(app[f]):
 218                         warn("%s '%s': %s" % (f, app[f], r))
 219
 220         # Build warnings
 221         for build in app['builds']:
 222             if build['disable']:
 223                 continue
 224             for s in ['master', 'origin', 'HEAD', 'default', 'trunk']:
 225                 if build['commit'] and build['commit'].startswith(s):
 226                     warn("Branch '%s' used as commit in build '%s'" % (
 227                         s, build['version']))
 228                 for srclib in build['srclibs']:
 229                     ref = srclib.split('@')[1].split('/')[0]
 230                     if ref.startswith(s):
 231                         warn("Branch '%s' used as commit in srclib '%s'" % (
 232                             s, srclib))
 233             for s in ['git clone', 'git svn clone', 'svn checkout', 'svn co', 'hg clone']:
 234                 for flag in ['init', 'prebuild', 'build']:
 235                     if not build[flag]:
 236                         continue
 237                     if s in build[flag]:
 238                         # TODO: This should not be pedantic!
 239                         pwarn("'%s' used in %s '%s'" % (s, flag, build[flag]))
 240
 241         if not curid:
 242             print
 243
 244     logging.info("Found a total of %i warnings in %i apps out of %i total." % (
 245         count['warn'], count['app'], count['app_total']))
 246
 247 if __name__ == "__main__":
 248     main()