ClickHouse/tests/integration
2024-11-26 18:40:18 +01:00
..
compose Added proper healthcheck 2024-11-13 14:41:16 +01:00
helpers Resubmit #68682, att2 2024-11-26 12:59:38 +00:00
test_accept_invalid_certificate
test_access_control_on_cluster
test_access_for_functions
test_aggregation_memory_efficient
test_aliases_in_default_expr_not_break_table_structure
test_allow_feature_tier Rename allowed_feature_tier to allow_feature_tier 2024-11-26 12:30:57 +01:00
test_allowed_client_hosts
test_allowed_url_from_config
test_alter_codec
test_alter_comment_on_cluster
test_alter_moving_garbage
test_alter_on_mixed_type_cluster
test_alter_settings_on_cluster
test_alter_update_cast_keep_nullable
test_alternative_keeper_config Fix 2024-10-25 10:19:50 +02:00
test_always_fetch_merged
test_analyzer_compatibility
test_async_connect_to_multiple_ips
test_async_insert_adaptive_busy_timeout
test_async_insert_memory
test_async_load_databases add cleanup after test 2024-10-25 18:59:05 +00:00
test_async_metrics_in_cgroup
test_asynchronous_metric_jemalloc_profile_active
test_asynchronous_metric_log_table
test_asynchronous_metrics_pk_bytes_fields
test_atomic_drop_table
test_attach_backup_from_s3_plain
test_attach_partition_using_copy
test_attach_partition_with_large_destination
test_attach_table_from_s3_plain_readonly
test_attach_table_normalizer
test_attach_with_different_projections_or_indices Cosmetic changes, upd setting name 2024-10-21 12:55:53 +02:00
test_attach_without_checksums
test_attach_without_fetching
test_authentication
test_azure_blob_storage_native_copy
test_azure_blob_storage_plain_rewritable
test_azure_blob_storage_zero_copy_replication
test_backup_log
test_backup_restore
test_backup_restore_azure_blob_storage
test_backup_restore_keeper_map
test_backup_restore_new
test_backup_restore_on_cluster Increase timeout in test test_long_disconnection_stops_backup. 2024-11-17 17:36:22 +01:00
test_backup_restore_s3
test_backup_restore_storage_policy
test_backup_s3_storage_class
test_backward_compatibility
test_block_structure_mismatch
test_broken_part_during_merge
test_broken_projections
test_buffer_profile
test_build_sets_from_multiple_threads
test_catboost_evaluate
test_cgroup_limit
test_check_table
test_checking_s3_blobs_paranoid cancel or finalize write buffer 2024-11-11 11:37:12 +01:00
test_cleanup_after_start
test_cleanup_dir_after_bad_zk_conn
test_cluster_all_replicas
test_cluster_discovery Antother style fix 2024-11-18 16:18:36 +01:00
test_codec_encrypted
test_compatibility_merge_tree_settings Automatic style fix 2024-10-03 13:40:07 +00:00
test_composable_protocols
test_compressed_marks_restart
test_compression_codec_read
test_compression_nested_columns
test_concurrent_backups_s3
test_concurrent_queries_for_all_users_restriction
test_concurrent_queries_for_user_restriction
test_concurrent_queries_restriction_by_query_kind
test_concurrent_threads_soft_limit better ProfileEvent names 2024-10-18 18:11:33 +00:00
test_concurrent_ttl_merges
test_config_corresponding_root
test_config_decryption
test_config_hide_in_preprocessed
test_config_reload Fix and simplify test 2024-10-29 23:09:37 +00:00
test_config_reloader_interval
test_config_substitutions
test_config_xml_full Merge remote-tracking branch 'origin/master' into support-ddl-on-cluster-stop-waiting-offline-hosts 2024-10-28 07:30:23 +00:00
test_config_xml_main
test_config_xml_yaml_mix
test_config_yaml_full
test_config_yaml_main
test_config_yaml_merge_keys
test_consistant_parts_after_move_partition
test_consistent_parts_after_clone_replica cancel or finalize write buffer 2024-11-11 11:37:12 +01:00
test_covered_by_broken_exists
test_crash_log
test_create_query_constraints
test_create_user_and_login
test_cross_replication
test_custom_dashboards
test_custom_settings
test_ddl_alter_query
test_ddl_config_hostname
test_ddl_on_cluster_stop_waiting_for_offline_hosts Tidy test_ddl_on_cluster_stop_waiting_for_offline_hosts 2024-10-03 07:09:41 +00:00
test_ddl_worker_non_leader
test_ddl_worker_replicas Make test_ddl_worker_replicas predictable 2024-10-03 12:44:23 +00:00
test_deduplicated_attached_part_rename Fix style 2024-10-06 22:56:48 +03:00
test_default_compression_codec
test_default_database_on_cluster
test_default_role
test_delayed_replica_failover
test_detached_parts_metrics Fix test 2024-10-28 06:36:26 +01:00
test_dictionaries_access
test_dictionaries_all_layouts_separate_sources
test_dictionaries_complex_key_cache_string
test_dictionaries_config_reload
test_dictionaries_ddl
test_dictionaries_dependency
test_dictionaries_dependency_xml
test_dictionaries_mysql
test_dictionaries_null_value
test_dictionaries_postgresql
test_dictionaries_redis
test_dictionaries_replace
test_dictionaries_select_all
test_dictionaries_update_and_reload
test_dictionaries_wait_for_load
test_dictionaries_with_invalid_structure
test_dictionary_allow_read_expired_keys
test_dictionary_custom_settings
test_dictionary_ddl_on_cluster
test_disable_insertion_and_mutation
test_disabled_access_control_improvements
test_disabled_mysql_server
test_disk_access_storage
test_disk_configuration Disallow having disk and storage policy at the same time 2024-10-18 18:43:00 +03:00
test_disk_over_web_server Update test.py 2024-11-19 11:23:46 +01:00
test_disk_types
test_disks_app_func
test_disks_app_interactive
test_distributed_async_insert_for_node_changes
test_distributed_config
test_distributed_ddl
test_distributed_ddl_on_cross_replication
test_distributed_ddl_parallel
test_distributed_ddl_password
test_distributed_default_database
test_distributed_directory_monitor_split_batch_on_failure Improve error and log messages around memory usage 2024-10-29 16:15:41 +01:00
test_distributed_format
test_distributed_insert_backward_compatibility
test_distributed_inter_server_secret
test_distributed_load_balancing
test_distributed_over_distributed
test_distributed_respect_user_timeouts
test_distributed_storage_configuration
test_distributed_system_query
test_distributed_type_object
test_dns_cache
test_dotnet_client
test_drop_if_empty
test_drop_is_lock_free
test_drop_no_local_path
test_drop_replica Merge pull request #70642 from MikhailBurdukov/fix_exception_system_drop_replica 2024-10-31 14:35:45 +00:00
test_drop_replica_with_auxiliary_zookeepers
test_enabling_access_management
test_encrypted_disk
test_encrypted_disk_replication
test_endpoint_macro_substitution
test_executable_dictionary
test_executable_table_function
test_executable_user_defined_function
test_executable_user_defined_functions_config_reload
test_explain_estimates
test_external_cluster
test_external_http_authenticator
test_extreme_deduplication
test_failed_async_inserts
test_failed_mutations Fix style 2024-11-01 16:01:17 +00:00
test_fetch_memory_usage
test_fetch_partition_from_auxiliary_zookeeper
test_fetch_partition_should_reset_mutation
test_fetch_partition_with_outdated_parts
test_file_cluster
test_file_schema_inference_cache
test_filesystem_cache
test_filesystem_layout
test_fix_metadata_version mv fixReplicaMetadataVersionIfNeeded from attach thread to restarting thread 2024-10-28 13:06:26 +00:00
test_force_deduplication
test_force_drop_table
test_format_avro_confluent
test_format_schema_on_server
test_freeze_table
test_global_overcommit_tracker
test_globs_in_filepath
test_grant_and_revoke Sync integration test with private 2024-10-27 19:21:08 +01:00
test_graphite_merge_tree
test_graphite_merge_tree_typed
test_group_array_element_size
test_groupBitmapAnd_on_distributed
test_grpc_protocol Adjust some tests 2024-10-29 17:08:32 +01:00
test_grpc_protocol_ssl
test_hedged_requests
test_hedged_requests_parallel
test_host_regexp_hosts_file_resolution
test_host_regexp_multiple_ptr_records
test_hot_reload_storage_policy
test_http_and_readonly
test_http_failover
test_http_handlers_config Add ability to set user/password in http_handlers 2024-10-24 17:04:40 +02:00
test_http_native
test_https_replication
test_https_s3_table_function_with_http_proxy_no_tunneling
test_inherit_multiple_profiles
test_input_format_parallel_parsing_memory_tracking
test_insert_distributed_async_extra_dirs
test_insert_distributed_async_send
test_insert_distributed_load_balancing
test_insert_into_distributed
test_insert_into_distributed_sync_async
test_insert_into_distributed_through_materialized_view
test_insert_over_http_query_log
test_inserts_with_keeper_retries
test_intersecting_parts
test_interserver_dns_retires
test_jbod_balancer
test_jbod_ha
test_jbod_load_balancing
test_jdbc_bridge
test_jemalloc_percpu_arena
test_join_set_family_s3
test_kafka_bad_messages
test_keeper_and_access_storage
test_keeper_auth
test_keeper_availability_zone
test_keeper_back_to_back
test_keeper_broken_logs Automatic style fix 2024-10-23 15:49:38 +00:00
test_keeper_client
test_keeper_compression
test_keeper_disks
test_keeper_dynamic_log_level
test_keeper_feature_flags_config
test_keeper_force_recovery
test_keeper_force_recovery_single_node
test_keeper_four_word_command Fix test_keeper_four_word_command 2024-10-03 10:33:03 +02:00
test_keeper_http_control
test_keeper_incorrect_config
test_keeper_internal_secure
test_keeper_map
test_keeper_map_retries More fixes 2024-10-10 19:39:28 +02:00
test_keeper_memory_soft_limit
test_keeper_mntr_data_size
test_keeper_mntr_pressure
test_keeper_multinode_simple
test_keeper_nodes_add
test_keeper_nodes_move
test_keeper_nodes_remove
test_keeper_persistent_log
test_keeper_persistent_log_multinode
test_keeper_profiler
test_keeper_reconfig_add
test_keeper_reconfig_remove
test_keeper_reconfig_remove_many
test_keeper_reconfig_replace_leader
test_keeper_reconfig_replace_leader_in_one_command
test_keeper_restore_from_snapshot
test_keeper_s3_snapshot
test_keeper_secure_client
test_keeper_session
test_keeper_snapshot_on_exit
test_keeper_snapshot_small_distance
test_keeper_snapshots
test_keeper_snapshots_multinode
test_keeper_three_nodes_start
test_keeper_three_nodes_two_alive
test_keeper_two_nodes_cluster
test_keeper_znode_time
test_keeper_zookeeper_converter
test_kerberos_auth
test_lazy_database
test_ldap_external_user_directory fix build, fix test 2024-11-19 09:53:28 +00:00
test_library_bridge Increase timeout 2024-11-21 09:53:31 +00:00
test_limit_materialized_view_count
test_limited_replicated_fetches
test_log_family_hdfs
test_log_family_s3
test_log_levels_update
test_log_lz4_streaming
test_log_query_probability
test_logs_level
test_lost_part
test_lost_part_during_startup
test_manipulate_statistics
test_mask_sensitive_info
test_match_process_uid_against_data_owner
test_materialized_mysql_database
test_materialized_view_restart_server
test_max_authentication_methods_per_user
test_max_rows_to_read_leaf_with_view
test_max_suspicious_broken_parts
test_max_suspicious_broken_parts_replicated
test_memory_limit
test_memory_limit_observer
test_memory_profiler_min_max_borders
test_MemoryTracking
test_merge_table_over_distributed
test_merge_tree_azure_blob_storage
test_merge_tree_check_part_with_cache
test_merge_tree_empty_parts
test_merge_tree_hdfs
test_merge_tree_load_marks
test_merge_tree_load_parts
test_merge_tree_s3 fix style 2024-11-11 11:37:13 +01:00
test_merge_tree_s3_failover
test_merge_tree_s3_with_cache
test_merge_tree_settings_constraints
test_merges_memory_limit
test_modify_engine_on_restart
test_move_partition_to_disk_on_cluster
test_move_partition_to_volume_async
test_move_ttl_broken_compatibility
test_multi_access_storage_role_management
test_multiple_disks
test_mutation_fetch_fallback
test_mutations_hardlinks
test_mutations_in_partitions_of_merge_tree
test_mutations_with_merge_tree
test_mutations_with_projection
test_mysql57_database_engine
test_mysql_database_engine
test_mysql_protocol
test_named_collections Update tests/integration/test_named_collections/test.py 2024-11-04 21:40:59 +03:00
test_named_collections_encrypted
test_named_collections_if_exists_on_cluster
test_non_default_compression Remove idxd-config library which has incompatible license 2024-10-23 21:45:39 +02:00
test_odbc_interaction
test_old_parts_finally_removed
test_old_versions
test_on_cluster_timeouts
test_optimize_on_insert
test_overcommit_tracker
test_parallel_replicas_all_marks_read
test_parallel_replicas_custom_key
test_parallel_replicas_custom_key_failover
test_parallel_replicas_custom_key_load_balancing
test_parallel_replicas_distributed_skip_shards
test_parallel_replicas_failover
test_parallel_replicas_invisible_parts
test_parallel_replicas_no_replicas
test_parallel_replicas_over_distributed
test_parallel_replicas_protocol
test_parallel_replicas_skip_shards
test_parallel_replicas_snapshot_from_initiator
test_parquet_page_index fix ci 2024-10-16 13:59:12 +08:00
test_part_log_table
test_part_uuid
test_partition
test_parts_delete_zookeeper
test_passing_max_partitions_to_read_remotely
test_password_constraints
test_peak_memory_usage Resubmit #68682, att2 2024-11-26 12:59:38 +00:00
test_placement_info
test_polymorphic_parts
test_postgresql_database_engine
test_postgresql_protocol
test_postgresql_replica_database_engine_1
test_postgresql_replica_database_engine_2
test_profile_events_s3
test_profile_max_sessions_for_user
test_profile_settings_and_constraints_order
test_prometheus_endpoint
test_prometheus_protocols Add waiting for prometheus instances to start before running test "test_prometheus_protocols". 2024-11-11 16:06:17 +01:00
test_quorum_inserts Add context manager for partition manager 2024-11-06 15:55:41 +00:00
test_quorum_inserts_parallel
test_quota
test_random_inserts
test_range_hashed_dictionary_types
test_read_only_table
test_read_temporary_tables_on_failure
test_recompression_ttl
test_recovery_replica
test_recovery_time_metric
test_redirect_url_storage
test_refreshable_mv Merge branch 'master' into randomize-keeper-feature-flasgs-keeper 2024-10-28 12:07:38 +01:00
test_regexp_logger Use rotate_logs() and contains_in_log() in test_regexp_logger 2024-10-21 11:44:11 -07:00
test_relative_filepath
test_reload_auxiliary_zookeepers
test_reload_certificate
test_reload_client_certificate Downgrade a test to stable old method 2024-10-29 01:52:33 +03:00
test_reload_clusters_config
test_reload_max_table_size_to_drop
test_reload_query_masking_rules
test_reload_zookeeper
test_reloading_settings_from_users_xml
test_reloading_storage_configuration
test_remote_blobs_naming
test_remote_prewhere
test_remove_stale_moving_parts
test_rename_column
test_render_log_file_name_templates
test_replace_partition
test_replica_can_become_leader
test_replica_is_active
test_replicated_database Revert changes in test_replicated_database 2024-10-03 02:18:21 +00:00
test_replicated_database_alter_modify_order_by
test_replicated_database_cluster_groups
test_replicated_fetches_bandwidth
test_replicated_fetches_timeouts
test_replicated_merge_tree_compatibility
test_replicated_merge_tree_config
test_replicated_merge_tree_encrypted_disk
test_replicated_merge_tree_encryption_codec
test_replicated_merge_tree_replicated_db_ttl
test_replicated_merge_tree_s3
test_replicated_merge_tree_s3_zero_copy
test_replicated_merge_tree_thread_schedule_timeouts
test_replicated_merge_tree_wait_on_shutdown
test_replicated_merge_tree_with_auxiliary_zookeepers
test_replicated_mutations
test_replicated_parse_zk_metadata
test_replicated_s3_zero_copy_drop_partition fix_test_drop_complex_columns: flaky check for test_drop_after_fetch 2024-11-06 14:52:55 +00:00
test_replicated_table_attach
test_replicated_user_defined_functions
test_replicated_users
test_replicated_zero_copy_projection_mutation
test_replicating_constants
test_replication_credentials
test_replication_without_zookeeper
test_restart_server
test_restore_external_engines
test_restore_replica
test_rocksdb_options
test_rocksdb_read_only
test_role
test_row_policy
test_runtime_configurable_cache_size
test_s3_access_headers Rebase 2024-10-30 09:27:50 +00:00
test_s3_aws_sdk_has_slightly_unreliable_behaviour
test_s3_cluster
test_s3_imds
test_s3_low_cardinality_right_border
test_s3_plain_rewritable add test 2024-10-24 02:48:40 +00:00
test_s3_storage_class
test_s3_storage_conf_new_proxy
test_s3_storage_conf_proxy
test_s3_style_link
test_s3_table_function_with_http_proxy
test_s3_table_function_with_https_proxy
test_s3_table_functions
test_s3_with_https
test_s3_zero_copy_replication Remove flaky test and extend stable one 2024-11-24 14:26:38 +00:00
test_s3_zero_copy_ttl
test_scheduler Fix test: add more retries 2024-10-31 19:06:51 +00:00
test_secure_socket
test_select_access_rights
test_send_crash_reports
test_send_request_to_leader_replica
test_server_initialization
test_server_keep_alive
test_server_reload Fix comments 2024-11-18 07:18:46 +01:00
test_server_start_and_ip_conversions
test_session_log
test_settings_constraints
test_settings_constraints_distributed
test_settings_profile
test_settings_randomization
test_shard_level_const_function
test_sharding_key_from_default_column
test_shutdown_static_destructor_failure
test_shutdown_wait_unfinished_queries
test_sql_user_defined_functions_on_cluster
test_ssh_keys_authentication
test_ssl_cert_authentication
test_startup_scripts Automatic style fix 2024-10-03 11:28:41 +00:00
test_stop_insert_when_disk_close_to_full
test_storage_azure_blob_storage Automatic style fix 2024-10-22 13:33:09 +00:00
test_storage_delta Fix test 2024-10-15 14:01:15 +02:00
test_storage_dict
test_storage_hdfs Support write hdfs files with space 2024-10-29 18:42:35 +08:00
test_storage_hudi
test_storage_iceberg Automatic style fix 2024-11-18 17:51:51 +00:00
test_storage_kafka Merge branch 'master' into randomize-keeper-feature-flasgs-keeper 2024-11-19 10:00:41 +01:00
test_storage_kerberized_kafka
test_storage_mongodb m 2024-11-14 15:05:34 +01:00
test_storage_mongodb_legacy
test_storage_mysql Remove test 2024-10-29 15:18:07 +00:00
test_storage_numbers
test_storage_policies
test_storage_postgresql Fix test 2024-10-30 10:52:51 +00:00
test_storage_rabbitmq Fix annoying isort check 2024-10-21 19:35:46 +02:00
test_storage_redis
test_storage_s3 Improve error and log messages around memory usage 2024-10-29 16:15:41 +01:00
test_storage_s3_queue Merge pull request #70523 from ClickHouse/randomize-keeper-feature-flasgs-keeper 2024-11-21 08:20:07 +00:00
test_storage_url
test_storage_url_http_headers fix name 2024-10-23 19:14:44 +00:00
test_storage_url_with_proxy
test_store_cleanup
test_structured_logging_json Omitted comment and reformatted 2024-11-14 19:47:30 +03:30
test_system_clusters_actual_information
test_system_ddl_worker_queue
test_system_detached_tables
test_system_flush_logs
test_system_logs
test_system_logs_comment
test_system_logs_hostname
test_system_logs_recreate
test_system_merges
test_system_metrics
test_system_queries
test_system_reload_async_metrics
test_system_start_stop_listen
test_table_db_num_limit Test other replica and cleanup 2024-10-29 16:23:55 +03:00
test_table_function_mongodb
test_table_function_mongodb_legacy
test_table_function_redis
test_table_functions_access_rights
test_tcp_handler_http_responses
test_tcp_handler_interserver_listen_host
test_temporary_data
test_temporary_data_in_cache
test_text_log_level
test_throttling
test_timezone_config
test_tlsv1_3
test_tmp_policy upd tests/integration/test_tmp_policy/test.py 2024-10-21 16:57:32 +00:00
test_trace_collector_serverwide
test_trace_log_build_id
test_transactions
test_truncate_database Fix test_truncate_database 2024-10-25 15:47:00 +02:00
test_ttl_move
test_ttl_replicated
test_unambiguous_alter_commands Fix test 2024-11-19 14:10:55 +00:00
test_undrop_query
test_union_header
test_unknown_column_dist_table_with_alias
test_user_defined_object_persistence
test_user_directories
test_user_grants_from_config
test_user_ip_restrictions
test_user_valid_until black check 2024-10-08 09:19:02 -03:00
test_user_zero_database_access
test_version_update
test_version_update_after_mutation
test_wrong_db_or_table_name
test_zero_copy_fetch
test_zero_copy_replication_drop_detached_part
test_zero_copy_unfreeze
test_zookeeper_config
test_zookeeper_config_load_balancing
test_zookeeper_fallback_session
.dockerignore
.gitignore
conftest.py
integration_test_images.py
parallel_skip.json make integration tests that use hardcoded ip addresses sequential 2024-11-01 10:59:39 +00:00
parallel.readme
pytest.ini
README.md
runner

