Get GiddyUp consuming riak_test.log

- Have lager fire up an extra handler for each test run
- Place lager output in riak_test.log and upload to GiddyUp
- Remove rt.hrl and move the rt_webhook record into giddyup.erl
- Remove unused GiddyUp code from escript
- Let the test_runner know the name of the log directory so it knows where to put the riak_test.log
- Add separate flag to rt_reporter to indicate the need to upload files to GiddyUp
- Always copy log files to local directory before uploading to GiddyUp

Author: Brett Hazen

include/rt.hrl

@@ -21,7 +21,12 @@
 
 -export([get_suite/1, post_result/1, post_artifact/2]).
 -define(STREAM_CHUNK_SIZE, 8192).
--include("rt.hrl").
+
+-record(rt_webhook, {
+    name :: string(),
+    url :: string(),
+    headers=[] :: [{atom(), string()}]
+}).
 
 -spec get_suite(string()) -> [{atom(), term()}].
 get_suite(Platform) ->

src/giddyup.erl

@@ -20,7 +20,6 @@
 
 %% @private
 -module(riak_test_escript).
--include("rt.hrl").
 %% TODO: Temporary build workaround, remove!!
 -compile(export_all).
 -export([main/1]).
@@ -426,49 +425,7 @@ match_group_attributes(Attributes, Groups) ->
 %%                             TestCount) ||
 %%                       {Test, TestMetaData} <- Tests],
 
-publish_report(_SingleTestResult, _CoverFile, undefined) ->
-    ok;
-publish_report(SingleTestResult, CoverFile, _Report) ->
-    {value, {log, Log}, TestResult} = lists:keytake(log, 1, SingleTestResult),
-    publish_artifacts(TestResult,
-                      Log,
-                      CoverFile,
-                      giddyup:post_result(TestResult)).
-
-publish_artifacts(_TestResult, _Log, _CoverFile, error) ->
-    whoomp; %% there it is
-publish_artifacts(TestResult, Log, CoverFile, {ok, Base}) ->
-            %% Now push up the artifacts, starting with the test log
-            giddyup:post_artifact(Base, {"riak_test.log", Log}),
-            [giddyup:post_artifact(Base, File) || File <- rt:get_node_logs()],
-            post_cover_artifact(Base, CoverFile),
-            ResultPlusGiddyUp = TestResult ++ [{giddyup_url, list_to_binary(Base)}],
-            [rt:post_result(ResultPlusGiddyUp, WebHook) || WebHook <- get_webhooks()].
-
-post_cover_artifact(_Base, cover_disabled) ->
-    ok;
-post_cover_artifact(Base, CoverFile) ->
-    CoverArchiveName = filename:basename(CoverFile) ++ ".gz",
-    CoverArchive = zlib:gzip(element(2, file:read_file(CoverFile))),
-    giddyup:post_artifact(Base, {CoverArchiveName, CoverArchive}).
-
-get_webhooks() ->
-    Hooks = lists:foldl(fun(E, Acc) -> [parse_webhook(E) | Acc] end,
-                        [],
-                        rt_config:get(webhooks, [])),
-    lists:filter(fun(E) -> E =/= undefined end, Hooks).
-
-parse_webhook(Props) ->
-    Url = proplists:get_value(url, Props),
-    case is_list(Url) of
-        true ->
-            #rt_webhook{url= Url,
-                        name=proplists:get_value(name, Props, "Webhook"),
-                        headers=proplists:get_value(headers, Props, [])};
-        false ->
-            lager:error("Invalid configuration for webhook : ~p", Props),
-            undefined
-    end.
+
 
 backend_list(Backend) when is_atom(Backend) ->
     atom_to_list(Backend);

src/riak_test_escript.erl

@@ -63,11 +63,11 @@ init([Tests, LogDir, Platform, UpgradeList, NotifyPid]) ->
 
     ContinueOnFail = rt_config:get(continue_on_fail),
 
-    LogLocation = case Platform of
-                      undefined -> LogDir;
-                      _ -> giddyup
+    UploadToGiddyUp = case Platform of
+                      undefined -> false;
+                      _ -> true
                   end,
