Split common library parts into a separate workspace (#39)

Create a new workspace `libazureinit`, split common library parts into the separate lib. Add package metadata fields in `Cargo.toml` for publishing to [crates.io](https://crates.io). ## Testing done local tests pass
Azure · Feb 28, 2024 · 1f877ff · 1f877ff
1 parent 02ade86
commit 1f877ff
Show file tree

Hide file tree

Showing 12 changed files with 50 additions and 27 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -2,34 +2,31 @@
 name = "azure-init"
 version = "0.1.1"
 edition = "2021"
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+repository = "https://github.com/Azure/azure-init/"
+homepage = "https://github.com/Azure/azure-init/"
+license = "MIT"
+readme = "README.md"
+description = "A reference implementation for provisioning Linux VMs on Azure."
 
 [dependencies]
-reqwest = { version = "0.11.18", default-features = false, features = ["blocking", "json"] }
-serde = {version = "1.0.163", features = ["derive"]}
-serde_xml = "0.9.1"
-serde_derive = "1.0"
 tokio = { version = "1", features = ["full"] }
-serde-xml-rs = "0.6.0"
-xml-rs = "0.8.13"
-serde_json = "1.0.96"
-rustfmt = "0.10.0"
-nix = "0.26.2"
-libc = "0.2.146"
-fmt = "0.1.0"
+
+[dependencies.libazureinit]
+path = "libazureinit"
+version = "0.1.0"
 
 [profile.dev]
 incremental = true
 
-[lib]
-name = "lib"
-path = "src/lib.rs"
-
 [[bin]]
 name = "azure-init"
 path = "src/main.rs"
 
 [[bin]]
 name = "functional_tests"
 path = "tests/functional_tests.rs"
+
+[workspace]
+members = [
+    "libazureinit",
+]
diff --git a/README.md b/README.md
@@ -2,13 +2,13 @@
 
 [![Github CI](https://github.com/Azure/azure-init/actions/workflows/ci.yaml/badge.svg)](https://github.com/Azure/azure-init/actions)
 
-A minimal guest agent implementation for provisioning Linux VMs on Azure.
+A reference implementation for provisioning Linux VMs on Azure.
 
-The agent configures Linux guests from provisioning metadata.
-Contrary to complex guest configuration and customisation systems like e.g. cloud-init, Azure-Init aims to be minimal.
+Azure-init configures Linux guests from provisioning metadata.
+Contrary to complex guest configuration and customisation systems like e.g. cloud-init, azure-init aims to be minimal.
 It strictly focuses on basic instance initialisation from Azure metadata.
 
-Azure-Init has very few requirements on its environment, so it may run in a very early stage of the boot process.
+Azure-init has very few requirements on its environment, so it may run in a very early stage of the boot process.
 
 ## Installing Rust
 

diff --git a/SUPPORT.md b/SUPPORT.md
@@ -15,4 +15,4 @@ Feel free to [start a new discussion](https://github.com/Azure/azure-init/discus
 
 ## Microsoft Support Policy
 
-Support for the Azure-Init is limited to the resources listed above.
+Support for the azure-init is limited to the resources listed above.
diff --git a/libazureinit/Cargo.toml b/libazureinit/Cargo.toml
@@ -0,0 +1,26 @@
+[package]
+name = "libazureinit"
+version = "0.1.1"
+edition = "2021"
+repository = "https://github.com/Azure/azure-init/"
+homepage = "https://github.com/Azure/azure-init/"
+license = "MIT"
+description = "A common library for provisioning Linux VMs on Azure."
+
+[dependencies]
+reqwest = { version = "0.11.18", default-features = false, features = ["blocking", "json"] }
+serde = {version = "1.0.163", features = ["derive"]}
+serde_xml = "0.9.1"
+serde_derive = "1.0"
+tokio = { version = "1", features = ["full"] }
+serde-xml-rs = "0.6.0"
+xml-rs = "0.8.13"
+serde_json = "1.0.96"
+rustfmt = "0.10.0"
+nix = "0.26.2"
+libc = "0.2.146"
+
+[lib]
+name = "libazureinit"
+path = "src/lib.rs"
+
diff --git a/src/distro.rs → libazureinit/src/distro.rs b/src/distro.rs → libazureinit/src/distro.rs
diff --git a/src/goalstate.rs → libazureinit/src/goalstate.rs b/src/goalstate.rs → libazureinit/src/goalstate.rs
diff --git a/src/imds.rs → libazureinit/src/imds.rs b/src/imds.rs → libazureinit/src/imds.rs
diff --git a/src/lib.rs → libazureinit/src/lib.rs b/src/lib.rs → libazureinit/src/lib.rs
diff --git a/src/media.rs → libazureinit/src/media.rs b/src/media.rs → libazureinit/src/media.rs
diff --git a/src/user.rs → libazureinit/src/user.rs b/src/user.rs → libazureinit/src/user.rs
diff --git a/src/main.rs b/src/main.rs
@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-use lib::distro::{Distribution, Distributions};
-use lib::{goalstate, imds, media, user};
+use libazureinit::distro::{Distribution, Distributions};
+use libazureinit::{goalstate, imds, media, user};
 
 #[tokio::main]
 async fn main() {

diff --git a/tests/functional_tests.rs b/tests/functional_tests.rs
@@ -1,9 +1,9 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-use lib::distro::{Distribution, Distributions};
-use lib::imds::PublicKeys;
-use lib::{goalstate, user};
+use libazureinit::distro::{Distribution, Distributions};
+use libazureinit::imds::PublicKeys;
+use libazureinit::{goalstate, user};
 
 use std::env;