1 // Copyright (C) 2017 The Android Open Source Project
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //      http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #include <gtest/gtest.h>
16 
17 #include <vector>
18 
19 #include "src/StatsLogProcessor.h"
20 #include "src/stats_log_util.h"
21 #include "stats_event.h"
22 #include "tests/statsd_test_util.h"
23 
24 namespace android {
25 namespace os {
26 namespace statsd {
27 
28 #ifdef __ANDROID__
29 
30 namespace {
31 
CreateStatsdConfigForPushedEvent(const GaugeMetric::SamplingType sampling_type)32 StatsdConfig CreateStatsdConfigForPushedEvent(const GaugeMetric::SamplingType sampling_type) {
33     StatsdConfig config;
34     config.add_allowed_log_source("AID_ROOT"); // LogEvent defaults to UID of root.
35     *config.add_atom_matcher() = CreateMoveToBackgroundAtomMatcher();
36     *config.add_atom_matcher() = CreateMoveToForegroundAtomMatcher();
37 
38     auto atomMatcher = CreateSimpleAtomMatcher("", util::APP_START_OCCURRED);
39     *config.add_atom_matcher() = atomMatcher;
40 
41     auto isInBackgroundPredicate = CreateIsInBackgroundPredicate();
42     *isInBackgroundPredicate.mutable_simple_predicate()->mutable_dimensions() =
43         CreateDimensions(util::ACTIVITY_FOREGROUND_STATE_CHANGED, {1 /* uid field */ });
44     *config.add_predicate() = isInBackgroundPredicate;
45 
46     auto gaugeMetric = config.add_gauge_metric();
47     gaugeMetric->set_id(123456);
48     gaugeMetric->set_what(atomMatcher.id());
49     gaugeMetric->set_condition(isInBackgroundPredicate.id());
50     gaugeMetric->mutable_gauge_fields_filter()->set_include_all(false);
51     gaugeMetric->set_sampling_type(sampling_type);
52     auto fieldMatcher = gaugeMetric->mutable_gauge_fields_filter()->mutable_fields();
53     fieldMatcher->set_field(util::APP_START_OCCURRED);
54     fieldMatcher->add_child()->set_field(3);  // type (enum)
55     fieldMatcher->add_child()->set_field(4);  // activity_name(str)
56     fieldMatcher->add_child()->set_field(7);  // activity_start_msec(int64)
57     *gaugeMetric->mutable_dimensions_in_what() =
58         CreateDimensions(util::APP_START_OCCURRED, {1 /* uid field */ });
59     gaugeMetric->set_bucket(FIVE_MINUTES);
60 
61     auto links = gaugeMetric->add_links();
62     links->set_condition(isInBackgroundPredicate.id());
63     auto dimensionWhat = links->mutable_fields_in_what();
64     dimensionWhat->set_field(util::APP_START_OCCURRED);
65     dimensionWhat->add_child()->set_field(1);  // uid field.
66     auto dimensionCondition = links->mutable_fields_in_condition();
67     dimensionCondition->set_field(util::ACTIVITY_FOREGROUND_STATE_CHANGED);
68     dimensionCondition->add_child()->set_field(1);  // uid field.
69     return config;
70 }
71 
72 }  // namespace
73 
TEST(GaugeMetricE2eTest,TestMultipleFieldsForPushedEvent)74 TEST(GaugeMetricE2eTest, TestMultipleFieldsForPushedEvent) {
75     for (const auto& sampling_type :
76          {GaugeMetric::FIRST_N_SAMPLES, GaugeMetric::RANDOM_ONE_SAMPLE}) {
77         auto config = CreateStatsdConfigForPushedEvent(sampling_type);
78         int64_t bucketStartTimeNs = 10000000000;
79         int64_t bucketSizeNs =
80                 TimeUnitToBucketSizeInMillis(config.gauge_metric(0).bucket()) * 1000000;
81 
82         ConfigKey cfgKey;
83         auto processor =
84                 CreateStatsLogProcessor(bucketStartTimeNs, bucketStartTimeNs, config, cfgKey);
85         ASSERT_EQ(processor->mMetricsManagers.size(), 1u);
86         EXPECT_TRUE(processor->mMetricsManagers.begin()->second->isConfigValid());
87 
88         int appUid1 = 123;
89         int appUid2 = 456;
90         std::vector<std::unique_ptr<LogEvent>> events;
91         events.push_back(CreateMoveToBackgroundEvent(bucketStartTimeNs + 15, appUid1));
92         events.push_back(
93                 CreateMoveToForegroundEvent(bucketStartTimeNs + bucketSizeNs + 250, appUid1));
94         events.push_back(
95                 CreateMoveToBackgroundEvent(bucketStartTimeNs + bucketSizeNs + 350, appUid1));
96         events.push_back(
97                 CreateMoveToForegroundEvent(bucketStartTimeNs + 2 * bucketSizeNs + 100, appUid1));
98 
99         events.push_back(CreateAppStartOccurredEvent(
100                 bucketStartTimeNs + 10, appUid1, "app1", AppStartOccurred::WARM, "activity_name1",
101                 "calling_pkg_name1", true /*is_instant_app*/, 101 /*activity_start_msec*/));
102         events.push_back(CreateAppStartOccurredEvent(
103                 bucketStartTimeNs + 20, appUid1, "app1", AppStartOccurred::HOT, "activity_name2",
104                 "calling_pkg_name2", true /*is_instant_app*/, 102 /*activity_start_msec*/));
105         events.push_back(CreateAppStartOccurredEvent(
106                 bucketStartTimeNs + 30, appUid1, "app1", AppStartOccurred::COLD, "activity_name3",
107                 "calling_pkg_name3", true /*is_instant_app*/, 103 /*activity_start_msec*/));
108         events.push_back(CreateAppStartOccurredEvent(
109                 bucketStartTimeNs + bucketSizeNs + 30, appUid1, "app1", AppStartOccurred::WARM,
110                 "activity_name4", "calling_pkg_name4", true /*is_instant_app*/,
111                 104 /*activity_start_msec*/));
112         events.push_back(CreateAppStartOccurredEvent(
113                 bucketStartTimeNs + 2 * bucketSizeNs, appUid1, "app1", AppStartOccurred::COLD,
114                 "activity_name5", "calling_pkg_name5", true /*is_instant_app*/,
115                 105 /*activity_start_msec*/));
116         events.push_back(CreateAppStartOccurredEvent(
117                 bucketStartTimeNs + 2 * bucketSizeNs + 10, appUid1, "app1", AppStartOccurred::HOT,
118                 "activity_name6", "calling_pkg_name6", false /*is_instant_app*/,
119                 106 /*activity_start_msec*/));
120 
121         events.push_back(
122                 CreateMoveToBackgroundEvent(bucketStartTimeNs + bucketSizeNs + 10, appUid2));
123         events.push_back(CreateAppStartOccurredEvent(
124                 bucketStartTimeNs + 2 * bucketSizeNs + 10, appUid2, "app2", AppStartOccurred::COLD,
125                 "activity_name7", "calling_pkg_name7", true /*is_instant_app*/,
126                 201 /*activity_start_msec*/));
127 
128         sortLogEventsByTimestamp(&events);
129 
130         for (const auto& event : events) {
131             processor->OnLogEvent(event.get());
132         }
133         ConfigMetricsReportList reports;
134         vector<uint8_t> buffer;
135         processor->onDumpReport(cfgKey, bucketStartTimeNs + 3 * bucketSizeNs, false, true, ADB_DUMP,
136                                 FAST, &buffer);
137         EXPECT_TRUE(buffer.size() > 0);
138         EXPECT_TRUE(reports.ParseFromArray(&buffer[0], buffer.size()));
139         backfillDimensionPath(&reports);
140         backfillStringInReport(&reports);
141         backfillStartEndTimestamp(&reports);
142         ASSERT_EQ(1, reports.reports_size());
143         ASSERT_EQ(1, reports.reports(0).metrics_size());
144         StatsLogReport::GaugeMetricDataWrapper gaugeMetrics;
145         sortMetricDataByDimensionsValue(reports.reports(0).metrics(0).gauge_metrics(),
146                                         &gaugeMetrics);
147         ASSERT_EQ(2, gaugeMetrics.data_size());
148 
149         auto data = gaugeMetrics.data(0);
150         EXPECT_EQ(util::APP_START_OCCURRED, data.dimensions_in_what().field());
151         ASSERT_EQ(1, data.dimensions_in_what().value_tuple().dimensions_value_size());
152         EXPECT_EQ(1 /* uid field */,
153                   data.dimensions_in_what().value_tuple().dimensions_value(0).field());
154         EXPECT_EQ(appUid1, data.dimensions_in_what().value_tuple().dimensions_value(0).value_int());
155         ASSERT_EQ(3, data.bucket_info_size());
156         if (sampling_type == GaugeMetric::FIRST_N_SAMPLES) {
157             ASSERT_EQ(2, data.bucket_info(0).atom_size());
158             ASSERT_EQ(2, data.bucket_info(0).elapsed_timestamp_nanos_size());
159             ASSERT_EQ(0, data.bucket_info(0).wall_clock_timestamp_nanos_size());
160             EXPECT_EQ(bucketStartTimeNs, data.bucket_info(0).start_bucket_elapsed_nanos());
161             EXPECT_EQ(bucketStartTimeNs + bucketSizeNs,
162                       data.bucket_info(0).end_bucket_elapsed_nanos());
163             EXPECT_EQ(AppStartOccurred::HOT,
164                       data.bucket_info(0).atom(0).app_start_occurred().type());
165             EXPECT_EQ("activity_name2",
166                       data.bucket_info(0).atom(0).app_start_occurred().activity_name());
167             EXPECT_EQ(102L,
168                       data.bucket_info(0).atom(0).app_start_occurred().activity_start_millis());
169             EXPECT_EQ(AppStartOccurred::COLD,
170                       data.bucket_info(0).atom(1).app_start_occurred().type());
171             EXPECT_EQ("activity_name3",
172                       data.bucket_info(0).atom(1).app_start_occurred().activity_name());
173             EXPECT_EQ(103L,
174                       data.bucket_info(0).atom(1).app_start_occurred().activity_start_millis());
175 
176             ASSERT_EQ(1, data.bucket_info(1).atom_size());
177             ASSERT_EQ(1, data.bucket_info(1).elapsed_timestamp_nanos_size());
178             EXPECT_EQ(bucketStartTimeNs + bucketSizeNs,
179                       data.bucket_info(1).start_bucket_elapsed_nanos());
180             EXPECT_EQ(bucketStartTimeNs + 2 * bucketSizeNs,
181                       data.bucket_info(1).end_bucket_elapsed_nanos());
182             EXPECT_EQ(AppStartOccurred::WARM,
183                       data.bucket_info(1).atom(0).app_start_occurred().type());
184             EXPECT_EQ("activity_name4",
185                       data.bucket_info(1).atom(0).app_start_occurred().activity_name());
186             EXPECT_EQ(104L,
187                       data.bucket_info(1).atom(0).app_start_occurred().activity_start_millis());
188 
189             ASSERT_EQ(2, data.bucket_info(2).atom_size());
190             ASSERT_EQ(2, data.bucket_info(2).elapsed_timestamp_nanos_size());
191             EXPECT_EQ(bucketStartTimeNs + 2 * bucketSizeNs,
192                       data.bucket_info(2).start_bucket_elapsed_nanos());
193             EXPECT_EQ(bucketStartTimeNs + 3 * bucketSizeNs,
194                       data.bucket_info(2).end_bucket_elapsed_nanos());
195             EXPECT_EQ(AppStartOccurred::COLD,
196                       data.bucket_info(2).atom(0).app_start_occurred().type());
197             EXPECT_EQ("activity_name5",
198                       data.bucket_info(2).atom(0).app_start_occurred().activity_name());
199             EXPECT_EQ(105L,
200                       data.bucket_info(2).atom(0).app_start_occurred().activity_start_millis());
201             EXPECT_EQ(AppStartOccurred::HOT,
202                       data.bucket_info(2).atom(1).app_start_occurred().type());
203             EXPECT_EQ("activity_name6",
204                       data.bucket_info(2).atom(1).app_start_occurred().activity_name());
205             EXPECT_EQ(106L,
206                       data.bucket_info(2).atom(1).app_start_occurred().activity_start_millis());
207         } else {
208             ASSERT_EQ(1, data.bucket_info(0).atom_size());
209             ASSERT_EQ(1, data.bucket_info(0).elapsed_timestamp_nanos_size());
210             EXPECT_EQ(bucketStartTimeNs, data.bucket_info(0).start_bucket_elapsed_nanos());
211             EXPECT_EQ(bucketStartTimeNs + bucketSizeNs,
212                       data.bucket_info(0).end_bucket_elapsed_nanos());
213             EXPECT_EQ(AppStartOccurred::HOT,
214                       data.bucket_info(0).atom(0).app_start_occurred().type());
215             EXPECT_EQ("activity_name2",
216                       data.bucket_info(0).atom(0).app_start_occurred().activity_name());
217             EXPECT_EQ(102L,
218                       data.bucket_info(0).atom(0).app_start_occurred().activity_start_millis());
219 
220             ASSERT_EQ(1, data.bucket_info(1).atom_size());
221             ASSERT_EQ(1, data.bucket_info(1).elapsed_timestamp_nanos_size());
222             EXPECT_EQ(bucketStartTimeNs + bucketSizeNs,
223                       data.bucket_info(1).start_bucket_elapsed_nanos());
224             EXPECT_EQ(bucketStartTimeNs + 2 * bucketSizeNs,
225                       data.bucket_info(1).end_bucket_elapsed_nanos());
226             EXPECT_EQ(AppStartOccurred::WARM,
227                       data.bucket_info(1).atom(0).app_start_occurred().type());
228             EXPECT_EQ("activity_name4",
229                       data.bucket_info(1).atom(0).app_start_occurred().activity_name());
230             EXPECT_EQ(104L,
231                       data.bucket_info(1).atom(0).app_start_occurred().activity_start_millis());
232 
233             ASSERT_EQ(1, data.bucket_info(2).atom_size());
234             ASSERT_EQ(1, data.bucket_info(2).elapsed_timestamp_nanos_size());
235             EXPECT_EQ(bucketStartTimeNs + 2 * bucketSizeNs,
236                       data.bucket_info(2).start_bucket_elapsed_nanos());
237             EXPECT_EQ(bucketStartTimeNs + 3 * bucketSizeNs,
238                       data.bucket_info(2).end_bucket_elapsed_nanos());
239             EXPECT_EQ(AppStartOccurred::COLD,
240                       data.bucket_info(2).atom(0).app_start_occurred().type());
241             EXPECT_EQ("activity_name5",
242                       data.bucket_info(2).atom(0).app_start_occurred().activity_name());
243             EXPECT_EQ(105L,
244                       data.bucket_info(2).atom(0).app_start_occurred().activity_start_millis());
245         }
246 
247         data = gaugeMetrics.data(1);
248 
249         EXPECT_EQ(data.dimensions_in_what().field(), util::APP_START_OCCURRED);
250         ASSERT_EQ(data.dimensions_in_what().value_tuple().dimensions_value_size(), 1);
251         EXPECT_EQ(1 /* uid field */,
252                   data.dimensions_in_what().value_tuple().dimensions_value(0).field());
253         EXPECT_EQ(appUid2, data.dimensions_in_what().value_tuple().dimensions_value(0).value_int());
254         ASSERT_EQ(1, data.bucket_info_size());
255         ASSERT_EQ(1, data.bucket_info(0).atom_size());
256         ASSERT_EQ(1, data.bucket_info(0).elapsed_timestamp_nanos_size());
257         EXPECT_EQ(bucketStartTimeNs + 2 * bucketSizeNs,
258                   data.bucket_info(0).start_bucket_elapsed_nanos());
259         EXPECT_EQ(bucketStartTimeNs + 3 * bucketSizeNs,
260                   data.bucket_info(0).end_bucket_elapsed_nanos());
261         EXPECT_EQ(AppStartOccurred::COLD, data.bucket_info(0).atom(0).app_start_occurred().type());
262         EXPECT_EQ("activity_name7",
263                   data.bucket_info(0).atom(0).app_start_occurred().activity_name());
264         EXPECT_EQ(201L, data.bucket_info(0).atom(0).app_start_occurred().activity_start_millis());
265     }
266 }
267 
268 #else
269 GTEST_LOG_(INFO) << "This test does nothing.\n";
270 #endif
271 
272 }  // namespace statsd
273 }  // namespace os
274 }  // namespace android
275