109 lines
3.0 KiB
Python
109 lines
3.0 KiB
Python
# Copyright 2015 Canonical Ltd.
|
|
# This file is part of cloud-init. See LICENCE file for license information.
|
|
#
|
|
# vi: ts=4 expandtab
|
|
|
|
import abc
|
|
|
|
import six
|
|
|
|
|
|
class APIResponse(object):
|
|
"""Holds API response content
|
|
|
|
To access the content in the binary format, use the
|
|
`buffer` attribute, while the unicode content can be
|
|
accessed by calling `str` over this (or by accessing
|
|
the `decoded_buffer` property).
|
|
"""
|
|
|
|
def __init__(self, buffer, encoding="utf-8"):
|
|
self.buffer = buffer
|
|
self.encoding = encoding
|
|
self._decoded_buffer = None
|
|
|
|
@property
|
|
def decoded_buffer(self):
|
|
# Avoid computing this again and again (although multiple threads
|
|
# may decode it if they all get in here at the same time, but meh
|
|
# thats ok).
|
|
if self._decoded_buffer is None:
|
|
self._decoded_buffer = self.buffer.decode(self.encoding)
|
|
return self._decoded_buffer
|
|
|
|
def __str__(self):
|
|
return self.decoded_buffer
|
|
|
|
|
|
@six.add_metaclass(abc.ABCMeta)
|
|
class BaseDataSource(object):
|
|
"""Base class for the data sources."""
|
|
|
|
datasource_config = {}
|
|
|
|
def __init__(self, config=None):
|
|
self._cache = {}
|
|
# TODO(cpopa): merge them instead.
|
|
self._config = config or self.datasource_config
|
|
|
|
def _get_cache_data(self, path):
|
|
"""Do a metadata lookup for the given *path*
|
|
|
|
This will return the available metadata under *path*,
|
|
while caching the result, so that a next call will not do
|
|
an additional API call.
|
|
"""
|
|
if path not in self._cache:
|
|
self._cache[path] = self._get_data(path)
|
|
|
|
return self._cache[path]
|
|
|
|
@abc.abstractmethod
|
|
def load(self):
|
|
"""Try to load this metadata service.
|
|
|
|
This should return ``True`` if the service was loaded properly,
|
|
``False`` otherwise.
|
|
"""
|
|
|
|
@abc.abstractmethod
|
|
def _get_data(self, path):
|
|
"""Retrieve the metadata exported under the `path` key.
|
|
|
|
This should return an instance of :class:`APIResponse`.
|
|
"""
|
|
|
|
def instance_id(self):
|
|
"""Get this instance's id."""
|
|
|
|
def user_data(self):
|
|
"""Get the user data available for this instance."""
|
|
|
|
def vendor_data(self):
|
|
"""Get the vendor data available for this instance."""
|
|
|
|
def host_name(self):
|
|
"""Get the hostname available for this instance."""
|
|
|
|
def public_keys(self):
|
|
"""Get the public keys available for this instance."""
|
|
|
|
def network_config(self):
|
|
"""Get the specified network config, if any."""
|
|
|
|
def admin_password(self):
|
|
"""Get the admin password."""
|
|
|
|
def post_password(self, password):
|
|
"""Post the password to the metadata service."""
|
|
|
|
def can_update_password(self):
|
|
"""Check if this data source can update the admin password."""
|
|
|
|
def is_password_changed(self):
|
|
"""Check if the data source has a new password for this instance."""
|
|
return False
|
|
|
|
def is_password_set(self):
|
|
"""Check if the password was already posted to the metadata service."""
|