docs: remove hardcoded substitution variables

bakdata · Nov 3, 2023 · 605c2fe · 605c2fe
1 parent d800e54
commit 605c2fe
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 18 deletions.
diff --git a/docs/docs/schema/config.json b/docs/docs/schema/config.json
@@ -294,7 +294,7 @@
             "properties": {
                 "default_error_topic_name": {
                     "default": "${pipeline_name}-${component_name}-error",
-                    "description": "Configures the value for the variable ${error_topic_name}",
+                    "description": "Configures the value for the variable ${topic_name_config_default_error_topic_name}",
                     "env_names": [
                         "default_error_topic_name"
                     ],

diff --git a/docs/docs/user/core-concepts/variables/substitution.md b/docs/docs/user/core-concepts/variables/substitution.md
@@ -23,14 +23,6 @@ All of them are prefixed with `component_` and follow the following form: `compo
 
 These variables include all fields in the [config](../config.md) and refer to the pipeline configuration that is independent of the components.
 
-<!-- dprint-ignore-start -->
-
-!!! info Aliases
-    `error_topic_name` is an alias for `topic_name_config_default_error_topic_name`  
-    `output_topic_name` is an alias for `topic_name_config_default_output_topic_name`
-
-<!-- dprint-ignore-end -->
-
 ## Environment variables
 
 Environment variables such as `$PATH` can be used in the pipeline definition and defaults without any transformation following the form `${ENV_VAR_NAME}`. This, of course, includes variables like the ones relevant to the [KPOps cli](../../references/cli-commands.md) that are exported by the user.

diff --git a/tests/components/test_kafka_sink_connector.py b/tests/components/test_kafka_sink_connector.py
@@ -54,9 +54,9 @@ def connector(
             namespace="test-namespace",
             to=ToSection(
                 topics={
-                    TopicName("${topic_name_config_default_output_topic_name}"): TopicConfig(
-                        type=OutputTopicTypes.OUTPUT, partitions_count=10
-                    ),
+                    TopicName(
+                        "${topic_name_config_default_output_topic_name}"
+                    ): TopicConfig(type=OutputTopicTypes.OUTPUT, partitions_count=10),
                 }
             ),
         )

diff --git a/tests/components/test_kafka_source_connector.py b/tests/components/test_kafka_source_connector.py
@@ -47,9 +47,9 @@ def connector(
             namespace="test-namespace",
             to=ToSection(
                 topics={
-                    TopicName("${topic_name_config_default_output_topic_name}"): TopicConfig(
-                        type=OutputTopicTypes.OUTPUT, partitions_count=10
-                    ),
+                    TopicName(
+                        "${topic_name_config_default_output_topic_name}"
+                    ): TopicConfig(type=OutputTopicTypes.OUTPUT, partitions_count=10),
                 }
             ),
             offset_topic="kafka-connect-offsets",

diff --git a/tests/components/test_producer_app.py b/tests/components/test_producer_app.py
@@ -90,7 +90,10 @@ def test_output_topics(self, config: KpopsConfig, handlers: ComponentHandlers):
             },
         )
 
-        assert producer_app.app.streams.output_topic == "${topic_name_config_default_output_topic_name}"
+        assert (
+            producer_app.app.streams.output_topic
+            == "${topic_name_config_default_output_topic_name}"
+        )
         assert producer_app.app.streams.extra_output_topics == {
             "first-extra-topic": "extra-topic-1"
         }

diff --git a/tests/components/test_streams_app.py b/tests/components/test_streams_app.py
@@ -228,8 +228,14 @@ def test_set_streams_output_from_to(
             "first-extra-topic": "extra-topic-1",
             "second-extra-topic": "extra-topic-2",
         }
-        assert streams_app.app.streams.output_topic == "${topic_name_config_default_output_topic_name}"
-        assert streams_app.app.streams.error_topic == "${topic_name_config_default_error_topic_name}"
+        assert (
+            streams_app.app.streams.output_topic
+            == "${topic_name_config_default_output_topic_name}"
+        )
+        assert (
+            streams_app.app.streams.error_topic
+            == "${topic_name_config_default_error_topic_name}"
+        )
 
     def test_weave_inputs_from_prev_component(
         self, config: KpopsConfig, handlers: ComponentHandlers