Update type specifications

Author: Szymon Mentel

src/dobby_oflib.erl

@@ -36,17 +36,17 @@ get_path(SrcEndpoint, DstEndpoint) ->
 %%
 %% The function returns Net Flow Identifier: `NetFlowId' that can be
 %% used for referencing published Net Flow.
--spec publish_new_flow(identifier(), identifier(), flow_path()) ->
+-spec publish_new_flow(dby_identifier(), dby_identifier(), flow_path()) ->
                               Result when
-      Result :: {ok, NetFlowId :: endpoint()}
+      Result :: {ok, NetFlowId :: dby_endpoint()}
               | {error, Reason :: term()}.
 
 publish_new_flow(SrcEndpoint, DstEndpoint, FlowPath) ->
     NfId = publish_net_flow_identifier(SrcEndpoint, DstEndpoint),
     publish_flow_path(NfId, FlowPath),
     lager:info("Published NetFlow: ~p between endpoints src: ~p dst: ~p ~n",
                [NfId, SrcEndpoint, DstEndpoint]),
-    NfId.
+    {ok, NfId}.
 
 %%%=============================================================================
 %%% Internal functions

src/dofl_identifier.erl

@@ -21,22 +21,20 @@
 %%% External functions
 %%%=============================================================================
 
--spec net_flow(Src :: identifier(), Dst :: identifier()) -> NetFlow :: endpoint().
+-spec net_flow(dby_identifier(), dby_identifier()) -> dby_endpoint().
 
 net_flow(Src, Dst) ->
     {<<"NF:", Src/binary, ":", Dst/binary>>, #{type => of_net_flow}}.
 
--spec flow_mod(Dpid :: binary(), OFVersion :: of_version(), FlowMod :: flow_mod())
-              -> FlowModId :: endpoint().
+-spec flow_mod(dby_identifier(), of_version(), flow_mod()) -> dby_endpoint().
 
 flow_mod(Dpid, OFVersion, FlowMod) ->
     {_Matches, _Instructions, Opts} = FlowMod,
     Cookie = proplists:get_value(cookie, Opts),
     {Cookie, #{type => of_flow_mod, dpid => Dpid, of_version => OFVersion}}.
 
 
--spec flow_table(DatapathId :: binary(), FlowMod :: flow_mod())
-                -> FlowTableId :: idenfier().
+-spec flow_table(dby_identifier(), flow_mod()) -> dby_identifier().
 
 flow_table(DatapahtId, {_Matches, _Actions, Opts}) ->
     TableNo = proplists:get_value(table_id, Opts),

src/dofl_link_metadata.erl

@@ -21,28 +21,26 @@
 %%% External functions
 %%%=============================================================================
 
--spec endpoint_with_net_flow(Src :: identifier()) -> Metadata :: map().
+-spec endpoint_with_net_flow(dby_identifier()) -> map().
 
 endpoint_with_net_flow(Src) ->
     #{type => ep_to_nf, src => Src}.
 
 
--spec net_flow_with_flow_mod(Src :: identifier(), NetFlowId :: identifier())
-                            -> Metadata :: map().
+-spec net_flow_with_flow_mod(dby_identifier(), dby_identifier()) -> map().
 
 net_flow_with_flow_mod(Src, NetFlowId) when Src =:= NetFlowId ->
     #{type => of_path_starts_at, src => Src, net_flow_ids => [NetFlowId]};
 net_flow_with_flow_mod(Src, NetFlowId) ->
     #{type => of_path_ends_at, src => Src, net_flow_ids => [NetFlowId]}.
 
 
--spec between_flow_mods(Src :: identifier(), NetFlowId :: identifier()) ->
-                               Metadata :: map().
+-spec between_flow_mods(dby_identifier(), dby_identifier()) -> map().
 
 between_flow_mods(Src, NetFlowId) ->
     #{type => of_path_forwards_to, src => Src, net_flow_ids => [NetFlowId]}.
 
--spec flow_mod_with_flow_table() -> Metadata :: map().
+-spec flow_mod_with_flow_table() -> map().
 
 flow_mod_with_flow_table() ->
     #{type => of_resource}.

test/dobby_oflib_SUITE.erl

@@ -46,7 +46,7 @@ should_publish_net_flow(_Config) ->
     FlowPath = dofl_test_utils:flow_path(),
 
     %% WHEN
-    NetFlowId = dobby_oflib:publish_new_flow(?SRC_EP, ?DST_EP, FlowPath),
+    {ok, NetFlowId} = dobby_oflib:publish_new_flow(?SRC_EP, ?DST_EP, FlowPath),
 
     %% THEN
     assert_net_flow_published(?SRC_EP, ?DST_EP, NetFlowId).
@@ -57,7 +57,7 @@ should_publish_flow_path(_Config) ->
     FlowPath1 = reconstruct_flow_path(FlowPath0),
 
     %% WHEN
-    NetFlowId = dobby_oflib:publish_new_flow(?SRC_EP, ?DST_EP, FlowPath0),
+    {ok, NetFlowId} = dobby_oflib:publish_new_flow(?SRC_EP, ?DST_EP, FlowPath0),
 
     %% THEN
     assert_flow_path_published(NetFlowId, FlowPath1).

test/dofl_with_server_SUITE.erl

@@ -52,7 +52,7 @@ should_publish_net_flow(_Config) ->
                           {of_path_ends_at, ep_to_nf}],
 
     %% WHEN
-    NetFlowId = dobby_oflib:publish_new_flow(SrcEP, DstEP, FlowPath),
+    {ok, NetFlowId} = dobby_oflib:publish_new_flow(SrcEP, DstEP, FlowPath),
     Expected = lists:flatten([SrcEP, NetFlowId, FlowPathIds, NetFlowId, DstEP]),
 
     %% THEN