ClickHouse integration tests

This directory contains tests that involve several ClickHouse instances, custom configs, ZooKeeper, etc.

Running natively

Prerequisites:

  • Ubuntu 20.04 (Focal) or higher.
  • docker. Minimum required API version: 1.25, check with docker version.

You must install latest Docker from https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#set-up-the-repository Don't use Docker from your system repository.

  • pip and libpq-dev. To install: sudo apt-get install python3-pip libpq-dev zlib1g-dev libcrypto++-dev libssl-dev libkrb5-dev python3-dev
  • py.test testing framework. To install: sudo -H pip install pytest
  • docker compose and additional python libraries. To install:
sudo -H pip install \
    PyMySQL \
    avro \
    cassandra-driver \
    confluent-kafka \
    dicttoxml \
    docker \
    grpcio \
    grpcio-tools \
    kafka-python \
    kazoo \
    minio \
    lz4 \
    protobuf \
    psycopg2-binary \
    pymongo \
    pytz \
    pytest \
    pytest-timeout \
    redis \
    tzlocal==2.1 \
    urllib3 \
    requests-kerberos \
    dict2xml \
    hypothesis \
    pyhdfs \
    pika \
    nats-py

(highly not recommended) If you really want to use OS packages on modern debian/ubuntu instead of "pip": sudo apt install -y docker docker-compose-v2 python3-pytest python3-dicttoxml python3-docker python3-pymysql python3-protobuf python3-pymongo python3-tzlocal python3-kazoo python3-psycopg2 kafka-python python3-pytest-timeout python3-minio

