libs/web/build_api.cc

//
// Copyright (C) 2019 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include "build_api.h"

#include <dirent.h>
#include <unistd.h>

#include <chrono>
#include <set>
#include <string>
#include <thread>

#include <android-base/strings.h>
#include <android-base/logging.h>

#include "common/libs/utils/environment.h"
#include "common/libs/utils/files.h"

namespace cuttlefish {
namespace {

const std::string BUILD_API =
    "https://www.googleapis.com/android/internal/build/v3";

bool StatusIsTerminal(const std::string& status) {
  const static std::set<std::string> terminal_statuses = {
    "abandoned",
    "complete",
    "error",
    "ABANDONED",
    "COMPLETE",
    "ERROR",
  };
  return terminal_statuses.count(status) > 0;
}

} // namespace

Artifact::Artifact(const Json::Value& json_artifact) {
  name = json_artifact["name"].asString();
  size = std::stol(json_artifact["size"].asString());
  last_modified_time = std::stol(json_artifact["lastModifiedTime"].asString());
  md5 = json_artifact["md5"].asString();
  content_type = json_artifact["contentType"].asString();
  revision = json_artifact["revision"].asString();
  creation_time = std::stol(json_artifact["creationTime"].asString());
  crc32 = json_artifact["crc32"].asUInt();
}

std::ostream& operator<<(std::ostream& out, const DeviceBuild& build) {
  return out << "(id=\"" << build.id << "\", target=\"" << build.target << "\")";
}

std::ostream& operator<<(std::ostream& out, const DirectoryBuild& build) {
  auto paths = android::base::Join(build.paths, ":");
  return out << "(paths=\"" << paths << "\", target=\"" << build.target << "\")";
}

std::ostream& operator<<(std::ostream& out, const Build& build) {
  std::visit([&out](auto&& arg) { out << arg; }, build);
  return out;
}

DirectoryBuild::DirectoryBuild(const std::vector<std::string>& paths,
                               const std::string& target)
    : paths(paths), target(target), id("eng") {
  product = StringFromEnv("TARGET_PRODUCT", "");
}

BuildApi::BuildApi(CurlWrapper& curl, CredentialSource* credential_source)
    : BuildApi(curl, credential_source, "") {}

BuildApi::BuildApi(CurlWrapper& curl, CredentialSource* credential_source,
                   std::string api_key)
    : curl(curl),
      credential_source(credential_source),
      api_key_(std::move(api_key)) {}

std::vector<std::string> BuildApi::Headers() {
  std::vector<std::string> headers;
  if (credential_source) {
    headers.push_back("Authorization: Bearer " +
                      credential_source->Credential());
  }
  return headers;
}

std::string BuildApi::LatestBuildId(const std::string& branch,
                                    const std::string& target) {
  std::string url =
      BUILD_API + "/builds?branch=" + curl.UrlEscape(branch) +
      "&buildAttemptStatus=complete" +
      "&buildType=submitted&maxResults=1&successful=true&target=" +
      curl.UrlEscape(target);
  if (!api_key_.empty()) {
    url += "&key=" + curl.UrlEscape(api_key_);
  }
  auto curl_response = curl.DownloadToJson(url, Headers());
  const auto& json = curl_response.data;
  if (!curl_response.HttpSuccess()) {
    LOG(FATAL) << "Error fetching the latest build of \"" << target
               << "\" on \"" << branch << "\". The server response was \""
               << json << "\", and code was " << curl_response.http_code;
  }
  CHECK(!json.isMember("error"))
      << "Response had \"error\" but had http success status. Received \""
      << json << "\"";

  if (!json.isMember("builds") || json["builds"].size() != 1) {
    LOG(WARNING) << "expected to receive 1 build for \"" << target << "\" on \""
                 << branch << "\", but received " << json["builds"].size()
                 << ". Full response was " << json;
    return "";
  }
  return json["builds"][0]["buildId"].asString();
}

std::string BuildApi::BuildStatus(const DeviceBuild& build) {
  std::string url = BUILD_API + "/builds/" + curl.UrlEscape(build.id) + "/" +
                    curl.UrlEscape(build.target);
  if (!api_key_.empty()) {
    url += "?key=" + curl.UrlEscape(api_key_);
  }
  auto curl_response = curl.DownloadToJson(url, Headers());
  const auto& json = curl_response.data;
  if (!curl_response.HttpSuccess()) {
    LOG(FATAL) << "Error fetching the status of \"" << build
               << "\". The server response was \"" << json
               << "\", and code was " << curl_response.http_code;
  }
  CHECK(!json.isMember("error"))
      << "Response had \"error\" but had http success status. Received \""
      << json << "\"";

  return json["buildAttemptStatus"].asString();
}

std::string BuildApi::ProductName(const DeviceBuild& build) {
  std::string url = BUILD_API + "/builds/" + curl.UrlEscape(build.id) + "/" +
                    curl.UrlEscape(build.target);
  if (!api_key_.empty()) {
    url += "?key=" + curl.UrlEscape(api_key_);
  }
  auto curl_response = curl.DownloadToJson(url, Headers());
  const auto& json = curl_response.data;
  if (!curl_response.HttpSuccess()) {
    LOG(FATAL) << "Error fetching the product name of \"" << build
               << "\". The server response was \"" << json
               << "\", and code was " << curl_response.http_code;
  }
  CHECK(!json.isMember("error"))
      << "Response had \"error\" but had http success status. Received \""
      << json << "\"";

  CHECK(json.isMember("target")) << "Build was missing target field.";
  return json["target"]["product"].asString();
}

std::vector<Artifact> BuildApi::Artifacts(const DeviceBuild& build) {
  std::string page_token = "";
  std::vector<Artifact> artifacts;
  do {
    std::string url = BUILD_API + "/builds/" + curl.UrlEscape(build.id) + "/" +
                      curl.UrlEscape(build.target) +
                      "/attempts/latest/artifacts?maxResults=100";
    if (page_token != "") {
      url += "&pageToken=" + curl.UrlEscape(page_token);
    }
    if (!api_key_.empty()) {
      url += "&key=" + curl.UrlEscape(api_key_);
    }
    auto curl_response = curl.DownloadToJson(url, Headers());
    const auto& json = curl_response.data;
    if (!curl_response.HttpSuccess()) {
      LOG(FATAL) << "Error fetching the artifacts of \"" << build
                 << "\". The server response was \"" << json
                 << "\", and code was " << curl_response.http_code;
    }
    CHECK(!json.isMember("error"))
        << "Response had \"error\" but had http success status. Received \""
        << json << "\"";
    if (json.isMember("nextPageToken")) {
      page_token = json["nextPageToken"].asString();
    } else {
      page_token = "";
    }
    for (const auto& artifact_json : json["artifacts"]) {
      artifacts.emplace_back(artifact_json);
    }
  } while (page_token != "");
  return artifacts;
}

struct CloseDir {
  void operator()(DIR* dir) {
    closedir(dir);
  }
};

using UniqueDir = std::unique_ptr<DIR, CloseDir>;

std::vector<Artifact> BuildApi::Artifacts(const DirectoryBuild& build) {
  std::vector<Artifact> artifacts;
  for (const auto& path : build.paths) {
    auto dir = UniqueDir(opendir(path.c_str()));
    CHECK(dir != nullptr) << "Could not read files from \"" << path << "\"";
    for (auto entity = readdir(dir.get()); entity != nullptr; entity = readdir(dir.get())) {
      artifacts.emplace_back(std::string(entity->d_name));
    }
  }
  return artifacts;
}

bool BuildApi::ArtifactToCallback(const DeviceBuild& build,
                                  const std::string& artifact,
                                  CurlWrapper::DataCallback callback) {
  std::string download_url_endpoint =
      BUILD_API + "/builds/" + curl.UrlEscape(build.id) + "/" +
      curl.UrlEscape(build.target) + "/attempts/latest/artifacts/" +
      curl.UrlEscape(artifact) + "/url";
  if (!api_key_.empty()) {
    download_url_endpoint += "?key=" + curl.UrlEscape(api_key_);
  }
  auto curl_response = curl.DownloadToJson(download_url_endpoint, Headers());
  const auto& json = curl_response.data;
  if (!(curl_response.HttpSuccess() || curl_response.HttpRedirect())) {
    LOG(ERROR) << "Error fetching the url of \"" << artifact << "\" for \""
               << build << "\". The server response was \"" << json
               << "\", and code was " << curl_response.http_code;
    return false;
  }
  if (json.isMember("error")) {
    LOG(ERROR) << "Response had \"error\" but had http success status. "
               << "Received \"" << json << "\"";
    return false;
  }
  if (!json.isMember("signedUrl")) {
    LOG(ERROR) << "URL endpoint did not have json path: " << json;
    return false;
  }
  std::string url = json["signedUrl"].asString();
  return curl.DownloadToCallback(callback, url).HttpSuccess();
}

bool BuildApi::ArtifactToFile(const DeviceBuild& build,
                              const std::string& artifact,
                              const std::string& path) {
  std::string download_url_endpoint =
      BUILD_API + "/builds/" + curl.UrlEscape(build.id) + "/" +
      curl.UrlEscape(build.target) + "/attempts/latest/artifacts/" +
      curl.UrlEscape(artifact) + "/url";
  if (!api_key_.empty()) {
    download_url_endpoint += "?key=" + curl.UrlEscape(api_key_);
  }
  auto curl_response = curl.DownloadToJson(download_url_endpoint, Headers());
  const auto& json = curl_response.data;
  if (!(curl_response.HttpSuccess() || curl_response.HttpRedirect())) {
    LOG(ERROR) << "Error fetching the url of \"" << artifact << "\" for \""
               << build << "\". The server response was \"" << json
               << "\", and code was " << curl_response.http_code;
    return false;
  }
  if (json.isMember("error")) {
    LOG(ERROR) << "Response had \"error\" but had http success status. "
               << "Received \"" << json << "\"";
  }
  if (!json.isMember("signedUrl")) {
    LOG(ERROR) << "URL endpoint did not have json path: " << json;
    return false;
  }
  std::string url = json["signedUrl"].asString();
  return curl.DownloadToFile(url, path).HttpSuccess();
}

bool BuildApi::ArtifactToFile(const DirectoryBuild& build,
                              const std::string& artifact,
                              const std::string& destination) {
  for (const auto& path : build.paths) {
    auto source = path + "/" + artifact;
    if (!FileExists(source)) {
      continue;
    }
    unlink(destination.c_str());
    if (symlink(source.c_str(), destination.c_str())) {
      int error_num = errno;
      LOG(ERROR) << "Could not create symlink from " << source << " to "
                  << destination << ": " << strerror(error_num);
      return false;
    }
    return true;
  }
  return false;
}

Build ArgumentToBuild(BuildApi* build_api, const std::string& arg,
                      const std::string& default_build_target,
                      const std::chrono::seconds& retry_period) {
  if (arg.find(':') != std::string::npos) {
    std::vector<std::string> dirs = android::base::Split(arg, ":");
    std::string id = dirs.back();
    dirs.pop_back();
    return DirectoryBuild(dirs, id);
  }
  size_t slash_pos = arg.find('/');
  if (slash_pos != std::string::npos
        && arg.find('/', slash_pos + 1) != std::string::npos) {
    LOG(FATAL) << "Build argument cannot have more than one '/' slash. Was at "
        << slash_pos << " and " << arg.find('/', slash_pos + 1);
  }
  std::string build_target = slash_pos == std::string::npos
      ? default_build_target : arg.substr(slash_pos + 1);
  std::string branch_or_id = slash_pos == std::string::npos
      ? arg: arg.substr(0, slash_pos);
  std::string branch_latest_build_id =
      build_api->LatestBuildId(branch_or_id, build_target);
  std::string build_id = branch_or_id;
  if (branch_latest_build_id != "") {
    LOG(INFO) << "The latest good build on branch \"" << branch_or_id
        << "\"with build target \"" << build_target
        << "\" is \"" << branch_latest_build_id << "\"";
    build_id = branch_latest_build_id;
  }
  DeviceBuild proposed_build = DeviceBuild(build_id, build_target);
  std::string status = build_api->BuildStatus(proposed_build);
  if (status == "") {
    LOG(FATAL) << proposed_build << " is not a valid branch or build id.";
  }
  LOG(INFO) << "Status for build " << proposed_build << " is " << status;
  while (retry_period != std::chrono::seconds::zero() && !StatusIsTerminal(status)) {
    LOG(INFO) << "Status is \"" << status << "\". Waiting for " << retry_period.count()
        << " seconds.";
    std::this_thread::sleep_for(retry_period);
    status = build_api->BuildStatus(proposed_build);
  }
  LOG(INFO) << "Status for build " << proposed_build << " is " << status;
  proposed_build.product = build_api->ProductName(proposed_build);
  return proposed_build;
}

} // namespace cuttlefish