Fix #436: add --description/-d to publish

tabcmd/commands/datasources_and_workbooks/publish_command.py

@@ -177,6 +177,8 @@ def publish_workbook_file(args, logger, server, project_id, str_filename, publis
             raise AttributeError("Cannot specify both a user and group for thumbnails.")
 
         new_workbook = TSC.WorkbookItem(project_id, name=args.name, show_tabs=args.tabbed)
+        if getattr(args, "description", None):
+            new_workbook.description = args.description
         new_workbook = server.workbooks.publish(
             new_workbook,
             str_filename,
@@ -193,6 +195,8 @@ def publish_workbook_file(args, logger, server, project_id, str_filename, publis
     def publish_datasource_file(args, logger, server, project_id, str_filename, publish_mode, credentials):
         new_datasource = TSC.DatasourceItem(project_id, name=args.name)
         new_datasource.use_remote_query_agent = args.use_tableau_bridge
+        if getattr(args, "description", None):
+            new_datasource.description = args.description
         new_datasource = server.datasources.publish(
             new_datasource, str_filename, publish_mode, connection_credentials=credentials
         )

tabcmd/execution/global_options.py

@@ -252,6 +252,7 @@ def set_destination_filename_arg(parser):
 
 def set_publish_args(parser):
     parser.add_argument("-n", "--name", help=_("publish.options.name"))
+    parser.add_argument("-d", "--description", help=_("publish.options.description"))
 
     creds = parser.add_mutually_exclusive_group()
     creds.add_argument("--oauth-username", help=_("publish.options.oauth-username"))

tabcmd/locales/en/tabcmd_messages_en.properties

@@ -78,6 +78,7 @@ publish.errors.server_resource_not_found=The resource you specified does not exi
 publish.options.append=Append extract file to existing data source
 publish.options.db-password=Database password for all data sources
 publish.options.db-username=Database username for all data sources
+publish.options.description=Description for the workbook or data source, sent with the publish request
 publish.options.encrypt_extracts=Encrypt extracts in the workbook or datasource being published to the server. 
 publish.options.name=Workbook or data source name on the server. If omitted, the workbook or data source will be named after the file name, without the twb(x), tds(x), or tde extension. Publishing a .tde file will create a data source
 publish.options.oauth-username=Use the credentials saved on the server keychain associated with USERNAME to publish

tests/parsers/test_parser_publish.py

@@ -105,3 +105,18 @@ def test_publish_parser_deprecated_options(self):
     def test_publish_parser_use_bridge_option(self):
         mock_args = [commandname, "filename.twbx", "--use-tableau-bridge"]
         args = self.parser_under_test.parse_args(mock_args)
+
+    def test_publish_parser_description_long_flag(self):
+        mock_args = [commandname, "filename.twbx", "--description", "My workbook description"]
+        args = self.parser_under_test.parse_args(mock_args)
+        assert args.description == "My workbook description", args
+
+    def test_publish_parser_description_short_flag(self):
+        mock_args = [commandname, "filename.twbx", "-d", "Short desc"]
+        args = self.parser_under_test.parse_args(mock_args)
+        assert args.description == "Short desc", args
+
+    def test_publish_parser_description_optional(self):
+        mock_args = [commandname, "filename.twbx"]
+        args = self.parser_under_test.parse_args(mock_args)
+        assert args.description is None, args