Some tests have other dependencies, e.g. spark. See docker/test/integration/runner/Dockerfile for how to install those. See docker/test/integration/runner/dockerd-entrypoint.sh for environment variables that need to be set (e.g. JAVA_PATH).

If you want to run the tests under a non-privileged user, you must add this user to docker group: sudo usermod -aG docker $USER and re-login. (You must close all your sessions (for example, restart your computer)) To check, that you have access to Docker, run docker ps.

Run the tests with the pytest command. To select which tests to run, use: pytest -k <test_name_pattern>

By default tests are run with system-wide client binary, server binary and base configs. To change that, set the following environment variables:

  • CLICKHOUSE_TESTS_SERVER_BIN_PATH to choose the server binary.
  • CLICKHOUSE_TESTS_CLIENT_BIN_PATH to choose the client binary.
  • CLICKHOUSE_TESTS_BASE_CONFIG_DIR to choose the directory from which base configs (config.xml andusers.xml) are taken.

Please note that if you use separate build (ENABLE_CLICKHOUSE_ALL=OFF), you need to build different components, including but not limited to ENABLE_CLICKHOUSE_LIBRARY_BRIDGE=ON ENABLE_CLICKHOUSE_ODBC_BRIDGE=ON ENABLE_CLICKHOUSE_KEEPER=ON. So it is easier to use ENABLE_CLICKHOUSE_ALL=ON

