Replace Spec with RecipeSpec and PackageSpec

This is the first step towards having separate types for the different
variations of specs that are valid in specific contexts. These changes
will be done in a series of PRs to limit the diff size of each change.

In this PR the focus is on embedded packages. In a recipe, an embedded
package spec in a recipe spec is expected to be given a `VersionIdent`,
as in:

```yaml
install:
  embedded:
    - pkg: example/1.0.0
```

It is now illegal to specify a build id for an embedded package in a
recipe.

When the package is built, the embedded package in a package spec is a
`BuildIdent` to reflect the idea that the embedded package is "built",
such as:

```yaml
install:
  embedded:
    - pkg: example/1.0.0/embedded
```

Test content has been updated appropriately since this was not enforced
previously.

What is allowed in the `build:` and `install:` sections of an embedded
package is different from a regular package, so `EmbeddedRecipeSpec`
and `EmbeddedPackageSpec` model those differences. These contain
`EmbeddedBuildSpec` and `EmbeddedInstallSpec`.

An `EmbeddedInstallSpec` does not contain an `embedded` field, making it
impossible to nest embedded packages.

`EmbeddedPackagesList` gained a generic parameter for the type of spec
it contains so it can be reused for the two flavors of embedded specs.

`Package::components()` was moved to its own trait to make is possible
to not have `Package` implemented for embedded packages. Note that when
embedded packages are turned into stubs, the stubs are normal packages
that implement `Package`.

All the new types were created in the `v0` module since they are part of
the `v0/package` API. The types like `BuildSpec` and `InstallSpec`
should arguably have been defined in `v0` as well.

These new types were created by copying and modifying the existing types
(and tests) and I haven't (at this point) done the work to remove
duplicate or unused code.

Signed-off-by: J Robert Ray <jrray@jrray.org>

Author: jrray

Cargo.lock