-    {ok, Reporter} = rt_reporter:start_link(LogLocation, NotifyPid),
+    {ok, Reporter} = rt_reporter:start_link(UploadToGiddyUp, LogDir, NotifyPid),
 
     lager:notice("Starting the Riak Test executor in ~p execution mode", [ExecutionMode]),
     State = #state{pending_tests=Tests,
@@ -169,14 +169,15 @@ launch_test({nodes, Nodes, NodeMap}, State) ->
            runner_pids=Pids,
            running_tests=Running,
            continue_on_fail=ContinueOnFail,
-           reporter_pid=ReporterPid} = State,
+           reporter_pid=ReporterPid,
+           log_dir=LogDir} = State,
     NextTestModule = rt_test_plan:get_module(NextTestPlan),
     lager:debug("Executing test ~p in mode ~p", [NextTestModule, ExecutionMode]),
     {NextTestPlan, TestProps} = lists:keyfind(NextTestPlan, 1, PropertiesList),
     UpdTestProps = rt_properties:set([{node_map, NodeMap}, {node_ids, Nodes}],
                                      TestProps),
     {RunnerPids, RunningTests} = run_test(ExecutionMode, NextTestPlan, UpdTestProps,
-                                          Pids, Running, ContinueOnFail, ReporterPid),
+                                          Pids, Running, ContinueOnFail, ReporterPid, LogDir),
     UpdState = State#state{pending_tests=RestPending,
                            execution_mode=ExecutionMode,
                            runner_pids=RunnerPids,
@@ -318,11 +319,11 @@ override_props(State) ->
             [{upgrade_path, UpgradeList}]
     end.
 
--spec run_test(parallel | serial, atom(), proplists:proplist(), [pid()], [rt_test_plan:test_plan()], boolean(), pid()) -> {[pid()], [atom()]}.
-run_test(parallel, TestPlan, Properties, RunningPids, RunningTests, ContinueOnFail, ReporterPid) ->
-    Pid = spawn_link(riak_test_runner, start, [TestPlan, Properties, ContinueOnFail, ReporterPid]),
+-spec run_test(parallel | serial, atom(), proplists:proplist(), [pid()], [rt_test_plan:test_plan()], boolean(), pid(), string()) -> {[pid()], [atom()]}.
+run_test(parallel, TestPlan, Properties, RunningPids, RunningTests, ContinueOnFail, ReporterPid, LogDir) ->
+    Pid = spawn_link(riak_test_runner, start, [TestPlan, Properties, ContinueOnFail, ReporterPid, LogDir]),
     {[Pid | RunningPids], [TestPlan | RunningTests]};
-run_test(serial, TestPlan, Properties, RunningPids, RunningTests, ContinueOnFail, ReporterPid) ->
-    riak_test_runner:start(TestPlan, Properties, ContinueOnFail, ReporterPid),
+run_test(serial, TestPlan, Properties, RunningPids, RunningTests, ContinueOnFail, ReporterPid, LogDir) ->
+    riak_test_runner:start(TestPlan, Properties, ContinueOnFail, ReporterPid, LogDir),
     {RunningPids, RunningTests}.
 

src/riak_test_executor.erl

@@ -24,7 +24,7 @@
 -behavior(gen_fsm).
 
 %% API
--export([start/4,
+-export([start/5,
          send_event/2,
          stop/0]).
 
@@ -48,7 +48,6 @@
          terminate/3,
          code_change/4]).
 
--include("rt.hrl").
 -include_lib("eunit/include/eunit.hrl").
 
 -type test_type() :: {new | old}.
@@ -70,7 +69,8 @@
                 remaining_versions :: [string()],
                 test_results :: [term()],
                 continue_on_fail :: boolean(),
-                reporter_pid :: pid()}).
+                log_dir :: string(),
+                reporter_pids :: pid()}).
 
 -deprecated([{metadata,0,next_major_release}]).
 
@@ -79,8 +79,8 @@
 %%%===================================================================
 
 %% @doc Start the test runner
