Merge lp:~lazypower/charm-tools/refactor-readme-lint into lp:charm-tools/1.6

[Charles Butler]

Refactored the README.ex lint to spit out the matched line contents, vs the line number.

When linting a charm, matched README.ex boilerplate line number isn't terribly helpful, but knowing what content we have matched really helps to narrow down what has matched. This may not be the right approach but it certainly starts the conversation.

[Tim Van Steenburgh (tvansteenburgh)]

`make check` fails now, e.g.:

--- tests_functional/proof/expected/unknown-metadata 2015-08-25 14:56:08.755392000 -0400
+++ tests_functional/proof/results/unknown-metadata 2015-08-27 15:24:25.685029478 -0400
@@ -2,7 +2,7 @@
 I: metadata name (test) must match directory name (unknown-metadata) exactly for local deployment.
 W: no copyright file
 W: Includes template README.ex file
-W: README.ex includes line 1 of boilerplate README.ex
+W: Boilerplate readmeidentified in README.ex: Describe the intended usage of this charm and anything unique about how this charm relates to others here.
 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

review: Needs Fixing

[lp:~lazypower/charm-tools/refactor-readme-lint]

356. By Charles Butler on 2015-08-27

Updates the check targets for the new verbiage and refactors the verbiage of
the linter to reflect what existed before the modification

[Tim Van Steenburgh (tvansteenburgh)]

LGTM, thanks Chuck.

review: Approve

=== modified file 'charmtools/charms.py'
--- charmtools/charms.py	2015-08-25 18:05:28 +0000
+++ charmtools/charms.py	2015-08-27 19:40:57 +0000
@@ -314,9 +314,9 @@
                                         continue
                                     lc += 1
                                     if l in readme_content:
-                                        err_msg = ('%s includes line %d of '
-                                                   'boilerplate README.ex')
-                                        lint.warn(err_msg % (readme, lc))
+                                        err_msg = ('%s includes boilerplate: '
+                                                   '%s')
+                                        lint.warn(err_msg % (readme, l))
                 except IOError as e:
                     lint.warn(
                         "Error while opening %s (%s)" %
 
=== modified file 'tests_functional/proof/expected/broken-maintainer'
--- tests_functional/proof/expected/broken-maintainer	2014-12-05 21:04:40 +0000
+++ tests_functional/proof/expected/broken-maintainer	2015-08-27 19:40:57 +0000
@@ -2,7 +2,7 @@
 W: Maintainer format should be "Name <Email>", not "test@testhost"
 W: no copyright file
 W: Includes template README.ex file
-W: README.ex includes line 1 of boilerplate README.ex
+W: README.ex includes boilerplate: Describe the intended usage of this charm and anything unique about how this charm relates to others here.
 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_functional/proof/expected/icon-template'
--- tests_functional/proof/expected/icon-template	2014-10-22 20:02:21 +0000
+++ tests_functional/proof/expected/icon-template	2015-08-27 19:40:57 +0000
@@ -1,7 +1,7 @@
 I: Includes template icon.svg file.
 W: no copyright file
 W: Includes template README.ex file
-W: README.ex includes line 1 of boilerplate README.ex
+W: README.ex includes boilerplate: Describe the intended usage of this charm and anything unique about how this charm relates to others here.
 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
 
=== modified file 'tests_functional/proof/expected/missing-maintainer'
--- tests_functional/proof/expected/missing-maintainer	2014-12-05 21:04:40 +0000
+++ tests_functional/proof/expected/missing-maintainer	2015-08-27 19:40:57 +0000
@@ -2,7 +2,7 @@
 E: Charm must have either a maintainer or maintainers field
 W: no copyright file
 W: Includes template README.ex file
-W: README.ex includes line 1 of boilerplate README.ex
+W: README.ex includes boilerplate: Describe the intended usage of this charm and anything unique about how this charm relates to others here.
 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_functional/proof/expected/test'
--- tests_functional/proof/expected/test	2014-10-24 16:21:01 +0000
+++ tests_functional/proof/expected/test	2015-08-27 19:40:57 +0000
@@ -2,7 +2,7 @@
 I: No icon.svg file.
 W: no copyright file
 W: Includes template README.ex file
-W: README.ex includes line 1 of boilerplate README.ex
+W: README.ex includes boilerplate: Describe the intended usage of this charm and anything unique about how this charm relates to others here.
 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_functional/proof/expected/unknown-metadata'
--- tests_functional/proof/expected/unknown-metadata	2014-12-05 21:04:40 +0000
+++ tests_functional/proof/expected/unknown-metadata	2015-08-27 19:40:57 +0000
@@ -2,7 +2,7 @@
 I: metadata name (test) must match directory name (unknown-metadata) exactly for local deployment.
 W: no copyright file
 W: Includes template README.ex file
-W: README.ex includes line 1 of boilerplate README.ex
+W: README.ex includes boilerplate: Describe the intended usage of this charm and anything unique about how this charm relates to others here.
 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