Rest gateway (#1355)

## Summarize your change
Create a service to expose a REST endpoint for the grpc interface. The
motivation behind having a REST endpoint is to create a web version of
cuegui (coming soon).


## How does it work

See the [module
README](https://github.com/AcademySoftwareFoundation/OpenCue/blob/1f3229599a58af64aa9c7feda7657f8fece9c97d/rest_gateway/README.md)
for a full documentation.

---------

Signed-off-by: Diego Tavares <[email protected]>
Co-authored-by: Zachary Fong <[email protected]>
Co-authored-by: Ramon Figueiredo <[email protected]>

.gitignore

@@ -9,6 +9,7 @@ venv*/
 .coverage
 coverage.xml
 htmlcov/
+rest_gateway/*.tar\.gz
 /.env
 .envrc
 .vscode

VERSION.in

@@ -1 +1 @@
-1.0
+1.0

proto/comment.proto

@@ -5,6 +5,8 @@ package comment;
 option java_package = "com.imageworks.spcue.grpc.comment";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
+
 // The Comment class contains comment data for any entity that supports
 // commenting.  Currently these are [Job] and [Host].
 

proto/criterion.proto

@@ -4,6 +4,7 @@ package criterion;
 option java_package = "com.imageworks.spcue.grpc.criterion";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
 
 // -------- Primary Message Types --------]
 

proto/cue.proto

@@ -5,6 +5,8 @@ package cue;
 option java_package = "com.imageworks.spcue.grpc.cue";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
+
 // Core System level objects and methods
 
 

proto/department.proto

@@ -5,6 +5,8 @@ package department;
 option java_package = "com.imageworks.spcue.grpc.department";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
+
 import "task.proto";
 
 // Departments

proto/depend.proto

@@ -5,6 +5,7 @@ package depend;
 option java_package = "com.imageworks.spcue.grpc.depend";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
 
 // -------- Services --------
 

proto/facility.proto

@@ -7,6 +7,7 @@ option java_multiple_files = true;
 import "host.proto";
 import "subscription.proto";
 
+option go_package = "opencue_gateway/gen/go";
 
 // -------- Services --------
 

proto/filter.proto

@@ -7,6 +7,7 @@ option java_multiple_files = true;
 
 import "job.proto";
 
+option go_package = "opencue_gateway/gen/go";
 
 // -------- Services --------
 

proto/host.proto

@@ -10,6 +10,7 @@ import "criterion.proto";
 import "job.proto";
 import "renderPartition.proto";
 
+option go_package = "opencue_gateway/gen/go";
 
 // -------- Services --------]
 

proto/job.proto

@@ -5,6 +5,8 @@ package job;
 option java_package = "com.imageworks.spcue.grpc.job";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
+
 import "comment.proto";
 import "depend.proto";
 import "limit.proto";

proto/limit.proto

@@ -5,6 +5,8 @@ package limit;
 option java_package = "com.imageworks.spcue.grpc.limit";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
+
 // The Limit class contains data that allows users to place limits
 // on the maximum number of running frames for a certain type of layer.
 

proto/renderPartition.proto

@@ -5,6 +5,7 @@ package renderPartition;
 option java_package = "com.imageworks.spcue.grpc.renderpartition";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
 
 // -------- Services --------]
 

proto/report.proto

@@ -5,6 +5,8 @@ package report;
 option java_package = "com.imageworks.spcue.grpc.report";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
+
 import "host.proto";
 
 // Interface to handle RQD pings.

proto/rqd.proto

@@ -5,6 +5,8 @@ package rqd;
 option java_package = "com.imageworks.spcue.grpc.rqd";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
+
 import "report.proto";
 
 // Interface for issuing commands to an RQD instance.

proto/service.proto

@@ -5,6 +5,7 @@ package service;
 option java_package = "com.imageworks.spcue.grpc.service";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
 
 // Interface for managing Service objects
 

proto/show.proto

@@ -5,6 +5,8 @@ package show;
 option java_package = "com.imageworks.spcue.grpc.show";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
+
 import "department.proto";
 import "filter.proto";
 import "host.proto";

proto/subscription.proto

@@ -5,6 +5,8 @@ package subscription;
 option java_package = "com.imageworks.spcue.grpc.subscription";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
+
 // Subscriptions
 // A subscription is what a show sets up when they want to use hosts in
 // an allocation.

proto/task.proto

@@ -5,6 +5,8 @@ package task;
 option java_package = "com.imageworks.spcue.grpc.task";
 option java_multiple_files = true;
 
+option go_package = "opencue_gateway/gen/go";
+
 // Tasks
 // Tasks are shot priorities for a specific dept
 

rest_gateway/.gitignore

@@ -0,0 +1 @@
+.env

rest_gateway/Dockerfile

@@ -0,0 +1,54 @@
+FROM centos7.6-go1.21:latest AS build
+
+RUN yum install -y \
+    git \ 
+    protobuf3-compiler \ 
+    && yum clean all
+WORKDIR /app
+ENV PATH=$PATH:/root/go/bin:/opt/protobuf3/usr/bin/
+
+# Copy all of the staged files (protos plus go source)
+COPY ./proto /app/proto
+COPY ./rest_gateway/opencue_gateway /app/opencue_gateway
+# COPY ./lib /app/lib
+
+
+WORKDIR /app/opencue_gateway
+RUN go mod init opencue_gateway && go mod tidy
+
+RUN go install \
+    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway \
+    github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2 \
+    github.com/golang-jwt/jwt/v5 \
+    google.golang.org/protobuf/cmd/protoc-gen-go \
+    google.golang.org/grpc/cmd/protoc-gen-go-grpc
+
+# Generate go grpc code
+RUN mkdir -p gen/go && \
+    protoc -I ../proto/ \
+    --go_out ./gen/go/ \
+    --go_opt paths=source_relative \
+    --go-grpc_out ./gen/go/ \
+    --go-grpc_opt paths=source_relative \
+    ../proto/*.proto
+
+# Generate grpc-gateway handlers
+RUN protoc -I ../proto/ --grpc-gateway_out ./gen/go \
+    --grpc-gateway_opt paths=source_relative \
+    --grpc-gateway_opt generate_unbound_methods=true \
+    ../proto/*.proto
+
+# Uncomment this to run go tests
+# RUN go test -v
+
+# Build project
+RUN go build -o grpc_gateway main.go
+
+FROM centos-7.6.1810:latest
+COPY --from=build /app/opencue_gateway/grpc_gateway /app/
+
+# Ensure logs folder is created and has correct permissions
+RUN mkdir -p /logs && chmod 755 /logs
+
+EXPOSE 8448
+ENTRYPOINT ["/app/grpc_gateway"]