Merge lp:~sergiusens/snapcraft/1510160 into lp:~snappy-dev/snapcraft/core

[Sergio Schvezov]

Add list-plugins

[John Lenton (chipaca)]

LGTM! :)

review: Approve

[Leo Arias (elopio)]

The only problem I see is that when you add a new plugin, you will have to change two tests. +1 anyway as that might be a good thing.

I also have a question, what happens if somebody wants to name the plugin my_plugin, with underscore instead of a dash?

review: Approve

[Sergio Schvezov (sergiusens)]

> The only problem I see is that when you add a new plugin, you will have to
> change two tests. +1 anyway as that might be a good thing.

This would also break if there is another package that puts stuff here, very dodgy, but possible. I prefer the tight control in some aspects. In the end, 'list-plugins' could also just be a fixed list :-P

> I also have a question, what happens if somebody wants to name the plugin
> my_plugin, with underscore instead of a dash?

It is my question too, we would just need some tight control here. This is the inherited design. We can eventually grab the name from an attribute inside the module.

=== modified file 'integration-tests/units/jobs.pxu'
--- integration-tests/units/jobs.pxu	2015-10-20 12:20:11 +0000
+++ integration-tests/units/jobs.pxu	2015-10-26 15:57:33 +0000
@@ -1,3 +1,9 @@
+id: snapcraft/normal/list-plugins
+command:
+    OUTPUT=$(${SNAPCRAFT} list-plugins)
+    test "$OUTPUT" = "$(echo -e "ant\nautotools\ncatkin\ncmake\ncopy\ngo\njdk\nmake\nmaven\npython2\npython3\nqml\nroscore\nscons\ntar-content\n")"
+flags: simple has-leftovers
+
 id: snapcraft/normal/no-yaml
 command:
     set -x

=== modified file 'snapcraft/cmds.py'
--- snapcraft/cmds.py	2015-10-21 20:22:42 +0000
+++ snapcraft/cmds.py	2015-10-26 15:57:33 +0000
@@ -237,6 +237,16 @@
             qemu.kill()
 
 
+def list_plugins(args=None):
+    import pkgutil
+    import snapcraft.plugins
+
+    for importer, modname, is_package in pkgutil.iter_modules(
+            snapcraft.plugins.__path__):
+        if not is_package:
+            print(modname.replace('_', '-'))
+
+
 def clean(args):
     config = _load_config()
 

=== modified file 'snapcraft/main.py'
--- snapcraft/main.py	2015-10-02 09:13:00 +0000
+++ snapcraft/main.py	2015-10-26 15:57:33 +0000
@@ -55,6 +55,12 @@
     parser.set_defaults(func=snapcraft.cmds.run)
 
     parser = subparsers.add_parser(
+        'list-plugins',
+        help='list the available plugins that handle different types '
+        'of a part')
+    parser.set_defaults(func=snapcraft.cmds.list_plugins)
+
+    parser = subparsers.add_parser(
         'clean',
         help='clean up the environment (to start from scratch)')
     parser.set_defaults(func=snapcraft.cmds.clean)

=== modified file 'snapcraft/tests/test_cmds.py'
--- snapcraft/tests/test_cmds.py	2015-10-08 22:43:48 +0000
+++ snapcraft/tests/test_cmds.py	2015-10-26 15:57:33 +0000
@@ -14,6 +14,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import io
 import logging
 import os
 import tempfile
@@ -79,6 +80,27 @@
             '  a/2\n',
             fake_logger.output)
 
+    @mock.patch('sys.stdout', new_callable=io.StringIO)
+    def test_list_plugins(self, mock_stdout):
+        expected_list = '''ant
+autotools
+catkin
+cmake
+copy
+go
+jdk
+make
+maven
+python2
+python3
+qml
+roscore
+scons
+tar-content
+'''
+        cmds.list_plugins()
+        self.assertEqual(mock_stdout.getvalue(), expected_list)
+
 
 class CleanTestCase(tests.TestCase):