1#!/usr/bin/env python3.4
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
17
18class OtaTool(object):
19    """A Wrapper for an OTA Update command or tool.
20
21    Each OtaTool acts as a facade to the underlying command or tool used to
22    update the device.
23    """
24
25    def __init__(self, command):
26        """Creates an OTA Update tool with the given properties.
27
28        Args:
29            command: A string that is used as the command line tool
30        """
31        self.command = command
32
33    def update(self, ota_runner):
34        """Begins the OTA Update. Returns after the update has installed.
35
36        Args:
37            ota_runner: The OTA Runner that handles the device information.
38        """
39        raise NotImplementedError()
40
41    def cleanup(self, ota_runner):
42        """A cleanup method for the OTA Tool to run after the update completes.
43
44        Args:
45            ota_runner: The OTA Runner that handles the device information.
46        """
47        pass
48