1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
//! Test utilities for Ora.
#![warn(clippy::pedantic, missing_docs)]

use std::{
    collections::HashMap,
    sync::{Arc, Mutex},
};

use async_trait::async_trait;
use ora_api::{client::TaskHandle, Handler, Task};
use ora_client::{RawTaskResult, ScheduleOperations, TaskOperations};
use ora_common::{
    task::{TaskDefinition, TaskStatus, WorkerSelector},
    UnixNanos,
};
use ora_worker::RawHandler;
use tokio_util::sync::CancellationToken;
use uuid::Uuid;

/// A worker that can be used to test worker implementations.
#[derive(Default)]
#[must_use]
pub struct TestWorker {
    workers: HashMap<WorkerSelector, Arc<dyn RawHandler + Send + Sync>>,
}

impl std::fmt::Debug for TestWorker {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("TestWorker")
            .field("workers", &self.workers.keys().collect::<Vec<_>>())
            .finish()
    }
}

impl TestWorker {
    /// Create a new test worker.
    pub fn new() -> Self {
        Self::default()
    }

    /// Add a handler to the test worker.
    ///
    /// # Panics
    ///
    /// Panics if a worker with a matching [`WorkerSelector`]
    /// already exists.
    pub fn register_worker(&mut self, worker: Arc<dyn RawHandler + Send + Sync>) -> &mut Self {
        let selector = worker.selector();

        assert!(
            !self.workers.contains_key(worker.selector()),
            "a worker is already registered with the given selector: {selector:?}"
        );

        self.workers.insert(worker.selector().clone(), worker);
        self
    }

    /// Spawn a task onto the worker, immediately run it with a
    /// registered and return a [`TaskHandle`] for it.
    ///
    /// It returns [`None`] if there are no suitable workers registered.
    ///
    /// # Panics
    ///
    /// Panics if not called inside a [`tokio`] runtime.
    pub fn spawn_task<T>(&mut self, task: TaskDefinition<T>) -> Option<TaskHandle<T>>
    where
        T: Send + 'static,
    {
        let worker = self.workers.get(&task.worker_selector)?.clone();

        let task_id = Uuid::new_v4();
        let cancellation = CancellationToken::new();
        let ctx = ora_worker::_private::new_context(task_id, cancellation.clone());

        let inner = Arc::new(Mutex::new(TestTaskInner {
            task_id,
            definition: task.clone().cast(),
            cancellation,
            added: UnixNanos::now(),
            finished: None,
            result: None,
            cancelled: None,
        }));

        let task_inner = inner.clone();
        tokio::spawn(async move {
            let data_format = task.data_format;

            let res = worker.run(ctx, task.cast()).await;
            let mut inner = task_inner.lock().unwrap();
            if inner.result.is_some() {
                return;
            }

            inner.finished = Some(UnixNanos::now());

            match res {
                Ok(output) => {
                    inner.result = Some(RawTaskResult::Success {
                        output_format: data_format,
                        output,
                    });
                }
                Err(error) => {
                    inner.result = Some(RawTaskResult::Failure {
                        reason: format!("{error:?}"),
                    });
                }
            }
        });

        Some(TaskHandle::new_raw(Arc::new(TestTaskOperations { inner })))
    }
}

/// Run a worker with a given task and return its output.
///
/// This will simply provide an empty context to the worker and
/// run the handler function.
/// For more options, see [`TestWorker`].
///
/// # Errors
///
/// Returns errors returned by the worker.
pub async fn run_worker<T, W>(worker: &W, task: T) -> eyre::Result<T::Output>
where
    T: Task,
    W: Handler<T>,
{
    worker
        .run(
            ora_worker::_private::new_context(Uuid::nil(), CancellationToken::default()),
            task,
        )
        .await
}

#[derive(Debug)]
struct TestTaskOperations {
    inner: Arc<Mutex<TestTaskInner>>,
}

#[derive(Debug)]
struct TestTaskInner {
    task_id: Uuid,
    definition: TaskDefinition,
    cancellation: CancellationToken,
    added: UnixNanos,
    finished: Option<UnixNanos>,
    result: Option<RawTaskResult>,
    cancelled: Option<UnixNanos>,
}

#[async_trait]
impl TaskOperations for TestTaskOperations {
    fn id(&self) -> Uuid {
        self.inner.lock().unwrap().task_id
    }

    async fn status(&self) -> eyre::Result<TaskStatus> {
        match &self.inner.lock().unwrap().result {
            Some(res) => match res {
                RawTaskResult::Success { .. } => Ok(TaskStatus::Succeeded),
                RawTaskResult::Failure { .. } => Ok(TaskStatus::Failed),
                RawTaskResult::Cancelled => Ok(TaskStatus::Cancelled),
            },
            None => Ok(TaskStatus::Started),
        }
    }