@@ -29,6 +29,7 @@ use spk_schema::{
     BuildIdent,
     ComponentFileMatchMode,
     ComponentSpecList,
+    Components,
     InputVariant,
     Package,
     PackageMut,

crates/spk-build/src/build/binary.rs

@@ -12,7 +12,16 @@ use spk_schema::foundation::fixtures::*;
 use spk_schema::foundation::ident_component::Component;
 use spk_schema::foundation::{opt_name, option_map};
 use spk_schema::ident::{PkgRequest, RangeIdent, Request};
-use spk_schema::{ComponentSpecList, FromYaml, OptionMap, Package, Recipe, SpecRecipe, recipe};
+use spk_schema::{
+    ComponentSpecList,
+    Components,
+    FromYaml,
+    OptionMap,
+    Package,
+    Recipe,
+    SpecRecipe,
+    recipe,
+};
 use spk_solve::{Solution, SolverImpl};
 use spk_storage::fixtures::*;
 use spk_storage::{self as storage, Repository};

crates/spk-build/src/build/binary_test.rs

@@ -119,7 +119,7 @@ async fn test_sources_subdir(tmpdir: tempfile::TempDir) {
     let file_source = LocalSource::new(source_file).set_subdir("local");
 
     let dest_dir = rt.tmpdir.path().join("dest");
-    let mut spec = v0::Spec::new("test-pkg/1.0.0/src".parse().unwrap());
+    let mut spec = v0::PackageSpec::new("test-pkg/1.0.0/src".parse().unwrap());
     spec.sources = vec![
         SourceSpec::Git(git_source),
         SourceSpec::Tar(tar_source),
@@ -145,7 +145,7 @@ async fn test_sources_subdir(tmpdir: tempfile::TempDir) {
 #[tokio::test]
 async fn test_sources_environment(_tmpdir: tempfile::TempDir) {
     let rt = spfs_runtime().await;
-    let mut spec = v0::Spec::new(build_ident!("sources-test/0.1.0/src"));
+    let mut spec = v0::PackageSpec::new(build_ident!("sources-test/0.1.0/src"));
     let expected = [
         "SPK_PKG=sources-test/0.1.0/src",
         "SPK_PKG_NAME=sources-test",

crates/spk-build/src/build/sources_test.rs

@@ -12,7 +12,7 @@ use crate::validation::Validator;
 
 #[tokio::test]
 async fn test_validate_build_changeset_modified() {
-    let package = v0::Spec::new("test-pkg/1.0.0/3I42H3S6".parse().unwrap());
+    let package = v0::PackageSpec::new("test-pkg/1.0.0/3I42H3S6".parse().unwrap());
     let report = BuildReport {
         output: BuildOutputReport {
             collected_changes: vec![spfs::tracking::Diff {

crates/spk-build/src/validation/alter_existing_files_test.rs

@@ -12,7 +12,7 @@ use crate::validation::Validator;
 
 #[tokio::test]
 async fn test_validate_build_changeset_collected() {
-    let mut package = v0::Spec::new("test-pkg/1.0.0/3I42H3S6".parse().unwrap());
+    let mut package = v0::PackageSpec::new("test-pkg/1.0.0/3I42H3S6".parse().unwrap());
     // the default components are added and collect all files,
     // so we remove them to ensure nothing is collected
     let _ = package.install.components.drain(..);

crates/spk-build/src/validation/collect_all_files_test.rs

@@ -12,8 +12,8 @@ use crate::validation::Validator;
 
 #[tokio::test]
 async fn test_validate_build_changeset_collect_existing() {
-    let dependency_package = v0::Spec::new("dep-pkg/1.0.0/3I42H3S6".parse().unwrap());
-    let package = v0::Spec::new("test-pkg/1.0.0/3I42H3S6".parse().unwrap());
+    let dependency_package = v0::PackageSpec::new("dep-pkg/1.0.0/3I42H3S6".parse().unwrap());
+    let package = v0::PackageSpec::new("test-pkg/1.0.0/3I42H3S6".parse().unwrap());
 
     let mut environment_filesystem = Manifest::new(
         spfs::tracking::Entry::empty_dir_with_open_perms_with_data(package.ident().clone()),

crates/spk-build/src/validation/collect_existing_files_test.rs

@@ -12,7 +12,7 @@ use crate::validation::Validator;
 
 #[tokio::test]
 async fn test_validate_build_changeset_nothing() {
-    let package = v0::Spec::new("test-pkg/1.0.0/3I42H3S6".parse().unwrap());
+    let package = v0::PackageSpec::new("test-pkg/1.0.0/3I42H3S6".parse().unwrap());
     let report = BuildReport {
         setup: BuildSetupReport {
             environment: Solution::default(),

crates/spk-build/src/validation/empty_package_test.rs

@@ -13,10 +13,10 @@ use spfs::graph::object::EncodingFormat;
 use spfs::prelude::*;
 use spfs::sync::reporter::SyncReporters;
 use spfs::tracking::{Entry, EntryKind};
-use spk_schema::Spec;
 use spk_schema::foundation::format::{FormatIdent, FormatOptionMap};
 use spk_schema::foundation::ident_component::Component;
 use spk_schema::prelude::*;
+use spk_schema::{Components, Spec};
 use spk_solve::solution::{PackageSource, SPK_SOLVE_EXTRA_DATA_KEY, Solution};
 use spk_solve::{BuildIdent, RepositoryHandle};
 use spk_storage as storage;

crates/spk-exec/src/exec.rs

@@ -134,7 +134,7 @@ impl IsDefault for AutoHostVars {
 }
 
 /// A set of structured inputs used to build a package.
-#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
+#[derive(Clone, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize)]
 pub struct BuildSpec {
     pub script: Script,
     #[serde(default, skip_serializing_if = "Vec::is_empty")]
@@ -152,19 +152,6 @@ pub struct BuildSpec {
     pub auto_host_vars: AutoHostVars,
 }
 
-impl Default for BuildSpec {
-    fn default() -> Self {
-        Self {
-            script: Script(vec!["sh ./build.sh".into()]),
-            options: Vec::new(),
-            raw_variants: Vec::new(),
-            variants: Vec::new(),
-            validation: ValidationSpec::default(),
-            auto_host_vars: AutoHostVars::default(),
-        }
-    }
-}
-
 impl BuildSpec {
     /// Returns this build's options, plus any additional ones needed
     /// for building the given variant
@@ -342,6 +329,20 @@ impl IsDefault for BuildSpec {
     }
 }
 
+impl From<v0::EmbeddedBuildSpec> for BuildSpec {
+    fn from(value: v0::EmbeddedBuildSpec) -> Self {
+        BuildSpec {
+            options: value.options,
+            // Other fields are not part of the embedded build spec
+            auto_host_vars: Default::default(),
+            raw_variants: Default::default(),
+            script: Script::default(),
+            validation: Default::default(),
+            variants: Default::default(),
+        }
+    }
+}
+
 impl TryFrom<UncheckedBuildSpec> for BuildSpec {
     type Error = crate::Error;
 
@@ -527,6 +528,12 @@ impl Script {
     }
 }
 
+impl Default for Script {
+    fn default() -> Self {
+        Self(vec!["sh ./build.sh".into()])
+    }
+}
+
 impl From<Vec<String>> for Script {
     fn from(v: Vec<String>) -> Self {
         Self(v)