1 files changed, 141 insertions, 0 deletions
diff --git a/mod/ci-common.hxx b/mod/ci-common.hxx
new file mode 100644
index 0000000..848bca1
--- /dev/null
+++ b/mod/ci-common.hxx
@@ -0,0 +1,141 @@
+// file      : mod/ci-common.hxx -*- C++ -*-
+// license   : MIT; see accompanying LICENSE file
+
+#ifndef MOD_CI_COMMON_HXX
+#define MOD_CI_COMMON_HXX
+
+#include <odb/forward.hxx> // database
+
+#include <libbrep/types.hxx>
+#include <libbrep/utility.hxx>
+
+#include <libbrep/common.hxx>
+
+#include <mod/diagnostics.hxx>
+#include <mod/module-options.hxx>
+
+namespace brep
+{
+  class ci_start
+  {
+  public:
+    void
+    init (shared_ptr<options::ci_start>);
+
+    // If the request handling has been performed normally, then return the
+    // information that corresponds to the CI result manifest (see CI Result
+    // Manifest in the manual). Otherwise (some internal has error occured),
+    // log the error and return nullopt.
+    //
+    // The arguments correspond to the CI request and overrides manifest
+    // values (see CI Request and Overrides Manifests in the manual). Note:
+    // request id and timestamp are generated by the implementation.
+    //
+    struct package
+    {
+      package_name name;
+      optional<brep::version> version;
+    };
+
+    // Note that the inability to generate the reference is an internal
+    // error. Thus, it is not optional.
+    //
+    struct start_result
+    {
+      uint16_t status;
+      string message;
+      string reference;
+      vector<pair<string, string>> custom_result;
+    };
+
+    // In the optional service information, if id is empty, then the generated
+    // reference is used instead.
+    //
+    optional<start_result>
+    start (const basic_mark& error,
+           const basic_mark& warn,
+           const basic_mark* trace,
+           optional<tenant_service>&&,
+           const repository_location& repository,
+           const vector<package>& packages,
+           const optional<string>& client_ip,
+           const optional<string>& user_agent,
+           const optional<string>& interactive = nullopt,
+           const optional<string>& simulate = nullopt,
+           const vector<pair<string, string>>& custom_request = {},
+           const vector<pair<string, string>>& overrides = {}) const;
+
+    // Create an unloaded CI request returning start_result::reference on
+    // success and nullopt on an internal error. Such a request is not started
+    // until loaded with the load() function below. Configure the time
+    // interval between the build_unloaded() notifications for the being
+    // created tenant and set the initial delay for the first notification.
+    // See also the build_unloaded() tenant services notification.
+    //
+    // Note: should be called out of the database transaction.
+    //
+    optional<string>
+    create (const basic_mark& error,
+            const basic_mark& warn,
+            const basic_mark* trace,
+            odb::core::database&,
+            tenant_service&&,
+            duration notify_interval,
+            duration notify_delay) const;
+
+    // Load (and start) previously created (as unloaded) CI request. Similarly
+    // to the start() function, return nullopt on an internal error.
+    //
+    // Note that tenant_service::id is used to identify the CI request tenant.
+    //
+    // Note: should be called out of the database transaction.
+    //
+    optional<start_result>
+    load (const basic_mark& error,
+          const basic_mark& warn,
+          const basic_mark* trace,
+          odb::core::database&,
+          tenant_service&&,
+          const repository_location& repository) const;
+
+    // Cancel previously created or started CI request. Return the service
+    // state or nullopt if there is no tenant for such a type/id pair.
+    //
+    // Note: should be called out of the database transaction.
+    //
+    optional<tenant_service>
+    cancel (const basic_mark& error,
+            const basic_mark& warn,
+            const basic_mark* trace,
+            odb::core::database&,
+            const string& type,
+            const string& id) const;
+
+    // Cancel previously created or started CI request. Return false if there
+    // is no tenant for the specified tenant id. Note that the reason argument
+    // is only used for tracing.
+    //
+    // Note: should be called out of the database transaction.
+    //
+    bool
+    cancel (const basic_mark& error,
+            const basic_mark& warn,
+            const basic_mark* trace,
+            const string& reason,
+            odb::core::database&,
+            const string& tenant_id) const;
+
+    // Helpers.
+    //
+
+    // Serialize the start result as a CI result manifest.
+    //
+    static void
+    serialize_manifest (const start_result&, ostream&, bool long_lines = false);
+
+  private:
+    shared_ptr<options::ci_start> options_;
+  };
+}
+
+#endif // MOD_CI_COMMON_HXX