T7121: add commitd protobuf message definition file

5 files changed, 487 insertions, 2 deletions

diff --git a/data/dune b/data/dune
index e5ffaa6..df63152 100644
--- a/data/dune
+++ b/data/dune
@@ -1,3 +1,3 @@
 (install
- (files vyconfd.conf vyconf.proto)
+ (files vyconfd.conf vyconf.proto vycall.proto)
  (section share))
diff --git a/data/vycall.proto b/data/vycall.proto
new file mode 100644
index 0000000..e0af67b
--- /dev/null
+++ b/data/vycall.proto
@@ -0,0 +1,27 @@
+message Status {
+    required bool success = 1;
+    required string out = 2;
+}
+
+message Call {
+    required string script_name = 1;
+    optional string tag_value = 2;
+    optional string arg_value = 3;
+    optional Status reply = 4;
+}
+
+message Commit {
+    required string session_id = 1;
+    // optional explicit load;
+    // otherwise, session configs are loaded from cached internal
+    // representation, specified by session id value
+    optional string named_active = 2;
+    optional string named_proposed = 3;
+    //
+    required bool dry_run = 4;
+    required bool atomic = 5;
+    required bool background = 6;
+
+    optional Status init = 7;
+    repeated Call calls = 8;
+}
diff --git a/src/dune b/src/dune
index 3998f1e..97f24ee 100644
--- a/src/dune
+++ b/src/dune
@@ -50,7 +50,6 @@
  (preprocess (pps lwt_ppx)))
 
 (rule
- (alias protoc)
  (mode promote)
  (targets vyconf_pbt.ml vyconf_pbt.mli)
  (action
@@ -61,6 +60,17 @@
     (run mv src/vyconf.ml src/vyconf_pbt.ml)
     (run mv src/vyconf.mli src/vyconf_pbt.mli)))))
 
