MISP
/
PyMISPGalaxies
mirror of https://github.com/MISP/PyMISPGalaxies
2
0
Fork 0
Code Issues Releases Wiki Activity

fix: to_json sort_keys is required for consistent output

pull/28/head
Christophe Vandeplas 2024-06-25 13:12:57 +02:00
parent 92cc8e36d3
commit 295d0d8bc3
No known key found for this signature in database
GPG Key ID: BDC48619FFDC5A5B
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
pymispgalaxies/api.py
View File

@ -60,7 +60,7 @@ class Galaxy():
uuid (str): The UUID of the galaxy. uuid (str): The UUID of the galaxy.
namespace (str, optional): The namespace of the galaxy. namespace (str, optional): The namespace of the galaxy.
kill_chain_order (Dict, optional): The kill chain order of the galaxy. kill_chain_order (Dict, optional): The kill chain order of the galaxy.
__init_hash (int): The hash of the json representation of the galaxy at __init__(). _init_hash (int): The hash of the json representation of the galaxy at __init__().
""" """
def __init__(self, galaxy: Union[str, Dict[str, str]]): def __init__(self, galaxy: Union[str, Dict[str, str]]):
@ -86,7 +86,7 @@ class Galaxy():
self.uuid = self.galaxy['uuid'] self.uuid = self.galaxy['uuid']
self.namespace = self.galaxy.pop('namespace', None) self.namespace = self.galaxy.pop('namespace', None)
self.kill_chain_order = self.galaxy.pop('kill_chain_order', None) self.kill_chain_order = self.galaxy.pop('kill_chain_order', None)
self.__init_hash: int = hash(self.to_json()) self._init_hash: int = hash(self.to_json())
def save(self, file_name: str, update_version: bool = True) -> None: def save(self, file_name: str, update_version: bool = True) -> None:
""" """
@ -111,7 +111,7 @@ class Galaxy():
Returns: Returns:
bool: True if the galaxy has changed, False otherwise. bool: True if the galaxy has changed, False otherwise.
""" """
return hash(self.to_json()) != self.__init_hash return hash(self.to_json()) != self._init_hash
def to_json(self) -> str: def to_json(self) -> str:
""" """
@ -120,7 +120,7 @@ class Galaxy():
Returns: Returns:
str: The JSON representation of the galaxy object. str: The JSON representation of the galaxy object.
""" """
return json.dumps(self, cls=EncodeGalaxies) return json.dumps(self, cls=EncodeGalaxies, sort_keys=True)
def to_dict(self) -> Dict[str, str]: def to_dict(self) -> Dict[str, str]:
""" """
@ -251,7 +251,7 @@ class ClusterValueMeta():
self.additional_properties = m self.additional_properties = m
def to_json(self) -> str: def to_json(self) -> str:
return json.dumps(self, cls=EncodeClusters) return json.dumps(self, cls=EncodeClusters, sort_keys=True)
def to_dict(self) -> Dict[str, str]: def to_dict(self) -> Dict[str, str]:
to_return = {} to_return = {}
@ -380,7 +380,7 @@ class ClusterValue():
Returns: Returns:
str: The JSON representation of the ClusterValue object. str: The JSON representation of the ClusterValue object.
""" """
return json.dumps(self, cls=EncodeClusters) return json.dumps(self, cls=EncodeClusters, sort_keys=True)
def to_dict(self) -> Dict[str, Any]: def to_dict(self) -> Dict[str, Any]:
""" """
@ -417,7 +417,7 @@ class Cluster(Mapping): # type: ignore
category (str): The category of the cluster. category (str): The category of the cluster.
cluster_values (Dict[str, ClusterValue]): A dictionary containing the cluster values, where the keys are the values of the cluster and the values are instances of the ClusterValue class. cluster_values (Dict[str, ClusterValue]): A dictionary containing the cluster values, where the keys are the values of the cluster and the values are instances of the ClusterValue class.
duplicates (List[Tuple[str, str]]): A list of tuples representing duplicate values in the cluster, where each tuple contains the name of the cluster and the duplicate value. duplicates (List[Tuple[str, str]]): A list of tuples representing duplicate values in the cluster, where each tuple contains the name of the cluster and the duplicate value.
__init_hash (int): The hash of the json representation of the cluster at __init__(). _init_hash (int): The hash of the json representation of the cluster at __init__().
Methods: Methods:
__init__(self, cluster: Union[Dict[str, Any], str], skip_duplicates: bool = False): Initializes a Cluster object from a dict or existing cluster file __init__(self, cluster: Union[Dict[str, Any], str], skip_duplicates: bool = False): Initializes a Cluster object from a dict or existing cluster file
@ -465,7 +465,7 @@ class Cluster(Mapping): # type: ignore
self.append(new_cluster_value, skip_duplicates) self.append(new_cluster_value, skip_duplicates)
except KeyError: except KeyError:
pass pass
self.__init_hash: int = hash(self.to_json()) self._init_hash: int = hash(self.to_json())
@overload @overload
def search(self, query: str, return_tags: Literal[False] = False) -> List[ClusterValue]: def search(self, query: str, return_tags: Literal[False] = False) -> List[ClusterValue]:
@ -597,7 +597,7 @@ class Cluster(Mapping): # type: ignore
Returns: Returns:
bool: True if the cluster has changed, False otherwise. bool: True if the cluster has changed, False otherwise.
""" """
return hash(self.to_json()) != self.__init_hash return hash(self.to_json()) != self._init_hash
def __str__(self) -> str: def __str__(self) -> str:
""" """
@ -645,7 +645,7 @@ class Cluster(Mapping): # type: ignore
Returns: Returns:
str: The JSON representation of the Cluster object. str: The JSON representation of the Cluster object.
""" """
return json.dumps(self, cls=EncodeClusters) return json.dumps(self, cls=EncodeClusters, sort_keys=True)
def to_dict(self) -> Dict[str, Any]: def to_dict(self) -> Dict[str, Any]:
""" """