Running with runner script

The only requirement is fresh configured docker and docker pull clickhouse/integration-tests-runner

Notes:

  • If you want to run integration tests without sudo you have to add your user to docker group sudo usermod -aG docker $USER. More information about docker configuration.
  • If you already had run these tests without ./runner script you may have problems with pytest cache. It can be removed with rm -r __pycache__ .pytest_cache/.
  • Some tests maybe require a lot of resources (CPU, RAM, etc.). Better not try large tests like test_distributed_ddl* on your laptop.

You can run tests via ./runner script and pass pytest arguments as last arg:

$ ./runner --binary $HOME/ClickHouse/programs/clickhouse  --odbc-bridge-binary $HOME/ClickHouse/programs/clickhouse-odbc-bridge --base-configs-dir $HOME/ClickHouse/programs/server/ 'test_ssl_cert_authentication -ss'
Start tests
====================================================================================================== test session starts ======================================================================================================
platform linux -- Python 3.8.10, pytest-7.1.2, pluggy-1.0.0 -- /usr/bin/python3
cachedir: .pytest_cache
rootdir: /ClickHouse/tests/integration, configfile: pytest.ini
plugins: repeat-0.9.1, xdist-2.5.0, forked-1.4.0, order-1.0.0, timeout-2.1.0
timeout: 900.0s
timeout method: signal
timeout func_only: False
collected 4 items

