{"id":797,"date":"2009-10-04T14:30:07","date_gmt":"2009-10-04T23:30:07","guid":{"rendered":"https:\/\/www.kellyrob99.com\/blog\/?p=797"},"modified":"2009-10-04T14:32:12","modified_gmt":"2009-10-04T23:32:12","slug":"groovy-clibuilder-with-multiple-arguments","status":"publish","type":"post","link":"https:\/\/www.kellyrob99.com\/blog\/2009\/10\/04\/groovy-clibuilder-with-multiple-arguments\/","title":{"rendered":"Groovy CliBuilder with multiple arguments"},"content":{"rendered":"

I’ve been writing a lot of Groovy scripts lately and have developed quite a fondness for the CliBuilder along the way.
\nThere’s lots of great examples on the internet, but I could only find one place that demonstrated how to easily consume an unknown number of parameters as a List and that was a copy of the CliBuilderTest I found on Koders<\/a>. There’s also some explanation for the different behavior inherent in the Apache Commons Cli<\/a> libraries V1.0 and V1.1 that CliBuilder encapsulates(there is a 1.2 version, but from the documentation it seems CliBuilder may not be fully compatible with it).<\/p>\n

Here’s a GroovyTestCase that exercises CliBuilder with multiple arguments.<\/p>\n

\n
\r\npackage org.kar\r\nimport org.apache.commons.cli.Option\r\n\/**\r\n * Demonstrates usage of the CliBuilder with multiple arguments to create a List.\r\n *\/\r\nclass CliBuilderDemoTest\r\nextends GroovyTestCase {\r\n    \/**\r\n     * You can specify multiple arguments one at a time.\r\n     *\/\r\n    void testMultiOption() {\r\n        CliBuilder cli = new CliBuilder()\r\n        cli.with {\r\n            a longOpt: 'arguments', args: 2, required: true, 'Two arguments'\r\n        }\r\n        def args = ['-a', 'arg1', '-a', 'arg2']\r\n        def options = cli.parse(args)\r\n\r\n        assert (options)\r\n        assertEquals('First arg is available with the -a option. ', 'arg1', options.a)\r\n        assertEquals('Should be two args, in order, available with the addition of an "s" to the option.',\r\n                ['arg1', 'arg2'], options.as)\r\n    }\r\n\r\n    \/**\r\n     * You can specify multiple arguments together in a block, with a defined separator(in this case a comma).\r\n     *\/\r\n    void testMultiOptionWithSeparator() {\r\n        CliBuilder cli = new CliBuilder()\r\n        cli.with {\r\n            a longOpt: 'arguments', args: 2, required: true, valueSeparator: ',' as char,\r\n                    'Two arguments, separated by a comma'\r\n        }\r\n        def args = ['-a', 'arg1,arg2']\r\n        def options = cli.parse(args)\r\n\r\n        assert (options)\r\n        assertEquals('First arg is available with the -a option. ', 'arg1', options.a)\r\n        assertEquals('Should be two args, in order.', ['arg1', 'arg2'], options.as)\r\n    }\r\n\r\n    \/**\r\n     * You can also have any number of arguments by specifying UNLIMITED_VALUES.\r\n     *\/\r\n    void testUnlimitedArgs() {\r\n        CliBuilder cli = new CliBuilder()\r\n        cli.with {\r\n            a longOpt: 'arguments', args: Option.UNLIMITED_VALUES, required: true, valueSeparator: ',' as char,\r\n                    'Two arguments, separated by a comma'\r\n        }\r\n        def args = ['-a', 'arg1,arg2,arg3']\r\n        def options = cli.parse(args)\r\n\r\n        assert (options)\r\n        assertEquals('First arg is available with the -a option. ', 'arg1', options.a)\r\n        assertEquals('Should be a list of args, in order.', ['arg1', 'arg2', 'arg3'], options.as)\r\n\r\n        def args2 = ['-a', 'argOnly']\r\n        def options2 = cli.parse(args2)\r\n\r\n        assert (options)\r\n        assertEquals('First arg is available with the -a option.', 'argOnly', options2.a)\r\n        assertEquals('Should be a list of args, with a single entry.', ['argOnly'], options2.as)\r\n\r\n        def args3 = []\r\n        \/\/this will automagically print the usage string and any validation errors to System.out\r\n        def options3 = cli.parse(args3)\r\n        assertNull(options3)\r\n    }\r\n}\r\n\r\n<\/pre>\n<\/div>\n
Anyhow, hope that the next guy finds this info useful – it certainly has made my recent work writing Groovy scripts much easier!<\/p>\n","protected":false},"excerpt":{"rendered":"
I’ve been writing a lot of Groovy scripts lately and have developed quite a fondness for the CliBuilder along the way. There’s lots of great examples on the internet, but I could only find one place that demonstrated how to easily consume an unknown number of parameters as a List and that was a copy […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"ngg_post_thumbnail":0,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_feature_clip_id":0,"_jetpack_memberships_contains_paid_content":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2},"jetpack_post_was_ever_published":false},"categories":[6],"tags":[94,134,133,135,257,132,113],"class_list":["post-797","post","type-post","status-publish","format-standard","hentry","category-dev","tag-apache","tag-cli","tag-clibuilder","tag-command-line-interface","tag-groovy","tag-script","tag-thekaptain"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t