Support for loading templates from the file system or from an embedded representation in the app's binary.

Cargo.toml

@@ -40,6 +40,8 @@ anyhow = "1.0.83"
 itertools = "0.12.1"
 globset = { version = "0.4.14", features = ["serde1"] }
 miette = { version = "7.2.0", features = ["fancy", "serde"] }
+include_dir = "0.7.3"
+tempdir = "0.3.7"
 
 # Features definition =========================================================
 [features]
@@ -69,10 +71,15 @@ serde.workspace = true
 serde_yaml.workspace = true
 serde_json.workspace = true
 walkdir.workspace = true
+include_dir.workspace = true
+thiserror.workspace = true
+miette.workspace = true
 
 rayon = "1.10.0"
 
 [dev-dependencies]
+weaver_diff = { path = "crates/weaver_diff" }
+tempdir.workspace = true
 assert_cmd = "2.0.14"
 
 [profile.release]

Dockerfile

@@ -10,7 +10,8 @@ COPY crates /build/crates
 COPY data /build/data
 COPY src /build/src
 COPY tests build/tests
-COPY diagnostic_templates /build/diagnostic_templates
+COPY default_diagnostic_templates build/default_diagnostic_templates
+
 # Don't build release, so we get template debugging output.
 RUN cargo build
 

README.md

