Add extension API test

Author: cd-work

cli/src/commands/extensions/api.rs

@@ -1,4 +1,5 @@
 use std::cell::RefCell;
+use std::fs;
 use std::ops::Deref;
 use std::path::Path;
 use std::pin::Pin;
@@ -17,9 +18,10 @@ use phylum_types::types::package::{
 };
 use phylum_types::types::project::ProjectDetailsResponse;
 
+use crate::api::PhylumApi;
+use crate::auth::UserInfo;
 use crate::commands::parse::{get_packages_from_lockfile, LOCKFILE_PARSERS};
 use crate::config::get_current_project;
-use crate::{api::PhylumApi, auth::UserInfo};
 
 /// Holds either an unawaited, boxed `Future`, or the result of awaiting the future.
 enum OnceFuture<T: Unpin> {
@@ -233,13 +235,14 @@ async fn get_package_details(
 /// Parse a lockfile and return the package descriptors contained therein.
 /// Equivalent to `phylum parse`.
 #[op]
-fn parse_lockfile(lockfile: &str, lockfile_type: &str) -> Result<Vec<PackageDescriptor>> {
+fn parse_lockfile(lockfile: String, lockfile_type: String) -> Result<Vec<PackageDescriptor>> {
     let parser = LOCKFILE_PARSERS
         .iter()
         .find_map(|(name, parser)| (*name == lockfile_type).then(|| *parser))
         .ok_or_else(|| anyhow!("Unrecognized lockfile type: `{lockfile_type}`"))?;
 
-    let lockfile_data = std::fs::read_to_string(Path::new(lockfile))?;
+    let lockfile_data = fs::read_to_string(&lockfile)
+        .with_context(|| format!("Could not read lockfile at '{lockfile}'"))?;
     parser.parse(&lockfile_data)
 }
 

cli/src/extension_api.ts

@@ -44,4 +44,9 @@ export class PhylumApi {
     static async getPackageDetails(name: string, version: string, packageType: string): object {
         return await Deno.core.opAsync('get_package_details', name, version, packageType);
     }
+
+    /// Get dependencies inside a lockfile.
+    static parseLockfile(lockfile: string, lockfileType: string): [object] {
+        return Deno.core.opSync('parse_lockfile', lockfile, lockfileType);
+    }
 }

cli/tests/extensions.rs

@@ -225,6 +225,27 @@ fn extension_list_should_emit_output() {
     assert!(output.lines().any(|m| re.is_match(m)));
 }
 
+// Extensions relying on the injected Phylum API work.
+#[tokio::test]
+async fn injected_api() {
+    let tempdir = TempDir::new().unwrap();
+    Command::cargo_bin("phylum")
+        .unwrap()
+        .env("XDG_DATA_HOME", tempdir.path())
+        .args(&["extension", "add"])
+        .arg(fixtures_path().join("api-extension"))
+        .assert()
+        .success();
+
+    Command::cargo_bin("phylum")
+        .unwrap()
+        .env("XDG_DATA_HOME", tempdir.path())
+        .arg("api-extension")
+        .assert()
+        .success()
+        .stdout("44\n");
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 // Miscellaneous tests
 ////////////////////////////////////////////////////////////////////////////////

cli/tests/fixtures/extensions/api-extension/PhylumExt.toml

@@ -1,3 +1,3 @@
 name = "api-extension"
-description = "This extension tests the API ops"
+description = "Test phylum API injection"
 entry_point = "main.ts"

cli/tests/fixtures/extensions/api-extension/main.ts

@@ -1,19 +1,4 @@
-import * as PhylumApi from './phylum-api.ts'
+import { PhylumApi } from "phylum";
 
-// Extension tests should be ran against an integration context, and not in CI
-// at least for the moment, as they require access to an API instance, or a
-// well-formed, external mock of it.
-
-// Deno.core.print(JSON.stringify(await PhylumApi.get_user_info()))
-// await PhylumApi.get_access_token()
-// await PhylumApi.get_refresh_token()
-// try {
-//   await PhylumApi.get_job_status()
-// } catch(e) {
-//   Deno.core.print(JSON.stringify(e))
-// }
-// try {
-//   await PhylumApi.get_project_details()
-// } catch(e) {
-//   Deno.core.print(JSON.stringify(e))
-// }
+const packages = PhylumApi.parseLockfile("./tests/fixtures/poetry.lock", "poetry");
+console.log(packages.length);