    async fn target(&self) -> eyre::Result<UnixNanos> {
        Ok(self.inner.lock().unwrap().definition.target)
    }

    async fn definition(&self) -> eyre::Result<TaskDefinition> {
        Ok(self.inner.lock().unwrap().definition.clone())
    }

    async fn result(&self) -> eyre::Result<Option<RawTaskResult>> {
        Ok(self.inner.lock().unwrap().result.clone())
    }

    async fn wait_result(&self) -> eyre::Result<RawTaskResult> {
        loop {
            if let Some(res) = self.result().await? {
                return Ok(res);
            }

            tokio::time::sleep(std::time::Duration::from_millis(100)).await;
        }
    }

    async fn schedule(&self) -> eyre::Result<Option<Arc<dyn ScheduleOperations>>> {
        Ok(None)
    }

    async fn added_at(&self) -> eyre::Result<UnixNanos> {
        Ok(self.inner.lock().unwrap().added)
    }

    async fn ready_at(&self) -> eyre::Result<Option<UnixNanos>> {
        Ok(Some(self.inner.lock().unwrap().added))
    }

    async fn started_at(&self) -> eyre::Result<Option<UnixNanos>> {
        Ok(Some(self.inner.lock().unwrap().added))
    }

    async fn succeeded_at(&self) -> eyre::Result<Option<UnixNanos>> {
        let inner = self.inner.lock().unwrap();

        if let Some(res) = &inner.result {
            if res.is_success() {
                return Ok(inner.finished);
            }
        }

        Ok(None)
    }

    async fn failed_at(&self) -> eyre::Result<Option<UnixNanos>> {
        let inner = self.inner.lock().unwrap();

        if let Some(res) = &inner.result {
            if res.is_failure() {
                return Ok(inner.finished);
            }
        }

        Ok(None)
    }

    async fn cancelled_at(&self) -> eyre::Result<Option<UnixNanos>> {
        Ok(self.inner.lock().unwrap().cancelled)
    }

    async fn cancel(&self) -> eyre::Result<()> {
        let mut inner = self.inner.lock().unwrap();
        if inner.result.is_none() {
            inner.cancelled = Some(UnixNanos::now());
            inner.cancellation.cancel();
            inner.result = Some(RawTaskResult::Cancelled);
        }

        Ok(())
    }

    async fn worker_id(&self) -> eyre::Result<Option<Uuid>> {
        Ok(None)
    }
}

#[cfg(test)]
mod tests {
    use async_trait::async_trait;
    use ora_api::{Handler, IntoHandler, Task};
    use ora_worker::TaskContext;
    use serde::{Deserialize, Serialize};
    use tokio::test;
    use uuid::Uuid;

    use crate::TestWorker;

    #[derive(Debug, Serialize, Deserialize)]
    struct TestTask;

    impl Task for TestTask {
        type Output = Uuid;
    }

    #[derive(Debug, Serialize, Deserialize)]
    struct CancelOnlyTask;

    impl Task for CancelOnlyTask {
        type Output = ();
    }

    struct TestHandler;

    #[async_trait]
    impl Handler<TestTask> for TestHandler {
        async fn run(
            &self,
            ctx: TaskContext,
            _task: TestTask,
        ) -> eyre::Result<<TestTask as Task>::Output> {
            Ok(ctx.task_id())
        }
    }

    #[async_trait]
    impl Handler<CancelOnlyTask> for TestHandler {
        async fn run(
            &self,
            ctx: TaskContext,
            _task: CancelOnlyTask,
        ) -> eyre::Result<<CancelOnlyTask as Task>::Output> {
            ctx.cancelled().await;
            Ok(())
        }
    }

    #[test]
    async fn test_worker_smoke() {
        let mut worker = TestWorker::new();
        assert!(worker.spawn_task(TestTask.task()).is_none());
        worker.register_worker(TestHandler.handler::<TestTask>());

        let task = worker.spawn_task(TestTask.task()).unwrap();
        let output_task_id = task.clone().await.unwrap();
        assert_eq!(output_task_id, task.id());

        worker.register_worker(TestHandler.handler::<CancelOnlyTask>());

        let task = worker.spawn_task(CancelOnlyTask.task()).unwrap();
        tokio::select! {
            _ = task.clone() => {
                unreachable!()
            }
            _ = tokio::time::sleep(std::time::Duration::from_millis(100)) => {},
        }

        task.cancel().await.unwrap();
        assert!(task.cancelled_at().await.unwrap().is_some());
        assert!(task.await.is_err());
    }

    #[test]
    #[should_panic]
    async fn test_duplicate_handlers() {
        let mut worker = TestWorker::new();
        worker.register_worker(TestHandler.handler::<TestTask>());
        worker.register_worker(TestHandler.handler::<TestTask>());
    }
}