Implement manifests and build_config

1 files changed, 215 insertions, 0 deletions

diff --git a/bbot/manifest b/bbot/manifest
new file mode 100644
index 0000000..5122dc6
--- /dev/null
+++ b/bbot/manifest
@@ -0,0 +1,215 @@
+// 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 <iosfwd>
+
+#include <butl/optional>
+#include <butl/small-vector>
+#include <butl/target-triplet>
+#include <butl/manifest-forward>
+
+#include <bpkg/manifest> // version, repository_location
+
+#include <bbot/export>
+
+#include <bbot/variable>
+
+namespace bbot
+{
+  enum class machine_type {vm, container};
+
+  class LIBBBOT_EXPORT machine_manifest
+  {
+  public:
+    std::string id;
+    std::string name;
+
+    // Absent if inside task_request_manifest.
+    //
+    butl::optional<machine_type> type;
+
+    std::string summary;
+
+  public:
+    machine_manifest () = default; // VC export.
+    machine_manifest (butl::manifest_parser&, bool ignore_unknown = false);
+    machine_manifest (butl::manifest_parser&,
+                      butl::manifest_name_value start,
+                      bool ignore_unknown = false);
+
+    void
+    serialize (butl::manifest_serializer&) const;
+
+  private:
+    machine_manifest (butl::manifest_parser&,
+                      butl::manifest_name_value start,
+                      bool in_list,
+                      bool ignore_unknown);
+  };
+
+  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
+    //
+    std::string fingerprint;
+
+    std::vector<machine_manifest> machines;
+
+  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.
+
+    // 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).
+    //
+    variables config;
+
+  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;
+  };
+
+  class LIBBBOT_EXPORT task_response_manifest
+  {
+  public:
+    // If empty then no task available.
+    //
+    std::string session;
+
+    // Challenge and task are absent if session is empty.
+    //
+    butl::optional<std::string> challenge;
+    butl::optional<task_manifest> task;
+
+  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
+  };
+
+  std::ostream&
+  operator<< (std::ostream&, result_status);
+
+  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;
+  }
+
+  struct operation_result
+  {
+    std::string operation; // "configure", "update", "test", etc.
+    result_status status;
+    std::string log;
+  };
+
+  using operation_results = butl::small_vector<operation_result, 3>;
+
+  class LIBBBOT_EXPORT result_manifest
+  {
+  public:
+    // Built package.
+    //
+    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 () = 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.
+    std::string challenge; // The answer to challenge in the task response.
+
+    result_manifest result;
+
+  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