Coverage for tests/test_remote_butler.py: 53%
77 statements
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-30 09:54 +0000
« prev ^ index » next coverage.py v7.5.0, created at 2024-04-30 09:54 +0000
1# This file is part of daf_butler.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This software is dual licensed under the GNU General Public License and also
10# under a 3-clause BSD license. Recipients may choose which of these licenses
11# to use; please see the files gpl-3.0.txt and/or bsd_license.txt,
12# respectively. If you choose the GPL option then the following text applies
13# (but note that there is still no warranty even if you opt for BSD instead):
14#
15# This program is free software: you can redistribute it and/or modify
16# it under the terms of the GNU General Public License as published by
17# the Free Software Foundation, either version 3 of the License, or
18# (at your option) any later version.
19#
20# This program is distributed in the hope that it will be useful,
21# but WITHOUT ANY WARRANTY; without even the implied warranty of
22# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23# GNU General Public License for more details.
24#
25# You should have received a copy of the GNU General Public License
26# along with this program. If not, see <http://www.gnu.org/licenses/>.
28import os
29import unittest
30from unittest.mock import patch
32from lsst.daf.butler import Butler, Registry
33from lsst.daf.butler._exceptions import UnknownButlerUserError
34from lsst.daf.butler.datastores.file_datastore.retrieve_artifacts import (
35 determine_destination_for_retrieved_artifact,
36)
37from lsst.daf.butler.registry.tests import RegistryTests
38from lsst.resources import ResourcePath
39from pydantic import ValidationError
41try:
42 import httpx
43 from lsst.daf.butler.remote_butler import ButlerServerError, RemoteButler
44except ImportError:
45 # httpx is not available in rubin-env yet, so skip these tests if it's not
46 # available
47 RemoteButler = None
49try:
50 from lsst.daf.butler.tests.server import create_test_server
51except ImportError:
52 create_test_server = None
54TESTDIR = os.path.abspath(os.path.dirname(__file__))
57@unittest.skipIf(RemoteButler is None, "httpx is not installed")
58class RemoteButlerConfigTests(unittest.TestCase):
59 """Test construction of RemoteButler via Butler()"""
61 def test_bad_config(self):
62 with self.assertRaises(ValidationError):
63 Butler({"cls": "lsst.daf.butler.remote_butler.RemoteButler", "remote_butler": {"url": "!"}})
66@unittest.skipIf(create_test_server is None, "Server dependencies not installed")
67class RemoteButlerErrorHandlingTests(unittest.TestCase):
68 """Test RemoteButler error handling."""
70 def setUp(self):
71 server_instance = self.enterContext(create_test_server(TESTDIR))
72 self.butler = server_instance.remote_butler
73 self.mock = self.enterContext(patch.object(self.butler._connection._client, "request"))
75 def _mock_error_response(self, content: str) -> None:
76 self.mock.return_value = httpx.Response(
77 status_code=422, content=content, request=httpx.Request("GET", "/")
78 )
80 def test_internal_server_error(self):
81 self.mock.side_effect = httpx.HTTPError("unhandled error")
82 with self.assertRaises(ButlerServerError):
83 self.butler.get_dataset_type("int")
85 def test_unknown_error_type(self):
86 self.mock.return_value = httpx.Response(
87 status_code=422, json={"error_type": "not a known error type", "detail": "an error happened"}
88 )
89 with self.assertRaises(UnknownButlerUserError):
90 self.butler.get_dataset_type("int")
92 def test_non_json_error(self):
93 # Server returns a non-JSON body with an error
94 self._mock_error_response("notvalidjson")
95 with self.assertRaises(ButlerServerError):
96 self.butler.get_dataset_type("int")
98 def test_malformed_error(self):
99 # Server returns JSON, but not in the expected format.
100 self._mock_error_response("{}")
101 with self.assertRaises(ButlerServerError):
102 self.butler.get_dataset_type("int")
105class RemoteButlerMiscTests(unittest.TestCase):
106 """Test miscellaneous RemoteButler functionality."""
108 def test_retrieve_artifacts_security(self):
109 # Make sure that the function used to determine output file paths for
110 # retrieveArtifacts throws if a malicious server tries to escape its
111 # destination directory.
112 with self.assertRaisesRegex(ValueError, "^File path attempts to escape destination directory"):
113 determine_destination_for_retrieved_artifact(
114 ResourcePath("output_directory/"),
115 ResourcePath("../something.txt", forceAbsolute=False),
116 preserve_path=True,
117 )
119 # Make sure all paths are forced to relative paths, even if the server
120 # sends an absolute path.
121 self.assertEqual(
122 determine_destination_for_retrieved_artifact(
123 ResourcePath("/tmp/output_directory/"),
124 ResourcePath("file:///not/relative.txt"),
125 preserve_path=True,
126 ),
127 ResourcePath("/tmp/output_directory/not/relative.txt"),
128 )
131@unittest.skipIf(create_test_server is None, "Server dependencies not installed.")
132class RemoteButlerRegistryTests(RegistryTests, unittest.TestCase):
133 """Tests for RemoteButler's `Registry` shim."""
135 supportsCollectionRegex = False
137 def setUp(self):
138 self.server_instance = self.enterContext(create_test_server(TESTDIR))
140 @classmethod
141 def getDataDir(cls) -> str:
142 return os.path.join(TESTDIR, "data", "registry")
144 def makeRegistry(self, share_repo_with: Registry | None = None) -> Registry:
145 if share_repo_with is None:
146 return self.server_instance.hybrid_butler.registry
147 else:
148 return self.server_instance.hybrid_butler._clone().registry
150 def testBasicTransaction(self):
151 # RemoteButler will never support transactions.
152 pass
154 def testNestedTransaction(self):
155 # RemoteButler will never support transactions.
156 pass
158 def testOpaque(self):
159 # This tests an internal implementation detail that isn't exposed to
160 # the client side.
161 pass
163 def testCollectionChainPrependConcurrency(self):
164 # This tests an implementation detail that requires access to the
165 # collection manager object.
166 pass
168 def testCollectionChainReplaceConcurrency(self):
169 # This tests an implementation detail that requires access to the
170 # collection manager object.
171 pass
173 def testAttributeManager(self):
174 # Tests a non-public API that isn't relevant on the client side.
175 pass
178if __name__ == "__main__":
179 unittest.main()