refactor the code

clients/client-python/gravitino/audit/__init__.py

@@ -0,0 +1,16 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

clients/client-python/gravitino/audit/caller_context.py

@@ -0,0 +1,71 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+import threading
+from typing import Dict
+
+caller_context_holder = threading.local()
+
+
+class CallerContext:
+    """A class defining the caller context for auditing coarse granularity operations."""
+
+    _context: Dict[str, str]
+
+    def __init__(self, context: Dict[str, str]):
+        """Initialize the CallerContext.
+
+        Args:
+            context: The context dict.
+        """
+        self._context = context
+
+    def context(self) -> Dict[str, str]:
+        """Returns the context dict in the caller context.
+
+        Returns:
+             The context dict.
+        """
+        return self._context
+
+
+class CallerContextHolder:
+    """A thread local holder for the CallerContext."""
+
+    @staticmethod
+    def set(context: CallerContext):
+        """Set the CallerContext in the thread local.
+
+        Args:
+             context: The CallerContext to set.
+        """
+        caller_context_holder.caller_context = context
+
+    @staticmethod
+    def get():
+        """Get the CallerContext from the thread local.
+
+        Returns:
+             The CallerContext.
+        """
+        if not hasattr(caller_context_holder, "caller_context"):
+            return None
+        return caller_context_holder.caller_context
+
+    @staticmethod
+    def remove():
+        """Remove the CallerContext from the thread local."""
+        del caller_context_holder.caller_context

clients/client-python/gravitino/audit/fileset_audit_constants.py

@@ -0,0 +1,28 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+
+class FilesetAuditConstants:
+    """Constants used for fileset data operation audits."""
+
+    HTTP_HEADER_INTERNAL_CLIENT_TYPE = "InternalClientType"
+    """The HTTP header used to pass the internal client type.
+    """
+
+    HTTP_HEADER_FILESET_DATA_OPERATION = "FilesetDataOperation"
+    """The HTTP header used to pass the fileset data operation.
+    """

clients/client-python/gravitino/audit/fileset_data_operation.py

@@ -0,0 +1,77 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+from enum import Enum
+
+
+class FilesetDataOperation(Enum):
+    """An enum class containing fileset data operations that supported."""
+
+    CREATE = "CREATE"
+    """ This data operation means that create a new file.
+    """
+
+    OPEN = "OPEN"
+    """This data operation means that open a file.
+    """
+
+    APPEND = "APPEND"
+    """This data operation means that append some content into a file.
+    """
+
+    RENAME = "RENAME"
+    """This data operation means that rename a file or a directory.
+    """
+
+    DELETE = "DELETE"
+    """This data operation means that delete a file or a directory.
+    """
+
+    GET_FILE_STATUS = "GET_FILE_STATUS"
+    """This data operation means that get a file status from a file or a directory.
+    """
+
+    LIST_STATUS = "LIST_STATUS"
+    """This data operation means that list file statuses under a directory.
+    """
+
+    MKDIRS = "MKDIRS"
+    """This data operation means that create a directory.
+    """
+
+    EXISTS = "EXISTS"
+    """This data operation means that check if a file or a directory exists.
+    """
+
+    CREATED_TIME = "CREATED_TIME"
+    """This data operation means that get the created time of a file.
+    """
+
+    COPY_FILE = "COPY_FILE"
+    """This data operation means that copy a file.
+    """
+
+    CAT_FILE = "CAT_FILE"
+    """This data operation means that get the content of a file.
+    """
+
+    GET_FILE = "GET_FILE"
+    """This data operation means that copy a remote file to local.
+    """
+
+    UNKNOWN = "UNKNOWN"
+    """This data operation means that it is an unknown data operation.
+    """

clients/client-python/gravitino/audit/internal_client_type.py

