1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
|
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/ash/crostini/ansible/ansible_management_service.h"
#include <memory>
#include <sstream>
#include "base/check_op.h"
#include "base/files/file_util.h"
#include "base/logging.h"
#include "base/notimplemented.h"
#include "base/task/task_traits.h"
#include "base/task/thread_pool.h"
#include "chrome/browser/ash/crostini/crostini_pref_names.h"
#include "chrome/browser/ash/crostini/crostini_util.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/ui/views/crostini/crostini_ansible_software_config_view.h"
#include "components/prefs/pref_service.h"
namespace crostini {
const char kCrostiniDefaultAnsibleVersion[] =
"ansible;2.2.1.0-2+deb9u1;all;debian-stable-main";
namespace {
ash::CiceroneClient* GetCiceroneClient() {
return ash::CiceroneClient::Get();
}
} // namespace
AnsibleConfiguration::AnsibleConfiguration(
std::string playbook,
base::FilePath path,
base::OnceCallback<void(bool success)> callback)
: playbook(playbook), path(path), callback(std::move(callback)) {}
AnsibleConfiguration::AnsibleConfiguration(
base::FilePath path,
base::OnceCallback<void(bool success)> callback)
: AnsibleConfiguration("", path, std::move(callback)) {}
AnsibleConfiguration::~AnsibleConfiguration() = default;
AnsibleManagementService::AnsibleManagementService(Profile* profile)
: profile_(profile), weak_ptr_factory_(this) {}
AnsibleManagementService::~AnsibleManagementService() = default;
void AnsibleManagementService::ConfigureContainer(
const guest_os::GuestId& container_id,
base::FilePath playbook_path,
base::OnceCallback<void(bool success)> callback) {
if (configuration_tasks_.count(container_id) > 0) {
LOG(ERROR) << "Attempting to configure a container which is already being "
"configured";
std::move(callback).Run(false);
return;
}
if (container_id == DefaultContainerId() &&
!ShouldConfigureDefaultContainer(profile_)) {
LOG(ERROR) << "Trying to configure default Crostini container when it "
<< "should not be configured";
std::move(callback).Run(false);
return;
}
// Add ourselves as an observer if we aren't already awaiting.
if (configuration_tasks_.empty()) {
CrostiniManager::GetForProfile(profile_)
->AddLinuxPackageOperationProgressObserver(this);
}
configuration_tasks_.emplace(
std::make_pair(container_id, std::make_unique<AnsibleConfiguration>(
playbook_path, std::move(callback))));
for (auto& observer : observers_) {
observer.OnAnsibleSoftwareConfigurationStarted(container_id);
}
CreateUiElement(container_id);
CrostiniManager::GetForProfile(profile_)->InstallLinuxPackageFromApt(
container_id, kCrostiniDefaultAnsibleVersion,
base::BindOnce(&AnsibleManagementService::OnInstallAnsibleInContainer,
weak_ptr_factory_.GetWeakPtr(), container_id));
}
void AnsibleManagementService::CreateUiElement(
const guest_os::GuestId& container_id) {
ui_elements_[container_id] = views::DialogDelegate::CreateDialogWidget(
std::make_unique<CrostiniAnsibleSoftwareConfigView>(profile_,
container_id),
nullptr, nullptr);
ui_elements_[container_id]->Show();
}
views::Widget* AnsibleManagementService::GetDialogWidgetForTesting(
const guest_os::GuestId& container_id) {
return ui_elements_.count(container_id) > 0 ? ui_elements_[container_id]
: nullptr;
}
void AnsibleManagementService::AddConfigurationTaskForTesting(
const guest_os::GuestId& container_id,
views::Widget* widget) {
configuration_tasks_[container_id] = std::make_unique<AnsibleConfiguration>(
base::FilePath(), base::BindOnce([](bool success) {}));
ui_elements_[container_id] = widget;
}
void AnsibleManagementService::OnInstallAnsibleInContainer(
const guest_os::GuestId& container_id,
CrostiniResult result) {
// Check if cancelled.
if (IsCancelled(container_id)) {
return;
}
if (result == CrostiniResult::INSTALL_LINUX_PACKAGE_FAILED) {
LOG(ERROR) << "Ansible installation failed";
OnConfigurationFinished(container_id, false);
return;
}
DCHECK_NE(result, CrostiniResult::BLOCKING_OPERATION_ALREADY_ACTIVE);
DCHECK_EQ(result, CrostiniResult::SUCCESS);
VLOG(1) << "Ansible installation has been started successfully";
// Waiting for Ansible installation progress being reported.
for (auto& observer : observers_) {
observer.OnAnsibleSoftwareInstall(container_id);
}
}
void AnsibleManagementService::OnInstallLinuxPackageProgress(
const guest_os::GuestId& container_id,
InstallLinuxPackageProgressStatus status,
int progress_percent,
const std::string& error_message) {
// Check if cancelled.
if (IsCancelled(container_id)) {
return;
}
std::stringstream status_line;
switch (status) {
case InstallLinuxPackageProgressStatus::SUCCEEDED: {
GetAnsiblePlaybookToApply(container_id);
return;
}
case InstallLinuxPackageProgressStatus::FAILED:
LOG(ERROR) << "Ansible installation failed";
OnConfigurationFinished(container_id, false);
return;
// TODO(okalitova): Report Ansible downloading/installation progress.
case InstallLinuxPackageProgressStatus::DOWNLOADING:
status_line << "Ansible downloading progress: " << progress_percent
<< "%";
VLOG(1) << status_line.str();
for (auto& observer : observers_) {
observer.OnAnsibleSoftwareConfigurationProgress(
container_id, std::vector<std::string>({status_line.str()}));
}
return;
case InstallLinuxPackageProgressStatus::INSTALLING:
status_line << "Ansible installing progress: " << progress_percent << "%";
VLOG(1) << status_line.str();
for (auto& observer : observers_) {
observer.OnAnsibleSoftwareConfigurationProgress(
container_id, std::vector<std::string>({status_line.str()}));
}
return;
default:
NOTREACHED();
}
}
void AnsibleManagementService::GetAnsiblePlaybookToApply(
const guest_os::GuestId& container_id) {
// Check if cancelled.
if (IsCancelled(container_id)) {
return;
}
const base::FilePath& ansible_playbook_file_path =
configuration_tasks_[container_id]->path;
bool success = base::ThreadPool::PostTaskAndReplyWithResult(
FROM_HERE, {base::MayBlock(), base::TaskPriority::USER_VISIBLE},
base::BindOnce(base::ReadFileToString, ansible_playbook_file_path,
&configuration_tasks_[container_id]->playbook),
base::BindOnce(&AnsibleManagementService::OnAnsiblePlaybookRetrieved,
weak_ptr_factory_.GetWeakPtr(), container_id));
if (!success) {
LOG(ERROR) << "Failed to post task to retrieve Ansible playbook content";
OnConfigurationFinished(container_id, false);
}
}
void AnsibleManagementService::OnAnsiblePlaybookRetrieved(
const guest_os::GuestId& container_id,
bool success) {
// Check if cancelled.
if (IsCancelled(container_id)) {
return;
}
if (!success) {
LOG(ERROR) << "Failed to retrieve Ansible playbook content";
OnConfigurationFinished(container_id, false);
return;
}
ApplyAnsiblePlaybook(container_id);
}
void AnsibleManagementService::ApplyAnsiblePlaybook(
const guest_os::GuestId& container_id) {
// Check if cancelled.
if (IsCancelled(container_id)) {
return;
}
if (!GetCiceroneClient()->IsApplyAnsiblePlaybookProgressSignalConnected()) {
// Technically we could still start the application, but we wouldn't be able
// to detect when the application completes, successfully or otherwise.
LOG(ERROR)
<< "Attempted to apply playbook when progress signal not connected.";
OnConfigurationFinished(container_id, false);
return;
}
vm_tools::cicerone::ApplyAnsiblePlaybookRequest request;
request.set_owner_id(CryptohomeIdForProfile(profile_));
request.set_vm_name(container_id.vm_name);
request.set_container_name(container_id.container_name);
request.set_playbook(configuration_tasks_[container_id]->playbook);
GetCiceroneClient()->ApplyAnsiblePlaybook(
std::move(request),
base::BindOnce(&AnsibleManagementService::OnApplyAnsiblePlaybook,
weak_ptr_factory_.GetWeakPtr(), container_id));
}
void AnsibleManagementService::OnApplyAnsiblePlaybook(
const guest_os::GuestId& container_id,
std::optional<vm_tools::cicerone::ApplyAnsiblePlaybookResponse> response) {
// Check if cancelled.
if (IsCancelled(container_id)) {
return;
}
if (!response) {
LOG(ERROR) << "Failed to apply Ansible playbook. Empty response.";
OnConfigurationFinished(container_id, false);
return;
}
if (response->status() ==
vm_tools::cicerone::ApplyAnsiblePlaybookResponse::FAILED) {
LOG(ERROR) << "Failed to apply Ansible playbook: "
<< response->failure_reason();
OnConfigurationFinished(container_id, false);
return;
}
VLOG(1) << "Ansible playbook application has been started successfully";
// Waiting for Ansible playbook application progress being reported.
// TODO(https://crbug.com/1043060): Add a timeout after which we stop waiting.
for (auto& observer : observers_) {
observer.OnApplyAnsiblePlaybook(container_id);
}
}
void AnsibleManagementService::OnApplyAnsiblePlaybookProgress(
const vm_tools::cicerone::ApplyAnsiblePlaybookProgressSignal& signal) {
guest_os::GuestId container_id(kCrostiniDefaultVmType, signal.vm_name(),
signal.container_name());
// Check if cancelled.
if (IsCancelled(container_id)) {
return;
}
switch (signal.status()) {
case vm_tools::cicerone::ApplyAnsiblePlaybookProgressSignal::SUCCEEDED:
OnConfigurationFinished(container_id, true);
break;
case vm_tools::cicerone::ApplyAnsiblePlaybookProgressSignal::FAILED:
LOG(ERROR) << "Ansible playbook application has failed with reason:\n"
<< signal.failure_details();
OnConfigurationFinished(container_id, false);
break;
case vm_tools::cicerone::ApplyAnsiblePlaybookProgressSignal::IN_PROGRESS:
for (auto& observer : observers_) {
observer.OnAnsibleSoftwareConfigurationProgress(
container_id,
std::vector<std::string>(signal.status_string().begin(),
signal.status_string().end()));
}
break;
default:
NOTREACHED();
}
}
void AnsibleManagementService::AddObserver(Observer* observer) {
DCHECK(observer);
observers_.AddObserver(observer);
}
void AnsibleManagementService::RemoveObserver(Observer* observer) {
observers_.RemoveObserver(observer);
}
void AnsibleManagementService::OnUninstallPackageProgress(
const guest_os::GuestId& container_id,
UninstallPackageProgressStatus status,
int progress_percent) {
NOTIMPLEMENTED();
}
void AnsibleManagementService::OnConfigurationFinished(
const guest_os::GuestId& container_id,
bool success) {
// Check if cancelled.
if (IsCancelled(container_id)) {
return;
}
if (success && container_id == DefaultContainerId()) {
profile_->GetPrefs()->SetBoolean(prefs::kCrostiniDefaultContainerConfigured,
true);
}
for (auto& observer : observers_) {
observer.OnAnsibleSoftwareConfigurationFinished(container_id, success);
}
for (auto& observer : observers_) {
// Interactive prompt currently only occurs when there has been a failure.
observer.OnAnsibleSoftwareConfigurationUiPrompt(container_id, !success);
}
}
void AnsibleManagementService::RetryConfiguration(
const guest_os::GuestId& container_id) {
// We're not 100% sure where we lost connection, so we'll have to restart from
// the very beginning.
DCHECK_GT(configuration_tasks_.count(container_id), 0u);
VLOG(1) << "Retrying configuration";
CrostiniManager::GetForProfile(profile_)->InstallLinuxPackageFromApt(
container_id, kCrostiniDefaultAnsibleVersion,
base::BindOnce(&AnsibleManagementService::OnInstallAnsibleInContainer,
weak_ptr_factory_.GetWeakPtr(), container_id));
}
void AnsibleManagementService::CancelConfiguration(
const guest_os::GuestId& container_id) {
DCHECK_GT(configuration_tasks_.count(container_id), 0u);
OnConfigurationFinished(container_id, false);
CompleteConfiguration(container_id, false);
}
void AnsibleManagementService::CompleteConfiguration(
const guest_os::GuestId& container_id,
bool success) {
// Check if cancelled.
if (IsCancelled(container_id)) {
return;
}
auto callback = std::move(configuration_tasks_[container_id]->callback);
configuration_tasks_.erase(configuration_tasks_.find(container_id));
ui_elements_[container_id]->CloseWithReason(
views::Widget::ClosedReason::kUnspecified);
ui_elements_.erase(container_id);
// Clean up our observer if no more packages are awaiting this.
if (configuration_tasks_.empty()) {
CrostiniManager::GetForProfile(profile_)
->RemoveLinuxPackageOperationProgressObserver(this);
}
std::move(callback).Run(success);
}
bool AnsibleManagementService::IsCancelled(
const guest_os::GuestId& container_id) {
return configuration_tasks_.count(container_id) == 0;
}
} // namespace crostini
|