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 regex_warnings = {
  31     'Web Site': [
  32         (re.compile(r'.*[^sS]://github\.com/.*'),
  33          "github URLs should always use https:// not http://"),
  34         (re.compile(r'.*[^sS]://code\.google\.com/.*'),
  35          "code.google.com URLs should always use https:// not http://"),
  36         ],
  37     'Source Code': [
  38         (re.compile(r'.*[^sS]://github\.com/.*'),
  39          "github URLs should always use https:// (not http://, git://, or git@)"),
  40         (re.compile(r'.*code\.google\.com/p/[^/]+[/]*$'),
  41          "/source is missing"),
  42         (re.compile(r'.*[^sS]://code\.google\.com/.*'),
  43          "code.google.com URLs should always use https:// not http://"),
  44         (re.compile(r'.*[^sS]://dl\.google\.com/.*'),
  45          "dl.google.com URLs should always use https:// not http://"),
  46         (re.compile(r'.*[^sS]://gitorious\.org/.*'),
  47          "gitorious URLs should always use https:// (not http://, git://, or git@)"),
  48         ],
  49     'Repo': [
  50         (re.compile(r'.*[^sS]://code\.google\.com/.*'),
  51          "code.google.com URLs should always use https:// not http://"),
  52         (re.compile(r'.*[^sS]://dl\.google\.com/.*'),
  53          "dl.google.com URLs should always use https:// not http://"),
  54         (re.compile(r'.*[^sS]://github\.com/.*'),
  55          "github URLs should always use https:// (not http://, git://, or git@)"),
  56         (re.compile(r'.*[^sS]://gitorious\.org/.*'),
  57          "gitorious URLs should always use https:// (not http://, git://, or git@)"),
  58         (re.compile(r'.*[^sS]://[^.]*\.googlecode\.com/svn/?.*'),
  59          "Google Code SVN URLs should always use https:// (not http:// or svn://)"),
  60         (re.compile(r'.*[^sS]://svn\.apache\.org/repos/?.*'),
  61          "Apache SVN URLs should always use https:// (not http:// or svn://)"),
  62         (re.compile(r'.*[^sS]://svn\.code\.sf\.net/.*'),
  63          "Sourceforge SVN URLs should always use https:// (not http:// or svn://)"),
  64         ],
  65     'Issue Tracker': [
  66         (re.compile(r'.*code\.google\.com/p/[^/]+[/]*$'),
  67          "/issues is missing"),
  68         (re.compile(r'.*[^sS]://code\.google\.com/.*'),
  69          "code.google.com URLs should always use https:// not http://"),
  70         (re.compile(r'.*github\.com/[^/]+/[^/]+[/]*$'),
  71          "/issues is missing"),
  72         (re.compile(r'.*[^sS]://github\.com/.*'),
  73          "github URLs should always use https:// not http://"),
  74         (re.compile(r'.*[^sS]://gitorious\.org/.*'),
  75          "gitorious URLs should always use https:// not http://"),
  76         ],
  77     'License': [
  78         (re.compile(r'^(|None|Unknown)$'),
  79          "No license specified"),
  80         ],
  81     'Summary': [
  82         (re.compile(r'^$'),
  83          "Summary yet to be filled"),
  84         ],
  85     'Description': [
  86         (re.compile(r'^No description available$'),
  87          "Description yet to be filled"),
  88         (re.compile(r'[ ]*[*#][^ .]'),
  89          "Invalid bulleted list"),
  90         (re.compile(r'^ '),
  91          "Unnecessary leading space"),
  92         ],
  93 }
  94
  95 regex_pedantic = {
  96     'Web Site': [
  97         (re.compile(r'.*github\.com/[^/]+/[^/]+\.git'),
  98          "Appending .git is not necessary"),
  99         (re.compile(r'.*code\.google\.com/p/[^/]+/[^w]'),
 100          "Possible incorrect path appended to google code project site"),
 101         ],
 102     'Source Code': [
 103         (re.compile(r'.*github\.com/[^/]+/[^/]+\.git'),
 104          "Appending .git is not necessary"),
 105         (re.compile(r'.*code\.google\.com/p/[^/]+/source/.*'),
 106          "/source is often enough on its own"),
 107         ],
 108     'Repo': [
 109         (re.compile(r'^http://.*'),
 110          "use https:// if available"),
 111         (re.compile(r'^svn://.*'),
 112          "use https:// if available"),
 113         ],
 114     'Issue Tracker': [
 115         (re.compile(r'.*code\.google\.com/p/[^/]+/issues/.*'),
 116          "/issues is often enough on its own"),
 117         (re.compile(r'.*github\.com/[^/]+/[^/]+/issues/.*'),
 118          "/issues is often enough on its own"),
 119         ],
 120     'Summary': [
 121         (re.compile(r'.*\b(free software|open source)\b.*', re.IGNORECASE),
 122          "No need to specify that the app is Free Software"),
 123         (re.compile(r'.*[a-z0-9][.,!?][ $]'),
 124          "Punctuation should be avoided"),
 125         ],
 126     }
 127
 128
 129 def main():
 130
 131     global config, options, appid, count
 132     appid = None
 133
 134     count = Counter()
 135
 136     def warn(message):
 137         global appid, count
 138         if appid:
 139             print "%s:" % appid
 140             appid = None
 141             count['app'] += 1
 142         print '    %s' % message
 143         count['warn'] += 1
 144
 145     def pwarn(message):
 146         if options.pedantic:
 147             warn(message)
 148
 149     # Parse command line...
 150     parser = OptionParser(usage="Usage: %prog [options] [APPID [APPID ...]]")
 151     parser.add_option("-v", "--verbose", action="store_true", default=False,
 152                       help="Spew out even more information than normal")
 153     parser.add_option("-q", "--quiet", action="store_true", default=False,
 154                       help="Restrict output to warnings and errors")
 155     parser.add_option("-p", "--pedantic", action="store_true", default=False,
 156                       help="Show pedantic warnings that might give false positives")
 157     (options, args) = parser.parse_args()
 158
 159     config = common.read_config(options)
 160
 161     # Get all apps...
 162     allapps = metadata.read_metadata(xref=False)
 163     apps = common.read_app_args(args, allapps, False)
 164
 165     for appid, app in apps.iteritems():
 166         lastcommit = ''
 167
 168         if app['Disabled']:
 169             continue
 170
 171         for build in app['builds']:
 172             if build['commit'] and not build['disable']:
 173                 lastcommit = build['commit']
 174
 175         # Potentially incorrect UCM
 176         if (app['Update Check Mode'] == 'RepoManifest' and
 177                 any(s in lastcommit for s in '.,_-/')):
 178             pwarn("Last used commit '%s' looks like a tag, but Update Check Mode is '%s'" % (
 179                 lastcommit, app['Update Check Mode']))
 180
 181         # Summary size limit
 182         summ_chars = len(app['Summary'])
 183         if summ_chars > config['char_limits']['Summary']:
 184             warn("Summary of length %s is over the %i char limit" % (
 185                 summ_chars, config['char_limits']['Summary']))
 186
 187         # Redundant summaries
 188         summary = app['Summary']
 189         name = app['Name'] or app['Auto Name']
 190         if summary and name:
 191             summary_l = summary.lower()
 192             name_l = name.lower()
 193             if summary_l == name_l:
 194                 warn("Summary '%s' is just the app's name" % summary)
 195             elif (summary_l in name_l or name_l in summary_l):
 196                 pwarn("Summary '%s' probably contains redundant info already in app name '%s'" % (
 197                     summary, name))
 198
 199         # Description size limit
 200         desc_chars = sum(len(l) for l in app['Description'])
 201         if desc_chars > config['char_limits']['Description']:
 202             warn("Description of length %s is over the %i char limit" % (
 203                 desc_chars, config['char_limits']['Description']))
 204
 205         # Regex checks in all kinds of fields
 206         for f in regex_warnings:
 207             for m, r in regex_warnings[f]:
 208                 t = metadata.metafieldtype(f)
 209                 if t == 'string':
 210                     if m.match(app[f]):
 211                         warn("%s '%s': %s" % (f, app[f], r))
 212                 elif t == 'multiline':
 213                     for l in app[f]:
 214                         if m.match(l):
 215                             warn("%s at line '%s': %s" % (f, l, r))
 216
 217         # Regex pedantic checks in all kinds of fields
 218         if options.pedantic:
 219             for f in regex_pedantic:
 220                 for m, r in regex_pedantic[f]:
 221                     if m.match(app[f]):
 222                         warn("%s '%s': %s" % (f, app[f], r))
 223
 224         # Build warnings
 225         for build in app['builds']:
 226             if build['disable']:
 227                 continue
 228             for s in ['master', 'origin', 'HEAD', 'default', 'trunk']:
 229                 if build['commit'] and build['commit'].startswith(s):
 230                     warn("Branch '%s' used as commit in build '%s'" % (
 231                         s, build['version']))
 232                 for srclib in build['srclibs']:
 233                     ref = srclib.split('@')[1].split('/')[0]
 234                     if ref.startswith(s):
 235                         warn("Branch '%s' used as commit in srclib '%s'" % (
 236                             s, srclib))
 237             for s in ['git clone', 'git svn clone', 'svn checkout', 'svn co', 'hg clone']:
 238                 for flag in ['init', 'prebuild', 'build']:
 239                     if not build[flag]:
 240                         continue
 241                     if s in build[flag]:
 242                         # TODO: This should not be pedantic!
 243                         pwarn("'%s' used in %s '%s'" % (s, flag, build[flag]))
 244
 245         if not appid:
 246             print
 247
 248     logging.info("Found a total of %i warnings in %i apps." % (count['warn'], count['app']))
 249
 250 if __name__ == "__main__":
 251     main()