-start(TestPlan, Properties, ContinueOnFail, ReporterPid) ->
-    Args = [TestPlan, Properties, ContinueOnFail, ReporterPid],
+start(TestPlan, Properties, ContinueOnFail, ReporterPids, LogDir) ->
+    Args = [TestPlan, Properties, ContinueOnFail, ReporterPids, LogDir],
     gen_fsm:start_link(?MODULE, Args, []).
 
 send_event(Pid, Msg) ->
@@ -103,7 +103,7 @@ metadata() ->
 
 %% @doc Read the storage schedule and go to idle.
 %% compose_test_datum(Version, Project, undefined, undefined) ->
-init([TestPlan, Properties, ContinueOnFail, ReporterPid]) ->
+init([TestPlan, Properties, ContinueOnFail, ReporterPid, LogDir]) ->
     lager:debug("Started riak_test_runnner with pid ~p (continue on fail: ~p)", [self(), ContinueOnFail]),
     Project = list_to_binary(rt_config:get(rt_project, "undefined")),
     Backend = rt_test_plan:get(backend, TestPlan),
@@ -144,7 +144,8 @@ init([TestPlan, Properties, ContinueOnFail, ReporterPid]) ->
                    prereq_check=PreReqCheck,
                    group_leader=group_leader(),
                    continue_on_fail=ContinueOnFail,
-                   reporter_pid=ReporterPid},
+                   reporter_pids=ReporterPid,
+                   log_dir=LogDir},
     {ok, setup, State, 0}.
 
 %% @doc there are no all-state events for this fsm
@@ -219,19 +220,22 @@ setup(_Event, _State) ->
     ok.
 
 execute({nodes_deployed, _}, State) ->
-    #state{test_module=TestModule,
+    #state{test_plan=TestPlan,
+           test_module=TestModule,
            test_type=TestType,
            properties=Properties,
            setup_modfun=SetupModFun,
            confirm_modfun=ConfirmModFun,
-           test_timeout=TestTimeout} = State,
+           test_timeout=TestTimeout,
+           log_dir=OutDir} = State,
     lager:notice("Running ~s", [TestModule]),
     lager:notice("Properties: ~p", [Properties]),
 
     StartTime = os:timestamp(),
     %% Perform test setup which includes clustering of the nodes if
     %% required by the test properties. The cluster information is placed
     %% into the properties record and returned by the `setup' function.
+    start_lager_backend(rt_test_plan:get_name(TestPlan), OutDir),
     SetupResult = maybe_setup_test(TestModule, TestType, SetupModFun, Properties),
     UpdState = maybe_execute_test(SetupResult, TestModule, TestType, ConfirmModFun, StartTime, State),
 
@@ -451,10 +455,22 @@ function_name(FunName, TestModule, Arity, Default) when is_atom(TestModule) ->
             {Default, FunName}
     end.
 
-%% remove_lager_backend() ->
-%%     gen_event:delete_handler(lager_event, lager_file_backend, []),
-%%     gen_event:delete_handler(lager_event, riak_test_lager_backend, []).
+start_lager_backend(TestName, Outdir) ->
+    LogLevel = rt_config:get(lager_level, info),
+    case Outdir of
+        undefined -> ok;
+        _ ->
+            gen_event:add_handler(lager_event, lager_file_backend,
+                {filename:join([Outdir, TestName, "riak_test.log"]),
+                    LogLevel, 10485760, "$D0", 1}),
+            lager:set_loglevel(lager_file_backend, LogLevel)
+    end,
+    gen_event:add_handler(lager_event, riak_test_lager_backend, [LogLevel, false]),
+    lager:set_loglevel(riak_test_lager_backend, LogLevel).
 
+stop_lager_backend() ->
+    gen_event:delete_handler(lager_event, lager_file_backend, []),
+    gen_event:delete_handler(lager_event, riak_test_lager_backend, []).
 
 %% A return of `fail' must be converted to a non normal exit since
 %% status is determined by `rec_loop'.
@@ -508,6 +524,8 @@ report_cleanup_and_notify(Result, CleanUp, State=#state{test_plan=TestPlan,
     ResultMessage = test_result_message(Result),
     rt_reporter:send_result(test_result({TestPlan, ResultMessage, Duration})),
     maybe_cleanup(CleanUp, State),
+    {ok, Logs} = stop_lager_backend(),
+    _Log = unicode:characters_to_binary(Logs),
     Notification = {test_complete, TestPlan, self(), ResultMessage},
     riak_test_executor:send_event(Notification).
 

src/riak_test_runner.erl

@@ -25,7 +25,6 @@
 %% multiple independent tests.
 -module(rt).
 -deprecated(module).
--include("rt.hrl").
 -include_lib("eunit/include/eunit.hrl").
 
 -compile(export_all).
@@ -64,7 +63,7 @@
          expect_in_log/2,
          get_deps/0,
          get_ip/1,
-         get_node_logs/1,
+         get_node_logs/3,
          get_replica/5,
          get_ring/1,
          get_version/0,
@@ -1364,9 +1363,9 @@ setup_harness(_Test, _Args) ->
 
 %% @doc Copy all of the nodes' log files to a local dir or
 %% open a port to each file to upload to GiddyUp
--spec(get_node_logs(string() | giddyup) -> list()).
-get_node_logs(DestDir) ->
-    rt2:get_node_logs(DestDir).
+-spec(get_node_logs(boolean(), string(), string()) -> list()).
+get_node_logs(UploadToGiddyUp, LogFile, DestDir) ->
+    rt2:get_node_logs(UploadToGiddyUp, LogFile, DestDir).
 
 check_ibrowse() ->
     rt2:check_ibrowse().

src/rt.erl

@@ -24,7 +24,6 @@
 %% Please extend this module with new functions that prove useful between
 %% multiple independent tests.
 -module(rt2).
--include("rt.hrl").
 -include_lib("eunit/include/eunit.hrl").
 
 -compile(export_all).
@@ -39,7 +38,7 @@
          expect_in_log/2,
          get_deps/0,
          get_ip/1,
-         get_node_logs/1,
+         get_node_logs/3,
          get_replica/5,
          get_version/0,
          is_mixed_cluster/1,
@@ -611,8 +610,8 @@ setup_harness(Test, Args) ->
 
 %% @doc Downloads any extant log files from the harness's running
 %%   nodes.
-get_node_logs(DestDir) ->
-    rt_harness:get_node_logs(DestDir).
+get_node_logs(UploadToGiddyUp, LogFile, DestDir) ->
+    rt_harness:get_node_logs(UploadToGiddyUp, LogFile, DestDir).
 
 check_ibrowse() ->
     try sys:get_status(ibrowse) of
@@ -630,6 +629,7 @@ check_ibrowse() ->
 %%% Bucket Types Functions
 %%%===================================================================
 
+%% TODO: Determine if this can leverage riak_test_runner:start_lager_backend/2
 %% @doc Set up in memory log capture to check contents in a test.
 setup_log_capture(Nodes) when is_list(Nodes) ->
     rt:load_modules_on_nodes([riak_test_lager_backend], Nodes),

src/rt2.erl

@@ -23,8 +23,6 @@
 
 -export([wait_until_aae_trees_built/1]).
 
--include("rt.hrl").
-
 wait_until_aae_trees_built(Nodes) ->
     lager:info("Wait until AAE builds all partition trees across ~p", [Nodes]),
     BuiltFun = fun() -> lists:foldl(aae_tree_built_fun(), true, Nodes) end,

src/rt_aae.erl

@@ -18,7 +18,6 @@
 %%
 %% -------------------------------------------------------------------
 -module(rt_backend).
--include("rt.hrl").
 -include_lib("eunit/include/eunit.hrl").
 
 -compile(export_all).

src/rt_backend.erl

@@ -27,8 +27,6 @@
          wait_until_bucket_type_status/3,
          wait_until_bucket_props/3]).
 
--include("rt.hrl").
-
 %% Specify the bucket_types field for the properties record. The list
 %% of bucket types may have two forms, a bucket_type or a pair
 %% consisting of an integer and a bucket_type. The latter form