+(rule
+ (mode promote)
+ (targets vycall_pbt.ml vycall_pbt.mli)
+ (action
+  (chdir
+   %{project_root}
+   (progn
+    (run ocaml-protoc --ml_out src data/vycall.proto)
+    (run mv src/vycall.ml src/vycall_pbt.ml)
+    (run mv src/vycall.mli src/vycall_pbt.mli)))))
+
 (library
  (name vyos1x_adapter)
  (public_name vyconf.vyos1x-adapter)
diff --git a/src/vycall_pbt.ml b/src/vycall_pbt.ml
new file mode 100644
index 0000000..8cccb0a
--- /dev/null
+++ b/src/vycall_pbt.ml
@@ -0,0 +1,349 @@
+[@@@ocaml.warning "-27-30-39-44"]
+
+type status = {
+  success : bool;
+  out : string;
+}
+
+type call = {
+  script_name : string;
+  tag_value : string option;
+  arg_value : string option;
+  reply : status option;
+}
+
+type commit = {
+  session_id : string;
+  named_active : string option;
+  named_proposed : string option;
+  dry_run : bool;
+  atomic : bool;
+  background : bool;
+  init : status option;
+  calls : call list;
+}
+
+let rec default_status 
+  ?success:((success:bool) = false)
+  ?out:((out:string) = "")
+  () : status  = {
+  success;
+  out;
+}
+
+let rec default_call 
+  ?script_name:((script_name:string) = "")
+  ?tag_value:((tag_value:string option) = None)
+  ?arg_value:((arg_value:string option) = None)
+  ?reply:((reply:status option) = None)
+  () : call  = {
+  script_name;
+  tag_value;
+  arg_value;
+  reply;
+}
+
+let rec default_commit 
+  ?session_id:((session_id:string) = "")
+  ?named_active:((named_active:string option) = None)
+  ?named_proposed:((named_proposed:string option) = None)
+  ?dry_run:((dry_run:bool) = false)
+  ?atomic:((atomic:bool) = false)
+  ?background:((background:bool) = false)
+  ?init:((init:status option) = None)
+  ?calls:((calls:call list) = [])
+  () : commit  = {
+  session_id;
+  named_active;
+  named_proposed;
+  dry_run;
+  atomic;
+  background;
+  init;
+  calls;
+}
+
+type status_mutable = {
+  mutable success : bool;
+  mutable out : string;
+}
+
+let default_status_mutable () : status_mutable = {
+  success = false;
+  out = "";
+}
+
+type call_mutable = {
+  mutable script_name : string;
+  mutable tag_value : string option;
+  mutable arg_value : string option;
+  mutable reply : status option;
+}
+
+let default_call_mutable () : call_mutable = {
+  script_name = "";
+  tag_value = None;
+  arg_value = None;
+  reply = None;
+}
+
+type commit_mutable = {
+  mutable session_id : string;
+  mutable named_active : string option;
+  mutable named_proposed : string option;
+  mutable dry_run : bool;
+  mutable atomic : bool;
+  mutable background : bool;
+  mutable init : status option;
+  mutable calls : call list;
+}
+
+let default_commit_mutable () : commit_mutable = {
+  session_id = "";
+  named_active = None;
+  named_proposed = None;
+  dry_run = false;
+  atomic = false;
+  background = false;
+  init = None;
+  calls = [];
+}
+
+[@@@ocaml.warning "-27-30-39"]
+
+(** {2 Formatters} *)
+
+let rec pp_status fmt (v:status) = 
+  let pp_i fmt () =
+    Pbrt.Pp.pp_record_field ~first:true "success" Pbrt.Pp.pp_bool fmt v.success;
+    Pbrt.Pp.pp_record_field ~first:false "out" Pbrt.Pp.pp_string fmt v.out;
+  in
+  Pbrt.Pp.pp_brk pp_i fmt ()
+
+let rec pp_call fmt (v:call) = 
+  let pp_i fmt () =
+    Pbrt.Pp.pp_record_field ~first:true "script_name" Pbrt.Pp.pp_string fmt v.script_name;
+    Pbrt.Pp.pp_record_field ~first:false "tag_value" (Pbrt.Pp.pp_option Pbrt.Pp.pp_string) fmt v.tag_value;
+    Pbrt.Pp.pp_record_field ~first:false "arg_value" (Pbrt.Pp.pp_option Pbrt.Pp.pp_string) fmt v.arg_value;
+    Pbrt.Pp.pp_record_field ~first:false "reply" (Pbrt.Pp.pp_option pp_status) fmt v.reply;
+  in
+  Pbrt.Pp.pp_brk pp_i fmt ()
+
+let rec pp_commit fmt (v:commit) = 
+  let pp_i fmt () =
+    Pbrt.Pp.pp_record_field ~first:true "session_id" Pbrt.Pp.pp_string fmt v.session_id;
+    Pbrt.Pp.pp_record_field ~first:false "named_active" (Pbrt.Pp.pp_option Pbrt.Pp.pp_string) fmt v.named_active;
+    Pbrt.Pp.pp_record_field ~first:false "named_proposed" (Pbrt.Pp.pp_option Pbrt.Pp.pp_string) fmt v.named_proposed;
+    Pbrt.Pp.pp_record_field ~first:false "dry_run" Pbrt.Pp.pp_bool fmt v.dry_run;
+    Pbrt.Pp.pp_record_field ~first:false "atomic" Pbrt.Pp.pp_bool fmt v.atomic;
+    Pbrt.Pp.pp_record_field ~first:false "background" Pbrt.Pp.pp_bool fmt v.background;
+    Pbrt.Pp.pp_record_field ~first:false "init" (Pbrt.Pp.pp_option pp_status) fmt v.init;
+    Pbrt.Pp.pp_record_field ~first:false "calls" (Pbrt.Pp.pp_list pp_call) fmt v.calls;
+  in
+  Pbrt.Pp.pp_brk pp_i fmt ()
+
+[@@@ocaml.warning "-27-30-39"]
+
+(** {2 Protobuf Encoding} *)
+
+let rec encode_pb_status (v:status) encoder = 
+  Pbrt.Encoder.bool v.success encoder;
+  Pbrt.Encoder.key 1 Pbrt.Varint encoder; 
+  Pbrt.Encoder.string v.out encoder;
+  Pbrt.Encoder.key 2 Pbrt.Bytes encoder; 
+  ()
+
+let rec encode_pb_call (v:call) encoder = 
+  Pbrt.Encoder.string v.script_name encoder;
+  Pbrt.Encoder.key 1 Pbrt.Bytes encoder; 
+  begin match v.tag_value with
+  | Some x -> 
+    Pbrt.Encoder.string x encoder;
+    Pbrt.Encoder.key 2 Pbrt.Bytes encoder; 
+  | None -> ();
+  end;
+  begin match v.arg_value with
+  | Some x -> 
+    Pbrt.Encoder.string x encoder;
+    Pbrt.Encoder.key 3 Pbrt.Bytes encoder; 
+  | None -> ();
+  end;
+  begin match v.reply with
+  | Some x -> 
+    Pbrt.Encoder.nested encode_pb_status x encoder;
+    Pbrt.Encoder.key 4 Pbrt.Bytes encoder; 
+  | None -> ();
+  end;
+  ()
+
+let rec encode_pb_commit (v:commit) encoder = 
+  Pbrt.Encoder.string v.session_id encoder;
+  Pbrt.Encoder.key 1 Pbrt.Bytes encoder; 
+  begin match v.named_active with
+  | Some x -> 
+    Pbrt.Encoder.string x encoder;
+    Pbrt.Encoder.key 2 Pbrt.Bytes encoder; 
+  | None -> ();
+  end;
+  begin match v.named_proposed with
+  | Some x -> 
+    Pbrt.Encoder.string x encoder;
+    Pbrt.Encoder.key 3 Pbrt.Bytes encoder; 
+  | None -> ();
+  end;
+  Pbrt.Encoder.bool v.dry_run encoder;
+  Pbrt.Encoder.key 4 Pbrt.Varint encoder; 
+  Pbrt.Encoder.bool v.atomic encoder;
+  Pbrt.Encoder.key 5 Pbrt.Varint encoder; 
+  Pbrt.Encoder.bool v.background encoder;
+  Pbrt.Encoder.key 6 Pbrt.Varint encoder; 
+  begin match v.init with
+  | Some x -> 
+    Pbrt.Encoder.nested encode_pb_status x encoder;
+    Pbrt.Encoder.key 7 Pbrt.Bytes encoder; 
+  | None -> ();
+  end;
+  Pbrt.List_util.rev_iter_with (fun x encoder -> 
+    Pbrt.Encoder.nested encode_pb_call x encoder;
+    Pbrt.Encoder.key 8 Pbrt.Bytes encoder; 
+  ) v.calls encoder;
+  ()
+
+[@@@ocaml.warning "-27-30-39"]
+
+(** {2 Protobuf Decoding} *)
+
+let rec decode_pb_status d =
+  let v = default_status_mutable () in
+  let continue__= ref true in
+  let out_is_set = ref false in
+  let success_is_set = ref false in
+  while !continue__ do
+    match Pbrt.Decoder.key d with
+    | None -> (
+    ); continue__ := false
+    | Some (1, Pbrt.Varint) -> begin
+      v.success <- Pbrt.Decoder.bool d; success_is_set := true;
+    end
+    | Some (1, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(status), field(1)" pk
+    | Some (2, Pbrt.Bytes) -> begin
+      v.out <- Pbrt.Decoder.string d; out_is_set := true;
+    end
+    | Some (2, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(status), field(2)" pk
+    | Some (_, payload_kind) -> Pbrt.Decoder.skip d payload_kind
+  done;
+  begin if not !out_is_set then Pbrt.Decoder.missing_field "out" end;
+  begin if not !success_is_set then Pbrt.Decoder.missing_field "success" end;
+  ({
+    success = v.success;
+    out = v.out;
+  } : status)
+
+let rec decode_pb_call d =
+  let v = default_call_mutable () in
+  let continue__= ref true in
+  let script_name_is_set = ref false in
+  while !continue__ do
+    match Pbrt.Decoder.key d with
+    | None -> (
+    ); continue__ := false
+    | Some (1, Pbrt.Bytes) -> begin
+      v.script_name <- Pbrt.Decoder.string d; script_name_is_set := true;
+    end
+    | Some (1, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(call), field(1)" pk
+    | Some (2, Pbrt.Bytes) -> begin
+      v.tag_value <- Some (Pbrt.Decoder.string d);
+    end
+    | Some (2, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(call), field(2)" pk
+    | Some (3, Pbrt.Bytes) -> begin
+      v.arg_value <- Some (Pbrt.Decoder.string d);
+    end
+    | Some (3, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(call), field(3)" pk
+    | Some (4, Pbrt.Bytes) -> begin
+      v.reply <- Some (decode_pb_status (Pbrt.Decoder.nested d));
+    end
+    | Some (4, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(call), field(4)" pk
+    | Some (_, payload_kind) -> Pbrt.Decoder.skip d payload_kind
+  done;
+  begin if not !script_name_is_set then Pbrt.Decoder.missing_field "script_name" end;
+  ({
+    script_name = v.script_name;
+    tag_value = v.tag_value;
+    arg_value = v.arg_value;
+    reply = v.reply;
+  } : call)
+
+let rec decode_pb_commit d =
+  let v = default_commit_mutable () in
+  let continue__= ref true in
+  let background_is_set = ref false in
+  let atomic_is_set = ref false in
+  let dry_run_is_set = ref false in
+  let session_id_is_set = ref false in
+  while !continue__ do
+    match Pbrt.Decoder.key d with
+    | None -> (
+      v.calls <- List.rev v.calls;
+    ); continue__ := false
+    | Some (1, Pbrt.Bytes) -> begin
+      v.session_id <- Pbrt.Decoder.string d; session_id_is_set := true;
+    end
+    | Some (1, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(commit), field(1)" pk
+    | Some (2, Pbrt.Bytes) -> begin
+      v.named_active <- Some (Pbrt.Decoder.string d);
+    end
+    | Some (2, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(commit), field(2)" pk
+    | Some (3, Pbrt.Bytes) -> begin
+      v.named_proposed <- Some (Pbrt.Decoder.string d);
+    end
+    | Some (3, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(commit), field(3)" pk
+    | Some (4, Pbrt.Varint) -> begin
+      v.dry_run <- Pbrt.Decoder.bool d; dry_run_is_set := true;
+    end
+    | Some (4, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(commit), field(4)" pk
+    | Some (5, Pbrt.Varint) -> begin
+      v.atomic <- Pbrt.Decoder.bool d; atomic_is_set := true;
+    end
+    | Some (5, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(commit), field(5)" pk
+    | Some (6, Pbrt.Varint) -> begin
+      v.background <- Pbrt.Decoder.bool d; background_is_set := true;
+    end
+    | Some (6, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(commit), field(6)" pk
+    | Some (7, Pbrt.Bytes) -> begin
+      v.init <- Some (decode_pb_status (Pbrt.Decoder.nested d));
+    end
+    | Some (7, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(commit), field(7)" pk
+    | Some (8, Pbrt.Bytes) -> begin
+      v.calls <- (decode_pb_call (Pbrt.Decoder.nested d)) :: v.calls;
+    end
+    | Some (8, pk) -> 
+      Pbrt.Decoder.unexpected_payload "Message(commit), field(8)" pk
+    | Some (_, payload_kind) -> Pbrt.Decoder.skip d payload_kind
+  done;
+  begin if not !background_is_set then Pbrt.Decoder.missing_field "background" end;
+  begin if not !atomic_is_set then Pbrt.Decoder.missing_field "atomic" end;
+  begin if not !dry_run_is_set then Pbrt.Decoder.missing_field "dry_run" end;
+  begin if not !session_id_is_set then Pbrt.Decoder.missing_field "session_id" end;
+  ({
+    session_id = v.session_id;
+    named_active = v.named_active;
+    named_proposed = v.named_proposed;
+    dry_run = v.dry_run;
+    atomic = v.atomic;
+    background = v.background;
+    init = v.init;
+    calls = v.calls;
+  } : commit)
diff --git a/src/vycall_pbt.mli b/src/vycall_pbt.mli
new file mode 100644
index 0000000..5c8bd20
--- /dev/null
+++ b/src/vycall_pbt.mli
@@ -0,0 +1,99 @@
+
+(** Code for vycall.proto *)
+
+(* generated from "data/vycall.proto", do not edit *)
+
+
+
+(** {2 Types} *)
+
+type status = {
+  success : bool;
+  out : string;
+}
+
+type call = {
+  script_name : string;
+  tag_value : string option;
+  arg_value : string option;
+  reply : status option;
+}
+
+type commit = {
+  session_id : string;
+  named_active : string option;
+  named_proposed : string option;
+  dry_run : bool;
+  atomic : bool;
+  background : bool;
+  init : status option;
+  calls : call list;
+}
+
+
+(** {2 Basic values} *)
+
+val default_status : 
+  ?success:bool ->
+  ?out:string ->
+  unit ->
+  status
+(** [default_status ()] is the default value for type [status] *)
+
+val default_call : 
+  ?script_name:string ->
+  ?tag_value:string option ->
+  ?arg_value:string option ->
+  ?reply:status option ->
+  unit ->
+  call
+(** [default_call ()] is the default value for type [call] *)
+
+val default_commit : 
+  ?session_id:string ->
+  ?named_active:string option ->
+  ?named_proposed:string option ->
+  ?dry_run:bool ->
+  ?atomic:bool ->
+  ?background:bool ->
+  ?init:status option ->
+  ?calls:call list ->
+  unit ->
+  commit
+(** [default_commit ()] is the default value for type [commit] *)
+
+
+(** {2 Formatters} *)
+
+val pp_status : Format.formatter -> status -> unit 
+(** [pp_status v] formats v *)
+
+val pp_call : Format.formatter -> call -> unit 
+(** [pp_call v] formats v *)
+
+val pp_commit : Format.formatter -> commit -> unit 
+(** [pp_commit v] formats v *)
+
+
+(** {2 Protobuf Encoding} *)
+
+val encode_pb_status : status -> Pbrt.Encoder.t -> unit
+(** [encode_pb_status v encoder] encodes [v] with the given [encoder] *)
+
+val encode_pb_call : call -> Pbrt.Encoder.t -> unit
+(** [encode_pb_call v encoder] encodes [v] with the given [encoder] *)
+
+val encode_pb_commit : commit -> Pbrt.Encoder.t -> unit
+(** [encode_pb_commit v encoder] encodes [v] with the given [encoder] *)
+
+
+(** {2 Protobuf Decoding} *)
+
+val decode_pb_status : Pbrt.Decoder.t -> status
+(** [decode_pb_status decoder] decodes a [status] binary value from [decoder] *)
+
+val decode_pb_call : Pbrt.Decoder.t -> call
+(** [decode_pb_call decoder] decodes a [call] binary value from [decoder] *)
+
+val decode_pb_commit : Pbrt.Decoder.t -> commit
+(** [decode_pb_commit decoder] decodes a [commit] binary value from [decoder] *)