Merge pull request #528 from pvanheus/add_history_copy

Add copy_history verb and associated test

Author: nsoranzo

bioblend/_tests/TestGalaxyHistories.py

@@ -28,6 +28,19 @@ def test_create_history(self):
         assert new_history["name"] == history_name
         assert new_history["url"] is not None
 
+    def test_copy_history(self):
+        history_id = self.history["id"]
+        dataset1_id = self._test_dataset(history_id)
+        copied_history_name = "Copied History"
+        copied_history = self.gi.histories.copy_history(history_id, name=copied_history_name)
+        assert copied_history["id"] is not None
+        assert copied_history["name"] == copied_history_name
+        copied_history_contents = self.gi.histories.show_history(copied_history["id"], contents=True)
+        assert len(copied_history_contents) == 1
+        assert copied_history_contents[0]["hid"] == 1
+        assert copied_history_contents[0]["history_id"] == copied_history["id"]
+        assert copied_history_contents[0]["id"] != dataset1_id
+
     def test_update_history(self):
         new_name = "buildbot - automated test renamed"
         new_annotation = f"Annotation for {new_name}"

bioblend/galaxy/histories/__init__.py

@@ -55,6 +55,31 @@ def create_history(self, name: str | None = None) -> dict[str, Any]:
             payload["name"] = name
         return self._post(payload)
 
+    def copy_history(self, history_id: str, name: str | None = None, all_datasets: bool = False) -> dict[str, Any]:
+        """
+        Create a new history by copying an existing one.
+
+        :type history_id: str
+        :param history_id: ID of the history to copy.
+
+        :type name: str
+        :param name: Optional name for new history
+
+        :type all_datasets: bool
+        :param all_datasets: Whether to copy also deleted datasets and dataset collections.
+
+        :rtype: dict
+        :return: Dictionary containing information about the newly created history
+        """
+        payload: dict[str, Any] = {"source": "history"}
+        if name is not None:
+            payload["name"] = name
+        payload["history_id"] = history_id
+        if all_datasets:
+            payload["all_datasets"] = all_datasets
+
+        return self._post(payload)
+
     def import_history(self, file_path: str | None = None, url: str | None = None) -> dict[str, Any]:
         """
         Import a history from an archive on disk or a URL.