Merge lp:~clint-fewbar/charm-tools/flag-readme into lp:~charmers/charm-tools/trunk

[Clint Byrum]

Flag instances of the boilerplate lines of the README.ex in a README so that
if somebody just renames the file blindly we get an E:

[Marco Ceppi (marcoceppi)]

LGTM!

review: Approve

[Martin Packman (gz)]

This will throw an error if the readme contains the line "-----\n" say. Only checking non-trivial lines (20 chars or more for instance).

+ for l in [ x.strip() for x in tr]:
...
+ tr.seek(0)

Rather than iterating over the file multiple times and seeking back to the start, do it once and reuse this list. For instance:

    try:
        bad_lines = []
        with open(TEMPLATE_README) as tr:
            for line in tr:
                if len(line) > 20:
                    bad_lines.append(line.strip())
        for readme in found_readmes:
            ...
    except ...

review: Needs Fixing

[lp:~clint-fewbar/charm-tools/flag-readme]

166. By Clint Byrum on 2012-10-28

address case where short lines in the example README are common idioms

167. By Clint Byrum on 2012-10-28

Adding short lines from README.ex to test short line heuristic

[Clint Byrum (clint-fewbar)]

Thanks Martin, I think I've addressed it with the last commit. Can you review again?

[Martin Packman (gz)]

+ tr.seek(0)

This is harmless but now redundant.

review: Approve

=== modified file 'scripts/proof'
--- scripts/proof	2012-09-30 16:13:08 +0000
+++ scripts/proof	2012-10-28 15:04:18 +0000
@@ -47,6 +47,9 @@
 KNOWN_SCOPES = [ 'global',
                  'container' ]
 
+TEMPLATE_README = os.path.abspath(
+        os.path.join(__file__, '..', '..', 'templates', 'charm', 'README.ex'))
+
 class RelationError(Exception):
     pass
 
@@ -212,6 +215,26 @@
   if len(found_readmes):
     if 'README.ex' in found_readmes:
       err("Includes template README.ex file")
+    try:
+      with open(TEMPLATE_README) as tr:
+        bad_lines = []
+        for line in tr:
+          if len(line) >= 20:
+            bad_lines.append(line.strip())
+        for readme in found_readmes:
+          readme_path = os.path.join(charm_path, readme)
+          with open(readme_path) as r:
+            readme_content = r.read()
+            lc = 0
+            for l in bad_lines:
+              if not len(l):
+                continue
+              lc += 1
+              if l in readme_content:
+                err("%s Includes boilerplate README.ex line %d" % (readme, lc))
+            tr.seek(0)
+    except IOError, e:
+      err("Error while opening %s (%s)" % (e.filename, e.strerror))
   else:
     warn("no README file")
 

=== modified file 'tests/charms/mod-spdy/README'
--- tests/charms/mod-spdy/README	2012-04-23 20:46:55 +0000
+++ tests/charms/mod-spdy/README	2012-10-28 15:04:18 +0000
@@ -1,3 +1,6 @@
+Configuration
+-------------
+
 This will open port 443 on any machine with apache and enable mod_spdy.
 
 juju deploy wrdpress

=== modified file 'tests/proof/expected/broken-maintainer'
--- tests/proof/expected/broken-maintainer	2012-09-30 16:07:25 +0000
+++ tests/proof/expected/broken-maintainer	2012-10-28 15:04:18 +0000
@@ -2,6 +2,8 @@
 W: Maintainer address should contain a real-name and email only. [test@testhost]
 E: no copyright file
 E: Includes template README.ex file
+E: README.ex Includes boilerplate README.ex line 1
+E: README.ex Includes boilerplate README.ex line 2
 E: template interface names should be changed: interface-name
 E: template relations should be renamed to fit charm: relation-name
 E: template interface names should be changed: interface-name

=== modified file 'tests/proof/expected/missing-maintainer'
--- tests/proof/expected/missing-maintainer	2012-09-30 16:07:25 +0000
+++ tests/proof/expected/missing-maintainer	2012-10-28 15:04:18 +0000
@@ -2,6 +2,8 @@
 E: Charms need a maintainer (See RFC2822) - Name <email>
 E: no copyright file
 E: Includes template README.ex file
+E: README.ex Includes boilerplate README.ex line 1
+E: README.ex Includes boilerplate README.ex line 2
 E: template interface names should be changed: interface-name
 E: template relations should be renamed to fit charm: relation-name
 E: template interface names should be changed: interface-name

=== modified file 'tests/proof/expected/test'
--- tests/proof/expected/test	2012-09-30 16:07:25 +0000
+++ tests/proof/expected/test	2012-10-28 15:04:18 +0000
@@ -1,5 +1,7 @@
 E: no copyright file
 E: Includes template README.ex file
+E: README.ex Includes boilerplate README.ex line 1
+E: README.ex Includes boilerplate README.ex line 2
 E: template interface names should be changed: interface-name
 E: template relations should be renamed to fit charm: relation-name
 E: template interface names should be changed: interface-name

=== modified file 'tests/proof/expected/unknown-metadata'
--- tests/proof/expected/unknown-metadata	2012-09-30 16:07:25 +0000
+++ tests/proof/expected/unknown-metadata	2012-10-28 15:04:18 +0000
@@ -2,6 +2,8 @@
 W: metadata name (test) must match directory name (unknown-metadata) exactly for local deployment.
 E: no copyright file
 E: Includes template README.ex file
+E: README.ex Includes boilerplate README.ex line 1
+E: README.ex Includes boilerplate README.ex line 2
 E: template interface names should be changed: interface-name
 E: Unknown relation field in relation relation-name - (baz)
 E: template relations should be renamed to fit charm: relation-name