test_ssl_cert_authentication/test.py::test_https Copy common default production configuration from /clickhouse-config. Files: config.xml, users.xml
PASSED
test_ssl_cert_authentication/test.py::test_https_wrong_cert PASSED
test_ssl_cert_authentication/test.py::test_https_non_ssl_auth PASSED
test_ssl_cert_authentication/test.py::test_create_user PASSED

================================================================================================= 4 passed in 118.58s (0:01:58) =================================================================================================

Path to binary and configs maybe specified via env variables:

$ export CLICKHOUSE_TESTS_BASE_CONFIG_DIR=$HOME/ClickHouse/programs/server/
$ export CLICKHOUSE_TESTS_SERVER_BIN_PATH=$HOME/ClickHouse/programs/clickhouse
$ export CLICKHOUSE_TESTS_ODBC_BRIDGE_BIN_PATH=$HOME/ClickHouse/programs/clickhouse-odbc-bridge
$ ./runner 'test_odbc_interaction'
$ # or ./runner '-v -ss'
Start tests
============================= test session starts ==============================
platform linux2 -- Python 2.7.15rc1, pytest-4.0.0, py-1.7.0, pluggy-0.8.0
rootdir: /ClickHouse/tests/integration, inifile: pytest.ini
collected 6 items

test_odbc_interaction/test.py ......                                     [100%]
==================== 6 passed, 1 warnings in 96.33 seconds =====================

