feat: add option to sort before store

While storing workspace content on GitHub it is useful to have sorted content of YAML files. Therefore, the sort option is added. It is set to False because of backward compatibility.

JIRA: PSDK-220
risk: low

Author: hkad98

docs/content/en/latest/workspace-content/analytics-model/store_analytics_model_to_disk.md

@@ -5,7 +5,7 @@ weight: 131
 superheading: "catalog_workspace_content."
 ---
 
-``store_analytics_model_to_disk(workspace_id: str, path: Path = Path.cwd())``
+``store_analytics_model_to_disk(workspace_id: str, path: Path = Path.cwd(), exclude: Optional[list[str]] = None, sort: bool = False)``
 
 Stores analytics model for a given workspace in directory hierarchy.This method does not tie the declarative analytics model to the workspace and organization, thus it is recommended for migration between workspaces. If you want to backup analytics model between workspaces or organizations, use [store_analytics_model_to_disk](../store_analytics_model_to_disk/).
 
@@ -31,6 +31,12 @@ Workspace identification string e.g. "demo"
 {{< parameter p_name="path" p_type="Optional[Path]" >}}
 Path to the root of the layout directory. Defaults to Path.cwd().
 {{< /parameter >}}
+{{< parameter p_name="exclude" p_type=" Optional[list[str]]" >}}
+Defines properties which should not be included in the result. E.g.: ["ACTIVITY_INFO"] – refers to createdBy, etc. Default is None.
+{{< /parameter >}}
+{{< parameter p_name="sort" p_type="bool" >}}
+Flag if the output should be sorted before storing to disk. Default is False.
+{{< /parameter >}}
 {{% /parameters-block %}}
 
 {{% parameters-block title="Returns" None="yes" %}}

docs/content/en/latest/workspace-content/logical-data-model/store_ldm_to_disk.md

@@ -6,7 +6,7 @@ superheading: "catalog_workspace_content."
 ---
 
 
-``store_ldm_to_disk(workspace_id: str, path: Path = Path.cwd())``
+``store_ldm_to_disk(workspace_id: str, path: Path = Path.cwd(), sort: bool = False)``
 
 Stores the declarative logical data model for a given workspace in directory hierarchy. This method does not tie the LDM to the workspace and organization, thus it is recommended for migration between organizations. If you want to backup LDM use [store_declarative_ldm](../store_declarative_ldm/).
 
@@ -26,6 +26,9 @@ Workspace identification string e.g. "demo"
 {{< parameter p_name="path" p_type="Optional[Path]" >}}
 Path to the root of the layout directory. Defaults to Path.cwd().
 {{< /parameter >}}
+{{< parameter p_name="sort" p_type="bool" >}}
+Flag if the output should be sorted before storing to disk. Default is False.
+{{< /parameter >}}
 {{% /parameters-block %}}
 
 {{% parameters-block title="Returns" None="yes" %}}

gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/data_source.py

@@ -110,11 +110,11 @@ def client_class() -> type[DeclarativeDataSources]:
     def data_sources_folder(layout_organization_folder: Path) -> Path:
         return layout_organization_folder / LAYOUT_DATA_SOURCES_DIR
 
-    def store_to_disk(self, layout_organization_folder: Path) -> None:
+    def store_to_disk(self, layout_organization_folder: Path, sort: bool = False) -> None:
         data_sources_folder = self.data_sources_folder(layout_organization_folder)
         create_directory(data_sources_folder)
         for data_source in self.data_sources:
-            data_source.store_to_disk(data_sources_folder)
+            data_source.store_to_disk(data_sources_folder, sort=sort)
 
     @classmethod
     def load_from_disk(cls, layout_organization_folder: Path) -> CatalogDeclarativeDataSources:
@@ -201,12 +201,12 @@ def to_api(
             dictionary["client_secret"] = client_secret
         return self.client_class().from_dict(dictionary)
 
-    def store_to_disk(self, data_sources_folder: Path) -> None:
+    def store_to_disk(self, data_sources_folder: Path, sort: bool = False) -> None:
         data_source_folder = self.data_source_folder(data_sources_folder, self.id)
         file_path = data_source_folder / f"{self.id}.yaml"
         data_source_dict = self.to_api().to_dict(camel_case=True)
 
-        write_layout_to_file(file_path, data_source_dict)
+        write_layout_to_file(file_path, data_source_dict, sort=sort)
 
     @classmethod
     def load_from_disk(cls, data_sources_folder: Path, data_source_id: str) -> CatalogDeclarativeDataSource:

gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/physical_model/table.py

@@ -25,10 +25,10 @@ class CatalogDeclarativeTable(Base):
     def client_class() -> builtins.type[DeclarativeTable]:
         return DeclarativeTable
 
-    def store_to_disk(self, pdm_folder: Path) -> None:
+    def store_to_disk(self, pdm_folder: Path, sort: bool = False) -> None:
         table_dict = self.to_api().to_dict(camel_case=True)
         table_file_path = pdm_folder / f"{self.id}.yaml"
-        write_layout_to_file(table_file_path, table_dict)
+        write_layout_to_file(table_file_path, table_dict, sort=sort)
 
     @classmethod
     def load_from_disk(cls, table_file_path: Path) -> CatalogDeclarativeTable:

gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user.py

@@ -34,12 +34,12 @@ def load_from_disk(cls, layout_organization_folder: Path) -> CatalogDeclarativeU
         users = [CatalogDeclarativeUser.from_dict(record, camel_case=True) for record in data]
         return cls(users=users)
 
-    def store_to_disk(self, layout_organization_folder: Path) -> None:
+    def store_to_disk(self, layout_organization_folder: Path, sort: bool = False) -> None:
         users_directory = layout_organization_folder / LAYOUT_USERS_DIR
         users_file = users_directory / LAYOUT_USERS_FILE
         create_directory(users_directory)
         users = [user.to_dict(camel_case=True) for user in self.users]
-        write_layout_to_file(users_file, users)
+        write_layout_to_file(users_file, users, sort=sort)
 
 
 @attr.s(auto_attribs=True, kw_only=True)

gooddata-sdk/gooddata_sdk/catalog/user/declarative_model/user_group.py

@@ -33,12 +33,12 @@ def load_from_disk(cls, layout_organization_folder: Path) -> CatalogDeclarativeU
         user_groups = [CatalogDeclarativeUserGroup.from_dict(record, camel_case=True) for record in data]
         return cls(user_groups=user_groups)
 
-    def store_to_disk(self, layout_organization_folder: Path) -> None:
+    def store_to_disk(self, layout_organization_folder: Path, sort: bool = False) -> None:
         user_groups_directory = layout_organization_folder / LAYOUT_USER_GROUPS_DIR
         user_groups_file = user_groups_directory / LAYOUT_USER_GROUPS_FILE
         create_directory(user_groups_directory)
         user_groups = [user_group.to_dict(camel_case=True) for user_group in self.user_groups]
-        write_layout_to_file(user_groups_file, user_groups)
+        write_layout_to_file(user_groups_file, user_groups, sort=sort)
 
 
 @attr.s(auto_attribs=True, kw_only=True)

gooddata-sdk/gooddata_sdk/catalog/workspace/content_service.py

@@ -358,7 +358,7 @@ def load_and_put_declarative_ldm(
         declarative_ldm = self.load_declarative_ldm(workspace_id, layout_root_path)
         self.put_declarative_ldm(workspace_id, declarative_ldm, validator, standalone_copy)
 
-    def store_ldm_to_disk(self, workspace_id: str, path: Path = Path.cwd()) -> None:
+    def store_ldm_to_disk(self, workspace_id: str, path: Path = Path.cwd(), sort: bool = False) -> None:
         """Store declarative logical data model for a given workspace in directory hierarchy.
             This method does not tie the LDM to the workspace and organization, thus it is recommended
             for migration between organizations. If you want to backup LDM use store_declarative_ldm.
@@ -368,11 +368,13 @@ def store_ldm_to_disk(self, workspace_id: str, path: Path = Path.cwd()) -> None:
                 Workspace identification string e.g. "demo"
             path (Path, optional):
                 Path to the root of the layout directory. Defaults to Path.cwd().
+            sort (bool, optional):
+                Flag if the output should be sorted before storing to disk. Default is False.
 
         Returns:
             None
         """
-        self.get_declarative_ldm(workspace_id).store_to_disk(path)
+        self.get_declarative_ldm(workspace_id).store_to_disk(path, sort=sort)
 
     @staticmethod
     def load_ldm_from_disk(path: Path = Path.cwd()) -> CatalogDeclarativeModel:
@@ -479,7 +481,7 @@ def load_and_put_declarative_analytics_model(self, workspace_id: str, layout_roo
         self.put_declarative_analytics_model(workspace_id, declarative_analytics_model)
 
     def store_analytics_model_to_disk(
-        self, workspace_id: str, path: Path = Path.cwd(), exclude: Optional[list[str]] = None
+        self, workspace_id: str, path: Path = Path.cwd(), exclude: Optional[list[str]] = None, sort: bool = False
     ) -> None:
         """Store analytics model for a given workspace in directory hierarchy.This method does not tie the declarative
             analytics model to the workspace and organization, thus it is recommended for migration between workspaces.
@@ -491,12 +493,14 @@ def store_analytics_model_to_disk(
             path (Path, optional):
                 Path to the root of the layout directory. Defaults to Path.cwd().
             exclude (Optional[list[str]]):
-                Defines properties which should not be included in the payload. E.g.: ["ACTIVITY_INFO"]
+                Defines properties which should not be included in the result. E.g.: ["ACTIVITY_INFO"] – refers to createdBy, etc. Default is None.
+            sort (bool, optional):
+                Flag if the output should be sorted before storing to disk. Default is False.
 
         Returns:
             None
         """
-        self.get_declarative_analytics_model(workspace_id, exclude).store_to_disk(path)
+        self.get_declarative_analytics_model(workspace_id, exclude).store_to_disk(path, sort=sort)
 
     @staticmethod
     def load_analytics_model_from_disk(path: Path = Path.cwd()) -> CatalogDeclarativeAnalytics:

gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/analytics_model.py

@@ -58,9 +58,9 @@ class CatalogDeclarativeAnalytics(Base):
     def client_class() -> type[DeclarativeAnalytics]:
         return DeclarativeAnalytics
 
-    def store_to_disk(self, workspace_folder: Path) -> None:
+    def store_to_disk(self, workspace_folder: Path, sort: bool = False) -> None:
         if self.analytics is not None:
-            self.analytics.store_to_disk(workspace_folder)
+            self.analytics.store_to_disk(workspace_folder, sort=sort)
 
     @classmethod
     def load_from_disk(cls, workspace_folder: Path) -> CatalogDeclarativeAnalytics:
@@ -137,7 +137,7 @@ def get_export_definition_dif(analytics_model_folder: Path) -> Path:
         create_directory(folder)
         return folder
 
-    def store_to_disk(self, workspace_folder: Path) -> None:
+    def store_to_disk(self, workspace_folder: Path, sort: bool = False) -> None:
         analytics_model_folder = self.get_analytics_model_folder(workspace_folder)
 
         analytical_dashboards_folder = self.get_analytical_dashboards_folder(analytics_model_folder)
@@ -150,28 +150,28 @@ def store_to_disk(self, workspace_folder: Path) -> None:
         export_definition_folder = self.get_export_definition_dif(analytical_dashboards_folder)
 
         for analytical_dashboard in self.analytical_dashboards:
-            analytical_dashboard.store_to_disk(analytical_dashboards_folder)
+            analytical_dashboard.store_to_disk(analytical_dashboards_folder, sort=sort)
 
         for analytical_dashboard_extension in self.analytical_dashboard_extensions:
-            analytical_dashboard_extension.store_to_disk(analytical_dashboard_extensions_folder)
+            analytical_dashboard_extension.store_to_disk(analytical_dashboard_extensions_folder, sort=sort)
 
         for dashboard_plugin in self.dashboard_plugins:
-            dashboard_plugin.store_to_disk(dashboard_plugins_folder)
+            dashboard_plugin.store_to_disk(dashboard_plugins_folder, sort=sort)
 
         for filter_context in self.filter_contexts:
-            filter_context.store_to_disk(filter_contexts_folder)
+            filter_context.store_to_disk(filter_contexts_folder, sort=sort)
 
         for metric in self.metrics:
-            metric.store_to_disk(metrics_folder)
+            metric.store_to_disk(metrics_folder, sort=sort)
 
         for visualization_object in self.visualization_objects:
-            visualization_object.store_to_disk(visualization_objects_folder)
+            visualization_object.store_to_disk(visualization_objects_folder, sort=sort)
 
         for attribute_hierarchy in self.attribute_hierarchies:
-            attribute_hierarchy.store_to_disk(attribute_hierarchy_folder)
+            attribute_hierarchy.store_to_disk(attribute_hierarchy_folder, sort=sort)
 
         for export_definition in self.export_definitions:
-            export_definition.store_to_disk(export_definition_folder)
+            export_definition.store_to_disk(export_definition_folder, sort=sort)
 
     @classmethod
     def load_from_disk(cls, workspace_folder: Path) -> CatalogDeclarativeAnalyticsLayer:

gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/analytics_model/base.py

@@ -15,9 +15,9 @@
 class CatalogAnalyticsObjectBase(Base):
     id: str
 
-    def store_to_disk(self, analytics_folder: Path) -> None:
+    def store_to_disk(self, analytics_folder: Path, sort: bool = False) -> None:
         analytics_file = analytics_folder / f"{self.id}.yaml"
-        write_layout_to_file(analytics_file, self.to_api().to_dict(camel_case=True))
+        write_layout_to_file(analytics_file, self.to_api().to_dict(camel_case=True), sort=sort)
 
     @classmethod
     def load_from_disk(cls: type[T], analytics_file: Path) -> T:

gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/logical_model/dataset/dataset.py

@@ -53,9 +53,9 @@ class CatalogDeclarativeDataset(Base):
     def client_class() -> type[DeclarativeDataset]:
         return DeclarativeDataset
 
-    def store_to_disk(self, datasets_folder: Path) -> None:
+    def store_to_disk(self, datasets_folder: Path, sort: bool = False) -> None:
         dataset_file = datasets_folder / f"{self.id}.yaml"
-        write_layout_to_file(dataset_file, self.to_api().to_dict(camel_case=True))
+        write_layout_to_file(dataset_file, self.to_api().to_dict(camel_case=True), sort=sort)
 
     @classmethod
     def load_from_disk(cls, dataset_file: Path) -> CatalogDeclarativeDataset: