1#!/usr/bin/env python
2#
3#   Copyright 2017 - The Android Open Source Project
4#
5#   Licensed under the Apache License, Version 2.0 (the "License");
6#   you may not use this file except in compliance with the License.
7#   You may obtain a copy of the License at
8#
9#       http://www.apache.org/licenses/LICENSE-2.0
10#
11#   Unless required by applicable law or agreed to in writing, software
12#   distributed under the License is distributed on an "AS IS" BASIS,
13#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14#   See the License for the specific language governing permissions and
15#   limitations under the License.
16
17from metrics.metric import Metric
18
19
20class TimeSyncMetric(Metric):
21
22    COMMAND = 'timedatectl status | grep synchronized'
23    # Fields for response dictionary
24    IS_SYNCHRONIZED = 'is_synchronized'
25
26    def gather_metric(self):
27        """Tells whether NTP synchronized
28
29        Returns:
30            A dict with the following fields:
31              is_synchronized: True if synchronized
32
33        """
34        # Run shell command
35        result = self._shell.run(self.COMMAND).stdout
36        # Example stdout:
37        # NTP synchronized: yes
38
39        status = 'yes' in result
40        response = {
41            self.IS_SYNCHRONIZED: status,
42        }
43        return response
44