You can just open shell inside a container by overwritting the command: ./runner --command=bash

Parallel test execution

On the CI, we run a number of parallel runners (5 at the time of this writing), each on its own Docker container. These runner containers spawn more containers for each test for the services needed such as ZooKeeper, MySQL, PostgreSQL and minio, among others. This means that tests do not share any services among them. Within each runner, tests are parallelized using pytest-xdist. We're using --dist=loadfile to distribute the load. In the documentation words: this guarantees that all tests in a file run in the same worker. This means that any test within the same file will never execute their tests in parallel. They'll be executed on the same worker one after the other.

If the test supports parallel and repeated execution, you can run a bunch of them in parallel to look for flakiness. We use pytest-repeat to set the number of times we want to execute a test through the --count argument. Then, -n sets the number of parallel workers for pytest-xdist.

$ export CLICKHOUSE_TESTS_BASE_CONFIG_DIR=$HOME/ClickHouse/programs/server/
$ export CLICKHOUSE_TESTS_SERVER_BIN_PATH=$HOME/ClickHouse/programs/clickhouse
$ export CLICKHOUSE_TESTS_ODBC_BRIDGE_BIN_PATH=$HOME/ClickHouse/programs/clickhouse-odbc-bridge
$ ./runner test_storage_s3_queue/test.py::test_max_set_age --count 10 -n 5
Start tests
=============================================================================== test session starts ================================================================================
platform linux -- Python 3.10.12, pytest-7.4.4, pluggy-1.5.0 -- /usr/bin/python3
cachedir: .pytest_cache
rootdir: /ClickHouse/tests/integration
configfile: pytest.ini
plugins: reportlog-0.4.0, xdist-3.5.0, random-0.2, repeat-0.9.3, order-1.0.0, timeout-2.2.0
timeout: 900.0s
timeout method: signal
timeout func_only: False
5 workers [10 items]
scheduling tests via LoadScheduling

