revise: add the ord feature

stjude-rust-labs · Sep 23, 2024 · 9813cbc · 9813cbc
1 parent c822006
commit 9813cbc
Show file tree

Hide file tree

Showing 9 changed files with 37 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Changes the `v1::types::responses::service` module to
   `v1::types::responses::service_info`.
 - Makes `v1::types::task::State` `Copy`.
+- Adds the `ord` feature for all types.
 
 ## 0.2.0 - 08-08-2024
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -29,6 +29,7 @@ tracing-subscriber = { version = "0.3.18", features = ["env-filter"] }
 [features]
 default = ["types"]
 client = ["dep:anyhow", "types", "dep:serde_json", "dep:url"]
+ord = []
 serde = ["dep:serde", "dep:serde_json"]
 types = ["dep:url"]
 

diff --git a/src/v1/client/tasks.rs b/src/v1/client/tasks.rs
@@ -6,6 +6,7 @@
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "serde", serde(rename_all = "UPPERCASE"))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub enum View {
     /// Only includes the `id` and `state` fields in the returned task.
     #[default]

diff --git a/src/v1/types/responses.rs b/src/v1/types/responses.rs
@@ -8,6 +8,7 @@ pub use service_info::ServiceInfo;
 /// A response from `POST /tasks`.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct CreateTask {
     /// The ID of the created task.
     pub id: String,
@@ -16,6 +17,7 @@ pub struct CreateTask {
 /// The response from `GET /tasks`.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct ListTasks<Task> {
     /// The tasks in this page of results.
     pub tasks: Vec<Task>,

diff --git a/src/v1/types/responses/service_info.rs b/src/v1/types/responses/service_info.rs
@@ -17,6 +17,7 @@ pub const TES_VERSION: &str = "1.1.0";
 /// only be `"tes"` but it's still technically listed as an enum.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub enum Artifact {
     /// A task execution service.
     #[cfg_attr(feature = "serde", serde(rename = "tes"))]
@@ -27,6 +28,7 @@ pub enum Artifact {
 /// An organization provided a TES service.
 #[derive(Clone, Debug, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct Organization {
     /// The organization name.
     pub name: String,
@@ -38,6 +40,7 @@ pub struct Organization {
 /// A type of service.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct ServiceType {
     /// Namespace in reverse domain name format.
     pub group: String,
@@ -53,6 +56,7 @@ pub struct ServiceType {
 #[derive(Clone, Debug, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "serde", serde(rename_all = "camelCase"))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct ServiceInfo {
     /// A unique identifier for the service.
     id: String,
@@ -157,8 +161,10 @@ impl ServiceInfo {
 
 #[cfg(test)]
 mod tests {
+    #[cfg(feature = "serde")]
     use pretty_assertions::assert_eq;
 
+    #[cfg(feature = "serde")]
     use super::*;
 
     #[cfg(feature = "serde")]

diff --git a/src/v1/types/responses/task.rs b/src/v1/types/responses/task.rs
@@ -6,6 +6,7 @@ use crate::v1::types::task::State;
 /// A response for when `?view=MINIMAL` in a task endpoint.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct MinimalTask {
     /// The ID.
     pub id: String,
@@ -18,6 +19,7 @@ pub struct MinimalTask {
 #[derive(Clone, Debug, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "serde", serde(untagged))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub enum Response {
     /// A response for when `?view=MINIMAL` in a task endpoint.
     Minimal(MinimalTask),

diff --git a/src/v1/types/task.rs b/src/v1/types/task.rs
@@ -1,5 +1,8 @@
 //! Tasks submitted to a service.
 
+#[cfg(feature = "ord")]
+use std::collections::BTreeMap;
+#[cfg(not(feature = "ord"))]
 use std::collections::HashMap;
 
 use chrono::DateTime;
@@ -15,6 +18,7 @@ pub use executor::Executor;
 #[derive(Copy, Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
 #[cfg_attr(feature = "serde", serde(rename_all = "UPPERCASE"))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub enum State {
     /// An unknown state.
     #[default]
@@ -60,6 +64,7 @@ impl State {
 /// An input for a TES task.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct Input {
     /// An optional name.
     pub name: Option<String>,
@@ -84,6 +89,7 @@ pub struct Input {
 /// An output for a TES task.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct Output {
     /// An optional name.
     pub name: Option<String>,
@@ -105,6 +111,7 @@ pub struct Output {
 /// Requested resources for a TES task.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct Resources {
     /// The number of CPU cores.
     pub cpu_cores: Option<i64>,
@@ -125,6 +132,7 @@ pub struct Resources {
 /// An output file log.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct OutputFileLog {
     /// The URL.
     pub url: String,
@@ -139,6 +147,7 @@ pub struct OutputFileLog {
 /// A task log.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct TaskLog {
     /// The executor logs.
     pub logs: Vec<executor::Log>,
@@ -159,6 +168,7 @@ pub struct TaskLog {
 /// A task.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct Task {
     /// The ID.
     pub id: Option<String>,
@@ -188,7 +198,11 @@ pub struct Task {
     pub volumes: Option<Vec<String>>,
 
     /// The tags.
+    #[cfg(not(feature = "ord"))]
     pub tags: Option<HashMap<String, String>>,
+    /// The tags.
+    #[cfg(feature = "ord")]
+    pub tags: Option<BTreeMap<String, String>>,
 
     /// The logs.
     pub logs: Option<Vec<TaskLog>>,

diff --git a/src/v1/types/task/executor.rs b/src/v1/types/task/executor.rs
@@ -1,5 +1,8 @@
 //! Executor declared within tasks.
 
+#[cfg(feature = "ord")]
+use std::collections::BTreeMap;
+#[cfg(not(feature = "ord"))]
 use std::collections::HashMap;
 
 use chrono::DateTime;
@@ -12,6 +15,7 @@ use chrono::Utc;
 /// the task.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct Executor {
     /// The image.
     pub image: String,
@@ -32,12 +36,17 @@ pub struct Executor {
     pub stderr: Option<String>,
 
     /// The environment variables.
+    #[cfg(not(feature = "ord"))]
     pub env: Option<HashMap<String, String>>,
+    /// The environment variables.
+    #[cfg(feature = "ord")]
+    pub env: Option<BTreeMap<String, String>>,
 }
 
 /// A log for an [`Executor`].
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub struct Log {
     /// The start time.
     pub start_time: Option<DateTime<Utc>>,

diff --git a/src/v1/types/task/file.rs b/src/v1/types/task/file.rs
@@ -3,6 +3,7 @@
 /// A type of file.
 #[derive(Clone, Debug, Default, Eq, PartialEq)]
 #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[cfg_attr(feature = "ord", derive(Ord, PartialOrd))]
 pub enum Type {
     /// A file.
     #[cfg_attr(feature = "serde", serde(rename = "FILE"))]