Add support for token prefix masking in the mock

Allow token prefixes to be registered on the mock job. If they
are present, add them to the Gitlab features provided by the mock
with that job, as Gitlab itself does.

Author: eds-collabora

gitlab-runner-mock/src/api/request.rs

@@ -107,6 +107,46 @@ impl Respond for JobRequestResponder {
                     value
                 })
                 .collect();
+
+            let failure_reasons = json!([
+                "unknown_failure",
+                "script_failure",
+                "api_failure",
+                "stuck_or_timeout_failure",
+                "runner_system_failure",
+                "missing_dependency_failure",
+                "runner_unsupported",
+                "stale_schedule",
+                "job_execution_timeout",
+                "archived_failure",
+                "unmet_prerequisites",
+                "scheduler_failure",
+                "data_integrity_failure",
+                "forward_deployment_failure",
+                "user_blocked",
+                "project_deleted",
+                "insufficient_bridge_permissions",
+                "downstream_bridge_project_not_found",
+                "invalid_bridge_trigger",
+                "bridge_pipeline_is_child_pipeline",
+                "downstream_pipeline_creation_failed",
+                "secrets_provider_not_found",
+                "reached_max_descendant_pipelines_depth"
+            ]);
+
+            let features = if !job.token_prefixes().is_empty() {
+                json!({
+                    "trace_sections": true,
+                    "token_mask_prefixes": job.token_prefixes(),
+                    "failure_reasons": failure_reasons
+                })
+            } else {
+                json!({
+                    "trace_sections": true,
+                    "failure_reasons": failure_reasons
+                })
+            };
+
             ResponseTemplate::new(201).set_body_json(json!({
                 "id": job.id(),
                 "token": job.token(),
@@ -155,34 +195,7 @@ impl Respond for JobRequestResponder {
                     }
                 ],
                 "dependencies": dependencies,
-                "features": {
-                    "trace_sections": true,
-                    "failure_reasons": [
-                        "unknown_failure",
-                        "script_failure",
-                        "api_failure",
-                        "stuck_or_timeout_failure",
-                        "runner_system_failure",
-                        "missing_dependency_failure",
-                        "runner_unsupported",
-                        "stale_schedule",
-                        "job_execution_timeout",
-                        "archived_failure",
-                        "unmet_prerequisites",
-                        "scheduler_failure",
-                        "data_integrity_failure",
-                        "forward_deployment_failure",
-                        "user_blocked",
-                        "project_deleted",
-                        "insufficient_bridge_permissions",
-                        "downstream_bridge_project_not_found",
-                        "invalid_bridge_trigger",
-                        "bridge_pipeline_is_child_pipeline",
-                        "downstream_pipeline_creation_failed",
-                        "secrets_provider_not_found",
-                        "reached_max_descendant_pipelines_depth"
-                    ]
-                }
+                "features": features
             }))
         } else {
             ResponseTemplate::new(StatusCode::NoContent)

gitlab-runner-mock/src/job.rs

@@ -117,6 +117,7 @@ pub struct MockJob {
     steps: Vec<MockJobStep>,
     dependencies: Vec<MockJob>,
     artifacts: Vec<MockJobArtifact>,
+    token_prefixes: Vec<String>,
     inner: Arc<Mutex<MockJobInner>>,
 }
 
@@ -143,6 +144,7 @@ impl MockJob {
             steps: Vec::new(),
             dependencies: Vec::new(),
             artifacts: Vec::new(),
+            token_prefixes: Vec::new(),
             inner: Arc::new(Mutex::new(MockJobInner {
                 state: MockJobState::Success,
                 state_updates: 2,
@@ -177,6 +179,10 @@ impl MockJob {
         &self.variables
     }
 
+    pub fn token_prefixes(&self) -> &[String] {
+        &self.token_prefixes
+    }
+
     pub fn steps(&self) -> &[MockJobStep] {
         &self.steps
     }
@@ -265,6 +271,7 @@ pub struct MockJobBuilder {
     variables: HashMap<String, MockJobVariable>,
     steps: Vec<MockJobStep>,
     dependencies: Vec<MockJob>,
+    token_prefixes: Vec<String>,
     artifacts: Vec<MockJobArtifact>,
 }
 
@@ -293,6 +300,10 @@ impl MockJobBuilder {
         );
     }
 
+    pub fn add_token_prefix(&mut self, prefix: String) {
+        self.token_prefixes.push(prefix);
+    }
+
     pub fn add_step(
         &mut self,
         name: MockJobStepName,
@@ -373,6 +384,7 @@ impl MockJobBuilder {
             variables: self.variables.into_values().collect(),
             dependencies: self.dependencies,
             artifacts: self.artifacts,
+            token_prefixes: self.token_prefixes,
             inner,
         }
     }