path: root/bbot/manifest

// file      : bbot/manifest -*- C++ -*-
// copyright : Copyright (c) 2014-2017 Code Synthesis Ltd
// license   : MIT; see accompanying LICENSE file

#ifndef BBOT_MANIFEST
#define BBOT_MANIFEST

#include <string>
#include <vector>
#include <ostream>

#include <butl/optional>
#include <butl/target-triplet>
#include <butl/manifest-forward>

#include <bpkg/manifest> // version, repository_location

#include <bbot/export>

namespace bbot
{
  using strings = std::vector<std::string>;

  class LIBBBOT_EXPORT machine_header_manifest
  {
  public:
    std::string id;
    std::string name;
    std::string summary;

    machine_header_manifest (std::string i, std::string n, std::string s)
        : id (std::move (i)), name (std::move (n)), summary (std::move (s)) {}

  public:
    machine_header_manifest () = default; // VC export.
    machine_header_manifest (butl::manifest_parser&,
                             bool ignore_unknown = false);
    machine_header_manifest (butl::manifest_parser&,
                             butl::manifest_name_value start,
                             bool ignore_unknown = false);

    void
    serialize (butl::manifest_serializer&) const;
  };

  using machine_header_manifests = std::vector<machine_header_manifest>;

  class LIBBBOT_EXPORT task_request_manifest
  {
  public:
    std::string agent;

    // Agent's public key SHA256 fingerprint.
    //
    // @@ How the fingerpring for openssl public key will be produced? Seems
    //    there is no "standard" for it. Possibly we will use the following
    //    command result (plain SHA256).
    //
    //    $ cat key.pub | openssl sha256
    //
    butl::optional<std::string> fingerprint;

    machine_header_manifests machines;

    task_request_manifest (std::string a,
                           butl::optional<std::string> f,
                           machine_header_manifests m)
        : agent (std::move (a)),
          fingerprint (std::move (f)),
          machines (std::move (m)) {}

  public:
    task_request_manifest () = default; // VC export.
    task_request_manifest (butl::manifest_parser&,
                           bool ignore_unknown = false);

    void
    serialize (butl::manifest_serializer&) const;
  };

  class LIBBBOT_EXPORT task_manifest
  {
  public:
    // Package to build.
    //
    std::string name;
    bpkg::version version;
    bpkg::repository_location repository; // Remote or absolute.

    // The SHA256 repositories certificates fingerprints to trust. The special
    // 'yes' value can be specified instead of fingerprint (in which case all
    // repositories will be trusted without authentication).
    //
    strings trust;

    // Build machine to use for building the package.
    //
    std::string machine;

    // Default for the machine if absent.
    //
    butl::optional<butl::target_triplet> target;

    // Build system configuration variables (in addition to build environment
    // configuration variables).
    // Note: could be quoted.
    //
    strings config;

    strings
    unquoted_config ();

    task_manifest (std::string nm,
                   bpkg::version vr,
                   bpkg::repository_location rl,
                   strings tr,
                   std::string mn,
                   butl::optional<butl::target_triplet> tg,
                   strings cf)
        : name (std::move (nm)),
          version (std::move (vr)),
          repository (std::move (rl)),
          trust (tr),
          machine (std::move (mn)),
          target (std::move (tg)),
          config (std::move (cf)) {}

  public:
    task_manifest () = default; // VC export.
    task_manifest (butl::manifest_parser&, bool ignore_unknown = false);
    task_manifest (butl::manifest_parser&,
                   butl::manifest_name_value start,
                   bool ignore_unknown = false);

    void
    serialize (butl::manifest_serializer&) const;

    // Check that a string has the name=value format. The name must not
    // contain spaces. Throw invalid_argument if the string doesn't conform to
    // these rules.
    //
    static void
    check_config (const std::string&);
  };

  class LIBBBOT_EXPORT task_response_manifest
  {
  public:
    // If empty then no task available.
    //
    std::string session;

    // Challenge, result url and task are absent if session is empty.
    //
    butl::optional<std::string> challenge;
    butl::optional<std::string> result_url;
    butl::optional<task_manifest> task;

    task_response_manifest (std::string s,
                            butl::optional<std::string> c,
                            butl::optional<std::string> u,
                            butl::optional<task_manifest> t)
        : session (std::move (s)),
          challenge (std::move (c)),
          result_url (std::move (u)),
          task (std::move (t)) {}

  public:
    task_response_manifest () = default; // VC export.
    task_response_manifest (butl::manifest_parser&,
                            bool ignore_unknown = false);

    void
    serialize (butl::manifest_serializer&) const;
  };

  // Build task or operation result status.
  //
  enum class result_status: std::uint8_t
  {
    // The order of the enumerators is arranged so that their integral values
    // indicate whether one "overrides" the other in the "merge" operator|
    // (see below).
    //
    success,
    warning,
    error,
    abort,
    abnormal
  };

  LIBBBOT_EXPORT std::string
  to_string (result_status);

  LIBBBOT_EXPORT result_status
  to_result_status (const std::string&); // May throw invalid_argument.

  inline std::ostream&
  operator<< (std::ostream& os, result_status s) {return os << to_string (s);}

  inline result_status&
  operator|= (result_status& l, result_status r)
  {
    if (static_cast<std::uint8_t> (r) > static_cast<std::uint8_t> (l))
      l = r;
    return l;
  }

  // Return true if the result is "bad", that is, error or worse.
  //
  inline bool
  operator! (result_status s)
  {
    return static_cast<std::uint8_t> (s) >=
      static_cast<std::uint8_t> (result_status::error);
  }

  struct operation_result
  {
    std::string operation; // "configure", "update", "test", etc.
    result_status status;
    std::string log;
  };

  using operation_results = std::vector<operation_result>;

  class LIBBBOT_EXPORT result_manifest
  {
  public:
    // Built package.
    //
    // If the version is 0 (which signifies a stub package that cannot be
    // possibly built) then both name and version are "unknown". This is used
    // by the worker to signal abnormal termination before being able to
    // obtain the package name/version.
    //
    std::string name;
    bpkg::version version;

    result_status status;

    // Ordered (ascending) by operation value. May not contain all the
    // operations if the task failed in the middle, but should have no gaps
    // (operation can not start unless all previous ones succeeded).
    //
    operation_results results;

    result_manifest (std::string n,
                     bpkg::version v,
                     result_status s,
                     operation_results r)
        : name (std::move (n)),
          version (std::move (v)),
          status (s),
          results (std::move (r)) {}

  public:
    result_manifest () = default; // VC export.
    result_manifest (butl::manifest_parser&, bool ignore_unknown = false);
    result_manifest (butl::manifest_parser&,
                     butl::manifest_name_value start,
                     bool ignore_unknown = false);

    void
    serialize (butl::manifest_serializer&) const;
  };

  class LIBBBOT_EXPORT result_request_manifest
  {
  public:
    std::string session;   // The task response session.

    // The answer to challenge in the task response.
    //
    butl::optional<std::string> challenge;

    result_manifest result;

    result_request_manifest (std::string s,
                             butl::optional<std::string> c,
                             result_manifest r)
        : session (std::move (s)),
          challenge (std::move (c)),
          result (std::move (r)) {}

  public:
    result_request_manifest () = default; // VC export.
    result_request_manifest (butl::manifest_parser&,
                             bool ignore_unknown = false);

    void
    serialize (butl::manifest_serializer&) const;
  };
}

#endif // BBOT_MANIFEST