refactor(testkit): make the provider helpers Context methods

testkit creates things through Context methods, such as cx.sandbox(..)
and cx.on_cleanup(..), so import_profile, create_provider and
install_provider become cx methods instead of free functions.

Signed-off-by: Matthew Grossman <mgrossman@nvidia.com>

Author: matthewgrossman

tests/suites/conformance/src/credential_gating.rs

@@ -285,7 +285,8 @@ credentials:
 {endpoints}binaries:
 {binaries}"
     );
-    testkit::install_provider(cx, &name, &profile, &[(TOKEN_ENV, TEST_SECRET)]).await?;
+    cx.install_provider(&name, &profile, &[(TOKEN_ENV, TEST_SECRET)])
+        .await?;
     Ok(name)
 }
 

tests/testkit/README.md

@@ -93,10 +93,10 @@ fails. A killed test process skips cleanup, so names are unique to the run.
   Pass the result to `cx.sandbox(..).policy(policy)`, or `policy::to_yaml`
   for the CLI.
   `testkit::PYTHON_BINARIES` names `python3` in `python_image()` images.
-- `testkit::import_profile(cx, profile)` to import a provider profile and
-  return its `id`, and `testkit::create_provider(cx, name, type, credentials)`
-  to create a provider, each with cleanup. `testkit::install_provider(cx, name,
-  profile, credentials)` does both.
+- `cx.import_profile(profile)` to import a provider profile and return its
+  `id`, and `cx.create_provider(name, type, credentials)` to create a
+  provider, each with cleanup. `cx.install_provider(name, profile,
+  credentials)` does both.
 - `testkit::YamlFile` for YAML a CLI command reads from a file.
 - `cx.client()` for SDK calls testkit does not wrap.
 - `error.grpc_code()` for the gRPC status code (`testkit::GrpcCode`) of a

tests/testkit/testkit/src/lib.rs

@@ -53,7 +53,6 @@ pub use image::{PYTHON_BINARIES, base_image, python_image};
 pub use openshell_sdk as sdk;
 pub use poll::{Poll, poll_until};
 pub use program::main;
-pub use provider::{create_provider, import_profile, install_provider};
 pub use ready::check as check_ready;
 pub use registry::Test;
 pub use run::{TestInfo, run};

tests/testkit/testkit/src/provider.rs

@@ -7,79 +7,82 @@ use crate::context::Context;
 use crate::error::{Error, Result, ResultExt as _};
 use crate::yaml_file::YamlFile;
 
-/// Import `profile`, a provider profile in YAML, and return its `id`, the
-/// provider type it defines. Cleanup deletes the profile after the test's
-/// sandboxes and the providers created after it.
-pub async fn import_profile(cx: &Context, profile: &str) -> Result<String> {
-    #[derive(Deserialize)]
-    struct Profile {
-        id: String,
+impl Context {
+    /// Import `profile`, a provider profile in YAML, and return its `id`, the
+    /// provider type it defines. Cleanup deletes the profile after the test's
+    /// sandboxes and the providers created after it.
+    pub async fn import_profile(&self, profile: &str) -> Result<String> {
+        #[derive(Deserialize)]
+        struct Profile {
+            id: String,
+        }
+        let id = serde_yml::from_str::<Profile>(profile)
+            .map_err(|error| Error::from_error(&error))
+            .context("read the provider profile's id")?
+            .id;
+        // Deleting a missing profile succeeds, so register the delete before
+        // the import.
+        self.on_cleanup_delete("profile", &id);
+        let file = YamlFile::new(profile)?;
+        self.cli(["profile", "import", "--file", file.path()?])
+            .await?
+            .success()
+            .context(format!("import profile {id}"))?;
+        Ok(id)
     }
-    let id = serde_yml::from_str::<Profile>(profile)
-        .map_err(|error| Error::from_error(&error))
-        .context("read the provider profile's id")?
-        .id;
-    // Deleting a missing profile succeeds, so register the delete before the
-    // import.
-    on_cleanup_delete(cx, "profile", &id);
-    let file = YamlFile::new(profile)?;
-    cx.cli(["profile", "import", "--file", file.path()?])
-        .await?
-        .success()
-        .context(format!("import profile {id}"))?;
-    Ok(id)
-}
 
-/// Create a provider called `name` of `provider_type` with `credentials`, as
-/// pairs of environment variable and value. Cleanup deletes the provider
-/// after the test's sandboxes.
-///
-/// The CLI reads the credential values from its environment, so they aren't
-/// in the reported command.
-pub async fn create_provider(
-    cx: &Context,
-    name: &str,
-    provider_type: &str,
-    credentials: &[(&str, &str)],
-) -> Result {
-    // Deleting a missing provider succeeds, so register the delete before the
-    // create.
-    on_cleanup_delete(cx, "provider", name);
-    let mut args = vec![
-        "provider",
-        "create",
-        "--name",
-        name,
-        "--type",
-        provider_type,
-    ];
-    for (key, _) in credentials {
-        args.extend(["--credential", key]);
+    /// Create a provider called `name` of `provider_type` with `credentials`,
+    /// as pairs of environment variable and value. Cleanup deletes the
+    /// provider after the test's sandboxes.
+    ///
+    /// The CLI reads the credential values from its environment, so they
+    /// aren't in the reported command.
+    pub async fn create_provider(
+        &self,
+        name: &str,
+        provider_type: &str,
+        credentials: &[(&str, &str)],
+    ) -> Result {
+        // Deleting a missing provider succeeds, so register the delete before
+        // the create.
+        self.on_cleanup_delete("provider", name);
+        let mut args = vec![
+            "provider",
+            "create",
+            "--name",
+            name,
+            "--type",
+            provider_type,
+        ];
+        for (key, _) in credentials {
+            args.extend(["--credential", key]);
+        }
+        self.cli_with_env(credentials, args)
+            .await?
+            .success()
+            .context(format!("create provider {name}"))?;
+        Ok(())
     }
-    cx.cli_with_env(credentials, args)
-        .await?
-        .success()
-        .context(format!("create provider {name}"))?;
-    Ok(())
-}
 
-/// Import `profile` with [`import_profile`] and create a provider called
-/// `name` of its type with [`create_provider`].
-pub async fn install_provider(
-    cx: &Context,
-    name: &str,
-    profile: &str,
-    credentials: &[(&str, &str)],
-) -> Result {
-    let provider_type = import_profile(cx, profile).await?;
-    create_provider(cx, name, &provider_type, credentials).await
-}
+    /// Import `profile` with [`Context::import_profile`] and create a provider
+    /// called `name` of its type with [`Context::create_provider`].
+    pub async fn install_provider(
+        &self,
+        name: &str,
+        profile: &str,
+        credentials: &[(&str, &str)],
+    ) -> Result {
+        let provider_type = self.import_profile(profile).await?;
+        self.create_provider(name, &provider_type, credentials)
+            .await
+    }
 
-fn on_cleanup_delete(cx: &Context, kind: &'static str, name: &str) {
-    let cli = cx.cli_handle();
-    let owned = name.to_string();
-    cx.on_cleanup(format!("delete {kind} {name}"), async move || {
-        cli.run([kind, "delete", &owned]).await?.success()?;
-        Ok(())
-    });
+    fn on_cleanup_delete(&self, kind: &'static str, name: &str) {
+        let cli = self.cli_handle();
+        let owned = name.to_string();
+        self.on_cleanup(format!("delete {kind} {name}"), async move || {
+            cli.run([kind, "delete", &owned]).await?.success()?;
+            Ok(())
+        });
+    }
 }