test_storage_s3_queue/test.py::test_max_set_age[9-10]
test_storage_s3_queue/test.py::test_max_set_age[7-10]
test_storage_s3_queue/test.py::test_max_set_age[5-10]
test_storage_s3_queue/test.py::test_max_set_age[1-10]
test_storage_s3_queue/test.py::test_max_set_age[3-10]
[gw3] [ 10%] PASSED test_storage_s3_queue/test.py::test_max_set_age[7-10]
test_storage_s3_queue/test.py::test_max_set_age[8-10]
[gw4] [ 20%] PASSED test_storage_s3_queue/test.py::test_max_set_age[9-10]
test_storage_s3_queue/test.py::test_max_set_age[10-10]
[gw0] [ 30%] PASSED test_storage_s3_queue/test.py::test_max_set_age[1-10]
test_storage_s3_queue/test.py::test_max_set_age[2-10]
[gw1] [ 40%] PASSED test_storage_s3_queue/test.py::test_max_set_age[3-10]
test_storage_s3_queue/test.py::test_max_set_age[4-10]
[gw2] [ 50%] PASSED test_storage_s3_queue/test.py::test_max_set_age[5-10]
test_storage_s3_queue/test.py::test_max_set_age[6-10]
[gw3] [ 60%] PASSED test_storage_s3_queue/test.py::test_max_set_age[8-10]
[gw4] [ 70%] PASSED test_storage_s3_queue/test.py::test_max_set_age[10-10]
[gw0] [ 80%] PASSED test_storage_s3_queue/test.py::test_max_set_age[2-10]
[gw1] [ 90%] PASSED test_storage_s3_queue/test.py::test_max_set_age[4-10]
[gw2] [100%] PASSED test_storage_s3_queue/test.py::test_max_set_age[6-10]
========================================================================== 10 passed in 120.65s (0:02:00) ==========================================================================

Rebuilding the docker containers

The main container used for integration tests lives in docker/test/integration/base/Dockerfile. Rebuild it with

cd docker/test/integration/base
docker build -t clickhouse/integration-test .

The helper container used by the runner script is in docker/test/integration/runner/Dockerfile. It can be rebuild with

cd docker/test/integration/runner
docker build -t clickhouse/integration-test-runner .

If your docker configuration doesn't allow access to public internet with docker build command you may also need to add option --network=host if you rebuild image for a local integration testsing.

Adding new tests

To add new test named foo, create a directory test_foo with an empty __init__.py and a file named test.py containing tests in it. All functions with names starting with test will become test cases.

helpers directory contains utilities for:

  • Launching a ClickHouse cluster with or without ZooKeeper in docker containers.
  • Sending queries to launched instances.
  • Introducing network failures such as severing network link between two instances.

To assert that two TSV files must be equal, wrap them in the TSV class and use the regular assert statement. Example: assert TSV(result) == TSV(reference). In case the assertion fails, pytest will automagically detect the types of variables and only the small diff of two files is printed.

Troubleshooting

If tests failing for mysterious reasons, this may help:

sudo service docker stop
sudo bash -c 'rm -rf /var/lib/docker/*'
sudo service docker start

iptables-nft

On Ubuntu 20.10 and later in host network mode (default) one may encounter problem with nested containers not seeing each other. It happens because legacy and nftables rules are out of sync. Problem can be solved by:

sudo iptables -P FORWARD ACCEPT