@@ -0,0 +1,35 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+from enum import Enum
+
+
+class InternalClientType(Enum):
+    """An enum class containing internal client type that supported."""
+
+    HADOOP_GVFS = "HADOOP_GVFS"
+    """The client type is `org.apache.gravitino.filesystem.hadoop.GravitinoVirtualFileSystem` which in
+    the filesystem-hadoop3 module.
+    """
+
+    PYTHON_GVFS = "PYTHON_GVFS"
+    """The client type is `gravitino.filesystem.gvfs.GravitinoVirtualFileSystem` which in the
+    client-python module.
+    """
+
+    UNKNOWN = "UNKNOWN"
+    """The client type is unknown.
+    """

clients/client-python/gravitino/catalog/fileset_catalog.py

@@ -234,6 +234,18 @@ def drop_fileset(self, ident: NameIdentifier) -> bool:
 
         return drop_resp.dropped()
 
+    def get_file_location(self, ident: NameIdentifier, sub_path: str) -> str:
+        """Get the actual location of a file or directory based on the storage location of Fileset and the sub path.
+
+        Args:
+             ident: A fileset identifier, which should be "schema.fileset" format.
+             sub_path: The sub path of the file or directory.
+
+        Returns:
+             The actual location of the file or directory.
+        """
+        raise NotImplementedError("Not implemented yet")
+
     @staticmethod
     def check_fileset_namespace(namespace: Namespace):
         Namespace.check(

clients/client-python/gravitino/dto/responses/file_location_response.py

@@ -0,0 +1,42 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+from dataclasses import dataclass, field
+
+from dataclasses_json import config
+from gravitino.dto.responses.base_response import BaseResponse
+from gravitino.exceptions.base import IllegalArgumentException
+
+
+@dataclass
+class FileLocationResponse(BaseResponse):
+    """Response for the actual file location."""
+
+    _file_location: str = field(metadata=config(field_name="fileLocation"))
+
+    def file_location(self) -> str:
+        return self._file_location
+
+    def validate(self):
+        """Validates the response data.
+
+        Raises:
+            IllegalArgumentException if file location is not set.
+        """
+        super().validate()
+        if self._file_location is None or len(self.file_location()) == 0:
+            raise IllegalArgumentException("file location must not be null")

clients/client-python/tests/unittests/audit/__init__.py

@@ -0,0 +1,16 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.

clients/client-python/tests/unittests/audit/test_caller_context.py

@@ -0,0 +1,35 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+import unittest
+from typing import Dict
+
+from gravitino.audit.caller_context import CallerContextHolder, CallerContext
+
+
+class TestCallerContext(unittest.TestCase):
+
+    def test_caller_context(self):
+        try:
+            context: Dict = {"k1": "v1", "k2": "v2"}
+            caller_context: CallerContext = CallerContext(context)
+            CallerContextHolder.set(caller_context)
+            self.assertEqual(CallerContextHolder.get().context()["k1"], context["k1"])
+            self.assertEqual(CallerContextHolder.get().context()["k2"], context["k2"])
+        finally:
+            CallerContextHolder.remove()
+
+        self.assertIsNone(CallerContextHolder.get())

clients/client-python/tests/unittests/test_responses.py

@@ -0,0 +1,41 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+import json
+import unittest
+
+from gravitino.dto.responses.file_location_response import FileLocationResponse
+from gravitino.exceptions.base import IllegalArgumentException
+
+
+class TestResponses(unittest.TestCase):
+    def test_file_location_response(self):
+        json_data = {"code": 0, "fileLocation": "file:/test/1"}
+        json_str = json.dumps(json_data)
+        file_location_resp: FileLocationResponse = FileLocationResponse.from_json(
+            json_str
+        )
+        self.assertEqual(file_location_resp.file_location(), "file:/test/1")
+        file_location_resp.validate()
+
+    def test_file_location_response_exception(self):
+        json_data = {"code": 0, "fileLocation": ""}
+        json_str = json.dumps(json_data)
+        file_location_resp: FileLocationResponse = FileLocationResponse.from_json(
+            json_str
+        )
+        with self.assertRaises(IllegalArgumentException):
+            file_location_resp.validate()