@@ -4,6 +4,7 @@
 [![codecov](https://codecov.io/gh/open-telemetry/weaver/graph/badge.svg?token=tmWKFoMT2G)](https://codecov.io/gh/open-telemetry/weaver)
 [![build](https://github.com/open-telemetry/weaver/actions/workflows/audit.yml/badge.svg)](https://github.com/open-telemetry/weaver/actions/workflows/audit.yml)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Slack](https://img.shields.io/badge/Slack-OpenTelemetry_Weaver-purple)](https://cloud-native.slack.com/archives/C0697EXNTL3)
 ----
 
 [Getting started](#getting-started) | [Main commands](#main-commands) | [Generate Doc & Code](crates/weaver_forge/README.md) | [Architecture](docs/architecture.md) | [Change log](CHANGELOG.md) | [Contributing](CONTRIBUTING.md) | [Links](#links) |
@@ -130,6 +131,7 @@ Telemetry Schemas.
 ## Documentation
 
 - [Weaver Architecture](docs/architecture.md): A document detailing the architecture of the project.
+- [Weaver Configuration](docs/weaver-config.md): A document detailing the configuration options available.
 - [Weaver Forge](crates/weaver_forge/README.md): An integrated template engine designed to generate
   documentation and code based on semantic conventions.
 - [Weaver Checker](crates/weaver_policy_engine/README.md): An integrated policy

crates/weaver_cache/Cargo.toml

@@ -24,4 +24,5 @@ gix = { version = "0.63.0", default-features = false, features = [
 
 thiserror.workspace = true
 serde.workspace = true
+miette.workspace = true
 

crates/weaver_cache/allowed-external-types.toml

@@ -4,4 +4,5 @@
 # the public API. Ideally this can have a few exceptions as possible.
 allowed_external_types = [
     "serde::ser::Serialize",
+    "miette::protocol::Diagnostic",
 ]

crates/weaver_cache/src/lib.rs

@@ -17,11 +17,12 @@ use gix::clone::PrepareFetch;
 use gix::create::Kind;
 use gix::remote::fetch::Shallow;
 use gix::{create, open, progress};
+use miette::Diagnostic;
 use serde::Serialize;
 use tempdir::TempDir;
 
 /// An error that can occur while creating or using a cache.
-#[derive(thiserror::Error, Debug, Serialize)]
+#[derive(thiserror::Error, Debug, Serialize, Diagnostic)]
 #[non_exhaustive]
 pub enum Error {
     /// Home directory not found.

crates/weaver_checker/src/lib.rs

@@ -1,5 +1,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
+#![allow(rustdoc::broken_intra_doc_links)]
 #![doc = include_str!("../README.md")]
 
 use std::fmt::{Display, Formatter};

crates/weaver_codegen_test/build.rs

@@ -13,14 +13,15 @@ use std::process::exit;
 use weaver_cache::Cache;
 use weaver_common::in_memory::LogMessage;
 use weaver_common::{in_memory, Logger};
+use weaver_forge::file_loader::FileSystemFileLoader;
 use weaver_forge::registry::TemplateRegistry;
-use weaver_forge::{GeneratorConfig, OutputDirective, TemplateEngine};
+use weaver_forge::{OutputDirective, TemplateEngine};
 use weaver_resolver::SchemaResolver;
 use weaver_semconv::path::RegistryPath;
 use weaver_semconv::registry::SemConvRegistry;
 
 const SEMCONV_REGISTRY_PATH: &str = "./semconv_registry/";
-const TEMPLATES_PATH: &str = "./templates/";
+const TEMPLATES_PATH: &str = "./templates/registry/";
 const REGISTRY_ID: &str = "test";
 const TARGET: &str = "rust";
 
@@ -47,9 +48,9 @@ fn main() {
     let schema = SchemaResolver::resolve_semantic_convention_registry(&mut registry)
         .unwrap_or_else(|e| process_error(&logger, e));
 
-    let config = GeneratorConfig::new(TEMPLATES_PATH.into());
-    let engine = TemplateEngine::try_new(&format!("registry/{}", TARGET), config)
+    let loader = FileSystemFileLoader::try_new(TEMPLATES_PATH.into(), TARGET)
         .unwrap_or_else(|e| process_error(&logger, e));
+    let engine = TemplateEngine::try_new(loader).unwrap_or_else(|e| process_error(&logger, e));
     let template_registry = TemplateRegistry::try_from_resolved_registry(
         schema
             .registry(REGISTRY_ID)

crates/weaver_common/src/diagnostic.rs

@@ -100,6 +100,12 @@ impl DiagnosticMessages {
             .iter()
             .any(|message| message.diagnostic.severity == Some(Severity::Error))
     }
+
+    /// Returns true if there are no diagnostic messages
+    #[must_use]
+    pub fn is_empty(&self) -> bool {
+        self.0.is_empty()
+    }
 }
 
 impl<T: WeaverDiagnostic + Diagnostic + Serialize + Send + Sync + 'static> From<T>
@@ -161,6 +167,8 @@ mod tests {
         };
         let diagnostic_messages = DiagnosticMessages::from_error(error.clone());
         assert_eq!(diagnostic_messages.0.len(), 1);
+        assert!(diagnostic_messages.has_error());
+        assert!(!diagnostic_messages.is_empty());
         assert_eq!(
             diagnostic_messages.0[0].diagnostic.message,
             "This is a test error"

crates/weaver_diff/Cargo.toml

@@ -9,6 +9,7 @@ edition.workspace = true
 rust-version.workspace = true
 
 [dependencies]
+walkdir.workspace = true
 similar = "2.5.0"
 
 

crates/weaver_diff/src/lib.rs

@@ -3,6 +3,10 @@
 //! This crate provides bare minimum support for colorized string differencing.
 
 use similar::TextDiff;
+use std::collections::HashSet;
+use std::fs;
+use std::path::Path;
+use walkdir::WalkDir;
 
 const GREEN: &str = "\x1b[32m";
 const RED: &str = "\x1b[31m";
@@ -30,3 +34,118 @@
     result.push_str(RESET);
     result
 }
+
+/// Displays differences between two directories and returns whether they are identical.
+/// The function will print differences to stderr.
+#[allow(clippy::print_stderr)]
+pub fn diff_dir<P: AsRef<Path>>(expected_dir: P, observed_dir: P) -> std::io::Result<bool> {
+    let mut expected_files = HashSet::new();
+    let mut observed_files = HashSet::new();
+
+    // Walk through the first directory and add files to files1 set
+    for entry in WalkDir::new(&expected_dir)
+        .into_iter()
+        .filter_map(|e| e.ok())
+    {
+        let path = entry.path();
+        if path.is_file() {
+            let relative_path = path
+                .strip_prefix(&expected_dir)
+                .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e))?;
+            _ = expected_files.insert(relative_path.to_path_buf());
+        }
+    }
+
+    // Walk through the second directory and add files to files2 set
+    for entry in WalkDir::new(&observed_dir)
+        .into_iter()
+        .filter_map(|e| e.ok())
+    {
+        let path = entry.path();
+        if path.is_file() {
+            let relative_path = path
+                .strip_prefix(&observed_dir)
+                .map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e))?;
+            _ = observed_files.insert(relative_path.to_path_buf());
+        }
+    }
+
+    // Assume directories are identical until proven otherwise
+    let mut are_identical = true;
+
+    // Compare files in both sets
+    for file in expected_files.intersection(&observed_files) {
+        let file1_content =
+            fs::read_to_string(expected_dir.as_ref().join(file))?.replace("\r\n", "\n");
+        let file2_content =
+            fs::read_to_string(observed_dir.as_ref().join(file))?.replace("\r\n", "\n");
+
+        if file1_content != file2_content {
+            are_identical = false;
+            eprintln!(
+                "Files {:?} and {:?} are different",
+                expected_dir.as_ref().join(file),
+                observed_dir.as_ref().join(file)
+            );
+
+            eprintln!(
+                "Found differences:\n{}",
+                diff_output(&file1_content, &file2_content)
+            );
+            break;
+        }
+    }
+    // If any file is unique to one directory, they are not identical
+    let not_in_observed = expected_files
+        .difference(&observed_files)
+        .collect::<Vec<_>>();
+    if !not_in_observed.is_empty() {
+        are_identical = false;
+        eprintln!("Observed output is missing files: {:?}", not_in_observed);
+    }
+    let not_in_expected = observed_files
+        .difference(&expected_files)
+        .collect::<Vec<_>>();
+    if !not_in_expected.is_empty() {
+        are_identical = false;
+        eprintln!(
+            "Observed output has unexpected files: {:?}",
+            not_in_expected
+        );
+    }
+
+    Ok(are_identical)
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_diff_output() {
+        let original = "Hello, world!";
+        let updated = "Hello, there!";
+        let diff = diff_output(original, updated);
+        assert_eq!(
+            diff,
+            "\u{1b}[31m- Hello, world!\n\u{1b}[32m+ Hello, there!\n\u{1b}[0m"
+        );
+    }
+
+    #[test]
+    fn test_diff_dir() {
+        let expected_dir = "./src";
+        let observed_dir = "./src";
+
+        let are_identical =
+            diff_dir(&expected_dir, &observed_dir).expect("Failed to diff directories");
+        assert!(are_identical);
+
+        let expected_dir = "./src";
+        let observed_dir = "../weaver_cache/src";
+
+        let are_identical =
+            diff_dir(&expected_dir, &observed_dir).expect("Failed to diff directories");
+        assert!(!are_identical);
+    }
+}

crates/weaver_forge/Cargo.toml

@@ -36,4 +36,11 @@ serde_json.workspace = true
 rayon.workspace = true
 walkdir.workspace = true
 globset.workspace = true
-miette.workspace = true
+miette.workspace = true
+include_dir.workspace = true
+
+[dev-dependencies]
+opentelemetry = { version = "0.22.0", features = ["trace", "metrics", "logs", "otel_unstable"] }
+opentelemetry_sdk = { version = "0.22.1", features = ["trace", "metrics", "logs"] }
+opentelemetry-stdout = { version = "0.3.0", features = ["trace", "metrics", "logs"] }
+