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

Add builds and tests with coverage #58792

Merged
merged 84 commits into from Feb 10, 2024

Conversation

alexey-milovidov
Copy link
Member

@alexey-milovidov alexey-milovidov commented Jan 14, 2024

Changelog category (leave one):

  • Build/Testing/Packaging Improvement

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

Added builds and tests with coverage collection with introspection. Continuation of #56102.

@robot-ch-test-poll4 robot-ch-test-poll4 added the pr-build Pull request with build/testing/packaging improvement label Jan 14, 2024
@robot-ch-test-poll4
Copy link
Contributor

robot-ch-test-poll4 commented Jan 14, 2024

This is an automated comment for commit 61227ac with description of existing statuses. It's updated for the latest CI running

❌ Click here to open a full report in a separate page

Successful checks
Check nameDescriptionStatus
ClickBenchRuns [ClickBench](https://github.com/ClickHouse/ClickBench/) with instant-attach table✅ 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 keeper imageThe check to build and optionally push the mentioned image to docker hub✅ success
Docker server imageThe 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
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
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
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❌ failure
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⏳ pending
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❌ failure
Stateless testsRuns stateless functional tests for ClickHouse binaries built in various configurations -- release, debug, with sanitizers, etc❌ failure
Stress testRuns stateless functional tests concurrently from several clients to detect concurrency-related errors❌ failure

@robot-clickhouse-ci-1 robot-clickhouse-ci-1 added the submodule changed At least one submodule changed in this PR. label Jan 14, 2024
@alexey-milovidov
Copy link
Member Author

New debug tests: 1hr 23min .. 1hr 55min.

@alexey-milovidov
Copy link
Member Author

Old debug tests: 1hr 19min .. 1hr 23min.

Not a big difference - ok to merge.

@alexey-milovidov
Copy link
Member Author

As tests are run in parallel, so far, we will have only cumulative, not per-test coverage.

tests/ci/ci_config.py Outdated Show resolved Hide resolved
alexey-milovidov and others added 2 commits February 9, 2024 18:32
Co-authored-by: Mikhail f. Shiryaev <felixoid@clickhouse.com>
Co-authored-by: Mikhail f. Shiryaev <felixoid@clickhouse.com>
@alexey-milovidov
Copy link
Member Author

Almost ready, but:

  1. It's strange that not every test is visible in the coverage_log on the CI Logs cluster.
  2. I tried to make the tests sequential for the coverage runs, but it didn't work.
  3. Check the hangs in some of the runs.

@alexey-milovidov
Copy link
Member Author

alexey-milovidov commented Feb 10, 2024

Nice: it captures almost all the tests:

clickhouse-cloud :) SELECT check_start_time, check_name, uniq(test_name), sum(length(coverage)), uniqArray(coverage) FROM coverage_log_11609173080111304637 GROUP BY ALL WITH TOTALS ORDER BY check_start_time

SELECT
    check_start_time,
    check_name,
    uniq(test_name),
    sum(length(coverage)),
    uniqArray(coverage)
FROM coverage_log_11609173080111304637
GROUP BY ALL
    WITH TOTALS
ORDER BY check_start_time ASC

Query id: 5639cce1-c2e3-4c44-a7e5-e0cfd3047a9e

┌────check_start_time─┬─check_name─────────────────┬─uniq(test_name)─┬─sum(coverage.size0)─┬─uniqArray(coverage)─┐
│ 2024-02-09 23:17:00 │ Stateful tests (coverage)  │             134 │             9511806 │              199782 │
│ 2024-02-09 23:17:04 │ Stateless tests (coverage) │             993 │           177304800 │              402380 │
│ 2024-02-09 23:17:08 │ Stateless tests (coverage) │             724 │           132668437 │              358264 │
│ 2024-02-09 23:17:24 │ Stateless tests (coverage) │             981 │           126618522 │              401880 │
│ 2024-02-09 23:18:18 │ Stateless tests (coverage) │             733 │           138739289 │              370636 │
│ 2024-02-09 23:19:46 │ Stateless tests (coverage) │            1027 │           183750228 │              414230 │
│ 2024-02-09 23:20:20 │ Stateless tests (coverage) │             529 │            79867396 │              336427 │
└─────────────────────┴────────────────────────────┴─────────────────┴─────────────────────┴─────────────────────┘

Totals:
┌────check_start_time─┬─check_name─┬─uniq(test_name)─┬─sum(coverage.size0)─┬─uniqArray(coverage)─┐
│ 1970-01-01 00:00:00 │            │            5115 │           848460478 │              652484 │
└─────────────────────┴────────────┴─────────────────┴─────────────────────┴─────────────────────┘

@alexey-milovidov
Copy link
Member Author

It works. An example of symbols covered by exactly one test:
https://pastila.nl/?0000fa09/7800a04e09958a7d109f88b4117ac5b2#LnsUmjzWEcB3LJfcbywoQA==

@alexey-milovidov
Copy link
Member Author

It's strange that not every test is visible in the coverage_log on the CI Logs cluster.

Fixed.

I tried to make the tests sequential for the coverage runs, but it didn't work.

Fixed.

@alexey-milovidov alexey-milovidov marked this pull request as ready for review February 10, 2024 22:50
@alexey-milovidov
Copy link
Member Author

Finally, it looks alright.

@alexey-milovidov alexey-milovidov merged commit 789bca1 into master Feb 10, 2024
274 of 285 checks passed
@alexey-milovidov alexey-milovidov deleted the enable-coverage-for-debug-build branch February 10, 2024 22:52
@alexey-milovidov alexey-milovidov self-assigned this Feb 10, 2024
@alexey-milovidov
Copy link
Member Author

Next step - add reports.

@alexey-milovidov
Copy link
Member Author

I suspect a subset of data is not delivered to the CI logs cluster due to high volume.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-build Pull request with build/testing/packaging improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants