Fix for #346 & #347 (#348)

renoyjohnm · web-flow · commit 8c78b10360f3 · 2025-03-04T15:38:24.000-08:00
* Fix for few issues * Fix mypy issue * Fix code format issues * Fix for issue #349 * Fixing mypy issue * Changing image resolution default value to high * code formatting changes
diff --git a/tabcmd/commands/auth/session.py b/tabcmd/commands/auth/session.py
@@ -6,6 +6,7 @@
 import tableauserverclient as TSC
 import urllib3
 from urllib3.exceptions import InsecureRequestWarning
+from urllib.parse import urlparse, urlunparse
 
 from tabcmd.version import version
 from tabcmd.commands.constants import Errors
@@ -61,7 +62,8 @@ def _update_session_data(self, args):
         # self.command = args.???
         self.username = args.username or self.username or ""
         self.username = self.username.lower()
-        self.server_url = args.server or self.server_url or "http://localhost"
+        server_base_url = self._get_server_base_url(args.server) if args.server else None
+        self.server_url = server_base_url or self.server_url or "http://localhost"
         self.server_url = self.server_url.lower()
         if args.server is not None:
             self.site_name = None
@@ -481,3 +483,14 @@ def _remove_json(self):
             message = "Error clearing session data from {}: check and remove manually".format(file_path)
             self.logger.error(message)
             self.logger.error(e)
+
+    def _get_server_base_url(self, url: str):
+        try:
+            parsed = urlparse(url)
+            scheme = parsed.scheme or "http"
+
+            # If netloc is empty, treat path as netloc and discard any extra path
+            netloc = parsed.netloc or parsed.path.split("/")[0]  # Keep only the domain
+            return urlunparse((scheme, netloc, "", "", "", ""))
+        except Exception as e:
+            Errors.exit_with_error(self.logger, exception=e)
diff --git a/tabcmd/commands/datasources_and_workbooks/datasources_and_workbooks_command.py b/tabcmd/commands/datasources_and_workbooks/datasources_and_workbooks_command.py
@@ -125,14 +125,18 @@ def apply_options_in_url(logger, request_options: TSC.RequestOptions, value: str
             request_options.max_age = 0  # type: ignore
             logger.debug("Set max age to {} from {}".format((TSC.ImageRequestOptions(request_options)).max_age, value))
         elif ":size" == setting_name:
-            # this is only used by get as png
-            try:
-                height, width = setting_val.split(",")
-                (TSC.ImageRequestOptions(request_options)).viz_height = int(height)
-                (TSC.ImageRequestOptions(request_options)).viz_width = int(width)
-            except Exception as oops:
-                logger.warn("Unable to read image size options '{}', skipping".format(setting_val))
-                logger.warn(oops)
+            if isinstance(request_options, (TSC.ImageRequestOptions, TSC.PDFRequestOptions)):
+                try:
+                    height, width = setting_val.split(",")
+                    request_options.viz_height = int(height)
+                    request_options.viz_width = int(width)
+                except Exception as oops:
+                    logger.warn("Unable to read image size options '{}', skipping".format(setting_val))
+                    logger.warn(oops)
+            else:
+                logger.debug(
+                    "Request options are not of type ImageRequestOptions or PDFRequestOptions, skipping size setting"
+                )
         else:
             logger.debug("Parameter[s] not recognized: {}".format(value))
 
@@ -147,8 +151,10 @@ def apply_png_options(logger, request_options: TSC.ImageRequestOptions, args):
             request_options.viz_height = int(args.height)
         if args.width:
             request_options.viz_width = int(args.width)
-        # Always request high-res images
-        request_options.image_resolution = "high"
+        if args.resolution and args.resolution != TSC.ImageRequestOptions.Resolution.High.lower():
+            request_options.image_resolution = None
+        else:
+            request_options.image_resolution = TSC.ImageRequestOptions.Resolution.High.lower()
 
     @staticmethod
     def apply_pdf_options(logger, request_options: TSC.PDFRequestOptions, args):
diff --git a/tabcmd/commands/datasources_and_workbooks/export_command.py b/tabcmd/commands/datasources_and_workbooks/export_command.py
@@ -10,6 +10,9 @@
 from .datasources_workbooks_views_url_parser import DatasourcesWorkbooksAndViewsUrlParser
 
 pagesize = TSC.PDFRequestOptions.PageType  # type alias for brevity
+pageorientation = TSC.PDFRequestOptions.Orientation
+imageresolution = TSC.ImageRequestOptions.Resolution
+ImageResolutionStandard = "standard"
 
 
 class ExportCommand(DatasourcesAndWorkbooks):
@@ -29,7 +32,7 @@ def define_args(export_parser):
 
         group.add_argument(
             "--pagelayout",
-            choices=["landscape", "portrait"],
+            choices=[pageorientation.Landscape, pageorientation.Portrait],
             type=str.lower,
             default=None,
             help="page orientation (landscape or portrait) of the exported PDF",
@@ -57,16 +60,20 @@ def define_args(export_parser):
             help="Set the page size of the exported PDF",
         )
 
-        group.add_argument(
-            "--width", default=800, help="[Not Yet Implemented] Set the width of the image in pixels. Default is 800 px"
-        )
+        group.add_argument("--width", default=800, help=_("export.options.width"))
         group.add_argument("--filename", "-f", help="filename to store the exported data")
         group.add_argument("--height", default=600, help=_("export.options.height"))
         group.add_argument(
             "--filter",
             metavar="COLUMN=VALUE",
             help="Data filter to apply to the view",
         )
+        group.add_argument(
+            "--resolution",
+            choices=[imageresolution.High, ImageResolutionStandard],
+            type=str.lower,
+            help=_("export.options.resolution"),
+        )
 
     """
     Command to Export a view_name or workbook from Tableau Server and save
diff --git a/tabcmd/locales/de/tabcmd_messages_de.properties b/tabcmd/locales/de/tabcmd_messages_de.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=Legt die Seitenausrichtung der exportierten PDF-Datei
 export.options.pagesize=Legt die Seitengröße der exportierten PDF-Datei fest. Zulässige Werte: {0} (Standard: „{1}“)
 export.options.pdf=Daten im PDF-Format exportieren
 export.options.png=Daten im PNG-Format exportieren
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=Legt die Breite fest. Muss ein Ganzzahlwert (Standard: 800 Pixel) sein
 export.short_description=Daten oder Bild einer Ansicht vom Server exportieren
 export.status=„{0}“ wird vom Server abgerufen...
diff --git a/tabcmd/locales/en/tabcmd_messages_en.properties b/tabcmd/locales/en/tabcmd_messages_en.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=Sets the page orientation of the exported PDF. Legal v
 export.options.pagesize=Sets the page size of the exported PDF. Legal values: {0} (default: ''{1}'')
 export.options.pdf=Export data in PDF format
 export.options.png=Export data in PNG format
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=Sets the width. Must be an integer value (default: 800 pixels)
 export.short_description=Export the data or image of a view from the server
 export.status=Requesting ''{0}'' from the server...
diff --git a/tabcmd/locales/es/tabcmd_messages_es.properties b/tabcmd/locales/es/tabcmd_messages_es.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=Configura la orientación de páginas del PDF exportad
 export.options.pagesize=Configura el tamaño de página del PDF exportado. Valores legales: {0} (valor predeterminado: “{1}”)
 export.options.pdf=Exportar datos en formato PDF
 export.options.png=Exportar datos en formato PNG
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=Configura el ancho. Debe ser un valor entero (valor predeterminado: 800 píxeles)
 export.short_description=Exportar los datos o la imagen de una vista del servidor
 export.status=Solicitando “{0}” al servidor...
diff --git a/tabcmd/locales/fr/tabcmd_messages_fr.properties b/tabcmd/locales/fr/tabcmd_messages_fr.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=Définit l’orientation de la page du PDF exporté. V
 export.options.pagesize=Définit la taille de page du PDF exporté. Valeurs admises : {0} (“{1}” par défaut).
 export.options.pdf=Exporter les données au format PDF
 export.options.png=Exporter les données au format PNG
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=Définit la largeur. Doit être un nombre entier (800 pixels par défaut)
 export.short_description=Exporter les données ou une image d’une vue depuis le serveur
 export.status=Requête de “{0}” en provenance du serveur...
diff --git a/tabcmd/locales/ga/tabcmd_messages_ga.properties b/tabcmd/locales/ga/tabcmd_messages_ga.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=f683-表:Sets the page orientation of the exported PDF
 export.options.pagesize=70c0-表:Sets the page size of the exported PDF. Legal values: {0} (default: ‘{1}’)|桜
 export.options.pdf=3ecf-表:Export data in PDF format|桜
 export.options.png=9e8c-表:Export data in PNG format|桜
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=687b-表:Sets the width. Must be an integer value (default: 800 pixels)|桜
 export.short_description=3b4e-表:Export the data or image of a view from the server|桜
 export.status=e524-表:Requesting ‘{0}’ from the server...|桜
diff --git a/tabcmd/locales/it/tabcmd_messages_it.properties b/tabcmd/locales/it/tabcmd_messages_it.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=Imposta l’orientamento della pagina del PDF esportat
 export.options.pagesize=Imposta le dimensioni della pagina del PDF esportato. Valori consentiti: {0} (predefiniti: “{1}”)
 export.options.pdf=Esporta i dati in formato PDF
 export.options.png=Esporta i dati in formato PNG
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=Imposta la profondità. Deve essere un valore intero (predefinito: 800 pixel)
 export.short_description=Esportare i dati o l’immagine di una vista dal server
 export.status=Richiesta di “{0}” dal server in corso...
diff --git a/tabcmd/locales/ja/tabcmd_messages_ja.properties b/tabcmd/locales/ja/tabcmd_messages_ja.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=エクスポートされた PDF のページの方向
 export.options.pagesize=エクスポートされた PDF のページ サイズを設定します。有効な値: {0} (既定: 「{1}」)
 export.options.pdf=PDF 形式でデータをエクスポート
 export.options.png=PNG 形式でデータをエクスポート
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=幅を設定します。整数値であることが必要です (既定: 800 ピクセル)
 export.short_description=サーバーから、ビューのデータまたはイメージをエクスポート
 export.status=サーバーから 「{0}」 を要求しています...
diff --git a/tabcmd/locales/ko/tabcmd_messages_ko.properties b/tabcmd/locales/ko/tabcmd_messages_ko.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=내보낸 PDF의 페이지 방향을 설정합니다.
 export.options.pagesize=내보낸 PDF의 페이지 크기를 설정합니다. 사용할 수 있는 값: {0}(기본값: ’{1}’)
 export.options.pdf=PDF 형식으로 데이터 내보내기
 export.options.png=PNG 형식으로 데이터 내보내기
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=너비를 설정합니다. 정수 값이어야 합니다(기본값: 800픽셀)
 export.short_description=서버에서 뷰의 이미지 또는 데이터 내보내기
 export.status=서버에서 ’{0}’을(를) 요청하는 중...
diff --git a/tabcmd/locales/pt/tabcmd_messages_pt.properties b/tabcmd/locales/pt/tabcmd_messages_pt.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=Define a orientação da página do PDF exportado. Val
 export.options.pagesize=Define o tamanho da página do PDF exportado. Valores legais: {0} (padrão: “{1}”)
 export.options.pdf=Exporte dados em formato PDF
 export.options.png=Exporte dados em formato PNG
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=Define a largura. Deve ser um valor integral (padrão: 800 pixels)
 export.short_description=Exporte os dados ou imagem de uma exibição do servidor
 export.status=Solicitando “{0}” do servidor...
diff --git a/tabcmd/locales/sv/tabcmd_messages_sv.properties b/tabcmd/locales/sv/tabcmd_messages_sv.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=Ställer in sidorienteringen för den exporterade PDF-
 export.options.pagesize=Ställer in sidstorleken för den exporterade PDF-filen. Giltiga värden: {0} (standard: ”{1}”)
 export.options.pdf=Exportera data i PDF-format
 export.options.png=Exportera data i PNG-format
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=Ställer in bredden. Måste vara ett heltalsvärde (standard: 800 bildpunkter)
 export.short_description=Exportera en vys data eller avbildning från servern
 export.status=Begär ”{0}” från servern ...
diff --git a/tabcmd/locales/zh/tabcmd_messages_zh.properties b/tabcmd/locales/zh/tabcmd_messages_zh.properties
@@ -175,6 +175,7 @@ export.options.pagelayout=设置导出的 PDF 的页面方向。合法值: {0}
 export.options.pagesize=设置导出的 PDF 的页面大小。合法值: {0} (默认值: “{1}”)
 export.options.pdf=将数据导出为 PDF 格式
 export.options.png=将数据导出为 PNG 格式
+export.options.resolution=Set the value to high to ensure maximum pixel density
 export.options.width=设置宽度。必须为整数值(默认值: 800 个像素)
 export.short_description=从服务器中导出数据或视图的图像
 export.status=正向服务器请求 “{0}”...
diff --git a/tests/commands/test_datasources_and_workbooks_command.py b/tests/commands/test_datasources_and_workbooks_command.py
@@ -49,12 +49,33 @@ def test_apply_options_from_url_params(self):
     def test_apply_png_options(self):
         mock_args.width = "800"
         mock_args.height = "76"
+        mock_args.resolution = None
         request_options = tsc.ImageRequestOptions()
         DatasourcesAndWorkbooks.apply_png_options(mock_logger, request_options, mock_args)
         assert request_options.image_resolution == "high"
         assert request_options.viz_width == 800
         assert request_options.viz_height == 76
 
+    def test_apply_png_options_with_resolution_high(self):
+        mock_args.width = "800"
+        mock_args.height = "76"
+        mock_args.resolution = "high"
+        request_options = tsc.ImageRequestOptions()
+        DatasourcesAndWorkbooks.apply_png_options(mock_logger, request_options, mock_args)
+        assert request_options.image_resolution == "high"
+        assert request_options.viz_width == 800
+        assert request_options.viz_height == 76
+
+    def test_apply_png_options_with_resolution_standard(self):
+        mock_args.width = "800"
+        mock_args.height = "76"
+        mock_args.resolution = "standard"
+        request_options = tsc.ImageRequestOptions()
+        DatasourcesAndWorkbooks.apply_png_options(mock_logger, request_options, mock_args)
+        assert request_options.image_resolution is None
+        assert request_options.viz_width == 800
+        assert request_options.viz_height == 76
+
     def test_apply_png_options_bad_values(self):
         mock_args.height = "seven"
         mock_args.width = "800b"
@@ -72,6 +93,39 @@ def test_apply_pdf_options(self):
         assert request_options.page_type == expected_page
         assert request_options.orientation == expected_layout
 
+    def test_apply_options_in_url_with_size(self):
+        request_options = tsc.ImageRequestOptions()
+        value = ":size=800,600"
+
+        DatasourcesAndWorkbooks.apply_options_in_url(mock_logger, request_options, value)
+        self.assertEqual(request_options.viz_height, 800)
+        self.assertEqual(request_options.viz_width, 600)
+
+    def test_apply_options_in_url_with_refresh(self):
+        request_options = tsc.ImageRequestOptions()
+        value = ":refresh=yes"
+
+        DatasourcesAndWorkbooks.apply_options_in_url(mock_logger, request_options, value)
+        self.assertEqual(request_options.max_age, 0)
+
+    def test_apply_options_in_url_with_invalid_size(self):
+        request_options = tsc.ImageRequestOptions()
+        value = ":size=invalid"
+
+        DatasourcesAndWorkbooks.apply_options_in_url(mock_logger, request_options, value)
+        self.assertEqual(request_options.viz_height, None)
+        self.assertEqual(request_options.viz_width, None)
+
+    def test_apply_options_in_url_with_unrecognized_parameter(self):
+        request_options = tsc.ImageRequestOptions()
+        default_max_age = request_options.max_age
+        value = ":unknown=param"
+
+        DatasourcesAndWorkbooks.apply_options_in_url(mock_logger, request_options, value)
+        self.assertEqual(request_options.viz_height, None)
+        self.assertEqual(request_options.viz_width, None)
+        self.assertEqual(request_options.max_age, default_max_age)
+
 
 @mock.patch("tableauserverclient.Server")
 class MockedServerTests(unittest.TestCase):
diff --git a/tests/commands/test_geturl_utils.py b/tests/commands/test_geturl_utils.py
@@ -17,6 +17,7 @@
 mock_args.height = None
 mock_args.filename = None
 mock_args.filter = None
+mock_args.resolution = None
 
 mock_logger = mock.MagicMock()
 
diff --git a/tests/commands/test_session.py b/tests/commands/test_session.py
@@ -361,6 +361,92 @@ def test_create_session_with_saved_expired_username_session(
         assert new_session.username == test_username, new_session
         assert mock_tsc.use_server_version.has_been_called()
 
+    @mock.patch("tableauserverclient.Server")
+    def test_create_session_server_url_with_server_arg(self, mock_tsc, mock_pass, mock_file, mock_path, mock_json):
+        name = "uuuu"
+        new_session = Session()
+        new_session.tableau_server = mock_tsc()
+        _set_mocks_for_json_file_exists(mock_path, mock_json, does_it_exist=False)
+        _set_mock_signin_validation_succeeds(new_session.tableau_server, name)
+
+        test_args = Namespace(**vars(args_to_mock))
+        test_args.username = name
+        test_args.password = "pppp"
+        args_server = "https://10ay.online.tableau.com/"
+        test_args.server = args_server
+
+        expected_session_server_url = args_server.rstrip("/")
+
+        auth = new_session.create_session(test_args, None)
+        assert auth is not None, auth
+        assert new_session.server_url == expected_session_server_url
+
+    @mock.patch("tableauserverclient.Server")
+    def test_create_session_server_url_with_no_protocol_in_server_arg(
+        self, mock_tsc, mock_pass, mock_file, mock_path, mock_json
+    ):
+        name = "uuuu"
+        new_session = Session()
+        new_session.tableau_server = mock_tsc()
+        _set_mocks_for_json_file_exists(mock_path, mock_json, does_it_exist=False)
+        _set_mock_signin_validation_succeeds(new_session.tableau_server, name)
+
+        test_args = Namespace(**vars(args_to_mock))
+        test_args.username = name
+        test_args.password = "pppp"
+        args_server = "10ay.online.tableau.com/"
+        test_args.server = args_server
+
+        expected_session_server_url = "http://" + args_server.rstrip("/")
+
+        auth = new_session.create_session(test_args, None)
+        assert auth is not None, auth
+        assert new_session.server_url == expected_session_server_url
+
+    @mock.patch("tableauserverclient.Server")
+    def test_create_session_server_url_with_no_protocol_and_extra_path_in_server_arg(
+        self, mock_tsc, mock_pass, mock_file, mock_path, mock_json
+    ):
+        name = "uuuu"
+        new_session = Session()
+        new_session.tableau_server = mock_tsc()
+        _set_mocks_for_json_file_exists(mock_path, mock_json, does_it_exist=False)
+        _set_mock_signin_validation_succeeds(new_session.tableau_server, name)
+
+        test_args = Namespace(**vars(args_to_mock))
+        test_args.username = name
+        test_args.password = "pppp"
+        args_server = "10ay.online.tableau.com/#/sitename/views/viewname"
+        test_args.server = args_server
+
+        expected_session_server_url = "http://" + args_server.split("/")[0]
+
+        auth = new_session.create_session(test_args, None)
+        assert auth is not None, auth
+        assert new_session.server_url == expected_session_server_url
+
+    @mock.patch("tableauserverclient.Server")
+    def test_create_session_server_url_with_extra_path_in_server_arg(
+        self, mock_tsc, mock_pass, mock_file, mock_path, mock_json
+    ):
+        name = "uuuu"
+        new_session = Session()
+        new_session.tableau_server = mock_tsc()
+        _set_mocks_for_json_file_exists(mock_path, mock_json, does_it_exist=False)
+        _set_mock_signin_validation_succeeds(new_session.tableau_server, name)
+
+        test_args = Namespace(**vars(args_to_mock))
+        test_args.username = name
+        test_args.password = "pppp"
+        args_server = "https://10ay.online.tableau.com/#/sitename/views/viewname"
+        test_args.server = args_server
+
+        expected_session_server_url = args_server.split("#")[0].rstrip("/")
+
+        auth = new_session.create_session(test_args, None)
+        assert auth is not None, auth
+        assert new_session.server_url == expected_session_server_url
+
 
 def _set_mock_tsc_not_signed_in(mock_tsc):
     tsc_in_test = mock.MagicMock(name="manually mocking tsc")
diff --git a/tests/e2e/online_tests.py b/tests/e2e/online_tests.py
diff --git a/tests/e2e/setup_e2e.py b/tests/e2e/setup_e2e.py
