Merge pull request #134 from inaka/ferigis.133.close_connection

[#133] create a method for closing the apns connection

rebar.config

@@ -30,6 +30,7 @@
   {test, [
     {deps, [
       {katana_test, "0.1.1"},
+      {katana, "0.3.1"},
       {mixer, "0.1.5", {pkg, inaka_mixer}},
       {meck, "0.8.4"}
     ]}

src/apns.erl

@@ -17,12 +17,13 @@
 %%% @copyright Inaka <[email protected]>
 %%%
 -module(apns).
--author("Felipe Ripoll <felipes@inakanetworks.com>").
+-author("Felipe Ripoll <felipe@inakanetworks.com>").
 
 %% API
 -export([ start/0
         , stop/0
         , connect/1
+        , close_connection/1
         ]).
 
 %%%===================================================================
@@ -41,7 +42,7 @@ stop() ->
   ok = application:stop(apns),
   ok.
 
-%% @doc Connect to APNs service with Provider Certificate
+%% @doc Connects to APNs service with Provider Certificate
 -spec connect( apns_connection:name()
              | apns_connection:connection()) -> {ok, pid()}.
 connect(ConnectionName) when is_atom(ConnectionName) ->
@@ -51,6 +52,11 @@ connect(Connection) ->
   {ok, _} = apns_sup:create_connection(Connection),
   {ok, whereis(apns_connection:name(Connection))}.
 
+%% @doc Closes the connection with APNs service.
+-spec close_connection(apns_connection:name()) -> ok.
+close_connection(ConnectionName) ->
+  apns_connection:close_connection(ConnectionName).
+
 %%%===================================================================
 %%% Internal Functions
 %%%===================================================================

src/apns_connection.erl

@@ -17,7 +17,7 @@
 %%% @copyright Inaka <[email protected]>
 %%%
 -module(apns_connection).
--author("Felipe Ripoll <ferigis@inakanetworks.com>").
+-author("Felipe Ripoll <felipe@inakanetworks.com>").
 
 -behaviour(gen_server).
 
@@ -30,6 +30,7 @@
         , certfile/1
         , keyfile/1
         , gun_connection/1
+        , close_connection/1
         ]).
 
 %% gen_server callbacks
@@ -89,6 +90,11 @@ default_connection(ConnectionName) ->
    , keyfile    => Keyfile
   }.
 
+%% @doc Close the connection with APNs gracefully
+-spec close_connection(name()) -> ok.
+close_connection(ConnectionName) ->
+  gen_server:cast(ConnectionName, stop).
+
 %% @doc Returns the gun's connection PID. This function is only used in tests.
 -spec gun_connection(name()) -> pid().
 gun_connection(ConnectionName) ->
@@ -118,6 +124,8 @@ handle_call(_Request, _From, State) ->
 
 -spec handle_cast(Request :: term(), State) ->
   {noreply, State}.
+handle_cast(stop, State) ->
+  {stop, normal, State};
 handle_cast(_Request, State) ->
   {noreply, State}.
 
@@ -134,8 +142,8 @@ handle_info(_Info, State) ->
   {noreply, State}.
 
 -spec terminate( Reason :: (normal | shutdown | {shutdown, term()} | term())
-               , State  :: map()
-               ) -> term().
+               , State  :: state()
+               ) -> ok.
 terminate(_Reason, _State) ->
   ok.
 

src/apns_sup.erl

@@ -62,12 +62,12 @@ init([]) ->
               , period    => 3600
               },
 
-  Children = [#{ id       => apns_connection_sup
-               , start    => {apns_connection_sup, start_link, []}
+  Children = [#{ id       => apns_connection
+               , start    => {apns_connection, start_link, []}
                , restart  => transient
                , shutdown => 5000
-               , type     => supervisor
-               , modules  => [apns_connection_sup]
+               , type     => worker
+               , modules  => [apns_connection]
                }],
 
   {ok, {SupFlags, Children}}.

test/connection_SUITE.erl

@@ -58,6 +58,8 @@ connect(_Config) ->
   {ok, ServerPid}  = apns:connect(ConnectionName),
   true = is_process_alive(ServerPid),
   ServerPid = whereis(ConnectionName),
+  ok = apns:close_connection(ConnectionName),
+  ktn_task:wait_for(fun() -> whereis(ConnectionName) end, undefined),
   ok.
 
 -spec gun_connection_crashes(config()) -> ok.
@@ -70,11 +72,12 @@ gun_connection_crashes(_Config) ->
   GunPid = apns_connection:gun_connection(ConnectionName),
   true = is_process_alive(GunPid),
   GunPid ! crash,
-  timer:sleep(1000),
-  false = is_process_alive(GunPid),
+  ktn_task:wait_for(fun() -> is_process_alive(GunPid) end, false),
   GunPid2 = apns_connection:gun_connection(ConnectionName),
   true = is_process_alive(GunPid2),
   true = (GunPid =/= GunPid2),
+  ok = apns:close_connection(ConnectionName),
+  ktn_task:wait_for(fun() -> is_process_alive(GunPid2) end, false),
   [_] = meck:unload(),
   ok.