Rust RQD (#1759)

Introduce a Rust directory containing a Rust version of the RQD module
and its dependencies.

For more information about the workspace organization, see
`Opencue/rust/OVERVIEW.md`

Modules can be compiled for the desired OS with `cargo built -r`, this
version supports both MacOS and Linux. Compiling at debug mode favours
the Linux version build.

Binaries can be found after compilation on the default directory
(target/release).

---------

Signed-off-by: Diego Tavares <[email protected]>

Author: DiegoTavares

.github/workflows/rust.yml

@@ -0,0 +1,27 @@
+name: Rust
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Protoc
+        uses: arduino/setup-protoc@v3
+      - name: Build
+        run: |
+          cd rust
+          cargo build --verbose
+      - name: Run tests
+        run: |
+          cd rust
+          cargo test --verbose

VERSION.in

@@ -1 +1 @@
-1.9
+1.10

proto/src/renderPartition.proto

@@ -54,8 +54,8 @@ message RenderPartitionSeq {
 
 
 // -------- Requests & Responses --------]
-message RenderPartDeleteRequest {
 
+message RenderPartDeleteRequest {
     RenderPartition render_partition = 1;
 }
 

proto/src/report.proto

@@ -39,7 +39,10 @@ message CoreDetail {
     int32 locked_cores = 3;
     int32 booked_cores = 4;
     //map <key: physid, value: coreid>
-    map<int64, CoreId> reserved_cores = 5;
+    // This field is deprecated as it should have never been part of the API. It was previously used
+    // solely on rqd's end to store a map of reserved cores, but the data was never communicated to
+    // the server.
+    map<int64, CoreId> reserved_cores = 5 [deprecated=true];
 }
 
 message CoreId {

proto/src/rqd.proto

@@ -1,4 +1,5 @@
 
+
 syntax = "proto3";
 package rqd;
 
@@ -15,7 +16,7 @@ import "report.proto";
 
 // Implemented by the Rqd server. Called by cuebot and tools.
 service RqdInterface {
-    // Return the RunFrame by id
+    // [Deprecated] Return the RunFrame by id
     rpc GetRunFrame(RqdStaticGetRunFrameRequest) returns (RqdStaticGetRunFrameResponse);
 
     // Return the RunningFrameStatus report
@@ -42,7 +43,7 @@ service RqdInterface {
     // Reboot the host when it becomes idle
     rpc RebootIdle(RqdStaticRebootIdleRequest) returns (RqdStaticRebootIdleResponse);
 
-    // Reboot the host now
+    // [Deprecated] Reboot the host now
     rpc RebootNow(RqdStaticRebootNowRequest) returns (RqdStaticRebootNowResponse);
 
     // Return the HostReport
@@ -54,7 +55,7 @@ service RqdInterface {
     // [Deprecated] Restart rqd process now
     rpc RestartRqdNow(RqdStaticRestartNowRequest) returns (RqdStaticRestartNowResponse);
 
-    // Turn off rqd when it becomes idle
+    // [Deprecated] Turn off rqd when it becomes idle
     rpc ShutdownRqdIdle(RqdStaticShutdownIdleRequest) returns (RqdStaticShutdownIdleResponse);
 
     // Stop rqd now
@@ -99,10 +100,16 @@ message RunFrame {
     string log_dir = 9;
     string show = 10;
     string shot = 11;
-    string job_temp_dir = 12;
+    // Deprecated: Not reliable and will not be taken on consideration moving forward
+    string job_temp_dir = 12 [deprecated=true];
+    // Deprecated: Not reliable and will not be taken on consideration moving forward
     string frame_temp_dir = 13;
-    string log_file = 14;
-    string log_dir_file = 15;
+    // Deprecated: The log_path is defined rqd using job_dir, job_name and frame_name.
+    // This field is misleading as it doesn't give cuebot the power to define the log path
+    string log_file = 14 [deprecated=true];
+    // Deprecated: The log_path is defined rqd using job_dir, job_name and frame_name.
+    // This field is misleading as it doesn't give cuebot the power to define the log path
+    string log_dir_file = 15 [deprecated=true];
     int64 start_time = 16;
     oneof uid_optional {
         int32 uid = 17;

rust/.gitignore

@@ -0,0 +1,9 @@
+/target
+
+# TODO: Remove once these crates are stable and ready for public use
+/crates/cuebot-config
+/crates/dist-lock
+/crates/scheduler
+
+.DS_Store
+config/rqd.local_docker.yaml