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'.*github\.com/[^/]+/[^/]+\.git'),
  47      "Appending .git is not necessary"),
  48     # TODO enable in August 2015, when Google Code goes read-only
  49     # (re.compile(r'.*://code\.google\.com/.*'),
  50     #  "code.google.com will be soon switching down, perhaps the project moved to github.com?"),
  51 ]
  52
  53 regex_warnings = {
  54     'Web Site': http_warnings + [
  55     ],
  56     'Source Code': http_warnings + [
  57     ],
  58     'Repo': https_enforcings + [
  59     ],
  60     'Issue Tracker': http_warnings + [
  61         (re.compile(r'.*github\.com/[^/]+/[^/]+[/]*$'),
  62          "/issues is missing"),
  63     ],
  64     'Changelog': http_warnings + [
  65     ],
  66     'License': [
  67         (re.compile(r'^(|None|Unknown)$'),
  68          "No license specified"),
  69     ],
  70     'Summary': [
  71         (re.compile(r'^$'),
  72          "Summary yet to be filled"),
  73         (re.compile(r'.*\b(free software|open source)\b.*', re.IGNORECASE),
  74          "No need to specify that the app is Free Software"),
  75         (re.compile(r'.*((your|for).*android|android.*(app|device|client|port|version))', re.IGNORECASE),
  76          "No need to specify that the app is for Android"),
  77         (re.compile(r'.*[a-z0-9][.!?]( |$)'),
  78          "Punctuation should be avoided"),
  79     ],
  80     'Description': [
  81         (re.compile(r'^No description available$'),
  82          "Description yet to be filled"),
  83         (re.compile(r'\s*[*#][^ .]'),
  84          "Invalid bulleted list"),
  85         (re.compile(r'^\s'),
  86          "Unnecessary leading space"),
  87         (re.compile(r'.*\s$'),
  88          "Unnecessary trailing space"),
  89     ],
  90 }
  91
  92
  93 def main():
  94
  95     global config, options, curid, count
  96     curid = None
  97
  98     count = Counter()
  99
 100     def warn(message):
 101         global curid, count
 102         if curid:
 103             print "%s:" % curid
 104             curid = None
 105             count['app'] += 1
 106         print '    %s' % message
 107         count['warn'] += 1
 108
 109     def pwarn(message):
 110         if options.pedantic:
 111             warn(message)
 112
 113     # Parse command line...
 114     parser = OptionParser(usage="Usage: %prog [options] [APPID [APPID ...]]")
 115     parser.add_option("-v", "--verbose", action="store_true", default=False,
 116                       help="Spew out even more information than normal")
 117     parser.add_option("-q", "--quiet", action="store_true", default=False,
 118                       help="Restrict output to warnings and errors")
 119     parser.add_option("-p", "--pedantic", action="store_true", default=False,
 120                       help="Show pedantic warnings that might give false positives")
 121     (options, args) = parser.parse_args()
 122
 123     config = common.read_config(options)
 124
 125     # Get all apps...
 126     allapps = metadata.read_metadata(xref=False)
 127     apps = common.read_app_args(args, allapps, False)
 128
 129     for appid, app in apps.iteritems():
 130         if app['Disabled']:
 131             continue
 132
 133         curid = appid
 134         count['app_total'] += 1
 135
 136         curbuild = None
 137         for build in app['builds']:
 138             if not curbuild or int(build['vercode']) > int(curbuild['vercode']):
 139                 curbuild = build
 140
 141         # Potentially incorrect UCM
 142         if (curbuild and curbuild['commit']
 143                 and app['Update Check Mode'] == 'RepoManifest'
 144                 and curbuild['commit'] != 'unknown - see disabled'
 145                 and any(s in curbuild['commit'] for s in '.,_-/')):
 146             pwarn("Last used commit '%s' looks like a tag, but Update Check Mode is '%s'" % (
 147                 curbuild['commit'], app['Update Check Mode']))
 148
 149         # Dangerous auto updates
 150         if curbuild and app['Auto Update Mode'] != 'None':
 151             for flag in ['target', 'srclibs', 'scanignore']:
 152                 if curbuild[flag]:
 153                     pwarn("Auto Update Mode is enabled but '%s' is manually set at '%s'" % (flag, curbuild[flag]))
 154
 155         # Summary size limit
 156         summ_chars = len(app['Summary'])
 157         if summ_chars > config['char_limits']['Summary']:
 158             warn("Summary of length %s is over the %i char limit" % (
 159                 summ_chars, config['char_limits']['Summary']))
 160
 161         # Redundant info
 162         if app['Web Site'] and app['Source Code']:
 163             if app['Web Site'].lower() == app['Source Code'].lower():
 164                 warn("Website '%s' is just the app's source code link" % app['Web Site'])
 165
 166         # "None" still a category
 167         if 'None' in app['Categories']:
 168             warn("Category 'None' is is still present")
 169         elif not app['Categories']:
 170             warn("Categories are not set")
 171
 172         name = app['Name'] or app['Auto Name']
 173         if app['Summary'] and name:
 174             if app['Summary'].lower() == name.lower():
 175                 warn("Summary '%s' is just the app's name" % app['Summary'])
 176
 177         desc = app['Description']
 178         if app['Summary'] and desc and len(desc) == 1:
 179             if app['Summary'].lower() == desc[0].lower():
 180                 warn("Description '%s' is just the app's summary" % app['Summary'])
 181
 182         # Description size limit
 183         desc_charcount = sum(len(l) for l in desc)
 184         if desc_charcount > config['char_limits']['Description']:
 185             warn("Description of length %s is over the %i char limit" % (
 186                 desc_charcount, config['char_limits']['Description']))
 187
 188         if (not desc[0] or not desc[-1]
 189                 or any(not desc[l - 1] and not desc[l] for l in range(1, len(desc)))):
 190             warn("Description has an extra empty line")
 191
 192         # Regex checks in all kinds of fields
 193         for f in regex_warnings:
 194             for m, r in regex_warnings[f]:
 195                 t = metadata.metafieldtype(f)
 196                 if t == 'string':
 197                     if m.match(app[f]):
 198                         warn("%s '%s': %s" % (f, app[f], r))
 199                 elif t == 'multiline':
 200                     for l in app[f]:
 201                         if m.match(l):
 202                             warn("%s at line '%s': %s" % (f, l, r))
 203
 204         # Build warnings
 205         for build in app['builds']:
 206             if build['disable']:
 207                 continue
 208             for s in ['master', 'origin', 'HEAD', 'default', 'trunk']:
 209                 if build['commit'] and build['commit'].startswith(s):
 210                     warn("Branch '%s' used as commit in build '%s'" % (
 211                         s, build['version']))
 212                 for srclib in build['srclibs']:
 213                     ref = srclib.split('@')[1].split('/')[0]
 214                     if ref.startswith(s):
 215                         warn("Branch '%s' used as commit in srclib '%s'" % (
 216                             s, srclib))
 217
 218         if not curid:
 219             print
 220
 221     logging.info("Found a total of %i warnings in %i apps out of %i total." % (
 222         count['warn'], count['app'], count['app_total']))
 223
 224 if __name__ == "__main__":
 225     main()