Fixes from review.

open-telemetry · Jul 17, 2024 · 6834934 · 6834934
2 parents f625068 + ece8753
commit 6834934
Show file tree

Hide file tree

Showing 90 changed files with 137 additions and 72 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -36,11 +36,11 @@ publish = false
 rust-version = "1.76"
 
 [workspace.dependencies]
-serde = { version = "1.0.203", features = ["derive"] }
+serde = { version = "1.0.204", features = ["derive"] }
 serde_yaml = "0.9.32"
 serde_json = { version = "1.0.116"}
 thiserror = "1.0.58"
-ureq = "2.9.7"
+ureq = "2.10.0"
 regex = "1.10.5"
 rayon = "1.10.0"
 ordered-float = { version = "4.2.0", features = ["serde", "schemars"] }
@@ -74,7 +74,7 @@ weaver_cache = { path = "crates/weaver_cache" }
 weaver_forge = { path = "crates/weaver_forge" }
 weaver_checker = { path = "crates/weaver_checker" }
 
-clap = { version = "4.5.7", features = ["derive"] }
+clap = { version = "4.5.9", features = ["derive"] }
 rayon = "1.10.0"
 ratatui = { version = "0.26.3", features=["serde"] }
 crossterm = { version = "0.27.0", features = ["serde"] }
@@ -186,7 +186,8 @@ redundant_feature_names = "warn"
 ref_option_ref = "warn"
 rest_pat_in_fully_bound_structs = "warn"
 same_functions_in_if_condition = "warn"
-self_named_module_files = "warn"
+# disabled due to false positives
+# self_named_module_files = "warn"
 semicolon_if_nothing_returned = "warn"
 single_match_else = "warn"
 string_add = "warn"

diff --git a/README.md b/README.md
@@ -9,6 +9,12 @@
 
 [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) |
 
+> [!NOTE]
+> Codegen authors, please refer to the following documentation to learn how to
+> use Weaver for generating code from semantic conventions:
+> - [Templates organization, integrated Jinja2 engine, list of supported filters/functions/tests](crates/weaver_forge/README.md)
+> - [Weaver Configuration](docs/weaver-config.md)
+
 ## What is OpenTelemetry Weaver?
 
 **OTel Weaver** is a comprehensive tool designed to enable developers to

diff --git a/crates/weaver_forge/Cargo.toml b/crates/weaver_forge/Cargo.toml
@@ -18,10 +18,11 @@ weaver_resolver = { path = "../weaver_resolver" }
 weaver_resolved_schema = { path = "../weaver_resolved_schema" }
 weaver_semconv = { path = "../weaver_semconv" }
 
-minijinja = { version = "2.0.1", features = ["loader", "custom_syntax", "debug", "json", "macros"] }
+minijinja = { version = "2.0.3", features = ["loader", "custom_syntax", "debug", "json", "urlencode", "macros"] }
+minijinja-contrib = { version="2.0.3", features = ["pycompat"] }
 convert_case = "0.6.0"
 jaq-core = "1.2.1"
-jaq-std = "1.2.1"
+jaq-std = "1.5.1"
 jaq-interpret = "1.2.1"
 jaq-parse = "1.0.2"
 indexmap = "2.2.6"

diff --git a/crates/weaver_forge/README.md b/crates/weaver_forge/README.md
@@ -37,8 +37,6 @@ templates/
       ...
     rust/                   <-- Templates to generate the semantic conventions in Rust
       ...
-    go/                     <-- Templates to generate the semantic conventions in Go
-      ...
   schema/
     sdk-go/                 <-- Templates to generate a Go Client SDK derived from the telemetry schema
       ...
