Forward user information from GUI and coconut to Kafka for use by Bookkeeping

coconut/control/control.go

@@ -40,6 +40,7 @@ import (
 	"text/template"
 	"time"
 
+	commonpb "github.com/AliceO2Group/Control/common/protos"
 	"github.com/fatih/color"
 
 	"github.com/xlab/treeprint"
@@ -365,7 +366,13 @@ func CreateEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.C
 				WithError(err).
 				Fatal("command finished with error")
 		}
-		_, err = rpc.NewAutoEnvironment(cxt, &pb.NewAutoEnvironmentRequest{WorkflowTemplate: wfPath, Vars: extraVarsMap, Id: id}, grpc.EmptyCallOption{})
+		_, err = rpc.NewAutoEnvironment(cxt, &pb.NewAutoEnvironmentRequest{
+			WorkflowTemplate: wfPath,
+			Vars:             extraVarsMap,
+			Id:               id,
+			RequestUser: &commonpb.User{
+				Name: getUserAndHost(),
+			}}, grpc.EmptyCallOption{})
 		if err != nil {
 			return err
 		}
@@ -424,9 +431,23 @@ func CreateEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.C
 
 	var response *pb.NewEnvironmentReply
 	if asynchronous {
-		response, err = rpc.NewEnvironmentAsync(cxt, &pb.NewEnvironmentRequest{WorkflowTemplate: wfPath, Vars: extraVarsMap, Public: public}, grpc.EmptyCallOption{})
+		response, err = rpc.NewEnvironmentAsync(cxt, &pb.NewEnvironmentRequest{
+			WorkflowTemplate: wfPath,
+			Vars:             extraVarsMap,
+			Public:           public,
+			RequestUser: &commonpb.User{
+				Name: getUserAndHost(),
+			},
+		}, grpc.EmptyCallOption{})
 	} else {
-		response, err = rpc.NewEnvironment(cxt, &pb.NewEnvironmentRequest{WorkflowTemplate: wfPath, Vars: extraVarsMap, Public: public}, grpc.EmptyCallOption{})
+		response, err = rpc.NewEnvironment(cxt, &pb.NewEnvironmentRequest{
+			WorkflowTemplate: wfPath,
+			Vars:             extraVarsMap,
+			Public:           public,
+			RequestUser: &commonpb.User{
+				Name: getUserAndHost(),
+			},
+		}, grpc.EmptyCallOption{})
 	}
 	if err != nil {
 		return
@@ -588,7 +609,13 @@ func ControlEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.
 	}
 
 	var response *pb.ControlEnvironmentReply
-	response, err = rpc.ControlEnvironment(cxt, &pb.ControlEnvironmentRequest{Id: args[0], Type: pb.ControlEnvironmentRequest_Optype(pb.ControlEnvironmentRequest_Optype_value[event])}, grpc.EmptyCallOption{})
+	response, err = rpc.ControlEnvironment(cxt, &pb.ControlEnvironmentRequest{
+		Id:   args[0],
+		Type: pb.ControlEnvironmentRequest_Optype(pb.ControlEnvironmentRequest_Optype_value[event]),
+		RequestUser: &commonpb.User{
+			Name: getUserAndHost(),
+		},
+	}, grpc.EmptyCallOption{})
 	if err != nil {
 		return
 	}
@@ -717,7 +744,15 @@ func DestroyEnvironment(cxt context.Context, rpc *coconut.RpcClient, cmd *cobra.
 		keepTasks = false
 	}
 
-	_, err = rpc.DestroyEnvironment(cxt, &pb.DestroyEnvironmentRequest{Id: envId, KeepTasks: keepTasks, AllowInRunningState: allowInRunningState, Force: force}, grpc.EmptyCallOption{})
+	_, err = rpc.DestroyEnvironment(cxt, &pb.DestroyEnvironmentRequest{
+		Id:                  envId,
+		KeepTasks:           keepTasks,
+		AllowInRunningState: allowInRunningState,
+		Force:               force,
+		RequestUser: &commonpb.User{
+			Name: getUserAndHost(),
+		},
+	}, grpc.EmptyCallOption{})
 	if err != nil {
 		return
 	}

coconut/control/controlutil.go

@@ -28,6 +28,8 @@ import (
 	"encoding/json"
 	"fmt"
 	"io"
+	"os"
+	"os/user"
 	"strconv"
 	"strings"
 	"time"
@@ -191,3 +193,20 @@ func formatNumber(numberOfMachines int32) string {
 	}
 	return nMString
 }
+
+func getUserAndHost() string {
+	userName := "unknown"
+	hostName := "unknown"
+
+	currentUser, err := user.Current()
+	if err == nil {
+		userName = currentUser.Username
+	}
+
+	currentHost, err := os.Hostname()
+	if err == nil {
+		hostName = currentHost
+	}
+
+	return fmt.Sprintf("%s@%s", userName, hostName)
+}

common/doc.go

@@ -27,3 +27,4 @@
 package common
 
 //go:generate protoc -I=./ --go_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative --go-grpc_out=require_unimplemented_servers=false:. protos/events.proto
+//go:generate protoc -I=./ --go_out=. --go_opt=paths=source_relative --go-grpc_opt=paths=source_relative --go-grpc_out=require_unimplemented_servers=false:. protos/common.proto

common/protos/common.proto

@@ -0,0 +1,41 @@
+/*
+ * === This file is part of ALICE O² ===
+ *
+ * Copyright 2024 CERN and copyright holders of ALICE O².
+ * Author: Teo Mrnjavac <[email protected]>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * In applying this license CERN does not waive the privileges and
+ * immunities granted to it by virtue of its status as an
+ * Intergovernmental Organization or submit itself to any jurisdiction.
+ */
+
+
+syntax = "proto3";
+
+package common;
+option java_package = "ch.cern.alice.o2.control.common";
+option go_package = "github.com/AliceO2Group/Control/common/protos;pb";
+
+//////////////// Common types ///////////////
+
+message User {
+  // The unique CERN identifier of this user.
+  int32 externalId = 1;
+  // The unique identifier of this entity.
+  optional int32 id = 2;
+  // Name of the user.
+  string name = 3;
+}