Merge pull request #16 from antmendoza/add-defaults_v3

added-default-values

Author: antmendoza

README.md

@@ -7,6 +7,10 @@ With the SDK you can:
 * Parse workflow JSON and YAML definitions
 * Validate workflow definitions
 
+### Status
+
+Current sdk version conforms to the [Serverless Workflow specification v0.8](https://github.com/serverlessworkflow/specification/tree/0.8.x).
+
 
 ## Install dependencies and run test 
 
@@ -26,7 +30,7 @@ python setup.py pytest
 
 ```
  workflow = Workflow(
-        id_="greeting",
+        id="greeting",
         name="Greeting Workflow",
         description="Greet Someone",
         version='1.0',

serverlessworkflow/sdk/action.py

@@ -5,13 +5,12 @@
 from serverlessworkflow.sdk.action_data_filter import ActionDataFilter
 from serverlessworkflow.sdk.event_ref import EventRef
 from serverlessworkflow.sdk.function_ref import FunctionRef
-from serverlessworkflow.sdk.hydration import ComplexTypeOf, UnionTypeOf, SimpleTypeOf, HydratableParameter, \
-    Fields
 from serverlessworkflow.sdk.sleep import Sleep
 from serverlessworkflow.sdk.sub_flow_ref import SubFlowRef
+from serverlessworkflow.sdk.swf_base import ComplexTypeOf, UnionTypeOf, SimpleTypeOf, HydratableParameter, SwfBase
 
 
-class Action:
+class Action(SwfBase):
     id: str = None
     name: str = None
     functionRef: (str | FunctionRef) = None
@@ -39,11 +38,10 @@ def __init__(self,
                  eslavida: str = None,
                  **kwargs):
 
-        Fields(locals(), kwargs, Action.f_hydration).set_to_object(self)
+        SwfBase.__init__(self, locals(), kwargs, Action.f_hydration)
 
     @staticmethod
     def f_hydration(p_key, p_value):
-
         parameter = HydratableParameter(value=p_value)
         if p_key == 'functionRef':
             return parameter.hydrateAs(UnionTypeOf([SimpleTypeOf(str), ComplexTypeOf(FunctionRef)]))

serverlessworkflow/sdk/action_data_filter.py

@@ -1,7 +1,7 @@
-from serverlessworkflow.sdk.hydration import Fields
+from serverlessworkflow.sdk.swf_base import SwfBase
 
 
-class ActionDataFilter:
+class ActionDataFilter(SwfBase):
     fromStateData: str = None
     useResults: bool = None
     results: str = None
@@ -13,4 +13,4 @@ def __init__(self,
                  results: str = None,
                  toStateData: str = None,
                  **kwargs):
-        Fields(locals(), kwargs, Fields.default_hydration).set_to_object(self)
+        SwfBase.__init__(self, locals(), kwargs, SwfBase.default_hydration)

serverlessworkflow/sdk/auth_def.py

@@ -4,11 +4,11 @@
 
 from serverlessworkflow.sdk.basic_props_def import BasicPropsDef
 from serverlessworkflow.sdk.bearer_props_def import BearerPropsDef
-from serverlessworkflow.sdk.hydration import Fields
 from serverlessworkflow.sdk.oauth2props_def import Oauth2PropsDef
+from serverlessworkflow.sdk.swf_base import SwfBase
 
 
-class AuthDef:
+class AuthDef(SwfBase):
     name: str = None
     scheme: str = None
     properties: (str | (BasicPropsDef | BearerPropsDef | Oauth2PropsDef)) = None
@@ -18,19 +18,20 @@ def __init__(self,
                  scheme: str = None,
                  properties: (str | (BasicPropsDef | BearerPropsDef | Oauth2PropsDef)) = None,
                  **kwargs):
-        Fields(locals(), kwargs, Fields.f_hydration).set_to_object(self)
+
+        _default_values = {'scheme': 'basic'}
+        SwfBase.__init__(self, locals(), kwargs, SwfBase.default_hydration, _default_values)
 
     @staticmethod
     def f_hydration(p_key, p_value):
-
         result = copy.deepcopy(p_value)
 
         if p_key == 'properties':
             if p_value["username"] and p_value["password"]:
-                return BasicPropsDef(p_value);
+                return BasicPropsDef(p_value)
             if p_value["token"]:
-                return BearerPropsDef(p_value);
+                return BearerPropsDef(p_value)
             if p_value["grantType"]:
-                return Oauth2PropsDef(p_value);
+                return Oauth2PropsDef(p_value)
 
         return result

serverlessworkflow/sdk/basic_props_def.py

@@ -1,8 +1,8 @@
-from serverlessworkflow.sdk.hydration import Fields
 from serverlessworkflow.sdk.metadata import Metadata
+from serverlessworkflow.sdk.swf_base import SwfBase
 
 
-class BasicPropsDef:
+class BasicPropsDef(SwfBase):
     username: str = None
     password: str = None
     metadata: Metadata = None
@@ -12,4 +12,4 @@ def __init__(self,
                  password: str = None,
                  metadata: Metadata = None,
                  **kwargs):
-        Fields(locals(), kwargs, Fields.default_hydration).set_to_object(self)
+        SwfBase.__init__(self, locals(), kwargs, SwfBase.default_hydration)

serverlessworkflow/sdk/bearer_props_def.py

@@ -1,13 +1,13 @@
-from serverlessworkflow.sdk.hydration import Fields
 from serverlessworkflow.sdk.metadata import Metadata
+from serverlessworkflow.sdk.swf_base import SwfBase
 
 
-class BearerPropsDef:
+class BearerPropsDef(SwfBase):
     token: str = None
     metadata: Metadata = None
 
     def __init__(self,
                  token: str = None,
                  metadata: Metadata = None,
                  **kwargs):
-        Fields(locals(), kwargs, Fields.default_hydration).set_to_object(self)
+        SwfBase.__init__(self, locals(), kwargs, SwfBase.default_hydration)

serverlessworkflow/sdk/branch.py

@@ -2,10 +2,10 @@
 
 from serverlessworkflow.sdk.action import Action
 from serverlessworkflow.sdk.branch_timeout import BranchTimeOut
-from serverlessworkflow.sdk.hydration import ArrayTypeOf, ComplexTypeOf, HydratableParameter, Fields
+from serverlessworkflow.sdk.swf_base import ArrayTypeOf, ComplexTypeOf, HydratableParameter, SwfBase
 
 
-class Branch:
+class Branch(SwfBase):
     name: str = None
     timeouts: BranchTimeOut = None
     actions: [Action] = None
@@ -15,7 +15,8 @@ def __init__(self,
                  timeouts: BranchTimeOut = None,
                  actions: [Action] = None,
                  **kwargs):
-        Fields(locals(), kwargs, Branch.f_hydration).set_to_object(self)
+
+        SwfBase.__init__(self, locals(), kwargs, Branch.f_hydration)
 
     @staticmethod
     def f_hydration(p_key, p_value):

serverlessworkflow/sdk/branch_timeout.py

@@ -1,12 +1,12 @@
-from serverlessworkflow.sdk.hydration import Fields
+from serverlessworkflow.sdk.swf_base import SwfBase
 
 
-class BranchTimeOut:
+class BranchTimeOut(SwfBase):
     actionExecTimeOut: str = None  # ActionExecTimeOut
     branchExecTimeOut: str = None  # BranchExecTimeOut
 
     def __init__(self,
                  actionExecTimeOut: str = None,
                  branchExecTimeOut: str = None,
                  **kwargs):
-        Fields(locals(), kwargs, Fields.default_hydration).set_to_object(self)
+        SwfBase.__init__(self, locals(), kwargs, SwfBase.default_hydration)

serverlessworkflow/sdk/callback_state.py

@@ -7,15 +7,15 @@
 from serverlessworkflow.sdk.end import End
 from serverlessworkflow.sdk.error import Error
 from serverlessworkflow.sdk.event_data_filter import EventDataFilter
-from serverlessworkflow.sdk.hydration import ComplexTypeOf, ArrayTypeOf, HydratableParameter, SimpleTypeOf, \
-    UnionTypeOf, Fields
 from serverlessworkflow.sdk.metadata import Metadata
 from serverlessworkflow.sdk.state import State
 from serverlessworkflow.sdk.state_data_filter import StateDataFilter
+from serverlessworkflow.sdk.swf_base import ComplexTypeOf, ArrayTypeOf, HydratableParameter, SimpleTypeOf, \
+    UnionTypeOf, SwfBase
 from serverlessworkflow.sdk.transition import Transition
 
 
-class CallbackState(State):
+class CallbackState(State, SwfBase):
     id: str = None
     name: str = None
     type: str = None
@@ -48,11 +48,11 @@ def __init__(self,
                  metadata: Metadata = None,
                  **kwargs):
 
-        Fields(locals(), kwargs, Fields.f_hydration).set_to_object(self)
+        _default_values = {'type': 'callback', 'usedForCompensation': False, }
+        SwfBase.__init__(self, locals(), kwargs, SwfBase.default_hydration, _default_values)
 
     @staticmethod
     def f_hydration(p_key, p_value):
-
         if p_key == 'action':
             return HydratableParameter(value=p_value).hydrateAs(ComplexTypeOf(Action))
 

serverlessworkflow/sdk/callback_state_timeout.py

@@ -1,10 +1,10 @@
 import copy
 
-from serverlessworkflow.sdk.hydration import HydratableParameter, ComplexTypeOf, Fields
 from serverlessworkflow.sdk.state_exec_timeout import StateExecTimeOut
+from serverlessworkflow.sdk.swf_base import HydratableParameter, ComplexTypeOf, SwfBase
 
 
-class CallbackStateTimeOut:
+class CallbackStateTimeOut(SwfBase):
     stateExecTimeOut: StateExecTimeOut = None
     actionExecTimeOut: str = None  # ActionExecTimeOut
     eventTimeOut: str = None  # EventTimeOut
@@ -14,7 +14,7 @@ def __init__(self,
                  actionExecTimeOut: str = None,
                  eventTimeOut: str = None,
                  **kwargs):
-        Fields(locals(), kwargs, CallbackStateTimeOut.f_hydration).set_to_object(self)
+        SwfBase.__init__(self, locals(), kwargs, CallbackStateTimeOut.f_hydration)
 
     @staticmethod
     def f_hydration(p_key, p_value):