@@ -131,7 +129,8 @@ Jinja templates can also access the parameters:
 ## Jinja Filters
 
 All the filters available in the MiniJinja template engine are available (see
-this online [documentation](https://docs.rs/minijinja/latest/minijinja/filters/index.html)).
+this online [documentation](https://docs.rs/minijinja/latest/minijinja/filters/index.html)) and the [py_compat](https://github.com/mitsuhiko/minijinja/blob/e8a7ec5198deef7638267f2667714198ef64a1db/minijinja-contrib/src/pycompat.rs) compatibility extensions
+that are also enabled in Weaver.
 
 In addition, OTel Weaver provides a set of custom filters to facilitate the
 generation of documentation and code.

diff --git a/crates/weaver_forge/expected_output/py_compat/test b/crates/weaver_forge/expected_output/py_compat/test
@@ -0,0 +1,6 @@
+Test integration with `py_compat` functions
+
+"Hello, World!".startswith("Hello") => true
+"Hello, World!".startswith("Bonjour") => false
+"Hello, World!".endswith("World!") => true
+"Hello, World!".endswith("Monde!") => false
diff --git a/.../attribute_group/attributes_jvm_memory.md → .../attribute_group/attributes_jvm_memory.md b/.../attribute_group/attributes_jvm_memory.md → .../attribute_group/attributes_jvm_memory.md
diff --git a/...ted_output/attribute_group/registry_db.md → ...utput/test/attribute_group/registry_db.md b/...ted_output/attribute_group/registry_db.md → ...utput/test/attribute_group/registry_db.md
diff --git a/...d_output/attribute_group/registry_http.md → ...put/test/attribute_group/registry_http.md b/...d_output/attribute_group/registry_http.md → ...put/test/attribute_group/registry_http.md
diff --git a/...utput/attribute_group/registry_network.md → .../test/attribute_group/registry_network.md b/...utput/attribute_group/registry_network.md → .../test/attribute_group/registry_network.md
diff --git a/...ed_output/attribute_group/registry_url.md → ...tput/test/attribute_group/registry_url.md b/...ed_output/attribute_group/registry_url.md → ...tput/test/attribute_group/registry_url.md
diff --git a/...ut/attribute_group/registry_user_agent.md → ...st/attribute_group/registry_user_agent.md b/...ut/attribute_group/registry_user_agent.md → ...st/attribute_group/registry_user_agent.md
diff --git a/...expected_output/attribute_group/server.md → ...ted_output/test/attribute_group/server.md b/...expected_output/attribute_group/server.md → ...ted_output/test/attribute_group/server.md
diff --git a/...forge/expected_output/attribute_groups.md → .../expected_output/test/attribute_groups.md b/...forge/expected_output/attribute_groups.md → .../expected_output/test/attribute_groups.md
diff --git a/...weaver_forge/expected_output/converter.md → ...r_forge/expected_output/test/converter.md b/...weaver_forge/expected_output/converter.md → ...r_forge/expected_output/test/converter.md
diff --git a/..._output/event/android_lifecycle_events.md → ...ut/test/event/android_lifecycle_events.md b/..._output/event/android_lifecycle_events.md → ...ut/test/event/android_lifecycle_events.md
diff --git a/...cted_output/event/ios_lifecycle_events.md → ...output/test/event/ios_lifecycle_events.md b/...cted_output/event/ios_lifecycle_events.md → ...output/test/event/ios_lifecycle_events.md
diff --git a/...es/weaver_forge/expected_output/events.md → ...aver_forge/expected_output/test/events.md b/...es/weaver_forge/expected_output/events.md → ...aver_forge/expected_output/test/events.md
diff --git a/..._output/group/android_lifecycle_events.md → ...ut/test/group/android_lifecycle_events.md b/..._output/group/android_lifecycle_events.md → ...ut/test/group/android_lifecycle_events.md
diff --git a/...ted_output/group/attributes_jvm_memory.md → ...utput/test/group/attributes_jvm_memory.md b/...ted_output/group/attributes_jvm_memory.md → ...utput/test/group/attributes_jvm_memory.md
diff --git a/.../weaver_forge/expected_output/group/db.md → ...er_forge/expected_output/test/group/db.md b/.../weaver_forge/expected_output/group/db.md → ...er_forge/expected_output/test/group/db.md
diff --git a/...rge/expected_output/group/db_cassandra.md → ...xpected_output/test/group/db_cassandra.md b/...rge/expected_output/group/db_cassandra.md → ...xpected_output/test/group/db_cassandra.md
diff --git a/...orge/expected_output/group/db_cosmosdb.md → ...expected_output/test/group/db_cosmosdb.md b/...orge/expected_output/group/db_cosmosdb.md → ...expected_output/test/group/db_cosmosdb.md
diff --git a/...forge/expected_output/group/db_couchdb.md → .../expected_output/test/group/db_couchdb.md b/...forge/expected_output/group/db_couchdb.md → .../expected_output/test/group/db_couchdb.md
diff --git a/...expected_output/group/db_elasticsearch.md → ...ted_output/test/group/db_elasticsearch.md b/...expected_output/group/db_elasticsearch.md → ...ted_output/test/group/db_elasticsearch.md
diff --git a/...r_forge/expected_output/group/db_hbase.md → ...ge/expected_output/test/group/db_hbase.md b/...r_forge/expected_output/group/db_hbase.md → ...ge/expected_output/test/group/db_hbase.md
diff --git a/...forge/expected_output/group/db_mongodb.md → .../expected_output/test/group/db_mongodb.md b/...forge/expected_output/group/db_mongodb.md → .../expected_output/test/group/db_mongodb.md
diff --git a/...r_forge/expected_output/group/db_mssql.md → ...ge/expected_output/test/group/db_mssql.md b/...r_forge/expected_output/group/db_mssql.md → ...ge/expected_output/test/group/db_mssql.md
diff --git a/...r_forge/expected_output/group/db_redis.md → ...ge/expected_output/test/group/db_redis.md b/...r_forge/expected_output/group/db_redis.md → ...ge/expected_output/test/group/db_redis.md
diff --git a/...ver_forge/expected_output/group/db_sql.md → ...orge/expected_output/test/group/db_sql.md b/...ver_forge/expected_output/group/db_sql.md → ...orge/expected_output/test/group/db_sql.md
diff --git a/...er_forge/expected_output/group/db_tech.md → ...rge/expected_output/test/group/db_tech.md b/...er_forge/expected_output/group/db_tech.md → ...rge/expected_output/test/group/db_tech.md
diff --git a/...cted_output/group/ios_lifecycle_events.md → ...output/test/group/ios_lifecycle_events.md b/...cted_output/group/ios_lifecycle_events.md → ...output/test/group/ios_lifecycle_events.md
diff --git a/...ed_output/group/metric_jvm_class_count.md → ...tput/test/group/metric_jvm_class_count.md b/...ed_output/group/metric_jvm_class_count.md → ...tput/test/group/metric_jvm_class_count.md
diff --git a/...d_output/group/metric_jvm_class_loaded.md → ...put/test/group/metric_jvm_class_loaded.md b/...d_output/group/metric_jvm_class_loaded.md → ...put/test/group/metric_jvm_class_loaded.md
diff --git a/...output/group/metric_jvm_class_unloaded.md → ...t/test/group/metric_jvm_class_unloaded.md b/...output/group/metric_jvm_class_unloaded.md → ...t/test/group/metric_jvm_class_unloaded.md
diff --git a/...cted_output/group/metric_jvm_cpu_count.md → ...output/test/group/metric_jvm_cpu_count.md b/...cted_output/group/metric_jvm_cpu_count.md → ...output/test/group/metric_jvm_cpu_count.md
diff --git a/...roup/metric_jvm_cpu_recent_utilization.md → ...roup/metric_jvm_cpu_recent_utilization.md b/...roup/metric_jvm_cpu_recent_utilization.md → ...roup/metric_jvm_cpu_recent_utilization.md
diff --git a/...ected_output/group/metric_jvm_cpu_time.md → ..._output/test/group/metric_jvm_cpu_time.md b/...ected_output/group/metric_jvm_cpu_time.md → ..._output/test/group/metric_jvm_cpu_time.md
diff --git a/...ed_output/group/metric_jvm_gc_duration.md → ...tput/test/group/metric_jvm_gc_duration.md b/...ed_output/group/metric_jvm_gc_duration.md → ...tput/test/group/metric_jvm_gc_duration.md
diff --git a/...tput/group/metric_jvm_memory_committed.md → ...test/group/metric_jvm_memory_committed.md b/...tput/group/metric_jvm_memory_committed.md → ...test/group/metric_jvm_memory_committed.md
diff --git a/...d_output/group/metric_jvm_memory_limit.md → ...put/test/group/metric_jvm_memory_limit.md b/...d_output/group/metric_jvm_memory_limit.md → ...put/test/group/metric_jvm_memory_limit.md
diff --git a/...ed_output/group/metric_jvm_memory_used.md → ...tput/test/group/metric_jvm_memory_used.md b/...ed_output/group/metric_jvm_memory_used.md → ...tput/test/group/metric_jvm_memory_used.md
diff --git a/...p/metric_jvm_memory_used_after_last_gc.md → ...p/metric_jvm_memory_used_after_last_gc.md b/...p/metric_jvm_memory_used_after_last_gc.md → ...p/metric_jvm_memory_used_after_last_gc.md
diff --git a/...d_output/group/metric_jvm_thread_count.md → ...put/test/group/metric_jvm_thread_count.md b/...d_output/group/metric_jvm_thread_count.md → ...put/test/group/metric_jvm_thread_count.md
diff --git a/...rge/expected_output/group/otel_library.md → ...xpected_output/test/group/otel_library.md b/...rge/expected_output/group/otel_library.md → ...xpected_output/test/group/otel_library.md
diff --git a/...forge/expected_output/group/otel_scope.md → .../expected_output/test/group/otel_scope.md b/...forge/expected_output/group/otel_scope.md → .../expected_output/test/group/otel_scope.md
diff --git a/...orge/expected_output/group/registry_db.md → ...expected_output/test/group/registry_db.md b/...orge/expected_output/group/registry_db.md → ...expected_output/test/group/registry_db.md
diff --git a/...ge/expected_output/group/registry_http.md → ...pected_output/test/group/registry_http.md b/...ge/expected_output/group/registry_http.md → ...pected_output/test/group/registry_http.md
diff --git a/...expected_output/group/registry_network.md → ...ted_output/test/group/registry_network.md b/...expected_output/group/registry_network.md → ...ted_output/test/group/registry_network.md
diff --git a/...rge/expected_output/group/registry_url.md → ...xpected_output/test/group/registry_url.md b/...rge/expected_output/group/registry_url.md → ...xpected_output/test/group/registry_url.md
diff --git a/...ected_output/group/registry_user_agent.md → ..._output/test/group/registry_user_agent.md b/...ected_output/group/registry_user_agent.md → ..._output/test/group/registry_user_agent.md
diff --git a/...ver_forge/expected_output/group/server.md → ...orge/expected_output/test/group/server.md b/...ver_forge/expected_output/group/server.md → ...orge/expected_output/test/group/server.md
diff --git a/...es/weaver_forge/expected_output/groups.md → ...aver_forge/expected_output/test/groups.md b/...es/weaver_forge/expected_output/groups.md → ...aver_forge/expected_output/test/groups.md
diff --git a/...d_output/metric/metric_jvm_class_count.md → ...put/test/metric/metric_jvm_class_count.md b/...d_output/metric/metric_jvm_class_count.md → ...put/test/metric/metric_jvm_class_count.md
diff --git a/..._output/metric/metric_jvm_class_loaded.md → ...ut/test/metric/metric_jvm_class_loaded.md b/..._output/metric/metric_jvm_class_loaded.md → ...ut/test/metric/metric_jvm_class_loaded.md
diff --git a/...utput/metric/metric_jvm_class_unloaded.md → .../test/metric/metric_jvm_class_unloaded.md b/...utput/metric/metric_jvm_class_unloaded.md → .../test/metric/metric_jvm_class_unloaded.md
diff --git a/...ted_output/metric/metric_jvm_cpu_count.md → ...utput/test/metric/metric_jvm_cpu_count.md b/...ted_output/metric/metric_jvm_cpu_count.md → ...utput/test/metric/metric_jvm_cpu_count.md
diff --git a/...tric/metric_jvm_cpu_recent_utilization.md → ...tric/metric_jvm_cpu_recent_utilization.md b/...tric/metric_jvm_cpu_recent_utilization.md → ...tric/metric_jvm_cpu_recent_utilization.md
diff --git a/...cted_output/metric/metric_jvm_cpu_time.md → ...output/test/metric/metric_jvm_cpu_time.md b/...cted_output/metric/metric_jvm_cpu_time.md → ...output/test/metric/metric_jvm_cpu_time.md
diff --git a/...d_output/metric/metric_jvm_gc_duration.md → ...put/test/metric/metric_jvm_gc_duration.md b/...d_output/metric/metric_jvm_gc_duration.md → ...put/test/metric/metric_jvm_gc_duration.md
diff --git a/...put/metric/metric_jvm_memory_committed.md → ...est/metric/metric_jvm_memory_committed.md b/...put/metric/metric_jvm_memory_committed.md → ...est/metric/metric_jvm_memory_committed.md
diff --git a/..._output/metric/metric_jvm_memory_limit.md → ...ut/test/metric/metric_jvm_memory_limit.md b/..._output/metric/metric_jvm_memory_limit.md → ...ut/test/metric/metric_jvm_memory_limit.md
diff --git a/...d_output/metric/metric_jvm_memory_used.md → ...put/test/metric/metric_jvm_memory_used.md b/...d_output/metric/metric_jvm_memory_used.md → ...put/test/metric/metric_jvm_memory_used.md
diff --git a/...c/metric_jvm_memory_used_after_last_gc.md → ...c/metric_jvm_memory_used_after_last_gc.md b/...c/metric_jvm_memory_used_after_last_gc.md → ...c/metric_jvm_memory_used_after_last_gc.md
diff --git a/..._output/metric/metric_jvm_thread_count.md → ...ut/test/metric/metric_jvm_thread_count.md b/..._output/metric/metric_jvm_thread_count.md → ...ut/test/metric/metric_jvm_thread_count.md
diff --git a/...s/weaver_forge/expected_output/metrics.md → ...ver_forge/expected_output/test/metrics.md b/...s/weaver_forge/expected_output/metrics.md → ...ver_forge/expected_output/test/metrics.md
diff --git a/.../weaver_forge/expected_output/registry.md → ...er_forge/expected_output/test/registry.md b/.../weaver_forge/expected_output/registry.md → ...er_forge/expected_output/test/registry.md
diff --git a/.../expected_output/resource/otel_library.md → ...cted_output/test/resource/otel_library.md b/.../expected_output/resource/otel_library.md → ...cted_output/test/resource/otel_library.md
diff --git a/...ge/expected_output/resource/otel_scope.md → ...pected_output/test/resource/otel_scope.md b/...ge/expected_output/resource/otel_scope.md → ...pected_output/test/resource/otel_scope.md
diff --git a/...weaver_forge/expected_output/resources.md → ...r_forge/expected_output/test/resources.md b/...weaver_forge/expected_output/resources.md → ...r_forge/expected_output/test/resources.md
diff --git a/...s/weaver_forge/expected_output/span/db.md → ...ver_forge/expected_output/test/span/db.md b/...s/weaver_forge/expected_output/span/db.md → ...ver_forge/expected_output/test/span/db.md
diff --git a/...orge/expected_output/span/db_cassandra.md → ...expected_output/test/span/db_cassandra.md b/...orge/expected_output/span/db_cassandra.md → ...expected_output/test/span/db_cassandra.md
diff --git a/...forge/expected_output/span/db_cosmosdb.md → .../expected_output/test/span/db_cosmosdb.md b/...forge/expected_output/span/db_cosmosdb.md → .../expected_output/test/span/db_cosmosdb.md
diff --git a/..._forge/expected_output/span/db_couchdb.md → ...e/expected_output/test/span/db_couchdb.md b/..._forge/expected_output/span/db_couchdb.md → ...e/expected_output/test/span/db_couchdb.md
diff --git a/.../expected_output/span/db_elasticsearch.md → ...cted_output/test/span/db_elasticsearch.md b/.../expected_output/span/db_elasticsearch.md → ...cted_output/test/span/db_elasticsearch.md
diff --git a/...er_forge/expected_output/span/db_hbase.md → ...rge/expected_output/test/span/db_hbase.md b/...er_forge/expected_output/span/db_hbase.md → ...rge/expected_output/test/span/db_hbase.md
diff --git a/..._forge/expected_output/span/db_mongodb.md → ...e/expected_output/test/span/db_mongodb.md b/..._forge/expected_output/span/db_mongodb.md → ...e/expected_output/test/span/db_mongodb.md
diff --git a/...er_forge/expected_output/span/db_mssql.md → ...rge/expected_output/test/span/db_mssql.md b/...er_forge/expected_output/span/db_mssql.md → ...rge/expected_output/test/span/db_mssql.md
diff --git a/...er_forge/expected_output/span/db_redis.md → ...rge/expected_output/test/span/db_redis.md b/...er_forge/expected_output/span/db_redis.md → ...rge/expected_output/test/span/db_redis.md
diff --git a/...aver_forge/expected_output/span/db_sql.md → ...forge/expected_output/test/span/db_sql.md b/...aver_forge/expected_output/span/db_sql.md → ...forge/expected_output/test/span/db_sql.md
diff --git a/...ver_forge/expected_output/span/db_tech.md → ...orge/expected_output/test/span/db_tech.md b/...ver_forge/expected_output/span/db_tech.md → ...orge/expected_output/test/span/db_tech.md
diff --git a/crates/weaver_forge/expected_output/spans.md → ...eaver_forge/expected_output/test/spans.md b/crates/weaver_forge/expected_output/spans.md → ...eaver_forge/expected_output/test/spans.md
diff --git a/...emplates/test/expected_output/registry.md → ...ted_output/whitespace_control/registry.md b/...emplates/test/expected_output/registry.md → ...ted_output/whitespace_control/registry.md