Bug/223 relationship test with limit (#245)

* add settings_section flag as comment for code using settings

* override test sql macro and add limit-placer macro

* update CHANGELOG.md

* rename end of query flag

CHANGELOG.md

@@ -2,6 +2,7 @@
 #### Bug Fix
 - Fixed an issue where Materialize Views would break with a custom schema.  Thanks to [Rory Sawyer](https://github.com/SoryRawyer)
 for the PR!
+- A few tests with LIMIT clause were broken due to parsing error when having settings in the query ([issue](https://github.com/ClickHouse/dbt-clickhouse/issues/223)). We added a dedicated limit placer, that takes into account the settings section (using a comment flag `-- settings_section` within the query).
 
 ### Release [1.7.1], 2023-12-13
 #### Bug Fixes

dbt/adapters/clickhouse/impl.py

@@ -412,15 +412,30 @@ def get_model_settings(self, model):
         res = []
         for key in settings:
             res.append(f' {key}={settings[key]}')
-        return '' if len(res) == 0 else 'SETTINGS ' + ', '.join(res) + '\n'
+        if len(res) == 0:
+            return ''
+        else:
+            settings_str = 'SETTINGS ' + ', '.join(res) + '\n'
+            return f"""
+                        -- end_of_sql
+                        {settings_str}
+                        """
 
     @available
     def get_model_query_settings(self, model):
         settings = model['config'].get('query_settings', {})
         res = []
         for key in settings:
             res.append(f' {key}={settings[key]}')
-        return '' if len(res) == 0 else 'SETTINGS ' + ', '.join(res) + '\n'
+
+        if len(res) == 0:
+            return ''
+        else:
+            settings_str = 'SETTINGS ' + ', '.join(res) + '\n'
+            return f"""
+            -- settings_section
+            {settings_str}
+            """
 
     @available.parse_none
     def get_column_schema_from_query(self, sql: str, *_) -> List[ClickHouseColumn]:

dbt/include/clickhouse/macros/schema_tests/relationships.sql

@@ -19,6 +19,7 @@ left join parent
     on child.from_field = parent.to_field
 
 where parent.to_field is null
+-- end_of_sql
 settings join_use_nulls = 1
 
 {% endmacro %}

dbt/include/clickhouse/macros/utils/utils.sql

@@ -1,3 +1,33 @@
+{% macro clickhouse__get_test_sql(main_sql, fail_calc, warn_if, error_if, limit) -%}
+    {% set main_sql_formatted = clickhouse__place_limit(main_sql, limit) if limit !=None else main_sql%}
+    select
+      {{ fail_calc }} as failures,
+      {{ fail_calc }} {{ warn_if }} as should_warn,
+      {{ fail_calc }} {{ error_if }} as should_error
+    from (
+      {{ main_sql_formatted }}
+    ) dbt_internal_test
+
+{%- endmacro %}
+
+
+-- This macro is designed to add a LIMIT clause to a ClickHouse SQL query while preserving any ClickHouse settings specified in the query.
+-- When multiple queries are nested, the limit will be attached to the outer query
+{% macro clickhouse__place_limit(query, limit) -%}
+   {% if 'settings' in query.lower()%}
+        {% if '-- end_of_sql' not in query.lower()%}
+            {{exceptions.raise_compiler_error("-- end_of_sql must be set when using ClickHouse settings")}}
+        {% endif %}
+        {% set split_by_settings_sections = query.split("-- end_of_sql")%}
+        {% set split_by_settings_sections_with_limit = split_by_settings_sections[-2] + "\n LIMIT " + limit|string  + "\n" %}
+        {% set query_with_limit = "-- end_of_sql".join(split_by_settings_sections[:-2] + [split_by_settings_sections_with_limit, split_by_settings_sections[-1]])%}
+        {{query_with_limit}}
+    {% else %}
+    {{query}}
+    {{"limit " ~ limit}}
+    {% endif %}
+{%- endmacro %}
+
 {% macro clickhouse__any_value(expression) -%}
     any({{ expression }})
 {%- endmacro %}