Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow to hide settings in preprocessed configuration file #53818

Merged
merged 17 commits into from
Aug 31, 2023

Conversation

rvasin
Copy link
Contributor

@rvasin rvasin commented Aug 25, 2023

Closes #52207

Changelog category (leave one):

  • New Feature

Changelog entry (a user-readable short description of the changes that goes to CHANGELOG.md):

Added the "hide_in_preprocessed" attribute to ClickHouse's server configuration XML dialect. This is a mechanism to hide certain settings from appearing in preprocessed server configuration files. Useful e.g. for passwords or private keys that should not appear verbatim in files.

@rvasin

This comment was marked as outdated.

@rschu1ze rschu1ze self-assigned this Aug 25, 2023
@rschu1ze rschu1ze added the can be tested Allows running workflows for external contributors label Aug 25, 2023
@robot-ch-test-poll robot-ch-test-poll added the pr-feature Pull request with new product feature label Aug 25, 2023
@robot-ch-test-poll
Copy link
Contributor

robot-ch-test-poll commented Aug 25, 2023

This is an automated comment for commit 92b89e8 with description of existing statuses. It's updated for the latest CI running
The full report is available here
The overall status of the commit is 🟢 success

Check nameDescriptionStatus
AST fuzzerRuns randomly generated queries to catch program errors. The build type is optionally given in parenthesis. If it fails, ask a maintainer for help🟢 success
CI runningA meta-check that indicates the running CI. Normally, it's in success or pending state. The failed status indicates some problems with the PR🟢 success
ClickHouse build checkBuilds ClickHouse in various configurations for use in further steps. You have to fix the builds that fail. Build logs often has enough information to fix the error, but you might have to reproduce the failure locally. The cmake options can be found in the build log, grepping for cmake. Use these options and follow the general build process🟢 success
Compatibility checkChecks that clickhouse binary runs on distributions with old libc versions. If it fails, ask a maintainer for help🟢 success
Docker image for serversThe check to build and optionally push the mentioned image to docker hub🟢 success
Docs CheckBuilds and tests the documentation🟢 success
Fast testNormally this is the first check that is ran for a PR. It builds ClickHouse and runs most of stateless functional tests, omitting some. If it fails, further checks are not started until it is fixed. Look at the report to see which tests fail, then reproduce the failure locally as described here🟢 success
Flaky testsChecks if new added or modified tests are flaky by running them repeatedly, in parallel, with more randomization. Functional tests are run 100 times with address sanitizer, and additional randomization of thread scheduling. Integrational tests are run up to 10 times. If at least once a new test has failed, or was too long, this check will be red. We don't allow flaky tests, read the doc🟢 success
Install packagesChecks that the built packages are installable in a clear environment🟢 success
Integration testsThe integration tests report. In parenthesis the package type is given, and in square brackets are the optional part/total tests🟢 success
Mergeable CheckChecks if all other necessary checks are successful🟢 success
Performance ComparisonMeasure changes in query performance. The performance test report is described in detail here. In square brackets are the optional part/total tests🟢 success
Push to DockerhubThe check for building and pushing the CI related docker images to docker hub🟢 success
SQLTestThere's no description for the check yet, please add it to tests/ci/ci_config.py:CHECK_DESCRIPTIONS🟢 success
SQLancerFuzzing tests that detect logical bugs with SQLancer tool🟢 success
SqllogicRun clickhouse on the sqllogic test set against sqlite and checks that all statements are passed🟢 success
Stateful testsRuns stateful functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc🟢 success
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc🟢 success
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors🟢 success
Style CheckRuns a set of checks to keep the code style clean. If some of tests failed, see the related log from the report🟢 success
Unit testsRuns the unit tests for different release types🟢 success
Upgrade checkRuns stress tests on server version from last release and then tries to upgrade it to the version from the PR. It checks if the new server can successfully startup without any errors, crashes or sanitizer asserts🟢 success

@rvasin

This comment was marked as outdated.

docs/en/operations/configuration-files.md Outdated Show resolved Hide resolved
src/Common/Config/ConfigProcessor.cpp Outdated Show resolved Hide resolved
src/Common/Config/ConfigProcessor.cpp Outdated Show resolved Hide resolved
src/Common/Config/ConfigProcessor.cpp Outdated Show resolved Hide resolved
@rvasin rvasin changed the title Add new hidden attribute in configuration file Add new hide_in_preprocessed attribute in configuration file Aug 28, 2023
@rvasin
Copy link
Contributor Author

rvasin commented Aug 29, 2023

I am working on fixing the integration tests. It when ClickHouse is built with ASAN then in fails to restart ClickHouse in integration test using node.restart_clickhouse()

For example,

def test_hide_in_preprocessed(started_cluster):
    assert (
        node.query(
            "select value from system.server_settings where name ='max_thread_pool_free_size'"
        )
        == "2000\n"
    )
    node.restart_clickhouse()
    assert (
        node.query(
            "select value from system.server_settings where name ='max_thread_pool_free_size'"
        )
        == "2000\n"
    )

It will display "Exception: Cannot start ClickHouse, see additional info in logs" which is produced by elf.start_clickhouse(stop_start_wait_sec).

It's not clear how is it related with by code and with ASAN. But surely it's related. I am going to fix it.

@rvasin
Copy link
Contributor Author

rvasin commented Aug 30, 2023

Thanks to ASAN build, probably the failed integration tests were fixed by changing:

Node * new_node = xml_tree_copy->importNode(node, true);

to

NodePtr new_node = xml_tree_copy->importNode(node, true);

Because NodePtr is AutoPtr:
base/poco/Foundation/include/Poco/AutoPtr.h

class AutoPtr
/// AutoPtr is a "smart" pointer for classes implementing
/// reference counting based garbage collection.

@rvasin
Copy link
Contributor Author

rvasin commented Aug 31, 2023

@rschu1ze "All checks have passed".

@rschu1ze rschu1ze merged commit 97d960b into ClickHouse:master Aug 31, 2023
281 checks passed
@rschu1ze rschu1ze changed the title Add new hide_in_preprocessed attribute in configuration file Allow to hide settings in preprocessed configuration file Aug 31, 2023
rschu1ze added a commit to rschu1ze/ClickHouse that referenced this pull request Aug 31, 2023
rschu1ze added a commit that referenced this pull request Aug 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
can be tested Allows running workflows for external contributors pr-feature Pull request with new product feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Preprocessed config file with hidden/in-memory parts
3 participants