Refactor out the OBS interaction code into a new obs-commander crate

refi64 · refi64 · commit 398d53270f80 · 2025-08-14T15:36:48.000-05:00
This is largely just a rename, as well as the slightly-silly
`obs-commander-test-support` crate that exists to avoid making the
primary `obs-commander` crate depend on testing dependencies.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,50 +1,29 @@
-[package]
-name = "obs-gitlab-runner"
-version = "0.1.8"
-edition = "2024"
-license = "MIT OR Apache-2.0"
+[workspace]
+resolver = "3"
+members = [
+  "obs-commander",
+  "obs-commander-test-support",
+  "obs-gitlab-runner"
+]
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
-[dependencies]
+[workspace.dependencies]
 async-trait = "0.1"
-base16ct = { version = "0.2", features = ["std"] }
-bytes = "1.10"
 camino = "1.1"
+claims = "0.8"
 clap = { version = "4.5", features = ["default", "derive", "env"] }
 color-eyre = "0.6"
 derivative = "2.2"
 futures-util = "0.3"
-md-5 = "0.10"
-reqwest = "0.12"
-rfc822-like = "0.2"
+open-build-service-api = { git = "https://github.com/collabora/open-build-service-rs" }
+# open-build-service-api = { path = "../open-build-service-rs/open-build-service-api" }
+open-build-service-mock = { git = "https://github.com/collabora/open-build-service-rs" }
+# open-build-service-mock = { path = "../open-build-service-rs/open-build-service-api" }
+rstest = "0.26"
 serde = "1.0"
 serde_yaml = "0.9"
-shellexpand = "3.1"
-shell-words = "1.1"
-strum = { version = "0.27", features = ["derive"] }
 tempfile = "3.20"
+thiserror = "2.0"
 tokio = { version = "1.45", features = ["full"] }
-tokio-retry2 = { version = "0.5.7", features = ["jitter"] }
 tokio-util = { version = "0.7", features = ["full"] }
 tracing = "0.1"
-tracing-error = "0.2"
-tracing-subscriber = { version = "0.3", features = ["default", "json"] }
-url = "2.5"
-
-gitlab-runner = "0.3.0-rc1"
-# gitlab-runner = { path = "../gitlab-runner-rs/gitlab-runner" }
-open-build-service-api = { git = "https://github.com/collabora/open-build-service-rs" }
-thiserror = "2.0.12"
-# open-build-service-api = { path = "../open-build-service-rs/open-build-service-api" }
-
-[dev-dependencies]
-claims = "0.8"
-rstest = "0.26"
 wiremock = "0.6"
-zip = "4.1"
-
-gitlab-runner-mock = "0.2.1"
-# gitlab-runner-mock = { path = "../gitlab-runner-rs/gitlab-runner-mock" }
-open-build-service-mock = { git = "https://github.com/collabora/open-build-service-rs" }
-# open-build-service-mock = { path = "../open-build-service-rs/open-build-service-mock" }
diff --git a/obs-commander-test-support/Cargo.toml b/obs-commander-test-support/Cargo.toml
@@ -0,0 +1,9 @@
+[package]
+name = "obs-commander-test-support"
+version = "0.1.0"
+edition = "2024"
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+open-build-service-api.workspace = true
+open-build-service-mock.workspace = true
diff --git a/obs-commander-test-support/src/lib.rs b/obs-commander-test-support/src/lib.rs
diff --git a/obs-commander/Cargo.toml b/obs-commander/Cargo.toml
@@ -0,0 +1,35 @@
+[package]
+name = "obs-commander"
+version = "0.1.0"
+edition = "2024"
+license = "MIT OR Apache-2.0"
+
+[dependencies]
+async-trait.workspace = true
+base16ct = { version = "0.2", features = ["std"] }
+bytes = "1.10"
+camino.workspace = true
+clap.workspace = true
+color-eyre.workspace = true
+derivative.workspace = true
+futures-util.workspace = true
+md-5 = "0.10"
+obs-commander-test-support = { path = "../obs-commander-test-support" }
+open-build-service-api.workspace = true
+reqwest = "0.12"
+rfc822-like = "0.2"
+serde.workspace = true
+serde_yaml.workspace = true
+tempfile.workspace = true
+thiserror.workspace = true
+tokio.workspace = true
+tokio-retry2 = { version = "0.5.7", features = ["jitter"] }
+tokio-util.workspace = true
+tracing.workspace = true
+
+[dev-dependencies]
+claims.workspace = true
+rstest.workspace = true
+open-build-service-mock.workspace = true
+wiremock.workspace = true
+
diff --git a/obs-commander/src/actions.rs b/obs-commander/src/actions.rs
diff --git a/obs-commander/src/artifacts.rs b/obs-commander/src/artifacts.rs
@@ -97,7 +97,6 @@ pub trait ArtifactDirectory: Send + Sync {
     }
 }
 
-#[cfg(test)]
 pub mod test_support {
     use std::collections::HashMap;
 
diff --git a/obs-commander/src/binaries.rs b/obs-commander/src/binaries.rs
@@ -77,9 +77,10 @@ mod tests {
     use std::time::SystemTime;
 
     use claims::*;
+    use obs_commander_test_support::*;
     use open_build_service_mock::*;
 
-    use crate::{artifacts::test_support::MockArtifactDirectory, test_support::*};
+    use crate::artifacts::test_support::MockArtifactDirectory;
 
     use super::*;
 
diff --git a/obs-commander/src/build_meta.rs b/obs-commander/src/build_meta.rs
@@ -265,11 +265,10 @@ mod tests {
     use std::time::{Duration, SystemTime};
 
     use claims::*;
+    use obs_commander_test_support::*;
     use open_build_service_mock::*;
     use rstest::rstest;
 
-    use crate::test_support::*;
-
     use super::*;
 
     #[tokio::test]
diff --git a/obs-commander/src/dsc.rs b/obs-commander/src/dsc.rs
diff --git a/obs-commander/src/lib.rs b/obs-commander/src/lib.rs
@@ -0,0 +1,9 @@
+pub mod actions;
+pub mod artifacts;
+pub mod binaries;
+pub mod build_meta;
+pub mod dsc;
+pub mod monitor;
+pub mod prune;
+pub mod retry;
+pub mod upload;
diff --git a/obs-commander/src/monitor.rs b/obs-commander/src/monitor.rs
@@ -296,9 +296,10 @@ mod tests {
 
     use claims::*;
     use obs::PackageCode;
+    use obs_commander_test_support::*;
     use open_build_service_mock::*;
 
-    use crate::{artifacts::test_support::MockArtifactDirectory, test_support::*};
+    use crate::artifacts::test_support::MockArtifactDirectory;
 
     use super::*;
 
diff --git a/obs-commander/src/prune.rs b/obs-commander/src/prune.rs
@@ -77,10 +77,9 @@ mod tests {
     use std::time::SystemTime;
 
     use claims::*;
+    use obs_commander_test_support::*;
     use open_build_service_mock::*;
 
-    use crate::test_support::*;
-
     use super::*;
 
     #[tokio::test]
diff --git a/obs-commander/src/retry.rs b/obs-commander/src/retry.rs
@@ -79,15 +79,14 @@ macro_rules! retry_request {
 mod tests {
     use claims::*;
     use futures_util::Future;
+    use obs_commander_test_support::*;
     use open_build_service_api as obs;
     use rstest::*;
     use wiremock::{
         Mock, MockServer, ResponseTemplate,
         matchers::{method, path_regex},
     };
 
-    use crate::test_support::*;
-
     use super::*;
 
     #[fixture]
diff --git a/obs-commander/src/upload.rs b/obs-commander/src/upload.rs
@@ -376,9 +376,10 @@ mod tests {
     use std::time::SystemTime;
 
     use claims::*;
+    use obs_commander_test_support::*;
     use open_build_service_mock::*;
 
-    use crate::{artifacts::test_support::MockArtifactDirectory, test_support::*};
+    use crate::artifacts::test_support::MockArtifactDirectory;
 
     use super::*;
 
diff --git a/obs-gitlab-runner/Cargo.toml b/obs-gitlab-runner/Cargo.toml
@@ -0,0 +1,42 @@
+[package]
+name = "obs-gitlab-runner"
+version = "0.1.8"
+edition = "2024"
+license = "MIT OR Apache-2.0"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+async-trait.workspace = true
+camino.workspace = true
+clap.workspace = true
+color-eyre.workspace = true
+derivative.workspace = true
+futures-util.workspace = true
+gitlab-runner = "0.3.0-rc1"
+# gitlab-runner = { path = "../gitlab-runner-rs/gitlab-runner" }
+obs-commander = { path = "../obs-commander" }
+obs-commander-test-support = { path = "../obs-commander-test-support" }
+open-build-service-api.workspace = true
+serde.workspace = true
+serde_yaml.workspace = true
+shellexpand = "3.1"
+shell-words = "1.1"
+strum = { version = "0.27", features = ["derive"] }
+tempfile.workspace = true
+thiserror.workspace = true
+tokio.workspace = true
+tokio-util.workspace = true
+tracing.workspace = true
+tracing-error = "0.2"
+tracing-subscriber = { version = "0.3", features = ["default", "json"] }
+url = "2.5"
+
+[dev-dependencies]
+claims.workspace = true
+gitlab-runner-mock = "0.2.1"
+# gitlab-runner-mock = { path = "../gitlab-runner-rs/gitlab-runner-mock" }
+open-build-service-mock.workspace = true
+rstest.workspace = true
+wiremock.workspace = true
+zip = "4.1"
diff --git a/obs-gitlab-runner/src/handler.rs b/obs-gitlab-runner/src/handler.rs
@@ -15,6 +15,15 @@ use gitlab_runner::{
     JobHandler, JobResult, Phase, UploadableFile,
     job::{Dependency, Job, Variable},
 };
+use obs_commander::{
+    actions::{
+        Actions, DEFAULT_BUILD_INFO, DEFAULT_BUILD_LOG, DownloadBinariesAction, DputAction,
+        FailedBuild, FlagSupportingExplicitValue, LOG_TAIL_2MB, MonitorAction, ObsBuildInfo,
+        PruneAction,
+    },
+    artifacts::{ArtifactDirectory, AsyncFileReopen, MissingArtifact, async_tempfile},
+    monitor::PackageMonitoringOptions,
+};
 use open_build_service_api as obs;
 use tokio::{fs::File as AsyncFile, io::AsyncWriteExt};
 use tokio_util::{
@@ -23,15 +32,8 @@ use tokio_util::{
 };
 use tracing::{error, info, instrument, warn};
 
-use crate::{
-    actions::{
-        Actions, DEFAULT_BUILD_INFO, DEFAULT_BUILD_LOG, DownloadBinariesAction, DputAction,
-        FailedBuild, FlagSupportingExplicitValue, LOG_TAIL_2MB, MonitorAction, ObsBuildInfo,
-        PruneAction,
-    },
-    artifacts::{ArtifactDirectory, AsyncFileReopen, MissingArtifact, async_tempfile},
-    monitor::PackageMonitoringOptions,
-    pipeline::{GeneratePipelineOptions, PipelineDownloadBinaries, generate_monitor_pipeline},
+use crate::pipeline::{
+    GeneratePipelineOptions, PipelineDownloadBinaries, generate_monitor_pipeline,
 };
 
 const DEFAULT_MONITOR_PIPELINE: &str = "obs.yml";
@@ -446,16 +448,16 @@ mod tests {
     use claims::*;
     use gitlab_runner::{GitlabLayer, Runner, RunnerBuilder};
     use gitlab_runner_mock::*;
+    use obs_commander::{build_meta::RepoArch, upload::compute_md5};
+    use obs_commander_test_support::*;
     use open_build_service_mock::*;
     use rstest::rstest;
     use tempfile::TempDir;
     use tracing::{Level, instrument::WithSubscriber};
     use tracing_subscriber::{Layer, Registry, filter::Targets, prelude::*};
     use zip::ZipArchive;
 
-    use crate::{
-        build_meta::RepoArch, logging::GitLabForwarder, test_support::*, upload::compute_md5,
-    };
+    use crate::logging::GitLabForwarder;
 
     use super::*;
 
@@ -1570,7 +1572,7 @@ mod tests {
         )]
         test: Option<GenerateMonitorTimeoutLocation>,
     ) {
-        use crate::build_meta::CommitBuildInfo;
+        use obs_commander::build_meta::CommitBuildInfo;
 
         const TEST_MONITOR_TIMEOUT: &str = "10 minutes";
 
diff --git a/obs-gitlab-runner/src/logging.rs b/obs-gitlab-runner/src/logging.rs
@@ -43,6 +43,7 @@ impl<S: Subscriber + Send + Sync + 'static + for<'span> LookupSpan<'span>, F: Fi
 {
     pub fn new(inner: Filtered<GitlabLayer, F, S>) -> Filtered<Self, Targets, S> {
         GitLabForwarder(inner).with_filter(Targets::new().with_targets([
+            ("obs_commander", Level::INFO),
             ("obs_gitlab_runner", Level::INFO),
             // This target is used to inject the current job ID, which
             // gitlab-runner needs to actually send the logs out.
diff --git a/obs-gitlab-runner/src/main.rs b/obs-gitlab-runner/src/main.rs
diff --git a/obs-gitlab-runner/src/pipeline.rs b/obs-gitlab-runner/src/pipeline.rs

Original file line number	Diff line number	Diff line change
`@@ -97,7 +97,6 @@ pub trait ArtifactDirectory: Send + Sync {`
`97`	`97`	`}`
`98`	`98`	`}`
`99`	`99`
`100`		`-#[cfg(test)]`
`101`	`100`	`pub mod test_support {`
`102`	`101`	`use std::collections::HashMap;`
`103`	`102`